Interface YieldService

rawTxBuilder

balanceOf

• balanceOf(params: YieldBalanceParams, provider?: Provider): Promise<string>

• Get token balance

  Parameters

  • params: YieldBalanceParams
  • Optionalprovider: Provider

  Returns Promise<string>

  Token balance

checkAllowance

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

• Check if the amount of approved tokens is enough

  Parameters

  • params: YieldCheckAllowanceParams

    See YieldCheckAllowanceParams
  • Optionalprovider: Provider

    will be used to access the network

  Returns Promise<boolean>

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

getAllowance

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

• Get amount of tokens approved for Yield

  Parameters

  • params: YieldGetAllowanceParams

    See YieldGetAllowanceParams
  • Optionalprovider: Provider

    will be used to access the network

  Returns Promise<string>

  the amount of approved tokens

getCYDTokens

• getCYDTokens(): Promise<CYDToken[]>

• Returns a list of supported CYDToken.

  Returns Promise<CYDToken[]>

getEstimatedAmountOnDeposit

• getEstimatedAmountOnDeposit(
      params: YieldGetEstimatedAmountOnDepositParams,
      provider?: Provider,
  ): Promise<string>

• Calculates the amount of CYD tokens that will be deposited

  Parameters

  • params: YieldGetEstimatedAmountOnDepositParams

    will be used to access the network
  • Optionalprovider: Provider

    will be used to access the network

  Returns Promise<string>

  amount

getWithdrawAmounts

• getWithdrawAmounts(
      params: YieldGetWithdrawProportionAmountParams,
      provider?: Provider,
  ): Promise<YieldWithdrawAmount[]>

• Calculates the amounts of tokens (YieldWithdrawAmount) will be withdrawn

  Parameters

  • params: YieldGetWithdrawProportionAmountParams
  • Optionalprovider: Provider

    will be used to access the network

  Returns Promise<YieldWithdrawAmount[]>

  amounts