contracts.ERC20

@bosonprotocol/ethers-sdk / Exports / contracts / ERC20

Interface: ERC20

contracts.ERC20

Hierarchy

• BaseContract

  ↳ ERC20

Table of contents

Properties

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

Methods

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

Properties

_deployedPromise

• _deployedPromise: Promise<Contract>

Inherited from

BaseContract._deployedPromise

Defined in

node_modules/@ethersproject/contracts/lib/index.d.ts:100

---

_runningEvents

• _runningEvents: Object

Index signature

▪ [eventTag: string]: RunningEvent

Inherited from

BaseContract._runningEvents

Defined in

node_modules/@ethersproject/contracts/lib/index.d.ts:101

---

_wrappedEmits

• _wrappedEmits: Object

Index signature

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

Inherited from

BaseContract._wrappedEmits

Defined in

node_modules/@ethersproject/contracts/lib/index.d.ts:104

---

address

• Readonly address: string

Inherited from

BaseContract.address

Defined in

node_modules/@ethersproject/contracts/lib/index.d.ts:79

---

callStatic

• callStatic: Object

Type declaration

Name	Type
allowance	(_owner: string, _spender: string, overrides?: CallOverrides) => Promise<BigNumber>
approve	(_spender: string, _value: BigNumberish, overrides?: CallOverrides) => Promise<boolean>
balanceOf	(_owner: string, overrides?: CallOverrides) => Promise<BigNumber>
decimals	(overrides?: CallOverrides) => Promise<number>
name	(overrides?: CallOverrides) => Promise<string>
symbol	(overrides?: CallOverrides) => Promise<string>
totalSupply	(overrides?: CallOverrides) => Promise<BigNumber>
transfer	(_to: string, _value: BigNumberish, overrides?: CallOverrides) => Promise<boolean>
transferFrom	(_from: string, _to: string, _value: BigNumberish, overrides?: CallOverrides) => Promise<boolean>

Overrides

BaseContract.callStatic

Defined in

src/contracts/ERC20.ts:200

---

contractName

• contractName: "ERC20"

Defined in

src/contracts/ERC20.ts:99

---

deployTransaction

• Readonly deployTransaction: TransactionResponse

Inherited from

BaseContract.deployTransaction

Defined in

node_modules/@ethersproject/contracts/lib/index.d.ts:99

---

estimateGas

• estimateGas: Object

Type declaration

