core

Export all packages grouped by name spaces

Index

Namespaces

formatters

Enumerations

Classes

Interfaces

Type Aliases

Variables

DEFAULT_BATCH_REQUEST_TIMEOUT

Namespaces

formatters

formatters:

inputAddressFormatter

inputAddressFormatter(address: string): string

Parameters
- address: string
Returns string

inputBlockNumberFormatter

inputBlockNumberFormatter(blockNumber: undefined | Numbers): undefined | string

Parameters
- blockNumber: undefined | Numbers
Returns undefined | string

inputCallFormatter

inputCallFormatter(options: TransactionInput, defaultAccount?: string): Mutable<TransactionOutput>

Parameters
- options: TransactionInput
- optionaldefaultAccount: string
Returns Mutable<TransactionOutput>

inputDefaultBlockNumberFormatter

inputDefaultBlockNumberFormatter(blockNumber: undefined | Numbers, defaultBlock: Numbers): undefined | string

Parameters
- blockNumber: undefined | Numbers
- defaultBlock: Numbers
Returns undefined | string

inputLogFormatter

inputLogFormatter(filter: Filter): Filter

Parameters
- filter: Filter
Returns Filter

inputPostFormatter

inputPostFormatter(post: PostOutput): PostInput

Parameters
- post: PostOutput
Returns PostInput

inputSignFormatter

inputSignFormatter(data: string): string

Parameters
- data: string
Returns string

inputStorageKeysFormatter

inputStorageKeysFormatter(keys: string[]): string[]

Parameters
- keys: string[]
Returns string[]

inputTopicFormatter

inputTopicFormatter(topic: string): null | string

Parameters
- topic: string
Returns null | string

inputTransactionFormatter

inputTransactionFormatter(options: TransactionInput, defaultAccount?: string): Mutable<TransactionOutput>

Parameters
- options: TransactionInput
- optionaldefaultAccount: string
Returns Mutable<TransactionOutput>

outputBigIntegerFormatter

outputBigIntegerFormatter(number: Numbers): number | bigint

Parameters
- number: Numbers
Returns number | bigint

outputBlockFormatter

outputBlockFormatter(block: BlockInput): BlockOutput

Parameters
- block: BlockInput
Returns BlockOutput

outputLogFormatter

outputLogFormatter(log: Partial<LogsInput>): LogsOutput

Parameters
- log: Partial<LogsInput>
Returns LogsOutput

outputPostFormatter

outputPostFormatter(post: PostInput): PostOutput

Parameters
- post: PostInput
Returns PostOutput

outputProofFormatter

outputProofFormatter(proof: Proof): Proof

Parameters
- proof: Proof
Returns Proof

outputSyncingFormatter

outputSyncingFormatter(result: SyncInput): SyncOutput

Parameters
- result: SyncInput
Returns SyncOutput

outputTransactionFormatter

outputTransactionFormatter(tx: TransactionInput): TransactionOutput

Parameters
- tx: TransactionInput
Returns TransactionOutput

outputTransactionReceiptFormatter

outputTransactionReceiptFormatter(receipt: ReceiptInput): ReceiptOutput

Parameters
- receipt: ReceiptInput
Returns ReceiptOutput

txInputOptionsFormatter

txInputOptionsFormatter(options: TransactionInput): Mutable<TransactionOutput>

Parameters
- options: TransactionInput
Returns Mutable<TransactionOutput>

Enumerations

Web3ConfigEvent

Web3ConfigEvent:

CONFIG_CHANGE

CONFIG_CHANGE: CONFIG_CHANGE = "CONFIG_CHANGE"

Web3RequestManagerEvent

Web3RequestManagerEvent:

BEFORE_PROVIDER_CHANGE

BEFORE_PROVIDER_CHANGE: BEFORE_PROVIDER_CHANGE = "BEFORE_PROVIDER_CHANGE"

PROVIDER_CHANGED

PROVIDER_CHANGED: PROVIDER_CHANGED = "PROVIDER_CHANGED"

Classes

Web3BatchRequest

Web3BatchRequest:

constructor

new Web3BatchRequest(requestManager: Web3RequestManager<EthExecutionAPI>): Web3BatchRequest

Parameters
- requestManager: Web3RequestManager<EthExecutionAPI>
Returns Web3BatchRequest

requests

get requests(): JsonRpcRequest<unknown[]>[]

Returns JsonRpcRequest<unknown[]>[]

add

add<ResponseType>(request: JsonRpcOptionalRequest<unknown>): Web3DeferredPromise<ResponseType>

Type parameters
- ResponseType = unknown
Parameters
- request: JsonRpcOptionalRequest<unknown>
Returns Web3DeferredPromise<ResponseType>

execute

execute(): Promise<JsonRpcBatchResponse<unknown, unknown>>

Returns Promise<JsonRpcBatchResponse<unknown, unknown>>

abstractWeb3Config

Web3Config:

constructor

new Web3Config(options?: Partial<Web3ConfigOptions>): Web3Config

Overrides Web3EventEmitter.constructor
Parameters
- optionaloptions: Partial<Web3ConfigOptions>
Returns Web3Config

blockHeaderTimeout

get blockHeaderTimeout(): number
set blockHeaderTimeout(val: number): void

Implementation of Web3ConfigOptions.blockHeaderTimeout
Returns number
Implementation of Web3ConfigOptions.blockHeaderTimeout
Parameters
- val: number
Returns void

defaultAccount

get defaultAccount(): undefined | string
set defaultAccount(val: undefined | string): void

Implementation of Web3ConfigOptions.defaultAccount
Returns undefined | string
Implementation of Web3ConfigOptions.defaultAccount
Parameters
- val: undefined | string
Returns void

defaultBlock

get defaultBlock(): BlockNumberOrTag
set defaultBlock(val: BlockNumberOrTag): void

Implementation of Web3ConfigOptions.defaultBlock
Returns BlockNumberOrTag
Implementation of Web3ConfigOptions.defaultBlock
Parameters
- val: BlockNumberOrTag
Returns void

defaultChain

get defaultChain(): string
set defaultChain(val: string): void

Implementation of Web3ConfigOptions.defaultChain
Returns string
Implementation of Web3ConfigOptions.defaultChain
Parameters
- val: string
Returns void

defaultCommon

get defaultCommon(): undefined | Common
set defaultCommon(val: undefined | Common): void

Implementation of Web3ConfigOptions.defaultCommon
Returns undefined | Common
Implementation of Web3ConfigOptions.defaultCommon
Parameters
- val: undefined | Common
Returns void

defaultHardfork

get defaultHardfork(): string
set defaultHardfork(val: string): void

Implementation of Web3ConfigOptions.defaultHardfork
Returns string
Implementation of Web3ConfigOptions.defaultHardfork
Parameters
- val: string
Returns void

defaultMaxPriorityFeePerGas

get defaultMaxPriorityFeePerGas(): Numbers
set defaultMaxPriorityFeePerGas(val: Numbers): void

Implementation of Web3ConfigOptions.defaultMaxPriorityFeePerGas
Returns Numbers
Implementation of Web3ConfigOptions.defaultMaxPriorityFeePerGas
Parameters
- val: Numbers
Returns void

defaultNetworkId

get defaultNetworkId(): undefined | Numbers
set defaultNetworkId(val: undefined | Numbers): void

Implementation of Web3ConfigOptions.defaultNetworkId
Returns undefined | Numbers
Implementation of Web3ConfigOptions.defaultNetworkId
Parameters
- val: undefined | Numbers
Returns void

defaultTransactionType

get defaultTransactionType(): Numbers
set defaultTransactionType(val: Numbers): void

Implementation of Web3ConfigOptions.defaultTransactionType
Returns Numbers
Implementation of Web3ConfigOptions.defaultTransactionType
Parameters
- val: Numbers
Returns void

enableExperimentalFeatures

get enableExperimentalFeatures(): { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean }
set enableExperimentalFeatures(val: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean }): void

Implementation of Web3ConfigOptions.enableExperimentalFeatures
Returns { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean }
- useRpcCallSpecification: boolean
- useSubscriptionWhenCheckingBlockTimeout: boolean
Implementation of Web3ConfigOptions.enableExperimentalFeatures
Parameters
- val: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean }
Returns void

handleRevert

get handleRevert(): boolean
set handleRevert(val: boolean): void

Implementation of Web3ConfigOptions.handleRevert
Returns boolean
Implementation of Web3ConfigOptions.handleRevert
Parameters
- val: boolean
Returns void

maxListenersWarningThreshold

get maxListenersWarningThreshold(): number
set maxListenersWarningThreshold(val: number): void

Implementation of Web3ConfigOptions.maxListenersWarningThreshold
Returns number
Implementation of Web3ConfigOptions.maxListenersWarningThreshold
Parameters
- val: number
Returns void

transactionBlockTimeout

get transactionBlockTimeout(): number
set transactionBlockTimeout(val: number): void

Implementation of Web3ConfigOptions.transactionBlockTimeout
Returns number
Implementation of Web3ConfigOptions.transactionBlockTimeout
Parameters
- val: number
Returns void

transactionBuilder

get transactionBuilder(): undefined | TransactionBuilder<unknown>
set transactionBuilder(val: undefined | TransactionBuilder<unknown>): void

Implementation of Web3ConfigOptions.transactionBuilder
Returns undefined | TransactionBuilder<unknown>
Implementation of Web3ConfigOptions.transactionBuilder
Parameters
- val: undefined | TransactionBuilder<unknown>
Returns void

transactionConfirmationBlocks

get transactionConfirmationBlocks(): number
set transactionConfirmationBlocks(val: number): void

Implementation of Web3ConfigOptions.transactionConfirmationBlocks
Returns number
Implementation of Web3ConfigOptions.transactionConfirmationBlocks
Parameters
- val: number
Returns void

transactionConfirmationPollingInterval

get transactionConfirmationPollingInterval(): undefined | number
set transactionConfirmationPollingInterval(val: undefined | number): void

Implementation of Web3ConfigOptions.transactionConfirmationPollingInterval
Returns undefined | number
Implementation of Web3ConfigOptions.transactionConfirmationPollingInterval
Parameters
- val: undefined | number
Returns void

transactionPollingInterval

get transactionPollingInterval(): number
set transactionPollingInterval(val: number): void

Implementation of Web3ConfigOptions.transactionPollingInterval
Returns number
Implementation of Web3ConfigOptions.transactionPollingInterval
Parameters
- val: number
Returns void

transactionPollingTimeout

get transactionPollingTimeout(): number
set transactionPollingTimeout(val: number): void

Implementation of Web3ConfigOptions.transactionPollingTimeout
Returns number
Implementation of Web3ConfigOptions.transactionPollingTimeout
Parameters
- val: number
Returns void

transactionReceiptPollingInterval

get transactionReceiptPollingInterval(): undefined | number
set transactionReceiptPollingInterval(val: undefined | number): void

Implementation of Web3ConfigOptions.transactionReceiptPollingInterval
Returns undefined | number
Implementation of Web3ConfigOptions.transactionReceiptPollingInterval
Parameters
- val: undefined | number
Returns void

transactionSendTimeout

get transactionSendTimeout(): number
set transactionSendTimeout(val: number): void

Implementation of Web3ConfigOptions.transactionSendTimeout
Returns number
Implementation of Web3ConfigOptions.transactionSendTimeout
Parameters
- val: number
Returns void

transactionTypeParser

get transactionTypeParser(): undefined | TransactionTypeParser
set transactionTypeParser(val: undefined | TransactionTypeParser): void

Implementation of Web3ConfigOptions.transactionTypeParser
Returns undefined | TransactionTypeParser
Implementation of Web3ConfigOptions.transactionTypeParser
Parameters
- val: undefined | TransactionTypeParser
Returns void

emit

emit<K>(eventName: K, params: { CONFIG_CHANGE: { name: handleRevert; newValue: boolean; oldValue: boolean } | { name: defaultAccount; newValue: undefined | string; oldValue: undefined | string } | { name: defaultBlock; newValue: BlockNumberOrTag; oldValue: BlockNumberOrTag } | { name: transactionSendTimeout; newValue: number; oldValue: number } | { name: transactionBlockTimeout; newValue: number; oldValue: number } | { name: transactionConfirmationBlocks; newValue: number; oldValue: number } | { name: transactionPollingInterval; newValue: number; oldValue: number } | { name: transactionPollingTimeout; newValue: number; oldValue: number } | { name: transactionReceiptPollingInterval; newValue: undefined | number; oldValue: undefined | number } | { name: transactionConfirmationPollingInterval; newValue: undefined | number; oldValue: undefined | number } | { name: blockHeaderTimeout; newValue: number; oldValue: number } | { name: maxListenersWarningThreshold; newValue: number; oldValue: number } | { name: defaultNetworkId; newValue: undefined | Numbers; oldValue: undefined | Numbers } | { name: defaultChain; newValue: string; oldValue: string } | { name: defaultHardfork; newValue: string; oldValue: string } | { name: defaultCommon; newValue: undefined | Common; oldValue: undefined | Common } | { name: defaultTransactionType; newValue: Numbers; oldValue: Numbers } | { name: defaultMaxPriorityFeePerGas; newValue: Numbers; oldValue: Numbers } | { name: enableExperimentalFeatures; newValue: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean }; oldValue: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean } } | { name: transactionBuilder; newValue: undefined | TransactionBuilder<unknown>; oldValue: undefined | TransactionBuilder<unknown> } | { name: transactionTypeParser; newValue: undefined | TransactionTypeParser; oldValue: undefined | TransactionTypeParser } }[K]): void

Inherited from Web3EventEmitter.emit
Type parameters
- K: CONFIG_CHANGE
Parameters
- eventName: K
- params: { CONFIG_CHANGE: { name: handleRevert; newValue: boolean; oldValue: boolean } | { name: defaultAccount; newValue: undefined | string; oldValue: undefined | string } | { name: defaultBlock; newValue: BlockNumberOrTag; oldValue: BlockNumberOrTag } | { name: transactionSendTimeout; newValue: number; oldValue: number } | { name: transactionBlockTimeout; newValue: number; oldValue: number } | { name: transactionConfirmationBlocks; newValue: number; oldValue: number } | { name: transactionPollingInterval; newValue: number; oldValue: number } | { name: transactionPollingTimeout; newValue: number; oldValue: number } | { name: transactionReceiptPollingInterval; newValue: undefined | number; oldValue: undefined | number } | { name: transactionConfirmationPollingInterval; newValue: undefined | number; oldValue: undefined | number } | { name: blockHeaderTimeout; newValue: number; oldValue: number } | { name: maxListenersWarningThreshold; newValue: number; oldValue: number } | { name: defaultNetworkId; newValue: undefined | Numbers; oldValue: undefined | Numbers } | { name: defaultChain; newValue: string; oldValue: string } | { name: defaultHardfork; newValue: string; oldValue: string } | { name: defaultCommon; newValue: undefined | Common; oldValue: undefined | Common } | { name: defaultTransactionType; newValue: Numbers; oldValue: Numbers } | { name: defaultMaxPriorityFeePerGas; newValue: Numbers; oldValue: Numbers } | { name: enableExperimentalFeatures; newValue: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean }; oldValue: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean } } | { name: transactionBuilder; newValue: undefined | TransactionBuilder<unknown>; oldValue: undefined | TransactionBuilder<unknown> } | { name: transactionTypeParser; newValue: undefined | TransactionTypeParser; oldValue: undefined | TransactionTypeParser } }[K]
Returns void

eventNames

eventNames(): (string | symbol)[]

Inherited from Web3EventEmitter.eventNames
Returns (string | symbol)[]

getConfig

getConfig(): Web3ConfigOptions

Returns Web3ConfigOptions

getMaxListeners

getMaxListeners(): number

Inherited from Web3EventEmitter.getMaxListeners
Returns number

listenerCount

listenerCount<K>(eventName: K): number

Inherited from Web3EventEmitter.listenerCount
Type parameters
- K: CONFIG_CHANGE
Parameters
- eventName: K
Returns number

listeners

listeners<K>(eventName: K): Function[]

Inherited from Web3EventEmitter.listeners
Type parameters
- K: CONFIG_CHANGE
Parameters
- eventName: K
Returns Function[]

off

off<K>(eventName: K, fn: Web3EventCallback<{ CONFIG_CHANGE: { name: handleRevert; newValue: boolean; oldValue: boolean } | { name: defaultAccount; newValue: undefined | string; oldValue: undefined | string } | { name: defaultBlock; newValue: BlockNumberOrTag; oldValue: BlockNumberOrTag } | { name: transactionSendTimeout; newValue: number; oldValue: number } | { name: transactionBlockTimeout; newValue: number; oldValue: number } | { name: transactionConfirmationBlocks; newValue: number; oldValue: number } | { name: transactionPollingInterval; newValue: number; oldValue: number } | { name: transactionPollingTimeout; newValue: number; oldValue: number } | { name: transactionReceiptPollingInterval; newValue: undefined | number; oldValue: undefined | number } | { name: transactionConfirmationPollingInterval; newValue: undefined | number; oldValue: undefined | number } | { name: blockHeaderTimeout; newValue: number; oldValue: number } | { name: maxListenersWarningThreshold; newValue: number; oldValue: number } | { name: defaultNetworkId; newValue: undefined | Numbers; oldValue: undefined | Numbers } | { name: defaultChain; newValue: string; oldValue: string } | { name: defaultHardfork; newValue: string; oldValue: string } | { name: defaultCommon; newValue: undefined | Common; oldValue: undefined | Common } | { name: defaultTransactionType; newValue: Numbers; oldValue: Numbers } | { name: defaultMaxPriorityFeePerGas; newValue: Numbers; oldValue: Numbers } | { name: enableExperimentalFeatures; newValue: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean }; oldValue: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean } } | { name: transactionBuilder; newValue: undefined | TransactionBuilder<unknown>; oldValue: undefined | TransactionBuilder<unknown> } | { name: transactionTypeParser; newValue: undefined | TransactionTypeParser; oldValue: undefined | TransactionTypeParser } }[K]>): void

