Skip to main content

Interface: Erc20TokenClient

A standard ERC20 token

Hierarchy

  • TokenERC20

    Erc20TokenClient

Properties

_deployedPromise

_deployedPromise: Promise<Contract>

Inherited from

TokenERC20._deployedPromise


_runningEvents

_runningEvents: Object

Index signature

[eventTag: string]: RunningEvent

Inherited from

TokenERC20._runningEvents


_wrappedEmits

_wrappedEmits: Object

Index signature

[eventTag: string]: (...args: any[]) => void

Inherited from

TokenERC20._wrappedEmits


address

Readonly address: string

Inherited from

TokenERC20.address


callStatic

callStatic: Object

Type declaration

NameType
allowance(owner: PromiseOrValue<string>, spender: PromiseOrValue<string>, overrides?: CallOverrides) => Promise<BigNumber>
approve(spender: PromiseOrValue<string>, amount: PromiseOrValue<BigNumberish>, overrides?: CallOverrides) => Promise<boolean>
balanceOf(account: PromiseOrValue<string>, overrides?: CallOverrides) => Promise<BigNumber>
decimals(overrides?: CallOverrides) => Promise<number>
decreaseAllowance(spender: PromiseOrValue<string>, subtractedValue: PromiseOrValue<BigNumberish>, overrides?: CallOverrides) => Promise<boolean>
increaseAllowance(spender: PromiseOrValue<string>, addedValue: PromiseOrValue<BigNumberish>, overrides?: CallOverrides) => Promise<boolean>
name(overrides?: CallOverrides) => Promise<string>
symbol(overrides?: CallOverrides) => Promise<string>
totalSupply(overrides?: CallOverrides) => Promise<BigNumber>
transfer(to: PromiseOrValue<string>, amount: PromiseOrValue<BigNumberish>, overrides?: CallOverrides) => Promise<boolean>
transferFrom(from: PromiseOrValue<string>, to: PromiseOrValue<string>, amount: PromiseOrValue<BigNumberish>, overrides?: CallOverrides) => Promise<boolean>

Inherited from

TokenERC20.callStatic


clientType

clientType: TokenClient


deployTransaction

Readonly deployTransaction: TransactionResponse

Inherited from

TokenERC20.deployTransaction


estimateGas

estimateGas: Object

Type declaration

