ERC20 | @certusone/wormhole-sdk

Hierarchy

BaseContract
- ERC20

Index

Constructors

constructor

Properties

Constructors

constructor

new ERC20(addressOrName: string, contractInterface: ContractInterface, signerOrProvider?: Signer | Provider): ERC20

Inherited from BaseContract.constructor
- Defined in node_modules/@ethersproject/contracts/lib/index.d.ts:107
Parameters
- addressOrName: string
- contractInterface: ContractInterface
- Optional signerOrProvider: Signer | Provider
Returns ERC20

Properties

_deployedPromise

_deployedPromise: Promise<Contract>

_runningEvents

_runningEvents: {}

Type declaration

[eventTag: string]: RunningEvent

_wrappedEmits

_wrappedEmits: {}

Type declaration

[eventTag: string]: (...args: any[]) => void
- - (...args: any[]): void
  - Parameters
    - Rest ...args: any[]
    Returns void

Readonly address

address: string

callStatic

callStatic: { allowance: any; approve: any; balanceOf: any; decimals: any; decreaseAllowance: any; increaseAllowance: any; name: any; symbol: any; totalSupply: any; transfer: any; transferFrom: any }

Type declaration

allowance: function
- allowance(owner: string, spender: string, overrides?: CallOverrides): Promise<BigNumber>
- - Defined in src/ethers-contracts/ERC20.d.ts:346
  See {IERC20-allowance}.
  
  Parameters
  - owner: string
  - spender: string
  - Optional overrides: CallOverrides
  Returns Promise<BigNumber>
approve: function
- approve(spender: string, amount: BigNumberish, overrides?: CallOverrides): Promise<boolean>
- - Defined in src/ethers-contracts/ERC20.d.ts:355
  See {IERC20-approve}. Requirements: - spender cannot be the zero address.
  
  Parameters
  - spender: string
  - amount: BigNumberish
  - Optional overrides: CallOverrides
  Returns Promise<boolean>
balanceOf: function
- balanceOf(account: string, overrides?: CallOverrides): Promise<BigNumber>
- - Defined in src/ethers-contracts/ERC20.d.ts:332
  See {IERC20-balanceOf}.
  
  Parameters
  - account: string
  - Optional overrides: CallOverrides
  Returns Promise<BigNumber>
decimals: function
- decimals(overrides?: CallOverrides): Promise<number>
- - Defined in src/ethers-contracts/ERC20.d.ts:322
  Returns the number of decimals used to get its user representation. For example, if decimals equals 2, a balance of 505 tokens should be displayed to a user as 5.05 (505 / 10 ** 2). Tokens usually opt for a value of 18, imitating the relationship between Ether and Wei. This is the value {ERC20} uses, unless this function is overridden; NOTE: This information is only used for display purposes: it in no way affects any of the arithmetic of the contract, including {IERC20-balanceOf} and {IERC20-transfer}.
  
  Parameters
  - Optional overrides: CallOverrides
  Returns Promise<number>
decreaseAllowance: function
- decreaseAllowance(spender: string, subtractedValue: BigNumberish, overrides?: CallOverrides): Promise<boolean>
- - Defined in src/ethers-contracts/ERC20.d.ts:383
  Atomically decreases the allowance granted to spender by the caller. This is an alternative to {approve} that can be used as a mitigation for problems described in {IERC20-approve}. Emits an {Approval} event indicating the updated allowance. Requirements: - spender cannot be the zero address. - spender must have allowance for the caller of at least subtractedValue.
  
  Parameters
  - spender: string
  - subtractedValue: BigNumberish
  - Optional overrides: CallOverrides
  Returns Promise<boolean>
increaseAllowance: function
- increaseAllowance(spender: string, addedValue: BigNumberish, overrides?: CallOverrides): Promise<boolean>
- - Defined in src/ethers-contracts/ERC20.d.ts:374
  Atomically increases the allowance granted to spender by the caller. This is an alternative to {approve} that can be used as a mitigation for problems described in {IERC20-approve}. Emits an {Approval} event indicating the updated allowance. Requirements: - spender cannot be the zero address.
  
  Parameters
  - spender: string
  - addedValue: BigNumberish
  - Optional overrides: CallOverrides
  Returns Promise<boolean>
name: function
- name(overrides?: CallOverrides): Promise<string>
- - Defined in src/ethers-contracts/ERC20.d.ts:312
  Returns the name of the token.
  
  Parameters
  - Optional overrides: CallOverrides
  Returns Promise<string>
symbol: function
- symbol(overrides?: CallOverrides): Promise<string>
- - Defined in src/ethers-contracts/ERC20.d.ts:317
  Returns the symbol of the token, usually a shorter version of the name.
  
  Parameters
  - Optional overrides: CallOverrides
  Returns Promise<string>