Inherited from Web3EventEmitter.off
Type parameters
- K: CONFIG_CHANGE
Parameters
- eventName: K
- fn: Web3EventCallback<{ CONFIG_CHANGE: { name: handleRevert; newValue: boolean; oldValue: boolean } | { name: defaultAccount; newValue: undefined | string; oldValue: undefined | string } | { name: defaultBlock; newValue: BlockNumberOrTag; oldValue: BlockNumberOrTag } | { name: transactionSendTimeout; newValue: number; oldValue: number } | { name: transactionBlockTimeout; newValue: number; oldValue: number } | { name: transactionConfirmationBlocks; newValue: number; oldValue: number } | { name: transactionPollingInterval; newValue: number; oldValue: number } | { name: transactionPollingTimeout; newValue: number; oldValue: number } | { name: transactionReceiptPollingInterval; newValue: undefined | number; oldValue: undefined | number } | { name: transactionConfirmationPollingInterval; newValue: undefined | number; oldValue: undefined | number } | { name: blockHeaderTimeout; newValue: number; oldValue: number } | { name: maxListenersWarningThreshold; newValue: number; oldValue: number } | { name: defaultNetworkId; newValue: undefined | Numbers; oldValue: undefined | Numbers } | { name: defaultChain; newValue: string; oldValue: string } | { name: defaultHardfork; newValue: string; oldValue: string } | { name: defaultCommon; newValue: undefined | Common; oldValue: undefined | Common } | { name: defaultTransactionType; newValue: Numbers; oldValue: Numbers } | { name: defaultMaxPriorityFeePerGas; newValue: Numbers; oldValue: Numbers } | { name: enableExperimentalFeatures; newValue: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean }; oldValue: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean } } | { name: transactionBuilder; newValue: undefined | TransactionBuilder<unknown>; oldValue: undefined | TransactionBuilder<unknown> } | { name: transactionTypeParser; newValue: undefined | TransactionTypeParser; oldValue: undefined | TransactionTypeParser } }[K]>
Returns void

on

on<K>(eventName: K, fn: Web3EventCallback<{ CONFIG_CHANGE: { name: handleRevert; newValue: boolean; oldValue: boolean } | { name: defaultAccount; newValue: undefined | string; oldValue: undefined | string } | { name: defaultBlock; newValue: BlockNumberOrTag; oldValue: BlockNumberOrTag } | { name: transactionSendTimeout; newValue: number; oldValue: number } | { name: transactionBlockTimeout; newValue: number; oldValue: number } | { name: transactionConfirmationBlocks; newValue: number; oldValue: number } | { name: transactionPollingInterval; newValue: number; oldValue: number } | { name: transactionPollingTimeout; newValue: number; oldValue: number } | { name: transactionReceiptPollingInterval; newValue: undefined | number; oldValue: undefined | number } | { name: transactionConfirmationPollingInterval; newValue: undefined | number; oldValue: undefined | number } | { name: blockHeaderTimeout; newValue: number; oldValue: number } | { name: maxListenersWarningThreshold; newValue: number; oldValue: number } | { name: defaultNetworkId; newValue: undefined | Numbers; oldValue: undefined | Numbers } | { name: defaultChain; newValue: string; oldValue: string } | { name: defaultHardfork; newValue: string; oldValue: string } | { name: defaultCommon; newValue: undefined | Common; oldValue: undefined | Common } | { name: defaultTransactionType; newValue: Numbers; oldValue: Numbers } | { name: defaultMaxPriorityFeePerGas; newValue: Numbers; oldValue: Numbers } | { name: enableExperimentalFeatures; newValue: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean }; oldValue: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean } } | { name: transactionBuilder; newValue: undefined | TransactionBuilder<unknown>; oldValue: undefined | TransactionBuilder<unknown> } | { name: transactionTypeParser; newValue: undefined | TransactionTypeParser; oldValue: undefined | TransactionTypeParser } }[K]>): void

Inherited from Web3EventEmitter.on
Type parameters
- K: CONFIG_CHANGE
Parameters
- eventName: K
- fn: Web3EventCallback<{ CONFIG_CHANGE: { name: handleRevert; newValue: boolean; oldValue: boolean } | { name: defaultAccount; newValue: undefined | string; oldValue: undefined | string } | { name: defaultBlock; newValue: BlockNumberOrTag; oldValue: BlockNumberOrTag } | { name: transactionSendTimeout; newValue: number; oldValue: number } | { name: transactionBlockTimeout; newValue: number; oldValue: number } | { name: transactionConfirmationBlocks; newValue: number; oldValue: number } | { name: transactionPollingInterval; newValue: number; oldValue: number } | { name: transactionPollingTimeout; newValue: number; oldValue: number } | { name: transactionReceiptPollingInterval; newValue: undefined | number; oldValue: undefined | number } | { name: transactionConfirmationPollingInterval; newValue: undefined | number; oldValue: undefined | number } | { name: blockHeaderTimeout; newValue: number; oldValue: number } | { name: maxListenersWarningThreshold; newValue: number; oldValue: number } | { name: defaultNetworkId; newValue: undefined | Numbers; oldValue: undefined | Numbers } | { name: defaultChain; newValue: string; oldValue: string } | { name: defaultHardfork; newValue: string; oldValue: string } | { name: defaultCommon; newValue: undefined | Common; oldValue: undefined | Common } | { name: defaultTransactionType; newValue: Numbers; oldValue: Numbers } | { name: defaultMaxPriorityFeePerGas; newValue: Numbers; oldValue: Numbers } | { name: enableExperimentalFeatures; newValue: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean }; oldValue: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean } } | { name: transactionBuilder; newValue: undefined | TransactionBuilder<unknown>; oldValue: undefined | TransactionBuilder<unknown> } | { name: transactionTypeParser; newValue: undefined | TransactionTypeParser; oldValue: undefined | TransactionTypeParser } }[K]>
Returns void

once

once<K>(eventName: K, fn: Web3EventCallback<{ CONFIG_CHANGE: { name: handleRevert; newValue: boolean; oldValue: boolean } | { name: defaultAccount; newValue: undefined | string; oldValue: undefined | string } | { name: defaultBlock; newValue: BlockNumberOrTag; oldValue: BlockNumberOrTag } | { name: transactionSendTimeout; newValue: number; oldValue: number } | { name: transactionBlockTimeout; newValue: number; oldValue: number } | { name: transactionConfirmationBlocks; newValue: number; oldValue: number } | { name: transactionPollingInterval; newValue: number; oldValue: number } | { name: transactionPollingTimeout; newValue: number; oldValue: number } | { name: transactionReceiptPollingInterval; newValue: undefined | number; oldValue: undefined | number } | { name: transactionConfirmationPollingInterval; newValue: undefined | number; oldValue: undefined | number } | { name: blockHeaderTimeout; newValue: number; oldValue: number } | { name: maxListenersWarningThreshold; newValue: number; oldValue: number } | { name: defaultNetworkId; newValue: undefined | Numbers; oldValue: undefined | Numbers } | { name: defaultChain; newValue: string; oldValue: string } | { name: defaultHardfork; newValue: string; oldValue: string } | { name: defaultCommon; newValue: undefined | Common; oldValue: undefined | Common } | { name: defaultTransactionType; newValue: Numbers; oldValue: Numbers } | { name: defaultMaxPriorityFeePerGas; newValue: Numbers; oldValue: Numbers } | { name: enableExperimentalFeatures; newValue: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean }; oldValue: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean } } | { name: transactionBuilder; newValue: undefined | TransactionBuilder<unknown>; oldValue: undefined | TransactionBuilder<unknown> } | { name: transactionTypeParser; newValue: undefined | TransactionTypeParser; oldValue: undefined | TransactionTypeParser } }[K]>): void

Inherited from Web3EventEmitter.once
Type parameters
- K: CONFIG_CHANGE
Parameters
- eventName: K
- fn: Web3EventCallback<{ CONFIG_CHANGE: { name: handleRevert; newValue: boolean; oldValue: boolean } | { name: defaultAccount; newValue: undefined | string; oldValue: undefined | string } | { name: defaultBlock; newValue: BlockNumberOrTag; oldValue: BlockNumberOrTag } | { name: transactionSendTimeout; newValue: number; oldValue: number } | { name: transactionBlockTimeout; newValue: number; oldValue: number } | { name: transactionConfirmationBlocks; newValue: number; oldValue: number } | { name: transactionPollingInterval; newValue: number; oldValue: number } | { name: transactionPollingTimeout; newValue: number; oldValue: number } | { name: transactionReceiptPollingInterval; newValue: undefined | number; oldValue: undefined | number } | { name: transactionConfirmationPollingInterval; newValue: undefined | number; oldValue: undefined | number } | { name: blockHeaderTimeout; newValue: number; oldValue: number } | { name: maxListenersWarningThreshold; newValue: number; oldValue: number } | { name: defaultNetworkId; newValue: undefined | Numbers; oldValue: undefined | Numbers } | { name: defaultChain; newValue: string; oldValue: string } | { name: defaultHardfork; newValue: string; oldValue: string } | { name: defaultCommon; newValue: undefined | Common; oldValue: undefined | Common } | { name: defaultTransactionType; newValue: Numbers; oldValue: Numbers } | { name: defaultMaxPriorityFeePerGas; newValue: Numbers; oldValue: Numbers } | { name: enableExperimentalFeatures; newValue: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean }; oldValue: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean } } | { name: transactionBuilder; newValue: undefined | TransactionBuilder<unknown>; oldValue: undefined | TransactionBuilder<unknown> } | { name: transactionTypeParser; newValue: undefined | TransactionTypeParser; oldValue: undefined | TransactionTypeParser } }[K]>
Returns void

removeAllListeners

removeAllListeners(): EventEmitter

Inherited from Web3EventEmitter.removeAllListeners
Returns EventEmitter

setConfig

setConfig(options: Partial<Web3ConfigOptions>): void

Parameters
- options: Partial<Web3ConfigOptions>
Returns void

setMaxListenerWarningThreshold

setMaxListenerWarningThreshold(maxListenersWarningThreshold: number): void

Inherited from Web3EventEmitter.setMaxListenerWarningThreshold
Parameters
- maxListenersWarningThreshold: number
Returns void

Web3Context

Web3Context<API, RegisteredSubs>:

Type parameters

API: Web3APISpec = unknown
RegisteredSubs: {} = any

constructor

new Web3Context<API, RegisteredSubs>(providerOrContext?: string | SupportedProviders<API> | Web3ContextInitOptions<API, RegisteredSubs>): Web3Context<API, RegisteredSubs>

Overrides Web3Config.constructor
Type parameters
- API: unknown = unknown
- RegisteredSubs: {} = any
Parameters
- optionalproviderOrContext: string | SupportedProviders<API> | Web3ContextInitOptions<API, RegisteredSubs>
Returns Web3Context<API, RegisteredSubs>

readonlyproviders

providers: { HttpProvider: Web3BaseProviderConstructor; IpcProvider: Web3BaseProviderConstructor; WebsocketProvider: Web3BaseProviderConstructor }

Type declaration

HttpProvider: Web3BaseProviderConstructor
IpcProvider: Web3BaseProviderConstructor
WebsocketProvider: Web3BaseProviderConstructor

staticoptionalgivenProvider

givenProvider?: SupportedProviders<never>

staticreadonlyproviders

providers: { HttpProvider: Web3BaseProviderConstructor; IpcProvider: Web3BaseProviderConstructor; WebsocketProvider: Web3BaseProviderConstructor }

Type declaration

HttpProvider: Web3BaseProviderConstructor
IpcProvider: Web3BaseProviderConstructor
WebsocketProvider: Web3BaseProviderConstructor

BatchRequest

get BatchRequest(): new () => Web3BatchRequest

Returns new () => Web3BatchRequest
- - new (): Web3BatchRequest
  - Returns Web3BatchRequest

accountProvider

get accountProvider(): undefined | Web3AccountProvider<Web3BaseWalletAccount>

Returns undefined | Web3AccountProvider<Web3BaseWalletAccount>

blockHeaderTimeout

get blockHeaderTimeout(): number
set blockHeaderTimeout(val: number): void

Inherited from Web3Config.blockHeaderTimeout
Returns number
Inherited from Web3Config.blockHeaderTimeout
Parameters
- val: number
Returns void

currentProvider

get currentProvider(): undefined | string | SupportedProviders<API>
set currentProvider(provider: undefined | string | SupportedProviders<API>): void

Returns undefined | string | SupportedProviders<API>
Parameters
- provider: undefined | string | SupportedProviders<API>
Returns void

defaultAccount

get defaultAccount(): undefined | string
set defaultAccount(val: undefined | string): void

Inherited from Web3Config.defaultAccount
Returns undefined | string
Inherited from Web3Config.defaultAccount
Parameters
- val: undefined | string
Returns void

defaultBlock

get defaultBlock(): BlockNumberOrTag
set defaultBlock(val: BlockNumberOrTag): void

Inherited from Web3Config.defaultBlock
Returns BlockNumberOrTag
Inherited from Web3Config.defaultBlock
Parameters
- val: BlockNumberOrTag
Returns void

defaultChain

get defaultChain(): string
set defaultChain(val: string): void

Inherited from Web3Config.defaultChain
Returns string
Inherited from Web3Config.defaultChain
Parameters
- val: string
Returns void

defaultCommon

get defaultCommon(): undefined | Common
set defaultCommon(val: undefined | Common): void

Inherited from Web3Config.defaultCommon
Returns undefined | Common
Inherited from Web3Config.defaultCommon
Parameters
- val: undefined | Common
Returns void

defaultHardfork

get defaultHardfork(): string
set defaultHardfork(val: string): void

Inherited from Web3Config.defaultHardfork
Returns string
Inherited from Web3Config.defaultHardfork
Parameters
- val: string
Returns void

defaultMaxPriorityFeePerGas

get defaultMaxPriorityFeePerGas(): Numbers
set defaultMaxPriorityFeePerGas(val: Numbers): void

Inherited from Web3Config.defaultMaxPriorityFeePerGas
Returns Numbers
Inherited from Web3Config.defaultMaxPriorityFeePerGas
Parameters
- val: Numbers
Returns void

defaultNetworkId

get defaultNetworkId(): undefined | Numbers
set defaultNetworkId(val: undefined | Numbers): void

Inherited from Web3Config.defaultNetworkId
Returns undefined | Numbers
Inherited from Web3Config.defaultNetworkId
Parameters
- val: undefined | Numbers
Returns void

defaultTransactionType

get defaultTransactionType(): Numbers
set defaultTransactionType(val: Numbers): void

Inherited from Web3Config.defaultTransactionType
Returns Numbers
Inherited from Web3Config.defaultTransactionType
Parameters
- val: Numbers
Returns void

enableExperimentalFeatures

get enableExperimentalFeatures(): { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean }
set enableExperimentalFeatures(val: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean }): void

Inherited from Web3Config.enableExperimentalFeatures
Returns { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean }
- useRpcCallSpecification: boolean
- useSubscriptionWhenCheckingBlockTimeout: boolean
Inherited from Web3Config.enableExperimentalFeatures
Parameters
- val: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean }
Returns void

givenProvider

get givenProvider(): undefined | SupportedProviders<never>

Returns undefined | SupportedProviders<never>

handleRevert

get handleRevert(): boolean
set handleRevert(val: boolean): void

Inherited from Web3Config.handleRevert
Returns boolean
Inherited from Web3Config.handleRevert
Parameters
- val: boolean
Returns void

maxListenersWarningThreshold

get maxListenersWarningThreshold(): number
set maxListenersWarningThreshold(val: number): void

Inherited from Web3Config.maxListenersWarningThreshold
Returns number
Inherited from Web3Config.maxListenersWarningThreshold
Parameters
- val: number
Returns void

provider

get provider(): undefined | string | SupportedProviders<API>
set provider(provider: undefined | string | SupportedProviders<API>): void

Returns undefined | string | SupportedProviders<API>
Parameters
- provider: undefined | string | SupportedProviders<API>
Returns void

requestManager

get requestManager(): Web3RequestManager<API>

Returns Web3RequestManager<API>

subscriptionManager

get subscriptionManager(): undefined | Web3SubscriptionManager<API, RegisteredSubs>

Returns undefined | Web3SubscriptionManager<API, RegisteredSubs>

transactionBlockTimeout

get transactionBlockTimeout(): number
set transactionBlockTimeout(val: number): void

Inherited from Web3Config.transactionBlockTimeout
Returns number
Inherited from Web3Config.transactionBlockTimeout
Parameters
- val: number
Returns void

transactionBuilder

get transactionBuilder(): undefined | TransactionBuilder<unknown>
set transactionBuilder(val: undefined | TransactionBuilder<unknown>): void

Inherited from Web3Config.transactionBuilder
Returns undefined | TransactionBuilder<unknown>
Inherited from Web3Config.transactionBuilder
Parameters
- val: undefined | TransactionBuilder<unknown>
Returns void

transactionConfirmationBlocks

get transactionConfirmationBlocks(): number
set transactionConfirmationBlocks(val: number): void

Inherited from Web3Config.transactionConfirmationBlocks
Returns number
Inherited from Web3Config.transactionConfirmationBlocks
Parameters
- val: number
Returns void

transactionConfirmationPollingInterval

get transactionConfirmationPollingInterval(): undefined | number
set transactionConfirmationPollingInterval(val: undefined | number): void

Inherited from Web3Config.transactionConfirmationPollingInterval
Returns undefined | number
Inherited from Web3Config.transactionConfirmationPollingInterval
Parameters
- val: undefined | number
Returns void

