eth

Index

References

• Web3Eth

Namespaces

• abi
• accounts
• contract
• ens
• iban
• personal

Classes

• LogsSubscription
• NewHeadsSubscription
• NewPendingTransactionsSubscription
• SyncingSubscription

Interfaces

• SendSignedTransactionOptions
• SendTransactionOptions

Type Aliases

• InternalTransaction
• SendSignedTransactionEvents
• SendTransactionEvents

Variables

• accessListItemSchema
• accessListResultSchema
• accessListSchema
• accountSchema
• blockHeaderSchema
• blockSchema
• chainSchema
• customChainSchema
• feeHistorySchema
• hardforkSchema
• logSchema
• registeredSubscriptions
• storageProofSchema
• syncSchema
• transactionInfoSchema
• transactionReceiptSchema
• transactionSchema

Functions

• call
• createAccessList
• detectTransactionType
• estimateGas
• formatTransaction
• getBalance
• getBlock
• getBlockNumber
• getBlockTransactionCount
• getBlockUncleCount
• getChainId
• getCode
• getCoinbase
• getFeeHistory
• getGasPrice
• getHashRate
• getLogs
• getPendingTransactions
• getProof
• getProtocolVersion
• getStorageAt
• getTransaction
• getTransactionCount
• getTransactionFromBlock
• getTransactionReceipt
• getUncle
• isAccessList
• isAccessListEntry
• isBaseTransaction
• isMining
• isSyncing
• isTransaction1559Unsigned
• isTransaction2930Unsigned
• isTransactionCall
• isTransactionLegacyUnsigned
• isTransactionWithSender
• prepareTransactionForSigning
• sendSignedTransaction
• sendTransaction
• sign
• signTransaction
• transactionBuilder
• validateBaseChain
• validateChainInfo
• validateCustomChainInfo
• validateFeeMarketGas
• validateGas
• validateHardfork
• validateLegacyGas
• validateTransactionCall
• validateTransactionForSigning
• validateTransactionWithSender

References

Web3Eth

Re-exports Web3Eth

Namespaces

abi

abi:

decodeLog

• decodeLog<ReturnType_1>(inputs: AbiParameter[], data: string, topics: string | string[]): ReturnType_1

• Type parameters

  • ReturnType_1: DecodedParams<ReturnType_1>

  Parameters

  • inputs: AbiParameter[]

  • data: string

  • topics: string | string[]

  Returns ReturnType_1

decodeParameter

• decodeParameter(abi: AbiInput, bytes: string): unknown

• Parameters

  • abi: AbiInput

  • bytes: string

  Returns unknown

decodeParameters

• decodeParameters(abi: AbiInput[], bytes: string): { __length__: number }

• Parameters

  • abi: AbiInput[]

  • bytes: string

  Returns { __length__: number }

  • [key string]: unknown

  • __length__: number

decodeParametersWith

• decodeParametersWith(abis: AbiInput[], bytes: string, loose: boolean): { __length__: number }

• Parameters

  • abis: AbiInput[]

  • bytes: string

  • loose: boolean

  Returns { __length__: number }

  • [key string]: unknown

  • __length__: number

encodeErrorSignature

• encodeErrorSignature(functionName: string | AbiErrorFragment): string

• Parameters

  • functionName: string | AbiErrorFragment

  Returns string

encodeEventSignature

• encodeEventSignature(functionName: string | AbiEventFragment): string

• Parameters

  • functionName: string | AbiEventFragment

  Returns string

encodeFunctionCall

• encodeFunctionCall(jsonInterface: AbiFunctionFragment, params: unknown[]): string

• Parameters

  • jsonInterface: AbiFunctionFragment

  • params: unknown[]

  Returns string

encodeFunctionSignature

• encodeFunctionSignature(functionName: string | AbiFunctionFragment): string

• Parameters

  • functionName: string | AbiFunctionFragment

  Returns string

encodeParameter

• encodeParameter(abi: AbiInput, param: unknown): string

• Parameters

  • abi: AbiInput

  • param: unknown

  Returns string

encodeParameters

• encodeParameters(abi: readonly AbiInput[], params: unknown[]): string

• Parameters

  • abi: readonly AbiInput[]

  • params: unknown[]

  Returns string

flattenTypes

• flattenTypes(includeTuple: boolean, puts: readonly AbiParameter[]): string[]

• Parameters

  • includeTuple: boolean

  • puts: readonly AbiParameter[]

  Returns string[]

formatOddHexstrings

• formatOddHexstrings(param: string): string

• Parameters

  • param: string

  Returns string

formatParam

• formatParam(type: string, _param: unknown): unknown

• Parameters

  • type: string

  • _param: unknown

  Returns unknown

isAbiConstructorFragment

• isAbiConstructorFragment(item: unknown): item is AbiConstructorFragment

• Parameters

  • item: unknown

  Returns item is AbiConstructorFragment

isAbiErrorFragment

• isAbiErrorFragment(item: unknown): item is AbiEventFragment

• Parameters

  • item: unknown

  Returns item is AbiEventFragment

isAbiEventFragment

• isAbiEventFragment(item: unknown): item is AbiEventFragment

• Parameters

  • item: unknown

  Returns item is AbiEventFragment

isAbiFragment

• isAbiFragment(item: unknown): item is AbiFragment

• Parameters

  • item: unknown

  Returns item is AbiFragment

isAbiFunctionFragment

• isAbiFunctionFragment(item: unknown): item is AbiFunctionFragment

• Parameters

  • item: unknown

  Returns item is AbiFunctionFragment

isOddHexstring

• isOddHexstring(param: unknown): boolean

• Parameters

  • param: unknown

  Returns boolean

isSimplifiedStructFormat

• isSimplifiedStructFormat(type: Partial<AbiParameter> | Partial<AbiInput>): type is Omit<AbiParameter, name | components>

• Parameters

  • type: Partial<AbiParameter> | Partial<AbiInput>

  Returns type is Omit<AbiParameter, name | components>

jsonInterfaceMethodToString

• jsonInterfaceMethodToString(json: AbiFragment): string

• Parameters

  • json: AbiFragment

  Returns string

mapStructNameAndType

• mapStructNameAndType(structName: string): AbiStruct

• Parameters

  • structName: string

  Returns AbiStruct

mapStructToCoderFormat

• mapStructToCoderFormat(struct: AbiStruct): AbiCoderStruct[]

• Parameters

  • struct: AbiStruct

  Returns AbiCoderStruct[]

mapTypes

• mapTypes(types: AbiInput[]): (string | Record<string, unknown> | AbiParameter)[]

• Parameters

  • types: AbiInput[]

  Returns (string | Record<string, unknown> | AbiParameter)[]

modifyParams

• modifyParams(coder: Coder, param: unknown[]): unknown

• Parameters

  • coder: Coder

  • param: unknown[]

  Returns unknown

accounts

accounts:

Wallet

Wallet<T>:

Type parameters

• T: Web3BaseWalletAccount = Web3BaseWalletAccount

constructor

• new Wallet<T>(accountProvider: Web3AccountProvider<T>): Wallet<T>

• Inherited from Web3BaseWallet.constructor

  Type parameters

  • T: Web3BaseWalletAccount = Web3BaseWalletAccount

  Parameters

  • accountProvider: Web3AccountProvider<T>

  Returns Wallet<T>

add

• add(account: string | T): Wallet<T>

• Overrides Web3BaseWallet.add

  Parameters

  • account: string | T

  Returns Wallet<T>

clear

• clear(): Wallet<T>

• Overrides Web3BaseWallet.clear

  Returns Wallet<T>

create

• create(numberOfAccounts: number): Wallet<T>

• Overrides Web3BaseWallet.create

  Parameters

  • numberOfAccounts: number

  Returns Wallet<T>

decrypt

• decrypt(encryptedWallets: KeyStore[], password: string, options?: Record<string, unknown>): Promise<Wallet<T>>

• Overrides Web3BaseWallet.decrypt

  Parameters

  • encryptedWallets: KeyStore[]

  • password: string

  • optionaloptions: Record<string, unknown>

  Returns Promise<Wallet<T>>

encrypt

• encrypt(password: string, options?: Record<string, unknown>): Promise<KeyStore[]>

• Overrides Web3BaseWallet.encrypt

  Parameters

  • password: string

  • optionaloptions: Record<string, unknown>

  Returns Promise<KeyStore[]>

get

• get(addressOrIndex: string | number): undefined | T

• Overrides Web3BaseWallet.get

  Parameters

  • addressOrIndex: string | number

  Returns undefined | T

load

• load(password: string, keyName?: string): Promise<Wallet<T>>

• Overrides Web3BaseWallet.load

  Parameters

  • password: string

  • optionalkeyName: string

  Returns Promise<Wallet<T>>

remove

• remove(addressOrIndex: string | number): boolean

• Overrides Web3BaseWallet.remove

  Parameters

  • addressOrIndex: string | number

  Returns boolean

save

• save(password: string, keyName?: string): Promise<boolean>

• Overrides Web3BaseWallet.save

  Parameters

  • password: string

  • optionalkeyName: string

  Returns Promise<boolean>

staticgetStorage

• getStorage(): undefined | WebStorage

• Returns undefined | WebStorage

Web3Account

Web3Account:

address

address: string

Overrides Web3BaseWalletAccount.address

privateKey

privateKey: string

Overrides Web3BaseWalletAccount.privateKey

readonlyencrypt

• encrypt(password: string, options?: Record<string, unknown>): Promise<KeyStore>

• Inherited from Web3BaseWalletAccount.encrypt

  Parameters

  • password: string

  • optionaloptions: Record<string, unknown>

  Returns Promise<KeyStore>

readonlysign

• sign(data: string | Record<string, unknown>): { message?: string; messageHash: string; r: string; s: string; signature: string; v: string }

• Inherited from Web3BaseWalletAccount.sign

  Parameters

  • data: string | Record<string, unknown>

  Returns { message?: string; messageHash: string; r: string; s: string; signature: string; v: string }

  • optionalreadonlymessage?: string

  • readonlymessageHash: string

  • readonlyr: string

  • readonlys: string

  • readonlysignature: string

  • readonlyv: string

readonlysignTransaction

• signTransaction(tx: Record<string, unknown>): Promise<{ messageHash: string; r: string; rawTransaction: string; s: string; transactionHash: string; v: string }>

• Inherited from Web3BaseWalletAccount.signTransaction

  Parameters

  • tx: Record<string, unknown>

  Returns Promise<{ messageHash: string; r: string; rawTransaction: string; s: string; transactionHash: string; v: string }>

WebStorage

WebStorage:

readonlylength

length: number

clear

• clear(): void

• Returns void

getItem

• getItem(key: string): null | string

• Parameters

  • key: string

  Returns null | string

key

• key(index: number): null | string

• Parameters

  • index: number

  Returns null | string

removeItem

• removeItem(key: string): void

• Parameters

  • key: string

  Returns void

setItem

• setItem(key: string, value: string): void

• Parameters

  • key: string

  • value: string

  Returns void

SignFunction

SignFunction: (data: string, privateKey: string) => SignResult

Type declaration

• • (data: string, privateKey: string): SignResult

  • Parameters

    • data: string

    • privateKey: string

    Returns SignResult

SignResult

SignResult: SignatureObject & { message?: string; signature: string }

SignTransactionFunction

SignTransactionFunction: (transaction: TxData | AccessListEIP2930TxData | FeeMarketEIP1559TxData | Record<string, unknown>) => SignTransactionResult

Type declaration

• • (transaction: TxData | AccessListEIP2930TxData | FeeMarketEIP1559TxData | Record<string, unknown>): SignTransactionResult

  • Parameters

    • transaction: TxData | AccessListEIP2930TxData | FeeMarketEIP1559TxData | Record<string, unknown>

    Returns SignTransactionResult

SignTransactionResult

SignTransactionResult: SignatureObject & { rawTransaction: string; transactionHash: string }

SignatureObject

SignatureObject: { messageHash: string; r: string; s: string; v: string }

Type declaration

• messageHash: string

• r: string

• s: string

• v: string

constkeyStoreSchema

keyStoreSchema: { properties: { address: { type: string }; crypto: { properties: { cipher: { type: string }; cipherparams: { type: string }; ciphertext: { type: string }; kdf: { type: string }; kdfparams: { type: string }; mac: { type: string }; salt: { type: string } }; required: string[]; type: string }; id: { type: string }; version: { type: string } }; required: string[]; type: string }

Type declaration

• properties: { address: { type: string }; crypto: { properties: { cipher: { type: string }; cipherparams: { type: string }; ciphertext: { type: string }; kdf: { type: string }; kdfparams: { type: string }; mac: { type: string }; salt: { type: string } }; required: string[]; type: string }; id: { type: string }; version: { type: string } }

  • address: { type: string }

    • type: string

  • crypto: { properties: { cipher: { type: string }; cipherparams: { type: string }; ciphertext: { type: string }; kdf: { type: string }; kdfparams: { type: string }; mac: { type: string }; salt: { type: string } }; required: string[]; type: string }

    • properties: { cipher: { type: string }; cipherparams: { type: string }; ciphertext: { type: string }; kdf: { type: string }; kdfparams: { type: string }; mac: { type: string }; salt: { type: string } }

      • cipher: { type: string }

        • type: string

      • cipherparams: { type: string }

        • type: string

      • ciphertext: { type: string }

        • type: string

      • kdf: { type: string }

        • type: string

      • kdfparams: { type: string }

        • type: string

      • mac: { type: string }

        • type: string

      • salt: { type: string }

        • type: string

    • required: string[]

    • type: string

  • id: { type: string }

    • type: string

  • version: { type: string }

    • type: string

• required: string[]

• type: string

create

• create(): Web3Account

• Returns Web3Account

decrypt

• decrypt(keystore: string | KeyStore, password: string | Buffer, nonStrict?: boolean): Promise<Web3Account>

• Parameters

  • keystore: string | KeyStore

  • password: string | Buffer

  • optionalnonStrict: boolean

  Returns Promise<Web3Account>

encrypt

• encrypt(privateKey: Bytes, password: string | Buffer, options?: CipherOptions): Promise<KeyStore>

• Parameters

  • privateKey: Bytes

  • password: string | Buffer

  • optionaloptions: CipherOptions

  Returns Promise<KeyStore>

hashMessage

• hashMessage(message: string): string

• Parameters

  • message: string

  Returns string

parseAndValidatePrivateKey

• parseAndValidatePrivateKey(data: Bytes, ignoreLength?: boolean): Buffer

• Parameters

  • data: Bytes

  • optionalignoreLength: boolean

  Returns Buffer

privateKeyToAccount

• privateKeyToAccount(privateKey: Bytes, ignoreLength?: boolean): Web3Account

• Parameters

  • privateKey: Bytes

  • optionalignoreLength: boolean

  Returns Web3Account

privateKeyToAddress

• privateKeyToAddress(privateKey: Bytes): string

• Parameters

  • privateKey: Bytes

  Returns string

recover

• recover(data: string | SignatureObject, signatureOrV?: string, prefixedOrR?: string | boolean, s?: string, prefixed?: boolean): string

• Parameters

  • data: string | SignatureObject

  • optionalsignatureOrV: string

  • optionalprefixedOrR: string | boolean

  • optionals: string

  • optionalprefixed: boolean

  Returns string

recoverTransaction

• recoverTransaction(rawTransaction: string): string

• Parameters

  • rawTransaction: string

  Returns string

sign

• sign(data: string, privateKey: Bytes): SignResult

• Parameters

  • data: string

  • privateKey: Bytes

  Returns SignResult

signTransaction

• signTransaction(transaction: TypedTransaction, privateKey: string): Promise<SignTransactionResult>

• Parameters

  • transaction: TypedTransaction

  • privateKey: string

  Returns Promise<SignTransactionResult>

contract

contract:

Contract

Re-exports Contract

default

Renames and re-exports Contract

LogsSubscription

LogsSubscription:

constructor

• new LogsSubscription(args: { abi: AbiBaseFragment & { anonymous?: boolean; inputs?: readonly AbiParameter[]; name: string; type: string } & { signature: string }; address?: string; jsonInterface: ContractAbiWithSignature; topics?: (string | string[])[] }, options: { requestManager: Web3RequestManager<EthExecutionAPI>; returnFormat?: DataFormat }): LogsSubscription

• Overrides Web3Subscription.constructor

  Parameters

  • args: { abi: AbiBaseFragment & { anonymous?: boolean; inputs?: readonly AbiParameter[]; name: string; type: string } & { signature: string }; address?: string; jsonInterface: ContractAbiWithSignature; topics?: (string | string[])[] }

  • options: { requestManager: Web3RequestManager<EthExecutionAPI>; returnFormat?: DataFormat }

  Returns LogsSubscription

readonlyabi

abi: AbiBaseFragment & { anonymous?: boolean; inputs?: readonly AbiParameter[]; name: string; type: string } & { signature: string }

optionalreadonlyaddress

address?: string

readonlyargs

args: { abi: AbiEventFragment; address?: string; topics?: (string | string[])[] }

Inherited from Web3Subscription.args

Type declaration

• abi: AbiEventFragment

• optionaladdress?: string

• optionaltopics?: (string | string[])[]

readonlyjsonInterface

jsonInterface: ContractAbiWithSignature

optionalreadonlytopics

topics?: (string | string[])[]

id

• get id(): undefined | string

• Inherited from Web3Subscription.id

  Returns undefined | string

lastBlock

• get lastBlock(): undefined | BlockOutput

• Inherited from Web3Subscription.lastBlock

  Returns undefined | BlockOutput

emit

• emit<K>(eventName: K, params: { changed: EventLog & { removed: true }; connected: number; data: EventLog; error: Error }[K]): void

• Inherited from Web3Subscription.emit

  Type parameters

  • K: Web3EventKey<{ changed: EventLog & { removed: true }; connected: number; data: EventLog; error: Error }>

  Parameters

  • eventName: K

  • params: { changed: EventLog & { removed: true }; connected: number; data: EventLog; error: Error }[K]

  Returns void

eventNames

• eventNames(): (string | symbol)[]

• Inherited from Web3Subscription.eventNames

  Returns (string | symbol)[]

getMaxListeners

• getMaxListeners(): number

• Inherited from Web3Subscription.getMaxListeners

  Returns number

listenerCount

• listenerCount<K>(eventName: K): number

• Inherited from Web3Subscription.listenerCount

  Type parameters

  • K: Web3EventKey<{ changed: EventLog & { removed: true }; connected: number; data: EventLog; error: Error }>

  Parameters

  • eventName: K

  Returns number

listeners

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

• Inherited from Web3Subscription.listeners

  Type parameters

  • K: Web3EventKey<{ changed: EventLog & { removed: true }; connected: number; data: EventLog; error: Error }>

  Parameters

  • eventName: K

  Returns Function[]

off

• off<K>(eventName: K, fn: Web3EventCallback<{ changed: EventLog & { removed: true }; connected: number; data: EventLog; error: Error }[K]>): void

• Inherited from Web3Subscription.off

  Type parameters

  • K: Web3EventKey<{ changed: EventLog & { removed: true }; connected: number; data: EventLog; error: Error }>

  Parameters

  • eventName: K

  • fn: Web3EventCallback<{ changed: EventLog & { removed: true }; connected: number; data: EventLog; error: Error }[K]>

  Returns void

on

• on<K>(eventName: K, fn: Web3EventCallback<{ changed: EventLog & { removed: true }; connected: number; data: EventLog; error: Error }[K]>): void

• Inherited from Web3Subscription.on

  Type parameters

  • K: Web3EventKey<{ changed: EventLog & { removed: true }; connected: number; data: EventLog; error: Error }>

  Parameters

  • eventName: K

  • fn: Web3EventCallback<{ changed: EventLog & { removed: true }; connected: number; data: EventLog; error: Error }[K]>

  Returns void

once

• once<K>(eventName: K, fn: Web3EventCallback<{ changed: EventLog & { removed: true }; connected: number; data: EventLog; error: Error }[K]>): void

• Inherited from Web3Subscription.once

  Type parameters

  • K: Web3EventKey<{ changed: EventLog & { removed: true }; connected: number; data: EventLog; error: Error }>

  Parameters

  • eventName: K

  • fn: Web3EventCallback<{ changed: EventLog & { removed: true }; connected: number; data: EventLog; error: Error }[K]>

  Returns void

removeAllListeners

• removeAllListeners(): EventEmitter

• Inherited from Web3Subscription.removeAllListeners

  Returns EventEmitter

resubscribe

• resubscribe(): Promise<void>

• Inherited from Web3Subscription.resubscribe

  Returns Promise<void>

setMaxListenerWarningThreshold

• setMaxListenerWarningThreshold(maxListenersWarningThreshold: number): void

• Inherited from Web3Subscription.setMaxListenerWarningThreshold

  Parameters

  • maxListenersWarningThreshold: number

  Returns void

subscribe

• subscribe(): Promise<void>

• Inherited from Web3Subscription.subscribe

  Returns Promise<void>

unsubscribe

• unsubscribe(): Promise<void>

• Inherited from Web3Subscription.unsubscribe

  Returns Promise<void>

