Class ExchangeLab

constructor

• new ExchangeLab(): ExchangeLab

  Returns ExchangeLab

_compiler

_default_preferred_token_output_bch_amount

_rate_denominator

_template

constructTradeAvailableAmountBelowTargetRate

• constructTradeAvailableAmountBelowTargetRate(
      supply_token_id: string,
      demand_token_id: string,
      rate: Fraction,
      input_pools: PoolV0[],
  ): null | TradeResult

  Construct a trade from a set of input_pools with the following condition, Demands offers below the target rate. Meaning the differential rate of the demand at the highest rate is below the provided rate. This function does not consider pool fees, Assumes all pools have zero fee.

  Parameters

  • supply_token_id: string

    the supply token of the trade
  • demand_token_id: string

    the demand token of the trade
  • rate: Fraction

    the target rate
  • input_pools: PoolV0[]

    a list of input cauldron pools

  Returns null | TradeResult

  the constructed trade result or null if no trade can be generated with the given condition

  Throws

  ValueError

constructTradeAvailableAmountForTargetAvgRate

• constructTradeAvailableAmountForTargetAvgRate(
      supply_token_id: string,
      demand_token_id: string,
      rate: Fraction,
      input_pools: PoolV0[],
  ): null | TradeResult

  Construct a trade from a set of input_pools with the following condition, Demands as much possible with a target average rate. Meaning the differential rate of the demand at the highest rate is below the provided rate.

  Parameters

  • supply_token_id: string

    the supply token of the trade
  • demand_token_id: string

    the demand token of the trade
  • rate: Fraction

    the target rate
  • input_pools: PoolV0[]

    a list of input cauldron pools

  Returns null | TradeResult

  the constructed trade result or null

  Throws

  ValueError

constructTradeBestRateForTargetDemand

• constructTradeBestRateForTargetDemand(
      supply_token_id: string,
      demand_token_id: string,
      amount: bigint,
      input_pools: PoolV0[],
      txfee_per_byte: bigint,
  ): TradeResult

  Construct a trade from a set of input_pools with the following condition, Demands at least the target amount at the best rate. The best rate is estimated based on the state of input_pools and the fixed cost of network transaction fee.

  Parameters

  • supply_token_id: string

    the supply token of the trade
  • demand_token_id: string

    the demand token of the trade
  • amount: bigint

    the order's target demand
  • input_pools: PoolV0[]

    a list of input cauldron pools
  • txfee_per_byte: bigint

    the network fee to be paid per byte

  Returns TradeResult

  the constructed trade result

  Throws

  InsufficientCapitalInPools

  Throws

  ValueError

constructTradeBestRateForTargetSupply

• constructTradeBestRateForTargetSupply(
      supply_token_id: string,
      demand_token_id: string,
      amount: bigint,
      input_pools: PoolV0[],
      txfee_per_byte: bigint,
  ): TradeResult

  Construct a trade from a set of input_pools with the following condition, Supply at most the target amount at the best rate. The best rate is estimated based on the state of input_pools and the fixed cost of network transaction fee.

  Parameters

  • supply_token_id: string

    the supply token of the trade
  • demand_token_id: string

    the demand token of the trade
  • amount: bigint

    the order's target demand
  • input_pools: PoolV0[]

    a list of input cauldron pools
  • txfee_per_byte: bigint

    the network fee to be paid per byte

  Returns TradeResult

  the constructed trade result

  Throws

  InsufficientCapitalInPools

  Throws

  ValueError

createChainedTradeTx