transactionPollingInterval

get transactionPollingInterval(): number
set transactionPollingInterval(val: number): void

Inherited from Web3Config.transactionPollingInterval
Returns number
Inherited from Web3Config.transactionPollingInterval
Parameters
- val: number
Returns void

transactionPollingTimeout

get transactionPollingTimeout(): number
set transactionPollingTimeout(val: number): void

Inherited from Web3Config.transactionPollingTimeout
Returns number
Inherited from Web3Config.transactionPollingTimeout
Parameters
- val: number
Returns void

transactionReceiptPollingInterval

get transactionReceiptPollingInterval(): undefined | number
set transactionReceiptPollingInterval(val: undefined | number): void

Inherited from Web3Config.transactionReceiptPollingInterval
Returns undefined | number
Inherited from Web3Config.transactionReceiptPollingInterval
Parameters
- val: undefined | number
Returns void

transactionSendTimeout

get transactionSendTimeout(): number
set transactionSendTimeout(val: number): void

Inherited from Web3Config.transactionSendTimeout
Returns number
Inherited from Web3Config.transactionSendTimeout
Parameters
- val: number
Returns void

transactionTypeParser

get transactionTypeParser(): undefined | TransactionTypeParser
set transactionTypeParser(val: undefined | TransactionTypeParser): void

Inherited from Web3Config.transactionTypeParser
Returns undefined | TransactionTypeParser
Inherited from Web3Config.transactionTypeParser
Parameters
- val: undefined | TransactionTypeParser
Returns void

wallet

get wallet(): undefined | Web3BaseWallet<Web3BaseWalletAccount>

Returns undefined | Web3BaseWallet<Web3BaseWalletAccount>

emit

emit<K>(eventName: K, params: { CONFIG_CHANGE: { name: handleRevert; newValue: boolean; oldValue: boolean } | { name: defaultAccount; newValue: undefined | string; oldValue: undefined | string } | { name: defaultBlock; newValue: BlockNumberOrTag; oldValue: BlockNumberOrTag } | { name: transactionSendTimeout; newValue: number; oldValue: number } | { name: transactionBlockTimeout; newValue: number; oldValue: number } | { name: transactionConfirmationBlocks; newValue: number; oldValue: number } | { name: transactionPollingInterval; newValue: number; oldValue: number } | { name: transactionPollingTimeout; newValue: number; oldValue: number } | { name: transactionReceiptPollingInterval; newValue: undefined | number; oldValue: undefined | number } | { name: transactionConfirmationPollingInterval; newValue: undefined | number; oldValue: undefined | number } | { name: blockHeaderTimeout; newValue: number; oldValue: number } | { name: maxListenersWarningThreshold; newValue: number; oldValue: number } | { name: defaultNetworkId; newValue: undefined | Numbers; oldValue: undefined | Numbers } | { name: defaultChain; newValue: string; oldValue: string } | { name: defaultHardfork; newValue: string; oldValue: string } | { name: defaultCommon; newValue: undefined | Common; oldValue: undefined | Common } | { name: defaultTransactionType; newValue: Numbers; oldValue: Numbers } | { name: defaultMaxPriorityFeePerGas; newValue: Numbers; oldValue: Numbers } | { name: enableExperimentalFeatures; newValue: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean }; oldValue: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean } } | { name: transactionBuilder; newValue: undefined | TransactionBuilder<unknown>; oldValue: undefined | TransactionBuilder<unknown> } | { name: transactionTypeParser; newValue: undefined | TransactionTypeParser; oldValue: undefined | TransactionTypeParser } }[K]): void

Inherited from Web3Config.emit
Type parameters
- K: CONFIG_CHANGE
Parameters
- eventName: K
- params: { CONFIG_CHANGE: { name: handleRevert; newValue: boolean; oldValue: boolean } | { name: defaultAccount; newValue: undefined | string; oldValue: undefined | string } | { name: defaultBlock; newValue: BlockNumberOrTag; oldValue: BlockNumberOrTag } | { name: transactionSendTimeout; newValue: number; oldValue: number } | { name: transactionBlockTimeout; newValue: number; oldValue: number } | { name: transactionConfirmationBlocks; newValue: number; oldValue: number } | { name: transactionPollingInterval; newValue: number; oldValue: number } | { name: transactionPollingTimeout; newValue: number; oldValue: number } | { name: transactionReceiptPollingInterval; newValue: undefined | number; oldValue: undefined | number } | { name: transactionConfirmationPollingInterval; newValue: undefined | number; oldValue: undefined | number } | { name: blockHeaderTimeout; newValue: number; oldValue: number } | { name: maxListenersWarningThreshold; newValue: number; oldValue: number } | { name: defaultNetworkId; newValue: undefined | Numbers; oldValue: undefined | Numbers } | { name: defaultChain; newValue: string; oldValue: string } | { name: defaultHardfork; newValue: string; oldValue: string } | { name: defaultCommon; newValue: undefined | Common; oldValue: undefined | Common } | { name: defaultTransactionType; newValue: Numbers; oldValue: Numbers } | { name: defaultMaxPriorityFeePerGas; newValue: Numbers; oldValue: Numbers } | { name: enableExperimentalFeatures; newValue: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean }; oldValue: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean } } | { name: transactionBuilder; newValue: undefined | TransactionBuilder<unknown>; oldValue: undefined | TransactionBuilder<unknown> } | { name: transactionTypeParser; newValue: undefined | TransactionTypeParser; oldValue: undefined | TransactionTypeParser } }[K]
Returns void

eventNames

eventNames(): (string | symbol)[]

Inherited from Web3Config.eventNames
Returns (string | symbol)[]

getConfig

getConfig(): Web3ConfigOptions

Inherited from Web3Config.getConfig
Returns Web3ConfigOptions

getContextObject

getContextObject(): Web3ContextObject<API, RegisteredSubs>

Returns Web3ContextObject<API, RegisteredSubs>

getMaxListeners

getMaxListeners(): number

Inherited from Web3Config.getMaxListeners
Returns number

link

link<T>(parentContext: T): void

Type parameters
- T: Web3Context<unknown, any, T>
Parameters
- parentContext: T
Returns void

listenerCount

listenerCount<K>(eventName: K): number

Inherited from Web3Config.listenerCount
Type parameters
- K: CONFIG_CHANGE
Parameters
- eventName: K
Returns number

listeners

listeners<K>(eventName: K): Function[]

Inherited from Web3Config.listeners
Type parameters
- K: CONFIG_CHANGE
Parameters
- eventName: K
Returns Function[]

off

off<K>(eventName: K, fn: Web3EventCallback<{ CONFIG_CHANGE: { name: handleRevert; newValue: boolean; oldValue: boolean } | { name: defaultAccount; newValue: undefined | string; oldValue: undefined | string } | { name: defaultBlock; newValue: BlockNumberOrTag; oldValue: BlockNumberOrTag } | { name: transactionSendTimeout; newValue: number; oldValue: number } | { name: transactionBlockTimeout; newValue: number; oldValue: number } | { name: transactionConfirmationBlocks; newValue: number; oldValue: number } | { name: transactionPollingInterval; newValue: number; oldValue: number } | { name: transactionPollingTimeout; newValue: number; oldValue: number } | { name: transactionReceiptPollingInterval; newValue: undefined | number; oldValue: undefined | number } | { name: transactionConfirmationPollingInterval; newValue: undefined | number; oldValue: undefined | number } | { name: blockHeaderTimeout; newValue: number; oldValue: number } | { name: maxListenersWarningThreshold; newValue: number; oldValue: number } | { name: defaultNetworkId; newValue: undefined | Numbers; oldValue: undefined | Numbers } | { name: defaultChain; newValue: string; oldValue: string } | { name: defaultHardfork; newValue: string; oldValue: string } | { name: defaultCommon; newValue: undefined | Common; oldValue: undefined | Common } | { name: defaultTransactionType; newValue: Numbers; oldValue: Numbers } | { name: defaultMaxPriorityFeePerGas; newValue: Numbers; oldValue: Numbers } | { name: enableExperimentalFeatures; newValue: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean }; oldValue: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean } } | { name: transactionBuilder; newValue: undefined | TransactionBuilder<unknown>; oldValue: undefined | TransactionBuilder<unknown> } | { name: transactionTypeParser; newValue: undefined | TransactionTypeParser; oldValue: undefined | TransactionTypeParser } }[K]>): void

Inherited from Web3Config.off
Type parameters
- K: CONFIG_CHANGE
Parameters
- eventName: K
- fn: Web3EventCallback<{ CONFIG_CHANGE: { name: handleRevert; newValue: boolean; oldValue: boolean } | { name: defaultAccount; newValue: undefined | string; oldValue: undefined | string } | { name: defaultBlock; newValue: BlockNumberOrTag; oldValue: BlockNumberOrTag } | { name: transactionSendTimeout; newValue: number; oldValue: number } | { name: transactionBlockTimeout; newValue: number; oldValue: number } | { name: transactionConfirmationBlocks; newValue: number; oldValue: number } | { name: transactionPollingInterval; newValue: number; oldValue: number } | { name: transactionPollingTimeout; newValue: number; oldValue: number } | { name: transactionReceiptPollingInterval; newValue: undefined | number; oldValue: undefined | number } | { name: transactionConfirmationPollingInterval; newValue: undefined | number; oldValue: undefined | number } | { name: blockHeaderTimeout; newValue: number; oldValue: number } | { name: maxListenersWarningThreshold; newValue: number; oldValue: number } | { name: defaultNetworkId; newValue: undefined | Numbers; oldValue: undefined | Numbers } | { name: defaultChain; newValue: string; oldValue: string } | { name: defaultHardfork; newValue: string; oldValue: string } | { name: defaultCommon; newValue: undefined | Common; oldValue: undefined | Common } | { name: defaultTransactionType; newValue: Numbers; oldValue: Numbers } | { name: defaultMaxPriorityFeePerGas; newValue: Numbers; oldValue: Numbers } | { name: enableExperimentalFeatures; newValue: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean }; oldValue: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean } } | { name: transactionBuilder; newValue: undefined | TransactionBuilder<unknown>; oldValue: undefined | TransactionBuilder<unknown> } | { name: transactionTypeParser; newValue: undefined | TransactionTypeParser; oldValue: undefined | TransactionTypeParser } }[K]>
Returns void

on

on<K>(eventName: K, fn: Web3EventCallback<{ CONFIG_CHANGE: { name: handleRevert; newValue: boolean; oldValue: boolean } | { name: defaultAccount; newValue: undefined | string; oldValue: undefined | string } | { name: defaultBlock; newValue: BlockNumberOrTag; oldValue: BlockNumberOrTag } | { name: transactionSendTimeout; newValue: number; oldValue: number } | { name: transactionBlockTimeout; newValue: number; oldValue: number } | { name: transactionConfirmationBlocks; newValue: number; oldValue: number } | { name: transactionPollingInterval; newValue: number; oldValue: number } | { name: transactionPollingTimeout; newValue: number; oldValue: number } | { name: transactionReceiptPollingInterval; newValue: undefined | number; oldValue: undefined | number } | { name: transactionConfirmationPollingInterval; newValue: undefined | number; oldValue: undefined | number } | { name: blockHeaderTimeout; newValue: number; oldValue: number } | { name: maxListenersWarningThreshold; newValue: number; oldValue: number } | { name: defaultNetworkId; newValue: undefined | Numbers; oldValue: undefined | Numbers } | { name: defaultChain; newValue: string; oldValue: string } | { name: defaultHardfork; newValue: string; oldValue: string } | { name: defaultCommon; newValue: undefined | Common; oldValue: undefined | Common } | { name: defaultTransactionType; newValue: Numbers; oldValue: Numbers } | { name: defaultMaxPriorityFeePerGas; newValue: Numbers; oldValue: Numbers } | { name: enableExperimentalFeatures; newValue: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean }; oldValue: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean } } | { name: transactionBuilder; newValue: undefined | TransactionBuilder<unknown>; oldValue: undefined | TransactionBuilder<unknown> } | { name: transactionTypeParser; newValue: undefined | TransactionTypeParser; oldValue: undefined | TransactionTypeParser } }[K]>): void

Inherited from Web3Config.on
Type parameters
- K: CONFIG_CHANGE
Parameters
- eventName: K
- fn: Web3EventCallback<{ CONFIG_CHANGE: { name: handleRevert; newValue: boolean; oldValue: boolean } | { name: defaultAccount; newValue: undefined | string; oldValue: undefined | string } | { name: defaultBlock; newValue: BlockNumberOrTag; oldValue: BlockNumberOrTag } | { name: transactionSendTimeout; newValue: number; oldValue: number } | { name: transactionBlockTimeout; newValue: number; oldValue: number } | { name: transactionConfirmationBlocks; newValue: number; oldValue: number } | { name: transactionPollingInterval; newValue: number; oldValue: number } | { name: transactionPollingTimeout; newValue: number; oldValue: number } | { name: transactionReceiptPollingInterval; newValue: undefined | number; oldValue: undefined | number } | { name: transactionConfirmationPollingInterval; newValue: undefined | number; oldValue: undefined | number } | { name: blockHeaderTimeout; newValue: number; oldValue: number } | { name: maxListenersWarningThreshold; newValue: number; oldValue: number } | { name: defaultNetworkId; newValue: undefined | Numbers; oldValue: undefined | Numbers } | { name: defaultChain; newValue: string; oldValue: string } | { name: defaultHardfork; newValue: string; oldValue: string } | { name: defaultCommon; newValue: undefined | Common; oldValue: undefined | Common } | { name: defaultTransactionType; newValue: Numbers; oldValue: Numbers } | { name: defaultMaxPriorityFeePerGas; newValue: Numbers; oldValue: Numbers } | { name: enableExperimentalFeatures; newValue: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean }; oldValue: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean } } | { name: transactionBuilder; newValue: undefined | TransactionBuilder<unknown>; oldValue: undefined | TransactionBuilder<unknown> } | { name: transactionTypeParser; newValue: undefined | TransactionTypeParser; oldValue: undefined | TransactionTypeParser } }[K]>
Returns void

once

once<K>(eventName: K, fn: Web3EventCallback<{ CONFIG_CHANGE: { name: handleRevert; newValue: boolean; oldValue: boolean } | { name: defaultAccount; newValue: undefined | string; oldValue: undefined | string } | { name: defaultBlock; newValue: BlockNumberOrTag; oldValue: BlockNumberOrTag } | { name: transactionSendTimeout; newValue: number; oldValue: number } | { name: transactionBlockTimeout; newValue: number; oldValue: number } | { name: transactionConfirmationBlocks; newValue: number; oldValue: number } | { name: transactionPollingInterval; newValue: number; oldValue: number } | { name: transactionPollingTimeout; newValue: number; oldValue: number } | { name: transactionReceiptPollingInterval; newValue: undefined | number; oldValue: undefined | number } | { name: transactionConfirmationPollingInterval; newValue: undefined | number; oldValue: undefined | number } | { name: blockHeaderTimeout; newValue: number; oldValue: number } | { name: maxListenersWarningThreshold; newValue: number; oldValue: number } | { name: defaultNetworkId; newValue: undefined | Numbers; oldValue: undefined | Numbers } | { name: defaultChain; newValue: string; oldValue: string } | { name: defaultHardfork; newValue: string; oldValue: string } | { name: defaultCommon; newValue: undefined | Common; oldValue: undefined | Common } | { name: defaultTransactionType; newValue: Numbers; oldValue: Numbers } | { name: defaultMaxPriorityFeePerGas; newValue: Numbers; oldValue: Numbers } | { name: enableExperimentalFeatures; newValue: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean }; oldValue: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean } } | { name: transactionBuilder; newValue: undefined | TransactionBuilder<unknown>; oldValue: undefined | TransactionBuilder<unknown> } | { name: transactionTypeParser; newValue: undefined | TransactionTypeParser; oldValue: undefined | TransactionTypeParser } }[K]>): void

Inherited from Web3Config.once
Type parameters
- K: CONFIG_CHANGE
Parameters
- eventName: K
- fn: Web3EventCallback<{ CONFIG_CHANGE: { name: handleRevert; newValue: boolean; oldValue: boolean } | { name: defaultAccount; newValue: undefined | string; oldValue: undefined | string } | { name: defaultBlock; newValue: BlockNumberOrTag; oldValue: BlockNumberOrTag } | { name: transactionSendTimeout; newValue: number; oldValue: number } | { name: transactionBlockTimeout; newValue: number; oldValue: number } | { name: transactionConfirmationBlocks; newValue: number; oldValue: number } | { name: transactionPollingInterval; newValue: number; oldValue: number } | { name: transactionPollingTimeout; newValue: number; oldValue: number } | { name: transactionReceiptPollingInterval; newValue: undefined | number; oldValue: undefined | number } | { name: transactionConfirmationPollingInterval; newValue: undefined | number; oldValue: undefined | number } | { name: blockHeaderTimeout; newValue: number; oldValue: number } | { name: maxListenersWarningThreshold; newValue: number; oldValue: number } | { name: defaultNetworkId; newValue: undefined | Numbers; oldValue: undefined | Numbers } | { name: defaultChain; newValue: string; oldValue: string } | { name: defaultHardfork; newValue: string; oldValue: string } | { name: defaultCommon; newValue: undefined | Common; oldValue: undefined | Common } | { name: defaultTransactionType; newValue: Numbers; oldValue: Numbers } | { name: defaultMaxPriorityFeePerGas; newValue: Numbers; oldValue: Numbers } | { name: enableExperimentalFeatures; newValue: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean }; oldValue: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean } } | { name: transactionBuilder; newValue: undefined | TransactionBuilder<unknown>; oldValue: undefined | TransactionBuilder<unknown> } | { name: transactionTypeParser; newValue: undefined | TransactionTypeParser; oldValue: undefined | TransactionTypeParser } }[K]>
Returns void