totalSupply: function
- totalSupply(overrides?: CallOverrides): Promise<BigNumber>
- - Defined in src/ethers-contracts/ERC20.d.ts:327
  See {IERC20-totalSupply}.
  
  Parameters
  - Optional overrides: CallOverrides
  Returns Promise<BigNumber>
transfer: function
- transfer(recipient: string, amount: BigNumberish, overrides?: CallOverrides): Promise<boolean>
- - Defined in src/ethers-contracts/ERC20.d.ts:337
  See {IERC20-transfer}. Requirements: - recipient cannot be the zero address. - the caller must have a balance of at least amount.
  
  Parameters
  - recipient: string
  - amount: BigNumberish
  - Optional overrides: CallOverrides
  Returns Promise<boolean>
transferFrom: function
- transferFrom(sender: string, recipient: string, amount: BigNumberish, overrides?: CallOverrides): Promise<boolean>
- - Defined in src/ethers-contracts/ERC20.d.ts:364
  See {IERC20-transferFrom}. Emits an {Approval} event indicating the updated allowance. This is not required by the EIP. See the note at the beginning of {ERC20}. Requirements: - sender and recipient cannot be the zero address. - sender must have a balance of at least amount. - the caller must have allowance for sender's tokens of at least amount.
  
  Parameters
  - sender: string
  - recipient: string
  - amount: BigNumberish
  - Optional overrides: CallOverrides
  Returns Promise<boolean>

Readonly deployTransaction

deployTransaction: TransactionResponse

estimateGas

estimateGas: { allowance: any; approve: any; balanceOf: any; decimals: any; decreaseAllowance: any; increaseAllowance: any; name: any; symbol: any; totalSupply: any; transfer: any; transferFrom: any }

Type declaration

allowance: function
- allowance(owner: string, spender: string, overrides?: CallOverrides): Promise<BigNumber>
- - Defined in src/ethers-contracts/ERC20.d.ts:448
  See {IERC20-allowance}.
  
  Parameters
  - owner: string
  - spender: string
  - Optional overrides: CallOverrides
  Returns Promise<BigNumber>