ContractEventOptions

ContractEventOptions:

optionalfilter

filter?: Record<string, unknown>

optionalfromBlock

fromBlock?: BlockNumberOrTag

optionaltopics

topics?: string[]

ContractInitOptions

ContractInitOptions:

optionalreadonlydata

data?: Bytes

optionalreadonlyfrom

from?: string

optionalreadonlygas

gas?: string

optionalreadonlygasLimit

gasLimit?: string

optionalreadonlygasPrice

gasPrice?: string

optionalreadonlyprovider

provider?: string | SupportedProviders<EthExecutionAPI>

optionalreadonlysyncWithContext

syncWithContext?: boolean

ContractOptions

ContractOptions:

optionaladdress

address?: string

optionalreadonlydata

data?: Bytes

optionalreadonlyfrom

from?: string

optionalreadonlygas

gas?: string

optionalreadonlygasLimit

gasLimit?: string

optionalreadonlygasPrice

gasPrice?: string

jsonInterface

• get jsonInterface(): ContractAbiWithSignature
• set jsonInterface(value: ContractAbi): void

• Returns ContractAbiWithSignature

• Parameters

  • value: ContractAbi

  Returns void

EventLog

EventLog:

readonlyaddress

address: string

optionalreadonlyblockHash

blockHash?: string

optionalreadonlyblockNumber

blockNumber?: string | number | bigint

readonlydata

data: string

readonlyevent

event: string

optionalreadonlyid

id?: string

optionalreadonlylogIndex

logIndex?: string | number | bigint

optionalreadonlyraw

raw?: { data: string; topics: unknown[] }

Type declaration

• data: string

• topics: unknown[]

readonlyreturnValues

returnValues: Record<string, unknown>

optionalreadonlysignature

signature?: string

readonlytopics

topics: string[]

optionalreadonlytransactionHash

transactionHash?: string

optionalreadonlytransactionIndex

transactionIndex?: string | number | bigint

NonPayableCallOptions

NonPayableCallOptions:

optionalchainId

chainId?: string

optionaldata

data?: string

optionalfrom

from?: string

optionalgas

gas?: string

optionalgasPrice

gasPrice?: string

optionalmaxFeePerGas

maxFeePerGas?: string

optionalmaxPriorityFeePerGas

maxPriorityFeePerGas?: string

optionalnonce

nonce?: string

optionalto

to?: string

optionaltype

type?: string | number

NonPayableMethodObject

NonPayableMethodObject<Inputs, Outputs>:

Type parameters

• Inputs = unknown[]
• Outputs = unknown[]

arguments

arguments: Inputs

call

• call<SpecialOutput>(tx?: NonPayableCallOptions, block?: BlockNumberOrTag): Promise<SpecialOutput>

• Type parameters

  • SpecialOutput = Outputs

  Parameters

  • optionaltx: NonPayableCallOptions

  • optionalblock: BlockNumberOrTag

  Returns Promise<SpecialOutput>

createAccessList

• createAccessList(tx?: NonPayableCallOptions, block?: BlockNumberOrTag): Promise<AccessListResult>

• Parameters

  • optionaltx: NonPayableCallOptions

  • optionalblock: BlockNumberOrTag

  Returns Promise<AccessListResult>

encodeABI

• encodeABI(): string

• Returns string

estimateGas

• estimateGas<ReturnFormat>(options?: NonPayableCallOptions, returnFormat?: ReturnFormat): Promise<NumberTypes[ReturnFormat[number]]>

• Type parameters

  • ReturnFormat: DataFormat = { bytes: HEX; number: BIGINT }

  Parameters

  • optionaloptions: NonPayableCallOptions

  • optionalreturnFormat: ReturnFormat

  Returns Promise<NumberTypes[ReturnFormat[number]]>

send

• send(tx?: NonPayableCallOptions): Web3PromiEvent<{ blockHash: string; blockNumber: bigint; contractAddress?: string; cumulativeGasUsed: bigint; effectiveGasPrice?: bigint; from: string; gasUsed: bigint; logs: { readonly id?: string | undefined; readonly removed?: boolean | undefined; readonly logIndex?: bigint | undefined; readonly transactionIndex?: bigint | undefined; readonly transactionHash?: string | undefined; ... 4 more ...; readonly topics?: string[] | undefined; }[]; logsBloom: string; root: string; status: bigint; to: string; transactionHash: string; transactionIndex: bigint; type?: bigint }, SendTransactionEvents<{ bytes: HEX; number: BIGINT }>>

• Parameters

  • optionaltx: NonPayableCallOptions

  Returns Web3PromiEvent<{ blockHash: string; blockNumber: bigint; contractAddress?: string; cumulativeGasUsed: bigint; effectiveGasPrice?: bigint; from: string; gasUsed: bigint; logs: { readonly id?: string | undefined; readonly removed?: boolean | undefined; readonly logIndex?: bigint | undefined; readonly transactionIndex?: bigint | undefined; readonly transactionHash?: string | undefined; ... 4 more ...; readonly topics?: string[] | undefined; }[]; logsBloom: string; root: string; status: bigint; to: string; transactionHash: string; transactionIndex: bigint; type?: bigint }, SendTransactionEvents<{ bytes: HEX; number: BIGINT }>>

PayableCallOptions

PayableCallOptions:

optionalchainId

chainId?: string

Inherited from NonPayableCallOptions.chainId

optionaldata

data?: string

Inherited from NonPayableCallOptions.data

optionalfrom

from?: string

Inherited from NonPayableCallOptions.from

optionalgas

gas?: string

Inherited from NonPayableCallOptions.gas

optionalgasPrice

gasPrice?: string

Inherited from NonPayableCallOptions.gasPrice

optionalmaxFeePerGas

maxFeePerGas?: string

Inherited from NonPayableCallOptions.maxFeePerGas

optionalmaxPriorityFeePerGas

maxPriorityFeePerGas?: string

Inherited from NonPayableCallOptions.maxPriorityFeePerGas

optionalnonce

nonce?: string

Inherited from NonPayableCallOptions.nonce

optionalto

to?: string

Inherited from NonPayableCallOptions.to

optionaltype

type?: string | number

Inherited from NonPayableCallOptions.type

optionalvalue

value?: string

PayableMethodObject

PayableMethodObject<Inputs, Outputs>:

Type parameters

• Inputs = unknown[]
• Outputs = unknown[]

arguments

arguments: Inputs

call

• call<SpecialOutput>(tx?: PayableCallOptions, block?: BlockNumberOrTag): Promise<SpecialOutput>

• Type parameters

  • SpecialOutput = Outputs

  Parameters

  • optionaltx: PayableCallOptions

  • optionalblock: BlockNumberOrTag

  Returns Promise<SpecialOutput>

createAccessList

• createAccessList(tx?: NonPayableCallOptions, block?: BlockNumberOrTag): Promise<AccessListResult>

• Parameters

  • optionaltx: NonPayableCallOptions

  • optionalblock: BlockNumberOrTag

  Returns Promise<AccessListResult>

encodeABI

• encodeABI(): string

• Returns string

estimateGas

• estimateGas<ReturnFormat>(options?: PayableCallOptions, returnFormat?: ReturnFormat): Promise<NumberTypes[ReturnFormat[number]]>

• Type parameters

  • ReturnFormat: DataFormat = { bytes: HEX; number: BIGINT }

  Parameters

  • optionaloptions: PayableCallOptions

  • optionalreturnFormat: ReturnFormat

  Returns Promise<NumberTypes[ReturnFormat[number]]>

send

• send(tx?: PayableCallOptions): Web3PromiEvent<{ blockHash: string; blockNumber: bigint; contractAddress?: string; cumulativeGasUsed: bigint; effectiveGasPrice?: bigint; from: string; gasUsed: bigint; logs: { readonly id?: string | undefined; readonly removed?: boolean | undefined; readonly logIndex?: bigint | undefined; readonly transactionIndex?: bigint | undefined; readonly transactionHash?: string | undefined; ... 4 more ...; readonly topics?: string[] | undefined; }[]; logsBloom: string; root: string; status: bigint; to: string; transactionHash: string; transactionIndex: bigint; type?: bigint }, SendTransactionEvents<{ bytes: HEX; number: BIGINT }>>

• Parameters

  • optionaltx: PayableCallOptions

  Returns Web3PromiEvent<{ blockHash: string; blockNumber: bigint; contractAddress?: string; cumulativeGasUsed: bigint; effectiveGasPrice?: bigint; from: string; gasUsed: bigint; logs: { readonly id?: string | undefined; readonly removed?: boolean | undefined; readonly logIndex?: bigint | undefined; readonly transactionIndex?: bigint | undefined; readonly transactionHash?: string | undefined; ... 4 more ...; readonly topics?: string[] | undefined; }[]; logsBloom: string; root: string; status: bigint; to: string; transactionHash: string; transactionIndex: bigint; type?: bigint }, SendTransactionEvents<{ bytes: HEX; number: BIGINT }>>

ContractAbiWithSignature

ContractAbiWithSignature: ReadonlyArray<AbiFragment & { signature: HexString }>

ContractBoundEvent

ContractBoundEvent: (options?: ContractEventOptions) => LogsSubscription

Type declaration

• • (options?: ContractEventOptions): LogsSubscription

  • Parameters

    • optionaloptions: ContractEventOptions

    Returns LogsSubscription

ContractEventEmitterInterface

ContractEventEmitterInterface<Abi>: { [ EventAbi in FilterAbis<Abi, AbiFunctionFragment & { type: event }> as EventAbi[name] ]: ContractEvent<EventAbi>[Inputs] }

Type parameters

• Abi: ContractAbi

ContractEventsInterface

ContractEventsInterface<Abi, Events>: { [ Name in keyof Events | allEvents ]: ContractBoundEvent } & {}

Type parameters

• Abi: ContractAbi
• Events: ContractEvents<Abi> = ContractEvents<Abi>

ContractMethodsInterface

ContractMethodsInterface<Abi>: { [ MethodAbi in FilterAbis<Abi, AbiFunctionFragment & { type: function }> as MethodAbi[name] ]: ContractBoundMethod<MethodAbi> } & {}

Type parameters

• Abi: ContractAbi

ContractOverloadedMethodInputs

ContractOverloadedMethodInputs<AbiArr>: NonNullable<AbiArr extends readonly [] ? undefined : AbiArr extends readonly [infer A, ...infer R] ? A extends AbiFunctionFragment ? ContractMethodInputParameters<A[inputs]> | ContractOverloadedMethodInputs<R> : undefined : undefined>

Type parameters

• AbiArr: ReadonlyArray<unknown>

ContractOverloadedMethodOutputs

ContractOverloadedMethodOutputs<AbiArr>: NonNullable<AbiArr extends readonly [] ? undefined : AbiArr extends readonly [infer A, ...infer R] ? A extends AbiFunctionFragment ? ContractMethodOutputParameters<A[outputs]> | ContractOverloadedMethodOutputs<R> : undefined : undefined>

Type parameters

• AbiArr: ReadonlyArray<unknown>

NonPayableTxOptions

NonPayableTxOptions: NonPayableCallOptions

PayableTxOptions

PayableTxOptions: PayableCallOptions

TransactionReceipt

TransactionReceipt: TransactionReceiptBase<Numbers, Bytes, Bytes, Log>

Web3ContractContext

Web3ContractContext: Partial<Web3ContextInitOptions<EthExecutionAPI, { logs: typeof LogsSubscription; newBlockHeaders: typeof NewHeadsSubscription; newHeads: typeof NewHeadsSubscription }>>

decodeErrorData

• decodeErrorData(errorsAbi: AbiErrorFragment[], error: Eip838ExecutionError): void

• Parameters

  • errorsAbi: AbiErrorFragment[]

  • error: Eip838ExecutionError

  Returns void

decodeEventABI

• decodeEventABI(event: AbiBaseFragment & { anonymous?: boolean; inputs?: readonly AbiParameter[]; name: string; type: string } & { signature: string }, data: LogsInput, jsonInterface: ContractAbiWithSignature, returnFormat?: DataFormat): EventLog

• Parameters

  • event: AbiBaseFragment & { anonymous?: boolean; inputs?: readonly AbiParameter[]; name: string; type: string } & { signature: string }

  • data: LogsInput

  • jsonInterface: ContractAbiWithSignature

  • optionalreturnFormat: DataFormat

  Returns EventLog

decodeMethodReturn

• decodeMethodReturn(abi: AbiFunctionFragment, returnValues?: string): unknown

• Parameters

  • abi: AbiFunctionFragment

  • optionalreturnValues: string

  Returns unknown

encodeEventABI

• encodeEventABI(__namedParameters: ContractOptions, event: AbiBaseFragment & { anonymous?: boolean; inputs?: readonly AbiParameter[]; name: string; type: string } & { signature: string }, options?: { filter?: Filter; fromBlock?: BlockNumberOrTag; toBlock?: BlockNumberOrTag; topics?: (null | string | string[])[] }, returnFormat?: DataFormat): { address?: string; filter: Filter; fromBlock?: Numbers; toBlock?: Numbers; topics?: (string | string[])[] }

• Parameters

  • __namedParameters: ContractOptions

  • event: AbiBaseFragment & { anonymous?: boolean; inputs?: readonly AbiParameter[]; name: string; type: string } & { signature: string }

  • optionaloptions: { filter?: Filter; fromBlock?: BlockNumberOrTag; toBlock?: BlockNumberOrTag; topics?: (null | string | string[])[] }

  • optionalreturnFormat: DataFormat

  Returns { address?: string; filter: Filter; fromBlock?: Numbers; toBlock?: Numbers; topics?: (string | string[])[] }

  • optionaladdress?: string

  • filter: Filter

  • optionalfromBlock?: Numbers

  • optionaltoBlock?: Numbers

  • optionaltopics?: (string | string[])[]

encodeMethodABI

• encodeMethodABI(abi: AbiFunctionFragment | AbiConstructorFragment, args: unknown[], deployData?: string): string

• Parameters

  • abi: AbiFunctionFragment | AbiConstructorFragment

  • args: unknown[]

  • optionaldeployData: string

  Returns string

ens

ens:

ENS

ENS:

constructor

• new ENS(registryAddr?: string, provider?: string | SupportedProviders<EthExecutionAPI & Web3NetAPI> | Web3ContextObject<EthExecutionAPI & Web3NetAPI, any>): ENS

• Overrides Web3Context.constructor

  Parameters

  • optionalregistryAddr: string

  • optionalprovider: string | SupportedProviders<EthExecutionAPI & Web3NetAPI> | Web3ContextObject<EthExecutionAPI & Web3NetAPI, any>

  Returns ENS

readonlyproviders

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

Inherited from Web3Context.providers

Type declaration

• HttpProvider: Web3BaseProviderConstructor

• IpcProvider: Web3BaseProviderConstructor

• WebsocketProvider: Web3BaseProviderConstructor

registryAddress

registryAddress: string

staticoptionalgivenProvider

givenProvider?: SupportedProviders<never>

Inherited from Web3Context.givenProvider

staticreadonlyproviders

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

Inherited from Web3Context.providers

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>

checkNetwork

• checkNetwork(): Promise<string>

• Returns Promise<string>

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

getAddress

• getAddress(ENSName: string, coinType?: number): Promise<MatchPrimitiveType<bytes, unknown>>

• Parameters

  • ENSName: string

  • optionalcoinType: number

  Returns Promise<MatchPrimitiveType<bytes, unknown>>

getConfig

• getConfig(): Web3ConfigOptions

• Inherited from Web3Context.getConfig

  Returns Web3ConfigOptions

getContenthash

• getContenthash(ENSName: string): Promise<MatchPrimitiveType<bytes, unknown>>

• Parameters

  • ENSName: string

  Returns Promise<MatchPrimitiveType<bytes, unknown>>

getContextObject

• getContextObject(): Web3ContextObject<EthExecutionAPI & Web3NetAPI, any>

• Inherited from Web3Context.getContextObject

  Returns Web3ContextObject<EthExecutionAPI & Web3NetAPI, any>

getMaxListeners

• getMaxListeners(): number

• Inherited from Web3Context.getMaxListeners

  Returns number

getOwner

• getOwner(name: string): Promise<unknown>

• Parameters

  • name: string

  Returns Promise<unknown>

getPubkey

• getPubkey(ENSName: string): Promise<unknown[] & Record<1, MatchPrimitiveType<bytes32, unknown>> & Record<0, MatchPrimitiveType<bytes32, unknown>> & [] & Record<x, MatchPrimitiveType<bytes32, unknown>> & Record<y, MatchPrimitiveType<bytes32, unknown>>>

• Parameters

  • ENSName: string

  Returns Promise<unknown[] & Record<1, MatchPrimitiveType<bytes32, unknown>> & Record<0, MatchPrimitiveType<bytes32, unknown>> & [] & Record<x, MatchPrimitiveType<bytes32, unknown>> & Record<y, MatchPrimitiveType<bytes32, unknown>>>

getResolver

• getResolver(name: string): Promise<Contract<readonly [{ inputs: readonly [{ internalType: contract ENS; name: _ens; type: address }, { internalType: contract INameWrapper; name: wrapperAddress; type: address }, { internalType: address; name: _trustedETHController; type: address }, { internalType: address; name: _trustedReverseRegistrar; type: address }]; stateMutability: nonpayable; type: constructor }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: bytes32; name: node; type: bytes32 }, { indexed: true; internalType: uint256; name: contentType; type: uint256 }]; name: ABIChanged; type: event }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: bytes32; name: node; type: bytes32 }, { indexed: false; internalType: address; name: a; type: address }]; name: AddrChanged; type: event }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: bytes32; name: node; type: bytes32 }, { indexed: false; internalType: uint256; name: coinType; type: uint256 }, { indexed: false; internalType: bytes; name: newAddress; type: bytes }]; name: AddressChanged; type: event }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: address; name: owner; type: address }, { indexed: true; internalType: address; name: operator; type: address }, { indexed: false; internalType: bool; name: approved; type: bool }]; name: ApprovalForAll; type: event }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: bytes32; name: node; type: bytes32 }, { indexed: false; internalType: bytes; name: hash; type: bytes }]; name: ContenthashChanged; type: event }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: bytes32; name: node; type: bytes32 }, { indexed: false; internalType: bytes; name: name; type: bytes }, { indexed: false; internalType: uint16; name: resource; type: uint16 }, { indexed: false; internalType: bytes; name: record; type: bytes }]; name: DNSRecordChanged; type: event }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: bytes32; name: node; type: bytes32 }, { indexed: false; internalType: bytes; name: name; type: bytes }, { indexed: false; internalType: uint16; name: resource; type: uint16 }]; name: DNSRecordDeleted; type: event }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: bytes32; name: node; type: bytes32 }]; name: DNSZoneCleared; type: event }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: bytes32; name: node; type: bytes32 }, { indexed: false; internalType: bytes; name: lastzonehash; type: bytes }, { indexed: false; internalType: bytes; name: zonehash; type: bytes }]; name: DNSZonehashChanged; type: event }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: bytes32; name: node; type: bytes32 }, { indexed: true; internalType: bytes4; name: interfaceID; type: bytes4 }, { indexed: false; internalType: address; name: implementer; type: address }]; name: InterfaceChanged; type: event }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: bytes32; name: node; type: bytes32 }, { indexed: false; internalType: string; name: name; type: string }]; name: NameChanged; type: event }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: bytes32; name: node; type: bytes32 }, { indexed: false; internalType: bytes32; name: x; type: bytes32 }, { indexed: false; internalType: bytes32; name: y; type: bytes32 }]; name: PubkeyChanged; type: event }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: bytes32; name: node; type: bytes32 }, { indexed: true; internalType: string; name: indexedKey; type: string }, { indexed: false; internalType: string; name: key; type: string }]; name: TextChanged; type: event }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }, { internalType: uint256; name: contentTypes; type: uint256 }]; name: ABI; outputs: readonly [{ internalType: uint256; name: ; type: uint256 }, { internalType: bytes; name: ; type: bytes }]; stateMutability: view; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }]; name: addr; outputs: readonly [{ internalType: address payable; name: ; type: address }]; stateMutability: view; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }, { internalType: uint256; name: coinType; type: uint256 }]; name: addr; outputs: readonly [{ internalType: bytes; name: ; type: bytes }]; stateMutability: view; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }]; name: clearDNSZone; outputs: readonly []; stateMutability: nonpayable; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }]; name: contenthash; outputs: readonly [{ internalType: bytes; name: ; type: bytes }]; stateMutability: view; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }, { internalType: bytes32; name: name; type: bytes32 }, { internalType: uint16; name: resource; type: uint16 }]; name: dnsRecord; outputs: readonly [{ internalType: bytes; name: ; type: bytes }]; stateMutability: view; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }, { internalType: bytes32; name: name; type: bytes32 }]; name: hasDNSRecords; outputs: readonly [{ internalType: bool; name: ; type: bool }]; stateMutability: view; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }, { internalType: bytes4; name: interfaceID; type: bytes4 }]; name: interfaceImplementer; outputs: readonly [{ internalType: address; name: ; type: address }]; stateMutability: view; type: function }, { inputs: readonly [{ internalType: address; name: account; type: address }, { internalType: address; name: operator; type: address }]; name: isApprovedForAll; outputs: readonly [{ internalType: bool; name: ; type: bool }]; stateMutability: view; type: function }, { inputs: readonly [{ internalType: bytes[]; name: data; type: bytes[] }]; name: multicall; outputs: readonly [{ internalType: bytes[]; name: results; type: bytes[] }]; stateMutability: nonpayable; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }]; name: name; outputs: readonly [{ internalType: string; name: ; type: string }]; stateMutability: view; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }]; name: pubkey; outputs: readonly [{ internalType: bytes32; name: x; type: bytes32 }, { internalType: bytes32; name: y; type: bytes32 }]; stateMutability: view; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }, { internalType: uint256; name: contentType; type: uint256 }, { internalType: bytes; name: data; type: bytes }]; name: setABI; outputs: readonly []; stateMutability: nonpayable; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }, { internalType: uint256; name: coinType; type: uint256 }, { internalType: bytes; name: a; type: bytes }]; name: setAddr; outputs: readonly []; stateMutability: nonpayable; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }, { internalType: address; name: a; type: address }]; name: setAddr; outputs: readonly []; stateMutability: nonpayable; type: function }, { inputs: readonly [{ internalType: address; name: operator; type: address }, { internalType: bool; name: approved; type: bool }]; name: setApprovalForAll; outputs: readonly []; stateMutability: nonpayable; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }, { internalType: bytes; name: hash; type: bytes }]; name: setContenthash; outputs: readonly []; stateMutability: nonpayable; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }, { internalType: bytes; name: data; type: bytes }]; name: setDNSRecords; outputs: readonly []; stateMutability: nonpayable; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }, { internalType: bytes4; name: interfaceID; type: bytes4 }, { internalType: address; name: implementer; type: address }]; name: setInterface; outputs: readonly []; stateMutability: nonpayable; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }, { internalType: string; name: newName; type: string }]; name: setName; outputs: readonly []; stateMutability: nonpayable; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }, { internalType: bytes32; name: x; type: bytes32 }, { internalType: bytes32; name: y; type: bytes32 }]; name: setPubkey; outputs: readonly []; stateMutability: nonpayable; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }, { internalType: string; name: key; type: string }, { internalType: string; name: value; type: string }]; name: setText; outputs: readonly []; stateMutability: nonpayable; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }, { internalType: bytes; name: hash; type: bytes }]; name: setZonehash; outputs: readonly []; stateMutability: nonpayable; type: function }, { inputs: readonly [{ internalType: bytes4; name: interfaceID; type: bytes4 }]; name: supportsInterface; outputs: readonly [{ internalType: bool; name: ; type: bool }]; stateMutability: view; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }, { internalType: string; name: key; type: string }]; name: text; outputs: readonly [{ internalType: string; name: ; type: string }]; stateMutability: view; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }]; name: zonehash; outputs: readonly [{ internalType: bytes; name: ; type: bytes }]; stateMutability: view; type: function }]>>

