BaseContract

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

An interface for objects which have an address, and can resolve it asyncronously.

This allows objects such as [[Signer]] or [[Contract]] to be used most places an address can be, for example getting the balance.

Implements

Constructors

Constructor

new BaseContract(
   target,
   abi,
   runner?,
   _deployTx?): BaseContract;

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

Creates a new contract connected to %%target%% with the %%abi%% and optionally connected to a %%runner%% to perform operations on behalf of.

Parameters

Parameter	Type
`target`	\| `string` \| `Addressable`
`abi`	\| `Interface` \| `InterfaceAbi`
`runner?`	\| `null` \| `ContractRunner`
`_deployTx?`	\| `null` \| `TransactionResponse`

Returns

BaseContract

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:

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.

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.

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.

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.

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.

Methods

addListener()

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

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<BaseContract>

Implementation of

EventEmitterable.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

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

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

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>

Implementation of

EventEmitterable.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>

Implementation of

Addressable.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>

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

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

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>

Implementation of

EventEmitterable.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[]>

Implementation of

EventEmitterable.listeners

off()

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

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<BaseContract>

Implementation of

EventEmitterable.off

on()

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

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<BaseContract>

Implementation of

EventEmitterable.on

once()

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

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<BaseContract>

Implementation of

EventEmitterable.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)[]>

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[]>

removeAllListeners()

removeAllListeners(event?): Promise<BaseContract>;

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<BaseContract>

Implementation of

EventEmitterable.removeAllListeners

removeListener()

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

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<BaseContract>

Implementation of

EventEmitterable.removeListener

waitForDeployment()

waitForDeployment(): Promise<BaseContract>;

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<BaseContract>

buildClass()

static buildClass<T>(abi): (target, runner?) => BaseContract & Omit<T, keyof BaseContract>;

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

Create a new Class for the %%abi%%.

Type Parameters

Type Parameter	Default type
`T`	`ContractInterface`

Parameters

Parameter	Type
`abi`	\| `Interface` \| `InterfaceAbi`

Returns

new buildClass(target, runner?): BaseContract & Omit<T, keyof BaseContract>;

Parameters

Parameter	Type
`target`	`string`
`runner?`	\| `null` \| `ContractRunner`

Returns

BaseContract & Omit<T, keyof BaseContract>

from()

static from<T>(
   target,
   abi,
runner?): BaseContract & Omit<T, keyof BaseContract>;

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

Create a new BaseContract with a specified Interface.

Type Parameters

Type Parameter	Default type
`T`	`ContractInterface`

Parameters

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

Returns

BaseContract & Omit<T, keyof BaseContract>