lib/order/structure/maker/withMakerTxns.js 

  1. const getMakerTxns = require('./getMakerTxns');
  3. /**
  4.  * # 🔗 withMakerTxns
  5.  * Accepts an [Order]{@link Order} with execution type [Maker]{@tutorial Maker} and generates the relevant transactions.
  6.  *
  7.  *
  8.  * ### Existing Escrow (Only relevant for [makePlaceAlgo]{@link module:txns/buy.makePlaceAlgo} )
  9.  * When a user places a maker order, we first check to see if the [Algodex Orderbook]{@tutorial Orderbook} already has an Order entry at that price, from that User.
  10.  *  * If that order exists, we generate a set of transactions that adds to the existing order.
  11.  *  * If the order does not exist, we generate a set of transactions to create a new maker order.
  12.  *
  13.  * You can learn more about the differences between the two types of transactions in the trasnaction table for [makePlaceAlgoTxns]{@link module:txns/buy.makePlaceAlgoTxns} factory.
  14.  *
  15.  * ### When is it used?
  16.  * This method and the corresponding Factory is used anytime a Maker order is added to the [Algodex Orderbook]{@tutorial Orderbook}.
  17.  *
  18.  * This method is the maker leg of [getMakerTakerTxns]{@link module:order/structures.getMakerTakerTxns}.
  19.  *
  20.  * This method would be ideal for use in algorithmic trading strategies and for programmaticaly providing liquidity to the [Algodex Orderbook]{@tutorial Orderbook}
  21.  *
  22.  *
  23.  *
  24.  *
  25.  * @example
  26.  * const [AlgodexAPI]{@link AlgodexApi} = require(@algodex/algodex-sdk)
  27.  * const api = new [AlgodexAPI]{@link AlgodexApi}(require('../config.json'))
  28.  * const order = {
  29.  *   "client": api.algod,
  30.  *   "indexer": api.indexer,
  31.  *   "asset": {
  32.  *     "id": 15322902,
  33.  *     "decimals": 6,
  34.  *   },
  35.  *   "address": "TJFFNUYWHPPIYDE4DGGYPGHWKGAPJEWP3DGE5THZS3B2M2XIAPQ2WY3X4I",
  36.  *   "price": 2.22,
  37.  *   "amount": 1,
  38.  *   "total": 2,
  39.  *   "execution": "maker",
  40.  *   "type": "buy",
  41.  *   "appId": 22045503,
  42.  *   "version": 6
  43.  * }
  44.  * const {[compile]{@link module:order/compile}} = require(@algodex/algodex-sdk/order)
  45.  *
  46.  * //order.execution === 'maker'
  47.  * let res = await withMakerTxns(api, await [compile]{@link module:order/compile}(order))
  48.  * console.log(res.contract.txns)
  49.  * //Outputs:
  50.  * [makePlaceAlgoTxns]{@link module:txns/buy.makePlaceAlgoTxns} || [makePlaceAssetTxns]{@link module:txns/sell.makePlaceAssetTxns}
  51.  *
  52.  * @param {Api} api Instance of AlgodexApi
  53.  * @param {Order} order The User's Order
  54.  * @return {Promise<Order>}
  55.  * @memberOf module:order/structure
  56.  * @see [getMakerTxns]{@link getMakerTxns} || [makePlaceAlgoTxns]{@link module:txns/buy.makePlaceAlgoTxns} || [makePlaceAssetTxns]{@link module:txns/sell.makePlaceAssetTxns}
  57.  */
  58. async function withMakerTxns(api, order) {
  59.   const isExistingEscrow = await api.getIsExistingEscrow(order);
  60.   if (isExistingEscrow) {
  61.     order.contract = {
  62.       ...order.contract,
  63.       creator: order.address,
  64.     };
  65.   }
  67.   return {
  68.     ...order,
  69.     contract: {
  70.       ...order.contract,
  71.       txns: await getMakerTxns(order, isExistingEscrow),
  72.       creator: order.address,
  73.     },
  74.   };
  75. }
  76. module.exports = withMakerTxns;
  77. JAVASCRIPT
    Copied!