Skip to main content

types

Index

References

Enumerations

Classes

Interfaces

Type Aliases

Variables

References

ContractAbiWithSignature

Re-exports ContractAbiWithSignature

ContractOptions

Re-exports ContractOptions

EventLog

Re-exports EventLog

SignResult

Re-exports SignResult

SignTransactionResult

Re-exports SignTransactionResult

SignatureObject

Re-exports SignatureObject

Enumerations

BlockTags

BlockTags:

COMMITTED

COMMITTED: committed

EARLIEST

EARLIEST: earliest

FINALIZED

FINALIZED: finalized

LATEST

LATEST: latest

PENDING

PENDING: pending

SAFE

SAFE: safe

FMT_BYTES

FMT_BYTES:

HEX

HEX: BYTES_HEX

UINT8ARRAY

UINT8ARRAY: BYTES_UINT8ARRAY

FMT_NUMBER

FMT_NUMBER:

BIGINT

BIGINT: NUMBER_BIGINT

HEX

HEX: NUMBER_HEX

NUMBER

NUMBER: NUMBER_NUMBER

STR

STR: NUMBER_STR

HardforksOrdered

HardforksOrdered:

altair

altair: altair

arrowGlacier

arrowGlacier: arrowGlacier

bellatrix

bellatrix: bellatrix

berlin

berlin: berlin

byzantium

byzantium: byzantium

capella

capella: capella

chainstart

chainstart: chainstart

constantinople

constantinople: constantinople

dao

dao: dao

frontier

frontier: frontier

grayGlacier

grayGlacier: grayGlacier

homestead

homestead: homestead

istanbul

istanbul: istanbul

london

london: london

merge

merge: merge

muirGlacier

muirGlacier: muirGlacier

petersburg

petersburg: petersburg

shanghai

shanghai: shanghai

spuriousDragon

spuriousDragon: spuriousDragon

tangerineWhistle

tangerineWhistle: tangerineWhistle

Classes

abstractWeb3BaseProvider

Web3BaseProvider<API>:

Type parameters

constructor

[symbol]

  • get [symbol](): boolean

  • Returns boolean

asEIP1193Provider

  • Modify the return type of the request method to be fully compatible with EIP-1193

    [deprecated] In the future major releases (&gt;= v5) all providers are supposed to be fully compatible with EIP-1193. So this method will not be needed and would not be available in the future.

    @example
    const provider = new Web3HttpProvider('http://localhost:8545');
    const fullyCompatibleProvider = provider.asEIP1193Provider();
    const result = await fullyCompatibleProvider.request({ method: 'eth_getBalance' });
    console.log(result); // '0x0234c8a3397aab58' or something like that

    Returns Eip1193Compatible<API>

    A new instance of the provider with the request method fully compatible with EIP-1193

abstractconnect

  • connect(): void

  • Returns void

abstractdisconnect

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

  • Parameters

    • optionalcode: number
    • optionaldata: string

    Returns void

abstractgetStatus

abstracton

abstractonce

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

  • add(account: string | T): this

  • Parameters

    • account: string | T

    Returns this

abstractclear

  • clear(): this

  • Returns this

abstractcreate

  • create(numberOfAccounts: number): this

  • Parameters

    • numberOfAccounts: number

    Returns this

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

name

name: string

type

type: string

AbiOutput

AbiOutput:

optionalcomponents

components?: AbiOutput[]

optionalinternalType

internalType?: string

name

name: string

type

type: string

AbiStruct

AbiStruct:

name

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:

optionalreadonlyauthor

author?: string

optionalreadonlybaseFeePerGas

baseFeePerGas?: Numbers

optionalreadonlyblobGasUsed

blobGasUsed?: Numbers

optionalreadonlydifficulty

difficulty?: Numbers

optionalreadonlyexcessBlobGas

excessBlobGas?: Numbers

optionalreadonlyexcessDataGas

excessDataGas?: Numbers

optionalreadonlyextraData

extraData?: Bytes

readonlygasLimit

gasLimit: Numbers

readonlygasUsed

gasUsed: Numbers

optionalreadonlyhash

hash?: string

optionalreadonlylogsBloom

logsBloom?: Bytes

optionalreadonlyminer

miner?: string

