Contract

Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/contract/contract.d.ts:165

A [[BaseContract]] with no type guards on its methods or events.

Extends

• Contract_base

Indexable

[key: string]: BaseContractMethod<any[], any, any>

[key: number]: BaseContractMethod<any[], any, any>

Constructors

Constructor

new Contract(
   target,
   abi,
   runner?): Contract;

Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/contract/contract.d.ts:161

Parameters

Parameter	Type
target	| string | Addressable
abi	| Interface | InterfaceAbi
runner?	| null | ContractRunner

Returns

Contract

Inherited from

Contract_base.constructor

Properties

[internal]

readonly [internal]: any;

Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/contract/contract.d.ts:46

@_ignore:

Inherited from

Contract_base.[internal]

---

fallback

readonly fallback:
  | null
  | WrappedFallback;

Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/contract/contract.d.ts:50

The fallback or receive function if any.

Inherited from

Contract_base.fallback

---

filters

readonly filters: Record<string, ContractEvent>;

Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/contract/contract.d.ts:42

All the Events available on this contract.

Inherited from

Contract_base.filters

---

interface

readonly interface: Interface;

Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/contract/contract.d.ts:30

The contract Interface.

Inherited from

Contract_base.interface

---

runner

readonly runner:
  | null
  | ContractRunner;

Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/contract/contract.d.ts:38

The connected runner. This is generally a [[Provider]] or a [[Signer]], which dictates what operations are supported.

For example, a Contract connected to a [[Provider]] may only execute read-only operations.

Inherited from

Contract_base.runner

---

target

readonly target:
  | string
  | Addressable;

Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/contract/contract.d.ts:26

The target to connect to.

This can be an address, ENS name or any [[Addressable]], such as another contract. To get the resovled address, use the getAddress method.

Inherited from

Contract_base.target

Methods

addListener()

addListener(event, listener): Promise<Contract>;

Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/contract/contract.d.ts:147

Alias for [on].

Parameters

Parameter	Type
event	ContractEventName
listener	Listener

Returns

Promise<Contract>

Inherited from

Contract_base.addListener

---

attach()

attach(target): BaseContract;

Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/contract/contract.d.ts:66

Return a new Contract instance with the same ABI and runner, but a different %%target%%.

Parameters

Parameter	Type
target	| string | Addressable

Returns

BaseContract

Inherited from

Contract_base.attach

---

connect()

connect(runner): BaseContract;

Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/contract/contract.d.ts:61

Return a new Contract instance with the same target and ABI, but a different %%runner%%.

Parameters

Parameter	Type
runner	| null | ContractRunner

Returns

BaseContract

Inherited from

Contract_base.connect

---

deploymentTransaction()

deploymentTransaction():
  | null
  | ContractTransactionResponse;

Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/contract/contract.d.ts:86

Return the transaction used to deploy this contract.

This is only available if this instance was returned from a [[ContractFactory]].

Returns

| null | ContractTransactionResponse

Inherited from

Contract_base.deploymentTransaction

---

emit()

emit(event, ...args): Promise<boolean>;

Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/contract/contract.d.ts:123

Emit an %%event%% calling all listeners with %%args%%.

Resolves to true if any listeners were called.

Parameters

Parameter	Type
event	ContractEventName
…args	any[]

Returns

Promise<boolean>

Inherited from

Contract_base.emit

---

getAddress()

getAddress(): Promise<string>;

Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/contract/contract.d.ts:70

Return the resolved address of this Contract.

Returns

Promise<string>

Inherited from

Contract_base.getAddress

---

getDeployedCode()

getDeployedCode(): Promise<null | string>;

Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/contract/contract.d.ts:74

Return the deployed bytecode or null if no bytecode is found.

Returns

Promise<null | string>

Inherited from

Contract_base.getDeployedCode

---

getEvent()

getEvent(key): ContractEvent;

Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/contract/contract.d.ts:98

Return the event for a given name. This is useful when a contract event name conflicts with a JavaScript name such as prototype or when using a Contract programatically.

