Class Contract

Hierarchy

BaseContract
- Contract

Indexable

[key: string]: ContractFunction | any

Constructors

constructor

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

Properties

_deployedPromise

_deployedPromise: Promise<Contract>

_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
Inherited from BaseContract._checkRunningEvents
- Defined in node_modules/@ethersproject/contracts/lib/index.d.ts:121

_deployed

_deployed(blockTag?: BlockTag): Promise<Contract>
Parameters
- Optional blockTag: BlockTag
Returns Promise<Contract>
Inherited from BaseContract._deployed
- 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
Inherited from BaseContract._wrapEvent
- Defined in node_modules/@ethersproject/contracts/lib/index.d.ts:122

attach

attach(addressOrName: string): Contract
Parameters
- addressOrName: string
Returns Contract
Inherited from BaseContract.attach
- 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
Inherited from BaseContract.connect
- Defined in node_modules/@ethersproject/contracts/lib/index.d.ts:116

deployed

deployed(): Promise<Contract>
Returns Promise<Contract>
Inherited from BaseContract.deployed
- 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
Inherited from BaseContract.emit
- Defined in node_modules/@ethersproject/contracts/lib/index.d.ts:127

fallback

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

listenerCount

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

listeners

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

off

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

on

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

once

once(event: string | EventFilter, listener: Listener): Contract
Parameters
- event: string | EventFilter
- listener: Listener
Returns Contract
Inherited from BaseContract.once
- 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[]>
Inherited from BaseContract.queryFilter
- Defined in node_modules/@ethersproject/contracts/lib/index.d.ts:124

removeAllListeners

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

removeListener

removeListener(eventName: string | EventFilter, listener: Listener): Contract
Parameters
- eventName: string | EventFilter
- listener: Listener
Returns Contract
Inherited from BaseContract.removeListener
- 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
Inherited from BaseContract.getContractAddress
- Defined in node_modules/@ethersproject/contracts/lib/index.d.ts:108

`Static` getInterface

getInterface(contractInterface: ContractInterface): Interface
Parameters
- contractInterface: ContractInterface
Returns Interface
Inherited from BaseContract.getInterface
- 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
Inherited from BaseContract.isIndexed
- Defined in node_modules/@ethersproject/contracts/lib/index.d.ts:118

Generated using TypeDoc