approve: function
- approve(spender: string, amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>
- - Defined in src/ethers-contracts/ERC20.d.ts:457
  See {IERC20-approve}. Requirements: - spender cannot be the zero address.
  
  Parameters
  - spender: string
  - amount: BigNumberish
  - Optional overrides: Overrides & { from?: string | Promise<string> }
  Returns Promise<BigNumber>
balanceOf: function
- balanceOf(account: string, overrides?: CallOverrides): Promise<BigNumber>
- - Defined in src/ethers-contracts/ERC20.d.ts:434
  See {IERC20-balanceOf}.
  
  Parameters
  - account: string
  - Optional overrides: CallOverrides
  Returns Promise<BigNumber>
decimals: function
- decimals(overrides?: CallOverrides): Promise<BigNumber>
- - Defined in src/ethers-contracts/ERC20.d.ts:424
  Returns the number of decimals used to get its user representation. For example, if decimals equals 2, a balance of 505 tokens should be displayed to a user as 5.05 (505 / 10 ** 2). Tokens usually opt for a value of 18, imitating the relationship between Ether and Wei. This is the value {ERC20} uses, unless this function is overridden; NOTE: This information is only used for display purposes: it in no way affects any of the arithmetic of the contract, including {IERC20-balanceOf} and {IERC20-transfer}.
  
  Parameters
  - Optional overrides: CallOverrides
  Returns Promise<BigNumber>
decreaseAllowance: function
- decreaseAllowance(spender: string, subtractedValue: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>
- - Defined in src/ethers-contracts/ERC20.d.ts:485
  Atomically decreases the allowance granted to spender by the caller. This is an alternative to {approve} that can be used as a mitigation for problems described in {IERC20-approve}. Emits an {Approval} event indicating the updated allowance. Requirements: - spender cannot be the zero address. - spender must have allowance for the caller of at least subtractedValue.
  
  Parameters
  - spender: string
  - subtractedValue: BigNumberish
  - Optional overrides: Overrides & { from?: string | Promise<string> }
  Returns Promise<BigNumber>
increaseAllowance: function
- increaseAllowance(spender: string, addedValue: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>
- - Defined in src/ethers-contracts/ERC20.d.ts:476
  Atomically increases the allowance granted to spender by the caller. This is an alternative to {approve} that can be used as a mitigation for problems described in {IERC20-approve}. Emits an {Approval} event indicating the updated allowance. Requirements: - spender cannot be the zero address.
  
  Parameters
  - spender: string
  - addedValue: BigNumberish
  - Optional overrides: Overrides & { from?: string | Promise<string> }
  Returns Promise<BigNumber>
name: function
- name(overrides?: CallOverrides): Promise<BigNumber>
- - Defined in src/ethers-contracts/ERC20.d.ts:414
  Returns the name of the token.
  
  Parameters
  - Optional overrides: CallOverrides
  Returns Promise<BigNumber>
symbol: function
- symbol(overrides?: CallOverrides): Promise<BigNumber>
- - Defined in src/ethers-contracts/ERC20.d.ts:419
  Returns the symbol of the token, usually a shorter version of the name.
  
  Parameters
  - Optional overrides: CallOverrides
  Returns Promise<BigNumber>
totalSupply: function
- totalSupply(overrides?: CallOverrides): Promise<BigNumber>
- - Defined in src/ethers-contracts/ERC20.d.ts:429
  See {IERC20-totalSupply}.
  
  Parameters
  - Optional overrides: CallOverrides
  Returns Promise<BigNumber>
transfer: function
- transfer(recipient: string, amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>
- - Defined in src/ethers-contracts/ERC20.d.ts:439
  See {IERC20-transfer}. Requirements: - recipient cannot be the zero address. - the caller must have a balance of at least amount.
  
  Parameters
  - recipient: string
  - amount: BigNumberish
  - Optional overrides: Overrides & { from?: string | Promise<string> }
  Returns Promise<BigNumber>
transferFrom: function
- transferFrom(sender: string, recipient: string, amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>
- - Defined in src/ethers-contracts/ERC20.d.ts:466
  See {IERC20-transferFrom}. Emits an {Approval} event indicating the updated allowance. This is not required by the EIP. See the note at the beginning of {ERC20}. Requirements: - sender and recipient cannot be the zero address. - sender must have a balance of at least amount. - the caller must have allowance for sender's tokens of at least amount.
  
  Parameters
  - sender: string
  - recipient: string
  - amount: BigNumberish
  - Optional overrides: Overrides & { from?: string | Promise<string> }
  Returns Promise<BigNumber>

filters

filters: { Approval: any; Transfer: any }

Type declaration

Approval: function
- Approval(owner?: null | string, spender?: null | string, value?: null): TypedEventFilter<[string, string, BigNumber], { owner: string; spender: string; value: BigNumber }>
- - Defined in src/ethers-contracts/ERC20.d.ts:391
  Parameters
  - Optional owner: null | string
  - Optional spender: null | string
  - Optional value: null
  Returns TypedEventFilter<[string, string, BigNumber], { owner: string; spender: string; value: BigNumber }>
Transfer: function
- Transfer(from?: null | string, to?: null | string, value?: null): TypedEventFilter<[string, string, BigNumber], { from: string; to: string; value: BigNumber }>
- - Defined in src/ethers-contracts/ERC20.d.ts:400
  Parameters
  - Optional from: null | string
  - Optional to: null | string
  - Optional value: null
  Returns TypedEventFilter<[string, string, BigNumber], { from: string; to: string; value: BigNumber }>

functions

functions: { allowance: any; approve: any; balanceOf: any; decimals: any; decreaseAllowance: any; increaseAllowance: any; name: any; symbol: any; totalSupply: any; transfer: any; transferFrom: any }

Type declaration

allowance: function
- allowance(owner: string, spender: string, overrides?: CallOverrides): Promise<[BigNumber]>
- - Defined in src/ethers-contracts/ERC20.d.ts:184
  See {IERC20-allowance}.
  
  Parameters
  - owner: string
  - spender: string
  - Optional overrides: CallOverrides
  Returns Promise<[BigNumber]>
approve: function
- approve(spender: string, amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>
- - Defined in src/ethers-contracts/ERC20.d.ts:193
  See {IERC20-approve}. Requirements: - spender cannot be the zero address.
  
  Parameters
  - spender: string
  - amount: BigNumberish
  - Optional overrides: Overrides & { from?: string | Promise<string> }
  Returns Promise<ContractTransaction>
balanceOf: function
- balanceOf(account: string, overrides?: CallOverrides): Promise<[BigNumber]>
- - Defined in src/ethers-contracts/ERC20.d.ts:170
  See {IERC20-balanceOf}.
  
  Parameters
  - account: string
  - Optional overrides: CallOverrides
  Returns Promise<[BigNumber]>
decimals: function
- decimals(overrides?: CallOverrides): Promise<[number]>
- - Defined in src/ethers-contracts/ERC20.d.ts:160
  Returns the number of decimals used to get its user representation. For example, if decimals equals 2, a balance of 505 tokens should be displayed to a user as 5.05 (505 / 10 ** 2). Tokens usually opt for a value of 18, imitating the relationship between Ether and Wei. This is the value {ERC20} uses, unless this function is overridden; NOTE: This information is only used for display purposes: it in no way affects any of the arithmetic of the contract, including {IERC20-balanceOf} and {IERC20-transfer}.
  
  Parameters
  - Optional overrides: CallOverrides
  Returns Promise<[number]>
decreaseAllowance: function
- decreaseAllowance(spender: string, subtractedValue: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>
- - Defined in src/ethers-contracts/ERC20.d.ts:221
  Atomically decreases the allowance granted to spender by the caller. This is an alternative to {approve} that can be used as a mitigation for problems described in {IERC20-approve}. Emits an {Approval} event indicating the updated allowance. Requirements: - spender cannot be the zero address. - spender must have allowance for the caller of at least subtractedValue.
  
  Parameters
  - spender: string
  - subtractedValue: BigNumberish
  - Optional overrides: Overrides & { from?: string | Promise<string> }
  Returns Promise<ContractTransaction>
increaseAllowance: function
- increaseAllowance(spender: string, addedValue: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>
- - Defined in src/ethers-contracts/ERC20.d.ts:212
  Atomically increases the allowance granted to spender by the caller. This is an alternative to {approve} that can be used as a mitigation for problems described in {IERC20-approve}. Emits an {Approval} event indicating the updated allowance. Requirements: - spender cannot be the zero address.
  
  Parameters
  - spender: string
  - addedValue: BigNumberish
  - Optional overrides: Overrides & { from?: string | Promise<string> }
  Returns Promise<ContractTransaction>
name: function
- name(overrides?: CallOverrides): Promise<[string]>
- - Defined in src/ethers-contracts/ERC20.d.ts:150
  Returns the name of the token.
  
  Parameters
  - Optional overrides: CallOverrides
  Returns Promise<[string]>
symbol: function
- symbol(overrides?: CallOverrides): Promise<[string]>
- - Defined in src/ethers-contracts/ERC20.d.ts:155
  Returns the symbol of the token, usually a shorter version of the name.
  
  Parameters
  - Optional overrides: CallOverrides
  Returns Promise<[string]>
totalSupply: function
- totalSupply(overrides?: CallOverrides): Promise<[BigNumber]>
- - Defined in src/ethers-contracts/ERC20.d.ts:165
  See {IERC20-totalSupply}.
  
  Parameters
  - Optional overrides: CallOverrides
  Returns Promise<[BigNumber]>
transfer: function
- transfer(recipient: string, amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>
- - Defined in src/ethers-contracts/ERC20.d.ts:175
  See {IERC20-transfer}. Requirements: - recipient cannot be the zero address. - the caller must have a balance of at least amount.
  
  Parameters
  - recipient: string
  - amount: BigNumberish
  - Optional overrides: Overrides & { from?: string | Promise<string> }
  Returns Promise<ContractTransaction>
transferFrom: function
- transferFrom(sender: string, recipient: string, amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>
- - Defined in src/ethers-contracts/ERC20.d.ts:202
  See {IERC20-transferFrom}. Emits an {Approval} event indicating the updated allowance. This is not required by the EIP. See the note at the beginning of {ERC20}. Requirements: - sender and recipient cannot be the zero address. - sender must have a balance of at least amount. - the caller must have allowance for sender's tokens of at least amount.
  
  Parameters
  - sender: string
  - recipient: string
  - amount: BigNumberish
  - Optional overrides: Overrides & { from?: string | Promise<string> }
  Returns Promise<ContractTransaction>

interface

interface: ERC20Interface

populateTransaction

populateTransaction: { allowance: any; approve: any; balanceOf: any; decimals: any; decreaseAllowance: any; increaseAllowance: any; name: any; symbol: any; totalSupply: any; transfer: any; transferFrom: any }

Type declaration

allowance: function
- allowance(owner: string, spender: string, overrides?: CallOverrides): Promise<PopulatedTransaction>
- - Defined in src/ethers-contracts/ERC20.d.ts:533
  See {IERC20-allowance}.
  
  Parameters
  - owner: string
  - spender: string
  - Optional overrides: CallOverrides
  Returns Promise<PopulatedTransaction>
approve: function
- approve(spender: string, amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>
- - Defined in src/ethers-contracts/ERC20.d.ts:542
  See {IERC20-approve}. Requirements: - spender cannot be the zero address.
  
  Parameters
  - spender: string
  - amount: BigNumberish
  - Optional overrides: Overrides & { from?: string | Promise<string> }
  Returns Promise<PopulatedTransaction>
balanceOf: function
- balanceOf(account: string, overrides?: CallOverrides): Promise<PopulatedTransaction>
- - Defined in src/ethers-contracts/ERC20.d.ts:516
  See {IERC20-balanceOf}.
  
  Parameters
  - account: string
  - Optional overrides: CallOverrides
  Returns Promise<PopulatedTransaction>
decimals: function
- decimals(overrides?: CallOverrides): Promise<PopulatedTransaction>
- - Defined in src/ethers-contracts/ERC20.d.ts:506
  Returns the number of decimals used to get its user representation. For example, if decimals equals 2, a balance of 505 tokens should be displayed to a user as 5.05 (505 / 10 ** 2). Tokens usually opt for a value of 18, imitating the relationship between Ether and Wei. This is the value {ERC20} uses, unless this function is overridden; NOTE: This information is only used for display purposes: it in no way affects any of the arithmetic of the contract, including {IERC20-balanceOf} and {IERC20-transfer}.
  
  Parameters
  - Optional overrides: CallOverrides
  Returns Promise<PopulatedTransaction>
decreaseAllowance: function
- decreaseAllowance(spender: string, subtractedValue: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>
- - Defined in src/ethers-contracts/ERC20.d.ts:570
  Atomically decreases the allowance granted to spender by the caller. This is an alternative to {approve} that can be used as a mitigation for problems described in {IERC20-approve}. Emits an {Approval} event indicating the updated allowance. Requirements: - spender cannot be the zero address. - spender must have allowance for the caller of at least subtractedValue.
  
  Parameters
  - spender: string
  - subtractedValue: BigNumberish
  - Optional overrides: Overrides & { from?: string | Promise<string> }
  Returns Promise<PopulatedTransaction>
increaseAllowance: function
- increaseAllowance(spender: string, addedValue: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>
- - Defined in src/ethers-contracts/ERC20.d.ts:561
  Atomically increases the allowance granted to spender by the caller. This is an alternative to {approve} that can be used as a mitigation for problems described in {IERC20-approve}. Emits an {Approval} event indicating the updated allowance. Requirements: - spender cannot be the zero address.
  
  Parameters
  - spender: string
  - addedValue: BigNumberish
  - Optional overrides: Overrides & { from?: string | Promise<string> }
  Returns Promise<PopulatedTransaction>
name: function
- name(overrides?: CallOverrides): Promise<PopulatedTransaction>
- - Defined in src/ethers-contracts/ERC20.d.ts:496
  Returns the name of the token.
  
  Parameters
  - Optional overrides: CallOverrides
  Returns Promise<PopulatedTransaction>
symbol: function
- symbol(overrides?: CallOverrides): Promise<PopulatedTransaction>
- - Defined in src/ethers-contracts/ERC20.d.ts:501
  Returns the symbol of the token, usually a shorter version of the name.
  
  Parameters
  - Optional overrides: CallOverrides
  Returns Promise<PopulatedTransaction>
totalSupply: function
- totalSupply(overrides?: CallOverrides): Promise<PopulatedTransaction>
- - Defined in src/ethers-contracts/ERC20.d.ts:511
  See {IERC20-totalSupply}.
  
  Parameters
  - Optional overrides: CallOverrides
  Returns Promise<PopulatedTransaction>
transfer: function
- transfer(recipient: string, amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>
- - Defined in src/ethers-contracts/ERC20.d.ts:524
  See {IERC20-transfer}. Requirements: - recipient cannot be the zero address. - the caller must have a balance of at least amount.
  
  Parameters
  - recipient: string
  - amount: BigNumberish
  - Optional overrides: Overrides & { from?: string | Promise<string> }
  Returns Promise<PopulatedTransaction>
transferFrom: function
- transferFrom(sender: string, recipient: string, amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>
- - Defined in src/ethers-contracts/ERC20.d.ts:551
  See {IERC20-transferFrom}. Emits an {Approval} event indicating the updated allowance. This is not required by the EIP. See the note at the beginning of {ERC20}. Requirements: - sender and recipient cannot be the zero address. - sender must have a balance of at least amount. - the caller must have allowance for sender's tokens of at least amount.
  
  Parameters
  - sender: string
  - recipient: string
  - amount: BigNumberish
  - Optional overrides: Overrides & { from?: string | Promise<string> }
  Returns Promise<PopulatedTransaction>

Readonly provider

provider: Provider

Readonly resolvedAddress

resolvedAddress: Promise<string>

Readonly signer

signer: Signer

Methods

_checkRunningEvents

_checkRunningEvents(runningEvent: RunningEvent): void

Inherited from BaseContract._checkRunningEvents
- Defined in node_modules/@ethersproject/contracts/lib/index.d.ts:121
Parameters
- runningEvent: RunningEvent
Returns void

_deployed

_deployed(blockTag?: BlockTag): Promise<Contract>

Inherited from BaseContract._deployed
- Defined in node_modules/@ethersproject/contracts/lib/index.d.ts:114
Parameters
- Optional blockTag: BlockTag
Returns Promise<Contract>

_wrapEvent

_wrapEvent(runningEvent: RunningEvent, log: Log, listener: Listener): Event

Inherited from BaseContract._wrapEvent
- Defined in node_modules/@ethersproject/contracts/lib/index.d.ts:122
Parameters
- runningEvent: RunningEvent
- log: Log
- listener: Listener
Returns Event

allowance

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

- Defined in src/ethers-contracts/ERC20.d.ts:265
See {IERC20-allowance}.

Parameters
- owner: string
- spender: string
- Optional overrides: CallOverrides
Returns Promise<BigNumber>

approve

approve(spender: string, amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

- Defined in src/ethers-contracts/ERC20.d.ts:274
See {IERC20-approve}. Requirements: - spender cannot be the zero address.

Parameters
- spender: string
- amount: BigNumberish
- Optional overrides: Overrides & { from?: string | Promise<string> }
Returns Promise<ContractTransaction>

attach

attach(addressOrName: string): ERC20

Overrides BaseContract.attach
- Defined in src/ethers-contracts/ERC20.d.ts:105
Parameters
- addressOrName: string
Returns ERC20

balanceOf

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

- Defined in src/ethers-contracts/ERC20.d.ts:251
See {IERC20-balanceOf}.

Parameters
- account: string
- Optional overrides: CallOverrides
Returns Promise<BigNumber>

connect

connect(signerOrProvider: string | Signer | Provider): ERC20

Overrides BaseContract.connect
- Defined in src/ethers-contracts/ERC20.d.ts:104
Parameters
- signerOrProvider: string | Signer | Provider
Returns ERC20

decimals

decimals(overrides?: CallOverrides): Promise<number>

- Defined in src/ethers-contracts/ERC20.d.ts:241
Returns the number of decimals used to get its user representation. For example, if decimals equals 2, a balance of 505 tokens should be displayed to a user as 5.05 (505 / 10 ** 2). Tokens usually opt for a value of 18, imitating the relationship between Ether and Wei. This is the value {ERC20} uses, unless this function is overridden; NOTE: This information is only used for display purposes: it in no way affects any of the arithmetic of the contract, including {IERC20-balanceOf} and {IERC20-transfer}.

Parameters
- Optional overrides: CallOverrides
Returns Promise<number>

decreaseAllowance

decreaseAllowance(spender: string, subtractedValue: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

- Defined in src/ethers-contracts/ERC20.d.ts:302
Atomically decreases the allowance granted to spender by the caller. This is an alternative to {approve} that can be used as a mitigation for problems described in {IERC20-approve}. Emits an {Approval} event indicating the updated allowance. Requirements: - spender cannot be the zero address. - spender must have allowance for the caller of at least subtractedValue.

Parameters
- spender: string
- subtractedValue: BigNumberish
- Optional overrides: Overrides & { from?: string | Promise<string> }
Returns Promise<ContractTransaction>

deployed

deployed(): Promise<ERC20>

Overrides BaseContract.deployed
- Defined in src/ethers-contracts/ERC20.d.ts:106
Returns Promise<ERC20>

emit

emit(eventName: string | EventFilter, ...args: any[]): boolean

Inherited from BaseContract.emit
- Defined in node_modules/@ethersproject/contracts/lib/index.d.ts:127
Parameters
- eventName: string | EventFilter
- Rest ...args: any[]
Returns boolean

fallback

fallback(overrides?: TransactionRequest): Promise<TransactionResponse>

Inherited from BaseContract.fallback
- Defined in node_modules/@ethersproject/contracts/lib/index.d.ts:115
Parameters
- Optional overrides: TransactionRequest
Returns Promise<TransactionResponse>

increaseAllowance

increaseAllowance(spender: string, addedValue: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

- Defined in src/ethers-contracts/ERC20.d.ts:293
Atomically increases the allowance granted to spender by the caller. This is an alternative to {approve} that can be used as a mitigation for problems described in {IERC20-approve}. Emits an {Approval} event indicating the updated allowance. Requirements: - spender cannot be the zero address.

Parameters
- spender: string
- addedValue: BigNumberish
- Optional overrides: Overrides & { from?: string | Promise<string> }
Returns Promise<ContractTransaction>

listenerCount

listenerCount(eventName?: string | EventFilter): number

Inherited from BaseContract.listenerCount
- Defined in node_modules/@ethersproject/contracts/lib/index.d.ts:128
Parameters
- Optional eventName: string | EventFilter
Returns number

listeners

listeners<EventArgsArray, EventArgsObject>(eventFilter?: TypedEventFilter<EventArgsArray, EventArgsObject>): TypedListener<EventArgsArray, EventArgsObject>[]
listeners(eventName?: string): Listener[]

Overrides BaseContract.listeners
- Defined in src/ethers-contracts/ERC20.d.ts:108
Type parameters
- EventArgsArray: any[]
- EventArgsObject
Parameters
- Optional eventFilter: TypedEventFilter<EventArgsArray, EventArgsObject>
Returns TypedListener<EventArgsArray, EventArgsObject>[]
Overrides BaseContract.listeners
- Defined in src/ethers-contracts/ERC20.d.ts:131
Parameters
- Optional eventName: string
Returns Listener[]

name

name(overrides?: CallOverrides): Promise<string>

- Defined in src/ethers-contracts/ERC20.d.ts:231
Returns the name of the token.

Parameters
- Optional overrides: CallOverrides
Returns Promise<string>

off

off<EventArgsArray, EventArgsObject>(eventFilter: TypedEventFilter<EventArgsArray, EventArgsObject>, listener: TypedListener<EventArgsArray, EventArgsObject>): ERC20
off(eventName: string, listener: Listener): ERC20

Overrides BaseContract.off
- Defined in src/ethers-contracts/ERC20.d.ts:111
Type parameters
- EventArgsArray: any[]
- EventArgsObject
Parameters
- eventFilter: TypedEventFilter<EventArgsArray, EventArgsObject>
- listener: TypedListener<EventArgsArray, EventArgsObject>
Returns ERC20
Overrides BaseContract.off
- Defined in src/ethers-contracts/ERC20.d.ts:132
Parameters
- eventName: string
- listener: Listener
Returns ERC20

on

on<EventArgsArray, EventArgsObject>(eventFilter: TypedEventFilter<EventArgsArray, EventArgsObject>, listener: TypedListener<EventArgsArray, EventArgsObject>): ERC20
on(eventName: string, listener: Listener): ERC20

Overrides BaseContract.on
- Defined in src/ethers-contracts/ERC20.d.ts:115
Type parameters
- EventArgsArray: any[]
- EventArgsObject
Parameters
- eventFilter: TypedEventFilter<EventArgsArray, EventArgsObject>
- listener: TypedListener<EventArgsArray, EventArgsObject>
Returns ERC20
Overrides BaseContract.on
- Defined in src/ethers-contracts/ERC20.d.ts:133
Parameters
- eventName: string
- listener: Listener
Returns ERC20

once

once<EventArgsArray, EventArgsObject>(eventFilter: TypedEventFilter<EventArgsArray, EventArgsObject>, listener: TypedListener<EventArgsArray, EventArgsObject>): ERC20
once(eventName: string, listener: Listener): ERC20

Overrides BaseContract.once
- Defined in src/ethers-contracts/ERC20.d.ts:119
Type parameters
- EventArgsArray: any[]
- EventArgsObject
Parameters
- eventFilter: TypedEventFilter<EventArgsArray, EventArgsObject>
- listener: TypedListener<EventArgsArray, EventArgsObject>
Returns ERC20
Overrides BaseContract.once
- Defined in src/ethers-contracts/ERC20.d.ts:134
Parameters
- eventName: string
- listener: Listener
Returns ERC20

queryFilter

queryFilter<EventArgsArray, EventArgsObject>(event: TypedEventFilter<EventArgsArray, EventArgsObject>, fromBlockOrBlockhash?: string | number, toBlock?: string | number): Promise<TypedEvent<EventArgsArray & EventArgsObject>[]>

Overrides BaseContract.queryFilter
- Defined in src/ethers-contracts/ERC20.d.ts:138
Type parameters
- EventArgsArray: any[]
- EventArgsObject
Parameters
- event: TypedEventFilter<EventArgsArray, EventArgsObject>
- Optional fromBlockOrBlockhash: string | number
- Optional toBlock: string | number
Returns Promise<TypedEvent<EventArgsArray & EventArgsObject>[]>

removeAllListeners

removeAllListeners<EventArgsArray, EventArgsObject>(eventFilter: TypedEventFilter<EventArgsArray, EventArgsObject>): ERC20
removeAllListeners(eventName?: string): ERC20

Overrides BaseContract.removeAllListeners
- Defined in src/ethers-contracts/ERC20.d.ts:127
Type parameters
- EventArgsArray: any[]
- EventArgsObject
Parameters
- eventFilter: TypedEventFilter<EventArgsArray, EventArgsObject>
Returns ERC20
Overrides BaseContract.removeAllListeners
- Defined in src/ethers-contracts/ERC20.d.ts:136
Parameters
- Optional eventName: string
Returns ERC20

removeListener

removeListener<EventArgsArray, EventArgsObject>(eventFilter: TypedEventFilter<EventArgsArray, EventArgsObject>, listener: TypedListener<EventArgsArray, EventArgsObject>): ERC20
removeListener(eventName: string, listener: Listener): ERC20

Overrides BaseContract.removeListener
- Defined in src/ethers-contracts/ERC20.d.ts:123
Type parameters
- EventArgsArray: any[]
- EventArgsObject
Parameters
- eventFilter: TypedEventFilter<EventArgsArray, EventArgsObject>
- listener: TypedListener<EventArgsArray, EventArgsObject>
Returns ERC20
Overrides BaseContract.removeListener
- Defined in src/ethers-contracts/ERC20.d.ts:135
Parameters
- eventName: string
- listener: Listener
Returns ERC20

symbol

symbol(overrides?: CallOverrides): Promise<string>

- Defined in src/ethers-contracts/ERC20.d.ts:236
Returns the symbol of the token, usually a shorter version of the name.

Parameters
- Optional overrides: CallOverrides
Returns Promise<string>

totalSupply

totalSupply(overrides?: CallOverrides): Promise<BigNumber>

- Defined in src/ethers-contracts/ERC20.d.ts:246
See {IERC20-totalSupply}.

Parameters
- Optional overrides: CallOverrides
Returns Promise<BigNumber>

transfer

transfer(recipient: string, amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

- Defined in src/ethers-contracts/ERC20.d.ts:256
See {IERC20-transfer}. Requirements: - recipient cannot be the zero address. - the caller must have a balance of at least amount.

Parameters
- recipient: string
- amount: BigNumberish
- Optional overrides: Overrides & { from?: string | Promise<string> }
Returns Promise<ContractTransaction>

transferFrom

transferFrom(sender: string, recipient: string, amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

- Defined in src/ethers-contracts/ERC20.d.ts:283
See {IERC20-transferFrom}. Emits an {Approval} event indicating the updated allowance. This is not required by the EIP. See the note at the beginning of {ERC20}. Requirements: - sender and recipient cannot be the zero address. - sender must have a balance of at least amount. - the caller must have allowance for sender's tokens of at least amount.

Parameters
- sender: string
- recipient: string
- amount: BigNumberish
- Optional overrides: Overrides & { from?: string | Promise<string> }
Returns Promise<ContractTransaction>

Static getContractAddress

getContractAddress(transaction: { from: string; nonce: BigNumberish }): string

Inherited from BaseContract.getContractAddress
- Defined in node_modules/@ethersproject/contracts/lib/index.d.ts:108
Parameters
- transaction: { from: string; nonce: BigNumberish }
  - from: string
  - nonce: BigNumberish
Returns string

Static getInterface

getInterface(contractInterface: ContractInterface): Interface

Inherited from BaseContract.getInterface
- Defined in node_modules/@ethersproject/contracts/lib/index.d.ts:112
Parameters
- contractInterface: ContractInterface
Returns Interface

Static isIndexed

isIndexed(value: any): value is Indexed

Inherited from BaseContract.isIndexed
- Defined in node_modules/@ethersproject/contracts/lib/index.d.ts:118
Parameters
- value: any
Returns value is Indexed

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

addressOrName: string

contractInterface: ContractInterface

Optional signerOrProvider: Signer | Provider

Returns ERC20

Properties

_deployedPromise

_runningEvents

Type declaration

[eventTag: string]: RunningEvent

_wrappedEmits

Type declaration

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

Parameters

Rest ...args: any[]

Returns void

Readonly address

callStatic

Type declaration

allowance: function

Parameters

owner: string

spender: string

Optional overrides: CallOverrides

Returns Promise<BigNumber>

approve: function

Parameters

spender: string

amount: BigNumberish

Optional overrides: CallOverrides

Returns Promise<boolean>

balanceOf: function

Parameters

account: string

Optional overrides: CallOverrides

Returns Promise<BigNumber>

decimals: function

Parameters

Optional overrides: CallOverrides

Returns Promise<number>

decreaseAllowance: function

Parameters

spender: string

subtractedValue: BigNumberish

Optional overrides: CallOverrides

Returns Promise<boolean>

increaseAllowance: function

Parameters

spender: string

addedValue: BigNumberish

Optional overrides: CallOverrides

Returns Promise<boolean>

name: function

Parameters

Optional overrides: CallOverrides

Returns Promise<string>

symbol: function

Parameters

Optional overrides: CallOverrides

Returns Promise<string>

totalSupply: function

Parameters

Optional overrides: CallOverrides

Returns Promise<BigNumber>

transfer: function

Parameters

recipient: string

amount: BigNumberish

Optional overrides: CallOverrides

Returns Promise<boolean>

transferFrom: function

Parameters

sender: string