Skip to main content

types

Index

Enumerations

Classes

Interfaces

Type Aliases

Variables

Enumerations

BlockTags

BlockTags:

EARLIEST

EARLIEST: earliest = "earliest"

FINALIZED

FINALIZED: finalized = "finalized"

LATEST

LATEST: latest = "latest"

PENDING

PENDING: pending = "pending"

SAFE

SAFE: safe = "safe"

Classes

abstractWeb3BaseProvider

Web3BaseProvider<API>:

Type parameters

constructor

[symbol]

  • get [symbol](): boolean

  • Returns boolean

abstractconnect

  • connect(): void

  • Returns void

abstractdisconnect

  • disconnect(code?: number, data?: string): void

  • Parameters

    • optionalcode: number
    • optionaldata: string

    Returns void

abstractgetStatus

abstracton

optionalabstractonce

optionalabstractremoveAllListeners

  • removeAllListeners(type: string): void

  • Parameters

    • type: string

    Returns void

abstractremoveListener

abstractrequest

abstractreset

  • reset(): void

  • Returns void

send

  • @deprecated

    Please use .request instead.

    Type parameters

    Parameters

    Returns void

sendAsync

abstractsupportsSubscriptions

  • supportsSubscriptions(): boolean

  • Returns boolean

staticisWeb3Provider

  • isWeb3Provider(provider: unknown): boolean

  • Parameters

    • provider: unknown

    Returns boolean

abstractWeb3BaseWallet

Web3BaseWallet<T>:

Type parameters

constructor

abstractadd

abstractclear

abstractcreate

abstractdecrypt

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

  • Parameters

    • encryptedWallet: KeyStore[]
    • password: string
    • optionaloptions: Record<string, unknown>

    Returns Promise<Web3BaseWallet<T>>

abstractencrypt

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

  • Parameters

    • password: string
    • optionaloptions: Record<string, unknown>

    Returns Promise<KeyStore[]>

abstractget

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

  • Parameters

    • addressOrIndex: string | number

    Returns undefined | T

abstractload

  • Parameters

    • password: string
    • optionalkeyName: string

    Returns Promise<Web3BaseWallet<T>>

abstractremove

  • remove(addressOrIndex: string | number): boolean

  • Parameters

    • addressOrIndex: string | number

    Returns boolean

abstractsave

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

  • Parameters

    • password: string
    • optionalkeyName: string

    Returns Promise<boolean>

Interfaces

AbiCoderStruct

AbiCoderStruct:

optionalcomponents

components?: AbiStruct[]

optionalname

name?: string

type

type: string

AbiStruct

AbiStruct:

optionalname

name?: string

type

type: string

AccessListEntry

AccessListEntry:

optionalreadonlyaddress

address?: string

optionalreadonlystorageKeys

storageKeys?: string[]

AccountObject

AccountObject:

readonlyaccountProof

accountProof: Bytes[]

readonlybalance

balance: Numbers

readonlycodeHash

codeHash: Bytes

readonlynonce

nonce: Numbers

readonlystorageHash

storageHash: Bytes

readonlystorageProof

storageProof: StorageProof[]

BaseTransactionAPI

BaseTransactionAPI:

optionalreadonlychainId

chainId?: string

optionalreadonlydata

data?: string

readonlygas

gas: string

optionalreadonlyhash

hash?: string

readonlyinput

input: string

readonlynonce

nonce: string

optionalreadonlyto

to?: null | string

readonlytype

type: string

readonlyvalue

value: string

BlockBase

BlockBase<ByteType, HexStringType, NumberType, extraDataType, TransactionTypes, logsBloomType>:

Type parameters

  • ByteType
  • HexStringType
  • NumberType
  • extraDataType
  • TransactionTypes
  • logsBloomType

optionalreadonlybaseFeePerGas

baseFeePerGas?: NumberType

optionalreadonlydifficulty

difficulty?: NumberType

readonlyextraData

extraData: extraDataType

readonlygasLimit

gasLimit: NumberType

readonlygasUsed

gasUsed: NumberType

optionalreadonlyhash

hash?: ByteType

optionalreadonlylogsBloom

logsBloom?: logsBloomType

readonlyminer

miner: HexStringType

readonlymixHash

mixHash: ByteType

readonlynonce

nonce: NumberType

readonlynumber

number: NumberType

readonlyparentHash

parentHash: ByteType

readonlyreceiptsRoot

receiptsRoot: ByteType

readonlysha3Uncles

sha3Uncles: ByteType

readonlysize

size: NumberType

readonlystateRoot

stateRoot: ByteType

readonlytimestamp

timestamp: NumberType

readonlytotalDifficulty

totalDifficulty: NumberType

readonlytransactions

transactions: TransactionTypes

readonlytransactionsRoot

transactionsRoot: ByteType

readonlyuncles

uncles: Uncles

BlockHeaderOutput

BlockHeaderOutput:

optionalreadonlybaseFeePerGas

baseFeePerGas?: Numbers

optionalreadonlydifficulty

difficulty?: Numbers

readonlygasLimit

gasLimit: Numbers

readonlygasUsed

gasUsed: Numbers

optionalreadonlyminer

miner?: string

optionalreadonlynumber

number?: Numbers

optionalreadonlyparentHash

parentHash?: string

readonlysha3Uncles

sha3Uncles: string[]

readonlytimestamp

timestamp: Numbers

optionalreadonlytotalDifficulty

totalDifficulty?: Numbers

optionalreadonlytransactions

transactions?: TransactionOutput[]

BlockInput

BlockInput:

optionalreadonlybaseFeePerGas

baseFeePerGas?: string

optionalreadonlydifficulty

difficulty?: string

readonlygasLimit

gasLimit: string

readonlygasUsed

gasUsed: string

optionalreadonlyminer

miner?: string

optionalreadonlynumber

number?: string

readonlysize

size: string

readonlytimestamp

timestamp: string

optionalreadonlytotalDifficulty

totalDifficulty?: string

optionalreadonlytransactions

transactions?: TransactionInput[]

BlockOutput

BlockOutput:

optionalreadonlybaseFeePerGas

baseFeePerGas?: number | bigint

optionalreadonlydifficulty

difficulty?: number | bigint

readonlygasLimit

gasLimit: number | bigint

readonlygasUsed

gasUsed: number | bigint

optionalreadonlyminer

miner?: string

optionalreadonlynumber

number?: number | bigint

optionalreadonlyparentHash

parentHash?: string

readonlysize

size: number | bigint

readonlytimestamp

timestamp: number | bigint

optionalreadonlytotalDifficulty

totalDifficulty?: number | bigint

optionalreadonlytransactions

transactions?: TransactionOutput[]

Common

Common:

optionalbaseChain

baseChain?: ValidChains

customChain

customChain: CustomChain

optionalhardfork

hardfork?: Hardfork

CompileResultAPI

CompileResultAPI:

readonlycode

code: string

readonlyinfo

info: { abiDefinition: Record<string, unknown>[]; compilerVersion: string; developerDoc: { methods: Record<string, unknown> }; language: string; languageVersion: string; source: string; userDoc: { methods: Record<string, unknown> } }

Type declaration

  • readonlyabiDefinition: Record<string, unknown>[]
  • readonlycompilerVersion: string
  • readonlydeveloperDoc: { methods: Record<string, unknown> }
    • readonlymethods: Record<string, unknown>
  • readonlylanguage: string
  • readonlylanguageVersion: string
  • readonlysource: string
  • readonlyuserDoc: { methods: Record<string, unknown> }
    • readonlymethods: Record<string, unknown>

CustomChain

CustomChain:

chainId

chainId: Numbers

optionalname

name?: string

networkId

networkId: Numbers

DecodedParams

DecodedParams:

__length__

__length__: number

EIP1193Provider

EIP1193Provider<API>:

Type parameters

request

  • request<Method, ResponseType>(args: Web3APIPayload<API, Method>): Promise<unknown>

EthSubscription

EthSubscription:

readonlydata

data: { result: unknown; subscription: string }

Type declaration

  • readonlyresult: unknown
  • readonlysubscription: string

readonlytype

type: eth_subscription

FeeHistoryBase

FeeHistoryBase<NumberType>:

Type parameters

  • NumberType

readonlybaseFeePerGas

baseFeePerGas: NumberType

readonlygasUsedRatio

gasUsedRatio: NumberType[]

readonlyoldestBlock

oldestBlock: NumberType

readonlyreward

reward: NumberType[][]

Filter

Filter:

optionalreadonlyaddress

address?: string | string[]

optionalreadonlyfromBlock

fromBlock?: BlockNumberOrTag

optionalreadonlytoBlock

toBlock?: BlockNumberOrTag

optionalreadonlytopics

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

JsonRpcError

JsonRpcError<T>:

Type parameters

readonlycode

code: number

optionalreadonlydata

data?: T

readonlymessage

message: string

JsonRpcNotification

JsonRpcNotification<T>:

Type parameters

optionalreadonlyid

id?: JsonRpcId

readonlyjsonrpc

jsonrpc: JsonRpcIdentifier

readonlymethod

method: string

readonlyparams

params: SubscriptionParams<T>

readonlyresult

result: never

JsonRpcOptionalRequest

JsonRpcOptionalRequest<ParamType>:

Type parameters

  • ParamType = unknown[]

optionalreadonlyid

id?: JsonRpcId

optionalreadonlyjsonrpc

jsonrpc?: JsonRpcIdentifier

readonlymethod

method: string

optionalreadonlyparams

params?: ParamType

JsonRpcRequest

JsonRpcRequest<T>:

Type parameters

  • T = unknown[]

readonlyid

id: JsonRpcId

readonlyjsonrpc

jsonrpc: JsonRpcIdentifier

readonlymethod

method: string

optionalreadonlyparams

params?: T

JsonRpcResponseWithError

JsonRpcResponseWithError<Error>:

Type parameters

readonlyerror

error: JsonRpcError<Error>

readonlyid

id: JsonRpcId

readonlyjsonrpc

jsonrpc: JsonRpcIdentifier

optionalreadonlyresult

result?: undefined

JsonRpcResponseWithResult

JsonRpcResponseWithResult<T>:

Type parameters

optionalreadonlyerror

error?: undefined

readonlyid

id: JsonRpcId

readonlyjsonrpc

jsonrpc: JsonRpcIdentifier

readonlyresult

result: T

JsonRpcSubscriptionResult

JsonRpcSubscriptionResult:

readonlyid

id: number

readonlyjsonrpc

jsonrpc: string

readonlymethod

method: never

readonlyparams

params: never

readonlyresult

result: string

LegacyRequestProvider

LegacyRequestProvider:

request

LegacySendAsyncProvider

LegacySendAsyncProvider:

sendAsync

LegacySendProvider

LegacySendProvider:

send

Log

Log:

optionalreadonlyaddress

address?: string

optionalreadonlyblockHash

blockHash?: Bytes

optionalreadonlyblockNumber

blockNumber?: Numbers

optionalreadonlydata

data?: Bytes

optionalreadonlyid

id?: string

optionalreadonlylogIndex

logIndex?: Numbers

optionalreadonlyremoved

removed?: boolean

optionalreadonlytopics

topics?: Bytes[]

optionalreadonlytransactionHash

transactionHash?: Bytes

optionalreadonlytransactionIndex

transactionIndex?: Numbers

LogBase

LogBase<NumberType, ByteType>:

Type parameters

  • NumberType
  • ByteType

optionalreadonlyaddress

address?: string

optionalreadonlyblockHash

blockHash?: ByteType

optionalreadonlyblockNumber

blockNumber?: NumberType

optionalreadonlydata

data?: ByteType

optionalreadonlyid

id?: string

optionalreadonlylogIndex

logIndex?: NumberType

optionalreadonlyremoved

removed?: boolean

optionalreadonlytopics

topics?: ByteType[]

optionalreadonlytransactionHash

transactionHash?: ByteType

optionalreadonlytransactionIndex

transactionIndex?: NumberType

LogsInput

LogsInput:

readonlyaddress

address: string

optionalreadonlyblockHash

blockHash?: string

optionalreadonlyblockNumber

blockNumber?: string

readonlydata

data: string

optionalreadonlyid

id?: string

optionalreadonlylogIndex

logIndex?: string

readonlytopics

topics: string[]

optionalreadonlytransactionHash

transactionHash?: string

optionalreadonlytransactionIndex

transactionIndex?: string

LogsOutput

LogsOutput:

readonlyaddress

address: string

optionalreadonlyblockHash

blockHash?: string

optionalreadonlyblockNumber

blockNumber?: Numbers

readonlydata

data: string

optionalreadonlyid

id?: string

optionalreadonlylogIndex

logIndex?: Numbers

readonlyremoved

removed: boolean

readonlytopics

topics: string[]

optionalreadonlytransactionHash

transactionHash?: string

optionalreadonlytransactionIndex

transactionIndex?: Numbers

PopulatedUnsignedBaseTransaction

PopulatedUnsignedBaseTransaction:

chain

chain: ValidChains

chainId

chainId: Numbers

common

common: Common

from

from: string

optionalgas

gas?: Numbers

gasLimit

gasLimit: Numbers

gasPrice

gasPrice: Numbers

hardfork

hardfork: Hardfork

input

input: Bytes

networkId

networkId: Numbers

nonce

nonce: Numbers

optionalto

to?: string

type

type: Numbers

value

value: Numbers

PopulatedUnsignedEip1559Transaction

PopulatedUnsignedEip1559Transaction:

accessList

accessList: AccessList

chain

chain: ValidChains

chainId

chainId: Numbers

common

common: Common

from

from: string

optionalgas

gas?: Numbers

gasLimit

gasLimit: Numbers

gasPrice

gasPrice: never

hardfork

hardfork: Hardfork

input

input: Bytes

maxFeePerGas

maxFeePerGas: Numbers

maxPriorityFeePerGas

maxPriorityFeePerGas: Numbers

networkId

networkId: Numbers

nonce

nonce: Numbers

optionalto

to?: string

type

type: Numbers

value

value: Numbers

PopulatedUnsignedEip2930Transaction

PopulatedUnsignedEip2930Transaction:

accessList

accessList: AccessList

chain

chain: ValidChains

chainId

chainId: Numbers

common

common: Common

from

from: string

optionalgas

gas?: Numbers

gasLimit

gasLimit: Numbers

gasPrice

gasPrice: Numbers

hardfork

hardfork: Hardfork

input

input: Bytes

networkId

networkId: Numbers

nonce

nonce: Numbers

optionalto

to?: string

type

type: Numbers

value

value: Numbers

PostInput

PostInput:

optionalreadonlyexpiry

expiry?: string

optionalreadonlypriority

priority?: string

optionalreadonlysent

sent?: string

optionalreadonlytopics

topics?: string[]

optionalreadonlyttl

ttl?: string

optionalreadonlyworkProved

workProved?: string

optionalreadonlyworkToProve

workToProve?: string

PostOutput

PostOutput:

optionalreadonlyexpiry

expiry?: number | bigint

optionalreadonlypriority

priority?: number | bigint

optionalreadonlysent

sent?: number | bigint

optionalreadonlytopics

topics?: string[]

optionalreadonlyttl

ttl?: number | bigint

optionalreadonlyworkProved

workProved?: number | bigint

optionalreadonlyworkToProve

workToProve?: number | bigint

Proof

Proof:

readonlyaddress

address: string

readonlybalance

balance: string

readonlynonce

nonce: string

ProviderConnectInfo

ProviderConnectInfo:

readonlychainId

chainId: string

ProviderMessage

ProviderMessage:

readonlydata

data: unknown

readonlytype

type: string

ProviderRpcError

ProviderRpcError:

code

code: number

optionaldata

data?: unknown

ReceiptInput

ReceiptInput:

optionalreadonlyblockNumber

blockNumber?: string

optionalreadonlycontractAddress

contractAddress?: string

readonlycumulativeGasUsed

cumulativeGasUsed: string

optionalreadonlyeffectiveGasPrice

effectiveGasPrice?: string

readonlygasUsed

gasUsed: string

optionalreadonlylogs

logs?: LogsInput[]

optionalreadonlystatus

status?: string

optionalreadonlytransactionIndex

transactionIndex?: string

ReceiptOutput

ReceiptOutput:

optionalreadonlyblockNumber

blockNumber?: number | bigint

optionalreadonlycontractAddress

contractAddress?: string

readonlycumulativeGasUsed

cumulativeGasUsed: number | bigint

optionalreadonlyeffectiveGasPrice

effectiveGasPrice?: number | bigint

readonlygasUsed

gasUsed: number | bigint

optionalreadonlylogs

logs?: LogsOutput[]

readonlystatus

status: boolean

optionalreadonlytransactionIndex

transactionIndex?: number | bigint

SignedTransactionInfoAPI

SignedTransactionInfoAPI:

raw

raw: string

tx

tx: TransactionSignedAPI

SocketRequestItem

SocketRequestItem<API, Method, ResponseType>:

Type parameters

deferredPromise

deferredPromise: Web3DeferredPromiseInterface<ResponseType>

payload

payload: Web3APIPayload<API, Method>

StorageProof

StorageProof:

readonlykey

key: Bytes

readonlyproof

proof: Bytes[]

readonlyvalue

value: Numbers

SubscriptionParams

SubscriptionParams<T>:

Type parameters

readonlyresult

result: T

readonlysubscription

subscription: string

SyncInput

SyncInput:

readonlycurrentBlock

currentBlock: string

readonlyhighestBlock

highestBlock: string

optionalreadonlyknownStates

knownStates?: string

optionalreadonlypulledStates

pulledStates?: string

readonlystartingBlock

startingBlock: string

SyncOutput

SyncOutput:

readonlycurrentBlock

currentBlock: Numbers

readonlyhighestBlock

highestBlock: Numbers

optionalreadonlyknownStates

knownStates?: Numbers

optionalreadonlypulledStates

pulledStates?: Numbers

readonlystartingBlock

startingBlock: Numbers

Transaction

Transaction:

optionalaccessList

accessList?: AccessList

optionalchain

chain?: ValidChains

optionalchainId

chainId?: Numbers

optionalcommon

common?: Common

optionaldata

data?: Bytes

optionalfrom

from?: string

optionalgas

gas?: Numbers

optionalgasLimit

gasLimit?: Numbers

optionalgasPrice

gasPrice?: Numbers

optionalhardfork

hardfork?: Hardfork

optionalinput

input?: Bytes

optionalmaxFeePerGas

maxFeePerGas?: Numbers

optionalmaxPriorityFeePerGas

maxPriorityFeePerGas?: Numbers

optionalnetworkId

networkId?: Numbers

optionalnonce

nonce?: Numbers

optionalr

r?: Bytes

optionals

s?: Bytes

optionalto

to?: null | string

optionaltype

type?: Numbers

optionalv

v?: Numbers

optionalvalue

value?: Numbers

optionalyParity

yParity?: string

Transaction1559SignedAPI

Transaction1559SignedAPI:

readonlyaccessList

accessList: AccessList

optionalreadonlychainId

chainId?: string

optionalreadonlydata

data?: string

readonlygas

gas: string

optionalreadonlyhash

hash?: string

readonlyinput

input: string

readonlymaxFeePerGas

maxFeePerGas: string

readonlymaxPriorityFeePerGas

maxPriorityFeePerGas: string

readonlynonce

nonce: string

readonlyr

r: string

readonlys

s: string

optionalreadonlyto

to?: null | string

readonlytype

type: string

readonlyvalue

value: string

readonlyyParity

yParity: string

Transaction1559UnsignedAPI

Transaction1559UnsignedAPI:

readonlyaccessList

accessList: AccessList

optionalreadonlychainId

chainId?: string

optionalreadonlydata

data?: string

readonlygas

gas: string

optionalreadonlyhash

hash?: string

readonlyinput

input: string

readonlymaxFeePerGas

maxFeePerGas: string

readonlymaxPriorityFeePerGas

maxPriorityFeePerGas: string

readonlynonce

nonce: string

optionalreadonlyto

to?: null | string

readonlytype

type: string

readonlyvalue

value: string

Transaction2930SignedAPI

Transaction2930SignedAPI:

readonlyaccessList

accessList: AccessList

optionalreadonlychainId

chainId?: string

optionalreadonlydata

data?: string

readonlygas

gas: string

readonlygasPrice

gasPrice: string

optionalreadonlyhash

hash?: string

readonlyinput

input: string

readonlynonce

nonce: string

readonlyr

r: string

readonlys

s: string

optionalreadonlyto

to?: null | string

readonlytype

type: string

readonlyvalue

value: string

readonlyyParity

yParity: string

Transaction2930UnsignedAPI

Transaction2930UnsignedAPI:

readonlyaccessList

accessList: AccessList

optionalreadonlychainId

chainId?: string

optionalreadonlydata

data?: string

readonlygas

gas: string

readonlygasPrice

gasPrice: string

optionalreadonlyhash

hash?: string

readonlyinput

input: string

readonlynonce

nonce: string

optionalreadonlyto

to?: null | string

readonlytype

type: string

readonlyvalue

value: string

TransactionCall

TransactionCall:

optionalaccessList

accessList?: AccessList

optionalchain

chain?: ValidChains

optionalchainId

chainId?: Numbers

optionalcommon

common?: Common

optionaldata

data?: Bytes

optionalfrom

from?: string

optionalgas

gas?: Numbers

optionalgasLimit

gasLimit?: Numbers

optionalgasPrice

gasPrice?: Numbers

optionalhardfork

hardfork?: Hardfork

optionalinput

input?: Bytes

optionalmaxFeePerGas