• Parameters

  • name: string

  Returns Promise<Contract<readonly [{ inputs: readonly [{ internalType: contract ENS; name: _ens; type: address }, { internalType: contract INameWrapper; name: wrapperAddress; type: address }, { internalType: address; name: _trustedETHController; type: address }, { internalType: address; name: _trustedReverseRegistrar; type: address }]; stateMutability: nonpayable; type: constructor }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: bytes32; name: node; type: bytes32 }, { indexed: true; internalType: uint256; name: contentType; type: uint256 }]; name: ABIChanged; type: event }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: bytes32; name: node; type: bytes32 }, { indexed: false; internalType: address; name: a; type: address }]; name: AddrChanged; type: event }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: bytes32; name: node; type: bytes32 }, { indexed: false; internalType: uint256; name: coinType; type: uint256 }, { indexed: false; internalType: bytes; name: newAddress; type: bytes }]; name: AddressChanged; type: event }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: address; name: owner; type: address }, { indexed: true; internalType: address; name: operator; type: address }, { indexed: false; internalType: bool; name: approved; type: bool }]; name: ApprovalForAll; type: event }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: bytes32; name: node; type: bytes32 }, { indexed: false; internalType: bytes; name: hash; type: bytes }]; name: ContenthashChanged; type: event }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: bytes32; name: node; type: bytes32 }, { indexed: false; internalType: bytes; name: name; type: bytes }, { indexed: false; internalType: uint16; name: resource; type: uint16 }, { indexed: false; internalType: bytes; name: record; type: bytes }]; name: DNSRecordChanged; type: event }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: bytes32; name: node; type: bytes32 }, { indexed: false; internalType: bytes; name: name; type: bytes }, { indexed: false; internalType: uint16; name: resource; type: uint16 }]; name: DNSRecordDeleted; type: event }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: bytes32; name: node; type: bytes32 }]; name: DNSZoneCleared; type: event }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: bytes32; name: node; type: bytes32 }, { indexed: false; internalType: bytes; name: lastzonehash; type: bytes }, { indexed: false; internalType: bytes; name: zonehash; type: bytes }]; name: DNSZonehashChanged; type: event }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: bytes32; name: node; type: bytes32 }, { indexed: true; internalType: bytes4; name: interfaceID; type: bytes4 }, { indexed: false; internalType: address; name: implementer; type: address }]; name: InterfaceChanged; type: event }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: bytes32; name: node; type: bytes32 }, { indexed: false; internalType: string; name: name; type: string }]; name: NameChanged; type: event }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: bytes32; name: node; type: bytes32 }, { indexed: false; internalType: bytes32; name: x; type: bytes32 }, { indexed: false; internalType: bytes32; name: y; type: bytes32 }]; name: PubkeyChanged; type: event }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: bytes32; name: node; type: bytes32 }, { indexed: true; internalType: string; name: indexedKey; type: string }, { indexed: false; internalType: string; name: key; type: string }]; name: TextChanged; type: event }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }, { internalType: uint256; name: contentTypes; type: uint256 }]; name: ABI; outputs: readonly [{ internalType: uint256; name: ; type: uint256 }, { internalType: bytes; name: ; type: bytes }]; stateMutability: view; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }]; name: addr; outputs: readonly [{ internalType: address payable; name: ; type: address }]; stateMutability: view; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }, { internalType: uint256; name: coinType; type: uint256 }]; name: addr; outputs: readonly [{ internalType: bytes; name: ; type: bytes }]; stateMutability: view; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }]; name: clearDNSZone; outputs: readonly []; stateMutability: nonpayable; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }]; name: contenthash; outputs: readonly [{ internalType: bytes; name: ; type: bytes }]; stateMutability: view; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }, { internalType: bytes32; name: name; type: bytes32 }, { internalType: uint16; name: resource; type: uint16 }]; name: dnsRecord; outputs: readonly [{ internalType: bytes; name: ; type: bytes }]; stateMutability: view; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }, { internalType: bytes32; name: name; type: bytes32 }]; name: hasDNSRecords; outputs: readonly [{ internalType: bool; name: ; type: bool }]; stateMutability: view; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }, { internalType: bytes4; name: interfaceID; type: bytes4 }]; name: interfaceImplementer; outputs: readonly [{ internalType: address; name: ; type: address }]; stateMutability: view; type: function }, { inputs: readonly [{ internalType: address; name: account; type: address }, { internalType: address; name: operator; type: address }]; name: isApprovedForAll; outputs: readonly [{ internalType: bool; name: ; type: bool }]; stateMutability: view; type: function }, { inputs: readonly [{ internalType: bytes[]; name: data; type: bytes[] }]; name: multicall; outputs: readonly [{ internalType: bytes[]; name: results; type: bytes[] }]; stateMutability: nonpayable; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }]; name: name; outputs: readonly [{ internalType: string; name: ; type: string }]; stateMutability: view; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }]; name: pubkey; outputs: readonly [{ internalType: bytes32; name: x; type: bytes32 }, { internalType: bytes32; name: y; type: bytes32 }]; stateMutability: view; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }, { internalType: uint256; name: contentType; type: uint256 }, { internalType: bytes; name: data; type: bytes }]; name: setABI; outputs: readonly []; stateMutability: nonpayable; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }, { internalType: uint256; name: coinType; type: uint256 }, { internalType: bytes; name: a; type: bytes }]; name: setAddr; outputs: readonly []; stateMutability: nonpayable; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }, { internalType: address; name: a; type: address }]; name: setAddr; outputs: readonly []; stateMutability: nonpayable; type: function }, { inputs: readonly [{ internalType: address; name: operator; type: address }, { internalType: bool; name: approved; type: bool }]; name: setApprovalForAll; outputs: readonly []; stateMutability: nonpayable; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }, { internalType: bytes; name: hash; type: bytes }]; name: setContenthash; outputs: readonly []; stateMutability: nonpayable; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }, { internalType: bytes; name: data; type: bytes }]; name: setDNSRecords; outputs: readonly []; stateMutability: nonpayable; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }, { internalType: bytes4; name: interfaceID; type: bytes4 }, { internalType: address; name: implementer; type: address }]; name: setInterface; outputs: readonly []; stateMutability: nonpayable; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }, { internalType: string; name: newName; type: string }]; name: setName; outputs: readonly []; stateMutability: nonpayable; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }, { internalType: bytes32; name: x; type: bytes32 }, { internalType: bytes32; name: y; type: bytes32 }]; name: setPubkey; outputs: readonly []; stateMutability: nonpayable; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }, { internalType: string; name: key; type: string }, { internalType: string; name: value; type: string }]; name: setText; outputs: readonly []; stateMutability: nonpayable; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }, { internalType: bytes; name: hash; type: bytes }]; name: setZonehash; outputs: readonly []; stateMutability: nonpayable; type: function }, { inputs: readonly [{ internalType: bytes4; name: interfaceID; type: bytes4 }]; name: supportsInterface; outputs: readonly [{ internalType: bool; name: ; type: bool }]; stateMutability: view; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }, { internalType: string; name: key; type: string }]; name: text; outputs: readonly [{ internalType: string; name: ; type: string }]; stateMutability: view; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }]; name: zonehash; outputs: readonly [{ internalType: bytes; name: ; type: bytes }]; stateMutability: view; type: function }]>>

getTTL

• getTTL(name: string): Promise<unknown>

• Parameters

  • name: string

  Returns Promise<unknown>

isApprovedForAll

• isApprovedForAll(owner: string, operator: string, returnFormat?: DataFormat): Promise<unknown>

• Parameters

  • owner: string

  • operator: string

  • optionalreturnFormat: DataFormat

  Returns Promise<unknown>

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

recordExists

• recordExists(name: string): Promise<unknown>

• Parameters

  • name: string

  Returns Promise<unknown>

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

setAddress

• setAddress(name: string, address: string, txConfig: NonPayableCallOptions, returnFormat?: DataFormat): Promise<TransactionReceipt | RevertInstructionError>

• Parameters

  • name: string

  • address: string

  • txConfig: NonPayableCallOptions

  • optionalreturnFormat: DataFormat

  Returns Promise<TransactionReceipt | RevertInstructionError>

setApprovalForAll

• setApprovalForAll(operator: string, approved: boolean, txConfig: NonPayableCallOptions): Promise<TransactionReceipt | RevertInstructionError>

• Parameters

  • operator: string

  • approved: boolean

  • txConfig: NonPayableCallOptions

  Returns Promise<TransactionReceipt | RevertInstructionError>

setConfig

• setConfig(options: Partial<Web3ConfigOptions>): void

• Inherited from Web3Context.setConfig

  Parameters

  • options: Partial<Web3ConfigOptions>

  Returns void

setContenthash

• setContenthash(name: string, hash: string, txConfig: NonPayableCallOptions): Promise<TransactionReceipt | RevertInstructionError>

• Parameters

  • name: string

  • hash: string

  • txConfig: NonPayableCallOptions

  Returns Promise<TransactionReceipt | RevertInstructionError>

setMaxListenerWarningThreshold

• setMaxListenerWarningThreshold(maxListenersWarningThreshold: number): void

• Inherited from Web3Context.setMaxListenerWarningThreshold

  Parameters

  • maxListenersWarningThreshold: number

  Returns void

setOwner

• setOwner(name: string, address: string, txConfig: NonPayableCallOptions, returnFormat?: DataFormat): Promise<TransactionReceipt | RevertInstructionError>

• Parameters

  • name: string

  • address: string

  • txConfig: NonPayableCallOptions

  • optionalreturnFormat: DataFormat

  Returns Promise<TransactionReceipt | RevertInstructionError>

setProvider

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

• Inherited from Web3Context.setProvider

  Parameters

  • optionalprovider: string | SupportedProviders<EthExecutionAPI & Web3NetAPI>

  Returns boolean

setPubkey

• setPubkey(name: string, x: string, y: string, txConfig: NonPayableCallOptions): Promise<TransactionReceipt | RevertInstructionError>

• Parameters

  • name: string

  • x: string

  • y: string

  • txConfig: NonPayableCallOptions

  Returns Promise<TransactionReceipt | RevertInstructionError>

setRecord

• setRecord(name: string, owner: string, resolver: string, ttl: number, txConfig: NonPayableCallOptions): Promise<TransactionReceipt | RevertInstructionError>

• Parameters

  • name: string

  • owner: string

  • resolver: string

  • ttl: number

  • txConfig: NonPayableCallOptions

  Returns Promise<TransactionReceipt | RevertInstructionError>

setResolver

• setResolver(name: string, address: string, txConfig: NonPayableCallOptions, returnFormat?: DataFormat): Promise<{ blockHash: string; blockNumber: bigint; contractAddress?: string; cumulativeGasUsed: bigint; effectiveGasPrice?: bigint; from: string; gasUsed: bigint; logs: { readonly id?: string | undefined; readonly removed?: boolean | undefined; readonly logIndex?: bigint | undefined; readonly transactionIndex?: bigint | undefined; readonly transactionHash?: string | undefined; ... 4 more ...; readonly topics?: string[] | undefined; }[]; logsBloom: string; root: string; status: bigint; to: string; transactionHash: string; transactionIndex: bigint; type?: bigint } | { code: bigint; innerError: undefined | { name: string; message: string; stack?: string | undefined; } | { name: string; message: string; stack?: string | undefined; }[]; name: string; reason: string; signature: string; stack: undefined | string; toJSON: any }>

• Parameters

  • name: string

  • address: string

  • txConfig: NonPayableCallOptions

  • optionalreturnFormat: DataFormat

  Returns Promise<{ blockHash: string; blockNumber: bigint; contractAddress?: string; cumulativeGasUsed: bigint; effectiveGasPrice?: bigint; from: string; gasUsed: bigint; logs: { readonly id?: string | undefined; readonly removed?: boolean | undefined; readonly logIndex?: bigint | undefined; readonly transactionIndex?: bigint | undefined; readonly transactionHash?: string | undefined; ... 4 more ...; readonly topics?: string[] | undefined; }[]; logsBloom: string; root: string; status: bigint; to: string; transactionHash: string; transactionIndex: bigint; type?: bigint } | { code: bigint; innerError: undefined | { name: string; message: string; stack?: string | undefined; } | { name: string; message: string; stack?: string | undefined; }[]; name: string; reason: string; signature: string; stack: undefined | string; toJSON: any }>

setSubnodeOwner

• setSubnodeOwner(node: string, label: string, address: string, txConfig: NonPayableCallOptions, returnFormat?: DataFormat): Promise<TransactionReceipt | RevertInstructionError>

• Parameters

  • node: string

  • label: string

  • address: string

  • txConfig: NonPayableCallOptions

  • optionalreturnFormat: DataFormat

  Returns Promise<TransactionReceipt | RevertInstructionError>

setSubnodeRecord

• setSubnodeRecord(name: string, label: string, owner: string, resolver: string, ttl: number, txConfig: NonPayableCallOptions, returnFormat?: DataFormat): Promise<TransactionReceipt | RevertInstructionError>

• Parameters

  • name: string

  • label: string

  • owner: string

  • resolver: string

  • ttl: number

  • txConfig: NonPayableCallOptions

  • optionalreturnFormat: DataFormat

  Returns Promise<TransactionReceipt | RevertInstructionError>

setTTL

• setTTL(name: string, ttl: number, txConfig: NonPayableCallOptions): Promise<TransactionReceipt | RevertInstructionError>

• Parameters

  • name: string

  • ttl: number

  • txConfig: NonPayableCallOptions

  Returns Promise<TransactionReceipt | RevertInstructionError>

supportsInterface

• supportsInterface(ENSName: string, interfaceId: string): Promise<MatchPrimitiveType<bool, unknown>>

• Parameters

  • ENSName: string

  • interfaceId: string

  Returns Promise<MatchPrimitiveType<bool, unknown>>

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

constregistryAddresses

registryAddresses: {}

Type declaration

• [T string]: string

iban

iban:

Iban

Re-exports Iban

default

Renames and re-exports Iban

IbanOptions

IbanOptions: { identifier: string; institution: string }

Type declaration

• identifier: string

• institution: string

personal

personal:

Personal

Re-exports Personal

default

Renames and re-exports Personal

Classes

LogsSubscription

LogsSubscription:

constructor

• new LogsSubscription(args: { address?: string | string[]; fromBlock?: BlockNumberOrTag; topics?: string[] }, options: { requestManager: Web3RequestManager<EthExecutionAPI>; returnFormat?: DataFormat }): LogsSubscription

• Inherited from Web3Subscription.constructor

  Parameters

  • args: { address?: string | string[]; fromBlock?: BlockNumberOrTag; topics?: string[] }

  • options: { requestManager: Web3RequestManager<EthExecutionAPI>; returnFormat?: DataFormat }

  Returns LogsSubscription

readonlyargs

args: { address?: string | string[]; fromBlock?: BlockNumberOrTag; topics?: string[] }

Inherited from Web3Subscription.args

Type declaration

• optionalreadonlyaddress?: string | string[]

• optionalreadonlyfromBlock?: BlockNumberOrTag

• optionalreadonlytopics?: string[]

id

• get id(): undefined | string

• Inherited from Web3Subscription.id

  Returns undefined | string

lastBlock

• get lastBlock(): undefined | BlockOutput

• Inherited from Web3Subscription.lastBlock

  Returns undefined | BlockOutput

_processSubscriptionError

• _processSubscriptionError(error: Error): void

• Overrides Web3Subscription._processSubscriptionError

  Parameters

  • error: Error

  Returns void

_processSubscriptionResult

• _processSubscriptionResult(data: LogsOutput): void

• Overrides Web3Subscription._processSubscriptionResult

  Parameters

  • data: LogsOutput

  Returns void

emit

• emit<K>(eventName: K, params: CommonSubscriptionEvents & { data: LogsOutput }[K]): void

• Inherited from Web3Subscription.emit

  Type parameters

  • K: Web3EventKey<CommonSubscriptionEvents & { data: LogsOutput }>

  Parameters

  • eventName: K

  • params: CommonSubscriptionEvents & { data: LogsOutput }[K]

  Returns void

eventNames

• eventNames(): (string | symbol)[]

• Inherited from Web3Subscription.eventNames

  Returns (string | symbol)[]

getMaxListeners

• getMaxListeners(): number

• Inherited from Web3Subscription.getMaxListeners

  Returns number

listenerCount

• listenerCount<K>(eventName: K): number

• Inherited from Web3Subscription.listenerCount

  Type parameters

  • K: Web3EventKey<CommonSubscriptionEvents & { data: LogsOutput }>

  Parameters

  • eventName: K

  Returns number

listeners

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

• Inherited from Web3Subscription.listeners

  Type parameters

  • K: Web3EventKey<CommonSubscriptionEvents & { data: LogsOutput }>

  Parameters

  • eventName: K

  Returns Function[]

off

• off<K>(eventName: K, fn: Web3EventCallback<CommonSubscriptionEvents & { data: LogsOutput }[K]>): void

• Inherited from Web3Subscription.off

  Type parameters

  • K: Web3EventKey<CommonSubscriptionEvents & { data: LogsOutput }>

  Parameters

  • eventName: K

  • fn: Web3EventCallback<CommonSubscriptionEvents & { data: LogsOutput }[K]>

  Returns void

on

• on<K>(eventName: K, fn: Web3EventCallback<CommonSubscriptionEvents & { data: LogsOutput }[K]>): void

• Inherited from Web3Subscription.on

  Type parameters

  • K: Web3EventKey<CommonSubscriptionEvents & { data: LogsOutput }>

  Parameters

  • eventName: K

  • fn: Web3EventCallback<CommonSubscriptionEvents & { data: LogsOutput }[K]>

  Returns void

once

• once<K>(eventName: K, fn: Web3EventCallback<CommonSubscriptionEvents & { data: LogsOutput }[K]>): void

• Inherited from Web3Subscription.once

  Type parameters

  • K: Web3EventKey<CommonSubscriptionEvents & { data: LogsOutput }>

  Parameters

  • eventName: K

  • fn: Web3EventCallback<CommonSubscriptionEvents & { data: LogsOutput }[K]>

  Returns void

removeAllListeners