registerPlugin

registerPlugin(plugin: Web3PluginBase<unknown>): void

Parameters
- plugin: Web3PluginBase<unknown>
Returns void

removeAllListeners

removeAllListeners(): EventEmitter

Inherited from Web3Config.removeAllListeners
Returns EventEmitter

setConfig

setConfig(options: Partial<Web3ConfigOptions>): void

Inherited from Web3Config.setConfig
Parameters
- options: Partial<Web3ConfigOptions>
Returns void

setMaxListenerWarningThreshold

setMaxListenerWarningThreshold(maxListenersWarningThreshold: number): void

Inherited from Web3Config.setMaxListenerWarningThreshold
Parameters
- maxListenersWarningThreshold: number
Returns void

setProvider

setProvider(provider?: string | SupportedProviders<API>): boolean

Parameters
- optionalprovider: string | SupportedProviders<API>
Returns boolean

use

use<T, T2>(ContextRef: Web3ContextConstructor<T, T2>, ...args: [...T2[]]): T

Type parameters
- T: Web3Context<unknown, any, T>
- T2: unknown[]
Parameters
- ContextRef: Web3ContextConstructor<T, T2>
- rest...args: [...T2[]]
Returns T

staticfromContextObject

fromContextObject<T, T3>(this: Web3ContextConstructor<T, T3>, ...args: [Web3ContextObject<unknown, any>, ...T3[]]): T

Type parameters
- T: Web3Context<unknown, any, T>
- T3: unknown[]
Parameters
- this: Web3ContextConstructor<T, T3>
- rest...args: [Web3ContextObject<unknown, any>, ...T3[]]
Returns T

abstractWeb3EthPluginBase

Web3EthPluginBase<API>:

Type parameters

API: Web3APISpec = unknown

constructor

new Web3EthPluginBase<API>(providerOrContext?: string | SupportedProviders<API & EthExecutionAPI> | Web3ContextInitOptions<API & EthExecutionAPI, any>): Web3EthPluginBase<API>

Inherited from Web3PluginBase.constructor
Type parameters
- API: unknown = unknown
Parameters
- optionalproviderOrContext: string | SupportedProviders<API & EthExecutionAPI> | Web3ContextInitOptions<API & EthExecutionAPI, any>
Returns Web3EthPluginBase<API>

abstractpluginNamespace

pluginNamespace: string

readonlyproviders

providers: { HttpProvider: Web3BaseProviderConstructor; IpcProvider: Web3BaseProviderConstructor; WebsocketProvider: Web3BaseProviderConstructor }

Type declaration

HttpProvider: Web3BaseProviderConstructor
IpcProvider: Web3BaseProviderConstructor
WebsocketProvider: Web3BaseProviderConstructor

staticoptionalgivenProvider

givenProvider?: SupportedProviders<never>

staticreadonlyproviders

providers: { HttpProvider: Web3BaseProviderConstructor; IpcProvider: Web3BaseProviderConstructor; WebsocketProvider: Web3BaseProviderConstructor }

Type declaration

HttpProvider: Web3BaseProviderConstructor
IpcProvider: Web3BaseProviderConstructor
WebsocketProvider: Web3BaseProviderConstructor

BatchRequest

get BatchRequest(): new () => Web3BatchRequest

Inherited from Web3PluginBase.BatchRequest
Returns new () => Web3BatchRequest
- - new (): Web3BatchRequest
  - Returns Web3BatchRequest

accountProvider

get accountProvider(): undefined | Web3AccountProvider<Web3BaseWalletAccount>

Inherited from Web3PluginBase.accountProvider
Returns undefined | Web3AccountProvider<Web3BaseWalletAccount>

blockHeaderTimeout

get blockHeaderTimeout(): number
set blockHeaderTimeout(val: number): void

Inherited from Web3PluginBase.blockHeaderTimeout
Returns number
Inherited from Web3PluginBase.blockHeaderTimeout
Parameters
- val: number
Returns void

currentProvider

get currentProvider(): undefined | string | SupportedProviders<API>
set currentProvider(provider: undefined | string | SupportedProviders<API>): void

Inherited from Web3PluginBase.currentProvider
Returns undefined | string | SupportedProviders<API>
Inherited from Web3PluginBase.currentProvider
Parameters
- provider: undefined | string | SupportedProviders<API>
Returns void

defaultAccount

get defaultAccount(): undefined | string
set defaultAccount(val: undefined | string): void

Inherited from Web3PluginBase.defaultAccount
Returns undefined | string
Inherited from Web3PluginBase.defaultAccount
Parameters
- val: undefined | string
Returns void

defaultBlock

get defaultBlock(): BlockNumberOrTag
set defaultBlock(val: BlockNumberOrTag): void

Inherited from Web3PluginBase.defaultBlock
Returns BlockNumberOrTag
Inherited from Web3PluginBase.defaultBlock
Parameters
- val: BlockNumberOrTag
Returns void

defaultChain

get defaultChain(): string
set defaultChain(val: string): void

Inherited from Web3PluginBase.defaultChain
Returns string
Inherited from Web3PluginBase.defaultChain
Parameters
- val: string
Returns void

defaultCommon

get defaultCommon(): undefined | Common
set defaultCommon(val: undefined | Common): void

Inherited from Web3PluginBase.defaultCommon
Returns undefined | Common
Inherited from Web3PluginBase.defaultCommon
Parameters
- val: undefined | Common
Returns void

defaultHardfork

get defaultHardfork(): string
set defaultHardfork(val: string): void

Inherited from Web3PluginBase.defaultHardfork
Returns string
Inherited from Web3PluginBase.defaultHardfork
Parameters
- val: string
Returns void

defaultMaxPriorityFeePerGas

get defaultMaxPriorityFeePerGas(): Numbers
set defaultMaxPriorityFeePerGas(val: Numbers): void

Inherited from Web3PluginBase.defaultMaxPriorityFeePerGas
Returns Numbers
Inherited from Web3PluginBase.defaultMaxPriorityFeePerGas
Parameters
- val: Numbers
Returns void

defaultNetworkId

get defaultNetworkId(): undefined | Numbers
set defaultNetworkId(val: undefined | Numbers): void

Inherited from Web3PluginBase.defaultNetworkId
Returns undefined | Numbers
Inherited from Web3PluginBase.defaultNetworkId
Parameters
- val: undefined | Numbers
Returns void

defaultTransactionType

get defaultTransactionType(): Numbers
set defaultTransactionType(val: Numbers): void

Inherited from Web3PluginBase.defaultTransactionType
Returns Numbers
Inherited from Web3PluginBase.defaultTransactionType
Parameters
- val: Numbers
Returns void

enableExperimentalFeatures

get enableExperimentalFeatures(): { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean }
set enableExperimentalFeatures(val: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean }): void

Inherited from Web3PluginBase.enableExperimentalFeatures
Returns { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean }
- useRpcCallSpecification: boolean
- useSubscriptionWhenCheckingBlockTimeout: boolean
Inherited from Web3PluginBase.enableExperimentalFeatures
Parameters
- val: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean }
Returns void

givenProvider

get givenProvider(): undefined | SupportedProviders<never>

Inherited from Web3PluginBase.givenProvider
Returns undefined | SupportedProviders<never>

handleRevert

get handleRevert(): boolean
set handleRevert(val: boolean): void

Inherited from Web3PluginBase.handleRevert
Returns boolean
Inherited from Web3PluginBase.handleRevert
Parameters
- val: boolean
Returns void

maxListenersWarningThreshold

get maxListenersWarningThreshold(): number
set maxListenersWarningThreshold(val: number): void

Inherited from Web3PluginBase.maxListenersWarningThreshold
Returns number
Inherited from Web3PluginBase.maxListenersWarningThreshold
Parameters
- val: number
Returns void

provider

get provider(): undefined | string | SupportedProviders<API>
set provider(provider: undefined | string | SupportedProviders<API>): void

Inherited from Web3PluginBase.provider
Returns undefined | string | SupportedProviders<API>
Inherited from Web3PluginBase.provider
Parameters
- provider: undefined | string | SupportedProviders<API>
Returns void

requestManager

get requestManager(): Web3RequestManager<API>

Inherited from Web3PluginBase.requestManager
Returns Web3RequestManager<API>

subscriptionManager

get subscriptionManager(): undefined | Web3SubscriptionManager<API, RegisteredSubs>

Inherited from Web3PluginBase.subscriptionManager
Returns undefined | Web3SubscriptionManager<API, RegisteredSubs>

transactionBlockTimeout

get transactionBlockTimeout(): number
set transactionBlockTimeout(val: number): void

Inherited from Web3PluginBase.transactionBlockTimeout
Returns number
Inherited from Web3PluginBase.transactionBlockTimeout
Parameters
- val: number
Returns void

transactionBuilder

get transactionBuilder(): undefined | TransactionBuilder<unknown>
set transactionBuilder(val: undefined | TransactionBuilder<unknown>): void

Inherited from Web3PluginBase.transactionBuilder
Returns undefined | TransactionBuilder<unknown>
Inherited from Web3PluginBase.transactionBuilder
Parameters
- val: undefined | TransactionBuilder<unknown>
Returns void

transactionConfirmationBlocks

get transactionConfirmationBlocks(): number
set transactionConfirmationBlocks(val: number): void

Inherited from Web3PluginBase.transactionConfirmationBlocks
Returns number
Inherited from Web3PluginBase.transactionConfirmationBlocks
Parameters
- val: number
Returns void

transactionConfirmationPollingInterval

get transactionConfirmationPollingInterval(): undefined | number
set transactionConfirmationPollingInterval(val: undefined | number): void

Inherited from Web3PluginBase.transactionConfirmationPollingInterval
Returns undefined | number
Inherited from Web3PluginBase.transactionConfirmationPollingInterval
Parameters
- val: undefined | number
Returns void

transactionPollingInterval

get transactionPollingInterval(): number
set transactionPollingInterval(val: number): void

Inherited from Web3PluginBase.transactionPollingInterval
Returns number
Inherited from Web3PluginBase.transactionPollingInterval
Parameters
- val: number
Returns void

transactionPollingTimeout

get transactionPollingTimeout(): number
set transactionPollingTimeout(val: number): void

Inherited from Web3PluginBase.transactionPollingTimeout
Returns number
Inherited from Web3PluginBase.transactionPollingTimeout
Parameters
- val: number
Returns void

transactionReceiptPollingInterval

get transactionReceiptPollingInterval(): undefined | number
set transactionReceiptPollingInterval(val: undefined | number): void

Inherited from Web3PluginBase.transactionReceiptPollingInterval
Returns undefined | number
Inherited from Web3PluginBase.transactionReceiptPollingInterval
Parameters
- val: undefined | number
Returns void

transactionSendTimeout

get transactionSendTimeout(): number
set transactionSendTimeout(val: number): void

Inherited from Web3PluginBase.transactionSendTimeout
Returns number
Inherited from Web3PluginBase.transactionSendTimeout
Parameters
- val: number
Returns void

transactionTypeParser

get transactionTypeParser(): undefined | TransactionTypeParser
set transactionTypeParser(val: undefined | TransactionTypeParser): void

Inherited from Web3PluginBase.transactionTypeParser
Returns undefined | TransactionTypeParser
Inherited from Web3PluginBase.transactionTypeParser
Parameters
- val: undefined | TransactionTypeParser
Returns void

wallet

get wallet(): undefined | Web3BaseWallet<Web3BaseWalletAccount>

Inherited from Web3PluginBase.wallet
Returns undefined | Web3BaseWallet<Web3BaseWalletAccount>

emit

emit<K>(eventName: K, params: { CONFIG_CHANGE: { name: handleRevert; newValue: boolean; oldValue: boolean } | { name: defaultAccount; newValue: undefined | string; oldValue: undefined | string } | { name: defaultBlock; newValue: BlockNumberOrTag; oldValue: BlockNumberOrTag } | { name: transactionSendTimeout; newValue: number; oldValue: number } | { name: transactionBlockTimeout; newValue: number; oldValue: number } | { name: transactionConfirmationBlocks; newValue: number; oldValue: number } | { name: transactionPollingInterval; newValue: number; oldValue: number } | { name: transactionPollingTimeout; newValue: number; oldValue: number } | { name: transactionReceiptPollingInterval; newValue: undefined | number; oldValue: undefined | number } | { name: transactionConfirmationPollingInterval; newValue: undefined | number; oldValue: undefined | number } | { name: blockHeaderTimeout; newValue: number; oldValue: number } | { name: maxListenersWarningThreshold; newValue: number; oldValue: number } | { name: defaultNetworkId; newValue: undefined | Numbers; oldValue: undefined | Numbers } | { name: defaultChain; newValue: string; oldValue: string } | { name: defaultHardfork; newValue: string; oldValue: string } | { name: defaultCommon; newValue: undefined | Common; oldValue: undefined | Common } | { name: defaultTransactionType; newValue: Numbers; oldValue: Numbers } | { name: defaultMaxPriorityFeePerGas; newValue: Numbers; oldValue: Numbers } | { name: enableExperimentalFeatures; newValue: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean }; oldValue: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean } } | { name: transactionBuilder; newValue: undefined | TransactionBuilder<unknown>; oldValue: undefined | TransactionBuilder<unknown> } | { name: transactionTypeParser; newValue: undefined | TransactionTypeParser; oldValue: undefined | TransactionTypeParser } }[K]): void

Inherited from Web3PluginBase.emit
Type parameters
- K: CONFIG_CHANGE
Parameters
- eventName: K
- params: { CONFIG_CHANGE: { name: handleRevert; newValue: boolean; oldValue: boolean } | { name: defaultAccount; newValue: undefined | string; oldValue: undefined | string } | { name: defaultBlock; newValue: BlockNumberOrTag; oldValue: BlockNumberOrTag } | { name: transactionSendTimeout; newValue: number; oldValue: number } | { name: transactionBlockTimeout; newValue: number; oldValue: number } | { name: transactionConfirmationBlocks; newValue: number; oldValue: number } | { name: transactionPollingInterval; newValue: number; oldValue: number } | { name: transactionPollingTimeout; newValue: number; oldValue: number } | { name: transactionReceiptPollingInterval; newValue: undefined | number; oldValue: undefined | number } | { name: transactionConfirmationPollingInterval; newValue: undefined | number; oldValue: undefined | number } | { name: blockHeaderTimeout; newValue: number; oldValue: number } | { name: maxListenersWarningThreshold; newValue: number; oldValue: number } | { name: defaultNetworkId; newValue: undefined | Numbers; oldValue: undefined | Numbers } | { name: defaultChain; newValue: string; oldValue: string } | { name: defaultHardfork; newValue: string; oldValue: string } | { name: defaultCommon; newValue: undefined | Common; oldValue: undefined | Common } | { name: defaultTransactionType; newValue: Numbers; oldValue: Numbers } | { name: defaultMaxPriorityFeePerGas; newValue: Numbers; oldValue: Numbers } | { name: enableExperimentalFeatures; newValue: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean }; oldValue: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean } } | { name: transactionBuilder; newValue: undefined | TransactionBuilder<unknown>; oldValue: undefined | TransactionBuilder<unknown> } | { name: transactionTypeParser; newValue: undefined | TransactionTypeParser; oldValue: undefined | TransactionTypeParser } }[K]
Returns void

eventNames

eventNames(): (string | symbol)[]

Inherited from Web3PluginBase.eventNames
Returns (string | symbol)[]

getConfig

getConfig(): Web3ConfigOptions

Inherited from Web3PluginBase.getConfig
Returns Web3ConfigOptions

getContextObject

getContextObject(): Web3ContextObject<API & EthExecutionAPI, any>

Inherited from Web3PluginBase.getContextObject
Returns Web3ContextObject<API & EthExecutionAPI, any>

getMaxListeners

getMaxListeners(): number

Inherited from Web3PluginBase.getMaxListeners
Returns number

link

link<T>(parentContext: T): void

Inherited from Web3PluginBase.link
Type parameters
- T: Web3Context<unknown, any, T>
Parameters
- parentContext: T
Returns void

listenerCount

listenerCount<K>(eventName: K): number

Inherited from Web3PluginBase.listenerCount
Type parameters
- K: CONFIG_CHANGE
Parameters
- eventName: K
Returns number

listeners

listeners<K>(eventName: K): Function[]

Inherited from Web3PluginBase.listeners
Type parameters
- K: CONFIG_CHANGE
Parameters
- eventName: K
Returns Function[]

off

off<K>(eventName: K, fn: Web3EventCallback<{ CONFIG_CHANGE: { name: handleRevert; newValue: boolean; oldValue: boolean } | { name: defaultAccount; newValue: undefined | string; oldValue: undefined | string } | { name: defaultBlock; newValue: BlockNumberOrTag; oldValue: BlockNumberOrTag } | { name: transactionSendTimeout; newValue: number; oldValue: number } | { name: transactionBlockTimeout; newValue: number; oldValue: number } | { name: transactionConfirmationBlocks; newValue: number; oldValue: number } | { name: transactionPollingInterval; newValue: number; oldValue: number } | { name: transactionPollingTimeout; newValue: number; oldValue: number } | { name: transactionReceiptPollingInterval; newValue: undefined | number; oldValue: undefined | number } | { name: transactionConfirmationPollingInterval; newValue: undefined | number; oldValue: undefined | number } | { name: blockHeaderTimeout; newValue: number; oldValue: number } | { name: maxListenersWarningThreshold; newValue: number; oldValue: number } | { name: defaultNetworkId; newValue: undefined | Numbers; oldValue: undefined | Numbers } | { name: defaultChain; newValue: string; oldValue: string } | { name: defaultHardfork; newValue: string; oldValue: string } | { name: defaultCommon; newValue: undefined | Common; oldValue: undefined | Common } | { name: defaultTransactionType; newValue: Numbers; oldValue: Numbers } | { name: defaultMaxPriorityFeePerGas; newValue: Numbers; oldValue: Numbers } | { name: enableExperimentalFeatures; newValue: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean }; oldValue: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean } } | { name: transactionBuilder; newValue: undefined | TransactionBuilder<unknown>; oldValue: undefined | TransactionBuilder<unknown> } | { name: transactionTypeParser; newValue: undefined | TransactionTypeParser; oldValue: undefined | TransactionTypeParser } }[K]>): void

