Class BaseContract

Hierarchy

BaseContract
- Contract

Constructors

constructor

new BaseContract(addressOrName: string, contractInterface: ContractInterface, signerOrProvider?: Signer | Provider): BaseContract
Parameters
- addressOrName: string
- contractInterface: ContractInterface
- Optional signerOrProvider: Signer | Provider
Returns BaseContract
- Defined in node_modules/@ethersproject/contracts/lib/index.d.ts:107

Properties

`Private` _addEventListener

_addEventListener: any

_deployedPromise

_deployedPromise: Promise<Contract>

`Private` _getRunningEvent

_getRunningEvent: any

`Private` _normalizeRunningEvent

_normalizeRunningEvent: any

_runningEvents

_runningEvents: {
[eventTag: string]: RunningEvent;
}

Type declaration

[eventTag: string]: RunningEvent

_wrappedEmits

_wrappedEmits: {
[eventTag: string]: ((...args: any[]) => void);
}

Type declaration

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

`Readonly` address

address: string

`Readonly` callStatic

callStatic: {
[name: string]: ContractFunction;
}

Type declaration

[name: string]: ContractFunction

`Readonly` deployTransaction

deployTransaction: TransactionResponse

`Readonly` estimateGas

estimateGas: {
[name: string]: ContractFunction<BigNumber>;
}

Type declaration

[name: string]: ContractFunction<BigNumber>

`Readonly` filters

filters: {
[name: string]: ((...args: any[]) => EventFilter);
}

Type declaration

[name: string]: ((...args: any[]) => EventFilter)
- - (...args: any[]): EventFilter
  - Parameters
    - Rest ...args: any[]
    Returns EventFilter

`Readonly` functions

functions: {
[name: string]: ContractFunction;
}

Type declaration

[name: string]: ContractFunction

`Readonly` interface

interface: Interface

`Readonly` populateTransaction

populateTransaction: {
[name: string]: ContractFunction<PopulatedTransaction>;
}

Type declaration

[name: string]: ContractFunction<PopulatedTransaction>

`Readonly` provider

provider: Provider

`Readonly` resolvedAddress

resolvedAddress: Promise<string>

`Readonly` signer

signer: Signer

Methods

_checkRunningEvents

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

_deployed

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

_wrapEvent

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

attach

attach(addressOrName: string): Contract
Parameters
- addressOrName: string
Returns Contract
- Defined in node_modules/@ethersproject/contracts/lib/index.d.ts:117

connect

connect(signerOrProvider: string | Signer | Provider): Contract
Parameters
- signerOrProvider: string | Signer | Provider
Returns Contract
- Defined in node_modules/@ethersproject/contracts/lib/index.d.ts:116

deployed

deployed(): Promise<Contract>
Returns Promise<Contract>
- Defined in node_modules/@ethersproject/contracts/lib/index.d.ts:113

emit

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

fallback

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

listenerCount

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

listeners

listeners(eventName?: string | EventFilter): Listener[]
Parameters
- Optional eventName: string | EventFilter
Returns Listener[]
- Defined in node_modules/@ethersproject/contracts/lib/index.d.ts:129

off

off(eventName: string | EventFilter, listener: Listener): BaseContract
Parameters
- eventName: string | EventFilter
- listener: Listener
Returns BaseContract
- Defined in node_modules/@ethersproject/contracts/lib/index.d.ts:131

on

on(event: string | EventFilter, listener: Listener): BaseContract
Parameters
- event: string | EventFilter
- listener: Listener
Returns BaseContract
- Defined in node_modules/@ethersproject/contracts/lib/index.d.ts:125

once

once(event: string | EventFilter, listener: Listener): BaseContract
Parameters
- event: string | EventFilter
- listener: Listener
Returns BaseContract
- Defined in node_modules/@ethersproject/contracts/lib/index.d.ts:126

queryFilter

queryFilter(event: string | EventFilter, fromBlockOrBlockhash?: BlockTag, toBlock?: BlockTag): Promise<Event[]>
Parameters
- event: string | EventFilter
- Optional fromBlockOrBlockhash: BlockTag
- Optional toBlock: BlockTag
Returns Promise<Event[]>
- Defined in node_modules/@ethersproject/contracts/lib/index.d.ts:124

removeAllListeners

removeAllListeners(eventName?: string | EventFilter): BaseContract
Parameters
- Optional eventName: string | EventFilter
Returns BaseContract
- Defined in node_modules/@ethersproject/contracts/lib/index.d.ts:130

removeListener

removeListener(eventName: string | EventFilter, listener: Listener): BaseContract
Parameters
- eventName: string | EventFilter
- listener: Listener
Returns BaseContract
- Defined in node_modules/@ethersproject/contracts/lib/index.d.ts:132

`Static` getContractAddress

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

`Static` getInterface

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

`Static` isIndexed

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

Class BaseContract

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

addressOrName: string

contractInterface: ContractInterface

Optional signerOrProvider: Signer | Provider

Returns BaseContract

Properties

Private _addEventListener

_deployedPromise

Private _getRunningEvent

Private _normalizeRunningEvent

_runningEvents

Type declaration

[eventTag: string]: RunningEvent

_wrappedEmits

Type declaration

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

Parameters

Rest ...args: any[]

Returns void

Readonly address

Readonly callStatic

Type declaration

[name: string]: ContractFunction

Readonly deployTransaction

Readonly estimateGas

Type declaration

[name: string]: ContractFunction<BigNumber>

Readonly filters

Type declaration

[name: string]: ((...args: any[]) => EventFilter)

Parameters

Rest ...args: any[]

Returns EventFilter

Readonly functions

Type declaration

[name: string]: ContractFunction

Readonly interface

Readonly populateTransaction

Type declaration

[name: string]: ContractFunction<PopulatedTransaction>

Readonly provider

Readonly resolvedAddress

Readonly signer

Methods

_checkRunningEvents

Parameters

runningEvent: RunningEvent

Returns void

_deployed

Parameters

Optional blockTag: BlockTag

Returns Promise<Contract>

_wrapEvent

Parameters

runningEvent: RunningEvent

log: Log

listener: Listener

Returns Event

attach

Parameters

addressOrName: string

Returns Contract

connect

Parameters

signerOrProvider: string | Signer | Provider

Returns Contract

deployed

Returns Promise<Contract>

emit

Parameters

eventName: string | EventFilter

Rest ...args: any[]

`Optional` signerOrProvider: Signer | Provider

`Private` _addEventListener

`Private` _getRunningEvent

`Private` _normalizeRunningEvent

`Rest` ...args: any[]

`Readonly` address

`Readonly` callStatic

`Readonly` deployTransaction

`Readonly` estimateGas

`Readonly` filters

`Rest` ...args: any[]

`Readonly` functions

`Readonly` interface

`Readonly` populateTransaction

`Readonly` provider

`Readonly` resolvedAddress

`Readonly` signer

`Optional` blockTag: BlockTag

`Rest` ...args: any[]

`Optional` overrides: TransactionRequest

`Optional` eventName: string | EventFilter

`Optional` eventName: string | EventFilter

`Optional` fromBlockOrBlockhash: BlockTag

`Optional` toBlock: BlockTag

`Optional` eventName: string | EventFilter

`Static` getContractAddress

transaction: {
from: string;
nonce: BigNumberish;
}

`Static` getInterface

`Static` isIndexed