optionalreadonlymixHash

mixHash?: string

optionalreadonlynonce

nonce?: Numbers

optionalreadonlynumber

number?: Numbers

optionalreadonlyparentBeaconBlockRoot

parentBeaconBlockRoot?: string

optionalreadonlyparentHash

parentHash?: string

optionalreadonlyreceiptsRoot

receiptsRoot?: string

readonlysha3Uncles

sha3Uncles: string[]

optionalreadonlysize

size?: Numbers

optionalreadonlystateRoot

stateRoot?: string

readonlytimestamp

timestamp: Numbers

optionalreadonlytotalDifficulty

totalDifficulty?: Numbers

optionalreadonlytransactions

transactions?: TransactionOutput[]

optionalreadonlytransactionsRoot

transactionsRoot?: string

optionalreadonlyuncles

uncles?: Uncles

optionalreadonlywithdrawals

withdrawals?: Withdrawals[]

optionalreadonlywithdrawalsRoot

withdrawalsRoot?: string

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

optionalreadonlyblobGasUsed

blobGasUsed?: number | bigint

optionalreadonlydifficulty

difficulty?: number | bigint

optionalreadonlyexcessBlobGas

excessBlobGas?: number | bigint

optionalreadonlyextraData

extraData?: Bytes

readonlygasLimit

gasLimit: number | bigint

readonlygasUsed

gasUsed: number | bigint

optionalreadonlyhash

hash?: string

optionalreadonlylogsBloom

logsBloom?: Bytes

optionalreadonlyminer

miner?: string

optionalreadonlymixHash

mixHash?: string

optionalreadonlynonce

nonce?: number | bigint

optionalreadonlynumber

number?: number | bigint

optionalreadonlyparentBeaconBlockRoot

parentBeaconBlockRoot?: string

optionalreadonlyparentHash

parentHash?: string

optionalreadonlyreceiptsRoot

receiptsRoot?: string

readonlysha3Uncles

sha3Uncles: string[]

readonlysize

size: number | bigint

optionalreadonlystateRoot

stateRoot?: string

readonlytimestamp

timestamp: number | bigint

optionalreadonlytotalDifficulty

totalDifficulty?: number | bigint

optionalreadonlytransactions

transactions?: TransactionOutput[]

optionalreadonlytransactionsRoot

transactionsRoot?: string

optionalreadonlyuncles

uncles?: Uncles

optionalreadonlywithdrawals

withdrawals?: Withdrawals[]

optionalreadonlywithdrawalsRoot

withdrawalsRoot?: string

Common

Common:

optionalbaseChain

baseChain?: ValidChains

customChain

customChain: CustomChain

optionalhardfork

hardfork?: chainstart | frontier | homestead | dao | tangerineWhistle | spuriousDragon | byzantium | constantinople | petersburg | istanbul | muirGlacier | berlin | london | altair | arrowGlacier | grayGlacier | bellatrix | merge | capella | shanghai

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>

ContractInitOptions

ContractInitOptions:

optionalreadonlydata

data?: Bytes

The byte code of the contract. Used when the contract gets deployed

optionalreadonlydataInputFill

dataInputFill?: input | data | both

optionalreadonlyfrom

from?: string

The address transactions should be made from

optionalreadonlygas

gas?: string

The maximum gas provided for a transaction (gas limit).

optionalreadonlygasLimit

gasLimit?: string

optionalreadonlygasPrice

gasPrice?: string

The gas price in wei to use for transactions.

optionalreadonlyinput

input?: Bytes

optionalreadonlyprovider

provider?: string | SupportedProviders<EthExecutionAPI>

optionalreadonlysyncWithContext

syncWithContext?: boolean

If true, the defaults of the contract instance will be updated automatically based on the changes of the context used to instantiate the contract.

CustomChain

CustomChain:

chainId

chainId: Numbers

optionalname

name?: string

networkId

networkId: Numbers

DecodedParams

DecodedParams:

__length__

__length__: number

EIP1193Provider

EIP1193Provider<API>:

Type parameters

on

  • on(event: connect, listener: (info: ProviderInfo) => void): void
  • on(event: disconnect, listener: (error: ProviderRpcError) => void): void
  • on(event: message, listener: (message: ProviderMessage) => void): void
  • on(event: chainChanged, listener: (chainId: string) => void): void
  • on(event: accountsChanged, listener: (accounts: ProviderAccounts) => void): void

  • Parameters

    Returns void