Inherited from Web3PluginBase.off
Type parameters
- K: CONFIG_CHANGE
Parameters
- eventName: K
- fn: Web3EventCallback<{ CONFIG_CHANGE: { name: handleRevert; newValue: boolean; oldValue: boolean } | { name: defaultAccount; newValue: undefined | string; oldValue: undefined | string } | { name: defaultBlock; newValue: BlockNumberOrTag; oldValue: BlockNumberOrTag } | { name: transactionSendTimeout; newValue: number; oldValue: number } | { name: transactionBlockTimeout; newValue: number; oldValue: number } | { name: transactionConfirmationBlocks; newValue: number; oldValue: number } | { name: transactionPollingInterval; newValue: number; oldValue: number } | { name: transactionPollingTimeout; newValue: number; oldValue: number } | { name: transactionReceiptPollingInterval; newValue: undefined | number; oldValue: undefined | number } | { name: transactionConfirmationPollingInterval; newValue: undefined | number; oldValue: undefined | number } | { name: blockHeaderTimeout; newValue: number; oldValue: number } | { name: maxListenersWarningThreshold; newValue: number; oldValue: number } | { name: defaultNetworkId; newValue: undefined | Numbers; oldValue: undefined | Numbers } | { name: defaultChain; newValue: string; oldValue: string } | { name: defaultHardfork; newValue: string; oldValue: string } | { name: defaultCommon; newValue: undefined | Common; oldValue: undefined | Common } | { name: defaultTransactionType; newValue: Numbers; oldValue: Numbers } | { name: defaultMaxPriorityFeePerGas; newValue: Numbers; oldValue: Numbers } | { name: enableExperimentalFeatures; newValue: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean }; oldValue: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean } } | { name: transactionBuilder; newValue: undefined | TransactionBuilder<unknown>; oldValue: undefined | TransactionBuilder<unknown> } | { name: transactionTypeParser; newValue: undefined | TransactionTypeParser; oldValue: undefined | TransactionTypeParser } }[K]>
Returns void

on

on<K>(eventName: K, fn: Web3EventCallback<{ CONFIG_CHANGE: { name: handleRevert; newValue: boolean; oldValue: boolean } | { name: defaultAccount; newValue: undefined | string; oldValue: undefined | string } | { name: defaultBlock; newValue: BlockNumberOrTag; oldValue: BlockNumberOrTag } | { name: transactionSendTimeout; newValue: number; oldValue: number } | { name: transactionBlockTimeout; newValue: number; oldValue: number } | { name: transactionConfirmationBlocks; newValue: number; oldValue: number } | { name: transactionPollingInterval; newValue: number; oldValue: number } | { name: transactionPollingTimeout; newValue: number; oldValue: number } | { name: transactionReceiptPollingInterval; newValue: undefined | number; oldValue: undefined | number } | { name: transactionConfirmationPollingInterval; newValue: undefined | number; oldValue: undefined | number } | { name: blockHeaderTimeout; newValue: number; oldValue: number } | { name: maxListenersWarningThreshold; newValue: number; oldValue: number } | { name: defaultNetworkId; newValue: undefined | Numbers; oldValue: undefined | Numbers } | { name: defaultChain; newValue: string; oldValue: string } | { name: defaultHardfork; newValue: string; oldValue: string } | { name: defaultCommon; newValue: undefined | Common; oldValue: undefined | Common } | { name: defaultTransactionType; newValue: Numbers; oldValue: Numbers } | { name: defaultMaxPriorityFeePerGas; newValue: Numbers; oldValue: Numbers } | { name: enableExperimentalFeatures; newValue: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean }; oldValue: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean } } | { name: transactionBuilder; newValue: undefined | TransactionBuilder<unknown>; oldValue: undefined | TransactionBuilder<unknown> } | { name: transactionTypeParser; newValue: undefined | TransactionTypeParser; oldValue: undefined | TransactionTypeParser } }[K]>): void

Inherited from Web3PluginBase.on
Type parameters
- K: CONFIG_CHANGE
Parameters
- eventName: K
- fn: Web3EventCallback<{ CONFIG_CHANGE: { name: handleRevert; newValue: boolean; oldValue: boolean } | { name: defaultAccount; newValue: undefined | string; oldValue: undefined | string } | { name: defaultBlock; newValue: BlockNumberOrTag; oldValue: BlockNumberOrTag } | { name: transactionSendTimeout; newValue: number; oldValue: number } | { name: transactionBlockTimeout; newValue: number; oldValue: number } | { name: transactionConfirmationBlocks; newValue: number; oldValue: number } | { name: transactionPollingInterval; newValue: number; oldValue: number } | { name: transactionPollingTimeout; newValue: number; oldValue: number } | { name: transactionReceiptPollingInterval; newValue: undefined | number; oldValue: undefined | number } | { name: transactionConfirmationPollingInterval; newValue: undefined | number; oldValue: undefined | number } | { name: blockHeaderTimeout; newValue: number; oldValue: number } | { name: maxListenersWarningThreshold; newValue: number; oldValue: number } | { name: defaultNetworkId; newValue: undefined | Numbers; oldValue: undefined | Numbers } | { name: defaultChain; newValue: string; oldValue: string } | { name: defaultHardfork; newValue: string; oldValue: string } | { name: defaultCommon; newValue: undefined | Common; oldValue: undefined | Common } | { name: defaultTransactionType; newValue: Numbers; oldValue: Numbers } | { name: defaultMaxPriorityFeePerGas; newValue: Numbers; oldValue: Numbers } | { name: enableExperimentalFeatures; newValue: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean }; oldValue: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean } } | { name: transactionBuilder; newValue: undefined | TransactionBuilder<unknown>; oldValue: undefined | TransactionBuilder<unknown> } | { name: transactionTypeParser; newValue: undefined | TransactionTypeParser; oldValue: undefined | TransactionTypeParser } }[K]>
Returns void

once

once<K>(eventName: K, fn: Web3EventCallback<{ CONFIG_CHANGE: { name: handleRevert; newValue: boolean; oldValue: boolean } | { name: defaultAccount; newValue: undefined | string; oldValue: undefined | string } | { name: defaultBlock; newValue: BlockNumberOrTag; oldValue: BlockNumberOrTag } | { name: transactionSendTimeout; newValue: number; oldValue: number } | { name: transactionBlockTimeout; newValue: number; oldValue: number } | { name: transactionConfirmationBlocks; newValue: number; oldValue: number } | { name: transactionPollingInterval; newValue: number; oldValue: number } | { name: transactionPollingTimeout; newValue: number; oldValue: number } | { name: transactionReceiptPollingInterval; newValue: undefined | number; oldValue: undefined | number } | { name: transactionConfirmationPollingInterval; newValue: undefined | number; oldValue: undefined | number } | { name: blockHeaderTimeout; newValue: number; oldValue: number } | { name: maxListenersWarningThreshold; newValue: number; oldValue: number } | { name: defaultNetworkId; newValue: undefined | Numbers; oldValue: undefined | Numbers } | { name: defaultChain; newValue: string; oldValue: string } | { name: defaultHardfork; newValue: string; oldValue: string } | { name: defaultCommon; newValue: undefined | Common; oldValue: undefined | Common } | { name: defaultTransactionType; newValue: Numbers; oldValue: Numbers } | { name: defaultMaxPriorityFeePerGas; newValue: Numbers; oldValue: Numbers } | { name: enableExperimentalFeatures; newValue: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean }; oldValue: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean } } | { name: transactionBuilder; newValue: undefined | TransactionBuilder<unknown>; oldValue: undefined | TransactionBuilder<unknown> } | { name: transactionTypeParser; newValue: undefined | TransactionTypeParser; oldValue: undefined | TransactionTypeParser } }[K]>): void

Inherited from Web3PluginBase.once
Type parameters
- K: CONFIG_CHANGE
Parameters
- eventName: K
- fn: Web3EventCallback<{ CONFIG_CHANGE: { name: handleRevert; newValue: boolean; oldValue: boolean } | { name: defaultAccount; newValue: undefined | string; oldValue: undefined | string } | { name: defaultBlock; newValue: BlockNumberOrTag; oldValue: BlockNumberOrTag } | { name: transactionSendTimeout; newValue: number; oldValue: number } | { name: transactionBlockTimeout; newValue: number; oldValue: number } | { name: transactionConfirmationBlocks; newValue: number; oldValue: number } | { name: transactionPollingInterval; newValue: number; oldValue: number } | { name: transactionPollingTimeout; newValue: number; oldValue: number } | { name: transactionReceiptPollingInterval; newValue: undefined | number; oldValue: undefined | number } | { name: transactionConfirmationPollingInterval; newValue: undefined | number; oldValue: undefined | number } | { name: blockHeaderTimeout; newValue: number; oldValue: number } | { name: maxListenersWarningThreshold; newValue: number; oldValue: number } | { name: defaultNetworkId; newValue: undefined | Numbers; oldValue: undefined | Numbers } | { name: defaultChain; newValue: string; oldValue: string } | { name: defaultHardfork; newValue: string; oldValue: string } | { name: defaultCommon; newValue: undefined | Common; oldValue: undefined | Common } | { name: defaultTransactionType; newValue: Numbers; oldValue: Numbers } | { name: defaultMaxPriorityFeePerGas; newValue: Numbers; oldValue: Numbers } | { name: enableExperimentalFeatures; newValue: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean }; oldValue: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean } } | { name: transactionBuilder; newValue: undefined | TransactionBuilder<unknown>; oldValue: undefined | TransactionBuilder<unknown> } | { name: transactionTypeParser; newValue: undefined | TransactionTypeParser; oldValue: undefined | TransactionTypeParser } }[K]>
Returns void

registerPlugin

registerPlugin(plugin: Web3PluginBase<unknown>): void

Inherited from Web3PluginBase.registerPlugin
Parameters
- plugin: Web3PluginBase<unknown>
Returns void

removeAllListeners

removeAllListeners(): EventEmitter

Inherited from Web3PluginBase.removeAllListeners
Returns EventEmitter

setConfig

setConfig(options: Partial<Web3ConfigOptions>): void

Inherited from Web3PluginBase.setConfig
Parameters
- options: Partial<Web3ConfigOptions>
Returns void

setMaxListenerWarningThreshold

setMaxListenerWarningThreshold(maxListenersWarningThreshold: number): void

Inherited from Web3PluginBase.setMaxListenerWarningThreshold
Parameters
- maxListenersWarningThreshold: number
Returns void

setProvider

setProvider(provider?: string | SupportedProviders<API & EthExecutionAPI>): boolean

Inherited from Web3PluginBase.setProvider
Parameters
- optionalprovider: string | SupportedProviders<API & EthExecutionAPI>
Returns boolean

use

use<T, T2>(ContextRef: Web3ContextConstructor<T, T2>, ...args: [...T2[]]): T

Inherited from Web3PluginBase.use
Type parameters
- T: Web3Context<unknown, any, T>
- T2: unknown[]
Parameters
- ContextRef: Web3ContextConstructor<T, T2>
- rest...args: [...T2[]]
Returns T

staticfromContextObject

fromContextObject<T, T3>(this: Web3ContextConstructor<T, T3>, ...args: [Web3ContextObject<unknown, any>, ...T3[]]): T

Inherited from Web3PluginBase.fromContextObject
Type parameters
- T: Web3Context<unknown, any, T>
- T3: unknown[]
Parameters
- this: Web3ContextConstructor<T, T3>
- rest...args: [Web3ContextObject<unknown, any>, ...T3[]]
Returns T

Web3EventEmitter

Web3EventEmitter<T>:

Type parameters

T: Web3EventMap

constructor

new Web3EventEmitter<T>(): Web3EventEmitter<T>

Type parameters
- T: Web3EventMap
Returns Web3EventEmitter<T>

emit

emit<K>(eventName: K, params: T[K]): void

Implementation of Web3Emitter.emit
Type parameters
- K: string
Parameters
- eventName: K
- params: T[K]
Returns void

eventNames

eventNames(): (string | symbol)[]

Returns (string | symbol)[]

getMaxListeners

getMaxListeners(): number

Returns number

listenerCount

listenerCount<K>(eventName: K): number

Type parameters
- K: string
Parameters
- eventName: K
Returns number

listeners

listeners<K>(eventName: K): Function[]

Type parameters
- K: string
Parameters
- eventName: K
Returns Function[]

off

off<K>(eventName: K, fn: Web3EventCallback<T[K]>): void

Implementation of Web3Emitter.off
Type parameters
- K: string
Parameters
- eventName: K
- fn: Web3EventCallback<T[K]>
Returns void

on

on<K>(eventName: K, fn: Web3EventCallback<T[K]>): void

Implementation of Web3Emitter.on
Type parameters
- K: string
Parameters
- eventName: K
- fn: Web3EventCallback<T[K]>
Returns void

once

once<K>(eventName: K, fn: Web3EventCallback<T[K]>): void

Implementation of Web3Emitter.once
Type parameters
- K: string
Parameters
- eventName: K
- fn: Web3EventCallback<T[K]>
Returns void

removeAllListeners

removeAllListeners(): EventEmitter

Returns EventEmitter

setMaxListenerWarningThreshold

setMaxListenerWarningThreshold(maxListenersWarningThreshold: number): void

Parameters
- maxListenersWarningThreshold: number
Returns void

abstractWeb3PluginBase

Web3PluginBase<API>:

Type parameters

API: Web3APISpec = Web3APISpec

constructor

new Web3PluginBase<API>(providerOrContext?: string | SupportedProviders<API> | Web3ContextInitOptions<API, any>): Web3PluginBase<API>

Inherited from Web3Context.constructor
Type parameters
- API: unknown = unknown
Parameters
- optionalproviderOrContext: string | SupportedProviders<API> | Web3ContextInitOptions<API, any>
Returns Web3PluginBase<API>

abstractpluginNamespace

pluginNamespace: string

readonlyproviders

providers: { HttpProvider: Web3BaseProviderConstructor; IpcProvider: Web3BaseProviderConstructor; WebsocketProvider: Web3BaseProviderConstructor }

Type declaration

HttpProvider: Web3BaseProviderConstructor
IpcProvider: Web3BaseProviderConstructor
WebsocketProvider: Web3BaseProviderConstructor

staticoptionalgivenProvider

givenProvider?: SupportedProviders<never>

staticreadonlyproviders

providers: { HttpProvider: Web3BaseProviderConstructor; IpcProvider: Web3BaseProviderConstructor; WebsocketProvider: Web3BaseProviderConstructor }

Type declaration

HttpProvider: Web3BaseProviderConstructor
IpcProvider: Web3BaseProviderConstructor
WebsocketProvider: Web3BaseProviderConstructor

BatchRequest

get BatchRequest(): new () => Web3BatchRequest

Inherited from Web3Context.BatchRequest
Returns new () => Web3BatchRequest
- - new (): Web3BatchRequest
  - Returns Web3BatchRequest

accountProvider

get accountProvider(): undefined | Web3AccountProvider<Web3BaseWalletAccount>

Inherited from Web3Context.accountProvider
Returns undefined | Web3AccountProvider<Web3BaseWalletAccount>

blockHeaderTimeout

get blockHeaderTimeout(): number
set blockHeaderTimeout(val: number): void

Inherited from Web3Context.blockHeaderTimeout
Returns number
Inherited from Web3Context.blockHeaderTimeout
Parameters
- val: number
Returns void

currentProvider

get currentProvider(): undefined | string | SupportedProviders<API>
set currentProvider(provider: undefined | string | SupportedProviders<API>): void

Inherited from Web3Context.currentProvider
Returns undefined | string | SupportedProviders<API>
Inherited from Web3Context.currentProvider
Parameters
- provider: undefined | string | SupportedProviders<API>
Returns void

defaultAccount

get defaultAccount(): undefined | string
set defaultAccount(val: undefined | string): void

Inherited from Web3Context.defaultAccount
Returns undefined | string
Inherited from Web3Context.defaultAccount
Parameters
- val: undefined | string
Returns void

defaultBlock

get defaultBlock(): BlockNumberOrTag
set defaultBlock(val: BlockNumberOrTag): void

Inherited from Web3Context.defaultBlock
Returns BlockNumberOrTag
Inherited from Web3Context.defaultBlock
Parameters
- val: BlockNumberOrTag
Returns void

defaultChain

get defaultChain(): string
set defaultChain(val: string): void

Inherited from Web3Context.defaultChain
Returns string
Inherited from Web3Context.defaultChain
Parameters
- val: string
Returns void

defaultCommon

get defaultCommon(): undefined | Common
set defaultCommon(val: undefined | Common): void

Inherited from Web3Context.defaultCommon
Returns undefined | Common
Inherited from Web3Context.defaultCommon
Parameters
- val: undefined | Common
Returns void

defaultHardfork

get defaultHardfork(): string
set defaultHardfork(val: string): void

Inherited from Web3Context.defaultHardfork
Returns string
Inherited from Web3Context.defaultHardfork
Parameters
- val: string
Returns void

defaultMaxPriorityFeePerGas

get defaultMaxPriorityFeePerGas(): Numbers
set defaultMaxPriorityFeePerGas(val: Numbers): void