Parameters

Parameter	Type
key	| string | EventFragment

Returns

ContractEvent

Inherited from

Contract_base.getEvent

---

getFunction()

getFunction<T>(key): T;

Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/contract/contract.d.ts:92

Return the function for a given name. This is useful when a contract method name conflicts with a JavaScript name such as prototype or when using a Contract programatically.

Type Parameters

Type Parameter	Default type
T extends ContractMethod<any[], any, any>	ContractMethod<any[], any, any>

Parameters

Parameter	Type
key	| string | FunctionFragment

Returns

T

Inherited from

Contract_base.getFunction

---

listenerCount()

listenerCount(event?): Promise<number>;

Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/contract/contract.d.ts:128

Resolves to the number of listeners of %%event%% or the total number of listeners if unspecified.

Parameters

Parameter	Type
event?	ContractEventName

Returns

Promise<number>

Inherited from

Contract_base.listenerCount

---

listeners()

listeners(event?): Promise<Listener[]>;

Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/contract/contract.d.ts:133

Resolves to the listeners subscribed to %%event%% or all listeners if unspecified.

Parameters

Parameter	Type
event?	ContractEventName

Returns

Promise<Listener[]>

Inherited from

Contract_base.listeners

---

off()

off(event, listener?): Promise<Contract>;

Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/contract/contract.d.ts:138

Remove the %%listener%% from the listeners for %%event%% or remove all listeners if unspecified.

Parameters

Parameter	Type
event	ContractEventName
listener?	Listener

Returns

Promise<Contract>

Inherited from

Contract_base.off

---

on()

on(event, listener): Promise<Contract>;

Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/contract/contract.d.ts:112

Add an event %%listener%% for the %%event%%.

Parameters

Parameter	Type
event	ContractEventName
listener	Listener

Returns

Promise<Contract>

Inherited from

Contract_base.on

---

once()

once(event, listener): Promise<Contract>;

Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/contract/contract.d.ts:117

Add an event %%listener%% for the %%event%%, but remove the listener after it is fired once.

Parameters

Parameter	Type
event	ContractEventName
listener	Listener

Returns

Promise<Contract>

Inherited from

Contract_base.once

---

queryFilter()

queryFilter(
   event,
   fromBlock?,
   toBlock?): Promise<(
  | Log
| EventLog)[]>;

Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/contract/contract.d.ts:108

Provide historic access to event data for %%event%% in the range %%fromBlock%% (default: 0) to %%toBlock%% (default: "latest") inclusive.

Parameters

Parameter	Type
event	ContractEventName
fromBlock?	BlockTag
toBlock?	BlockTag

Returns

Promise<( | Log | EventLog)[]>

Inherited from

Contract_base.queryFilter

---

queryTransaction()

queryTransaction(hash): Promise<EventLog[]>;

Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/contract/contract.d.ts:102

@_ignore:

Parameters

Parameter	Type
hash	string

Returns

Promise<EventLog[]>

Inherited from

Contract_base.queryTransaction

---

removeAllListeners()

removeAllListeners(event?): Promise<Contract>;

Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/contract/contract.d.ts:143

Remove all the listeners for %%event%% or remove all listeners if unspecified.

Parameters

Parameter	Type
event?	ContractEventName

Returns

Promise<Contract>

Inherited from

Contract_base.removeAllListeners

---

removeListener()

removeListener(event, listener): Promise<Contract>;

Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/contract/contract.d.ts:151

Alias for [off].

Parameters

Parameter	Type
event	ContractEventName
listener	Listener

Returns

Promise<Contract>

Inherited from

Contract_base.removeListener

---

waitForDeployment()

waitForDeployment(): Promise<Contract>;

Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/contract/contract.d.ts:79

Resolve to this Contract once the bytecode has been deployed, or resolve immediately if already deployed.

Returns

Promise<Contract>

Inherited from

Contract_base.waitForDeployment