maxFeePerGas?: Numbers

optionalmaxPriorityFeePerGas

maxPriorityFeePerGas?: Numbers

optionalnetworkId

networkId?: Numbers

optionalnonce

nonce?: Numbers

optionalr

r?: Bytes

optionals

s?: Bytes

to

to: string

optionaltype

type?: Numbers

optionalv

v?: Numbers

optionalvalue

value?: Numbers

optionalyParity

yParity?: string

TransactionCallAPI

TransactionCallAPI:

optionalreadonlyaccessList

accessList?: AccessList

optionalreadonlydata

data?: string

optionalreadonlyfrom

from?: string

optionalreadonlygas

gas?: string

optionalreadonlygasPrice

gasPrice?: string

optionalreadonlymaxFeePerGas

maxFeePerGas?: string

optionalreadonlymaxPriorityFeePerGas

maxPriorityFeePerGas?: string

readonlyto

to: string

optionalreadonlytype

type?: string

optionalreadonlyvalue

value?: string

TransactionForAccessList

TransactionForAccessList:

optionalaccessList

accessList?: AccessList

optionalchain

chain?: ValidChains

optionalchainId

chainId?: Numbers

optionalcommon

common?: Common

optionaldata

data?: Bytes

from

from: string

optionalgas

gas?: Numbers

optionalgasLimit

gasLimit?: Numbers

optionalgasPrice

gasPrice?: Numbers

optionalhardfork

hardfork?: Hardfork

optionalinput

input?: Bytes

optionalmaxFeePerGas

maxFeePerGas?: Numbers

optionalmaxPriorityFeePerGas

maxPriorityFeePerGas?: Numbers

optionalnetworkId

networkId?: Numbers

optionalnonce

nonce?: Numbers

optionalr

r?: Bytes

optionals

s?: Bytes

optionalto

to?: null | string

optionaltype

type?: Numbers

optionalv

v?: Numbers

optionalvalue

value?: Numbers

optionalyParity

yParity?: string

TransactionInfo

TransactionInfo:

optionalaccessList

accessList?: AccessList

optionalreadonlyblockHash

blockHash?: Bytes

optionalreadonlyblockNumber

blockNumber?: Numbers

optionalchain

chain?: ValidChains

optionalchainId

chainId?: Numbers

optionalcommon

common?: Common

optionaldata

data?: Bytes

readonlyfrom

from: string

optionalgas

gas?: Numbers

optionalgasLimit

gasLimit?: Numbers

optionalgasPrice

gasPrice?: Numbers

optionalhardfork

hardfork?: Hardfork

readonlyhash

hash: Bytes

optionalinput

input?: Bytes

optionalmaxFeePerGas

maxFeePerGas?: Numbers

optionalmaxPriorityFeePerGas

maxPriorityFeePerGas?: Numbers

optionalnetworkId

networkId?: Numbers

optionalnonce

nonce?: Numbers

optionalr

r?: Bytes

optionals

s?: Bytes

optionalto

to?: null | string

optionalreadonlytransactionIndex

transactionIndex?: Numbers

optionaltype

type?: Numbers

optionalv

v?: Numbers

optionalvalue

value?: Numbers

optionalyParity

yParity?: string

TransactionInput

TransactionInput:

optionalreadonlyblockNumber

blockNumber?: string

optionalreadonlychainId

chainId?: string

optionalreadonlydata

data?: string

optionalreadonlyfrom

from?: string

readonlygas

gas: string

optionalreadonlygasLimit

gasLimit?: string

optionalreadonlygasPrice

gasPrice?: string

optionalreadonlyinput

input?: string

optionalreadonlymaxFeePerGas

maxFeePerGas?: string

optionalreadonlymaxPriorityFeePerGas

maxPriorityFeePerGas?: string

readonlynonce

nonce: string

optionalreadonlyto

to?: string

optionalreadonlytransactionIndex

transactionIndex?: string

optionalreadonlytype

type?: string

readonlyvalue

value: string

TransactionLegacySignedAPI

TransactionLegacySignedAPI:

optionalreadonlychainId

chainId?: string

optionalreadonlydata

data?: string

readonlygas

gas: string

readonlygasPrice

gasPrice: string

optionalreadonlyhash

hash?: string

readonlyinput

input: string

readonlynonce

nonce: string

readonlyr

r: string

readonlys

s: string

optionalreadonlyto

to?: null | string

readonlytype

type: string

readonlyv

v: string

readonlyvalue

value: string

TransactionLegacyUnsignedAPI

TransactionLegacyUnsignedAPI:

optionalreadonlychainId

chainId?: string

optionalreadonlydata

data?: string

readonlygas

gas: string

readonlygasPrice

gasPrice: string

optionalreadonlyhash

hash?: string

readonlyinput

input: string

readonlynonce

nonce: string

optionalreadonlyto

to?: null | string

readonlytype

type: string

readonlyvalue

value: string

TransactionReceiptBase

TransactionReceiptBase<numberType, hashByteType, logsBloomByteType, logsType>:

Type parameters

  • numberType
  • hashByteType
  • logsBloomByteType
  • logsType

readonlyblockHash

blockHash: hashByteType

readonlyblockNumber

blockNumber: numberType

optionalreadonlycontractAddress

contractAddress?: string

readonlycumulativeGasUsed

cumulativeGasUsed: numberType

optionalreadonlyeffectiveGasPrice

effectiveGasPrice?: numberType

readonlyfrom

from: string

readonlygasUsed

gasUsed: numberType

readonlylogs

logs: logsType[]

readonlylogsBloom

logsBloom: logsBloomByteType

readonlyroot

root: hashByteType

readonlystatus

status: numberType

readonlyto

to: string

readonlytransactionHash

transactionHash: hashByteType

readonlytransactionIndex

transactionIndex: numberType

optionalreadonlytype

type?: numberType

TransactionWithFromAndToLocalWalletIndex

TransactionWithFromAndToLocalWalletIndex:

optionalaccessList

accessList?: AccessList

optionalchain

chain?: ValidChains

optionalchainId

chainId?: Numbers

optionalcommon

common?: Common

optionaldata

data?: Bytes

from

from: Numbers

optionalgas

gas?: Numbers

optionalgasLimit

gasLimit?: Numbers

optionalgasPrice

gasPrice?: Numbers

optionalhardfork

hardfork?: Hardfork

optionalinput

input?: Bytes

optionalmaxFeePerGas

maxFeePerGas?: Numbers

optionalmaxPriorityFeePerGas

maxPriorityFeePerGas?: Numbers

optionalnetworkId

networkId?: Numbers

optionalnonce

nonce?: Numbers

optionalr

r?: Bytes

optionals

s?: Bytes

to

to: Numbers

optionaltype

type?: Numbers

optionalv

v?: Numbers

optionalvalue

value?: Numbers

optionalyParity

yParity?: string

TransactionWithFromLocalWalletIndex

TransactionWithFromLocalWalletIndex:

optionalaccessList

accessList?: AccessList

optionalchain

chain?: ValidChains

optionalchainId

chainId?: Numbers

optionalcommon

common?: Common

optionaldata

data?: Bytes

from

from: Numbers

optionalgas

gas?: Numbers

optionalgasLimit

gasLimit?: Numbers

optionalgasPrice

gasPrice?: Numbers

optionalhardfork

hardfork?: Hardfork

optionalinput

input?: Bytes

optionalmaxFeePerGas

maxFeePerGas?: Numbers

optionalmaxPriorityFeePerGas

maxPriorityFeePerGas?: Numbers

optionalnetworkId

networkId?: Numbers

optionalnonce

nonce?: Numbers

optionalr

r?: Bytes

optionals

s?: Bytes

optionalto

to?: null | string

optionaltype

type?: Numbers

optionalv

v?: Numbers

optionalvalue

value?: Numbers

optionalyParity

yParity?: string

TransactionWithToLocalWalletIndex

TransactionWithToLocalWalletIndex:

optionalaccessList

accessList?: AccessList

optionalchain

chain?: ValidChains

optionalchainId

chainId?: Numbers

optionalcommon

common?: Common

optionaldata

data?: Bytes

optionalfrom

from?: string

optionalgas

gas?: Numbers

optionalgasLimit

gasLimit?: Numbers

optionalgasPrice

gasPrice?: Numbers

optionalhardfork

hardfork?: Hardfork

optionalinput

input?: Bytes

optionalmaxFeePerGas

maxFeePerGas?: Numbers

optionalmaxPriorityFeePerGas

maxPriorityFeePerGas?: Numbers

optionalnetworkId

networkId?: Numbers

optionalnonce

nonce?: Numbers

optionalr

r?: Bytes

optionals

s?: Bytes

to

to: Numbers

optionaltype

type?: Numbers

optionalv

v?: Numbers

optionalvalue

value?: Numbers

optionalyParity

yParity?: string

Web3APIPayload

Web3APIPayload<API, Method>:

Type parameters

optionalreadonlyid

id?: JsonRpcId

optionalreadonlyjsonrpc

jsonrpc?: JsonRpcIdentifier

method

method: string | Method

optionalparams

params?: object | readonly unknown[] | Web3APIParams<API, Method>

optionalreadonlyrequestOptions

requestOptions?: unknown

Web3APIRequest

Web3APIRequest<API, Method>:

Type parameters

method

method: string | Method

optionalparams

params?: object | Web3APIParams<API, Method> | readonly unknown[]

Web3AccountProvider

Web3AccountProvider<T>:

Type parameters

  • T

create

  • create(): T

  • Returns T

decrypt

  • decrypt(keystore: string | KeyStore, password: string, options?: Record<string, unknown>): Promise<T>

  • Parameters

    • keystore: string | KeyStore
    • password: string
    • optionaloptions: Record<string, unknown>

    Returns Promise<T>

privateKeyToAccount

  • privateKeyToAccount(privateKey: string): T

  • Parameters

    • privateKey: string

    Returns T

Web3BaseWalletAccount

Web3BaseWalletAccount:

readonlyaddress

address: string

readonlyprivateKey

privateKey: string

readonlyencrypt

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

  • 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 }

  • 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 }>

  • Parameters

    • tx: Record<string, unknown>

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

Web3DeferredPromiseInterface

Web3DeferredPromiseInterface<T>:

Type parameters

  • T

state

state: pending | fulfilled | rejected

reject

  • reject(reason?: unknown): void

  • Parameters

    • optionalreason: unknown

    Returns void

resolve

  • resolve(value: T | PromiseLike<T>): void

  • Parameters

    • value: T | PromiseLike<T>

    Returns void

startTimer

  • startTimer(): void

  • Returns void

Web3Error

Web3Error:

readonlycode

code: number

readonlyname

name: string

optionalreadonlystack

stack?: string

Type Aliases

AbiBaseFragment

AbiBaseFragment: { type: string | FragmentTypes }

Type declaration

  • readonlytype: string | FragmentTypes

AbiConstructorFragment

AbiConstructorFragment: AbiBaseFragment & { inputs?: ReadonlyArray<AbiParameter>; stateMutability: string | nonpayable | payable; type: string | constructor }

AbiErrorFragment

AbiErrorFragment: AbiBaseFragment & { inputs?: ReadonlyArray<AbiParameter>; name: string; type: string | error }

AbiEventFragment

AbiEventFragment: AbiBaseFragment & { anonymous?: boolean; inputs?: ReadonlyArray<AbiParameter>; name: string; type: string | event }

AbiFallbackFragment

AbiFallbackFragment: AbiBaseFragment & { constant?: boolean; inputs: never; name: never; outputs: never; payable?: boolean; stateMutability: string | nonpayable | payable | pure | view; type: string | fallback }

AbiFragment

AbiFragment: AbiConstructorFragment | AbiFunctionFragment | AbiEventFragment | AbiErrorFragment | AbiFallbackFragment

AbiFunctionFragment

AbiFunctionFragment: AbiBaseFragment & { constant?: boolean; inputs?: ReadonlyArray<AbiParameter>; name: string; outputs?: ReadonlyArray<AbiParameter>; payable?: boolean; stateMutability?: string | nonpayable | payable | pure | view; type: string | function }

AbiInput

AbiInput: string | AbiParameter | { components?: Components; index?: boolean; internalType?: string; name: string; type: string } | {}

AbiParameter

AbiParameter: { arrayChildren?: ReadonlyArray<AbiParameter>; arrayLength?: number; baseType?: string; components?: ReadonlyArray<AbiParameter>; indexed?: boolean; name: string; type: string }

Type declaration

  • optionalreadonlyarrayChildren?: ReadonlyArray<AbiParameter>
  • optionalreadonlyarrayLength?: number
  • optionalreadonlybaseType?: string
  • optionalreadonlycomponents?: ReadonlyArray<AbiParameter>
  • optionalreadonlyindexed?: boolean
  • readonlyname: string
  • readonlytype: string

AccessList

AccessList: AccessListEntry[]

AccessListResult

AccessListResult: { accessList?: AccessList; gasUsed?: Numbers }

Type declaration

Address

Address: HexString

ArrayToIndexObject

ArrayToIndexObject<T>: { [ K in IndexKeysForArray<T> ]: T[K] }

Type parameters

  • T: ReadonlyArray<unknown>

Block

Block: BlockBase<Bytes, Bytes, Numbers, Bytes, TransactionHash[] | TransactionInfo[], Bytes>

BlockAPI

BlockAPI: BlockBase<HexString32Bytes, HexString, Uint, HexStringBytes, TransactionHash[] | TransactionInfoAPI[], HexString256Bytes>

BlockNumberOrTag

BlockNumberOrTag: Numbers | BlockTag

BlockTag

BlockTag: `${BlockTags}`

Bytes

Bytes: Buffer | Uint8Array | ArrayBuffer | HexString

Cipher

Cipher: aes-128-ctr | aes-128-cbc | aes-256-cbc

CipherOptions

CipherOptions: { c?: number; dklen?: number; iv?: Buffer | string; kdf?: scrypt | pbkdf2; n?: number; p?: number; r?: number; salt?: Buffer | string }

Type declaration

  • optionalc?: number
  • optionaldklen?: number
  • optionaliv?: Buffer | string
  • optionalkdf?: scrypt | pbkdf2
  • optionaln?: number
  • optionalp?: number
  • optionalr?: number
  • optionalsalt?: Buffer | string

Components

Components: { components?: Components[]; indexed?: boolean; name: string; type: string }

Type declaration

  • optionalcomponents?: Components[]
  • optionalindexed?: boolean
  • name: string
  • type: string