removeListener

  • removeListener(event: connect, listener: (info: ProviderInfo) => void): void
  • removeListener(event: disconnect, listener: (error: ProviderRpcError) => void): void
  • removeListener(event: message, listener: (message: ProviderMessage) => void): void
  • removeListener(event: chainChanged, listener: (chainId: string) => void): void
  • removeListener(event: accountsChanged, listener: (accounts: ProviderAccounts) => void): void

  • Parameters

    Returns void

request

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

  • Type parameters

    Parameters

    Returns Promise<unknown>

Eip712TypeDetails

Eip712TypeDetails:

name

name: string

type

type: string

Eip712TypedData

Eip712TypedData:

readonlydomain

domain: Record<string, string | number>

readonlymessage

message: Record<string, unknown>

readonlyprimaryType

primaryType: string

readonlytypes

types: { EIP712Domain: Eip712TypeDetails[] }

Type declaration

EthSubscription

EthSubscription:

readonlydata

data: { result: unknown; subscription: string }

Type declaration

  • readonlyresult: unknown
  • readonlysubscription: string

readonlytype

type: eth_subscription

FeeData

FeeData:

To contain the gas Fee Data to be used with EIP-1559 transactions. EIP-1559 was applied to Ethereum after London hardfork.

Typically you will only need maxFeePerGas and maxPriorityFeePerGas for a transaction following EIP-1559. However, if you want to get informed about the fees of last block, you can use baseFeePerGas too.

@see

https://eips.ethereum.org/EIPS/eip-1559

optionalreadonlybaseFeePerGas

baseFeePerGas?: Numbers

The baseFeePerGas returned from the last available block.

If EIP-1559 is not supported, this will be undefined

However, the user will only pay (the future baseFeePerGas + the maxPriorityFeePerGas). And this value is just for getting informed about the fees of last block.

optionalreadonlygasPrice

gasPrice?: Numbers

This filed is used for legacy networks that does not support EIP-1559.

optionalreadonlymaxFeePerGas

maxFeePerGas?: Numbers

The maximum fee that the user would be willing to pay per-gas.

However, the user will only pay (the future baseFeePerGas + the maxPriorityFeePerGas). And the maxFeePerGas could be used to prevent paying more than it, if baseFeePerGas went too high.

If EIP-1559 is not supported, this will be undefined

optionalreadonlymaxPriorityFeePerGas

maxPriorityFeePerGas?: Numbers

The validator's tip for including a transaction in a block.

If EIP-1559 is not supported, this will be undefined

FeeHistoryBase

FeeHistoryBase<NumberType>:

Type parameters

  • NumberType

readonlybaseFeePerGas

baseFeePerGas: NumberType[]

readonlygasUsedRatio

gasUsedRatio: NumberType[]

readonlyoldestBlock

oldestBlock: NumberType

readonlyreward

reward: NumberType[][]

Filter

Filter:

optionalreadonlyaddress

address?: string | string[]

optionalreadonlyblockHash

blockHash?: string

optionalreadonlyfilter

filter?: FilterOption

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

optionalreadonlydata

data?: undefined

optionalreadonlyerror

error?: undefined

optionalreadonlyid

id?: JsonRpcId

readonlyjsonrpc

jsonrpc: JsonRpcIdentifier

readonlymethod

method: string

readonlyparams

params: SubscriptionParams<T>

optionalreadonlyresult

result?: undefined

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:

optionalreadonlydata

data?: undefined

readonlyid

id: number

readonlyjsonrpc

jsonrpc: string

readonlymethod

method: never

readonlyparams

params: never

readonlyresult

result: string

JsonRpcSubscriptionResultOld

JsonRpcSubscriptionResultOld<T>:

Type parameters

readonlydata

data: SubscriptionParams<T>

optionalreadonlyerror

error?: undefined

optionalreadonlyparams

params?: undefined

readonlytype

type: 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

MetaMaskProvider

MetaMaskProvider<API>:

Type parameters

isMetaMask

isMetaMask: boolean