• removeAllListeners(): EventEmitter

• Inherited from Web3Subscription.removeAllListeners

  Returns EventEmitter

resubscribe

• resubscribe(): Promise<void>

• Inherited from Web3Subscription.resubscribe

  Returns Promise<void>

setMaxListenerWarningThreshold

• setMaxListenerWarningThreshold(maxListenersWarningThreshold: number): void

• Inherited from Web3Subscription.setMaxListenerWarningThreshold

  Parameters

  • maxListenersWarningThreshold: number

  Returns void

subscribe

• subscribe(): Promise<void>

• Inherited from Web3Subscription.subscribe

  Returns Promise<void>

unsubscribe

• unsubscribe(): Promise<void>

• Inherited from Web3Subscription.unsubscribe

  Returns Promise<void>

NewHeadsSubscription

NewHeadsSubscription:

constructor

• new NewHeadsSubscription(args: any, options: { requestManager: Web3RequestManager<EthExecutionAPI>; returnFormat?: DataFormat }): NewHeadsSubscription

• Inherited from Web3Subscription.constructor

  Parameters

  • args: any

  • options: { requestManager: Web3RequestManager<EthExecutionAPI>; returnFormat?: DataFormat }

  Returns NewHeadsSubscription

readonlyargs

args: any

Inherited from Web3Subscription.args

id

• get id(): undefined | string

• Inherited from Web3Subscription.id

  Returns undefined | string

lastBlock

• get lastBlock(): undefined | BlockOutput

• Inherited from Web3Subscription.lastBlock

  Returns undefined | BlockOutput

emit

• emit<K>(eventName: K, params: CommonSubscriptionEvents & { data: BlockHeaderOutput }[K]): void

• Inherited from Web3Subscription.emit

  Type parameters

  • K: Web3EventKey<CommonSubscriptionEvents & { data: BlockHeaderOutput }>

  Parameters

  • eventName: K

  • params: CommonSubscriptionEvents & { data: BlockHeaderOutput }[K]

  Returns void

eventNames

• eventNames(): (string | symbol)[]

• Inherited from Web3Subscription.eventNames

  Returns (string | symbol)[]

getMaxListeners

• getMaxListeners(): number

• Inherited from Web3Subscription.getMaxListeners

  Returns number

listenerCount

• listenerCount<K>(eventName: K): number

• Inherited from Web3Subscription.listenerCount

  Type parameters

  • K: Web3EventKey<CommonSubscriptionEvents & { data: BlockHeaderOutput }>

  Parameters

  • eventName: K

  Returns number

listeners

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

• Inherited from Web3Subscription.listeners

  Type parameters

  • K: Web3EventKey<CommonSubscriptionEvents & { data: BlockHeaderOutput }>

  Parameters

  • eventName: K

  Returns Function[]

off

• off<K>(eventName: K, fn: Web3EventCallback<CommonSubscriptionEvents & { data: BlockHeaderOutput }[K]>): void

• Inherited from Web3Subscription.off

  Type parameters

  • K: Web3EventKey<CommonSubscriptionEvents & { data: BlockHeaderOutput }>

  Parameters

  • eventName: K

  • fn: Web3EventCallback<CommonSubscriptionEvents & { data: BlockHeaderOutput }[K]>

  Returns void

on

• on<K>(eventName: K, fn: Web3EventCallback<CommonSubscriptionEvents & { data: BlockHeaderOutput }[K]>): void

• Inherited from Web3Subscription.on

  Type parameters

  • K: Web3EventKey<CommonSubscriptionEvents & { data: BlockHeaderOutput }>

  Parameters

  • eventName: K

  • fn: Web3EventCallback<CommonSubscriptionEvents & { data: BlockHeaderOutput }[K]>

  Returns void

once

• once<K>(eventName: K, fn: Web3EventCallback<CommonSubscriptionEvents & { data: BlockHeaderOutput }[K]>): void

• Inherited from Web3Subscription.once

  Type parameters

  • K: Web3EventKey<CommonSubscriptionEvents & { data: BlockHeaderOutput }>

  Parameters

  • eventName: K

  • fn: Web3EventCallback<CommonSubscriptionEvents & { data: BlockHeaderOutput }[K]>

  Returns void

removeAllListeners

• removeAllListeners(): EventEmitter

• Inherited from Web3Subscription.removeAllListeners

  Returns EventEmitter

resubscribe

• resubscribe(): Promise<void>

• Inherited from Web3Subscription.resubscribe

  Returns Promise<void>

setMaxListenerWarningThreshold

• setMaxListenerWarningThreshold(maxListenersWarningThreshold: number): void

• Inherited from Web3Subscription.setMaxListenerWarningThreshold

  Parameters

  • maxListenersWarningThreshold: number

  Returns void

subscribe

• subscribe(): Promise<void>

• Inherited from Web3Subscription.subscribe

  Returns Promise<void>

unsubscribe

• unsubscribe(): Promise<void>

• Inherited from Web3Subscription.unsubscribe

  Returns Promise<void>

NewPendingTransactionsSubscription

NewPendingTransactionsSubscription:

constructor

• new NewPendingTransactionsSubscription(args: any, options: { requestManager: Web3RequestManager<EthExecutionAPI>; returnFormat?: DataFormat }): NewPendingTransactionsSubscription

• Inherited from Web3Subscription.constructor

  Parameters

  • args: any

  • options: { requestManager: Web3RequestManager<EthExecutionAPI>; returnFormat?: DataFormat }

  Returns NewPendingTransactionsSubscription

readonlyargs

args: any

Inherited from Web3Subscription.args

id

• get id(): undefined | string

• Inherited from Web3Subscription.id

  Returns undefined | string

lastBlock

• get lastBlock(): undefined | BlockOutput

• Inherited from Web3Subscription.lastBlock

  Returns undefined | BlockOutput

emit

• emit<K>(eventName: K, params: CommonSubscriptionEvents & { data: string }[K]): void

• Inherited from Web3Subscription.emit

  Type parameters

  • K: Web3EventKey<CommonSubscriptionEvents & { data: string }>

  Parameters

  • eventName: K

  • params: CommonSubscriptionEvents & { data: string }[K]

  Returns void

eventNames

• eventNames(): (string | symbol)[]

• Inherited from Web3Subscription.eventNames

  Returns (string | symbol)[]

getMaxListeners

• getMaxListeners(): number

• Inherited from Web3Subscription.getMaxListeners

  Returns number

listenerCount

• listenerCount<K>(eventName: K): number

• Inherited from Web3Subscription.listenerCount

  Type parameters

  • K: Web3EventKey<CommonSubscriptionEvents & { data: string }>

  Parameters

  • eventName: K

  Returns number

listeners

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

• Inherited from Web3Subscription.listeners

  Type parameters

  • K: Web3EventKey<CommonSubscriptionEvents & { data: string }>

  Parameters

  • eventName: K

  Returns Function[]

off

• off<K>(eventName: K, fn: Web3EventCallback<CommonSubscriptionEvents & { data: string }[K]>): void

• Inherited from Web3Subscription.off

  Type parameters

  • K: Web3EventKey<CommonSubscriptionEvents & { data: string }>

  Parameters

  • eventName: K

  • fn: Web3EventCallback<CommonSubscriptionEvents & { data: string }[K]>

  Returns void

on

• on<K>(eventName: K, fn: Web3EventCallback<CommonSubscriptionEvents & { data: string }[K]>): void

• Inherited from Web3Subscription.on

  Type parameters

  • K: Web3EventKey<CommonSubscriptionEvents & { data: string }>

  Parameters

  • eventName: K

  • fn: Web3EventCallback<CommonSubscriptionEvents & { data: string }[K]>

  Returns void

once

• once<K>(eventName: K, fn: Web3EventCallback<CommonSubscriptionEvents & { data: string }[K]>): void

• Inherited from Web3Subscription.once

  Type parameters

  • K: Web3EventKey<CommonSubscriptionEvents & { data: string }>

  Parameters

  • eventName: K

  • fn: Web3EventCallback<CommonSubscriptionEvents & { data: string }[K]>

  Returns void

removeAllListeners

• removeAllListeners(): EventEmitter

• Inherited from Web3Subscription.removeAllListeners

  Returns EventEmitter

resubscribe

• resubscribe(): Promise<void>

• Inherited from Web3Subscription.resubscribe

  Returns Promise<void>

setMaxListenerWarningThreshold

• setMaxListenerWarningThreshold(maxListenersWarningThreshold: number): void

• Inherited from Web3Subscription.setMaxListenerWarningThreshold

  Parameters

  • maxListenersWarningThreshold: number

  Returns void

subscribe

• subscribe(): Promise<void>

• Inherited from Web3Subscription.subscribe

  Returns Promise<void>

unsubscribe

• unsubscribe(): Promise<void>

• Inherited from Web3Subscription.unsubscribe

  Returns Promise<void>

SyncingSubscription

SyncingSubscription:

constructor

• new SyncingSubscription(args: any, options: { requestManager: Web3RequestManager<EthExecutionAPI>; returnFormat?: DataFormat }): SyncingSubscription

• Inherited from Web3Subscription.constructor

  Parameters

  • args: any

  • options: { requestManager: Web3RequestManager<EthExecutionAPI>; returnFormat?: DataFormat }

  Returns SyncingSubscription

readonlyargs

args: any

Inherited from Web3Subscription.args

id

• get id(): undefined | string

• Inherited from Web3Subscription.id

  Returns undefined | string

lastBlock

• get lastBlock(): undefined | BlockOutput

• Inherited from Web3Subscription.lastBlock

  Returns undefined | BlockOutput

emit

• emit<K>(eventName: K, params: CommonSubscriptionEvents & { changed: boolean; data: SyncOutput }[K]): void

• Inherited from Web3Subscription.emit

  Type parameters

  • K: Web3EventKey<CommonSubscriptionEvents & { changed: boolean; data: SyncOutput }>

  Parameters

  • eventName: K

  • params: CommonSubscriptionEvents & { changed: boolean; data: SyncOutput }[K]

  Returns void

eventNames

• eventNames(): (string | symbol)[]

• Inherited from Web3Subscription.eventNames

  Returns (string | symbol)[]

getMaxListeners

• getMaxListeners(): number

• Inherited from Web3Subscription.getMaxListeners

  Returns number

listenerCount

• listenerCount<K>(eventName: K): number

• Inherited from Web3Subscription.listenerCount

  Type parameters

  • K: Web3EventKey<CommonSubscriptionEvents & { changed: boolean; data: SyncOutput }>

  Parameters

  • eventName: K

  Returns number

listeners

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

• Inherited from Web3Subscription.listeners

  Type parameters

  • K: Web3EventKey<CommonSubscriptionEvents & { changed: boolean; data: SyncOutput }>

  Parameters

  • eventName: K

  Returns Function[]

off

• off<K>(eventName: K, fn: Web3EventCallback<CommonSubscriptionEvents & { changed: boolean; data: SyncOutput }[K]>): void

• Inherited from Web3Subscription.off

  Type parameters

  • K: Web3EventKey<CommonSubscriptionEvents & { changed: boolean; data: SyncOutput }>

  Parameters

  • eventName: K

  • fn: Web3EventCallback<CommonSubscriptionEvents & { changed: boolean; data: SyncOutput }[K]>

  Returns void

on

• on<K>(eventName: K, fn: Web3EventCallback<CommonSubscriptionEvents & { changed: boolean; data: SyncOutput }[K]>): void

• Inherited from Web3Subscription.on

  Type parameters

  • K: Web3EventKey<CommonSubscriptionEvents & { changed: boolean; data: SyncOutput }>

  Parameters

  • eventName: K

  • fn: Web3EventCallback<CommonSubscriptionEvents & { changed: boolean; data: SyncOutput }[K]>

  Returns void

once

• once<K>(eventName: K, fn: Web3EventCallback<CommonSubscriptionEvents & { changed: boolean; data: SyncOutput }[K]>): void

• Inherited from Web3Subscription.once

  Type parameters

  • K: Web3EventKey<CommonSubscriptionEvents & { changed: boolean; data: SyncOutput }>

  Parameters

  • eventName: K

  • fn: Web3EventCallback<CommonSubscriptionEvents & { changed: boolean; data: SyncOutput }[K]>

  Returns void

removeAllListeners

• removeAllListeners(): EventEmitter

• Inherited from Web3Subscription.removeAllListeners

  Returns EventEmitter

resubscribe

• resubscribe(): Promise<void>

• Inherited from Web3Subscription.resubscribe

  Returns Promise<void>

setMaxListenerWarningThreshold

• setMaxListenerWarningThreshold(maxListenersWarningThreshold: number): void

• Inherited from Web3Subscription.setMaxListenerWarningThreshold

  Parameters

  • maxListenersWarningThreshold: number

  Returns void

subscribe

• subscribe(): Promise<void>

• Inherited from Web3Subscription.subscribe

  Returns Promise<void>

unsubscribe

• unsubscribe(): Promise<void>

• Inherited from Web3Subscription.unsubscribe

  Returns Promise<void>

Interfaces

SendSignedTransactionOptions

SendSignedTransactionOptions<ResolveType>:

Type parameters

• ResolveType = TransactionReceipt

optionaltransactionResolver

• transactionResolver(receipt: TransactionReceipt): ResolveType

• Parameters

  • receipt: TransactionReceipt

  Returns ResolveType

SendTransactionOptions

SendTransactionOptions<ResolveType>:

Type parameters

• ResolveType = TransactionReceipt

optionalignoreGasPricing

ignoreGasPricing?: boolean

optionaltransactionResolver

• transactionResolver(receipt: TransactionReceipt): ResolveType

• Parameters

  • receipt: TransactionReceipt

  Returns ResolveType

Type Aliases

InternalTransaction

InternalTransaction: FormatType<Transaction, typeof ETH_DATA_FORMAT>

SendSignedTransactionEvents

SendSignedTransactionEvents<ReturnFormat>: { confirmation: { confirmations: FormatType<Numbers, ReturnFormat>; latestBlockHash: FormatType<Bytes, ReturnFormat>; receipt: FormatType<TransactionReceipt, ReturnFormat> }; contractExecutionError: ContractExecutionError | ResponseError<any>; error: TransactionError<FormatType<TransactionReceipt, ReturnFormat>>; receipt: FormatType<TransactionReceipt, ReturnFormat>; sending: FormatType<Bytes, typeof ETH_DATA_FORMAT>; sent: FormatType<Bytes, typeof ETH_DATA_FORMAT>; transactionHash: FormatType<Bytes, ReturnFormat> }

Type parameters

• ReturnFormat: DataFormat

Type declaration

• confirmation: { confirmations: FormatType<Numbers, ReturnFormat>; latestBlockHash: FormatType<Bytes, ReturnFormat>; receipt: FormatType<TransactionReceipt, ReturnFormat> }

  • confirmations: FormatType<Numbers, ReturnFormat>

  • latestBlockHash: FormatType<Bytes, ReturnFormat>

  • receipt: FormatType<TransactionReceipt, ReturnFormat>

• contractExecutionError: ContractExecutionError | ResponseError<any>

• error: TransactionError<FormatType<TransactionReceipt, ReturnFormat>>

• receipt: FormatType<TransactionReceipt, ReturnFormat>

• sending: FormatType<Bytes, typeof ETH_DATA_FORMAT>

• sent: FormatType<Bytes, typeof ETH_DATA_FORMAT>

• transactionHash: FormatType<Bytes, ReturnFormat>

SendTransactionEvents

SendTransactionEvents<ReturnFormat>: { confirmation: { confirmations: FormatType<Numbers, ReturnFormat>; latestBlockHash: FormatType<Bytes, ReturnFormat>; receipt: FormatType<TransactionReceipt, ReturnFormat> }; contractExecutionError: ContractExecutionError | ResponseError<any>; error: TransactionError<FormatType<TransactionReceipt, ReturnFormat>>; receipt: FormatType<TransactionReceipt, ReturnFormat>; sending: FormatType<Transaction, typeof ETH_DATA_FORMAT>; sent: FormatType<Transaction, typeof ETH_DATA_FORMAT>; transactionHash: FormatType<Bytes, ReturnFormat> }

Type parameters

• ReturnFormat: DataFormat

Type declaration

• confirmation: { confirmations: FormatType<Numbers, ReturnFormat>; latestBlockHash: FormatType<Bytes, ReturnFormat>; receipt: FormatType<TransactionReceipt, ReturnFormat> }

  • confirmations: FormatType<Numbers, ReturnFormat>

  • latestBlockHash: FormatType<Bytes, ReturnFormat>

  • receipt: FormatType<TransactionReceipt, ReturnFormat>

• contractExecutionError: ContractExecutionError | ResponseError<any>

• error: TransactionError<FormatType<TransactionReceipt, ReturnFormat>>

• receipt: FormatType<TransactionReceipt, ReturnFormat>

• sending: FormatType<Transaction, typeof ETH_DATA_FORMAT>

• sent: FormatType<Transaction, typeof ETH_DATA_FORMAT>

• transactionHash: FormatType<Bytes, ReturnFormat>

Variables

constaccessListItemSchema

accessListItemSchema: { properties: { address: { eth: string }; storageKeys: { items: { eth: string }; type: string } }; type: string }

Type declaration

• properties: { address: { eth: string }; storageKeys: { items: { eth: string }; type: string } }

  • address: { eth: string }

    • eth: string

  • storageKeys: { items: { eth: string }; type: string }

    • items: { eth: string }

      • eth: string

    • type: string

• type: string

constaccessListResultSchema

accessListResultSchema: { properties: { accessList: { items: { properties: { address: { eth: string }; storageKeys: { items: { eth: string }; type: string } }; type: string }; type: string }; gasUsed: { type: string } }; type: string }

Type declaration

• properties: { accessList: { items: { properties: { address: { eth: string }; storageKeys: { items: { eth: string }; type: string } }; type: string }; type: string }; gasUsed: { type: string } }

  • accessList: { items: { properties: { address: { eth: string }; storageKeys: { items: { eth: string }; type: string } }; type: string }; type: string }

    • items: { properties: { address: { eth: string }; storageKeys: { items: { eth: string }; type: string } }; type: string }

      • properties: { address: { eth: string }; storageKeys: { items: { eth: string }; type: string } }

        • address: { eth: string }

          • eth: string

        • storageKeys: { items: { eth: string }; type: string }

          • items: { eth: string }

            • eth: string

          • type: string

      • type: string

    • type: string

  • gasUsed: { type: string }

    • type: string

• type: string

constaccessListSchema

accessListSchema: { items: { properties: { address: { eth: string }; storageKeys: { items: { eth: string }; type: string } }; type: string }; type: string }

Type declaration

• items: { properties: { address: { eth: string }; storageKeys: { items: { eth: string }; type: string } }; type: string }

  • properties: { address: { eth: string }; storageKeys: { items: { eth: string }; type: string } }

    • address: { eth: string }

      • eth: string

    • storageKeys: { items: { eth: string }; type: string }

      • items: { eth: string }

        • eth: string

      • type: string

  • type: string

• type: string

constaccountSchema

accountSchema: { properties: { accountProof: { items: { eth: string }; type: string }; balance: { eth: string }; codeHash: { eth: string }; nonce: { eth: string }; storageHash: { eth: string }; storageProof: { items: { properties: { key: { eth: string }; proof: { items: { eth: string }; type: string }; value: { eth: string } }; type: string }; type: string } }; type: string }

Type declaration

• properties: { accountProof: { items: { eth: string }; type: string }; balance: { eth: string }; codeHash: { eth: string }; nonce: { eth: string }; storageHash: { eth: string }; storageProof: { items: { properties: { key: { eth: string }; proof: { items: { eth: string }; type: string }; value: { eth: string } }; type: string }; type: string } }

  • accountProof: { items: { eth: string }; type: string }

    • items: { eth: string }

      • eth: string

    • type: string

  • balance: { eth: string }

    • eth: string

  • codeHash: { eth: string }

    • eth: string

  • nonce: { eth: string }

    • eth: string

  • storageHash: { eth: string }

    • eth: string

  • storageProof: { items: { properties: { key: { eth: string }; proof: { items: { eth: string }; type: string }; value: { eth: string } }; type: string }; type: string }

    • items: { properties: { key: { eth: string }; proof: { items: { eth: string }; type: string }; value: { eth: string } }; type: string }

      • properties: { key: { eth: string }; proof: { items: { eth: string }; type: string }; value: { eth: string } }

        • key: { eth: string }

          • eth: string

        • proof: { items: { eth: string }; type: string }

          • items: { eth: string }

            • eth: string

          • type: string

        • value: { eth: string }

          • eth: string

      • type: string

    • type: string

• type: string

constblockHeaderSchema

blockHeaderSchema: { properties: { difficulty: { eth: string }; extraData: { eth: string }; gasLimit: { eth: string }; gasUsed: { eth: string }; logsBloom: { eth: string }; miner: { eth: string }; nonce: { eth: string }; number: { eth: string }; parentHash: { eth: string }; receiptRoot: { eth: string }; sha3Uncles: { eth: string }; stateRoot: { eth: string }; timestamp: { eth: string }; transactionsRoot: { eth: string } }; type: string }