ConnectionEvent

ConnectionEvent: { code: number; reason: string; wasClean?: boolean }

Type declaration

  • code: number
  • reason: string
  • optionalwasClean?: boolean

ContractAbi

ContractAbi: ReadonlyArray<AbiFragment>

ContractConstructor

ContractConstructor<Abis>: { [ Abi in FilterAbis<Abis, AbiConstructorFragment & { type: constructor }> as constructor ]: { Abi: Abi; Inputs: ContractMethodInputParameters<Abi[inputs]> } }[constructor]

Type parameters

ContractConstructorArgs

ContractConstructorArgs<Abis>: { [ Abi in FilterAbis<Abis, AbiConstructorFragment & { type: constructor }> as constructor ]: ContractMethodInputParameters<Abi[inputs]> }[constructor]

Type parameters

ContractEvent

ContractEvent<Abi>: { Abi: Abi; Inputs: ContractMethodInputParameters<Abi[inputs]> }

Type parameters

Type declaration

ContractEvents

ContractEvents<Abis>: { [ Abi in FilterAbis<Abis, AbiEventFragment & { type: event }> as Abi[name] ]: ContractEvent<Abi> }

Type parameters

ContractMethod

ContractMethod<Abi>: { Abi: Abi; Inputs: ContractMethodInputParameters<Abi[inputs]>; Outputs: ContractMethodOutputParameters<Abi[outputs]> }

Type parameters

Type declaration

ContractMethodInputParameters

ContractMethodInputParameters<Params>: Params extends readonly [] ? [] : Params extends readonly [infer H, ...infer R] ? H extends AbiParameter ? [MatchPrimitiveType<H[type], H[components]>, ...ContractMethodInputParameters<R>] : ContractMethodInputParameters<R> : Params extends undefined | unknown ? [] : Params

Type parameters

  • Params: ReadonlyArray<unknown> | undefined

ContractMethodOutputParameters

ContractMethodOutputParameters<Params>: Params extends readonly [] ? void : Params extends readonly [infer H, ...infer R] ? R extends readonly [] ? H extends AbiParameter ? MatchPrimitiveType<H[type], H[components]> : [] : ArrToObjectWithFunctions<[...ContractMethodOutputParametersRecursiveArray<Params>]> & ContractMethodOutputParametersRecursiveRecord<Params> : []

Type parameters

  • Params: ReadonlyArray<unknown> | undefined

ContractMethods

ContractMethods<Abis>: { [ Abi in FilterAbis<Abis, AbiFunctionFragment & { type: function }> as Abi[name] ]: ContractMethod<Abi> }

Type parameters

ConvertToNumber

ConvertToNumber<T, Range>: Range extends unknown ? `${Range}` extends T ? Range : never : never

Type parameters

  • T: string
  • Range: number = _SolidityIndexRange

EncodingTypes

EncodingTypes: Numbers | boolean | Numbers[] | boolean[]

EthExecutionAPI

EthExecutionAPI: { eth_accounts: any; eth_blockNumber: any; eth_call: any; eth_clearSubscriptions: any; eth_coinbase: any; eth_compileLLL: any; eth_compileSerpent: any; eth_compileSolidity: any; eth_estimateGas: any; eth_feeHistory: any; eth_gasPrice: any; eth_getBalance: any; eth_getBlockByHash: any; eth_getBlockByNumber: any; eth_getBlockTransactionCountByHash: any; eth_getBlockTransactionCountByNumber: any; eth_getCode: any; eth_getCompilers: any; eth_getFilterChanges: any; eth_getFilterLogs: any; eth_getLogs: any; eth_getStorageAt: any; eth_getTransactionByBlockHashAndIndex: any; eth_getTransactionByBlockNumberAndIndex: any; eth_getTransactionByHash: any; eth_getTransactionCount: any; eth_getTransactionReceipt: any; eth_getUncleByBlockHashAndIndex: any; eth_getUncleByBlockNumberAndIndex: any; eth_getUncleCountByBlockHash: any; eth_getUncleCountByBlockNumber: any; eth_getWork: any; eth_hashrate: any; eth_mining: any; eth_newBlockFilter: any; eth_newFilter: any; eth_newPendingTransactionFilter: any; eth_protocolVersion: any; eth_sendRawTransaction: any; eth_sendTransaction: any; eth_sign: any; eth_signTransaction: any; eth_submitHashrate: any; eth_submitWork: any; eth_subscribe: any; eth_syncing: any; eth_uninstallFilter: any; eth_unsubscribe: any }

Type declaration

  • eth_accounts: function
    • eth_accounts(): string[]

    • Returns string[]

  • eth_blockNumber: function
    • eth_blockNumber(): string

    • Returns string

  • eth_call: function
  • eth_clearSubscriptions: function
    • eth_clearSubscriptions(keepSyncing?: boolean): void

    • Parameters

      • optionalkeepSyncing: boolean

      Returns void

  • eth_coinbase: function
    • eth_coinbase(): string

    • Returns string

  • eth_compileLLL: function
    • eth_compileLLL(code: string): string

    • Parameters

      • code: string

      Returns string

  • eth_compileSerpent: function
    • eth_compileSerpent(code: string): string

    • Parameters

      • code: string

      Returns string

  • eth_compileSolidity: function
  • eth_estimateGas: function
  • eth_feeHistory: function
  • eth_gasPrice: function
    • eth_gasPrice(): string

    • Returns string

  • eth_getBalance: function
  • eth_getBlockByHash: function
    • eth_getBlockByHash(blockHash: string, hydrated: boolean): BlockAPI

    • Parameters

      • blockHash: string
      • hydrated: boolean

      Returns BlockAPI

  • eth_getBlockByNumber: function
  • eth_getBlockTransactionCountByHash: function
    • eth_getBlockTransactionCountByHash(blockHash: string): string

    • Parameters

      • blockHash: string

      Returns string

  • eth_getBlockTransactionCountByNumber: function
  • eth_getCode: function
  • eth_getCompilers: function
    • eth_getCompilers(): string[]

    • Returns string[]

  • eth_getFilterChanges: function
  • eth_getFilterLogs: function
  • eth_getLogs: function
  • eth_getStorageAt: function
    • eth_getStorageAt(address: string, storageSlot: string, blockNumber: BlockNumberOrTag): string

    • Parameters

      Returns string

  • eth_getTransactionByBlockHashAndIndex: function
    • eth_getTransactionByBlockHashAndIndex(blockHash: string, transactionIndex: string): undefined | TransactionInfoAPI
  • eth_getTransactionByBlockNumberAndIndex: function
  • eth_getTransactionByHash: function
  • eth_getTransactionCount: function
  • eth_getTransactionReceipt: function
  • eth_getUncleByBlockHashAndIndex: function
    • eth_getUncleByBlockHashAndIndex(blockHash: string, uncleIndex: string): BlockAPI

    • Parameters

      • blockHash: string
      • uncleIndex: string

      Returns BlockAPI

  • eth_getUncleByBlockNumberAndIndex: function
  • eth_getUncleCountByBlockHash: function
    • eth_getUncleCountByBlockHash(blockHash: string): string

    • Parameters

      • blockHash: string

      Returns string

  • eth_getUncleCountByBlockNumber: function
  • eth_getWork: function
    • eth_getWork(): [string, string, string]

    • Returns [string, string, string]

  • eth_hashrate: function
    • eth_hashrate(): string

    • Returns string

  • eth_mining: function
    • eth_mining(): boolean

    • Returns boolean

  • eth_newBlockFilter: function
    • eth_newBlockFilter(): string

    • Returns string

  • eth_newFilter: function
    • eth_newFilter(filter: Filter): string

    • Parameters

      Returns string

  • eth_newPendingTransactionFilter: function
    • eth_newPendingTransactionFilter(): string

    • Returns string

  • eth_protocolVersion: function
    • eth_protocolVersion(): string

    • Returns string

  • eth_sendRawTransaction: function
    • eth_sendRawTransaction(transaction: string): string

    • Parameters

      • transaction: string

      Returns string

  • eth_sendTransaction: function
  • eth_sign: function
    • eth_sign(address: string, message: string): string

    • Parameters

      • address: string
      • message: string

      Returns string

  • eth_signTransaction: function
  • eth_submitHashrate: function
    • eth_submitHashrate(hashRate: string, id: string): boolean

    • Parameters

      • hashRate: string
      • id: string

      Returns boolean

  • eth_submitWork: function
    • eth_submitWork(nonce: string, hash: string, digest: string): boolean

    • Parameters

      • nonce: string
      • hash: string
      • digest: string

      Returns boolean

  • eth_subscribe: function
    • eth_subscribe(...params: [newPendingTransactions] | [newHeads] | [syncing] | [logs, { address?: HexString; topics?: HexString[] }]): string

    • Parameters

      • rest...params: [newPendingTransactions] | [newHeads] | [syncing] | [logs, { address?: HexString; topics?: HexString[] }]

      Returns string

  • eth_syncing: function
  • eth_uninstallFilter: function
    • eth_uninstallFilter(filterIdentifier: string): boolean

    • Parameters

      • filterIdentifier: string

      Returns boolean

  • eth_unsubscribe: function
    • eth_unsubscribe(subscriptionId: string): string

    • Parameters

      • subscriptionId: string

      Returns string

