Class TokenService

Service providing userful interactions with token information and actions.

Hierarchy

Constructors

constructor

Properties

allowances level sdk tokens

Accessors

address connector provider signer

Methods

#_log #tryDecimals #tryName #trySymbol approve debug error increaseAllowance info loadAllowance loadAllowances loadBalance loadBalances loadToken loadTokens log revoke submitAction transfer verifyOrApprove verifyOrIncreaseAllowance warn

Constructors

constructor

Properties

Private allowances

allowances: Record<string, BigNumber> = {}

level

level: LogLevel

Protected sdk

sdk: eBTC

Private tokens

tokens: Record<string, Token> = {}

Accessors

address

  • get address(): undefined | string

  • Returns undefined | string

connector

  • get connector(): Signer | MulticallProvider

  • Returns Signer | MulticallProvider

provider

  • get provider(): MulticallProvider

  • Returns MulticallProvider

signer

  • get signer(): undefined | Signer

  • Returns undefined | Signer

Methods

Private #_log

  • #_log(level, message?, ...optionalParams): void

  • Parameters

    • level: LogLevel
    • Optional message: any
    • Rest ...optionalParams: any[]

    Returns void

Private #tryDecimals

  • #tryDecimals(token): Promise<number>

  • Attempt to resolve a token decimals

    Parameters

    • token: Erc20

      Token contract

    Returns Promise<number>

    Decimals if available, empty string if not

Private #tryName

  • #tryName(token): Promise<string>

  • Attempt to resolve a token name

    Parameters

    • token: Erc20

      Token contract

    Returns Promise<string>

    Name if available, empty string if not

Private #trySymbol

  • #trySymbol(token): Promise<string>

  • Attempt to resolve a token symbol

    Parameters

    • token: Erc20

      Token contract

    Returns Promise<string>

    Symbol if available, empty string if not

approve

debug

  • debug(message?, ...optionalParams): void

  • Parameters

    • Optional message: any
    • Rest ...optionalParams: any[]

    Returns void

error

  • error(message?, ...optionalParams): void

  • Parameters

    • Optional message: any
    • Rest ...optionalParams: any[]

    Returns void

increaseAllowance

  • increaseAllowance(options): Promise<TransactionStatus>

  • Increase token allowance for a given spender for requested token.

    Parameters

    • options: IncreaseAllowanceOptions

      Increase allowance paramters, enableErc20ApproveBackup If set to true, will attempt to use the ERC20 approve method if the increaseAllowance method fails.

    Returns Promise<TransactionStatus>

    Transaction status of the submitted increase allowance

info

  • info(message?, ...optionalParams): void

  • Parameters

    • Optional message: any
    • Rest ...optionalParams: any[]

    Returns void

loadAllowance

  • loadAllowance(token, spender, owner?): Promise<BigNumber>

  • Load token allowance for a given token to a specific user

    Parameters

    • token: string

      Address of requested token

    • spender: string

      Target address to check against

    • Optional owner: string

      A requested address to check allowance, defaults to the connected address if available

    Returns Promise<BigNumber>

    Token allowance for the requested spender

loadAllowances

  • loadAllowances(tokens, spender, owner?): Promise<Record<string, BigNumber>>

  • Load token allowances for given tokens to a specific user

    Parameters

    • tokens: string[]

      Addresses of requested tokens

    • spender: string

      Target address to check against

    • Optional owner: string

      A requested address to check allowance, defaults to the connected address if available

    Returns Promise<Record<string, BigNumber>>

    Mapping from address to allowance

loadBalance

  • loadBalance(token, owner?): Promise<BigNumber>

  • Load token balance for a given token

    Parameters

    • token: string

      Address of requested token

    • Optional owner: string

      A requested address to check balance, defaults to the connected address if available

    Returns Promise<BigNumber>

    Amount of token the owner has

loadBalances

  • loadBalances(tokens, owner?): Promise<Record<string, BigNumber>>

  • Load token balances for a given list of tokens

    Parameters

    • tokens: string[]

      Addresses of requested tokens

    • Optional owner: string

      A requested address to check balances, defaults to the connected address if available

    Returns Promise<Record<string, BigNumber>>

    Mapping from address to token balance

loadToken

  • loadToken(token): Promise<Token>

  • Load token information for a given token

    Parameters

    • token: string

      Address of requested token

    Returns Promise<Token>

    Token information

loadTokens

  • loadTokens(tokens): Promise<Record<string, Token>>

  • Load token information for a given list of tokens

    Parameters

    • tokens: string[]

      Addresses of requested tokens

    Returns Promise<Record<string, Token>>

    Mapping from address to token information

log

  • log(message?, ...optionalParams): void

  • Parameters

    • Optional message: any
    • Rest ...optionalParams: any[]

    Returns void

revoke

submitAction

transfer

verifyOrApprove

  • verifyOrApprove(options): Promise<TransactionStatus>

  • Checks a user's currently allowed tokens to be transfered by a given spender. If the allowance is not sufficient, a transaction to increase that allowance through an approve for the spender will be initiated.

    Parameters

    Returns Promise<TransactionStatus>

    Transaction status of the submitted approve

verifyOrIncreaseAllowance

  • verifyOrIncreaseAllowance(options): Promise<TransactionStatus>

  • Checks a user's currently allowed tokens to be transfered by a given spender. If the allowance is not sufficient, a transaction to increase that allowance for the spender will be initiated.

    Parameters

    Returns Promise<TransactionStatus>

    Transaction status of the submitted increase allowance

warn

  • warn(message?, ...optionalParams): void

  • Parameters

    • Optional message: any
    • Rest ...optionalParams: any[]

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc