ERC20

[# Masa SDK

• v3.1.2](/docs/developers/sdk/) / Exports / ERC20

Interface: ERC20

Hierarchy

• BaseContract

  ↳ ERC20

Table of contents

Properties

• _deployedPromise
• _runningEvents
• _wrappedEmits
• address
• callStatic
• deployTransaction
• estimateGas
• filters
• functions
• interface
• off
• on
• once
• populateTransaction
• provider
• removeListener
• resolvedAddress
• signer

Methods

• _checkRunningEvents
• _deployed
• _wrapEvent
• allowance
• approve
• attach
• balanceOf
• connect
• decimals
• decreaseAllowance
• deployed
• emit
• fallback
• increaseAllowance
• listenerCount
• listeners
• name
• queryFilter
• removeAllListeners
• symbol
• totalSupply
• transfer
• transferFrom

Properties

_deployedPromise

• _deployedPromise: Promise<Contract>

Inherited from

BaseContract._deployedPromise

---

_runningEvents

• _runningEvents: Object

Index signature

▪ [eventTag: string]: RunningEvent

Inherited from

BaseContract._runningEvents

---

_wrappedEmits

• _wrappedEmits: Object

Index signature

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

Inherited from

BaseContract._wrappedEmits

---

address

• Readonly address: string

Inherited from

BaseContract.address

---

callStatic

• callStatic: Object

Type declaration

Name	Type
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>

Overrides

BaseContract.callStatic

---

deployTransaction

• Readonly deployTransaction: TransactionResponse

Inherited from

BaseContract.deployTransaction

---

estimateGas

• estimateGas: Object

Type declaration

Name	Type
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>

Overrides

BaseContract.estimateGas

---

filters

• filters: Object

Type declaration

Name	Type
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

Overrides

BaseContract.filters

---

functions

• functions: Object

Type declaration

Name	Type
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>

Overrides

BaseContract.functions

---

interface

• interface: ERC20Interface

Overrides

BaseContract.interface

---

off

• off: OnEvent<ERC20>

Overrides

BaseContract.off

---

on

• on: OnEvent<ERC20>

Overrides

BaseContract.on

---

once

• once: OnEvent<ERC20>

Overrides

BaseContract.once

---

populateTransaction

• populateTransaction: Object

Type declaration

Name	Type
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>

Overrides

BaseContract.populateTransaction

---

provider

• Readonly provider: Provider

Inherited from

BaseContract.provider

---

removeListener

• removeListener: OnEvent<ERC20>

Overrides

BaseContract.removeListener

---

resolvedAddress

• Readonly resolvedAddress: Promise<string>

Inherited from

BaseContract.resolvedAddress

---

signer

• Readonly signer: Signer

Inherited from

BaseContract.signer

Methods

_checkRunningEvents

▸ _checkRunningEvents(runningEvent): void

Parameters

Name	Type
runningEvent	RunningEvent

Returns

void

Inherited from

BaseContract._checkRunningEvents

---

_deployed

▸ _deployed(blockTag?): Promise<Contract>

Parameters

Name	Type
blockTag?	BlockTag

Returns

Promise<Contract>

Inherited from

BaseContract._deployed

---

_wrapEvent

▸ _wrapEvent(runningEvent, log, listener): Event

Parameters

Name	Type
runningEvent	RunningEvent
log	Log
listener	Listener

Returns

Event

Inherited from

BaseContract._wrapEvent

---

allowance

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

Parameters

Name	Type
owner	PromiseOrValue<string>
spender	PromiseOrValue<string>
overrides?	CallOverrides

Returns

Promise<BigNumber>

---

approve

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

Parameters

Name	Type
spender	PromiseOrValue<string>
amount	PromiseOrValue<BigNumberish>
overrides?	Overrides & { from?: PromiseOrValue<string> }

Returns

Promise<ContractTransaction>

---

attach

▸ attach(addressOrName): ERC20

Parameters

Name	Type
addressOrName	string

Returns

ERC20

Overrides

BaseContract.attach

---

balanceOf

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

Parameters

Name	Type
account	PromiseOrValue<string>
overrides?	CallOverrides

Returns

Promise<BigNumber>

---

connect

▸ connect(signerOrProvider): ERC20

Parameters

Name	Type
signerOrProvider	string | Signer | Provider

Returns

ERC20

Overrides

BaseContract.connect

---

decimals

▸ decimals(overrides?): Promise<number>

Parameters

Name	Type
overrides?	CallOverrides

Returns

Promise<number>

---

decreaseAllowance

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

Parameters

Name	Type
spender	PromiseOrValue<string>
subtractedValue	PromiseOrValue<BigNumberish>
overrides?	Overrides & { from?: PromiseOrValue<string> }

Returns

Promise<ContractTransaction>

---

deployed

▸ deployed(): Promise<ERC20>

Returns

Promise<ERC20>

Overrides

BaseContract.deployed

---

emit

▸ emit(eventName, ...args): boolean

Parameters

Name	Type
eventName	string | EventFilter
...args	any[]

Returns

boolean

Inherited from

BaseContract.emit

---

fallback

▸ fallback(overrides?): Promise<TransactionResponse>

Parameters

Name	Type
overrides?	TransactionRequest

Returns

Promise<TransactionResponse>

Inherited from

BaseContract.fallback

---

increaseAllowance

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

Parameters

Name	Type
spender	PromiseOrValue<string>
addedValue	PromiseOrValue<BigNumberish>
overrides?	Overrides & { from?: PromiseOrValue<string> }

Returns

Promise<ContractTransaction>

---

listenerCount

▸ listenerCount(eventName?): number

Parameters

Name	Type
eventName?	string | EventFilter

Returns

number

Inherited from

BaseContract.listenerCount

---

listeners

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

Type parameters

Name	Type
TEvent	extends TypedEvent<any, any, TEvent>

Parameters

Name	Type
eventFilter?	TypedEventFilter<TEvent>

Returns

TypedListener<TEvent>[]

Overrides

BaseContract.listeners

▸ listeners(eventName?): Listener[]

Parameters

Name	Type
eventName?	string

Returns

Listener[]

Overrides

BaseContract.listeners

---

name

▸ name(overrides?): Promise<string>

Parameters

Name	Type
overrides?	CallOverrides

Returns

Promise<string>

---

queryFilter

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

Type parameters

Name	Type
TEvent	extends TypedEvent<any, any, TEvent>

Parameters

Name	Type
event	TypedEventFilter<TEvent>
fromBlockOrBlockhash?	string | number
toBlock?	string | number

Returns

Promise<TEvent[]>

Overrides

BaseContract.queryFilter

---

removeAllListeners

▸ removeAllListeners<TEvent>(eventFilter): ERC20

Type parameters

Name	Type
TEvent	extends TypedEvent<any, any, TEvent>

Parameters

Name	Type
eventFilter	TypedEventFilter<TEvent>

Returns

ERC20

Overrides

BaseContract.removeAllListeners

▸ removeAllListeners(eventName?): ERC20

Parameters

Name	Type
eventName?	string

Returns

ERC20

Overrides

BaseContract.removeAllListeners

---

symbol

▸ symbol(overrides?): Promise<string>

Parameters

Name	Type
overrides?	CallOverrides

Returns

Promise<string>

---

totalSupply

▸ totalSupply(overrides?): Promise<BigNumber>

Parameters

Name	Type
overrides?	CallOverrides

Returns

Promise<BigNumber>

---

transfer

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

Parameters

Name	Type
to	PromiseOrValue<string>
amount	PromiseOrValue<BigNumberish>
overrides?	Overrides & { from?: PromiseOrValue<string> }

Returns

Promise<ContractTransaction>

---

transferFrom

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

Parameters

Name	Type
from	PromiseOrValue<string>
to	PromiseOrValue<string>
amount	PromiseOrValue<BigNumberish>
overrides?	Overrides & { from?: PromiseOrValue<string> }

Returns

Promise<ContractTransaction>