on

  • on(event: connect, listener: (info: ProviderInfo) => void): void
  • on(event: disconnect, listener: (error: ProviderRpcError) => void): void
  • on(event: message, listener: (message: ProviderMessage) => void): void
  • on(event: chainChanged, listener: (chainId: string) => void): void
  • on(event: accountsChanged, listener: (accounts: ProviderAccounts) => void): void

  • Parameters

    Returns void

removeListener

  • removeListener(event: connect, listener: (info: ProviderInfo) => void): void
  • removeListener(event: disconnect, listener: (error: ProviderRpcError) => void): void
  • removeListener(event: message, listener: (message: ProviderMessage) => void): void
  • removeListener(event: chainChanged, listener: (chainId: string) => void): void
  • removeListener(event: accountsChanged, listener: (accounts: ProviderAccounts) => void): void

  • Parameters

    Returns void

request

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

  • Type parameters

    Parameters

    Returns Promise<unknown>

NonPayableCallOptions

NonPayableCallOptions:

optionaldata

data?: string

optionalfrom

from?: string

The address which is the call (the transaction) should be made from. For calls the from property is optional however it is highly recommended to explicitly set it or it may default to address(0) depending on your node or provider.

optionalgas

gas?: string

The maximum gas (gas limit) provided for this call (this transaction)

optionalgasPrice

gasPrice?: string

The gas price in wei to use for this call transaction.

optionalinput

input?: string

optionalmaxFeePerGas

maxFeePerGas?: string

optionalmaxPriorityFeePerGas

maxPriorityFeePerGas?: string

optionalnonce

nonce?: string

optionaltype

type?: string | number

PayableCallOptions

PayableCallOptions:

optionaldata

data?: string

optionalfrom

from?: string

The address which is the call (the transaction) should be made from. For calls the from property is optional however it is highly recommended to explicitly set it or it may default to address(0) depending on your node or provider.

optionalgas

gas?: string

The maximum gas (gas limit) provided for this call (this transaction)

optionalgasPrice

gasPrice?: string

The gas price in wei to use for this call transaction.

optionalinput

input?: string

optionalmaxFeePerGas

maxFeePerGas?: string

optionalmaxPriorityFeePerGas

maxPriorityFeePerGas?: string

optionalnonce

nonce?: string

optionaltype

type?: string | number

optionalvalue

value?: string

PopulatedUnsignedBaseTransaction

PopulatedUnsignedBaseTransaction:

chain

chain: ValidChains

chainId

chainId: Numbers

common

common: Common

optionaldata

data?: Bytes

from

from: string

optionalgas

gas?: Numbers

gasLimit

gasLimit: Numbers

gasPrice

gasPrice: Numbers

hardfork

hardfork: chainstart | frontier | homestead | dao | tangerineWhistle | spuriousDragon | byzantium | constantinople | petersburg | istanbul | muirGlacier | berlin | london | altair | arrowGlacier | grayGlacier | bellatrix | merge | capella | shanghai

optionalinput

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

optionaldata

data?: Bytes

from

from: string

optionalgas

gas?: Numbers

gasLimit

gasLimit: Numbers

gasPrice

gasPrice: never

hardfork

hardfork: chainstart | frontier | homestead | dao | tangerineWhistle | spuriousDragon | byzantium | constantinople | petersburg | istanbul | muirGlacier | berlin | london | altair | arrowGlacier | grayGlacier | bellatrix | merge | capella | shanghai

optionalinput

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

optionaldata

data?: Bytes

from

from: string

optionalgas

gas?: Numbers

gasLimit

gasLimit: Numbers

gasPrice

gasPrice: Numbers

hardfork

hardfork: chainstart | frontier | homestead | dao | tangerineWhistle | spuriousDragon | byzantium | constantinople | petersburg | istanbul | muirGlacier | berlin | london | altair | arrowGlacier | grayGlacier | bellatrix | merge | capella | shanghai

optionalinput

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

ProviderInfo

ProviderInfo:

chainId

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

SimpleProvider

SimpleProvider<API>:

Type parameters

request

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

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?: chainstart | frontier | homestead | dao | tangerineWhistle | spuriousDragon | byzantium | constantinople | petersburg | istanbul | muirGlacier | berlin | london | altair | arrowGlacier | grayGlacier | bellatrix | merge | capella | shanghai

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