EthPersonalAPI

EthPersonalAPI: { personal_ecRecover: any; personal_importRawKey: any; personal_listAccounts: any; personal_lockAccount: any; personal_newAccount: any; personal_sendTransaction: any; personal_sign: any; personal_signTransaction: any; personal_unlockAccount: any }

Type declaration

  • personal_ecRecover: function
    • personal_ecRecover(signedData: string, signature: string): string

    • Parameters

      • signedData: string
      • signature: string

      Returns string

  • personal_importRawKey: function
    • personal_importRawKey(keyData: string, passphrase: string): string

    • Parameters

      • keyData: string
      • passphrase: string

      Returns string

  • personal_listAccounts: function
    • personal_listAccounts(): string[]

    • Returns string[]

  • personal_lockAccount: function
    • personal_lockAccount(address: string): boolean

    • Parameters

      • address: string

      Returns boolean

  • personal_newAccount: function
    • personal_newAccount(password: string): string

    • Parameters

      • password: string

      Returns string

  • personal_sendTransaction: function
    • personal_sendTransaction(tx: Transaction, passphrase: string): string

    • Parameters

      Returns string

  • personal_sign: function
    • personal_sign(data: string, address: string, passphrase: string): string

    • Parameters

      • data: string
      • address: string
      • passphrase: string

      Returns string

  • personal_signTransaction: function
    • personal_signTransaction(tx: Transaction, passphrase: string): string

    • Parameters

      Returns string

  • personal_unlockAccount: function
    • personal_unlockAccount(address: string, password: string, unlockDuration: number): boolean

    • Parameters

      • address: string
      • password: string
      • unlockDuration: number

      Returns boolean

FeeHistory

FeeHistory: FeeHistoryBase<Numbers>

FeeHistoryResultAPI

FeeHistoryResultAPI: FeeHistoryBase<Uint>

FilterAbis

FilterAbis<Abis, Filter, Abi>: Abi extends Filter ? Abi : never

Type parameters

FilterResultsAPI

FilterResultsAPI: HexString32Bytes[] | LogAPI[]

FixedSizeArray

FixedSizeArray<T, N>: GrowToSize<T, [], N>

Type parameters

  • T
  • N: number

GrowToSize

GrowToSize<T, A, N>: { 0: A; 1: GrowToSize<T, _Grow<T, A>, N> }[A[length] extends N ? 0 : 1]

Type parameters

  • T
  • A: T[]
  • N: number

Hardfork

Hardfork: arrowGlacier | berlin | byzantium | chainstart | constantinople | dao | homestead | istanbul | london | merge | muirGlacier | petersburg | shanghai | spuriousDragon | tangerineWhistle

HexString

HexString: string

HexString16Bytes

HexString16Bytes: HexString

HexString256Bytes

HexString256Bytes: HexString

HexString32Bytes

HexString32Bytes: HexString

HexString8Bytes

HexString8Bytes: HexString

HexStringBytes

HexStringBytes: HexString

HexStringSingleByte

HexStringSingleByte: HexString

IndexKeysForArray

IndexKeysForArray<A>: Exclude<keyof A, keyof []>

Type parameters

  • A: readonly unknown[]

JsonEventInterface

JsonEventInterface: { anonymous: boolean; indexed: boolean; inputs: Components[]; name: string; type: event }

Type declaration

  • anonymous: boolean
  • indexed: boolean
  • inputs: Components[]
  • name: string
  • type: event

JsonFunctionInterface

JsonFunctionInterface: { inputs: Components[]; name: string; outputs?: AbiInput[]; stateMutability?: string; type: function }

Type declaration

  • inputs: Components[]
  • name: string
  • optionaloutputs?: AbiInput[]
  • optionalstateMutability?: string
  • type: function

JsonRpcBatchRequest

JsonRpcBatchRequest: JsonRpcRequest[]

JsonRpcBatchResponse

JsonRpcBatchResponse<Result, Error>: (JsonRpcResponseWithError<Error> | JsonRpcResponseWithResult<Result>)[]

Type parameters

JsonRpcId

JsonRpcId: string | number | undefined

JsonRpcIdentifier

JsonRpcIdentifier: string & (2.0 | 1.0)

JsonRpcPayload

JsonRpcPayload<Param>: JsonRpcRequest<Param> | JsonRpcBatchRequest

Type parameters

  • Param = unknown[]

JsonRpcResponse

JsonRpcResponse<Result, Error>: JsonRpcResponseWithError<Error> | JsonRpcResponseWithResult<Result> | JsonRpcBatchResponse<Result, Error>

Type parameters

JsonRpcResult

JsonRpcResult: string | number | boolean | Record<string, unknown>

KeyStore

KeyStore: { address: string; crypto: { cipher: Cipher; cipherparams: { iv: string }; ciphertext: string; kdf: pbkdf2 | scrypt; kdfparams: ScryptParams | PBKDF2SHA256Params; mac: HexString }; id: string; version: 3 }

Type declaration

LogAPI

LogAPI: LogBase<Uint, HexString32Bytes>

MatchPrimitiveType

MatchPrimitiveType<Type, TypeComponents>: PrimitiveAddressType<Type> | PrimitiveStringType<Type> | PrimitiveBooleanType<Type> | PrimitiveIntegerType<Type> | PrimitiveBytesType<Type> | PrimitiveTupleType<Type, TypeComponents> | never