Type declaration

• properties: { difficulty: { eth: string }; extraData: { eth: string }; gasLimit: { eth: string }; gasUsed: { eth: string }; logsBloom: { eth: string }; miner: { eth: string }; nonce: { eth: string }; number: { eth: string }; parentHash: { eth: string }; receiptRoot: { eth: string }; sha3Uncles: { eth: string }; stateRoot: { eth: string }; timestamp: { eth: string }; transactionsRoot: { eth: string } }

  • difficulty: { eth: string }

    • eth: string

  • extraData: { eth: string }

    • eth: string

  • gasLimit: { eth: string }

    • eth: string

  • gasUsed: { eth: string }

    • eth: string

  • logsBloom: { eth: string }

    • eth: string

  • miner: { eth: string }

    • eth: string

  • nonce: { eth: string }

    • eth: string

  • number: { eth: string }

    • eth: string

  • parentHash: { eth: string }

    • eth: string

  • receiptRoot: { eth: string }

    • eth: string

  • sha3Uncles: { eth: string }

    • eth: string

  • stateRoot: { eth: string }

    • eth: string

  • timestamp: { eth: string }

    • eth: string

  • transactionsRoot: { eth: string }

    • eth: string

• type: string

constblockSchema

blockSchema: { properties: { baseFeePerGas: { eth: string }; difficulty: { eth: string }; extraData: { eth: string }; gasLimit: { eth: string }; gasUsed: { eth: string }; hash: { eth: string }; logsBloom: { eth: string }; miner: { eth: string }; mixHash: { eth: string }; nonce: { eth: string }; number: { eth: string }; parentHash: { eth: string }; receiptsRoot: { eth: string }; sha3Uncles: { eth: string }; size: { eth: string }; stateRoot: { eth: string }; timestamp: { eth: string }; totalDifficulty: { eth: string }; transactions: { oneOf: ({ items: { eth?: undefined; properties: { accessList: { items: { properties: { address: { eth: string }; storageKeys: { items: { eth: string }; type: string } }; type: string }; type: string }; blockHash: { eth: string }; blockNumber: { eth: string }; chain: { enum: string[]; type: string }; chainId: { eth: string }; common: { properties: { baseChain: { enum: string[]; type: string }; customChain: { properties: { chainId: { eth: string }; name: { eth: string }; networkId: { eth: string } }; type: string }; hardfork: { enum: string[]; type: string } }; type: string }; data: { eth: string }; effectiveGasPrice: { eth: string }; from: { eth: string }; gas: { eth: string }; gasLimit: { eth: string }; gasPrice: { eth: string }; hardfork: { enum: string[]; type: string }; hash: { eth: string }; input: { eth: string }; maxFeePerGas: { eth: string }; maxPriorityFeePerGas: { eth: string }; networkId: { eth: string }; nonce: { eth: string }; r: { eth: string }; s: { eth: string }; to: { oneOf: ({ eth: string; type?: undefined } | { eth?: undefined; type: string })[] }; transactionIndex: { eth: string }; type: { eth: string }; v: { eth: string }; value: { eth: string } }; type: string }; type: string } | { items: { eth: string }; type: string })[] }; transactionsRoot: { eth: string }; uncles: { items: { eth: string }; type: string } }; type: string }

Type declaration

• properties: { baseFeePerGas: { eth: string }; difficulty: { eth: string }; extraData: { eth: string }; gasLimit: { eth: string }; gasUsed: { eth: string }; hash: { eth: string }; logsBloom: { eth: string }; miner: { eth: string }; mixHash: { eth: string }; nonce: { eth: string }; number: { eth: string }; parentHash: { eth: string }; receiptsRoot: { eth: string }; sha3Uncles: { eth: string }; size: { eth: string }; stateRoot: { eth: string }; timestamp: { eth: string }; totalDifficulty: { eth: string }; transactions: { oneOf: ({ items: { eth?: undefined; properties: { accessList: { items: { properties: { address: { eth: string }; storageKeys: { items: { eth: string }; type: string } }; type: string }; type: string }; blockHash: { eth: string }; blockNumber: { eth: string }; chain: { enum: string[]; type: string }; chainId: { eth: string }; common: { properties: { baseChain: { enum: string[]; type: string }; customChain: { properties: { chainId: { eth: string }; name: { eth: string }; networkId: { eth: string } }; type: string }; hardfork: { enum: string[]; type: string } }; type: string }; data: { eth: string }; effectiveGasPrice: { eth: string }; from: { eth: string }; gas: { eth: string }; gasLimit: { eth: string }; gasPrice: { eth: string }; hardfork: { enum: string[]; type: string }; hash: { eth: string }; input: { eth: string }; maxFeePerGas: { eth: string }; maxPriorityFeePerGas: { eth: string }; networkId: { eth: string }; nonce: { eth: string }; r: { eth: string }; s: { eth: string }; to: { oneOf: ({ eth: string; type?: undefined } | { eth?: undefined; type: string })[] }; transactionIndex: { eth: string }; type: { eth: string }; v: { eth: string }; value: { eth: string } }; type: string }; type: string } | { items: { eth: string }; type: string })[] }; transactionsRoot: { eth: string }; uncles: { items: { eth: string }; type: string } }

  • baseFeePerGas: { eth: string }

    • eth: string

  • difficulty: { eth: string }

    • eth: string

  • extraData: { eth: string }

    • eth: string

  • gasLimit: { eth: string }

    • eth: string

  • gasUsed: { eth: string }

    • eth: string

  • hash: { eth: string }

    • eth: string

  • logsBloom: { eth: string }

    • eth: string

  • miner: { eth: string }

    • eth: string

  • mixHash: { eth: string }

    • eth: string

  • nonce: { eth: string }

    • eth: string

  • number: { eth: string }

    • eth: string

  • parentHash: { eth: string }

    • eth: string

  • receiptsRoot: { eth: string }

    • eth: string

  • sha3Uncles: { eth: string }

    • eth: string

  • size: { eth: string }

    • eth: string

  • stateRoot: { eth: string }

    • eth: string

  • timestamp: { eth: string }

    • eth: string

  • totalDifficulty: { eth: string }

    • eth: string

  • transactions: { oneOf: ({ items: { eth?: undefined; properties: { accessList: { items: { properties: { address: { eth: string }; storageKeys: { items: { eth: string }; type: string } }; type: string }; type: string }; blockHash: { eth: string }; blockNumber: { eth: string }; chain: { enum: string[]; type: string }; chainId: { eth: string }; common: { properties: { baseChain: { enum: string[]; type: string }; customChain: { properties: { chainId: { eth: string }; name: { eth: string }; networkId: { eth: string } }; type: string }; hardfork: { enum: string[]; type: string } }; type: string }; data: { eth: string }; effectiveGasPrice: { eth: string }; from: { eth: string }; gas: { eth: string }; gasLimit: { eth: string }; gasPrice: { eth: string }; hardfork: { enum: string[]; type: string }; hash: { eth: string }; input: { eth: string }; maxFeePerGas: { eth: string }; maxPriorityFeePerGas: { eth: string }; networkId: { eth: string }; nonce: { eth: string }; r: { eth: string }; s: { eth: string }; to: { oneOf: ({ eth: string; type?: undefined } | { eth?: undefined; type: string })[] }; transactionIndex: { eth: string }; type: { eth: string }; v: { eth: string }; value: { eth: string } }; type: string }; type: string } | { items: { eth: string }; type: string })[] }

    • oneOf: ({ items: { eth?: undefined; properties: { accessList: { items: { properties: { address: { eth: string }; storageKeys: { items: { eth: string }; type: string } }; type: string }; type: string }; blockHash: { eth: string }; blockNumber: { eth: string }; chain: { enum: string[]; type: string }; chainId: { eth: string }; common: { properties: { baseChain: { enum: string[]; type: string }; customChain: { properties: { chainId: { eth: string }; name: { eth: string }; networkId: { eth: string } }; type: string }; hardfork: { enum: string[]; type: string } }; type: string }; data: { eth: string }; effectiveGasPrice: { eth: string }; from: { eth: string }; gas: { eth: string }; gasLimit: { eth: string }; gasPrice: { eth: string }; hardfork: { enum: string[]; type: string }; hash: { eth: string }; input: { eth: string }; maxFeePerGas: { eth: string }; maxPriorityFeePerGas: { eth: string }; networkId: { eth: string }; nonce: { eth: string }; r: { eth: string }; s: { eth: string }; to: { oneOf: ({ eth: string; type?: undefined } | { eth?: undefined; type: string })[] }; transactionIndex: { eth: string }; type: { eth: string }; v: { eth: string }; value: { eth: string } }; type: string }; type: string } | { items: { eth: string }; type: string })[]

  • transactionsRoot: { eth: string }

    • eth: string

  • uncles: { items: { eth: string }; type: string }

    • items: { eth: string }

      • eth: string

    • type: string

• type: string

constchainSchema

chainSchema: { enum: string[]; type: string }

Type declaration

• enum: string[]

• type: string

constcustomChainSchema

customChainSchema: { properties: { chainId: { eth: string }; name: { eth: string }; networkId: { eth: string } }; type: string }

Type declaration

• properties: { chainId: { eth: string }; name: { eth: string }; networkId: { eth: string } }

  • chainId: { eth: string }

    • eth: string

  • name: { eth: string }

    • eth: string

  • networkId: { eth: string }

    • eth: string

• type: string

constfeeHistorySchema

feeHistorySchema: { properties: { baseFeePerGas: { items: { eth: string }; type: string }; gasUsedRatio: { items: { type: string }; type: string }; oldestBlock: { eth: string }; reward: { items: { items: { eth: string }; type: string }; type: string } }; type: string }

Type declaration

• properties: { baseFeePerGas: { items: { eth: string }; type: string }; gasUsedRatio: { items: { type: string }; type: string }; oldestBlock: { eth: string }; reward: { items: { items: { eth: string }; type: string }; type: string } }

  • baseFeePerGas: { items: { eth: string }; type: string }

    • items: { eth: string }

      • eth: string

    • type: string

  • gasUsedRatio: { items: { type: string }; type: string }

    • items: { type: string }

      • type: string

    • type: string

  • oldestBlock: { eth: string }

    • eth: string

  • reward: { items: { items: { eth: string }; type: string }; type: string }

    • items: { items: { eth: string }; type: string }

      • items: { eth: string }

        • eth: string

      • type: string

    • type: string

• type: string

consthardforkSchema

hardforkSchema: { enum: string[]; type: string }

Type declaration

• enum: string[]

• type: string

constlogSchema

logSchema: { properties: { address: { eth: string }; blockHash: { eth: string }; blockNumber: { eth: string }; data: { eth: string }; logIndex: { eth: string }; removed: { eth: string }; topics: { items: { eth: string }; type: string }; transactionHash: { eth: string }; transactionIndex: { eth: string } }; type: string }

Type declaration

• properties: { address: { eth: string }; blockHash: { eth: string }; blockNumber: { eth: string }; data: { eth: string }; logIndex: { eth: string }; removed: { eth: string }; topics: { items: { eth: string }; type: string }; transactionHash: { eth: string }; transactionIndex: { eth: string } }

  • address: { eth: string }

    • eth: string

  • blockHash: { eth: string }

    • eth: string

  • blockNumber: { eth: string }

    • eth: string

  • data: { eth: string }

    • eth: string

  • logIndex: { eth: string }

    • eth: string

  • removed: { eth: string }

    • eth: string

  • topics: { items: { eth: string }; type: string }

    • items: { eth: string }

      • eth: string

    • type: string

  • transactionHash: { eth: string }

    • eth: string

  • transactionIndex: { eth: string }

    • eth: string

• type: string

constregisteredSubscriptions

registeredSubscriptions: { logs: typeof LogsSubscription; newBlockHeaders: typeof NewHeadsSubscription; newHeads: typeof NewHeadsSubscription; newPendingTransactions: typeof NewPendingTransactionsSubscription; pendingTransactions: typeof NewPendingTransactionsSubscription; syncing: typeof SyncingSubscription }

Type declaration

• logs: typeof LogsSubscription

• newBlockHeaders: typeof NewHeadsSubscription

• newHeads: typeof NewHeadsSubscription

• newPendingTransactions: typeof NewPendingTransactionsSubscription

• pendingTransactions: typeof NewPendingTransactionsSubscription

• syncing: typeof SyncingSubscription

conststorageProofSchema

storageProofSchema: { properties: { key: { eth: string }; proof: { items: { eth: string }; type: string }; value: { eth: string } }; type: string }

Type declaration

• properties: { key: { eth: string }; proof: { items: { eth: string }; type: string }; value: { eth: string } }

  • key: { eth: string }

    • eth: string

  • proof: { items: { eth: string }; type: string }

    • items: { eth: string }

      • eth: string

    • type: string

  • value: { eth: string }

    • eth: string

• type: string

constsyncSchema

syncSchema: { properties: { currentBlock: { eth: string }; highestBlock: { eth: string }; knownStates: { eth: string }; pulledStates: { eth: string }; startingBlock: { eth: string } }; type: string }

Type declaration

• properties: { currentBlock: { eth: string }; highestBlock: { eth: string }; knownStates: { eth: string }; pulledStates: { eth: string }; startingBlock: { eth: string } }

  • currentBlock: { eth: string }

    • eth: string

  • highestBlock: { eth: string }

    • eth: string

  • knownStates: { eth: string }

    • eth: string

  • pulledStates: { eth: string }

    • eth: string

  • startingBlock: { eth: string }

    • eth: string

• type: string

consttransactionInfoSchema

transactionInfoSchema: { properties: { accessList: { items: { properties: { address: { eth: string }; storageKeys: { items: { eth: string }; type: string } }; type: string }; type: string }; blockHash: { eth: string }; blockNumber: { eth: string }; chain: { enum: string[]; type: string }; chainId: { eth: string }; common: { properties: { baseChain: { enum: string[]; type: string }; customChain: { properties: { chainId: { eth: string }; name: { eth: string }; networkId: { eth: string } }; type: string }; hardfork: { enum: string[]; type: string } }; type: string }; data: { eth: string }; effectiveGasPrice: { eth: string }; from: { eth: string }; gas: { eth: string }; gasLimit: { eth: string }; gasPrice: { eth: string }; hardfork: { enum: string[]; type: string }; hash: { eth: string }; input: { eth: string }; maxFeePerGas: { eth: string }; maxPriorityFeePerGas: { eth: string }; networkId: { eth: string }; nonce: { eth: string }; r: { eth: string }; s: { eth: string }; to: { oneOf: ({ eth: string; type?: undefined } | { eth?: undefined; type: string })[] }; transactionIndex: { eth: string }; type: { eth: string }; v: { eth: string }; value: { eth: string } }; type: string }

Type declaration

• properties: { accessList: { items: { properties: { address: { eth: string }; storageKeys: { items: { eth: string }; type: string } }; type: string }; type: string }; blockHash: { eth: string }; blockNumber: { eth: string }; chain: { enum: string[]; type: string }; chainId: { eth: string }; common: { properties: { baseChain: { enum: string[]; type: string }; customChain: { properties: { chainId: { eth: string }; name: { eth: string }; networkId: { eth: string } }; type: string }; hardfork: { enum: string[]; type: string } }; type: string }; data: { eth: string }; effectiveGasPrice: { eth: string }; from: { eth: string }; gas: { eth: string }; gasLimit: { eth: string }; gasPrice: { eth: string }; hardfork: { enum: string[]; type: string }; hash: { eth: string }; input: { eth: string }; maxFeePerGas: { eth: string }; maxPriorityFeePerGas: { eth: string }; networkId: { eth: string }; nonce: { eth: string }; r: { eth: string }; s: { eth: string }; to: { oneOf: ({ eth: string; type?: undefined } | { eth?: undefined; type: string })[] }; transactionIndex: { eth: string }; type: { eth: string }; v: { eth: string }; value: { eth: string } }

  • accessList: { items: { properties: { address: { eth: string }; storageKeys: { items: { eth: string }; type: string } }; type: string }; type: string }

    • items: { properties: { address: { eth: string }; storageKeys: { items: { eth: string }; type: string } }; type: string }

      • properties: { address: { eth: string }; storageKeys: { items: { eth: string }; type: string } }

        • address: { eth: string }

          • eth: string

        • storageKeys: { items: { eth: string }; type: string }

          • items: { eth: string }

            • eth: string

          • type: string

      • type: string

    • type: string

  • blockHash: { eth: string }

    • eth: string

  • blockNumber: { eth: string }

    • eth: string

  • chain: { enum: string[]; type: string }

    • enum: string[]

    • type: string

  • chainId: { eth: string }

    • eth: string

  • common: { properties: { baseChain: { enum: string[]; type: string }; customChain: { properties: { chainId: { eth: string }; name: { eth: string }; networkId: { eth: string } }; type: string }; hardfork: { enum: string[]; type: string } }; type: string }

    • properties: { baseChain: { enum: string[]; type: string }; customChain: { properties: { chainId: { eth: string }; name: { eth: string }; networkId: { eth: string } }; type: string }; hardfork: { enum: string[]; type: string } }

      • baseChain: { enum: string[]; type: string }

        • enum: string[]

        • type: string

      • customChain: { properties: { chainId: { eth: string }; name: { eth: string }; networkId: { eth: string } }; type: string }

        • properties: { chainId: { eth: string }; name: { eth: string }; networkId: { eth: string } }

          • chainId: { eth: string }

            • eth: string

          • name: { eth: string }

            • eth: string

          • networkId: { eth: string }

            • eth: string

        • type: string

      • hardfork: { enum: string[]; type: string }

        • enum: string[]

        • type: string

    • type: string

  • data: { eth: string }

    • eth: string

  • effectiveGasPrice: { eth: string }

    • eth: string

  • from: { eth: string }

    • eth: string

  • gas: { eth: string }

    • eth: string

  • gasLimit: { eth: string }

    • eth: string

  • gasPrice: { eth: string }

    • eth: string

  • hardfork: { enum: string[]; type: string }

    • enum: string[]

    • type: string

  • hash: { eth: string }

    • eth: string

  • input: { eth: string }

    • eth: string

  • maxFeePerGas: { eth: string }

    • eth: string

  • maxPriorityFeePerGas: { eth: string }

    • eth: string

  • networkId: { eth: string }

    • eth: string

  • nonce: { eth: string }

    • eth: string

  • r: { eth: string }

    • eth: string

  • s: { eth: string }

    • eth: string

  • to: { oneOf: ({ eth: string; type?: undefined } | { eth?: undefined; type: string })[] }

    • oneOf: ({ eth: string; type?: undefined } | { eth?: undefined; type: string })[]

  • transactionIndex: { eth: string }

    • eth: string

  • type: { eth: string }

    • eth: string

  • v: { eth: string }

    • eth: string

  • value: { eth: string }

    • eth: string

• type: string

consttransactionReceiptSchema

transactionReceiptSchema: { properties: { blockHash: { eth: string }; blockNumber: { eth: string }; contractAddress: { eth: string }; cumulativeGasUsed: { eth: string }; effectiveGasPrice: { eth: string }; from: { eth: string }; gasUsed: { eth: string }; logs: { items: { properties: { address: { eth: string }; blockHash: { eth: string }; blockNumber: { eth: string }; data: { eth: string }; logIndex: { eth: string }; removed: { eth: string }; topics: { items: { eth: string }; type: string }; transactionHash: { eth: string }; transactionIndex: { eth: string } }; type: string }; type: string }; logsBloom: { eth: string }; root: { eth: string }; status: { eth: string }; to: { eth: string }; transactionHash: { eth: string }; transactionIndex: { eth: string }; type: { eth: string } }; type: string }

Type declaration

