Interface LiquidityPoolService

rawTxBuilder

approve

• approve(
      provider: Provider,
      approveData: LiquidityPoolsApproveParams,
  ): Promise<TransactionResponse>

• Parameters

  • provider: Provider

    will be used to access the network
  • approveData: LiquidityPoolsApproveParams

  Returns Promise<TransactionResponse>

  Deprecated

  Use rawTxBuilder.RawPoolTransactionBuilder.approve

  Approve tokens usage by another address on chains

  For ETH/USDT: due to specificity of the USDT contract:
  If the current allowance is not 0, this function will perform an additional transaction to set allowance to 0 before setting the new allowance value.

checkAllowance

• checkAllowance(
      provider: Provider,
      params: LiquidityPoolsCheckAllowanceParams,
  ): Promise<boolean>

• Check if the amount of approved tokens is enough

  Parameters

  • provider: Provider

    will be used to access the network
  • params: LiquidityPoolsCheckAllowanceParams

    See CheckAllowanceParams

  Returns Promise<boolean>

  true if the amount of approved tokens is enough to make a transfer
• checkAllowance(params: LiquidityPoolsCheckAllowanceParams): Promise<boolean>

• Check if the amount of approved tokens is enough

  Parameters

  • params: LiquidityPoolsCheckAllowanceParams

    See CheckAllowanceParams

  Returns Promise<boolean>

  true if the amount of approved tokens is enough to make a transfer

getAllowance

• getAllowance(
      provider: Provider,
      params: LiquidityPoolsGetAllowanceParams,
  ): Promise<string>

• Get amount of tokens approved for poolInfo

  Parameters

  • provider: Provider

    will be used to access the network
  • params: LiquidityPoolsGetAllowanceParams

    See GetAllowanceParams

  Returns Promise<string>

  the amount of approved tokens
• getAllowance(params: LiquidityPoolsGetAllowanceParams): Promise<string>

• Get amount of tokens approved for poolInfo

  Parameters

  • params: LiquidityPoolsGetAllowanceParams

    See GetAllowanceParams

  Returns Promise<string>

  the amount of approved tokens

getAmountToBeDeposited

• getAmountToBeDeposited(
      amount: string,
      token: TokenWithChainDetails,
      provider?: Provider,
  ): Promise<string>

• Calculates the amount of LP tokens that will be deposited

  Parameters

  • amount: string

    The float amount of tokens that will be sent
  • token: TokenWithChainDetails
  • Optionalprovider: Provider

    will be used to access the network

  Returns Promise<string>

  amount

getAmountToBeWithdrawn

• getAmountToBeWithdrawn(
      amount: string,
      accountAddress: string,
      token: TokenWithChainDetails,
      provider?: Provider,
  ): Promise<string>

• Calculates the amount of tokens will be withdrawn

  Parameters

  • amount: string

    The float amount of tokens that will be sent
  • accountAddress: string
  • token: TokenWithChainDetails
  • Optionalprovider: Provider

    will be used to access the network

  Returns Promise<string>

  amount

getPoolInfoFromChain

• getPoolInfoFromChain(
      token: TokenWithChainDetails,
      provider?: Provider,
  ): Promise<Required<PoolInfo>>

• Gets information about the poolInfo from chain

  Parameters

  • token: TokenWithChainDetails
  • Optionalprovider: Provider

    will be used to access the network

  Returns Promise<Required<PoolInfo>>

  poolInfo

getUserBalanceInfo

• getUserBalanceInfo(
      accountAddress: string,
      token: TokenWithChainDetails,
      provider?: Provider,
  ): Promise<UserBalanceInfo>

• Get User Balance Info on Liquidity poolInfo

  Parameters

  • accountAddress: string
  • token: TokenWithChainDetails
  • Optionalprovider: Provider

  Returns Promise<UserBalanceInfo>

  UserBalanceInfo