operations/create_passive_sell_offer.js

  1. import xdr from '../xdr';
  3. /**
  4.  * Returns a XDR CreatePasiveSellOfferOp. A "create passive offer" operation creates an
  5.  * offer that won't consume a counter offer that exactly matches this offer. This is
  6.  * useful for offers just used as 1:1 exchanges for path payments. Use manage offer
  7.  * to manage this offer after using this operation to create it.
  8.  * @function
  9.  * @alias Operation.createPassiveSellOffer
  10.  * @param {object} opts Options object
  11.  * @param {Asset} opts.selling - What you're selling.
  12.  * @param {Asset} opts.buying - What you're buying.
  13.  * @param {string} opts.amount - The total amount you're selling. If 0, deletes the offer.
  14.  * @param {number|string|BigNumber|Object} opts.price - Price of 1 unit of `selling` in terms of `buying`.
  15.  * @param {number} opts.price.n - If `opts.price` is an object: the price numerator
  16.  * @param {number} opts.price.d - If `opts.price` is an object: the price denominator
  17.  * @param {string} [opts.source] - The source account (defaults to transaction source).
  18.  * @throws {Error} Throws `Error` when the best rational approximation of `price` cannot be found.
  19.  * @returns {xdr.CreatePassiveSellOfferOp} Create Passive Sell Offer operation
  20.  */
  21. export function createPassiveSellOffer(opts) {
  22.   const attributes = {};
  23.   attributes.selling = opts.selling.toXDRObject();
  24.   attributes.buying = opts.buying.toXDRObject();
  25.   if (!this.isValidAmount(opts.amount)) {
  26.     throw new TypeError(this.constructAmountRequirementsError('amount'));
  27.   }
  28.   attributes.amount = this._toXDRAmount(opts.amount);
  29.   if (opts.price === undefined) {
  30.     throw new TypeError('price argument is required');
  31.   }
  32.   attributes.price = this._toXDRPrice(opts.price);
  33.   const createPassiveSellOfferOp = new xdr.CreatePassiveSellOfferOp(attributes);
  35.   const opAttributes = {};
  36.   opAttributes.body = xdr.OperationBody.createPassiveSellOffer(
  37.     createPassiveSellOfferOp
  38.   );
  39.   this.setSourceAccount(opAttributes, opts);
  41.   return new xdr.Operation(opAttributes);
  42. }