operations/liquidity_pool_deposit.js

  1. import xdr from '../xdr';
  3. /**
  4.  * Creates a liquidity pool deposit operation.
  5.  *
  6.  * @function
  7.  * @alias Operation.liquidityPoolDeposit
  8.  * @see https://developers.stellar.org/docs/start/list-of-operations/#liquidity-pool-deposit
  9.  *
  10.  * @param {object} opts - Options object
  11.  * @param {string} opts.liquidityPoolId - The liquidity pool ID.
  12.  * @param {string} opts.maxAmountA - Maximum amount of first asset to deposit.
  13.  * @param {string} opts.maxAmountB - Maximum amount of second asset to deposit.
  14.  * @param {number|string|BigNumber|Object} opts.minPrice -  Minimum depositA/depositB price.
  15.  * @param {number} opts.minPrice.n - If `opts.minPrice` is an object: the price numerator
  16.  * @param {number} opts.minPrice.d - If `opts.minPrice` is an object: the price denominator
  17.  * @param {number|string|BigNumber|Object} opts.maxPrice -  Maximum depositA/depositB price.
  18.  * @param {number} opts.maxPrice.n - If `opts.maxPrice` is an object: the price numerator
  19.  * @param {number} opts.maxPrice.d - If `opts.maxPrice` is an object: the price denominator
  20.  * @param {string} [opts.source] - The source account for the operation. Defaults to the transaction's source account.
  21.  *
  22.  * @returns {xdr.Operation} The resulting operation (xdr.LiquidityPoolDepositOp).
  23.  */
  24. export function liquidityPoolDeposit(opts = {}) {
  25.   const { liquidityPoolId, maxAmountA, maxAmountB, minPrice, maxPrice } = opts;
  26.   const attributes = {};
  28.   if (!liquidityPoolId) {
  29.     throw new TypeError('liquidityPoolId argument is required');
  30.   }
  31.   attributes.liquidityPoolId = xdr.PoolId.fromXDR(liquidityPoolId, 'hex');
  33.   if (!this.isValidAmount(maxAmountA, true)) {
  34.     throw new TypeError(this.constructAmountRequirementsError('maxAmountA'));
  35.   }
  36.   attributes.maxAmountA = this._toXDRAmount(maxAmountA);
  38.   if (!this.isValidAmount(maxAmountB, true)) {
  39.     throw new TypeError(this.constructAmountRequirementsError('maxAmountB'));
  40.   }
  41.   attributes.maxAmountB = this._toXDRAmount(maxAmountB);
  43.   if (minPrice === undefined) {
  44.     throw new TypeError('minPrice argument is required');
  45.   }
  46.   attributes.minPrice = this._toXDRPrice(minPrice);
  48.   if (maxPrice === undefined) {
  49.     throw new TypeError('maxPrice argument is required');
  50.   }
  51.   attributes.maxPrice = this._toXDRPrice(maxPrice);
  53.   const liquidityPoolDepositOp = new xdr.LiquidityPoolDepositOp(attributes);
  54.   const opAttributes = {
  55.     body: xdr.OperationBody.liquidityPoolDeposit(liquidityPoolDepositOp)
  56.   };
  57.   this.setSourceAccount(opAttributes, opts);
  59.   return new xdr.Operation(opAttributes);
  60. }