lib/order/txns/buy/makePlaceAlgoTxns.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 algosdk = require('algosdk');
  10. const logger = require('../../../logger');
  11. const AlgodError = require('../../../error/AlgodError');
  12. const enc = require('../../../utils/encoder');
  13. const teal = require('../../../teal');
  14. const getOptedIn = require('../../../wallet/getOptedIn');
  16. /**
  17.  * # 🏭 makePlaceAlgoTxns(order)
  18.  *
  19.  * > Transaction Factory for Placing Buy Orders
  20.  *
  21.  *
  22.  * Place a buy order into the Algodex {@tutorial Orderbook}. This is referred to as a {@tutorial Maker} order which is
  23.  * "Placed into the Orderbook". If the order has been previously placed it will have a contract
  24.  * key called "creator". This key determines if the order should call the ALGO delegate contract
  25.  * application opt in.
  26.  *
  27.  * Once the initial transaction has been created and the contract.creator has been sent, the sdk
  28.  * reverts to regular payment transactions to the escrow account. These payment transactions
  29.  * should include a note that relates to the operation for indexing since they will not have
  30.  * the orderbook application call.
  31.  *
  32.  * The transaction generator also supports bypassing the opt-in check by passing in the optIn flag
  33.  *
  34.  * ## ALGO Delegate Contract Transactions
  35.  *
  36.  * ### ➕ Open Order Transactions:
  37.  *
  38.  * | Index | Direction | Type | Description | Signer |
  39.  * | ----- | --------- | ---- | ----------- | ------ |
  40.  * | TXN 0 | BUYER TO ESCROW | {@link algosdk.makePaymentTxn} | Pay from order creator to escrow account | {@link Wallet} |
  41.  * | TXN 1 | ESCROW TO ORDERBOOK | {@link algosdk.makeApplicationOptInTxn} | Stateful app opt-in to order book | {@link algosdk.LogicSigAccount} |
  42.  * | TXN 2 | BUYER TO BUYER | {@link algosdk.makeAssetTransferTxn} | (Optional) ASA opt-in for the order creator's original wallet account | {@link Wallet} |
  43.  *
  44.  * ### 💰 Add Funds to Order Escrow Transactions:
  45.  *
  46.  * | Index | Direction | Type | Description | Signer |
  47.  * | ----- | --------- | ---- | ----------- | ------ |
  48.  * | TXN 0 | BUYER TO ESCROW | {@link algosdk.makePaymentTxn} | Pay from order creator to escrow account | {@link Wallet} |
  49.  * | TXN 1 | BUYER TO BUYER | {@link algosdk.makeAssetTransferTxn} | (Optional) ASA opt-in for the order creator's original wallet account | {@link Wallet} |
  50.  *
  51.  * #
  52.  *
  53.  *
  54.  * @example
  55.  * const {makePlaceAlgoTxns, compile} = require('@algodex/algodex-sdk')
  56.  * const txns = makePlaceAlgoTxns( await compile({
  57.  *    'asset': {
  58.  *         'id': 15322902,
  59.  *         'decimals': 6,
  60.  *       },
  61.  *       'address': 'WYWRYK42XADLY3O62N52BOLT27DMPRA3WNBT2OBRT65N6OEZQWD4OSH6PI',
  62.  *       'price': 2,
  63.  *       'amount': 1,
  64.  *       'total': 2,
  65.  *       'execution': 'maker',
  66.  *       'type': 'buy',
  67.  *       'appId': 22045503,
  68.  *       'version': 6,
  69.  * }))
  70.  *
  71.  * @param {Order} order The Order
  72.  * @param {boolean} [optIn] Flag for opting in
  73.  * @return {Promise<Transactions>}
  74.  * @memberOf module:txns/buy
  75.  */
  76. async function makePlaceAlgoTxns(
  77.     order,
  78.     optIn = false,
  79. ) {
  80.   if (!(order.indexer instanceof algosdk.Indexer)) {
  81.     throw new AlgodError('Order must have a valid SDK client');
  82.   }
  84.   if (typeof order.appId !== 'number') {
  85.     throw new TypeError('Must have valid Application Index');
  86.   }
  88.   if (typeof order.contract !== 'undefined' && typeof order.contract.entry !== 'string') {
  89.     throw new TypeError('Order must have a valid contract state with an entry!');
  90.   }
  92.   if (order.execution !== 'maker') {
  93.     throw new Error('Must be maker only mode!');
  94.   }
  96.   if (order.contract?.amount === 0) {
  97.     throw new Error('Cannot place a maker order with a 0 Amount');
  98.   }
  100.   logger.info({order: {price: order.price, amount: order.amount, total: order.total}, optIn}, 'Make Place Algo Txns');
  101.   // TODO: Note that contains the creator address and the current operation.
  102.   const _note = undefined;
  104.   // If the order has a creator key, it already exists
  105.   const _exists = typeof order?.contract?.creator !== 'undefined';
  106.   if (_exists) {
  107.     throw new TypeError('Adding to an existing algo escrow is disabled!');
  108.   }
  110.   let accountInfo;
  111.   if (typeof order?.wallet?.assets === 'undefined' && !optIn) {
  112.     logger.warn({address: order.address}, 'Loading account info!');
  113.     ({account: accountInfo} = await order.indexer.lookupAccountByID(order.address).do()); // We need to have the same structure between the conditionals
  114.   } else {
  115.     accountInfo = order.wallet;
  116.   }
  118.   const _optIn = !optIn ?
  119.     await getOptedIn(order.indexer, accountInfo, order.asset.id) :
  120.     optIn;
  122.   const _suggestedParams = await teal.getTransactionParams(order.client, order.contract.params, true);
  124.   /**
  125.          * Place Algo Structure
  126.          * @type {Structures}
  127.          */
  128.   const _outerTxns = [{
  129.     // Payment Transaction
  130.     // TODO: Add Note that tracks this payment transaction when the escrow already exists
  131.     unsignedTxn: algosdk.makePaymentTxnWithSuggestedParams(
  132.         order.address,
  133.         order.contract.lsig.address(),
  134.         order.contract.total,
  135.         undefined,
  136.         _note,
  137.         _suggestedParams,
  138.         undefined,
  139.     ),
  140.     senderAcct: order.address,
  141.   }];
  143.   // Open Order Transaction
  144.   if (!_exists) {
  145.     logger.debug({entry: order.contract.entry.slice(59)}, 'Creating new order!');
  146.     /**
  147.                  * Application Arguments
  148.                  * @type {Array<Uint8Array>}
  149.                  */
  150.     const _appArgs = [
  151.       enc.encode('open'),
  152.       enc.encode(order.contract.entry.slice(59)),
  153.       new Uint8Array([order.version]),
  154.     ];
  156.     // Create Escrow appOptIn Transaction
  157.     // This contract application args are parsed by the Algodex Indexer
  158.     _outerTxns.push({
  159.       unsignedTxn: await teal.txns.makeTransactionFromLogicSig(
  160.           order.client,
  161.           'appOptIn',
  162.           order.contract.lsig,
  163.           order?.contract?.params,
  164.           order.appId,
  165.           _appArgs,
  166.       ),
  167.       lsig: order.contract.lsig,
  168.     });
  169.   }
  171.   // Optin Transaction
  172.   if (!_optIn) {
  173.     logger.debug({address: order.address, asset: order.asset.id}, 'Opting in!');
  174.     _outerTxns.push({
  175.       unsignedTxn: algosdk.makeAssetTransferTxnWithSuggestedParams(
  176.           order.address,
  177.           order.address,
  178.           undefined,
  179.           undefined,
  180.           0,
  181.           undefined,
  182.           order.asset.id,
  183.           _suggestedParams,
  184.           undefined,
  185.       ),
  186.       senderAcct: order.address,
  187.     });
  188.   }
  190.   return _outerTxns;
  191. }
  193. module.exports = makePlaceAlgoTxns;
  195. JAVASCRIPT
    Copied!