Class ERC20

Basic representation of an ERC20 compatible contract. If additional functionality is required, this contract can be extended via inheritance

Hierarchy

BaseContract
- ERC20

Index

Constructors

Accessors

address contract

Methods

allowance approve balanceOf balanceOfBatch call connect decimals name retryCall supportsInterface symbol tokenMetadata totalSupply transfer transferFrom

Constructors

constructor

new ERC20(_contract): ERC20
Constructs a new instance of the object
Parameters
- _contract: IContract
Returns ERC20

Inherited from BaseContract.constructor

Accessors

address

get address(): string
Returns the contract address

Returns string

Inherited from BaseContract.address

contract

get contract(): Contract
Returns the underlying contract interface

Returns Contract

Inherited from BaseContract.contract

Methods

allowance

allowance(owner, spender): Promise<BigNumber>
Returns the amount which spender is still allowed to withdraw from owner.
Parameters
- owner: string
- spender: string
Returns Promise<BigNumber>

approve

approve(spender, value?, overrides?): Promise<ContractTransaction>
Allows spender to withdraw from your account multiple times, up to the value amount
Parameters
- spender: string
- value: BigNumberish = MaxApproval
- overrides: CallOverrides = {}
Returns Promise<ContractTransaction>

balanceOf

balanceOf(owner): Promise<BigNumber>
Returns the account balance of another account with address owner.
Parameters
- owner: string
Returns Promise<BigNumber>

balanceOfBatch

balanceOfBatch(owners): Promise<{
balance: BigNumber;
owner: string;
}[]>
Returns the balances for each of the provided accounts
Parameters
- owners: string[]
Returns Promise<{
balance: BigNumber;
owner: string;
}[]>

call

call(name, ...params): ContractCall
Returns an interface allowing for us with the multicall method of a provider
Parameters
- name: string
- Rest ...params: any[]
Returns ContractCall

Inherited from BaseContract.call

connect

connect(signerOrProvider): ERC20
Connects the existing instance of the contract to a new signer or provider
Parameters
- signerOrProvider: Provider | Signer | MulticallProvider
Returns ERC20

Inherited from BaseContract.connect

decimals

decimals(): Promise<number>
Returns the number of decimals the token uses - e.g. 8, means to divide the token amount by 100000000 to get its user representation.

Returns Promise<number>

name

name(): Promise<string>
Returns the name of the token - e.g. "MyToken".

Returns Promise<string>

`Protected` retryCall

retryCall<T>(func, ...params): Promise<T>
Protected
Automatically keeps trying the call unless we get a revert exception
Type Parameters
- T
Parameters
- func: ((...args) => Promise<T>)
  - - (...args): Promise<T>
    - Parameters
      
      Rest ...args: any[]
      
      Returns Promise<T>
- Rest ...params: any[]
Returns Promise<T>

Inherited from BaseContract.retryCall

supportsInterface

supportsInterface(interfaceId): Promise<boolean>
Returns whether the specified interface is supported by the contract
Parameters
- interfaceId: string
Returns Promise<boolean>

Inherited from BaseContract.supportsInterface

symbol

symbol(): Promise<string>
Returns the symbol of the token. E.g. “HIX”.

Returns Promise<string>

tokenMetadata

tokenMetadata(): Promise<{
    address: string;
    decimals: number;
    name: string;
    symbol: string;
    totalSupply: BigNumber;
}>
Return the metadata of the token

Returns Promise<{
    address: string;
    decimals: number;
    name: string;
    symbol: string;
    totalSupply: BigNumber;
}>

totalSupply

totalSupply(): Promise<BigNumber>
Returns the total token supply

Returns Promise<BigNumber>

transfer

transfer(to, value, overrides?): Promise<ContractTransaction>
Transfers value amount of tokens to address to
Parameters
- to: string
- value: BigNumberish
- overrides: CallOverrides = {}
Returns Promise<ContractTransaction>

transferFrom

transferFrom(from, to, value, overrides?): Promise<ContractTransaction>
Transfers value amount of tokens from address from to address to
Parameters
- from: string
- to: string
- value: BigNumberish
- overrides: CallOverrides = {}
Returns Promise<ContractTransaction>