NameType
allowance(owner: PromiseOrValue<string>, spender: PromiseOrValue<string>, overrides?: CallOverrides) => Promise<BigNumber>
approve(spender: PromiseOrValue<string>, amount: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<BigNumber>
balanceOf(account: PromiseOrValue<string>, overrides?: CallOverrides) => Promise<BigNumber>
decimals(overrides?: CallOverrides) => Promise<BigNumber>
decreaseAllowance(spender: PromiseOrValue<string>, subtractedValue: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<BigNumber>
increaseAllowance(spender: PromiseOrValue<string>, addedValue: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<BigNumber>
name(overrides?: CallOverrides) => Promise<BigNumber>
symbol(overrides?: CallOverrides) => Promise<BigNumber>
totalSupply(overrides?: CallOverrides) => Promise<BigNumber>
transfer(to: PromiseOrValue<string>, amount: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<BigNumber>
transferFrom(from: PromiseOrValue<string>, to: PromiseOrValue<string>, amount: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<BigNumber>

Inherited from

TokenERC20.estimateGas


filters

filters: Object

Type declaration

NameType
Approval(owner?: null | PromiseOrValue<string>, spender?: null | PromiseOrValue<string>, value?: null) => ApprovalEventFilter
Approval(address,address,uint256)(owner?: null | PromiseOrValue<string>, spender?: null | PromiseOrValue<string>, value?: null) => ApprovalEventFilter
Transfer(from?: null | PromiseOrValue<string>, to?: null | PromiseOrValue<string>, value?: null) => TransferEventFilter
Transfer(address,address,uint256)(from?: null | PromiseOrValue<string>, to?: null | PromiseOrValue<string>, value?: null) => TransferEventFilter

Inherited from

TokenERC20.filters


functions

functions: Object

Type declaration

NameType
allowance(owner: PromiseOrValue<string>, spender: PromiseOrValue<string>, overrides?: CallOverrides) => Promise<[BigNumber]>
approve(spender: PromiseOrValue<string>, amount: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<ContractTransaction>
balanceOf(account: PromiseOrValue<string>, overrides?: CallOverrides) => Promise<[BigNumber]>
decimals(overrides?: CallOverrides) => Promise<[number]>
decreaseAllowance(spender: PromiseOrValue<string>, subtractedValue: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<ContractTransaction>
increaseAllowance(spender: PromiseOrValue<string>, addedValue: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<ContractTransaction>
name(overrides?: CallOverrides) => Promise<[string]>
symbol(overrides?: CallOverrides) => Promise<[string]>
totalSupply(overrides?: CallOverrides) => Promise<[BigNumber]>
transfer(to: PromiseOrValue<string>, amount: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<ContractTransaction>
transferFrom(from: PromiseOrValue<string>, to: PromiseOrValue<string>, amount: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<ContractTransaction>

Inherited from

TokenERC20.functions


interface

interface: TokenERC20Interface

Inherited from

TokenERC20.interface


off

off: OnEvent<Erc20TokenClient>

Inherited from

TokenERC20.off


on

on: OnEvent<Erc20TokenClient>

Inherited from

TokenERC20.on


once

once: OnEvent<Erc20TokenClient>

Inherited from

TokenERC20.once


populateTransaction

populateTransaction: Object

Type declaration

NameType
allowance(owner: PromiseOrValue<string>, spender: PromiseOrValue<string>, overrides?: CallOverrides) => Promise<PopulatedTransaction>
approve(spender: PromiseOrValue<string>, amount: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<PopulatedTransaction>
balanceOf(account: PromiseOrValue<string>, overrides?: CallOverrides) => Promise<PopulatedTransaction>
decimals(overrides?: CallOverrides) => Promise<PopulatedTransaction>
decreaseAllowance(spender: PromiseOrValue<string>, subtractedValue: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<PopulatedTransaction>
increaseAllowance(spender: PromiseOrValue<string>, addedValue: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<PopulatedTransaction>
name(overrides?: CallOverrides) => Promise<PopulatedTransaction>
symbol(overrides?: CallOverrides) => Promise<PopulatedTransaction>
totalSupply(overrides?: CallOverrides) => Promise<PopulatedTransaction>
transfer(to: PromiseOrValue<string>, amount: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<PopulatedTransaction>
transferFrom(from: PromiseOrValue<string>, to: PromiseOrValue<string>, amount: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<PopulatedTransaction>

Inherited from

TokenERC20.populateTransaction


provider

Readonly provider: Provider

Inherited from

TokenERC20.provider


removeListener

removeListener: OnEvent<Erc20TokenClient>

Inherited from

TokenERC20.removeListener


resolvedAddress

Readonly resolvedAddress: Promise<string>

Inherited from

TokenERC20.resolvedAddress


signer

Readonly signer: Signer

Inherited from

TokenERC20.signer


tokenClientType

tokenClientType: Erc20

Methods

_checkRunningEvents

_checkRunningEvents(runningEvent): void

Parameters

NameType
runningEventRunningEvent

Returns

void

Inherited from

TokenERC20._checkRunningEvents


_deployed

_deployed(blockTag?): Promise<Contract>

Parameters

NameType
blockTag?BlockTag

Returns

Promise<Contract>

Inherited from

TokenERC20._deployed


_wrapEvent

_wrapEvent(runningEvent, log, listener): Event

Parameters

NameType
runningEventRunningEvent
logLog
listenerListener

Returns

Event

Inherited from

TokenERC20._wrapEvent


allowance

allowance(owner, spender, overrides?): Promise<BigNumber>

Parameters

NameType
ownerPromiseOrValue<string>
spenderPromiseOrValue<string>
overrides?CallOverrides

Returns

Promise<BigNumber>

Inherited from

TokenERC20.allowance


approve

approve(spender, amount, overrides?): Promise<ContractTransaction>

Parameters

NameType
spenderPromiseOrValue<string>
amountPromiseOrValue<BigNumberish>
overrides?Overrides & { from?: PromiseOrValue<string> }

Returns

Promise<ContractTransaction>

Inherited from

TokenERC20.approve


attach

attach(addressOrName): Erc20TokenClient

Parameters

NameType
addressOrNamestring

Returns

Erc20TokenClient

Inherited from

TokenERC20.attach


balanceOf

balanceOf(account, overrides?): Promise<BigNumber>

Parameters

NameType
accountPromiseOrValue<string>
overrides?CallOverrides

Returns

Promise<BigNumber>

Inherited from

TokenERC20.balanceOf


connect

connect(signerOrProvider): Erc20TokenClient

Parameters

NameType
signerOrProviderstring | Provider | Signer

Returns

Erc20TokenClient

Inherited from

TokenERC20.connect


decimals

decimals(overrides?): Promise<number>

Parameters

NameType
overrides?CallOverrides

Returns

Promise<number>

Inherited from

TokenERC20.decimals


decreaseAllowance

decreaseAllowance(spender, subtractedValue, overrides?): Promise<ContractTransaction>

Parameters

NameType
spenderPromiseOrValue<string>
subtractedValuePromiseOrValue<BigNumberish>
overrides?Overrides & { from?: PromiseOrValue<string> }

Returns

Promise<ContractTransaction>

Inherited from

TokenERC20.decreaseAllowance


deployed

deployed(): Promise<Erc20TokenClient>

Returns

Promise<Erc20TokenClient>

Inherited from

TokenERC20.deployed


emit

emit(eventName, ...args): boolean

Parameters

NameType
eventNamestring | EventFilter
...argsany[]

Returns

boolean

Inherited from

TokenERC20.emit


fallback

fallback(overrides?): Promise<TransactionResponse>

Parameters

NameType
overrides?TransactionRequest

Returns

Promise<TransactionResponse>

Inherited from

TokenERC20.fallback


getTokenInfo

getTokenInfo(): Promise<TokenInfo>

Get the standard ERC20 token information

Returns

Promise<TokenInfo>


increaseAllowance

increaseAllowance(spender, addedValue, overrides?): Promise<ContractTransaction>

Parameters

NameType
spenderPromiseOrValue<string>
addedValuePromiseOrValue<BigNumberish>
overrides?Overrides & { from?: PromiseOrValue<string> }

Returns

Promise<ContractTransaction>

Inherited from

TokenERC20.increaseAllowance


listenerCount

listenerCount(eventName?): number

Parameters

NameType
eventName?string | EventFilter

Returns

number

Inherited from

TokenERC20.listenerCount


listeners

listeners<TEvent>(eventFilter?): TypedListener<TEvent>[]

Type parameters

NameType
TEventextends TypedEvent<any, any, TEvent>

Parameters

NameType
eventFilter?TypedEventFilter<TEvent>

Returns

TypedListener<TEvent>[]

Inherited from

TokenERC20.listeners

listeners(eventName?): Listener[]

Parameters

NameType
eventName?string

Returns

Listener[]

Inherited from

TokenERC20.listeners


name

name(overrides?): Promise<string>

Parameters

NameType
overrides?CallOverrides

Returns

Promise<string>

Inherited from

TokenERC20.name


queryFilter

queryFilter<TEvent>(event, fromBlockOrBlockhash?, toBlock?): Promise<TEvent[]>

Type parameters

NameType
TEventextends TypedEvent<any, any, TEvent>

Parameters

NameType
eventTypedEventFilter<TEvent>
fromBlockOrBlockhash?string | number
toBlock?string | number

Returns

Promise<TEvent[]>

Inherited from

TokenERC20.queryFilter


removeAllListeners

removeAllListeners<TEvent>(eventFilter): Erc20TokenClient

Type parameters

NameType
TEventextends TypedEvent<any, any, TEvent>

Parameters

NameType
eventFilterTypedEventFilter<TEvent>

Returns

Erc20TokenClient

Inherited from

TokenERC20.removeAllListeners

removeAllListeners(eventName?): Erc20TokenClient

Parameters

NameType
eventName?string

Returns

Erc20TokenClient

Inherited from

TokenERC20.removeAllListeners


symbol

symbol(overrides?): Promise<string>

Parameters

NameType
overrides?CallOverrides

Returns

Promise<string>

Inherited from

TokenERC20.symbol


totalSupply

totalSupply(overrides?): Promise<BigNumber>

Parameters

NameType
overrides?CallOverrides

Returns

Promise<BigNumber>

Inherited from

TokenERC20.totalSupply


transfer

transfer(to, amount, overrides?): Promise<ContractTransaction>

Parameters

NameType
toPromiseOrValue<string>
amountPromiseOrValue<BigNumberish>
overrides?Overrides & { from?: PromiseOrValue<string> }

Returns

Promise<ContractTransaction>

Inherited from

TokenERC20.transfer


transferFrom

transferFrom(from, to, amount, overrides?): Promise<ContractTransaction>

Parameters

NameType
fromPromiseOrValue<string>
toPromiseOrValue<string>
amountPromiseOrValue<BigNumberish>
overrides?Overrides & { from?: PromiseOrValue<string> }

Returns

Promise<ContractTransaction>

Inherited from

TokenERC20.transferFrom