readonlygasPrice

gasPrice: 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

optionalreadonlyv

v?: undefined

readonlyvalue

value: string

readonlyyParity

yParity: string

Transaction1559UnsignedAPI

Transaction1559UnsignedAPI:

readonlyaccessList

accessList: AccessList

optionalreadonlychainId

chainId?: string

optionalreadonlydata

data?: string

readonlygas

gas: string

readonlygasPrice

gasPrice: 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

optionalreadonlymaxFeePerGas

maxFeePerGas?: undefined

optionalreadonlymaxPriorityFeePerGas

maxPriorityFeePerGas?: undefined

readonlynonce

nonce: string

readonlyr

r: string

readonlys

s: string

optionalreadonlyto

to?: null | string

readonlytype

type: string

optionalreadonlyv

v?: undefined

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

optionalreadonlymaxFeePerGas

maxFeePerGas?: undefined

optionalreadonlymaxPriorityFeePerGas

maxPriorityFeePerGas?: undefined

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?: chainstart | frontier | homestead | dao | tangerineWhistle | spuriousDragon | byzantium | constantinople | petersburg | istanbul | muirGlacier | berlin | london | altair | arrowGlacier | grayGlacier | bellatrix | merge | capella | shanghai

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?: chainstart | frontier | homestead | dao | tangerineWhistle | spuriousDragon | byzantium | constantinople | petersburg | istanbul | muirGlacier | berlin | london | altair | arrowGlacier | grayGlacier | bellatrix | merge | capella | shanghai

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?: chainstart | frontier | homestead | dao | tangerineWhistle | spuriousDragon | byzantium | constantinople | petersburg | istanbul | muirGlacier | berlin | london | altair | arrowGlacier | grayGlacier | bellatrix | merge | capella | shanghai

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:

optionalreadonlyaccessList

accessList?: undefined

optionalreadonlychainId

chainId?: string

optionalreadonlydata

data?: string

readonlygas

gas: string

readonlygasPrice

gasPrice: string

optionalreadonlyhash

hash?: string

readonlyinput

input: string

optionalreadonlymaxFeePerGas

maxFeePerGas?: undefined

optionalreadonlymaxPriorityFeePerGas

maxPriorityFeePerGas?: undefined

readonlynonce

nonce: string

readonlyr

r: string

readonlys

s: string

optionalreadonlyto

to?: null | string

readonlytype

type: string

readonlyv

v: string

readonlyvalue

value: string

TransactionLegacyUnsignedAPI

TransactionLegacyUnsignedAPI:

optionalreadonlyaccessList

accessList?: undefined

optionalreadonlychainId

chainId?: string

optionalreadonlydata

data?: string

readonlygas

gas: string

readonlygasPrice

gasPrice: string

optionalreadonlyhash

hash?: string

readonlyinput

input: string

optionalreadonlymaxFeePerGas

maxFeePerGas?: undefined

optionalreadonlymaxPriorityFeePerGas

maxPriorityFeePerGas?: undefined

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

optionalevents

events?: {}

Type declaration

  • [key string]: EventLog

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?: chainstart | frontier | homestead | dao | tangerineWhistle | spuriousDragon | byzantium | constantinople | petersburg | istanbul | muirGlacier | berlin | london | altair | arrowGlacier | grayGlacier | bellatrix | merge | capella | shanghai

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?: chainstart | frontier | homestead | dao | tangerineWhistle | spuriousDragon | byzantium | constantinople | petersburg | istanbul | muirGlacier | berlin | london | altair | arrowGlacier | grayGlacier | bellatrix | merge | capella | shanghai

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?: chainstart | frontier | homestead | dao | tangerineWhistle | spuriousDragon | byzantium | constantinople | petersburg | istanbul | muirGlacier | berlin | london | altair | arrowGlacier | grayGlacier | bellatrix | merge | capella | shanghai

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 | readonly unknown[] | Web3APIParams<API, Method>

Web3AccountProvider

Web3AccountProvider<T>:

Type parameters

  • T

create

create: () => T

Type declaration

    • (): T

    • Returns T

decrypt

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

Type declaration

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

