lib/order/structure/maker/withMakerTxns.js 

  1. /*
  2.  * Copyright (C) 2021-2022 Algodex VASP (BVI) Corp.
  3.  *
  4.  * This Source Code Form is subject to the terms of the Mozilla Public
  5.  * License, v. 2.0. If a copy of the MPL was not distributed with this
  6.  * file, You can obtain one at https://mozilla.org/MPL/2.0/.
  7.  */
  9. const getMakerTxns = require('./getMakerTxns');
  11. /**
  12.  * # 🔗 withMakerTxns
  13.  * Accepts an [Order]{@link Order} with execution type [Maker]{@tutorial Maker} and generates the relevant transactions.
  14.  *
  15.  *
  16.  * ### Existing Escrow (Only relevant for [makePlaceAlgo]{@link module:txns/buy.makePlaceAlgo} )
  17.  * 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.
  18.  *  * If that order exists, we generate a set of transactions that adds to the existing order.
  19.  *  * If the order does not exist, we generate a set of transactions to create a new maker order.
  20.  *
  21.  * 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.
  22.  *
  23.  * ### When is it used?
  24.  * This method and the corresponding Factory is used anytime a Maker order is added to the [Algodex Orderbook]{@tutorial Orderbook}.
  25.  *
  26.  * This method is the maker leg of [getMakerTakerTxns]{@link module:order/structures.getMakerTakerTxns}.
  27.  *
  28.  * This method would be ideal for use in algorithmic trading strategies and for programmaticaly providing liquidity to the [Algodex Orderbook]{@tutorial Orderbook}
  29.  *
  30.  *
  31.  *
  32.  *
  33.  * @example
  34.  * const [AlgodexAPI]{@link AlgodexApi} = require(@algodex/algodex-sdk)
  35.  * const api = new [AlgodexAPI]{@link AlgodexApi}(require('../config.json'))
  36.  * const order = {
  37.  *   "client": api.algod,
  38.  *   "indexer": api.indexer,
  39.  *   "asset": {
  40.  *     "id": 15322902,
  41.  *     "decimals": 6,
  42.  *   },
  43.  *   "address": "TJFFNUYWHPPIYDE4DGGYPGHWKGAPJEWP3DGE5THZS3B2M2XIAPQ2WY3X4I",
  44.  *   "price": 2.22,
  45.  *   "amount": 1,
  46.  *   "total": 2,
  47.  *   "execution": "maker",
  48.  *   "type": "buy",
  49.  *   "appId": 22045503,
  50.  *   "version": 6
  51.  * }
  52.  * const {[compile]{@link module:order/compile}} = require(@algodex/algodex-sdk/order)
  53.  *
  54.  * //order.execution === 'maker'
  55.  * let res = await withMakerTxns(api, await [compile]{@link module:order/compile}(order))
  56.  * console.log(res.contract.txns)
  57.  * //Outputs:
  58.  * [makePlaceAlgoTxns]{@link module:txns/buy.makePlaceAlgoTxns} || [makePlaceAssetTxns]{@link module:txns/sell.makePlaceAssetTxns}
  59.  *
  60.  * @param {Api} api Instance of AlgodexApi
  61.  * @param {Order} order The User's Order
  62.  * @return {Promise<Order>}
  63.  * @memberOf module:order/structure
  64.  * @see [getMakerTxns]{@link getMakerTxns} || [makePlaceAlgoTxns]{@link module:txns/buy.makePlaceAlgoTxns} || [makePlaceAssetTxns]{@link module:txns/sell.makePlaceAssetTxns}
  65.  */
  66. async function withMakerTxns(api, order) {
  67.   const isExistingEscrow = await api.getIsExistingEscrow(order);
  68.   if (isExistingEscrow) {
  69.     order.contract = {
  70.       ...order.contract,
  71.       creator: order.address,
  72.     };
  73.   }
  75.   return {
  76.     ...order,
  77.     contract: {
  78.       ...order.contract,
  79.       txns: await getMakerTxns(order, isExistingEscrow),
  80.       creator: order.address,
  81.     },
  82.   };
  83. }
  84. module.exports = withMakerTxns;
  85. JAVASCRIPT
    Copied!