Inherited from Web3Context.defaultMaxPriorityFeePerGas
Returns Numbers
Inherited from Web3Context.defaultMaxPriorityFeePerGas
Parameters
- val: Numbers
Returns void

defaultNetworkId

get defaultNetworkId(): undefined | Numbers
set defaultNetworkId(val: undefined | Numbers): void

Inherited from Web3Context.defaultNetworkId
Returns undefined | Numbers
Inherited from Web3Context.defaultNetworkId
Parameters
- val: undefined | Numbers
Returns void

defaultTransactionType

get defaultTransactionType(): Numbers
set defaultTransactionType(val: Numbers): void

Inherited from Web3Context.defaultTransactionType
Returns Numbers
Inherited from Web3Context.defaultTransactionType
Parameters
- val: Numbers
Returns void

enableExperimentalFeatures

get enableExperimentalFeatures(): { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean }
set enableExperimentalFeatures(val: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean }): void

Inherited from Web3Context.enableExperimentalFeatures
Returns { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean }
- useRpcCallSpecification: boolean
- useSubscriptionWhenCheckingBlockTimeout: boolean
Inherited from Web3Context.enableExperimentalFeatures
Parameters
- val: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean }
Returns void

givenProvider

get givenProvider(): undefined | SupportedProviders<never>

Inherited from Web3Context.givenProvider
Returns undefined | SupportedProviders<never>

handleRevert

get handleRevert(): boolean
set handleRevert(val: boolean): void

Inherited from Web3Context.handleRevert
Returns boolean
Inherited from Web3Context.handleRevert
Parameters
- val: boolean
Returns void

maxListenersWarningThreshold

get maxListenersWarningThreshold(): number
set maxListenersWarningThreshold(val: number): void

Inherited from Web3Context.maxListenersWarningThreshold
Returns number
Inherited from Web3Context.maxListenersWarningThreshold
Parameters
- val: number
Returns void

provider

get provider(): undefined | string | SupportedProviders<API>
set provider(provider: undefined | string | SupportedProviders<API>): void

Inherited from Web3Context.provider
Returns undefined | string | SupportedProviders<API>
Inherited from Web3Context.provider
Parameters
- provider: undefined | string | SupportedProviders<API>
Returns void

requestManager

get requestManager(): Web3RequestManager<API>

Inherited from Web3Context.requestManager
Returns Web3RequestManager<API>

subscriptionManager

get subscriptionManager(): undefined | Web3SubscriptionManager<API, RegisteredSubs>

Inherited from Web3Context.subscriptionManager
Returns undefined | Web3SubscriptionManager<API, RegisteredSubs>

transactionBlockTimeout

get transactionBlockTimeout(): number
set transactionBlockTimeout(val: number): void

Inherited from Web3Context.transactionBlockTimeout
Returns number
Inherited from Web3Context.transactionBlockTimeout
Parameters
- val: number
Returns void

transactionBuilder

get transactionBuilder(): undefined | TransactionBuilder<unknown>
set transactionBuilder(val: undefined | TransactionBuilder<unknown>): void

Inherited from Web3Context.transactionBuilder
Returns undefined | TransactionBuilder<unknown>
Inherited from Web3Context.transactionBuilder
Parameters
- val: undefined | TransactionBuilder<unknown>
Returns void

transactionConfirmationBlocks

get transactionConfirmationBlocks(): number
set transactionConfirmationBlocks(val: number): void

Inherited from Web3Context.transactionConfirmationBlocks
Returns number
Inherited from Web3Context.transactionConfirmationBlocks
Parameters
- val: number
Returns void

transactionConfirmationPollingInterval

get transactionConfirmationPollingInterval(): undefined | number
set transactionConfirmationPollingInterval(val: undefined | number): void

Inherited from Web3Context.transactionConfirmationPollingInterval
Returns undefined | number
Inherited from Web3Context.transactionConfirmationPollingInterval
Parameters
- val: undefined | number
Returns void

transactionPollingInterval

get transactionPollingInterval(): number
set transactionPollingInterval(val: number): void

Inherited from Web3Context.transactionPollingInterval
Returns number
Inherited from Web3Context.transactionPollingInterval
Parameters
- val: number
Returns void

transactionPollingTimeout

get transactionPollingTimeout(): number
set transactionPollingTimeout(val: number): void

Inherited from Web3Context.transactionPollingTimeout
Returns number
Inherited from Web3Context.transactionPollingTimeout
Parameters
- val: number
Returns void

transactionReceiptPollingInterval

get transactionReceiptPollingInterval(): undefined | number
set transactionReceiptPollingInterval(val: undefined | number): void

Inherited from Web3Context.transactionReceiptPollingInterval
Returns undefined | number
Inherited from Web3Context.transactionReceiptPollingInterval
Parameters
- val: undefined | number
Returns void

transactionSendTimeout

get transactionSendTimeout(): number
set transactionSendTimeout(val: number): void

Inherited from Web3Context.transactionSendTimeout
Returns number
Inherited from Web3Context.transactionSendTimeout
Parameters
- val: number
Returns void

transactionTypeParser

get transactionTypeParser(): undefined | TransactionTypeParser
set transactionTypeParser(val: undefined | TransactionTypeParser): void

Inherited from Web3Context.transactionTypeParser
Returns undefined | TransactionTypeParser
Inherited from Web3Context.transactionTypeParser
Parameters
- val: undefined | TransactionTypeParser
Returns void

wallet

get wallet(): undefined | Web3BaseWallet<Web3BaseWalletAccount>

Inherited from Web3Context.wallet
Returns undefined | Web3BaseWallet<Web3BaseWalletAccount>

emit

emit<K>(eventName: K, params: { CONFIG_CHANGE: { name: handleRevert; newValue: boolean; oldValue: boolean } | { name: defaultAccount; newValue: undefined | string; oldValue: undefined | string } | { name: defaultBlock; newValue: BlockNumberOrTag; oldValue: BlockNumberOrTag } | { name: transactionSendTimeout; newValue: number; oldValue: number } | { name: transactionBlockTimeout; newValue: number; oldValue: number } | { name: transactionConfirmationBlocks; newValue: number; oldValue: number } | { name: transactionPollingInterval; newValue: number; oldValue: number } | { name: transactionPollingTimeout; newValue: number; oldValue: number } | { name: transactionReceiptPollingInterval; newValue: undefined | number; oldValue: undefined | number } | { name: transactionConfirmationPollingInterval; newValue: undefined | number; oldValue: undefined | number } | { name: blockHeaderTimeout; newValue: number; oldValue: number } | { name: maxListenersWarningThreshold; newValue: number; oldValue: number } | { name: defaultNetworkId; newValue: undefined | Numbers; oldValue: undefined | Numbers } | { name: defaultChain; newValue: string; oldValue: string } | { name: defaultHardfork; newValue: string; oldValue: string } | { name: defaultCommon; newValue: undefined | Common; oldValue: undefined | Common } | { name: defaultTransactionType; newValue: Numbers; oldValue: Numbers } | { name: defaultMaxPriorityFeePerGas; newValue: Numbers; oldValue: Numbers } | { name: enableExperimentalFeatures; newValue: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean }; oldValue: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean } } | { name: transactionBuilder; newValue: undefined | TransactionBuilder<unknown>; oldValue: undefined | TransactionBuilder<unknown> } | { name: transactionTypeParser; newValue: undefined | TransactionTypeParser; oldValue: undefined | TransactionTypeParser } }[K]): void

Inherited from Web3Context.emit
Type parameters
- K: CONFIG_CHANGE
Parameters
- eventName: K
- params: { CONFIG_CHANGE: { name: handleRevert; newValue: boolean; oldValue: boolean } | { name: defaultAccount; newValue: undefined | string; oldValue: undefined | string } | { name: defaultBlock; newValue: BlockNumberOrTag; oldValue: BlockNumberOrTag } | { name: transactionSendTimeout; newValue: number; oldValue: number } | { name: transactionBlockTimeout; newValue: number; oldValue: number } | { name: transactionConfirmationBlocks; newValue: number; oldValue: number } | { name: transactionPollingInterval; newValue: number; oldValue: number } | { name: transactionPollingTimeout; newValue: number; oldValue: number } | { name: transactionReceiptPollingInterval; newValue: undefined | number; oldValue: undefined | number } | { name: transactionConfirmationPollingInterval; newValue: undefined | number; oldValue: undefined | number } | { name: blockHeaderTimeout; newValue: number; oldValue: number } | { name: maxListenersWarningThreshold; newValue: number; oldValue: number } | { name: defaultNetworkId; newValue: undefined | Numbers; oldValue: undefined | Numbers } | { name: defaultChain; newValue: string; oldValue: string } | { name: defaultHardfork; newValue: string; oldValue: string } | { name: defaultCommon; newValue: undefined | Common; oldValue: undefined | Common } | { name: defaultTransactionType; newValue: Numbers; oldValue: Numbers } | { name: defaultMaxPriorityFeePerGas; newValue: Numbers; oldValue: Numbers } | { name: enableExperimentalFeatures; newValue: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean }; oldValue: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean } } | { name: transactionBuilder; newValue: undefined | TransactionBuilder<unknown>; oldValue: undefined | TransactionBuilder<unknown> } | { name: transactionTypeParser; newValue: undefined | TransactionTypeParser; oldValue: undefined | TransactionTypeParser } }[K]
Returns void

eventNames

eventNames(): (string | symbol)[]

Inherited from Web3Context.eventNames
Returns (string | symbol)[]

getConfig

getConfig(): Web3ConfigOptions

Inherited from Web3Context.getConfig
Returns Web3ConfigOptions

getContextObject

getContextObject(): Web3ContextObject<API, any>

Inherited from Web3Context.getContextObject
Returns Web3ContextObject<API, any>

getMaxListeners

getMaxListeners(): number

Inherited from Web3Context.getMaxListeners
Returns number

link

link<T>(parentContext: T): void

Inherited from Web3Context.link
Type parameters
- T: Web3Context<unknown, any, T>
Parameters
- parentContext: T
Returns void

listenerCount

listenerCount<K>(eventName: K): number

Inherited from Web3Context.listenerCount
Type parameters
- K: CONFIG_CHANGE
Parameters
- eventName: K
Returns number

listeners

listeners<K>(eventName: K): Function[]

Inherited from Web3Context.listeners
Type parameters
- K: CONFIG_CHANGE
Parameters
- eventName: K
Returns Function[]

off

off<K>(eventName: K, fn: Web3EventCallback<{ CONFIG_CHANGE: { name: handleRevert; newValue: boolean; oldValue: boolean } | { name: defaultAccount; newValue: undefined | string; oldValue: undefined | string } | { name: defaultBlock; newValue: BlockNumberOrTag; oldValue: BlockNumberOrTag } | { name: transactionSendTimeout; newValue: number; oldValue: number } | { name: transactionBlockTimeout; newValue: number; oldValue: number } | { name: transactionConfirmationBlocks; newValue: number; oldValue: number } | { name: transactionPollingInterval; newValue: number; oldValue: number } | { name: transactionPollingTimeout; newValue: number; oldValue: number } | { name: transactionReceiptPollingInterval; newValue: undefined | number; oldValue: undefined | number } | { name: transactionConfirmationPollingInterval; newValue: undefined | number; oldValue: undefined | number } | { name: blockHeaderTimeout; newValue: number; oldValue: number } | { name: maxListenersWarningThreshold; newValue: number; oldValue: number } | { name: defaultNetworkId; newValue: undefined | Numbers; oldValue: undefined | Numbers } | { name: defaultChain; newValue: string; oldValue: string } | { name: defaultHardfork; newValue: string; oldValue: string } | { name: defaultCommon; newValue: undefined | Common; oldValue: undefined | Common } | { name: defaultTransactionType; newValue: Numbers; oldValue: Numbers } | { name: defaultMaxPriorityFeePerGas; newValue: Numbers; oldValue: Numbers } | { name: enableExperimentalFeatures; newValue: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean }; oldValue: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean } } | { name: transactionBuilder; newValue: undefined | TransactionBuilder<unknown>; oldValue: undefined | TransactionBuilder<unknown> } | { name: transactionTypeParser; newValue: undefined | TransactionTypeParser; oldValue: undefined | TransactionTypeParser } }[K]>): void

Inherited from Web3Context.off
Type parameters
- K: CONFIG_CHANGE
Parameters
- eventName: K
- fn: Web3EventCallback<{ CONFIG_CHANGE: { name: handleRevert; newValue: boolean; oldValue: boolean } | { name: defaultAccount; newValue: undefined | string; oldValue: undefined | string } | { name: defaultBlock; newValue: BlockNumberOrTag; oldValue: BlockNumberOrTag } | { name: transactionSendTimeout; newValue: number; oldValue: number } | { name: transactionBlockTimeout; newValue: number; oldValue: number } | { name: transactionConfirmationBlocks; newValue: number; oldValue: number } | { name: transactionPollingInterval; newValue: number; oldValue: number } | { name: transactionPollingTimeout; newValue: number; oldValue: number } | { name: transactionReceiptPollingInterval; newValue: undefined | number; oldValue: undefined | number } | { name: transactionConfirmationPollingInterval; newValue: undefined | number; oldValue: undefined | number } | { name: blockHeaderTimeout; newValue: number; oldValue: number } | { name: maxListenersWarningThreshold; newValue: number; oldValue: number } | { name: defaultNetworkId; newValue: undefined | Numbers; oldValue: undefined | Numbers } | { name: defaultChain; newValue: string; oldValue: string } | { name: defaultHardfork; newValue: string; oldValue: string } | { name: defaultCommon; newValue: undefined | Common; oldValue: undefined | Common } | { name: defaultTransactionType; newValue: Numbers; oldValue: Numbers } | { name: defaultMaxPriorityFeePerGas; newValue: Numbers; oldValue: Numbers } | { name: enableExperimentalFeatures; newValue: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean }; oldValue: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean } } | { name: transactionBuilder; newValue: undefined | TransactionBuilder<unknown>; oldValue: undefined | TransactionBuilder<unknown> } | { name: transactionTypeParser; newValue: undefined | TransactionTypeParser; oldValue: undefined | TransactionTypeParser } }[K]>
Returns void

on

on<K>(eventName: K, fn: Web3EventCallback<{ CONFIG_CHANGE: { name: handleRevert; newValue: boolean; oldValue: boolean } | { name: defaultAccount; newValue: undefined | string; oldValue: undefined | string } | { name: defaultBlock; newValue: BlockNumberOrTag; oldValue: BlockNumberOrTag } | { name: transactionSendTimeout; newValue: number; oldValue: number } | { name: transactionBlockTimeout; newValue: number; oldValue: number } | { name: transactionConfirmationBlocks; newValue: number; oldValue: number } | { name: transactionPollingInterval; newValue: number; oldValue: number } | { name: transactionPollingTimeout; newValue: number; oldValue: number } | { name: transactionReceiptPollingInterval; newValue: undefined | number; oldValue: undefined | number } | { name: transactionConfirmationPollingInterval; newValue: undefined | number; oldValue: undefined | number } | { name: blockHeaderTimeout; newValue: number; oldValue: number } | { name: maxListenersWarningThreshold; newValue: number; oldValue: number } | { name: defaultNetworkId; newValue: undefined | Numbers; oldValue: undefined | Numbers } | { name: defaultChain; newValue: string; oldValue: string } | { name: defaultHardfork; newValue: string; oldValue: string } | { name: defaultCommon; newValue: undefined | Common; oldValue: undefined | Common } | { name: defaultTransactionType; newValue: Numbers; oldValue: Numbers } | { name: defaultMaxPriorityFeePerGas; newValue: Numbers; oldValue: Numbers } | { name: enableExperimentalFeatures; newValue: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean }; oldValue: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean } } | { name: transactionBuilder; newValue: undefined | TransactionBuilder<unknown>; oldValue: undefined | TransactionBuilder<unknown> } | { name: transactionTypeParser; newValue: undefined | TransactionTypeParser; oldValue: undefined | TransactionTypeParser } }[K]>): void

Inherited from Web3Context.on
Type parameters
- K: CONFIG_CHANGE
Parameters
- eventName: K
- fn: Web3EventCallback<{ CONFIG_CHANGE: { name: handleRevert; newValue: boolean; oldValue: boolean } | { name: defaultAccount; newValue: undefined | string; oldValue: undefined | string } | { name: defaultBlock; newValue: BlockNumberOrTag; oldValue: BlockNumberOrTag } | { name: transactionSendTimeout; newValue: number; oldValue: number } | { name: transactionBlockTimeout; newValue: number; oldValue: number } | { name: transactionConfirmationBlocks; newValue: number; oldValue: number } | { name: transactionPollingInterval; newValue: number; oldValue: number } | { name: transactionPollingTimeout; newValue: number; oldValue: number } | { name: transactionReceiptPollingInterval; newValue: undefined | number; oldValue: undefined | number } | { name: transactionConfirmationPollingInterval; newValue: undefined | number; oldValue: undefined | number } | { name: blockHeaderTimeout; newValue: number; oldValue: number } | { name: maxListenersWarningThreshold; newValue: number; oldValue: number } | { name: defaultNetworkId; newValue: undefined | Numbers; oldValue: undefined | Numbers } | { name: defaultChain; newValue: string; oldValue: string } | { name: defaultHardfork; newValue: string; oldValue: string } | { name: defaultCommon; newValue: undefined | Common; oldValue: undefined | Common } | { name: defaultTransactionType; newValue: Numbers; oldValue: Numbers } | { name: defaultMaxPriorityFeePerGas; newValue: Numbers; oldValue: Numbers } | { name: enableExperimentalFeatures; newValue: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean }; oldValue: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean } } | { name: transactionBuilder; newValue: undefined | TransactionBuilder<unknown>; oldValue: undefined | TransactionBuilder<unknown> } | { name: transactionTypeParser; newValue: undefined | TransactionTypeParser; oldValue: undefined | TransactionTypeParser } }[K]>
Returns void