Type declaration

    • (privateKey: string): T

    • Parameters

      • privateKey: string

      Returns T

Web3BaseWalletAccount

Web3BaseWalletAccount:

readonlyaddress

address: string

readonlyencrypt

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

Type declaration

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

    • Parameters

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

      Returns Promise<KeyStore>

readonlyprivateKey

privateKey: string

readonlysign

sign: (data: string | Record<string, unknown>) => SignResult

Type declaration

    • (data: string | Record<string, unknown>): SignResult

    • Parameters

      • data: string | Record<string, unknown>

      Returns SignResult

readonlysignTransaction

signTransaction: (tx: Transaction) => Promise<SignTransactionResult>

Type declaration

    • Parameters

      Returns Promise<SignTransactionResult>

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

Withdrawals

Withdrawals:

readonlyaddress

address: string

readonlyamount

amount: Numbers

readonlyindex

index: Numbers

readonlyvalidatorIndex

validatorIndex: Numbers

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>; methodNameWithInputs?: string; name: string; outputs?: ReadonlyArray<AbiParameter>; payable?: boolean; signature?: string; stateMutability?: string | nonpayable | payable | pure | view; type: string | function }

AbiInput

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

AbiItem

AbiItem: AbiFragment

AbiParameter

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

Type declaration

  • optionalreadonlyarrayChildren?: ReadonlyArray<AbiParameter>
  • optionalreadonlyarrayLength?: number
  • optionalreadonlybaseType?: string
  • optionalreadonlycomponents?: ReadonlyArray<AbiParameter>
  • optionalreadonlyindexed?: boolean
  • optionalreadonlyinternalType?: string
  • 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}`

ByteTypes

ByteTypes: { BYTES_HEX: HexString; BYTES_UINT8ARRAY: Uint8Array }

Type declaration

  • BYTES_HEX: HexString
  • BYTES_UINT8ARRAY: Uint8Array

Bytes

Bytes: Uint8Array | HexString

Cipher

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

CipherOptions

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

Type declaration

  • optionalc?: number
  • optionaldklen?: number
  • optionaliv?: Uint8Array | string
  • optionalkdf?: scrypt | pbkdf2
  • optionaln?: number
  • optionalp?: number
  • optionalr?: number
  • optionalsalt?: Uint8Array | 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> | ReadonlyArray<AbiItem>

ContractConstructor

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

Type parameters

ContractConstructorArgs

ContractConstructorArgs<Abis>: FilterAbis<Abis, AbiConstructorFragment & { type: constructor }> extends never ? any : { [ 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 undefined ? any[] : 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

DataFormat

DataFormat: { bytes: FMT_BYTES; number: FMT_NUMBER }

Used to specify how data should be formatted. Bytes can be formatted as hexadecimal strings or Uint8Arrays. Numbers can be formatted as BigInts, hexadecimal strings, primitive numbers, or strings.

Type declaration

Eip1193Compatible

Eip1193Compatible<API>: Omit<Omit<Web3BaseProvider, request>, asEIP1193Provider> & { request: any }

Type parameters

Eip1193EventName

Eip1193EventName: connect | disconnect | message | chainChanged | accountsChanged

EncodingTypes

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

EthExecutionAPI

EthExecutionAPI: { eth_accounts: () => Address[]; eth_blockNumber: () => Uint; eth_call: (transaction: TransactionCallAPI, blockNumber: BlockNumberOrTag) => HexStringBytes; eth_clearSubscriptions: (keepSyncing?: boolean) => void; eth_coinbase: () => Address; eth_compileLLL: (code: string) => HexStringBytes; eth_compileSerpent: (code: string) => HexStringBytes; eth_compileSolidity: (code: string) => CompileResultAPI; eth_estimateGas: (transaction: Partial<TransactionWithSenderAPI>, blockNumber: BlockNumberOrTag) => Uint; eth_feeHistory: (blockCount: Uint, newestBlock: BlockNumberOrTag, rewardPercentiles: number[]) => FeeHistoryResultAPI; eth_gasPrice: () => Uint; eth_getBalance: (address: Address, blockNumber: BlockNumberOrTag) => Uint; eth_getBlockByHash: (blockHash: HexString32Bytes, hydrated: boolean) => BlockAPI; eth_getBlockByNumber: (blockNumber: BlockNumberOrTag, hydrated: boolean) => BlockAPI; eth_getBlockTransactionCountByHash: (blockHash: HexString32Bytes) => Uint; eth_getBlockTransactionCountByNumber: (blockNumber: BlockNumberOrTag) => Uint; eth_getCode: (address: Address, blockNumber: BlockNumberOrTag) => HexStringBytes; eth_getCompilers: () => string[]; eth_getFilterChanges: (filterIdentifier: Uint) => FilterResultsAPI; eth_getFilterLogs: (filterIdentifier: Uint) => FilterResultsAPI; eth_getLogs: (filter: Filter) => FilterResultsAPI; eth_getStorageAt: (address: Address, storageSlot: Uint256, blockNumber: BlockNumberOrTag) => HexStringBytes; eth_getTransactionByBlockHashAndIndex: (blockHash: HexString32Bytes, transactionIndex: Uint) => TransactionInfoAPI | undefined; eth_getTransactionByBlockNumberAndIndex: (blockNumber: BlockNumberOrTag, transactionIndex: Uint) => TransactionInfoAPI | undefined; eth_getTransactionByHash: (transactionHash: HexString32Bytes) => TransactionInfoAPI | undefined; eth_getTransactionCount: (address: Address, blockNumber: BlockNumberOrTag) => Uint; eth_getTransactionReceipt: (transactionHash: HexString32Bytes) => TransactionReceiptAPI | undefined; eth_getUncleByBlockHashAndIndex: (blockHash: HexString32Bytes, uncleIndex: Uint) => BlockAPI; eth_getUncleByBlockNumberAndIndex: (blockNumber: BlockNumberOrTag, uncleIndex: Uint) => BlockAPI; eth_getUncleCountByBlockHash: (blockHash: HexString32Bytes) => Uint; eth_getUncleCountByBlockNumber: (blockNumber: BlockNumberOrTag) => Uint; eth_getWork: () => [HexString32Bytes, HexString32Bytes, HexString32Bytes]; eth_hashrate: () => Uint; eth_maxPriorityFeePerGas: () => Uint; eth_mining: () => boolean; eth_newBlockFilter: () => Uint; eth_newFilter: (filter: Filter) => Uint; eth_newPendingTransactionFilter: () => Uint; eth_protocolVersion: () => string; eth_sendRawTransaction: (transaction: HexStringBytes) => HexString32Bytes; eth_sendTransaction: (transaction: TransactionWithSenderAPI | Partial<TransactionWithSenderAPI>) => HexString32Bytes; eth_sign: (address: Address, message: HexStringBytes) => HexString256Bytes; eth_signTransaction: (transaction: TransactionWithSenderAPI | Partial<TransactionWithSenderAPI>) => HexStringBytes | SignedTransactionInfoAPI; eth_submitHashrate: (hashRate: HexString32Bytes, id: HexString32Bytes) => boolean; eth_submitWork: (nonce: HexString8Bytes, hash: HexString32Bytes, digest: HexString32Bytes) => boolean; eth_subscribe: (...params: [newHeads] | [newPendingTransactions] | [syncing] | [logs, { address?: HexString; topics?: HexString[] }]) => HexString; eth_syncing: () => SyncingStatusAPI; eth_uninstallFilter: (filterIdentifier: Uint) => boolean; eth_unsubscribe: (subscriptionId: HexString) => HexString }

Type declaration

EthPersonalAPI

EthPersonalAPI: { personal_ecRecover: (signedData: HexString, signature: HexString) => Address; personal_importRawKey: (keyData: HexString, passphrase: string) => HexString; personal_listAccounts: () => Address[]; personal_lockAccount: (address: Address) => boolean; personal_newAccount: (password: string) => Address; personal_sendTransaction: (tx: Transaction, passphrase: string) => HexString; personal_sign: (data: HexString, address: Address, passphrase: string) => HexString; personal_signTransaction: (tx: Transaction, passphrase: string) => HexString; personal_unlockAccount: (address: Address, password: string, unlockDuration: number) => boolean }

Type declaration

FeeHistory

FeeHistory: FeeHistoryBase<Numbers>

FeeHistoryResultAPI

FeeHistoryResultAPI: FeeHistoryBase<Uint>

FilterAbis

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

Type parameters

FilterParams

FilterParams: Omit<Filter, blockHash | filter>

FilterResultsAPI

FilterResultsAPI: HexString32Bytes[] | LogAPI[]

FixedSizeArray

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

Type parameters

  • T
  • N: number

FormatType

FormatType<T, F>: number extends Extract<T, Numbers> ? NumberTypes[F[number]] | Exclude<T, Numbers> : Uint8Array extends Extract<T, Bytes> ? ByteTypes[F[bytes]] | Exclude<T, Bytes> : T extends object | undefined ? { [ P in keyof T ]: FormatType<T[P], F> } : T

Type parameters

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: `${HardforksOrdered}`

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> | JsonRpcNotification<Result>

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

Mutable

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

Type parameters

  • T

NumberTypes

NumberTypes: { NUMBER_BIGINT: bigint; NUMBER_HEX: HexString; NUMBER_NUMBER: number; NUMBER_STR: string }

Type declaration

  • NUMBER_BIGINT: bigint
  • NUMBER_HEX: HexString
  • NUMBER_NUMBER: number
  • NUMBER_STR: string

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: Uint8Array | string }

Type declaration

  • c: number
  • dklen: number
  • prf: hmac-sha256
  • salt: Uint8Array | 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 | unknown = []

ProviderAccounts

ProviderAccounts: string[]

ProviderChainId

ProviderChainId: string

Receipt

Receipt: Record<string, unknown>

ScryptParams

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

Type declaration

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

Sha3Input

Sha3Input: TypedObject | TypedObjectAbbreviated | Numbers | boolean | object

SupportedProviders

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

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

Web3Eip1193ProviderEventCallback

Web3Eip1193ProviderEventCallback<T>: (data: T) => void

Type parameters

  • T

Type declaration

    • (data: T): void

    • Parameters

      • data: T

      Returns void

Web3EthExecutionAPI

Web3EthExecutionAPI: EthExecutionAPI & { eth_chainId: () => Uint; eth_getProof: (address: Address, storageKeys: HexString32Bytes[], blockNumber: BlockNumberOrTag) => AccountObject; eth_pendingTransactions: () => TransactionInfo[]; eth_requestAccounts: () => Address[]; eth_signTypedData: (address: Address, typedData: Eip712TypedData, useLegacy: true) => HexString256Bytes; eth_signTypedData_v4: (address: Address, typedData: Eip712TypedData, useLegacy: false | undefined) => HexString256Bytes; web3_clientVersion: () => string }

Web3NetAPI

Web3NetAPI: { net_listening: () => boolean; net_peerCount: () => HexString; net_version: () => string }

Type declaration

  • net_listening: () => boolean
      • (): boolean

      • Returns boolean

  • net_peerCount: () => HexString
  • net_version: () => string
      • (): string

      • Returns string

Web3ProviderEventCallback

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

Type parameters

Type declaration

Web3ProviderMessageEventCallback

Web3ProviderMessageEventCallback<T>: (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

Web3ValidationErrorObject

Web3ValidationErrorObject<K, P, S>: { data?: unknown; instancePath: string; keyword: K; message?: string; params: P; propertyName?: string; schema?: S; schemaPath: string }

Type parameters

  • K: string = string
  • P = Record<string, any>
  • S = unknown

Type declaration

  • optionaldata?: unknown
  • instancePath: string
  • keyword: K
  • optionalmessage?: string
  • params: P
  • optionalpropertyName?: string
  • optionalschema?: S
  • schemaPath: string

Variables

constDEFAULT_RETURN_FORMAT

DEFAULT_RETURN_FORMAT: { bytes: FMT_BYTES.HEX; number: FMT_NUMBER.BIGINT }

Type declaration

  • readonlybytes: FMT_BYTES.HEX
  • readonlynumber: FMT_NUMBER.BIGINT

constETH_DATA_FORMAT

ETH_DATA_FORMAT: { bytes: FMT_BYTES.HEX; number: FMT_NUMBER.HEX }

Type declaration

  • readonlybytes: FMT_BYTES.HEX
  • readonlynumber: FMT_NUMBER.HEX

constTypedArray

TypedArray: any
Page Options