Type parameters

  • Type: string
  • TypeComponents: ReadonlyArray<AbiParameter> | undefined

Mutable

Mutable<T>: { -readonly [ P in keyof T ]: T[P] }

Type parameters

  • T

Numbers

Numbers: number | bigint | string | HexString

Optional

Optional<T, K>: Pick<Partial<T>, K> & Omit<T, K>

Type parameters

  • T
  • K: keyof T

PBKDF2SHA256Params

PBKDF2SHA256Params: { c: number; dklen: number; prf: hmac-sha256; salt: Buffer | string }

Type declaration

  • c: number
  • dklen: number
  • prf: hmac-sha256
  • salt: Buffer | string

PopulatedUnsignedTransaction

PopulatedUnsignedTransaction: PopulatedUnsignedBaseTransaction | PopulatedUnsignedEip2930Transaction | PopulatedUnsignedEip1559Transaction

PrimitiveAddressType

PrimitiveAddressType<Type>: Type extends `address[${infer Size}]` ? _TypedArray<Address, Size> : Type extends address ? Address : never

Type parameters

  • Type: string

PrimitiveBooleanType

PrimitiveBooleanType<Type>: Type extends `bool[${infer Size}]` ? _TypedArray<boolean, Size> : Type extends bool ? boolean : never

Type parameters

  • Type: string

PrimitiveBytesType

PrimitiveBytesType<Type>: Type extends `bytes${string}[${infer Size}]` ? _TypedArray<Bytes, Size> : Type extends bytes | `bytes${string}` ? Bytes : never

Type parameters

  • Type: string

PrimitiveIntegerType

PrimitiveIntegerType<Type>: Type extends `uint${string}[${infer Size}]` | `int${string}[${infer Size}]` ? _TypedArray<Numbers, Size> : Type extends uint | int | `int${string}` | `uint${string}` ? Numbers : never

Type parameters

  • Type: string

PrimitiveStringType

PrimitiveStringType<Type>: Type extends `string${string}[${infer Size}]` ? _TypedArray<string, Size> : Type extends string | `string${string}` ? string : never

Type parameters

  • Type: string

PrimitiveTupleType

PrimitiveTupleType<Type, TypeComponents>: TypeComponents extends ReadonlyArray<AbiParameter> ? Type extends tuple ? { [ Param in TypeComponents[number] as Param[name] ]: MatchPrimitiveType<Param[type], Param[components]> } : Type extends `tuple[${infer Size}]` ? _TypedArray<{ [ Param in TypeComponents[number] as Param[name] ]: MatchPrimitiveType<Param[type], Param[components]> }, Size> : never : never

Type parameters

  • Type: string
  • TypeComponents: ReadonlyArray<AbiParameter> | undefined = []

Receipt

Receipt: Record<string, unknown>

ScryptParams

ScryptParams: { dklen: number; n: number; p: number; r: number; salt: Buffer | string }

Type declaration

  • dklen: number
  • n: number
  • p: number
  • r: number
  • salt: Buffer | string

Sha3Input

Sha3Input: TypedObject | TypedObjectAbbreviated | Numbers | boolean | object

SupportedProviders

SupportedProviders<API>: EIP1193Provider<API> | Web3BaseProvider<API> | LegacyRequestProvider | LegacySendProvider | LegacySendAsyncProvider

Type parameters

SyncingStatusAPI

SyncingStatusAPI: { currentBlock: Uint; highestBlock: Uint; startingBlock: Uint } | boolean

Topic

Topic: HexString32Bytes

TransactionHash

TransactionHash: HexString

TransactionInfoAPI

TransactionInfoAPI: TransactionSignedAPI & { blockHash?: HexString32Bytes; blockNumber?: Uint; from: Address; hash: HexString32Bytes; transactionIndex?: Uint }

TransactionOutput

TransactionOutput: { blockNumber?: Numbers; from?: HexString; gas?: Numbers; gasLimit?: string; input: string; nonce: Numbers; to?: HexString; transactionIndex?: Numbers; value: Numbers } & ({ gasPrice?: never; maxFeePerGas: Numbers; maxPriorityFeePerGas: Numbers } | { gasPrice: Numbers; maxFeePerGas?: never; maxPriorityFeePerGas?: never })

TransactionReceipt

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

TransactionReceiptAPI

TransactionReceiptAPI: TransactionReceiptBase<Uint, HexString32Bytes, HexString256Bytes, LogAPI>

TransactionSignedAPI

TransactionSignedAPI: Transaction1559SignedAPI | Transaction2930SignedAPI | TransactionLegacySignedAPI

TransactionUnsignedAPI

TransactionUnsignedAPI: Transaction1559UnsignedAPI | Transaction2930UnsignedAPI | TransactionLegacyUnsignedAPI

TransactionWithSenderAPI

TransactionWithSenderAPI: TransactionUnsignedAPI & { from: Address }

TypedObject

TypedObject: { type: string; value: EncodingTypes }

Type declaration

TypedObjectAbbreviated

TypedObjectAbbreviated: { t: string; v: EncodingTypes }

Type declaration

Uint

Uint: HexString

Uint256

Uint256: HexString

Uncles

Uncles: HexString32Bytes[]

ValidChains

ValidChains: goerli | kovan | mainnet | rinkeby | ropsten | sepolia

ValueTypes

ValueTypes: address | bool | string | int256 | uint256 | bytes | bigint

Web3APIMethod

Web3APIMethod<T>: string & keyof Exclude<T, unknown>

Type parameters

Web3APIParams

Web3APIParams<API, Method>: API extends Exclude<Web3APISpec, unknown> ? Parameters<API[Method]> : unknown

Type parameters

Web3APIReturnType

Web3APIReturnType<API, Method>: API extends Record<string, (...params: any) => any> ? ReturnType<API[Method]> : any

Type parameters

Web3APISpec

Web3APISpec: Record<string, (...params: any) => any> | unknown

Web3BaseProviderConstructor

Web3BaseProviderConstructor: new <API>(url: string, net?: Socket) => Web3BaseProvider<API>

Type declaration

Web3EthExecutionAPI

Web3EthExecutionAPI: EthExecutionAPI & { eth_chainId: any; eth_getProof: any; eth_pendingTransactions: any; eth_requestAccounts: any; web3_clientVersion: any }

Web3NetAPI

Web3NetAPI: { net_listening: any; net_peerCount: any; net_version: any }

Type declaration

  • net_listening: function
    • net_listening(): boolean

    • Returns boolean

  • net_peerCount: function
    • net_peerCount(): string

    • Returns string

  • net_version: function
    • net_version(): string

    • Returns string

Web3ProviderEventCallback

Web3ProviderEventCallback<T>: (error: Error | ProviderRpcError | undefined, result?: JsonRpcSubscriptionResult | JsonRpcNotification<T>) => void

Type parameters

Type declaration

Web3ProviderRequestCallback

Web3ProviderRequestCallback<ResultType>: (err?: Error | Web3Error | null | JsonRpcResponseWithError<Error>, response?: JsonRpcResponseWithResult<ResultType>) => void

Type parameters

  • ResultType = unknown

Type declaration

Web3ProviderStatus

Web3ProviderStatus: connecting | connected | disconnected

Variables

constTypedArray

TypedArray: any