once

once<K>(eventName: K, fn: Web3EventCallback<{ CONFIG_CHANGE: { name: handleRevert; newValue: boolean; oldValue: boolean } | { name: defaultAccount; newValue: undefined | string; oldValue: undefined | string } | { name: defaultBlock; newValue: BlockNumberOrTag; oldValue: BlockNumberOrTag } | { name: transactionSendTimeout; newValue: number; oldValue: number } | { name: transactionBlockTimeout; newValue: number; oldValue: number } | { name: transactionConfirmationBlocks; newValue: number; oldValue: number } | { name: transactionPollingInterval; newValue: number; oldValue: number } | { name: transactionPollingTimeout; newValue: number; oldValue: number } | { name: transactionReceiptPollingInterval; newValue: undefined | number; oldValue: undefined | number } | { name: transactionConfirmationPollingInterval; newValue: undefined | number; oldValue: undefined | number } | { name: blockHeaderTimeout; newValue: number; oldValue: number } | { name: maxListenersWarningThreshold; newValue: number; oldValue: number } | { name: defaultNetworkId; newValue: undefined | Numbers; oldValue: undefined | Numbers } | { name: defaultChain; newValue: string; oldValue: string } | { name: defaultHardfork; newValue: string; oldValue: string } | { name: defaultCommon; newValue: undefined | Common; oldValue: undefined | Common } | { name: defaultTransactionType; newValue: Numbers; oldValue: Numbers } | { name: defaultMaxPriorityFeePerGas; newValue: Numbers; oldValue: Numbers } | { name: enableExperimentalFeatures; newValue: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean }; oldValue: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean } } | { name: transactionBuilder; newValue: undefined | TransactionBuilder<unknown>; oldValue: undefined | TransactionBuilder<unknown> } | { name: transactionTypeParser; newValue: undefined | TransactionTypeParser; oldValue: undefined | TransactionTypeParser } }[K]>): void

Inherited from Web3Context.once
Type parameters
- K: CONFIG_CHANGE
Parameters
- eventName: K
- fn: Web3EventCallback<{ CONFIG_CHANGE: { name: handleRevert; newValue: boolean; oldValue: boolean } | { name: defaultAccount; newValue: undefined | string; oldValue: undefined | string } | { name: defaultBlock; newValue: BlockNumberOrTag; oldValue: BlockNumberOrTag } | { name: transactionSendTimeout; newValue: number; oldValue: number } | { name: transactionBlockTimeout; newValue: number; oldValue: number } | { name: transactionConfirmationBlocks; newValue: number; oldValue: number } | { name: transactionPollingInterval; newValue: number; oldValue: number } | { name: transactionPollingTimeout; newValue: number; oldValue: number } | { name: transactionReceiptPollingInterval; newValue: undefined | number; oldValue: undefined | number } | { name: transactionConfirmationPollingInterval; newValue: undefined | number; oldValue: undefined | number } | { name: blockHeaderTimeout; newValue: number; oldValue: number } | { name: maxListenersWarningThreshold; newValue: number; oldValue: number } | { name: defaultNetworkId; newValue: undefined | Numbers; oldValue: undefined | Numbers } | { name: defaultChain; newValue: string; oldValue: string } | { name: defaultHardfork; newValue: string; oldValue: string } | { name: defaultCommon; newValue: undefined | Common; oldValue: undefined | Common } | { name: defaultTransactionType; newValue: Numbers; oldValue: Numbers } | { name: defaultMaxPriorityFeePerGas; newValue: Numbers; oldValue: Numbers } | { name: enableExperimentalFeatures; newValue: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean }; oldValue: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean } } | { name: transactionBuilder; newValue: undefined | TransactionBuilder<unknown>; oldValue: undefined | TransactionBuilder<unknown> } | { name: transactionTypeParser; newValue: undefined | TransactionTypeParser; oldValue: undefined | TransactionTypeParser } }[K]>
Returns void

registerPlugin

registerPlugin(plugin: Web3PluginBase<unknown>): void

Inherited from Web3Context.registerPlugin
Parameters
- plugin: Web3PluginBase<unknown>
Returns void

removeAllListeners

removeAllListeners(): EventEmitter

Inherited from Web3Context.removeAllListeners
Returns EventEmitter

setConfig

setConfig(options: Partial<Web3ConfigOptions>): void

Inherited from Web3Context.setConfig
Parameters
- options: Partial<Web3ConfigOptions>
Returns void

setMaxListenerWarningThreshold

setMaxListenerWarningThreshold(maxListenersWarningThreshold: number): void

Inherited from Web3Context.setMaxListenerWarningThreshold
Parameters
- maxListenersWarningThreshold: number
Returns void

setProvider

setProvider(provider?: string | SupportedProviders<API>): boolean

Inherited from Web3Context.setProvider
Parameters
- optionalprovider: string | SupportedProviders<API>
Returns boolean

use

use<T, T2>(ContextRef: Web3ContextConstructor<T, T2>, ...args: [...T2[]]): T

Inherited from Web3Context.use
Type parameters
- T: Web3Context<unknown, any, T>
- T2: unknown[]
Parameters
- ContextRef: Web3ContextConstructor<T, T2>
- rest...args: [...T2[]]
Returns T

staticfromContextObject

fromContextObject<T, T3>(this: Web3ContextConstructor<T, T3>, ...args: [Web3ContextObject<unknown, any>, ...T3[]]): T

Inherited from Web3Context.fromContextObject
Type parameters
- T: Web3Context<unknown, any, T>
- T3: unknown[]
Parameters
- this: Web3ContextConstructor<T, T3>
- rest...args: [Web3ContextObject<unknown, any>, ...T3[]]
Returns T

Web3PromiEvent

Web3PromiEvent<ResolveType, EventMap>:

Type parameters

ResolveType
EventMap: Web3EventMap

constructor

new Web3PromiEvent<ResolveType, EventMap>(executor: PromiseExecutor<ResolveType>): Web3PromiEvent<ResolveType, EventMap>

Overrides Web3EventEmitter.constructor
Type parameters
- ResolveType
- EventMap: Web3EventMap
Parameters
- executor: PromiseExecutor<ResolveType>
Returns Web3PromiEvent<ResolveType, EventMap>

[toStringTag]

[toStringTag]: Promise

catch

catch<TResult>(onrejected?: (reason: unknown) => TResult | PromiseLike<TResult>): Promise<ResolveType | TResult>

Implementation of Promise.catch
Type parameters
- TResult = never
Parameters
- optionalonrejected: (reason: unknown) => TResult | PromiseLike<TResult>
Returns Promise<ResolveType | TResult>

emit

emit<K>(eventName: K, params: EventMap[K]): void

Inherited from Web3EventEmitter.emit
Type parameters
- K: string
Parameters
- eventName: K
- params: EventMap[K]
Returns void

eventNames

eventNames(): (string | symbol)[]

Inherited from Web3EventEmitter.eventNames
Returns (string | symbol)[]

finally

finally(onfinally?: () => void): Promise<ResolveType>

Implementation of Promise.finally
Parameters
- optionalonfinally: () => void
Returns Promise<ResolveType>

getMaxListeners

getMaxListeners(): number

Inherited from Web3EventEmitter.getMaxListeners
Returns number

listenerCount

listenerCount<K>(eventName: K): number

Inherited from Web3EventEmitter.listenerCount
Type parameters
- K: string
Parameters
- eventName: K
Returns number

listeners

listeners<K>(eventName: K): Function[]

Inherited from Web3EventEmitter.listeners
Type parameters
- K: string
Parameters
- eventName: K
Returns Function[]

off

off<K>(eventName: K, fn: Web3EventCallback<EventMap[K]>): void

Inherited from Web3EventEmitter.off
Type parameters
- K: string
Parameters
- eventName: K
- fn: Web3EventCallback<EventMap[K]>
Returns void

on

on<K>(eventName: K, fn: Web3EventCallback<EventMap[K]>): Web3PromiEvent<ResolveType, EventMap>

Overrides Web3EventEmitter.on
Type parameters
- K: string
Parameters
- eventName: K
- fn: Web3EventCallback<EventMap[K]>
Returns Web3PromiEvent<ResolveType, EventMap>

once

once<K>(eventName: K, fn: Web3EventCallback<EventMap[K]>): Web3PromiEvent<ResolveType, EventMap>

Overrides Web3EventEmitter.once
Type parameters
- K: string
Parameters
- eventName: K
- fn: Web3EventCallback<EventMap[K]>
Returns Web3PromiEvent<ResolveType, EventMap>

removeAllListeners

removeAllListeners(): EventEmitter

Inherited from Web3EventEmitter.removeAllListeners
Returns EventEmitter

setMaxListenerWarningThreshold

setMaxListenerWarningThreshold(maxListenersWarningThreshold: number): void

Inherited from Web3EventEmitter.setMaxListenerWarningThreshold
Parameters
- maxListenersWarningThreshold: number
Returns void

then

then<TResult1, TResult2>(onfulfilled?: (value: ResolveType) => TResult1 | PromiseLike<TResult1>, onrejected?: (reason: unknown) => TResult2 | PromiseLike<TResult2>): Promise<TResult1 | TResult2>

Implementation of Promise.then
Type parameters
- TResult1 = ResolveType
- TResult2 = never
Parameters
- optionalonfulfilled: (value: ResolveType) => TResult1 | PromiseLike<TResult1>
- optionalonrejected: (reason: unknown) => TResult2 | PromiseLike<TResult2>
Returns Promise<TResult1 | TResult2>

Web3RequestManager

Web3RequestManager<API>:

Type parameters

API: Web3APISpec = EthExecutionAPI

constructor

new Web3RequestManager<API>(provider?: string | SupportedProviders<API>, net?: Socket, useRpcCallSpecification?: boolean): Web3RequestManager<API>

Overrides Web3EventEmitter.constructor
Type parameters
- API: unknown = EthExecutionAPI
Parameters
- optionalprovider: string | SupportedProviders<API>
- optionalnet: Socket
- optionaluseRpcCallSpecification: boolean
Returns Web3RequestManager<API>

provider

get provider(): undefined | SupportedProviders<API>

Returns undefined | SupportedProviders<API>

providers

get providers(): { HttpProvider: Web3BaseProviderConstructor; IpcProvider: Web3BaseProviderConstructor; WebsocketProvider: Web3BaseProviderConstructor }

Returns { HttpProvider: Web3BaseProviderConstructor; IpcProvider: Web3BaseProviderConstructor; WebsocketProvider: Web3BaseProviderConstructor }
- HttpProvider: Web3BaseProviderConstructor
- IpcProvider: Web3BaseProviderConstructor
- WebsocketProvider: Web3BaseProviderConstructor

staticproviders

get providers(): { HttpProvider: Web3BaseProviderConstructor; IpcProvider: Web3BaseProviderConstructor; WebsocketProvider: Web3BaseProviderConstructor }

Returns { HttpProvider: Web3BaseProviderConstructor; IpcProvider: Web3BaseProviderConstructor; WebsocketProvider: Web3BaseProviderConstructor }
- HttpProvider: Web3BaseProviderConstructor
- IpcProvider: Web3BaseProviderConstructor
- WebsocketProvider: Web3BaseProviderConstructor

emit

emit<K>(eventName: K, params: { BEFORE_PROVIDER_CHANGE: undefined | SupportedProviders<API>; PROVIDER_CHANGED: undefined | SupportedProviders<API> }[K]): void

Inherited from Web3EventEmitter.emit
Type parameters
- K: Web3EventKey<{ BEFORE_PROVIDER_CHANGE: undefined | SupportedProviders<API>; PROVIDER_CHANGED: undefined | SupportedProviders<API> }>
Parameters
- eventName: K
- params: { BEFORE_PROVIDER_CHANGE: undefined | SupportedProviders<API>; PROVIDER_CHANGED: undefined | SupportedProviders<API> }[K]
Returns void

eventNames

eventNames(): (string | symbol)[]

Inherited from Web3EventEmitter.eventNames
Returns (string | symbol)[]

getMaxListeners

getMaxListeners(): number

Inherited from Web3EventEmitter.getMaxListeners
Returns number

listenerCount

listenerCount<K>(eventName: K): number

Inherited from Web3EventEmitter.listenerCount
Type parameters
- K: Web3EventKey<{ BEFORE_PROVIDER_CHANGE: undefined | SupportedProviders<API>; PROVIDER_CHANGED: undefined | SupportedProviders<API> }>
Parameters
- eventName: K
Returns number

listeners

listeners<K>(eventName: K): Function[]

Inherited from Web3EventEmitter.listeners
Type parameters
- K: Web3EventKey<{ BEFORE_PROVIDER_CHANGE: undefined | SupportedProviders<API>; PROVIDER_CHANGED: undefined | SupportedProviders<API> }>
Parameters
- eventName: K
Returns Function[]

off

off<K>(eventName: K, fn: Web3EventCallback<{ BEFORE_PROVIDER_CHANGE: undefined | SupportedProviders<API>; PROVIDER_CHANGED: undefined | SupportedProviders<API> }[K]>): void

Inherited from Web3EventEmitter.off
Type parameters
- K: Web3EventKey<{ BEFORE_PROVIDER_CHANGE: undefined | SupportedProviders<API>; PROVIDER_CHANGED: undefined | SupportedProviders<API> }>
Parameters
- eventName: K
- fn: Web3EventCallback<{ BEFORE_PROVIDER_CHANGE: undefined | SupportedProviders<API>; PROVIDER_CHANGED: undefined | SupportedProviders<API> }[K]>
Returns void

on

on<K>(eventName: K, fn: Web3EventCallback<{ BEFORE_PROVIDER_CHANGE: undefined | SupportedProviders<API>; PROVIDER_CHANGED: undefined | SupportedProviders<API> }[K]>): void

Inherited from Web3EventEmitter.on
Type parameters
- K: Web3EventKey<{ BEFORE_PROVIDER_CHANGE: undefined | SupportedProviders<API>; PROVIDER_CHANGED: undefined | SupportedProviders<API> }>
Parameters
- eventName: K
- fn: Web3EventCallback<{ BEFORE_PROVIDER_CHANGE: undefined | SupportedProviders<API>; PROVIDER_CHANGED: undefined | SupportedProviders<API> }[K]>
Returns void

once

once<K>(eventName: K, fn: Web3EventCallback<{ BEFORE_PROVIDER_CHANGE: undefined | SupportedProviders<API>; PROVIDER_CHANGED: undefined | SupportedProviders<API> }[K]>): void

Inherited from Web3EventEmitter.once
Type parameters
- K: Web3EventKey<{ BEFORE_PROVIDER_CHANGE: undefined | SupportedProviders<API>; PROVIDER_CHANGED: undefined | SupportedProviders<API> }>
Parameters
- eventName: K
- fn: Web3EventCallback<{ BEFORE_PROVIDER_CHANGE: undefined | SupportedProviders<API>; PROVIDER_CHANGED: undefined | SupportedProviders<API> }[K]>
Returns void

removeAllListeners

removeAllListeners(): EventEmitter

Inherited from Web3EventEmitter.removeAllListeners
Returns EventEmitter

send

send<Method, ResponseType>(request: Web3APIRequest<API, Method>): Promise<ResponseType>

Type parameters
- Method: string
- ResponseType = Web3APIReturnType<API, Method>
Parameters
- request: Web3APIRequest<API, Method>
Returns Promise<ResponseType>

sendBatch

sendBatch(request: JsonRpcBatchRequest): Promise<JsonRpcBatchResponse<unknown, JsonRpcResult>>

Parameters
- request: JsonRpcBatchRequest
Returns Promise<JsonRpcBatchResponse<unknown, JsonRpcResult>>

setMaxListenerWarningThreshold

setMaxListenerWarningThreshold(maxListenersWarningThreshold: number): void

Inherited from Web3EventEmitter.setMaxListenerWarningThreshold
Parameters
- maxListenersWarningThreshold: number
Returns void

setProvider

setProvider(provider?: string | SupportedProviders<API>, net?: Socket): boolean

Parameters
- optionalprovider: string | SupportedProviders<API>
- optionalnet: Socket
Returns boolean

abstractWeb3Subscription

Web3Subscription<EventMap, ArgsType, API>:

Type parameters

EventMap: Web3EventMap
ArgsType = any
API: Web3APISpec = EthExecutionAPI

constructor

new Web3Subscription<EventMap, ArgsType, API>(args: ArgsType, options: { requestManager: Web3RequestManager<API>; returnFormat?: DataFormat }): Web3Subscription<EventMap, ArgsType, API>

Overrides Web3EventEmitter.constructor
Type parameters
- EventMap: Web3EventMap
- ArgsType = any
- API: unknown = EthExecutionAPI
Parameters
- args: ArgsType
- options: { requestManager: Web3RequestManager<API>; returnFormat?: DataFormat }
Returns Web3Subscription<EventMap, ArgsType, API>

readonlyargs

args: ArgsType

id

get id(): undefined | string

Returns undefined | string

lastBlock

get lastBlock(): undefined | BlockOutput

Returns undefined | BlockOutput

emit

emit<K>(eventName: K, params: EventMap[K]): void

Inherited from Web3EventEmitter.emit
Type parameters
- K: string
Parameters
- eventName: K
- params: EventMap[K]
Returns void

eventNames

eventNames(): (string | symbol)[]

Inherited from Web3EventEmitter.eventNames
Returns (string | symbol)[]

getMaxListeners

getMaxListeners(): number

Inherited from Web3EventEmitter.getMaxListeners
Returns number

listenerCount

listenerCount<K>(eventName: K): number