• properties: { blockHash: { eth: string }; blockNumber: { eth: string }; contractAddress: { eth: string }; cumulativeGasUsed: { eth: string }; effectiveGasPrice: { eth: string }; from: { eth: string }; gasUsed: { eth: string }; logs: { items: { properties: { address: { eth: string }; blockHash: { eth: string }; blockNumber: { eth: string }; data: { eth: string }; logIndex: { eth: string }; removed: { eth: string }; topics: { items: { eth: string }; type: string }; transactionHash: { eth: string }; transactionIndex: { eth: string } }; type: string }; type: string }; logsBloom: { eth: string }; root: { eth: string }; status: { eth: string }; to: { eth: string }; transactionHash: { eth: string }; transactionIndex: { eth: string }; type: { eth: string } }

  • blockHash: { eth: string }

    • eth: string

  • blockNumber: { eth: string }

    • eth: string

  • contractAddress: { eth: string }

    • eth: string

  • cumulativeGasUsed: { eth: string }

    • eth: string

  • effectiveGasPrice: { eth: string }

    • eth: string

  • from: { eth: string }

    • eth: string

  • gasUsed: { eth: string }

    • eth: string

  • logs: { items: { properties: { address: { eth: string }; blockHash: { eth: string }; blockNumber: { eth: string }; data: { eth: string }; logIndex: { eth: string }; removed: { eth: string }; topics: { items: { eth: string }; type: string }; transactionHash: { eth: string }; transactionIndex: { eth: string } }; type: string }; type: string }

    • items: { properties: { address: { eth: string }; blockHash: { eth: string }; blockNumber: { eth: string }; data: { eth: string }; logIndex: { eth: string }; removed: { eth: string }; topics: { items: { eth: string }; type: string }; transactionHash: { eth: string }; transactionIndex: { eth: string } }; type: string }

      • properties: { address: { eth: string }; blockHash: { eth: string }; blockNumber: { eth: string }; data: { eth: string }; logIndex: { eth: string }; removed: { eth: string }; topics: { items: { eth: string }; type: string }; transactionHash: { eth: string }; transactionIndex: { eth: string } }

        • address: { eth: string }

          • eth: string

        • blockHash: { eth: string }

          • eth: string

        • blockNumber: { eth: string }

          • eth: string

        • data: { eth: string }

          • eth: string

        • logIndex: { eth: string }

          • eth: string

        • removed: { eth: string }

          • eth: string

        • topics: { items: { eth: string }; type: string }

          • items: { eth: string }

            • eth: string

          • type: string

        • transactionHash: { eth: string }

          • eth: string

        • transactionIndex: { eth: string }

          • eth: string

      • type: string

    • type: string

  • logsBloom: { eth: string }

    • eth: string

  • root: { eth: string }

    • eth: string

  • status: { eth: string }

    • eth: string

  • to: { eth: string }

    • eth: string

  • transactionHash: { eth: string }

    • eth: string

  • transactionIndex: { eth: string }

    • eth: string

  • type: { eth: string }

    • eth: string

• type: string

consttransactionSchema

transactionSchema: { properties: { accessList: { items: { properties: { address: { eth: string }; storageKeys: { items: { eth: string }; type: string } }; type: string }; type: string }; chain: { enum: string[]; type: string }; chainId: { eth: string }; common: { properties: { baseChain: { enum: string[]; type: string }; customChain: { properties: { chainId: { eth: string }; name: { eth: string }; networkId: { eth: string } }; type: string }; hardfork: { enum: string[]; type: string } }; type: string }; data: { eth: string }; effectiveGasPrice: { eth: string }; from: { eth: string }; gas: { eth: string }; gasLimit: { eth: string }; gasPrice: { eth: string }; hardfork: { enum: string[]; type: string }; input: { eth: string }; maxFeePerGas: { eth: string }; maxPriorityFeePerGas: { eth: string }; networkId: { eth: string }; nonce: { eth: string }; r: { eth: string }; s: { eth: string }; to: { oneOf: ({ eth: string; type?: undefined } | { eth?: undefined; type: string })[] }; type: { eth: string }; v: { eth: string }; value: { eth: string } }; type: string }

Type declaration

• properties: { accessList: { items: { properties: { address: { eth: string }; storageKeys: { items: { eth: string }; type: string } }; type: string }; type: string }; chain: { enum: string[]; type: string }; chainId: { eth: string }; common: { properties: { baseChain: { enum: string[]; type: string }; customChain: { properties: { chainId: { eth: string }; name: { eth: string }; networkId: { eth: string } }; type: string }; hardfork: { enum: string[]; type: string } }; type: string }; data: { eth: string }; effectiveGasPrice: { eth: string }; from: { eth: string }; gas: { eth: string }; gasLimit: { eth: string }; gasPrice: { eth: string }; hardfork: { enum: string[]; type: string }; input: { eth: string }; maxFeePerGas: { eth: string }; maxPriorityFeePerGas: { eth: string }; networkId: { eth: string }; nonce: { eth: string }; r: { eth: string }; s: { eth: string }; to: { oneOf: ({ eth: string; type?: undefined } | { eth?: undefined; type: string })[] }; type: { eth: string }; v: { eth: string }; value: { eth: string } }

  • accessList: { items: { properties: { address: { eth: string }; storageKeys: { items: { eth: string }; type: string } }; type: string }; type: string }

    • items: { properties: { address: { eth: string }; storageKeys: { items: { eth: string }; type: string } }; type: string }

      • properties: { address: { eth: string }; storageKeys: { items: { eth: string }; type: string } }

        • address: { eth: string }

          • eth: string

        • storageKeys: { items: { eth: string }; type: string }

          • items: { eth: string }

            • eth: string

          • type: string

      • type: string

    • type: string

  • chain: { enum: string[]; type: string }

    • enum: string[]

    • type: string

  • chainId: { eth: string }

    • eth: string

  • common: { properties: { baseChain: { enum: string[]; type: string }; customChain: { properties: { chainId: { eth: string }; name: { eth: string }; networkId: { eth: string } }; type: string }; hardfork: { enum: string[]; type: string } }; type: string }

    • properties: { baseChain: { enum: string[]; type: string }; customChain: { properties: { chainId: { eth: string }; name: { eth: string }; networkId: { eth: string } }; type: string }; hardfork: { enum: string[]; type: string } }

      • baseChain: { enum: string[]; type: string }

        • enum: string[]

        • type: string

      • customChain: { properties: { chainId: { eth: string }; name: { eth: string }; networkId: { eth: string } }; type: string }

        • properties: { chainId: { eth: string }; name: { eth: string }; networkId: { eth: string } }

          • chainId: { eth: string }

            • eth: string

          • name: { eth: string }

            • eth: string

          • networkId: { eth: string }

            • eth: string

        • type: string

      • hardfork: { enum: string[]; type: string }

        • enum: string[]

        • type: string

    • type: string

  • data: { eth: string }

    • eth: string

  • effectiveGasPrice: { eth: string }

    • eth: string

  • from: { eth: string }

    • eth: string

  • gas: { eth: string }

    • eth: string

  • gasLimit: { eth: string }

    • eth: string

  • gasPrice: { eth: string }

    • eth: string

  • hardfork: { enum: string[]; type: string }

    • enum: string[]

    • type: string

  • input: { eth: string }

    • eth: string

  • maxFeePerGas: { eth: string }

    • eth: string

  • maxPriorityFeePerGas: { eth: string }

    • eth: string

  • networkId: { eth: string }

    • eth: string

  • nonce: { eth: string }

    • eth: string

  • r: { eth: string }

    • eth: string

  • s: { eth: string }

    • eth: string

  • to: { oneOf: ({ eth: string; type?: undefined } | { eth?: undefined; type: string })[] }

    • oneOf: ({ eth: string; type?: undefined } | { eth?: undefined; type: string })[]

  • type: { eth: string }

    • eth: string

  • v: { eth: string }

    • eth: string

  • value: { eth: string }

    • eth: string

• type: string

Functions

call

• call<ReturnFormat>(web3Context: Web3Context<EthExecutionAPI, any>, transaction: TransactionCall, blockNumber: undefined | BlockNumberOrTag, returnFormat: ReturnFormat): Promise<string>

• Type parameters

  • ReturnFormat: DataFormat

  Parameters

  • web3Context: Web3Context<EthExecutionAPI, any>

  • transaction: TransactionCall

  • blockNumber: undefined | BlockNumberOrTag

  • returnFormat: ReturnFormat

  Returns Promise<string>

createAccessList

• createAccessList<ReturnFormat>(web3Context: Web3Context<EthExecutionAPI, any>, transaction: TransactionForAccessList, blockNumber: undefined | BlockNumberOrTag, returnFormat: ReturnFormat): Promise<{ accessList?: { address?: string; storageKeys?: string[] }[]; gasUsed?: NumberTypes[ReturnFormat[number]] }>

• Type parameters

  • ReturnFormat: DataFormat

  Parameters

  • web3Context: Web3Context<EthExecutionAPI, any>

  • transaction: TransactionForAccessList

  • blockNumber: undefined | BlockNumberOrTag

  • returnFormat: ReturnFormat

  Returns Promise<{ accessList?: { address?: string; storageKeys?: string[] }[]; gasUsed?: NumberTypes[ReturnFormat[number]] }>

detectTransactionType

• detectTransactionType(transaction: { accessList?: { readonly address?: string | undefined; readonly storageKeys?: string[] | undefined; }[]; chain?: ValidChains; chainId?: string; common?: { customChain: { name?: string | undefined; networkId: string; chainId: string; }; baseChain?: ValidChains | undefined; hardfork?: Hardfork | undefined; }; data?: string; from?: string; gas?: string; gasLimit?: string; gasPrice?: string; hardfork?: Hardfork; input?: string; maxFeePerGas?: string; maxPriorityFeePerGas?: string; networkId?: string; nonce?: string; r?: string; s?: string; to?: null | string; type?: string; v?: string; value?: string; yParity?: string }, web3Context?: Web3Context<EthExecutionAPI, any>): undefined | string

• Parameters

  • transaction: { accessList?: { readonly address?: string | undefined; readonly storageKeys?: string[] | undefined; }[]; chain?: ValidChains; chainId?: string; common?: { customChain: { name?: string | undefined; networkId: string; chainId: string; }; baseChain?: ValidChains | undefined; hardfork?: Hardfork | undefined; }; data?: string; from?: string; gas?: string; gasLimit?: string; gasPrice?: string; hardfork?: Hardfork; input?: string; maxFeePerGas?: string; maxPriorityFeePerGas?: string; networkId?: string; nonce?: string; r?: string; s?: string; to?: null | string; type?: string; v?: string; value?: string; yParity?: string }

  • optionalweb3Context: Web3Context<EthExecutionAPI, any>

  Returns undefined | string

estimateGas

• estimateGas<ReturnFormat>(web3Context: Web3Context<EthExecutionAPI, any>, transaction: Transaction, blockNumber: undefined | BlockNumberOrTag, returnFormat: ReturnFormat): Promise<NumberTypes[ReturnFormat[number]]>

• Type parameters

  • ReturnFormat: DataFormat

  Parameters

  • web3Context: Web3Context<EthExecutionAPI, any>

  • transaction: Transaction

  • blockNumber: undefined | BlockNumberOrTag

  • returnFormat: ReturnFormat

  Returns Promise<NumberTypes[ReturnFormat[number]]>

formatTransaction

• formatTransaction<ReturnFormat, TransactionType>(transaction: TransactionType, returnFormat?: ReturnFormat): FormatType<TransactionType, ReturnFormat>

• Type parameters

  • ReturnFormat: DataFormat = { bytes: HEX; number: BIGINT }
  • TransactionType: Transaction = Transaction

  Parameters

  • transaction: TransactionType

  • optionalreturnFormat: ReturnFormat

  Returns FormatType<TransactionType, ReturnFormat>

getBalance

• getBalance<ReturnFormat>(web3Context: Web3Context<EthExecutionAPI, any>, address: string, blockNumber: undefined | BlockNumberOrTag, returnFormat: ReturnFormat): Promise<NumberTypes[ReturnFormat[number]]>

• Type parameters

  • ReturnFormat: DataFormat

  Parameters

  • web3Context: Web3Context<EthExecutionAPI, any>

  • address: string

  • blockNumber: undefined | BlockNumberOrTag

  • returnFormat: ReturnFormat

  Returns Promise<NumberTypes[ReturnFormat[number]]>

getBlock

• getBlock<ReturnFormat>(web3Context: Web3Context<EthExecutionAPI, any>, block: undefined | string | number | bigint | Buffer | ArrayBuffer | Uint8Array, hydrated: undefined | boolean, returnFormat: ReturnFormat): Promise<{ baseFeePerGas?: NumberTypes[ReturnFormat[number]]; difficulty?: NumberTypes[ReturnFormat[number]]; extraData: ByteTypes[ReturnFormat[bytes]]; gasLimit: NumberTypes[ReturnFormat[number]]; gasUsed: NumberTypes[ReturnFormat[number]]; hash?: ByteTypes[ReturnFormat[bytes]]; logsBloom?: ByteTypes[ReturnFormat[bytes]]; miner: ByteTypes[ReturnFormat[bytes]]; mixHash: ByteTypes[ReturnFormat[bytes]]; nonce: NumberTypes[ReturnFormat[number]]; number: NumberTypes[ReturnFormat[number]]; parentHash: ByteTypes[ReturnFormat[bytes]]; receiptsRoot: ByteTypes[ReturnFormat[bytes]]; sha3Uncles: ByteTypes[ReturnFormat[bytes]]; size: NumberTypes[ReturnFormat[number]]; stateRoot: ByteTypes[ReturnFormat[bytes]]; timestamp: NumberTypes[ReturnFormat[number]]; totalDifficulty: NumberTypes[ReturnFormat[number]]; transactions: string[] | { accessList?: { address?: string; storageKeys?: string[] }[]; blockHash?: ByteTypes[ReturnFormat[bytes]]; blockNumber?: NumberTypes[ReturnFormat[number]]; chain?: ValidChains; chainId?: NumberTypes[ReturnFormat[number]]; common?: { baseChain?: ValidChains; customChain: { chainId: NumberTypes[ReturnFormat[number]]; name?: string; networkId: NumberTypes[ReturnFormat[number]] }; hardfork?: Hardfork }; data?: ByteTypes[ReturnFormat[bytes]]; from: string; gas?: NumberTypes[ReturnFormat[number]]; gasLimit?: NumberTypes[ReturnFormat[number]]; gasPrice?: NumberTypes[ReturnFormat[number]]; hardfork?: Hardfork; hash: ByteTypes[ReturnFormat[bytes]]; input?: ByteTypes[ReturnFormat[bytes]]; maxFeePerGas?: NumberTypes[ReturnFormat[number]]; maxPriorityFeePerGas?: NumberTypes[ReturnFormat[number]]; networkId?: NumberTypes[ReturnFormat[number]]; nonce?: NumberTypes[ReturnFormat[number]]; r?: ByteTypes[ReturnFormat[bytes]]; s?: ByteTypes[ReturnFormat[bytes]]; to?: string | null; transactionIndex?: NumberTypes[ReturnFormat[number]]; type?: NumberTypes[ReturnFormat[number]]; v?: NumberTypes[ReturnFormat[number]]; value?: NumberTypes[ReturnFormat[number]]; yParity?: string }[]; transactionsRoot: ByteTypes[ReturnFormat[bytes]]; uncles: string[] }>

• Type parameters

  • ReturnFormat: DataFormat

  Parameters

  • web3Context: Web3Context<EthExecutionAPI, any>

  • block: undefined | string | number | bigint | Buffer | ArrayBuffer | Uint8Array

  • hydrated: undefined | boolean

  • returnFormat: ReturnFormat

  Returns Promise<{ baseFeePerGas?: NumberTypes[ReturnFormat[number]]; difficulty?: NumberTypes[ReturnFormat[number]]; extraData: ByteTypes[ReturnFormat[bytes]]; gasLimit: NumberTypes[ReturnFormat[number]]; gasUsed: NumberTypes[ReturnFormat[number]]; hash?: ByteTypes[ReturnFormat[bytes]]; logsBloom?: ByteTypes[ReturnFormat[bytes]]; miner: ByteTypes[ReturnFormat[bytes]]; mixHash: ByteTypes[ReturnFormat[bytes]]; nonce: NumberTypes[ReturnFormat[number]]; number: NumberTypes[ReturnFormat[number]]; parentHash: ByteTypes[ReturnFormat[bytes]]; receiptsRoot: ByteTypes[ReturnFormat[bytes]]; sha3Uncles: ByteTypes[ReturnFormat[bytes]]; size: NumberTypes[ReturnFormat[number]]; stateRoot: ByteTypes[ReturnFormat[bytes]]; timestamp: NumberTypes[ReturnFormat[number]]; totalDifficulty: NumberTypes[ReturnFormat[number]]; transactions: string[] | { accessList?: { address?: string; storageKeys?: string[] }[]; blockHash?: ByteTypes[ReturnFormat[bytes]]; blockNumber?: NumberTypes[ReturnFormat[number]]; chain?: ValidChains; chainId?: NumberTypes[ReturnFormat[number]]; common?: { baseChain?: ValidChains; customChain: { chainId: NumberTypes[ReturnFormat[number]]; name?: string; networkId: NumberTypes[ReturnFormat[number]] }; hardfork?: Hardfork }; data?: ByteTypes[ReturnFormat[bytes]]; from: string; gas?: NumberTypes[ReturnFormat[number]]; gasLimit?: NumberTypes[ReturnFormat[number]]; gasPrice?: NumberTypes[ReturnFormat[number]]; hardfork?: Hardfork; hash: ByteTypes[ReturnFormat[bytes]]; input?: ByteTypes[ReturnFormat[bytes]]; maxFeePerGas?: NumberTypes[ReturnFormat[number]]; maxPriorityFeePerGas?: NumberTypes[ReturnFormat[number]]; networkId?: NumberTypes[ReturnFormat[number]]; nonce?: NumberTypes[ReturnFormat[number]]; r?: ByteTypes[ReturnFormat[bytes]]; s?: ByteTypes[ReturnFormat[bytes]]; to?: string | null; transactionIndex?: NumberTypes[ReturnFormat[number]]; type?: NumberTypes[ReturnFormat[number]]; v?: NumberTypes[ReturnFormat[number]]; value?: NumberTypes[ReturnFormat[number]]; yParity?: string }[]; transactionsRoot: ByteTypes[ReturnFormat[bytes]]; uncles: string[] }>

getBlockNumber

• getBlockNumber<ReturnFormat>(web3Context: Web3Context<EthExecutionAPI, any>, returnFormat: ReturnFormat): Promise<NumberTypes[ReturnFormat[number]]>

• Type parameters

  • ReturnFormat: DataFormat

  Parameters

  • web3Context: Web3Context<EthExecutionAPI, any>

  • returnFormat: ReturnFormat

  Returns Promise<NumberTypes[ReturnFormat[number]]>

getBlockTransactionCount

• getBlockTransactionCount<ReturnFormat>(web3Context: Web3Context<EthExecutionAPI, any>, block: undefined | string | number | bigint | Buffer | ArrayBuffer | Uint8Array, returnFormat: ReturnFormat): Promise<NumberTypes[ReturnFormat[number]]>

• Type parameters

  • ReturnFormat: DataFormat

  Parameters

  • web3Context: Web3Context<EthExecutionAPI, any>

  • block: undefined | string | number | bigint | Buffer | ArrayBuffer | Uint8Array

  • returnFormat: ReturnFormat

  Returns Promise<NumberTypes[ReturnFormat[number]]>

getBlockUncleCount

• getBlockUncleCount<ReturnFormat>(web3Context: Web3Context<EthExecutionAPI, any>, block: undefined | string | number | bigint | Buffer | ArrayBuffer | Uint8Array, returnFormat: ReturnFormat): Promise<NumberTypes[ReturnFormat[number]]>

• Type parameters

  • ReturnFormat: DataFormat

  Parameters

  • web3Context: Web3Context<EthExecutionAPI, any>

  • block: undefined | string | number | bigint | Buffer | ArrayBuffer | Uint8Array

  • returnFormat: ReturnFormat

  Returns Promise<NumberTypes[ReturnFormat[number]]>

getChainId

• getChainId<ReturnFormat>(web3Context: Web3Context<EthExecutionAPI, any>, returnFormat: ReturnFormat): Promise<NumberTypes[ReturnFormat[number]]>

• Type parameters

  • ReturnFormat: DataFormat

  Parameters

  • web3Context: Web3Context<EthExecutionAPI, any>

  • returnFormat: ReturnFormat

  Returns Promise<NumberTypes[ReturnFormat[number]]>

getCode

• getCode<ReturnFormat>(web3Context: Web3Context<EthExecutionAPI, any>, address: string, blockNumber: undefined | BlockNumberOrTag, returnFormat: ReturnFormat): Promise<string>

• Type parameters

  • ReturnFormat: DataFormat

  Parameters

  • web3Context: Web3Context<EthExecutionAPI, any>

  • address: string

  • blockNumber: undefined | BlockNumberOrTag

  • returnFormat: ReturnFormat

  Returns Promise<string>

getCoinbase

• getCoinbase(web3Context: Web3Context<EthExecutionAPI, any>): Promise<string>

• Parameters

  • web3Context: Web3Context<EthExecutionAPI, any>

  Returns Promise<string>

getFeeHistory

• getFeeHistory<ReturnFormat>(web3Context: Web3Context<EthExecutionAPI, any>, blockCount: Numbers, newestBlock: undefined | BlockNumberOrTag, rewardPercentiles: Numbers[], returnFormat: ReturnFormat): Promise<{ baseFeePerGas: NumberTypes[ReturnFormat[number]]; gasUsedRatio: NumberTypes[ReturnFormat[number]][]; oldestBlock: NumberTypes[ReturnFormat[number]]; reward: NumberTypes[ReturnFormat[number]][][] }>

• Type parameters

  • ReturnFormat: DataFormat

  Parameters

  • web3Context: Web3Context<EthExecutionAPI, any>

  • blockCount: Numbers

  • newestBlock: undefined | BlockNumberOrTag

  • rewardPercentiles: Numbers[]

  • returnFormat: ReturnFormat

  Returns Promise<{ baseFeePerGas: NumberTypes[ReturnFormat[number]]; gasUsedRatio: NumberTypes[ReturnFormat[number]][]; oldestBlock: NumberTypes[ReturnFormat[number]]; reward: NumberTypes[ReturnFormat[number]][][] }>