• createChainedTradeTx(
      input_pool_trade_list: PoolTrade[],
      input_coins: SpendableCoin[],
      payout_rules: PayoutRule[],
      data_locking_bytecode: null | Uint8Array<ArrayBufferLike>,
      txfee_per_byte: number | bigint,
      controller?: CreateChainedTradeTxController,
  ): Promise<TradeTxResult[]>

  Create a chain of transactions from constructed trade.

  Parameters

  • input_pool_trade_list: PoolTrade[]

    a list of trades with pools.
  • input_coins: SpendableCoin[]

    a set of spendable coins used provide the supply side of the trade
  • payout_rules: PayoutRule[]

    a set of rules for the trade's payout + a pocket change
  • data_locking_bytecode: null | Uint8Array<ArrayBufferLike>

    an optional message to insert in the transaction as an OP_RETURN output
  • txfee_per_byte: number | bigint

    the rate of network fee (sat/byte)
  • Optionalcontroller: CreateChainedTradeTxController

    an optional controller used when generating the transactions

  Returns Promise<TradeTxResult[]>

  the trade's transaction result.

  Throws

  ValueError

  Throws

  InsufficientFunds

createTradeTx

• createTradeTx(
      input_pool_trade_list: PoolTrade[],
      input_coins: SpendableCoin[],
      payout_rules: PayoutRule[],
      data_locking_bytecode: null | Uint8Array<ArrayBufferLike>,
      txfee_per_byte: number | bigint,
  ): TradeTxResult

  Create a transaction from constructed trade.

  Parameters

  • input_pool_trade_list: PoolTrade[]

    a list of trades with pools.
  • input_coins: SpendableCoin[]

    a set of spendable coins used provide the supply side of the trade
  • payout_rules: PayoutRule[]

    a set of rules for the trade's payout + a pocket change
  • data_locking_bytecode: null | Uint8Array<ArrayBufferLike>

    an optional message to insert in the transaction as an OP_RETURN output
  • txfee_per_byte: number | bigint

    the rate of network fee (sat/byte)

  Returns TradeTxResult

  the trade's transaction result.

  Throws

  ValueError

  Throws

  InsufficientFunds

generatePoolV0LockingBytecode

• generatePoolV0LockingBytecode(parameters: PoolV0Parameters): Uint8Array

  Generate a pool's locking with PoolV0Parameters

  Parameters

  • parameters: PoolV0Parameters

    { withdraw_pubkey_hash }

  Returns Uint8Array

  the pool's p2sh locking bytecode

getMinTokenReserve

• getMinTokenReserve(token_id: string): bigint

  Parameters

  • token_id: string

    the subject token_id

  Returns bigint

  the min token in reserve needed for any cauldron pool.

getOutputMinAmount

• getOutputMinAmount(output: Output): bigint

  Parameters

  • output: Output

    the subject output

  Returns bigint

  the min bch amount required for the output to meet the network threshold

getPreferredTokenOutputBCHAmount

• getPreferredTokenOutputBCHAmount(output: Output): null | bigint

  Parameters

  • output: Output

    the subject output

  Returns null | bigint

  the preferred bch amount for a token output

getRateDenominator

• getRateDenominator(): bigint

  Get the default exchange rate's denominator

  Returns bigint

  the default denominator value of the rate

reconstructTradePoolsByReducingSupply

• reconstructTradePoolsByReducingSupply(
      pool_trade_list: PoolTrade[],
      reduce_supply: bigint,
  ): PoolTrade[]

  Reduce the supply of a constructed trade.

  Parameters

  • pool_trade_list: PoolTrade[]

    a pre-constructed list of trades with pools.
  • reduce_supply: bigint

    the amount to reduce the supply.

  Returns PoolTrade[]

  the reconstructed trades, represented in a list pools with the trade details

  Throws

  ValueError

setDefaultPreferredTokenOutputBCHAmount

• setDefaultPreferredTokenOutputBCHAmount(value: null | bigint): void

  Parameters

  • value: null | bigint

    the default preferred token bch amount

  Returns void

setRateDenominator

• setRateDenominator(denominator: bigint): void

  Set the default exchange rate's denominator. A higher value will increase the rate's percision, A lower value reduces it. initial value: 10000000000000n

  Parameters

  • denominator: bigint

    the default rate's denominator

  Returns void

verifyTradeTx

• verifyTradeTx(trade_tx_result: TradeTxResult): void

  Verify the validity of a TradeTxResult, Expecting all generated transactions should be valid.

  Parameters

  • trade_tx_result: TradeTxResult

    the result of createTradeTx or createChainedTradeTx

  Returns void

  Throws

  InvalidProgramState