Name	Type
allowance	(_owner: string, _spender: string, overrides?: CallOverrides) => Promise<BigNumber>
approve	(_spender: string, _value: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<BigNumber>
balanceOf	(_owner: string, overrides?: CallOverrides) => Promise<BigNumber>
decimals	(overrides?: CallOverrides) => Promise<BigNumber>
name	(overrides?: CallOverrides) => Promise<BigNumber>
symbol	(overrides?: CallOverrides) => Promise<BigNumber>
totalSupply	(overrides?: CallOverrides) => Promise<BigNumber>
transfer	(_to: string, _value: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<BigNumber>
transferFrom	(_from: string, _to: string, _value: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<BigNumber>

Overrides

BaseContract.estimateGas

Defined in

src/contracts/ERC20.ts:261

---

filters

• filters: Object

Type declaration

Name	Type
Approval	(owner?: string, spender?: string, value?: null) => ApprovalEventFilter
Approval(address,address,uint256)	(owner?: string, spender?: string, value?: null) => ApprovalEventFilter
Transfer	(from?: string, to?: string, value?: null) => TransferEventFilter
Transfer(address,address,uint256)	(from?: string, to?: string, value?: null) => TransferEventFilter

Overrides

BaseContract.filters

Defined in

src/contracts/ERC20.ts:237

---

functions

• functions: Object

Type declaration

Name	Type
allowance	(_owner: string, _spender: string, overrides?: CallOverrides) => Promise<[BigNumber]>
approve	(_spender: string, _value: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<ContractTransaction>
balanceOf	(_owner: string, overrides?: CallOverrides) => Promise<[BigNumber] & { balance: BigNumber }>
decimals	(overrides?: CallOverrides) => Promise<[number]>
name	(overrides?: CallOverrides) => Promise<[string]>
symbol	(overrides?: CallOverrides) => Promise<[string]>
totalSupply	(overrides?: CallOverrides) => Promise<[BigNumber]>
transfer	(_to: string, _value: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<ContractTransaction>
transferFrom	(_from: string, _to: string, _value: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<ContractTransaction>

Overrides

BaseContract.functions

Defined in

src/contracts/ERC20.ts:125

---

interface

• interface: ERC20Interface

Overrides

BaseContract.interface

Defined in

src/contracts/ERC20.ts:104

---

off

• off: OnEvent<ERC20>

Overrides

BaseContract.off

Defined in

src/contracts/ERC20.ts:120

---

on

• on: OnEvent<ERC20>

Overrides

BaseContract.on

Defined in

src/contracts/ERC20.ts:121

---

once

• once: OnEvent<ERC20>

Overrides

BaseContract.once

Defined in

src/contracts/ERC20.ts:122

---

populateTransaction

• populateTransaction: Object

Type declaration

Name	Type
allowance	(_owner: string, _spender: string, overrides?: CallOverrides) => Promise<PopulatedTransaction>
approve	(_spender: string, _value: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<PopulatedTransaction>
balanceOf	(_owner: string, overrides?: CallOverrides) => Promise<PopulatedTransaction>
decimals	(overrides?: CallOverrides) => Promise<PopulatedTransaction>
name	(overrides?: CallOverrides) => Promise<PopulatedTransaction>
symbol	(overrides?: CallOverrides) => Promise<PopulatedTransaction>
totalSupply	(overrides?: CallOverrides) => Promise<PopulatedTransaction>
transfer	(_to: string, _value: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<PopulatedTransaction>
transferFrom	(_from: string, _to: string, _value: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<PopulatedTransaction>

Overrides

BaseContract.populateTransaction

Defined in

src/contracts/ERC20.ts:298

---

provider

• Readonly provider: Provider

Inherited from

BaseContract.provider

Defined in

node_modules/@ethersproject/contracts/lib/index.d.ts:82

---

removeListener

• removeListener: OnEvent<ERC20>

Overrides

BaseContract.removeListener

Defined in

src/contracts/ERC20.ts:123

---

resolvedAddress

• Readonly resolvedAddress: Promise<string>

Inherited from

BaseContract.resolvedAddress

Defined in

node_modules/@ethersproject/contracts/lib/index.d.ts:98

---

signer

• Readonly signer: Signer

Inherited from

BaseContract.signer

Defined in

node_modules/@ethersproject/contracts/lib/index.d.ts:81

Methods

_checkRunningEvents

▸ _checkRunningEvents(runningEvent): void

Parameters

Name	Type
runningEvent	RunningEvent

Returns

void

Inherited from

BaseContract._checkRunningEvents

Defined in

node_modules/@ethersproject/contracts/lib/index.d.ts:121

---

_deployed

▸ _deployed(blockTag?): Promise<Contract>

Parameters

Name	Type
blockTag?	BlockTag

Returns

Promise<Contract>

Inherited from

BaseContract._deployed

Defined in

node_modules/@ethersproject/contracts/lib/index.d.ts:114

---

_wrapEvent

▸ _wrapEvent(runningEvent, log, listener): Event

Parameters

Name	Type
runningEvent	RunningEvent
log	Log
listener	Listener

Returns

Event

Inherited from

BaseContract._wrapEvent

Defined in

node_modules/@ethersproject/contracts/lib/index.d.ts:122

---

allowance

▸ allowance(_owner, _spender, overrides?): Promise<BigNumber>

Parameters

Name	Type
_owner	string
_spender	string
overrides?	CallOverrides

Returns

Promise<BigNumber>

Defined in

src/contracts/ERC20.ts:194

---

approve

▸ approve(_spender, _value, overrides?): Promise<ContractTransaction>

Parameters

Name	Type
_spender	string
_value	BigNumberish
overrides?	Overrides & { from?: string | Promise<string> }

Returns

Promise<ContractTransaction>

Defined in

src/contracts/ERC20.ts:167

---

attach

▸ attach(addressOrName): ERC20

Parameters

Name	Type
addressOrName	string

Returns

ERC20

Overrides

BaseContract.attach

Defined in

src/contracts/ERC20.ts:101

---

balanceOf

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

Parameters

Name	Type
_owner	string
overrides?	CallOverrides

Returns

Promise<BigNumber>

Defined in

src/contracts/ERC20.ts:184

---

connect

▸ connect(signerOrProvider): ERC20

Parameters

Name	Type
signerOrProvider	string | Signer | Provider

Returns

ERC20

Overrides

BaseContract.connect

Defined in

src/contracts/ERC20.ts:100

---

decimals

▸ decimals(overrides?): Promise<number>

Parameters

Name	Type
overrides?	CallOverrides

Returns

Promise<number>

Defined in

src/contracts/ERC20.ts:182

---

deployed

▸ deployed(): Promise<ERC20>

Returns

Promise<ERC20>

Overrides

BaseContract.deployed

Defined in

src/contracts/ERC20.ts:102

---

emit

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

Parameters

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

Returns

boolean

Inherited from

BaseContract.emit

Defined in

node_modules/@ethersproject/contracts/lib/index.d.ts:127

---

fallback

▸ fallback(overrides?): Promise<TransactionResponse>

Parameters

Name	Type
overrides?	TransactionRequest

Returns

Promise<TransactionResponse>

Inherited from

BaseContract.fallback

Defined in

node_modules/@ethersproject/contracts/lib/index.d.ts:115

---

listenerCount

▸ listenerCount(eventName?): number

Parameters

Name	Type
eventName?	string | EventFilter

Returns

number

Inherited from

BaseContract.listenerCount

Defined in

node_modules/@ethersproject/contracts/lib/index.d.ts:128

---

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

Defined in

src/contracts/ERC20.ts:112

▸ listeners(eventName?): Listener[]

Parameters

Name	Type
eventName?	string

Returns

Listener[]

Overrides

BaseContract.listeners

Defined in

src/contracts/ERC20.ts:115

---

name

▸ name(overrides?): Promise<string>

Parameters

Name	Type
overrides?	CallOverrides

Returns

Promise<string>

Defined in

src/contracts/ERC20.ts:165

---

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

Defined in

src/contracts/ERC20.ts:106

---

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

Defined in

src/contracts/ERC20.ts:116

▸ removeAllListeners(eventName?): ERC20

Parameters

Name	Type
eventName?	string

Returns

ERC20

Overrides

BaseContract.removeAllListeners

Defined in

src/contracts/ERC20.ts:119

---

symbol

▸ symbol(overrides?): Promise<string>

Parameters

Name	Type
overrides?	CallOverrides

Returns

Promise<string>

Defined in

src/contracts/ERC20.ts:186

---

totalSupply

▸ totalSupply(overrides?): Promise<BigNumber>

Parameters

Name	Type
overrides?	CallOverrides

Returns

Promise<BigNumber>

Defined in

src/contracts/ERC20.ts:173

---

transfer

▸ transfer(_to, _value, overrides?): Promise<ContractTransaction>

Parameters

Name	Type
_to	string
_value	BigNumberish
overrides?	Overrides & { from?: string | Promise<string> }

Returns

Promise<ContractTransaction>

Defined in

src/contracts/ERC20.ts:188

---

transferFrom

▸ transferFrom(_from, _to, _value, overrides?): Promise<ContractTransaction>

Parameters

Name	Type
_from	string
_to	string
_value	BigNumberish
overrides?	Overrides & { from?: string | Promise<string> }

Returns

Promise<ContractTransaction>

Defined in

src/contracts/ERC20.ts:175