getGasPrice

• getGasPrice<ReturnFormat>(web3Context: Web3Context<EthExecutionAPI, any>, returnFormat: ReturnFormat): Promise<NumberTypes[ReturnFormat[number]]>

• Type parameters

  • ReturnFormat: DataFormat

  Parameters

  • web3Context: Web3Context<EthExecutionAPI, any>

  • returnFormat: ReturnFormat

  Returns Promise<NumberTypes[ReturnFormat[number]]>

getHashRate

• getHashRate<ReturnFormat>(web3Context: Web3Context<EthExecutionAPI, any>, returnFormat: ReturnFormat): Promise<NumberTypes[ReturnFormat[number]]>

• Type parameters

  • ReturnFormat: DataFormat

  Parameters

  • web3Context: Web3Context<EthExecutionAPI, any>

  • returnFormat: ReturnFormat

  Returns Promise<NumberTypes[ReturnFormat[number]]>

getLogs

• getLogs<ReturnFormat>(web3Context: Web3Context<Web3EthExecutionAPI, any>, filter: Filter, returnFormat: ReturnFormat): Promise<(string | { address?: string; blockHash?: ByteTypes[ReturnFormat[bytes]]; blockNumber?: NumberTypes[ReturnFormat[number]]; data?: ByteTypes[ReturnFormat[bytes]]; id?: string; logIndex?: NumberTypes[ReturnFormat[number]]; removed?: boolean; topics?: ByteTypes[ReturnFormat[bytes]][]; transactionHash?: ByteTypes[ReturnFormat[bytes]]; transactionIndex?: NumberTypes[ReturnFormat[number]] })[]>

• Type parameters

  • ReturnFormat: DataFormat

  Parameters

  • web3Context: Web3Context<Web3EthExecutionAPI, any>

  • filter: Filter

  • returnFormat: ReturnFormat

  Returns Promise<(string | { address?: string; blockHash?: ByteTypes[ReturnFormat[bytes]]; blockNumber?: NumberTypes[ReturnFormat[number]]; data?: ByteTypes[ReturnFormat[bytes]]; id?: string; logIndex?: NumberTypes[ReturnFormat[number]]; removed?: boolean; topics?: ByteTypes[ReturnFormat[bytes]][]; transactionHash?: ByteTypes[ReturnFormat[bytes]]; transactionIndex?: NumberTypes[ReturnFormat[number]] })[]>

getPendingTransactions

• getPendingTransactions<ReturnFormat>(web3Context: Web3Context<EthExecutionAPI, any>, returnFormat: ReturnFormat): Promise<{ accessList?: { address?: string; storageKeys?: string[] }[]; chain?: ValidChains; chainId?: NumberTypes[ReturnFormat[number]]; common?: { baseChain?: ValidChains; customChain: { chainId: NumberTypes[ReturnFormat[number]]; name?: string; networkId: NumberTypes[ReturnFormat[number]] }; hardfork?: Hardfork }; data?: ByteTypes[ReturnFormat[bytes]]; from?: string; gas?: NumberTypes[ReturnFormat[number]]; gasLimit?: NumberTypes[ReturnFormat[number]]; gasPrice?: NumberTypes[ReturnFormat[number]]; hardfork?: Hardfork; input?: ByteTypes[ReturnFormat[bytes]]; maxFeePerGas?: NumberTypes[ReturnFormat[number]]; maxPriorityFeePerGas?: NumberTypes[ReturnFormat[number]]; networkId?: NumberTypes[ReturnFormat[number]]; nonce?: NumberTypes[ReturnFormat[number]]; r?: ByteTypes[ReturnFormat[bytes]]; s?: ByteTypes[ReturnFormat[bytes]]; to?: string | null; type?: NumberTypes[ReturnFormat[number]]; v?: NumberTypes[ReturnFormat[number]]; value?: NumberTypes[ReturnFormat[number]]; yParity?: string }[]>

• Type parameters

  • ReturnFormat: DataFormat

  Parameters

  • web3Context: Web3Context<EthExecutionAPI, any>

  • returnFormat: ReturnFormat

  Returns Promise<{ accessList?: { address?: string; storageKeys?: string[] }[]; chain?: ValidChains; chainId?: NumberTypes[ReturnFormat[number]]; common?: { baseChain?: ValidChains; customChain: { chainId: NumberTypes[ReturnFormat[number]]; name?: string; networkId: NumberTypes[ReturnFormat[number]] }; hardfork?: Hardfork }; data?: ByteTypes[ReturnFormat[bytes]]; from?: string; gas?: NumberTypes[ReturnFormat[number]]; gasLimit?: NumberTypes[ReturnFormat[number]]; gasPrice?: NumberTypes[ReturnFormat[number]]; hardfork?: Hardfork; input?: ByteTypes[ReturnFormat[bytes]]; maxFeePerGas?: NumberTypes[ReturnFormat[number]]; maxPriorityFeePerGas?: NumberTypes[ReturnFormat[number]]; networkId?: NumberTypes[ReturnFormat[number]]; nonce?: NumberTypes[ReturnFormat[number]]; r?: ByteTypes[ReturnFormat[bytes]]; s?: ByteTypes[ReturnFormat[bytes]]; to?: string | null; type?: NumberTypes[ReturnFormat[number]]; v?: NumberTypes[ReturnFormat[number]]; value?: NumberTypes[ReturnFormat[number]]; yParity?: string }[]>

getProof

• getProof<ReturnFormat>(web3Context: Web3Context<Web3EthExecutionAPI, any>, address: string, storageKeys: Bytes[], blockNumber: undefined | BlockNumberOrTag, returnFormat: ReturnFormat): Promise<{ accountProof: ByteTypes[ReturnFormat[bytes]][]; balance: NumberTypes[ReturnFormat[number]]; codeHash: ByteTypes[ReturnFormat[bytes]]; nonce: NumberTypes[ReturnFormat[number]]; storageHash: ByteTypes[ReturnFormat[bytes]]; storageProof: { key: ByteTypes[ReturnFormat[bytes]]; proof: ByteTypes[ReturnFormat[bytes]][]; value: NumberTypes[ReturnFormat[number]] }[] }>

• Type parameters

  • ReturnFormat: DataFormat

  Parameters

  • web3Context: Web3Context<Web3EthExecutionAPI, any>

  • address: string

  • storageKeys: Bytes[]

  • blockNumber: undefined | BlockNumberOrTag

  • returnFormat: ReturnFormat

  Returns Promise<{ accountProof: ByteTypes[ReturnFormat[bytes]][]; balance: NumberTypes[ReturnFormat[number]]; codeHash: ByteTypes[ReturnFormat[bytes]]; nonce: NumberTypes[ReturnFormat[number]]; storageHash: ByteTypes[ReturnFormat[bytes]]; storageProof: { key: ByteTypes[ReturnFormat[bytes]]; proof: ByteTypes[ReturnFormat[bytes]][]; value: NumberTypes[ReturnFormat[number]] }[] }>

getProtocolVersion

• getProtocolVersion(web3Context: Web3Context<EthExecutionAPI, any>): Promise<string>

• Parameters

  • web3Context: Web3Context<EthExecutionAPI, any>

  Returns Promise<string>

getStorageAt

• getStorageAt<ReturnFormat>(web3Context: Web3Context<EthExecutionAPI, any>, address: string, storageSlot: Numbers, blockNumber: undefined | BlockNumberOrTag, returnFormat: ReturnFormat): Promise<string>

• Type parameters

  • ReturnFormat: DataFormat

  Parameters

  • web3Context: Web3Context<EthExecutionAPI, any>

  • address: string

  • storageSlot: Numbers

  • blockNumber: undefined | BlockNumberOrTag

  • returnFormat: ReturnFormat

  Returns Promise<string>

getTransaction

• getTransaction<ReturnFormat>(web3Context: Web3Context<EthExecutionAPI, any>, transactionHash: Bytes, returnFormat: ReturnFormat): Promise<{ accessList?: { address?: string; storageKeys?: string[] }[]; blockHash?: ByteTypes[ReturnFormat[bytes]]; blockNumber?: NumberTypes[ReturnFormat[number]]; chain?: ValidChains; chainId?: NumberTypes[ReturnFormat[number]]; common?: { baseChain?: ValidChains; customChain: { chainId: NumberTypes[ReturnFormat[number]]; name?: string; networkId: NumberTypes[ReturnFormat[number]] }; hardfork?: Hardfork }; data?: ByteTypes[ReturnFormat[bytes]]; from: string; gas?: NumberTypes[ReturnFormat[number]]; gasLimit?: NumberTypes[ReturnFormat[number]]; gasPrice?: NumberTypes[ReturnFormat[number]]; hardfork?: Hardfork; hash: ByteTypes[ReturnFormat[bytes]]; input?: ByteTypes[ReturnFormat[bytes]]; maxFeePerGas?: NumberTypes[ReturnFormat[number]]; maxPriorityFeePerGas?: NumberTypes[ReturnFormat[number]]; networkId?: NumberTypes[ReturnFormat[number]]; nonce?: NumberTypes[ReturnFormat[number]]; r?: ByteTypes[ReturnFormat[bytes]]; s?: ByteTypes[ReturnFormat[bytes]]; to?: string | null; transactionIndex?: NumberTypes[ReturnFormat[number]]; type?: NumberTypes[ReturnFormat[number]]; v?: NumberTypes[ReturnFormat[number]]; value?: NumberTypes[ReturnFormat[number]]; yParity?: string } | undefined>

• Type parameters

  • ReturnFormat: DataFormat

  Parameters

  • web3Context: Web3Context<EthExecutionAPI, any>

  • transactionHash: Bytes

  • returnFormat: ReturnFormat

  Returns Promise<{ accessList?: { address?: string; storageKeys?: string[] }[]; blockHash?: ByteTypes[ReturnFormat[bytes]]; blockNumber?: NumberTypes[ReturnFormat[number]]; chain?: ValidChains; chainId?: NumberTypes[ReturnFormat[number]]; common?: { baseChain?: ValidChains; customChain: { chainId: NumberTypes[ReturnFormat[number]]; name?: string; networkId: NumberTypes[ReturnFormat[number]] }; hardfork?: Hardfork }; data?: ByteTypes[ReturnFormat[bytes]]; from: string; gas?: NumberTypes[ReturnFormat[number]]; gasLimit?: NumberTypes[ReturnFormat[number]]; gasPrice?: NumberTypes[ReturnFormat[number]]; hardfork?: Hardfork; hash: ByteTypes[ReturnFormat[bytes]]; input?: ByteTypes[ReturnFormat[bytes]]; maxFeePerGas?: NumberTypes[ReturnFormat[number]]; maxPriorityFeePerGas?: NumberTypes[ReturnFormat[number]]; networkId?: NumberTypes[ReturnFormat[number]]; nonce?: NumberTypes[ReturnFormat[number]]; r?: ByteTypes[ReturnFormat[bytes]]; s?: ByteTypes[ReturnFormat[bytes]]; to?: string | null; transactionIndex?: NumberTypes[ReturnFormat[number]]; type?: NumberTypes[ReturnFormat[number]]; v?: NumberTypes[ReturnFormat[number]]; value?: NumberTypes[ReturnFormat[number]]; yParity?: string } | undefined>

getTransactionCount

• getTransactionCount<ReturnFormat>(web3Context: Web3Context<EthExecutionAPI, any>, address: string, blockNumber: undefined | BlockNumberOrTag, returnFormat: ReturnFormat): Promise<NumberTypes[ReturnFormat[number]]>

• Type parameters

  • ReturnFormat: DataFormat

  Parameters

  • web3Context: Web3Context<EthExecutionAPI, any>

  • address: string

  • blockNumber: undefined | BlockNumberOrTag

  • returnFormat: ReturnFormat

  Returns Promise<NumberTypes[ReturnFormat[number]]>

getTransactionFromBlock

• getTransactionFromBlock<ReturnFormat>(web3Context: Web3Context<EthExecutionAPI, any>, block: undefined | string | number | bigint | Buffer | ArrayBuffer | Uint8Array, transactionIndex: Numbers, returnFormat: ReturnFormat): Promise<{ accessList?: { address?: string; storageKeys?: string[] }[]; blockHash?: ByteTypes[ReturnFormat[bytes]]; blockNumber?: NumberTypes[ReturnFormat[number]]; chain?: ValidChains; chainId?: NumberTypes[ReturnFormat[number]]; common?: { baseChain?: ValidChains; customChain: { chainId: NumberTypes[ReturnFormat[number]]; name?: string; networkId: NumberTypes[ReturnFormat[number]] }; hardfork?: Hardfork }; data?: ByteTypes[ReturnFormat[bytes]]; from: string; gas?: NumberTypes[ReturnFormat[number]]; gasLimit?: NumberTypes[ReturnFormat[number]]; gasPrice?: NumberTypes[ReturnFormat[number]]; hardfork?: Hardfork; hash: ByteTypes[ReturnFormat[bytes]]; input?: ByteTypes[ReturnFormat[bytes]]; maxFeePerGas?: NumberTypes[ReturnFormat[number]]; maxPriorityFeePerGas?: NumberTypes[ReturnFormat[number]]; networkId?: NumberTypes[ReturnFormat[number]]; nonce?: NumberTypes[ReturnFormat[number]]; r?: ByteTypes[ReturnFormat[bytes]]; s?: ByteTypes[ReturnFormat[bytes]]; to?: string | null; transactionIndex?: NumberTypes[ReturnFormat[number]]; type?: NumberTypes[ReturnFormat[number]]; v?: NumberTypes[ReturnFormat[number]]; value?: NumberTypes[ReturnFormat[number]]; yParity?: string } | undefined>

• Type parameters

  • ReturnFormat: DataFormat

  Parameters

  • web3Context: Web3Context<EthExecutionAPI, any>

  • block: undefined | string | number | bigint | Buffer | ArrayBuffer | Uint8Array

  • transactionIndex: Numbers

  • returnFormat: ReturnFormat

  Returns Promise<{ accessList?: { address?: string; storageKeys?: string[] }[]; blockHash?: ByteTypes[ReturnFormat[bytes]]; blockNumber?: NumberTypes[ReturnFormat[number]]; chain?: ValidChains; chainId?: NumberTypes[ReturnFormat[number]]; common?: { baseChain?: ValidChains; customChain: { chainId: NumberTypes[ReturnFormat[number]]; name?: string; networkId: NumberTypes[ReturnFormat[number]] }; hardfork?: Hardfork }; data?: ByteTypes[ReturnFormat[bytes]]; from: string; gas?: NumberTypes[ReturnFormat[number]]; gasLimit?: NumberTypes[ReturnFormat[number]]; gasPrice?: NumberTypes[ReturnFormat[number]]; hardfork?: Hardfork; hash: ByteTypes[ReturnFormat[bytes]]; input?: ByteTypes[ReturnFormat[bytes]]; maxFeePerGas?: NumberTypes[ReturnFormat[number]]; maxPriorityFeePerGas?: NumberTypes[ReturnFormat[number]]; networkId?: NumberTypes[ReturnFormat[number]]; nonce?: NumberTypes[ReturnFormat[number]]; r?: ByteTypes[ReturnFormat[bytes]]; s?: ByteTypes[ReturnFormat[bytes]]; to?: string | null; transactionIndex?: NumberTypes[ReturnFormat[number]]; type?: NumberTypes[ReturnFormat[number]]; v?: NumberTypes[ReturnFormat[number]]; value?: NumberTypes[ReturnFormat[number]]; yParity?: string } | undefined>

getTransactionReceipt

• getTransactionReceipt<ReturnFormat>(web3Context: Web3Context<EthExecutionAPI, any>, transactionHash: Bytes, returnFormat: ReturnFormat): Promise<TransactionReceipt | undefined>

• Type parameters

  • ReturnFormat: DataFormat

  Parameters

  • web3Context: Web3Context<EthExecutionAPI, any>

  • transactionHash: Bytes

  • returnFormat: ReturnFormat

  Returns Promise<TransactionReceipt | undefined>

getUncle

• getUncle<ReturnFormat>(web3Context: Web3Context<EthExecutionAPI, any>, block: undefined | string | number | bigint | Buffer | ArrayBuffer | Uint8Array, uncleIndex: Numbers, returnFormat: ReturnFormat): Promise<{ baseFeePerGas?: NumberTypes[ReturnFormat[number]]; difficulty?: NumberTypes[ReturnFormat[number]]; extraData: ByteTypes[ReturnFormat[bytes]]; gasLimit: NumberTypes[ReturnFormat[number]]; gasUsed: NumberTypes[ReturnFormat[number]]; hash?: ByteTypes[ReturnFormat[bytes]]; logsBloom?: ByteTypes[ReturnFormat[bytes]]; miner: ByteTypes[ReturnFormat[bytes]]; mixHash: ByteTypes[ReturnFormat[bytes]]; nonce: NumberTypes[ReturnFormat[number]]; number: NumberTypes[ReturnFormat[number]]; parentHash: ByteTypes[ReturnFormat[bytes]]; receiptsRoot: ByteTypes[ReturnFormat[bytes]]; sha3Uncles: ByteTypes[ReturnFormat[bytes]]; size: NumberTypes[ReturnFormat[number]]; stateRoot: ByteTypes[ReturnFormat[bytes]]; timestamp: NumberTypes[ReturnFormat[number]]; totalDifficulty: NumberTypes[ReturnFormat[number]]; transactions: string[] | { accessList?: { address?: string; storageKeys?: string[] }[]; blockHash?: ByteTypes[ReturnFormat[bytes]]; blockNumber?: NumberTypes[ReturnFormat[number]]; chain?: ValidChains; chainId?: NumberTypes[ReturnFormat[number]]; common?: { baseChain?: ValidChains; customChain: { chainId: NumberTypes[ReturnFormat[number]]; name?: string; networkId: NumberTypes[ReturnFormat[number]] }; hardfork?: Hardfork }; data?: ByteTypes[ReturnFormat[bytes]]; from: string; gas?: NumberTypes[ReturnFormat[number]]; gasLimit?: NumberTypes[ReturnFormat[number]]; gasPrice?: NumberTypes[ReturnFormat[number]]; hardfork?: Hardfork; hash: ByteTypes[ReturnFormat[bytes]]; input?: ByteTypes[ReturnFormat[bytes]]; maxFeePerGas?: NumberTypes[ReturnFormat[number]]; maxPriorityFeePerGas?: NumberTypes[ReturnFormat[number]]; networkId?: NumberTypes[ReturnFormat[number]]; nonce?: NumberTypes[ReturnFormat[number]]; r?: ByteTypes[ReturnFormat[bytes]]; s?: ByteTypes[ReturnFormat[bytes]]; to?: string | null; transactionIndex?: NumberTypes[ReturnFormat[number]]; type?: NumberTypes[ReturnFormat[number]]; v?: NumberTypes[ReturnFormat[number]]; value?: NumberTypes[ReturnFormat[number]]; yParity?: string }[]; transactionsRoot: ByteTypes[ReturnFormat[bytes]]; uncles: string[] }>

• Type parameters

  • ReturnFormat: DataFormat

  Parameters

  • web3Context: Web3Context<EthExecutionAPI, any>

  • block: undefined | string | number | bigint | Buffer | ArrayBuffer | Uint8Array

  • uncleIndex: Numbers

  • returnFormat: ReturnFormat

  Returns Promise<{ baseFeePerGas?: NumberTypes[ReturnFormat[number]]; difficulty?: NumberTypes[ReturnFormat[number]]; extraData: ByteTypes[ReturnFormat[bytes]]; gasLimit: NumberTypes[ReturnFormat[number]]; gasUsed: NumberTypes[ReturnFormat[number]]; hash?: ByteTypes[ReturnFormat[bytes]]; logsBloom?: ByteTypes[ReturnFormat[bytes]]; miner: ByteTypes[ReturnFormat[bytes]]; mixHash: ByteTypes[ReturnFormat[bytes]]; nonce: NumberTypes[ReturnFormat[number]]; number: NumberTypes[ReturnFormat[number]]; parentHash: ByteTypes[ReturnFormat[bytes]]; receiptsRoot: ByteTypes[ReturnFormat[bytes]]; sha3Uncles: ByteTypes[ReturnFormat[bytes]]; size: NumberTypes[ReturnFormat[number]]; stateRoot: ByteTypes[ReturnFormat[bytes]]; timestamp: NumberTypes[ReturnFormat[number]]; totalDifficulty: NumberTypes[ReturnFormat[number]]; transactions: string[] | { accessList?: { address?: string; storageKeys?: string[] }[]; blockHash?: ByteTypes[ReturnFormat[bytes]]; blockNumber?: NumberTypes[ReturnFormat[number]]; chain?: ValidChains; chainId?: NumberTypes[ReturnFormat[number]]; common?: { baseChain?: ValidChains; customChain: { chainId: NumberTypes[ReturnFormat[number]]; name?: string; networkId: NumberTypes[ReturnFormat[number]] }; hardfork?: Hardfork }; data?: ByteTypes[ReturnFormat[bytes]]; from: string; gas?: NumberTypes[ReturnFormat[number]]; gasLimit?: NumberTypes[ReturnFormat[number]]; gasPrice?: NumberTypes[ReturnFormat[number]]; hardfork?: Hardfork; hash: ByteTypes[ReturnFormat[bytes]]; input?: ByteTypes[ReturnFormat[bytes]]; maxFeePerGas?: NumberTypes[ReturnFormat[number]]; maxPriorityFeePerGas?: NumberTypes[ReturnFormat[number]]; networkId?: NumberTypes[ReturnFormat[number]]; nonce?: NumberTypes[ReturnFormat[number]]; r?: ByteTypes[ReturnFormat[bytes]]; s?: ByteTypes[ReturnFormat[bytes]]; to?: string | null; transactionIndex?: NumberTypes[ReturnFormat[number]]; type?: NumberTypes[ReturnFormat[number]]; v?: NumberTypes[ReturnFormat[number]]; value?: NumberTypes[ReturnFormat[number]]; yParity?: string }[]; transactionsRoot: ByteTypes[ReturnFormat[bytes]]; uncles: string[] }>

