Interface YieldService

interface YieldService {
    rawTxBuilder: RawYieldTransactionBuilder;
    balanceOf(params: YieldBalanceParams, provider?: Provider): Promise<string>;
    checkAllowance(
        params: YieldCheckAllowanceParams,
        provider?: Provider,
    ): Promise<boolean>;
    getAllowance(
        params: YieldGetAllowanceParams,
        provider?: Provider,
    ): Promise<string>;
    getCYDTokens(): Promise<CYDToken[]>;
    getEstimatedAmountOnDeposit(
        params: YieldGetEstimatedAmountOnDepositParams,
        provider?: Provider,
    ): Promise<string>;
    getWithdrawAmounts(
        params: YieldGetWithdrawProportionAmountParams,
        provider?: Provider,
    ): Promise<YieldWithdrawAmount[]>;
}

Index

Properties

Methods

balanceOf checkAllowance getAllowance getCYDTokens getEstimatedAmountOnDeposit getWithdrawAmounts

Properties

rawTxBuilder

rawTxBuilder: RawYieldTransactionBuilder

Methods

balanceOf

balanceOf(params: YieldBalanceParams, provider?: Provider): Promise<string>
Get token balance
Parameters
- params: YieldBalanceParams
- Optionalprovider: Provider
Returns Promise<string>
Token balance
- Defined in src/services/yield/index.ts:60

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
- Defined in src/services/yield/index.ts:52

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
- Defined in src/services/yield/index.ts:44

getCYDTokens

getCYDTokens(): Promise<CYDToken[]>
Returns a list of supported CYDToken.

Returns Promise<CYDToken[]>
- Defined in src/services/yield/index.ts:36

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
- Defined in src/services/yield/index.ts:68

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
- Defined in src/services/yield/index.ts:76