Inherited from Web3EventEmitter.listenerCount
Type parameters
- K: string
Parameters
- eventName: K
Returns number

listeners

listeners<K>(eventName: K): Function[]

Inherited from Web3EventEmitter.listeners
Type parameters
- K: string
Parameters
- eventName: K
Returns Function[]

off

off<K>(eventName: K, fn: Web3EventCallback<EventMap[K]>): void

Inherited from Web3EventEmitter.off
Type parameters
- K: string
Parameters
- eventName: K
- fn: Web3EventCallback<EventMap[K]>
Returns void

on

on<K>(eventName: K, fn: Web3EventCallback<EventMap[K]>): void

Inherited from Web3EventEmitter.on
Type parameters
- K: string
Parameters
- eventName: K
- fn: Web3EventCallback<EventMap[K]>
Returns void

once

once<K>(eventName: K, fn: Web3EventCallback<EventMap[K]>): void

Inherited from Web3EventEmitter.once
Type parameters
- K: string
Parameters
- eventName: K
- fn: Web3EventCallback<EventMap[K]>
Returns void

removeAllListeners

removeAllListeners(): EventEmitter

Inherited from Web3EventEmitter.removeAllListeners
Returns EventEmitter

resubscribe

resubscribe(): Promise<void>

Returns Promise<void>

setMaxListenerWarningThreshold

setMaxListenerWarningThreshold(maxListenersWarningThreshold: number): void

Inherited from Web3EventEmitter.setMaxListenerWarningThreshold
Parameters
- maxListenersWarningThreshold: number
Returns void

subscribe(): Promise<void>

Returns Promise<void>

unsubscribe

unsubscribe(): Promise<void>

Returns Promise<void>

Web3SubscriptionManager

Web3SubscriptionManager<API, RegisteredSubs>:

Type parameters

API: Web3APISpec
RegisteredSubs: {}

constructor

new Web3SubscriptionManager<API, RegisteredSubs>(requestManager: Web3RequestManager<API>, registeredSubscriptions: RegisteredSubs): Web3SubscriptionManager<API, RegisteredSubs>

Type parameters
- API: unknown
- RegisteredSubs: {}
Parameters
- requestManager: Web3RequestManager<API>
- registeredSubscriptions: RegisteredSubs
Returns Web3SubscriptionManager<API, RegisteredSubs>

readonlyregisteredSubscriptions

registeredSubscriptions: RegisteredSubs

readonlyrequestManager

requestManager: Web3RequestManager<API>

subscriptions

get subscriptions(): Map<string, InstanceType<RegisteredSubs[keyof RegisteredSubs]>>

Returns Map<string, InstanceType<RegisteredSubs[keyof RegisteredSubs]>>

addSubscription

addSubscription(sub: InstanceType<RegisteredSubs[keyof RegisteredSubs]>): Promise<void>

Parameters
- sub: InstanceType<RegisteredSubs[keyof RegisteredSubs]>
Returns Promise<void>

clear

clear(): void

Returns void

removeSubscription

removeSubscription(sub: InstanceType<RegisteredSubs[keyof RegisteredSubs]>): Promise<string>

Parameters
- sub: InstanceType<RegisteredSubs[keyof RegisteredSubs]>
Returns Promise<string>

subscribe<T>(name: T, args?: ConstructorParameters<RegisteredSubs[T]>[0], returnFormat?: DataFormat): Promise<InstanceType<RegisteredSubs[T]>>

Type parameters
- T: string | number | symbol
Parameters
- name: T
- optionalargs: ConstructorParameters<RegisteredSubs[T]>[0]
- optionalreturnFormat: DataFormat
Returns Promise<InstanceType<RegisteredSubs[T]>>

supportsSubscriptions

supportsSubscriptions(): boolean

Returns boolean

unsubscribe

unsubscribe(condition?: ShouldUnsubscribeCondition): Promise<string[]>

Parameters
- optionalcondition: ShouldUnsubscribeCondition
Returns Promise<string[]>

Interfaces

Web3ConfigOptions

Web3ConfigOptions:

blockHeaderTimeout

blockHeaderTimeout: number

optionaldefaultAccount

defaultAccount?: string

defaultBlock

defaultBlock: BlockNumberOrTag

defaultChain

defaultChain: string

optionaldefaultCommon

defaultCommon?: Common

defaultHardfork

defaultHardfork: string

defaultMaxPriorityFeePerGas

defaultMaxPriorityFeePerGas: Numbers

optionaldefaultNetworkId

defaultNetworkId?: Numbers

defaultTransactionType

defaultTransactionType: Numbers

enableExperimentalFeatures

enableExperimentalFeatures: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean }

Type declaration

useRpcCallSpecification: boolean
useSubscriptionWhenCheckingBlockTimeout: boolean

handleRevert

handleRevert: boolean

maxListenersWarningThreshold

maxListenersWarningThreshold: number

transactionBlockTimeout

transactionBlockTimeout: number

optionaltransactionBuilder

transactionBuilder?: TransactionBuilder<unknown>

transactionConfirmationBlocks

transactionConfirmationBlocks: number

optionaltransactionConfirmationPollingInterval

transactionConfirmationPollingInterval?: number

transactionPollingInterval

transactionPollingInterval: number

transactionPollingTimeout

transactionPollingTimeout: number

optionaltransactionReceiptPollingInterval

transactionReceiptPollingInterval?: number

transactionSendTimeout

transactionSendTimeout: number

optionaltransactionTypeParser

transactionTypeParser?: TransactionTypeParser

Web3Emitter

Web3Emitter<T>:

Type parameters

T: Web3EventMap

emit

emit<K>(eventName: K, params: T[K]): void

Type parameters
- K: string
Parameters
- eventName: K
- params: T[K]
Returns void

off

off<K>(eventName: K, fn: Web3EventCallback<T[K]>): void

Type parameters
- K: string
Parameters
- eventName: K
- fn: Web3EventCallback<T[K]>
Returns void

on

on<K>(eventName: K, fn: Web3EventCallback<T[K]>): void

Type parameters
- K: string
Parameters
- eventName: K
- fn: Web3EventCallback<T[K]>
Returns void

once

once<K>(eventName: K, fn: Web3EventCallback<T[K]>): void

Type parameters
- K: string
Parameters
- eventName: K
- fn: Web3EventCallback<T[K]>
Returns void

Type Aliases

PromiseExecutor

PromiseExecutor<T>: (resolve: (data: T) => void, reject: (reason: unknown) => void) => void

Type parameters

Type declaration

- (resolve: (data: T) => void, reject: (reason: unknown) => void): void
- Parameters
  - resolve: (data: T) => void
  - reject: (reason: unknown) => void
  Returns void

TransactionBuilder

TransactionBuilder<API>: <ReturnType>(options: { privateKey?: HexString | Buffer; transaction: Record<string, unknown>; web3Context: Web3Context<API> }) => Promise<ReturnType>

Type parameters

API: Web3APISpec = unknown

Type declaration

- <ReturnType>(options: { privateKey?: HexString | Buffer; transaction: Record<string, unknown>; web3Context: Web3Context<API> }): Promise<ReturnType>
- Type parameters
  - ReturnType = Record<string, unknown>
  Parameters
  - options: { privateKey?: HexString | Buffer; transaction: Record<string, unknown>; web3Context: Web3Context<API> }
  Returns Promise<ReturnType>

TransactionTypeParser

TransactionTypeParser: (transaction: Record<string, unknown>) => HexString | undefined

Type declaration

- (transaction: Record<string, unknown>): HexString | undefined
- Parameters
  - transaction: Record<string, unknown>
  Returns HexString | undefined

Web3ContextConstructor

Web3ContextConstructor<T, T2>: new (...args: [extras: T2, context: Web3ContextObject]) => T

Type parameters

T: Web3Context
T2: unknown[]

Type declaration

- new (...args: [extras: T2, context: Web3ContextObject]): T
- Parameters
  - rest...args: [extras: T2, context: Web3ContextObject]
  Returns T

Web3ContextFactory

Web3ContextFactory<T, T2>: Web3ContextConstructor<T, T2> & { fromContextObject: any }

Type parameters

T: Web3Context
T2: unknown[]

Web3ContextInitOptions

Web3ContextInitOptions<API, RegisteredSubs>: { accountProvider?: Web3AccountProvider<Web3BaseWalletAccount>; config?: Partial<Web3ConfigOptions>; provider?: SupportedProviders<API> | string; registeredSubscriptions?: RegisteredSubs; requestManager?: Web3RequestManager<API>; subscriptionManager?: Web3SubscriptionManager<API, RegisteredSubs>; wallet?: Web3BaseWallet<Web3BaseWalletAccount> }

Type parameters

API: Web3APISpec = unknown
RegisteredSubs: {} = any

Type declaration

optionalaccountProvider?: Web3AccountProvider<Web3BaseWalletAccount>
optionalconfig?: Partial<Web3ConfigOptions>
optionalprovider?: SupportedProviders<API> | string
optionalregisteredSubscriptions?: RegisteredSubs
optionalrequestManager?: Web3RequestManager<API>
optionalsubscriptionManager?: Web3SubscriptionManager<API, RegisteredSubs>
optionalwallet?: Web3BaseWallet<Web3BaseWalletAccount>

Web3ContextObject

Web3ContextObject<API, RegisteredSubs>: { accountProvider?: Web3AccountProvider<Web3BaseWalletAccount>; config: Web3ConfigOptions; provider?: SupportedProviders<API> | string; providers: typeof Web3RequestManager.providers; registeredSubscriptions?: RegisteredSubs; requestManager: Web3RequestManager<API>; subscriptionManager?: Web3SubscriptionManager<API, RegisteredSubs>; wallet?: Web3BaseWallet<Web3BaseWalletAccount> }

Type parameters

API: Web3APISpec = unknown
RegisteredSubs: {} = any

Type declaration

optionalaccountProvider?: Web3AccountProvider<Web3BaseWalletAccount>
config: Web3ConfigOptions
optionalprovider?: SupportedProviders<API> | string
providers: typeof Web3RequestManager.providers
optionalregisteredSubscriptions?: RegisteredSubs
requestManager: Web3RequestManager<API>
optionalsubscriptionManager?: Web3SubscriptionManager<API, RegisteredSubs>
optionalwallet?: Web3BaseWallet<Web3BaseWalletAccount>

Web3EventCallback

Web3EventCallback<T>: (params: T) => void | Promise<void>

Type parameters

Type declaration

- (params: T): void | Promise<void>
- Parameters
  - params: T
  Returns void | Promise<void>

Web3EventKey

Web3EventKey<T>: string & keyof T

Type parameters

T: Web3EventMap

Web3EventMap

Web3EventMap: Record<string, unknown>

Web3SubscriptionConstructor

Web3SubscriptionConstructor<API, SubscriptionType>: new (args: any, options: { requestManager: Web3RequestManager<API>; returnFormat?: DataFormat }) => SubscriptionType

Type parameters

API: Web3APISpec
SubscriptionType: Web3Subscription<any, any, API> = Web3Subscription<any, any, API>

Type declaration

- new (args: any, options: { requestManager: Web3RequestManager<API>; returnFormat?: DataFormat }): SubscriptionType
- Parameters
  - args: any
  - options: { requestManager: Web3RequestManager<API>; returnFormat?: DataFormat }
  Returns SubscriptionType

Variables

constDEFAULT_BATCH_REQUEST_TIMEOUT

DEFAULT_BATCH_REQUEST_TIMEOUT: 1000 = 1000

Functions

inputAddressFormatter

inputAddressFormatter(address: string): string

Parameters
- address: string
Returns string

inputBlockNumberFormatter

inputBlockNumberFormatter(blockNumber: undefined | Numbers): undefined | string

Parameters
- blockNumber: undefined | Numbers
Returns undefined | string

inputCallFormatter

inputCallFormatter(options: TransactionInput, defaultAccount?: string): Mutable<TransactionOutput>

Parameters
- options: TransactionInput
- optionaldefaultAccount: string
Returns Mutable<TransactionOutput>

inputDefaultBlockNumberFormatter

inputDefaultBlockNumberFormatter(blockNumber: undefined | Numbers, defaultBlock: Numbers): undefined | string

Parameters
- blockNumber: undefined | Numbers
- defaultBlock: Numbers
Returns undefined | string

inputLogFormatter

inputLogFormatter(filter: Filter): Filter

Parameters
- filter: Filter
Returns Filter

inputPostFormatter

inputPostFormatter(post: PostOutput): PostInput

Parameters
- post: PostOutput
Returns PostInput

inputSignFormatter

inputSignFormatter(data: string): string

Parameters
- data: string
Returns string

inputStorageKeysFormatter

inputStorageKeysFormatter(keys: string[]): string[]

Parameters
- keys: string[]
Returns string[]

inputTopicFormatter

inputTopicFormatter(topic: string): null | string

Parameters
- topic: string
Returns null | string

inputTransactionFormatter

inputTransactionFormatter(options: TransactionInput, defaultAccount?: string): Mutable<TransactionOutput>

Parameters
- options: TransactionInput
- optionaldefaultAccount: string
Returns Mutable<TransactionOutput>

isEIP1193Provider

isEIP1193Provider<API>(provider: SupportedProviders<API>): provider is EIP1193Provider<API>

Type parameters
- API: unknown
Parameters
- provider: SupportedProviders<API>
Returns provider is EIP1193Provider<API>

isLegacyRequestProvider

isLegacyRequestProvider<API>(provider: SupportedProviders<API>): provider is LegacyRequestProvider

Type parameters
- API: unknown
Parameters
- provider: SupportedProviders<API>
Returns provider is LegacyRequestProvider

isLegacySendAsyncProvider

isLegacySendAsyncProvider<API>(provider: SupportedProviders<API>): provider is LegacySendAsyncProvider

Type parameters
- API: unknown
Parameters
- provider: SupportedProviders<API>
Returns provider is LegacySendAsyncProvider

isLegacySendProvider

isLegacySendProvider<API>(provider: SupportedProviders<API>): provider is LegacySendProvider

Type parameters
- API: unknown
Parameters
- provider: SupportedProviders<API>
Returns provider is LegacySendProvider

isSupportSubscriptions

isSupportSubscriptions<API>(provider: SupportedProviders<API>): boolean

Type parameters
- API: unknown
Parameters
- provider: SupportedProviders<API>
Returns boolean

isSupportedProvider

isSupportedProvider<API>(provider: SupportedProviders<API>): provider is SupportedProviders<API>

Type parameters
- API: unknown
Parameters
- provider: SupportedProviders<API>
Returns provider is SupportedProviders<API>

isWeb3Provider

isWeb3Provider<API>(provider: SupportedProviders<API>): provider is Web3BaseProvider<API>

Type parameters
- API: unknown
Parameters
- provider: SupportedProviders<API>
Returns provider is Web3BaseProvider<API>

outputBigIntegerFormatter

outputBigIntegerFormatter(number: Numbers): number | bigint

Parameters
- number: Numbers
Returns number | bigint

outputBlockFormatter

outputBlockFormatter(block: BlockInput): BlockOutput

Parameters
- block: BlockInput
Returns BlockOutput

outputLogFormatter

outputLogFormatter(log: Partial<LogsInput>): LogsOutput

Parameters
- log: Partial<LogsInput>
Returns LogsOutput

outputPostFormatter

outputPostFormatter(post: PostInput): PostOutput

Parameters
- post: PostInput
Returns PostOutput

outputProofFormatter

outputProofFormatter(proof: Proof): Proof

Parameters
- proof: Proof
Returns Proof

outputSyncingFormatter

outputSyncingFormatter(result: SyncInput): SyncOutput

Parameters
- result: SyncInput
Returns SyncOutput

outputTransactionFormatter

outputTransactionFormatter(tx: TransactionInput): TransactionOutput

Parameters
- tx: TransactionInput
Returns TransactionOutput

outputTransactionReceiptFormatter

outputTransactionReceiptFormatter(receipt: ReceiptInput): ReceiptOutput

Parameters
- receipt: ReceiptInput
Returns ReceiptOutput

txInputOptionsFormatter

txInputOptionsFormatter(options: TransactionInput): Mutable<TransactionOutput>

Parameters
- options: TransactionInput
Returns Mutable<TransactionOutput>

Index

Namespaces

Enumerations

Classes

Interfaces

Type Aliases

Variables

Functions

Namespaces

formatters

inputAddressFormatter

Parameters

address: string

Returns string

inputBlockNumberFormatter

Parameters

blockNumber: undefined | Numbers

Returns undefined | string

inputCallFormatter

Parameters

options: TransactionInput

optionaldefaultAccount: string

Returns Mutable<TransactionOutput>

inputDefaultBlockNumberFormatter

Parameters

blockNumber: undefined | Numbers

defaultBlock: Numbers

Returns undefined | string

inputLogFormatter

Parameters

filter: Filter

Returns Filter

inputPostFormatter

Parameters

post: PostOutput

Returns PostInput

inputSignFormatter

Parameters

data: string

Returns string

inputStorageKeysFormatter

Parameters

keys: string[]

Returns string[]

inputTopicFormatter

Parameters

topic: string

Returns null | string

inputTransactionFormatter

Parameters

options: TransactionInput

optionaldefaultAccount: string

Returns Mutable<TransactionOutput>

outputBigIntegerFormatter

Parameters

number: Numbers

Returns number | bigint

outputBlockFormatter

Parameters

block: BlockInput

Returns BlockOutput

outputLogFormatter

Parameters

log: Partial<LogsInput>

Returns LogsOutput

outputPostFormatter

Parameters

post: PostInput

Returns PostOutput

outputProofFormatter

Parameters

proof: Proof

Returns Proof

outputSyncingFormatter

Parameters

result: SyncInput

Returns SyncOutput

outputTransactionFormatter

Parameters

tx: TransactionInput