Class ERC20Token

Hierarchy (view full)

Constructors

constructor

Properties

address allowance approve balanceOf contract name symbol totalSupply transfer transferFrom

Constructors

constructor

  • new ERC20Token(address): ERC20Token

  • Parameters

    • address: string

    Returns ERC20Token

Properties

Readonly address

address: string

allowance

allowance: ((__namedParameters) => Promise<string>)

Returns the allowance the owner has granted the spender.

Type declaration

    • (__namedParameters): Promise<string>

    • Returns the allowance the owner has granted the spender.

      Parameters

      Returns Promise<string>

      the allowance amount

Param: owner

the owner who has allotted the allowance

Param: spender

the spender who has received the allowance

Param: providerOrSigner

a provider or signer for executing a web3 call

Returns

the allowance amount

approve

approve: ((params) => Operation)

Approve receiver to spend amount tokens.

Type declaration

Param: receiver

The receiver approved.

Param: amount

The amount approved.

Param: overrides

ethers overrides object for more control over the transaction sent.

Returns

An instance of Operation which can be executed or batched.

balanceOf

balanceOf: ((__namedParameters) => Promise<string>)

Returns the ERC20 balanceOf the account, this can't be negative and will just display 0.

Type declaration

    • (__namedParameters): Promise<string>

    • Returns the ERC20 balanceOf the account, this can't be negative and will just display 0.

      Parameters

      Returns Promise<string>

      the token balance of account

Param: account

the account you would like to query

Param: providerOrSigner

a provider or signer for executing a web3 call

Returns

the token balance of account

Readonly contract

contract: IERC20Metadata

name

name: ((providerOrSigner) => Promise<string>)

Returns the token name

Type declaration

    • (providerOrSigner): Promise<string>

    • Returns the token name

      Parameters

      Returns Promise<string>

      the token name

Param: providerOrSigner

a provider or signer for executing a web3 call

Returns

the token name

symbol

symbol: ((providerOrSigner) => Promise<string>)

Returns the token symbol

Type declaration

    • (providerOrSigner): Promise<string>

    • Returns the token symbol

      Parameters

      Returns Promise<string>

      the token symbol

Param: providerOrSigner

a provider or signer for executing a web3 call

Returns

the token symbol

totalSupply

totalSupply: ((providerOrSigner) => Promise<string>)

Returns the total supply of the token.

Type declaration

    • (providerOrSigner): Promise<string>

    • Returns the total supply of the token.

      Parameters

      Returns Promise<string>

      the total supply of the token

Param: providerOrSigner

a provider or signer for executing a web3 call

Returns

the total supply of the token

transfer

transfer: ((params) => Operation)

Transfer receiver amount tokens.

Type declaration

Param: receiver

The receiver of the transfer.

Param: amount

The amount to be transferred.

Param: overrides

ethers overrides object for more control over the transaction sent.

Returns

An instance of Operation which can be executed or batched.

transferFrom

transferFrom: ((params) => Operation)

Transfer from sender to receiver amount tokens.

Type declaration

Param: sender

The sender of the transfer.

Param: receiver

The receiver of the transfer.

Param: amount

The amount to be transferred.

Param: overrides

ethers overrides object for more control over the transaction sent.

Returns

An instance of Operation which can be executed or batched.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc