stellar_sdk/operation/create_passive_sell_offer.py
from decimal import Decimal
from typing import Optional, Union
from .. import xdr as stellar_xdr
from ..asset import Asset
from ..muxed_account import MuxedAccount
from ..price import Price
from ..utils import raise_if_not_valid_amount
from .operation import Operation
__all__ = ["CreatePassiveSellOffer"]
class CreatePassiveSellOffer(Operation):
"""The :class:`CreatePassiveSellOffer` object, which represents a
CreatePassiveSellOffer operation on Stellar's network.
A passive sell offer is an offer that does not act on and take a reverse offer
of equal price. Instead, they only take offers of lesser price. For
example, if an offer exists to buy 5 BTC for 30 XLM, and you make a passive
sell offer to buy 30 XLM for 5 BTC, your passive sell offer does not take the first
offer.
Note that regular offers made later than your passive sell offer can act on and
take your passive sell offer, even if the regular offer is of the same price as
your passive sell offer.
Passive sell offers allow market makers to have zero spread. If you want to
trade EUR for USD at 1:1 price and USD for EUR also at 1:1, you can create
two passive sell offers so the two offers don't immediately act on each other.
Once the passive sell offer is created, you can manage it like any other offer
using the manage offer operation - see :class:`ManageBuyOffer` for more
details.
Threshold: Medium
See `Create Passive Sell Offer <https://developers.stellar.org/docs/start/list-of-operations/#create-passive-sell-offer>`_ for more information.
:param selling: What you're selling.
:param buying: What you're buying.
:param amount: The total amount you're selling.
:param price: Price of 1 unit of `selling` in terms of `buying`.
:param source: The source account for the operation. Defaults to the transaction's source account.
"""
_XDR_OPERATION_TYPE: stellar_xdr.OperationType = (
stellar_xdr.OperationType.CREATE_PASSIVE_SELL_OFFER
)
def __init__(
self,
selling: Asset,
buying: Asset,
amount: Union[str, Decimal],
price: Union[Price, str, Decimal],
source: Optional[Union[MuxedAccount, str]] = None,
) -> None:
super().__init__(source)
if not isinstance(price, Price):
price = Price.from_raw_price(price)
self.selling: Asset = selling
self.buying: Asset = buying
self.amount: str = str(amount)
self.price: Price = price
raise_if_not_valid_amount(self.amount, "amount")
def _to_operation_body(self) -> stellar_xdr.OperationBody:
selling = self.selling.to_xdr_object()
buying = self.buying.to_xdr_object()
price = self.price.to_xdr_object()
amount = stellar_xdr.Int64(Operation.to_xdr_amount(self.amount))
create_passive_sell_offer_op = stellar_xdr.CreatePassiveSellOfferOp(
selling, buying, amount, price
)
body = stellar_xdr.OperationBody(
type=self._XDR_OPERATION_TYPE,
create_passive_sell_offer_op=create_passive_sell_offer_op,
)
return body
@classmethod
def from_xdr_object(
cls, xdr_object: stellar_xdr.Operation
) -> "CreatePassiveSellOffer":
"""Creates a :class:`CreatePassiveSellOffer` object from an XDR Operation object."""
source = Operation.get_source_from_xdr_obj(xdr_object)
assert xdr_object.body.create_passive_sell_offer_op is not None
selling = Asset.from_xdr_object(
xdr_object.body.create_passive_sell_offer_op.selling
)
buying = Asset.from_xdr_object(
xdr_object.body.create_passive_sell_offer_op.buying
)
amount = Operation.from_xdr_amount(
xdr_object.body.create_passive_sell_offer_op.amount.int64
)
price = Price.from_xdr_object(
xdr_object.body.create_passive_sell_offer_op.price
)
op = cls(
source=source, selling=selling, buying=buying, amount=amount, price=price
)
return op
def __repr__(self):
return (
f"<CreatePassiveSellOffer [selling={self.selling}, buying={self.buying}, "
f"amount={self.amount}, price={self.price}, source={self.source}]>"
)