isAccessList

• isAccessList(value: AccessList): boolean

• Parameters

  • value: AccessList

  Returns boolean

isAccessListEntry

• isAccessListEntry(value: AccessListEntry): boolean

• Parameters

  • value: AccessListEntry

  Returns boolean

isBaseTransaction

• isBaseTransaction(value: BaseTransactionAPI): boolean

• Parameters

  • value: BaseTransactionAPI

  Returns boolean

isMining

• isMining(web3Context: Web3Context<EthExecutionAPI, any>): Promise<boolean>

• Parameters

  • web3Context: Web3Context<EthExecutionAPI, any>

  Returns Promise<boolean>

isSyncing

• isSyncing(web3Context: Web3Context<EthExecutionAPI, any>): Promise<SyncingStatusAPI>

• Parameters

  • web3Context: Web3Context<EthExecutionAPI, any>

  Returns Promise<SyncingStatusAPI>

isTransaction1559Unsigned

• isTransaction1559Unsigned(value: Transaction1559UnsignedAPI): boolean

• Parameters

  • value: Transaction1559UnsignedAPI

  Returns boolean

isTransaction2930Unsigned

• isTransaction2930Unsigned(value: Transaction2930UnsignedAPI): boolean

• Parameters

  • value: Transaction2930UnsignedAPI

  Returns boolean

isTransactionCall

• isTransactionCall(value: TransactionCall): boolean

• Parameters

  • value: TransactionCall

  Returns boolean

isTransactionLegacyUnsigned

• isTransactionLegacyUnsigned(value: TransactionLegacyUnsignedAPI): boolean

• Parameters

  • value: TransactionLegacyUnsignedAPI

  Returns boolean

isTransactionWithSender

• isTransactionWithSender(value: TransactionWithSenderAPI): boolean

• Parameters

  • value: TransactionWithSenderAPI

  Returns boolean

prepareTransactionForSigning

• prepareTransactionForSigning(transaction: Transaction, web3Context: Web3Context<EthExecutionAPI, any>, privateKey?: string | Buffer): Promise<TypedTransaction>

• Parameters

  • transaction: Transaction

  • web3Context: Web3Context<EthExecutionAPI, any>

  • optionalprivateKey: string | Buffer

  Returns Promise<TypedTransaction>

sendSignedTransaction

• sendSignedTransaction<ReturnFormat, ResolveType>(web3Context: Web3Context<EthExecutionAPI, any>, signedTransaction: Bytes, returnFormat: ReturnFormat, options?: SendSignedTransactionOptions<ResolveType>): Web3PromiEvent<ResolveType, SendSignedTransactionEvents<ReturnFormat>>

• Type parameters

  • ReturnFormat: DataFormat
  • ResolveType = { blockHash: ByteTypes[ReturnFormat[bytes]]; blockNumber: NumberTypes[ReturnFormat[number]]; contractAddress?: string; cumulativeGasUsed: NumberTypes[ReturnFormat[number]]; effectiveGasPrice?: NumberTypes[ReturnFormat[number]]; from: string; gasUsed: NumberTypes[ReturnFormat[number]]; logs: { readonly id?: string | undefined; readonly removed?: boolean | undefined; readonly logIndex?: NumberTypes[ReturnFormat["number"]] | undefined; ... 6 more ...; readonly topics?: ByteTypes[ReturnFormat["bytes"]][] | undefined; }[]; logsBloom: ByteTypes[ReturnFormat[bytes]]; root: ByteTypes[ReturnFormat[bytes]]; status: NumberTypes[ReturnFormat[number]]; to: string; transactionHash: ByteTypes[ReturnFormat[bytes]]; transactionIndex: NumberTypes[ReturnFormat[number]]; type?: NumberTypes[ReturnFormat[number]] }

  Parameters

  • web3Context: Web3Context<EthExecutionAPI, any>

  • signedTransaction: Bytes

  • returnFormat: ReturnFormat

  • optionaloptions: SendSignedTransactionOptions<ResolveType>

  Returns Web3PromiEvent<ResolveType, SendSignedTransactionEvents<ReturnFormat>>

sendTransaction

• sendTransaction<ReturnFormat, ResolveType>(web3Context: Web3Context<EthExecutionAPI, any>, transaction: Transaction | TransactionWithFromLocalWalletIndex | TransactionWithToLocalWalletIndex | TransactionWithFromAndToLocalWalletIndex, returnFormat: ReturnFormat, options?: SendTransactionOptions<ResolveType>): Web3PromiEvent<ResolveType, SendTransactionEvents<ReturnFormat>>

• Type parameters

  • ReturnFormat: DataFormat
  • ResolveType = { blockHash: ByteTypes[ReturnFormat[bytes]]; blockNumber: NumberTypes[ReturnFormat[number]]; contractAddress?: string; cumulativeGasUsed: NumberTypes[ReturnFormat[number]]; effectiveGasPrice?: NumberTypes[ReturnFormat[number]]; from: string; gasUsed: NumberTypes[ReturnFormat[number]]; logs: { readonly id?: string | undefined; readonly removed?: boolean | undefined; readonly logIndex?: NumberTypes[ReturnFormat["number"]] | undefined; ... 6 more ...; readonly topics?: ByteTypes[ReturnFormat["bytes"]][] | undefined; }[]; logsBloom: ByteTypes[ReturnFormat[bytes]]; root: ByteTypes[ReturnFormat[bytes]]; status: NumberTypes[ReturnFormat[number]]; to: string; transactionHash: ByteTypes[ReturnFormat[bytes]]; transactionIndex: NumberTypes[ReturnFormat[number]]; type?: NumberTypes[ReturnFormat[number]] }

  Parameters

  • web3Context: Web3Context<EthExecutionAPI, any>

  • transaction: Transaction | TransactionWithFromLocalWalletIndex | TransactionWithToLocalWalletIndex | TransactionWithFromAndToLocalWalletIndex

  • returnFormat: ReturnFormat

  • optionaloptions: SendTransactionOptions<ResolveType>

  Returns Web3PromiEvent<ResolveType, SendTransactionEvents<ReturnFormat>>

sign

• sign<ReturnFormat>(web3Context: Web3Context<EthExecutionAPI, any>, message: Bytes, addressOrIndex: string | number, returnFormat: ReturnFormat): Promise<string | { message?: string; messageHash: string; r: string; s: string; signature: string; v: string }>

• Type parameters

  • ReturnFormat: DataFormat

  Parameters

  • web3Context: Web3Context<EthExecutionAPI, any>

  • message: Bytes

  • addressOrIndex: string | number

  • returnFormat: ReturnFormat

  Returns Promise<string | { message?: string; messageHash: string; r: string; s: string; signature: string; v: string }>

signTransaction

• signTransaction<ReturnFormat>(web3Context: Web3Context<EthExecutionAPI, any>, transaction: Transaction, returnFormat: ReturnFormat): Promise<SignedTransactionInfoAPI>

• Type parameters

  • ReturnFormat: DataFormat

  Parameters

  • web3Context: Web3Context<EthExecutionAPI, any>

  • transaction: Transaction

  • returnFormat: ReturnFormat

  Returns Promise<SignedTransactionInfoAPI>

transactionBuilder

• transactionBuilder<ReturnType_1>(options: { privateKey?: string | Buffer; transaction: Transaction; web3Context: Web3Context<EthExecutionAPI, any> }): Promise<ReturnType_1>

• Type parameters

  • ReturnType_1 = Record<string, unknown>

  Parameters

  • options: { privateKey?: string | Buffer; transaction: Transaction; web3Context: Web3Context<EthExecutionAPI, any> }

  Returns Promise<ReturnType_1>

validateBaseChain

• validateBaseChain(transaction: { accessList?: { readonly address?: string | undefined; readonly storageKeys?: string[] | undefined; }[]; chain?: ValidChains; chainId?: string; common?: { customChain: { name?: string | undefined; networkId: string; chainId: string; }; baseChain?: ValidChains | undefined; hardfork?: Hardfork | undefined; }; data?: string; from?: string; gas?: string; gasLimit?: string; gasPrice?: string; hardfork?: Hardfork; input?: string; maxFeePerGas?: string; maxPriorityFeePerGas?: string; networkId?: string; nonce?: string; r?: string; s?: string; to?: null | string; type?: string; v?: string; value?: string; yParity?: string }): void

• Parameters

  • transaction: { accessList?: { readonly address?: string | undefined; readonly storageKeys?: string[] | undefined; }[]; chain?: ValidChains; chainId?: string; common?: { customChain: { name?: string | undefined; networkId: string; chainId: string; }; baseChain?: ValidChains | undefined; hardfork?: Hardfork | undefined; }; data?: string; from?: string; gas?: string; gasLimit?: string; gasPrice?: string; hardfork?: Hardfork; input?: string; maxFeePerGas?: string; maxPriorityFeePerGas?: string; networkId?: string; nonce?: string; r?: string; s?: string; to?: null | string; type?: string; v?: string; value?: string; yParity?: string }

  Returns void

validateChainInfo

• validateChainInfo(transaction: { accessList?: { readonly address?: string | undefined; readonly storageKeys?: string[] | undefined; }[]; chain?: ValidChains; chainId?: string; common?: { customChain: { name?: string | undefined; networkId: string; chainId: string; }; baseChain?: ValidChains | undefined; hardfork?: Hardfork | undefined; }; data?: string; from?: string; gas?: string; gasLimit?: string; gasPrice?: string; hardfork?: Hardfork; input?: string; maxFeePerGas?: string; maxPriorityFeePerGas?: string; networkId?: string; nonce?: string; r?: string; s?: string; to?: null | string; type?: string; v?: string; value?: string; yParity?: string }): void

• Parameters

  • transaction: { accessList?: { readonly address?: string | undefined; readonly storageKeys?: string[] | undefined; }[]; chain?: ValidChains; chainId?: string; common?: { customChain: { name?: string | undefined; networkId: string; chainId: string; }; baseChain?: ValidChains | undefined; hardfork?: Hardfork | undefined; }; data?: string; from?: string; gas?: string; gasLimit?: string; gasPrice?: string; hardfork?: Hardfork; input?: string; maxFeePerGas?: string; maxPriorityFeePerGas?: string; networkId?: string; nonce?: string; r?: string; s?: string; to?: null | string; type?: string; v?: string; value?: string; yParity?: string }

  Returns void

validateCustomChainInfo

• validateCustomChainInfo(transaction: { accessList?: { readonly address?: string | undefined; readonly storageKeys?: string[] | undefined; }[]; chain?: ValidChains; chainId?: string; common?: { customChain: { name?: string | undefined; networkId: string; chainId: string; }; baseChain?: ValidChains | undefined; hardfork?: Hardfork | undefined; }; data?: string; from?: string; gas?: string; gasLimit?: string; gasPrice?: string; hardfork?: Hardfork; input?: string; maxFeePerGas?: string; maxPriorityFeePerGas?: string; networkId?: string; nonce?: string; r?: string; s?: string; to?: null | string; type?: string; v?: string; value?: string; yParity?: string }): void

• Parameters

  • transaction: { accessList?: { readonly address?: string | undefined; readonly storageKeys?: string[] | undefined; }[]; chain?: ValidChains; chainId?: string; common?: { customChain: { name?: string | undefined; networkId: string; chainId: string; }; baseChain?: ValidChains | undefined; hardfork?: Hardfork | undefined; }; data?: string; from?: string; gas?: string; gasLimit?: string; gasPrice?: string; hardfork?: Hardfork; input?: string; maxFeePerGas?: string; maxPriorityFeePerGas?: string; networkId?: string; nonce?: string; r?: string; s?: string; to?: null | string; type?: string; v?: string; value?: string; yParity?: string }

  Returns void

validateFeeMarketGas

• validateFeeMarketGas(transaction: { accessList?: { readonly address?: string | undefined; readonly storageKeys?: string[] | undefined; }[]; chain?: ValidChains; chainId?: string; common?: { customChain: { name?: string | undefined; networkId: string; chainId: string; }; baseChain?: ValidChains | undefined; hardfork?: Hardfork | undefined; }; data?: string; from?: string; gas?: string; gasLimit?: string; gasPrice?: string; hardfork?: Hardfork; input?: string; maxFeePerGas?: string; maxPriorityFeePerGas?: string; networkId?: string; nonce?: string; r?: string; s?: string; to?: null | string; type?: string; v?: string; value?: string; yParity?: string }): void

• Parameters

  • transaction: { accessList?: { readonly address?: string | undefined; readonly storageKeys?: string[] | undefined; }[]; chain?: ValidChains; chainId?: string; common?: { customChain: { name?: string | undefined; networkId: string; chainId: string; }; baseChain?: ValidChains | undefined; hardfork?: Hardfork | undefined; }; data?: string; from?: string; gas?: string; gasLimit?: string; gasPrice?: string; hardfork?: Hardfork; input?: string; maxFeePerGas?: string; maxPriorityFeePerGas?: string; networkId?: string; nonce?: string; r?: string; s?: string; to?: null | string; type?: string; v?: string; value?: string; yParity?: string }

  Returns void

validateGas

• validateGas(transaction: { accessList?: { readonly address?: string | undefined; readonly storageKeys?: string[] | undefined; }[]; chain?: ValidChains; chainId?: string; common?: { customChain: { name?: string | undefined; networkId: string; chainId: string; }; baseChain?: ValidChains | undefined; hardfork?: Hardfork | undefined; }; data?: string; from?: string; gas?: string; gasLimit?: string; gasPrice?: string; hardfork?: Hardfork; input?: string; maxFeePerGas?: string; maxPriorityFeePerGas?: string; networkId?: string; nonce?: string; r?: string; s?: string; to?: null | string; type?: string; v?: string; value?: string; yParity?: string }): void

• Parameters

  • transaction: { accessList?: { readonly address?: string | undefined; readonly storageKeys?: string[] | undefined; }[]; chain?: ValidChains; chainId?: string; common?: { customChain: { name?: string | undefined; networkId: string; chainId: string; }; baseChain?: ValidChains | undefined; hardfork?: Hardfork | undefined; }; data?: string; from?: string; gas?: string; gasLimit?: string; gasPrice?: string; hardfork?: Hardfork; input?: string; maxFeePerGas?: string; maxPriorityFeePerGas?: string; networkId?: string; nonce?: string; r?: string; s?: string; to?: null | string; type?: string; v?: string; value?: string; yParity?: string }

  Returns void

validateHardfork

• validateHardfork(transaction: { accessList?: { readonly address?: string | undefined; readonly storageKeys?: string[] | undefined; }[]; chain?: ValidChains; chainId?: string; common?: { customChain: { name?: string | undefined; networkId: string; chainId: string; }; baseChain?: ValidChains | undefined; hardfork?: Hardfork | undefined; }; data?: string; from?: string; gas?: string; gasLimit?: string; gasPrice?: string; hardfork?: Hardfork; input?: string; maxFeePerGas?: string; maxPriorityFeePerGas?: string; networkId?: string; nonce?: string; r?: string; s?: string; to?: null | string; type?: string; v?: string; value?: string; yParity?: string }): void

• Parameters

  • transaction: { accessList?: { readonly address?: string | undefined; readonly storageKeys?: string[] | undefined; }[]; chain?: ValidChains; chainId?: string; common?: { customChain: { name?: string | undefined; networkId: string; chainId: string; }; baseChain?: ValidChains | undefined; hardfork?: Hardfork | undefined; }; data?: string; from?: string; gas?: string; gasLimit?: string; gasPrice?: string; hardfork?: Hardfork; input?: string; maxFeePerGas?: string; maxPriorityFeePerGas?: string; networkId?: string; nonce?: string; r?: string; s?: string; to?: null | string; type?: string; v?: string; value?: string; yParity?: string }

  Returns void

validateLegacyGas

• validateLegacyGas(transaction: { accessList?: { readonly address?: string | undefined; readonly storageKeys?: string[] | undefined; }[]; chain?: ValidChains; chainId?: string; common?: { customChain: { name?: string | undefined; networkId: string; chainId: string; }; baseChain?: ValidChains | undefined; hardfork?: Hardfork | undefined; }; data?: string; from?: string; gas?: string; gasLimit?: string; gasPrice?: string; hardfork?: Hardfork; input?: string; maxFeePerGas?: string; maxPriorityFeePerGas?: string; networkId?: string; nonce?: string; r?: string; s?: string; to?: null | string; type?: string; v?: string; value?: string; yParity?: string }): void

• Parameters

  • transaction: { accessList?: { readonly address?: string | undefined; readonly storageKeys?: string[] | undefined; }[]; chain?: ValidChains; chainId?: string; common?: { customChain: { name?: string | undefined; networkId: string; chainId: string; }; baseChain?: ValidChains | undefined; hardfork?: Hardfork | undefined; }; data?: string; from?: string; gas?: string; gasLimit?: string; gasPrice?: string; hardfork?: Hardfork; input?: string; maxFeePerGas?: string; maxPriorityFeePerGas?: string; networkId?: string; nonce?: string; r?: string; s?: string; to?: null | string; type?: string; v?: string; value?: string; yParity?: string }

  Returns void

validateTransactionCall

• validateTransactionCall(value: TransactionCall): void

• Parameters

  • value: TransactionCall

  Returns void

validateTransactionForSigning

• validateTransactionForSigning(transaction: { accessList?: { readonly address?: string | undefined; readonly storageKeys?: string[] | undefined; }[]; chain?: ValidChains; chainId?: string; common?: { customChain: { name?: string | undefined; networkId: string; chainId: string; }; baseChain?: ValidChains | undefined; hardfork?: Hardfork | undefined; }; data?: string; from?: string; gas?: string; gasLimit?: string; gasPrice?: string; hardfork?: Hardfork; input?: string; maxFeePerGas?: string; maxPriorityFeePerGas?: string; networkId?: string; nonce?: string; r?: string; s?: string; to?: null | string; type?: string; v?: string; value?: string; yParity?: string }, overrideMethod?: (transaction: { accessList?: { readonly address?: string | undefined; readonly storageKeys?: string[] | undefined; }[]; chain?: ValidChains; chainId?: string; common?: { customChain: { name?: string | undefined; networkId: string; chainId: string; }; baseChain?: ValidChains | undefined; hardfork?: Hardfork | undefined; }; data?: string; from?: string; gas?: string; gasLimit?: string; gasPrice?: string; hardfork?: Hardfork; input?: string; maxFeePerGas?: string; maxPriorityFeePerGas?: string; networkId?: string; nonce?: string; r?: string; s?: string; to?: null | string; type?: string; v?: string; value?: string; yParity?: string }) => void): void

• Parameters

  • transaction: { accessList?: { readonly address?: string | undefined; readonly storageKeys?: string[] | undefined; }[]; chain?: ValidChains; chainId?: string; common?: { customChain: { name?: string | undefined; networkId: string; chainId: string; }; baseChain?: ValidChains | undefined; hardfork?: Hardfork | undefined; }; data?: string; from?: string; gas?: string; gasLimit?: string; gasPrice?: string; hardfork?: Hardfork; input?: string; maxFeePerGas?: string; maxPriorityFeePerGas?: string; networkId?: string; nonce?: string; r?: string; s?: string; to?: null | string; type?: string; v?: string; value?: string; yParity?: string }

  • optionaloverrideMethod: (transaction: { accessList?: { readonly address?: string | undefined; readonly storageKeys?: string[] | undefined; }[]; chain?: ValidChains; chainId?: string; common?: { customChain: { name?: string | undefined; networkId: string; chainId: string; }; baseChain?: ValidChains | undefined; hardfork?: Hardfork | undefined; }; data?: string; from?: string; gas?: string; gasLimit?: string; gasPrice?: string; hardfork?: Hardfork; input?: string; maxFeePerGas?: string; maxPriorityFeePerGas?: string; networkId?: string; nonce?: string; r?: string; s?: string; to?: null | string; type?: string; v?: string; value?: string; yParity?: string }) => void

  Returns void

validateTransactionWithSender

• validateTransactionWithSender(value: TransactionWithSenderAPI): void

• Parameters

  • value: TransactionWithSenderAPI

  Returns void