eth
Index
References
Namespaces
Classes
Interfaces
Type Aliases
Variables
Functions
- call
- createAccessList
- detectTransactionType
- estimateGas
- formatTransaction
- getBalance
- getBlock
- getBlockNumber
- getBlockTransactionCount
- getBlockUncleCount
- getChainId
- getCode
- getCoinbase
- getFeeHistory
- getGasPrice
- getHashRate
- getLogs
- getPendingTransactions
- getProof
- getProtocolVersion
- getStorageAt
- getTransaction
- getTransactionCount
- getTransactionFromBlock
- getTransactionReceipt
- getUncle
- isAccessList
- isAccessListEntry
- isBaseTransaction
- isMining
- isSyncing
- isTransaction1559Unsigned
- isTransaction2930Unsigned
- isTransactionCall
- isTransactionLegacyUnsigned
- isTransactionWithSender
- prepareTransactionForSigning
- sendSignedTransaction
- sendTransaction
- sign
- signTransaction
- transactionBuilder
- validateBaseChain
- validateChainInfo
- validateCustomChainInfo
- validateFeeMarketGas
- validateGas
- validateHardfork
- validateLegacyGas
- validateTransactionCall
- validateTransactionForSigning
- validateTransactionWithSender
References
Web3Eth
Re-exports Web3Eth
Namespaces
abi
decodeContractErrorData
Parameters
errorsAbi: AbiErrorFragment[]
error: Eip838ExecutionError
Returns void
decodeLog
Type parameters
- ReturnType_1: DecodedParams<ReturnType_1>
Parameters
inputs: AbiParameter[]
data: string
topics: string | string[]
Returns ReturnType_1
decodeParameter
Parameters
abi: AbiInput
bytes: string
Returns unknown
decodeParameters
Parameters
abi: AbiInput[]
bytes: string
Returns { __length__: number }
[key string]: unknown
__length__: number
decodeParametersWith
Parameters
abis: AbiInput[]
bytes: string
loose: boolean
Returns { __length__: number }
[key string]: unknown
__length__: number
encodeErrorSignature
Parameters
functionName: string | AbiErrorFragment
Returns string
encodeEventSignature
Parameters
functionName: string | AbiEventFragment
Returns string
encodeFunctionCall
Parameters
jsonInterface: AbiFunctionFragment
params: unknown[]
Returns string
encodeFunctionSignature
Parameters
functionName: string | AbiFunctionFragment
Returns string
encodeParameter
Parameters
abi: AbiInput
param: unknown
Returns string
encodeParameters
Parameters
abi: readonly AbiInput[]
params: unknown[]
Returns string
flattenTypes
Parameters
includeTuple: boolean
puts: readonly AbiParameter[]
Returns string[]
formatOddHexstrings
Parameters
param: string
Returns string
formatParam
Parameters
type: string
_param: unknown
Returns unknown
isAbiConstructorFragment
Parameters
item: unknown
Returns item is AbiConstructorFragment
isAbiErrorFragment
Parameters
item: unknown
Returns item is AbiEventFragment
isAbiEventFragment
Parameters
item: unknown
Returns item is AbiEventFragment
isAbiFragment
Parameters
item: unknown
Returns item is AbiFragment
isAbiFunctionFragment
Parameters
item: unknown
Returns item is AbiFunctionFragment
isOddHexstring
Parameters
param: unknown
Returns boolean
isSimplifiedStructFormat
Parameters
type: Partial<AbiParameter> | Partial<AbiInput>
Returns type is Omit<AbiParameter, name | components>
jsonInterfaceMethodToString
Parameters
json: AbiFragment
Returns string
mapStructNameAndType
Parameters
structName: string
Returns AbiStruct
mapStructToCoderFormat
Parameters
struct: AbiStruct
Returns AbiCoderStruct[]
mapTypes
Parameters
types: AbiInput[]
Returns (string | Record<string, unknown> | AbiParameter)[]
modifyParams
Parameters
coder: Coder
param: unknown[]
Returns unknown
accounts
Capability
EIP1559FeeMarket
EIP155ReplayProtection
EIP2718TypedTransaction
EIP2930AccessLists
Chain
Goerli
Mainnet
Sepolia
ConsensusAlgorithm
Casper
Clique
Ethash
ConsensusType
ProofOfAuthority
ProofOfStake
ProofOfWork
CustomChain
ArbitrumOne
ArbitrumRinkebyTestnet
OptimisticEthereum
OptimisticKovan
PolygonMainnet
PolygonMumbai
xDaiChain
Hardfork
ArrowGlacier
Berlin
Byzantium
Chainstart
Constantinople
Dao
GrayGlacier
Homestead
Istanbul
London
Merge
MergeForkIdTransition
MuirGlacier
Petersburg
Shanghai
ShardingForkDev
SpuriousDragon
TangerineWhistle
AccessListEIP2930Transaction
constructor
Parameters
txData: AccessListEIP2930TxData
optionalopts: TxOptions
Returns AccessListEIP2930Transaction
readonlyAccessListJSON
readonlyaccessList
readonlychainId
readonlycommon
readonlydata
readonlygasLimit
readonlygasPrice
readonlynonce
optionalreadonlyr
optionalreadonlys
optionalreadonlyto
optionalreadonlyv
readonlyvalue
type
Returns number
_processSignature
Parameters
v: bigint
r: Buffer
s: Buffer
Returns AccessListEIP2930Transaction
errorStr
Returns string
getBaseFee
Returns bigint
getDataFee
Returns bigint
getMessageToSign
Parameters
optionalhashMessage: boolean
Returns Buffer
getMessageToVerifySignature
Returns Buffer
getSenderAddress
Returns Address
getSenderPublicKey
Returns Buffer
getUpfrontCost
Returns bigint
hash
Returns Buffer
isSigned
Returns boolean
raw
Returns AccessListEIP2930ValuesArray
serialize
Returns Buffer
sign
Parameters
privateKey: Buffer
Returns AccessListEIP2930Transaction
supports
Parameters
capability: Capability
Returns boolean
toCreationAddress
Returns boolean
toJSON
Returns JsonTx
validate
Returns boolean
verifySignature
Returns boolean
staticfromSerializedTx
Parameters
serialized: Buffer
optionalopts: TxOptions
Returns AccessListEIP2930Transaction
staticfromTxData
Parameters
txData: AccessListEIP2930TxData
optionalopts: TxOptions
Returns AccessListEIP2930Transaction
staticfromValuesArray
Parameters
values: AccessListEIP2930ValuesArray
optionalopts: TxOptions
Returns AccessListEIP2930Transaction
Common
constructor
Parameters
opts: CommonOpts
Returns Common
readonlyDEFAULT_HARDFORK
_calcForkHash
Parameters
hardfork: string
genesisHash: Buffer
Returns string
_getHardfork
Parameters
hardfork: string
Returns null | HardforkConfig
activeOnBlock
Parameters
blockNumber: Numbers
Returns boolean
bootstrapNodes
Returns undefined | BootstrapNodeConfig[]
chainId
Returns bigint
chainName
Returns string
consensusAlgorithm
Returns string
consensusConfig
Returns {}
[key string]: CliqueConfig | EthashConfig | CasperConfig
consensusType
Returns string
copy
Returns Common
dnsNetworks
Returns string[]
eipBlock
Parameters
eip: number
Returns null | bigint
eips
Returns number[]
forkHash
Parameters
optional_hardfork: string
optionalgenesisHash: Buffer
Returns string
genesis
Returns GenesisBlockConfig
getHardforkByBlockNumber
gteHardfork
Parameters
hardfork: string
Returns boolean
hardfork
Returns string
hardforkBlock
Parameters
optional_hardfork: string
Returns null | bigint
hardforkForForkHash
Parameters
forkHash: string
Returns null | HardforkConfig
hardforkGteHardfork
Parameters
_hardfork1: null | string
hardfork2: string
Returns boolean
hardforkIsActiveOnBlock
Parameters
_hardfork: null | string
_blockNumber: Numbers
Returns boolean
hardforkTTD
Parameters
optional_hardfork: string
Returns null | bigint
hardforkTimestamp
Parameters
optional_hardfork: string
Returns null | bigint
hardforks
Returns HardforkConfig[]
isActivatedEIP
Parameters
eip: number
Returns boolean
isHardforkBlock
Parameters
_blockNumber: Numbers
optional_hardfork: string
Returns boolean
isNextHardforkBlock
Parameters
_blockNumber: Numbers
optional_hardfork: string
Returns boolean
networkId
Returns bigint
nextHardforkBlock
Parameters
optional_hardfork: string
Returns null | bigint
nextHardforkBlockOrTimestamp
Parameters
optional_hardfork: string
Returns null | bigint
param
Parameters
topic: string
name: string
Returns bigint
paramByBlock
paramByEIP
Parameters
topic: string
name: string
eip: number
Returns undefined | bigint
paramByHardfork
Parameters
topic: string
name: string
hardfork: string
Returns bigint
setChain
Parameters
chain: string | number | bigint | object
Returns ChainConfig
setEIPs
Parameters
optionaleips: number[]
Returns void
setForkHashes
Parameters
genesisHash: Buffer
Returns void
setHardfork
Parameters
hardfork: string
Returns void
setHardforkByBlockNumber
static_getInitializedChains
Parameters
optionalcustomChains: ChainConfig[]
Returns ChainsConfig
staticcustom
Parameters
chainParamsOrName: Partial<ChainConfig> | CustomChain
optionalopts: CustomCommonOpts
Returns Common
staticfromGethGenesis
Parameters
genesisJson: any
__namedParameters: GethConfigOpts
Returns Common
staticisSupportedChainId
Parameters
chainId: bigint
Returns boolean
FeeMarketEIP1559Transaction
constructor
Parameters
txData: FeeMarketEIP1559TxData
optionalopts: TxOptions
Returns FeeMarketEIP1559Transaction
readonlyAccessListJSON
readonlyaccessList
readonlychainId
readonlycommon
readonlydata
readonlygasLimit
readonlymaxFeePerGas
readonlymaxPriorityFeePerGas
readonlynonce
optionalreadonlyr
optionalreadonlys
optionalreadonlyto
optionalreadonlyv
readonlyvalue
type
Returns number
_processSignature
Parameters
v: bigint
r: Buffer
s: Buffer
Returns FeeMarketEIP1559Transaction
errorStr
Returns string
getBaseFee
Returns bigint
getDataFee
Returns bigint
getMessageToSign
Parameters
optionalhashMessage: boolean
Returns Buffer
getMessageToVerifySignature
Returns Buffer
getSenderAddress
Returns Address
getSenderPublicKey
Returns Buffer
getUpfrontCost
Parameters
optionalbaseFee: bigint
Returns bigint
hash
Returns Buffer
isSigned
Returns boolean
raw
Returns FeeMarketEIP1559ValuesArray
serialize
Returns Buffer
sign
Parameters
privateKey: Buffer
Returns FeeMarketEIP1559Transaction
supports
Parameters
capability: Capability
Returns boolean
toCreationAddress
Returns boolean
toJSON
Returns JsonTx
validate
Returns boolean
verifySignature
Returns boolean
staticfromSerializedTx
Parameters
serialized: Buffer
optionalopts: TxOptions
Returns FeeMarketEIP1559Transaction
staticfromTxData
Parameters
txData: FeeMarketEIP1559TxData
optionalopts: TxOptions
Returns FeeMarketEIP1559Transaction
staticfromValuesArray
Parameters
values: FeeMarketEIP1559ValuesArray
optionalopts: TxOptions
Returns FeeMarketEIP1559Transaction
Transaction
constructor
Parameters
txData: TxData
optionalopts: TxOptions
Returns Transaction
readonlycommon
readonlydata
readonlygasLimit
readonlygasPrice
readonlynonce
optionalreadonlyr
optionalreadonlys
optionalreadonlyto
optionalreadonlyv
readonlyvalue
type
Returns number
errorStr
Returns string
getBaseFee
Returns bigint
getDataFee
Returns bigint
getMessageToSign
Parameters
hashMessage: false
Returns Buffer[]
getMessageToVerifySignature
Returns Buffer
getSenderAddress
Returns Address
getSenderPublicKey
Returns Buffer
getUpfrontCost
Returns bigint
hash
Returns Buffer
isSigned
Returns boolean
raw
Returns TxValuesArray
serialize
Returns Buffer
sign
Parameters
privateKey: Buffer
Returns Transaction
supports
Parameters
capability: Capability
Returns boolean
toCreationAddress
Returns boolean
toJSON
Returns JsonTx
validate
Returns boolean
verifySignature
Returns boolean
staticfromSerializedTx
Parameters
serialized: Buffer
optionalopts: TxOptions
Returns Transaction
staticfromTxData
Parameters
txData: TxData
optionalopts: TxOptions
Returns Transaction
staticfromValuesArray
Parameters
values: TxValuesArray
optionalopts: TxOptions
Returns Transaction
TransactionFactory
staticfromBlockBodyData
Parameters
data: Buffer | Buffer[]
optionaltxOptions: TxOptions
Returns TypedTransaction
staticfromSerializedData
Parameters
data: Buffer
optionaltxOptions: TxOptions
Returns TypedTransaction
staticfromTxData
Parameters
txData: TxData | AccessListEIP2930TxData | FeeMarketEIP1559TxData
optionaltxOptions: TxOptions
Returns TypedTransaction
Wallet
Type parameters
constructor
Type parameters
Parameters
accountProvider: Web3AccountProvider<T>
Returns Wallet<T>
add
Parameters
account: string | T
Returns Wallet<T>
clear
Returns Wallet<T>
create
Parameters
numberOfAccounts: number
Returns Wallet<T>
decrypt
Parameters
encryptedWallets: KeyStore[]
password: string
optionaloptions: Record<string, unknown>
Returns Promise<Wallet<T>>
encrypt
Parameters
password: string
optionaloptions: Record<string, unknown>
Returns Promise<KeyStore[]>
get
Parameters
addressOrIndex: string | number
Returns undefined | T
load
Parameters
password: string
optionalkeyName: string
Returns Promise<Wallet<T>>
remove
Parameters
addressOrIndex: string | number
Returns boolean
save
Parameters
password: string
optionalkeyName: string
Returns Promise<boolean>
staticgetStorage
Returns undefined | WebStorage
AccessListEIP2930TxData
optionalaccessList
optionalchainId
optionaldata
optionalgasLimit
optionalgasPrice
optionalnonce
optionalr
optionals
optionalto
optionaltype
optionalv
optionalvalue
BootstrapNodeConfig
optionalchainId
comment
id
ip
location
optionalnetwork
port
ChainConfig
optionalbootstrapNodes
chainId
optionalcomment
consensus
Type declaration
algorithm: string
optionalcasper?: CasperConfig
optionalclique?: CliqueConfig
optionalethash?: EthashConfig
type: string
optionaldefaultHardfork
optionaldnsNetworks
genesis
hardforks
name
networkId
optionalurl
ChainName
ChainsConfig
CommonOpts
chain
optionalcustomChains
optionaleips
optionalhardfork
CustomCommonOpts
optionalbaseChain
optionaleips
optionalhardfork
Decoded
data
remainder
ECDSASignature
r
s
v
FeeMarketEIP1559TxData
optionalaccessList
optionalchainId
optionaldata
optionalgasLimit
optionalgasPrice
optionalmaxFeePerGas
optionalmaxPriorityFeePerGas
optionalnonce
optionalr
optionals
optionalto
optionaltype
optionalv
optionalvalue
GenesisBlockConfig
optionalbaseFeePerGas
difficulty
extraData
gasLimit
nonce
optionaltimestamp
GethConfigOpts
optionalchain
optionaleips
optionalgenesisHash
optionalhardfork
optionalmergeForkIdPostMerge
HardforkConfig
block
optionalforkHash
name
optionaltimestamp
optionalttd
JsonRpcTx
optionalaccessList
blockHash
blockNumber
optionalchainId
from
gas
gasPrice
hash
input
optionalmaxFeePerDataGas
optionalmaxFeePerGas
optionalmaxPriorityFeePerGas
nonce
r
s
to
transactionIndex
type
v
value
optionalversionedHashes
JsonTx
optionalaccessList
optionalchainId
optionaldata
optionalgasLimit
optionalgasPrice
optionalmaxFeePerDataGas
optionalmaxFeePerGas
optionalmaxPriorityFeePerGas
optionalnonce
optionalr
optionals
optionalto
optionaltype
optionalv
optionalvalue
optionalversionedHashes
TxOptions
optionalcommon
optionalfreeze
Web3Account
address
privateKey
readonlyencrypt
Parameters
password: string
optionaloptions: Record<string, unknown>
Returns Promise<KeyStore>
readonlysign
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
Parameters
tx: Record<string, unknown>
Returns Promise<{ messageHash: string; r: string; rawTransaction: string; s: string; transactionHash: string; v: string }>
WebStorage
readonlylength
clear
Returns void
getItem
Parameters
key: string
Returns null | string
key
Parameters
index: number
Returns null | string
removeItem
Parameters
key: string
Returns void
setItem
Parameters
key: string
value: string
Returns void
AccessList
AccessListBuffer
AccessListBufferItem
AccessListEIP2930ValuesArray
AccessListItem
Type declaration
address: PrefixedHexString
storageKeys: PrefixedHexString[]
CasperConfig
CliqueConfig
Type declaration
epoch: number
period: number
EthashConfig
FeeMarketEIP1559ValuesArray
Input
NestedUint8Array
SignFunction
Type declaration
Parameters
data: string
privateKey: string
Returns SignResult
SignResult
SignTransactionFunction
Type declaration
Parameters
transaction: TxData | AccessListEIP2930TxData | FeeMarketEIP1559TxData | Record<string, unknown>
Returns SignTransactionResult
SignTransactionResult
SignatureObject
Type declaration
messageHash: string
r: string
s: string
v: string
TxData
Type declaration
optionaldata?: BufferLike
optionalgasLimit?: Numbers | Buffer
optionalgasPrice?: Numbers | Buffer | null
optionalnonce?: Numbers | Buffer
optionalr?: Numbers | Buffer
optionals?: Numbers | Buffer
optionalto?: Address | Buffer | HexString
optionaltype?: Numbers
optionalv?: Numbers | Buffer
optionalvalue?: Numbers | Buffer
TxValuesArray
TypedTransaction
constAccessTupleType
constAddressType
constBlobNetworkTransactionWrapper
constBlobTransactionType
constECDSASignatureType
constKZGCommitmentType
constKZGProofType
constRLP
Type declaration
decode: typeof decode
encode: typeof encode
constSignedBlobTransactionType
constkeyStoreSchema
Type declaration
properties: { address: { type: string }; crypto: { properties: { cipher: { type: string }; cipherparams: { type: string }; ciphertext: { type: string }; kdf: { type: string }; kdfparams: { type: string }; mac: { type: string }; salt: { type: string } }; required: string[]; type: string }; id: { type: string }; version: { type: string } }
address: { type: string }
type: string
crypto: { properties: { cipher: { type: string }; cipherparams: { type: string }; ciphertext: { type: string }; kdf: { type: string }; kdfparams: { type: string }; mac: { type: string }; salt: { type: string } }; required: string[]; type: string }
properties: { cipher: { type: string }; cipherparams: { type: string }; ciphertext: { type: string }; kdf: { type: string }; kdfparams: { type: string }; mac: { type: string }; salt: { type: string } }
cipher: { type: string }
type: string
cipherparams: { type: string }
type: string
ciphertext: { type: string }
type: string
kdf: { type: string }
type: string
kdfparams: { type: string }
type: string
mac: { type: string }
type: string
salt: { type: string }
type: string
required: string[]
type: string
id: { type: string }
type: string
version: { type: string }
type: string
required: string[]
type: string
constutils
Type declaration
bytesToHex: typeof bytesToHex
concatBytes: typeof concatBytes
hexToBytes: typeof hexToBytes
utf8ToBytes: typeof utf8ToBytes
create
Returns Web3Account
decode
Parameters
input: Input
optionalstream: false
Returns Uint8Array | NestedUint8Array
decrypt
Parameters
keystore: string | KeyStore
password: string | Buffer
optionalnonStrict: boolean
Returns Promise<Web3Account>
encode
Parameters
input: Input
Returns Uint8Array
encrypt
Parameters
privateKey: Bytes
password: string | Buffer
optionaloptions: CipherOptions
Returns Promise<KeyStore>
hashMessage
Parameters
message: string
Returns string
isAccessList
Parameters
input: AccessListBuffer | AccessList
Returns input is AccessList
isAccessListBuffer
Parameters
input: AccessListBuffer | AccessList
Returns input is AccessListBuffer
parseAndValidatePrivateKey
Parameters
data: Bytes
optionalignoreLength: boolean
Returns Buffer
parseGethGenesis
Parameters
json: any
optionalname: string
optionalmergeForkIdPostMerge: boolean
Returns { bootstrapNodes: never[]; chainId: number; consensus: { algorithm: string; clique: { epoch: any; period: any }; ethash?: undefined; type: string } | { algorithm: string; clique?: undefined; ethash: {}; type: string }; genesis: { baseFeePerGas: string; coinbase: string; difficulty: number; extraData: string; gasLimit: number; mixHash: string; nonce: string; timestamp: string }; hardfork: string | undefined; hardforks: ConfigHardfork[]; name: string; networkId: number }
bootstrapNodes: never[]
chainId: number
consensus: { algorithm: string; clique: { epoch: any; period: any }; ethash?: undefined; type: string } | { algorithm: string; clique?: undefined; ethash: {}; type: string }
genesis: { baseFeePerGas: string; coinbase: string; difficulty: number; extraData: string; gasLimit: number; mixHash: string; nonce: string; timestamp: string }
baseFeePerGas: string
coinbase: string
difficulty: number
extraData: string
gasLimit: number
mixHash: string
nonce: string
timestamp: string
hardfork: string | undefined
hardforks: ConfigHardfork[]
name: string
networkId: number
privateKeyToAccount
Parameters
privateKey: Bytes
optionalignoreLength: boolean
Returns Web3Account
privateKeyToAddress
Parameters
privateKey: Bytes
Returns string
recover
Parameters
data: string | SignatureObject
optionalsignatureOrV: string
optionalprefixedOrR: string | boolean
optionals: string
optionalprefixed: boolean
Returns string
recoverTransaction
Parameters
rawTransaction: string
Returns string
sign
Parameters
data: string
privateKey: Bytes
Returns SignResult
signTransaction
Parameters
transaction: TypedTransaction
privateKey: string
Returns Promise<SignTransactionResult>
contract
Contract
Re-exports Contract
default
Renames and re-exports Contract
LogsSubscription
constructor
Parameters
args: { abi: AbiBaseFragment & { anonymous?: boolean; inputs?: readonly AbiParameter[]; name: string; type: string } & { signature: string }; address?: string; jsonInterface: ContractAbiWithSignature; topics?: (string | string[])[] }
options: { requestManager: Web3RequestManager<EthExecutionAPI>; returnFormat?: DataFormat }
Returns LogsSubscription
readonlyabi
optionalreadonlyaddress
readonlyargs
Type declaration
abi: AbiEventFragment
optionaladdress?: string
optionaltopics?: (string | string[])[]
readonlyjsonInterface
optionalreadonlytopics
id
Returns undefined | string
lastBlock
Returns undefined | BlockOutput
emit
Type parameters
- K: Web3EventKey<{ changed: EventLog & { removed: true }; connected: number; data: EventLog; error: Error }>
Parameters
eventName: K
params: { changed: EventLog & { removed: true }; connected: number; data: EventLog; error: Error }[K]
Returns void
eventNames
Returns (string | symbol)[]
getMaxListeners
Returns number
listenerCount
Type parameters
- K: Web3EventKey<{ changed: EventLog & { removed: true }; connected: number; data: EventLog; error: Error }>
Parameters
eventName: K
Returns number
listeners
Type parameters
- K: Web3EventKey<{ changed: EventLog & { removed: true }; connected: number; data: EventLog; error: Error }>
Parameters
eventName: K
Returns Function[]
off
Type parameters
- K: Web3EventKey<{ changed: EventLog & { removed: true }; connected: number; data: EventLog; error: Error }>
Parameters
eventName: K
fn: Web3EventCallback<{ changed: EventLog & { removed: true }; connected: number; data: EventLog; error: Error }[K]>
Returns void
on
Type parameters
- K: Web3EventKey<{ changed: EventLog & { removed: true }; connected: number; data: EventLog; error: Error }>
Parameters
eventName: K
fn: Web3EventCallback<{ changed: EventLog & { removed: true }; connected: number; data: EventLog; error: Error }[K]>
Returns void
once
Type parameters
- K: Web3EventKey<{ changed: EventLog & { removed: true }; connected: number; data: EventLog; error: Error }>
Parameters
eventName: K
fn: Web3EventCallback<{ changed: EventLog & { removed: true }; connected: number; data: EventLog; error: Error }[K]>
Returns void
removeAllListeners
Returns EventEmitter
resubscribe
Returns Promise<void>
setMaxListenerWarningThreshold
Parameters
maxListenersWarningThreshold: number
Returns void
subscribe
Returns Promise<void>
unsubscribe
Returns Promise<void>
ContractEventOptions
optionalfilter
optionalfromBlock
optionaltopics
ContractInitOptions
optionalreadonlydata
optionalreadonlyfrom
optionalreadonlygas
optionalreadonlygasLimit
optionalreadonlygasPrice
optionalreadonlyinput
optionalreadonlyprovider
optionalreadonlysyncWithContext
ContractOptions
optionaladdress
optionalreadonlyfrom
optionalreadonlygas
optionalreadonlygasPrice
optionalreadonlyinput
jsonInterface
Returns ContractAbiWithSignature
Parameters
value: ContractAbi
Returns void
EventLog
readonlyaddress
optionalreadonlyblockHash
optionalreadonlyblockNumber
readonlydata
readonlyevent
optionalreadonlyid
optionalreadonlylogIndex
optionalreadonlyraw
Type declaration
data: string
topics: unknown[]
readonlyreturnValues
optionalreadonlysignature
readonlytopics
optionalreadonlytransactionHash
optionalreadonlytransactionIndex
NonPayableCallOptions
optionalchainId
optionaldata
optionalfrom
optionalgas
optionalgasPrice
optionalinput
optionalmaxFeePerGas
optionalmaxPriorityFeePerGas
optionalnonce
optionalto
optionaltype
NonPayableMethodObject
Type parameters
- Inputs = unknown[]
- Outputs = unknown[]
arguments
call
Type parameters
- SpecialOutput = Outputs
Parameters
optionaltx: NonPayableCallOptions
optionalblock: BlockNumberOrTag
Returns Promise<SpecialOutput>
createAccessList
Parameters
optionaltx: NonPayableCallOptions
optionalblock: BlockNumberOrTag
Returns Promise<AccessListResult>
encodeABI
Returns string
estimateGas
Type parameters
- ReturnFormat: DataFormat = { bytes: HEX; number: BIGINT }
Parameters
optionaloptions: NonPayableCallOptions
optionalreturnFormat: ReturnFormat
Returns Promise<NumberTypes[ReturnFormat[number]]>
send
Parameters
optionaltx: NonPayableCallOptions
Returns Web3PromiEvent<{ blockHash: string; blockNumber: bigint; contractAddress?: string; cumulativeGasUsed: bigint; effectiveGasPrice?: bigint; from: string; gasUsed: bigint; logs: { readonly id?: string | undefined; readonly removed?: boolean | undefined; readonly logIndex?: bigint | undefined; readonly transactionIndex?: bigint | undefined; readonly transactionHash?: string | undefined; ... 4 more ...; readonly topics?: string[] | undefined; }[]; logsBloom: string; root: string; status: bigint; to: string; transactionHash: string; transactionIndex: bigint; type?: bigint }, SendTransactionEvents<{ bytes: HEX; number: BIGINT }>>
PayableCallOptions
optionalchainId
optionaldata
optionalfrom
optionalgas
optionalgasPrice
optionalinput
optionalmaxFeePerGas
optionalmaxPriorityFeePerGas
optionalnonce
optionalto
optionaltype
optionalvalue
PayableMethodObject
Type parameters
- Inputs = unknown[]
- Outputs = unknown[]
arguments
call
Type parameters
- SpecialOutput = Outputs
Parameters
optionaltx: PayableCallOptions
optionalblock: BlockNumberOrTag
Returns Promise<SpecialOutput>
createAccessList
Parameters
optionaltx: NonPayableCallOptions
optionalblock: BlockNumberOrTag
Returns Promise<AccessListResult>
encodeABI
Returns string
estimateGas
Type parameters
- ReturnFormat: DataFormat = { bytes: HEX; number: BIGINT }
Parameters
optionaloptions: PayableCallOptions
optionalreturnFormat: ReturnFormat
Returns Promise<NumberTypes[ReturnFormat[number]]>
send
Parameters
optionaltx: PayableCallOptions
Returns Web3PromiEvent<{ blockHash: string; blockNumber: bigint; contractAddress?: string; cumulativeGasUsed: bigint; effectiveGasPrice?: bigint; from: string; gasUsed: bigint; logs: { readonly id?: string | undefined; readonly removed?: boolean | undefined; readonly logIndex?: bigint | undefined; readonly transactionIndex?: bigint | undefined; readonly transactionHash?: string | undefined; ... 4 more ...; readonly topics?: string[] | undefined; }[]; logsBloom: string; root: string; status: bigint; to: string; transactionHash: string; transactionIndex: bigint; type?: bigint }, SendTransactionEvents<{ bytes: HEX; number: BIGINT }>>
ContractAbiWithSignature
ContractBoundEvent
Type declaration
Parameters
optionaloptions: ContractEventOptions
Returns LogsSubscription
ContractEventEmitterInterface
Type parameters
- Abi: ContractAbi
ContractEventsInterface
Type parameters
- Abi: ContractAbi
- Events: ContractEvents<Abi> = ContractEvents<Abi>
ContractMethodsInterface
Type parameters
- Abi: ContractAbi
ContractOverloadedMethodInputs
Type parameters
- AbiArr: ReadonlyArray<unknown>
ContractOverloadedMethodOutputs
Type parameters
- AbiArr: ReadonlyArray<unknown>
NonPayableTxOptions
PayableTxOptions
TransactionReceipt
Web3ContractContext
decodeEventABI
Parameters
event: AbiBaseFragment & { anonymous?: boolean; inputs?: readonly AbiParameter[]; name: string; type: string } & { signature: string }
data: LogsInput
jsonInterface: ContractAbiWithSignature
optionalreturnFormat: DataFormat
Returns EventLog
decodeMethodReturn
Parameters
abi: AbiFunctionFragment
optionalreturnValues: string
Returns unknown
encodeEventABI
Parameters
__namedParameters: ContractOptions
event: AbiBaseFragment & { anonymous?: boolean; inputs?: readonly AbiParameter[]; name: string; type: string } & { signature: string }
optionaloptions: { filter?: Filter; fromBlock?: BlockNumberOrTag; toBlock?: BlockNumberOrTag; topics?: (null | string | string[])[] }
Returns { address?: string; filter: Filter; fromBlock?: Numbers; toBlock?: Numbers; topics?: (string | string[])[] }
encodeMethodABI
Parameters
abi: AbiFunctionFragment | AbiConstructorFragment
args: unknown[]
optionaldeployData: string
Returns string
ens
ENS
constructor
Parameters
optionalregistryAddr: string
optionalprovider: string | SupportedProviders<EthExecutionAPI & Web3NetAPI> | Web3ContextObject<EthExecutionAPI & Web3NetAPI, any>
Returns ENS
readonlyproviders
Type declaration
HttpProvider: Web3BaseProviderConstructor
IpcProvider: Web3BaseProviderConstructor
WebsocketProvider: Web3BaseProviderConstructor
registryAddress
staticoptionalgivenProvider
staticreadonlyproviders
Type declaration
HttpProvider: Web3BaseProviderConstructor
IpcProvider: Web3BaseProviderConstructor
WebsocketProvider: Web3BaseProviderConstructor
BatchRequest
Returns new () => Web3BatchRequest
Returns Web3BatchRequest
accountProvider
Returns undefined | Web3AccountProvider<Web3BaseWalletAccount>
blockHeaderTimeout
Returns number
Parameters
val: number
Returns void
currentProvider
Returns undefined | Web3BaseProvider<API>
Parameters
provider: undefined | string | SupportedProviders<API>
Returns void
defaultAccount
Returns undefined | string
Parameters
val: undefined | string
Returns void
defaultBlock
Returns BlockNumberOrTag
Parameters
val: BlockNumberOrTag
Returns void
defaultChain
Returns string
Parameters
val: string
Returns void
defaultCommon
defaultHardfork
Returns string
Parameters
val: string
Returns void
defaultMaxPriorityFeePerGas
defaultNetworkId
defaultTransactionType
enableExperimentalFeatures
Returns { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean }
useRpcCallSpecification: boolean
useSubscriptionWhenCheckingBlockTimeout: boolean
Parameters
val: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean }
Returns void
events
Returns ContractEventsInterface<readonly [{ inputs: readonly []; stateMutability: nonpayable; type: constructor }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: address; name: owner; type: address }, { indexed: true; internalType: address; name: operator; type: address }, { indexed: false; internalType: bool; name: approved; type: bool }]; name: ApprovalForAll; type: event }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: bytes32; name: node; type: bytes32 }, { indexed: true; internalType: bytes32; name: label; type: bytes32 }, { indexed: false; internalType: address; name: owner; type: address }]; name: NewOwner; type: event }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: bytes32; name: node; type: bytes32 }, { indexed: false; internalType: address; name: resolver; type: address }]; name: NewResolver; type: event }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: bytes32; name: node; type: bytes32 }, { indexed: false; internalType: uint64; name: ttl; type: uint64 }]; name: NewTTL; type: event }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: bytes32; name: node; type: bytes32 }, { indexed: false; internalType: address; name: owner; type: address }]; name: Transfer; type: event }, { inputs: readonly [{ internalType: address; name: owner; type: address }, { internalType: address; name: operator; type: address }]; name: isApprovedForAll; outputs: readonly [{ internalType: bool; name: ; type: bool }]; stateMutability: view; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }]; name: owner; outputs: readonly [{ internalType: address; name: ; type: address }]; stateMutability: view; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }]; name: recordExists; outputs: readonly [{ internalType: bool; name: ; type: bool }]; stateMutability: view; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }]; name: resolver; outputs: readonly [{ internalType: address; name: ; type: address }]; stateMutability: view; type: function }, { inputs: readonly [{ internalType: address; name: operator; type: address }, { internalType: bool; name: approved; type: bool }]; name: setApprovalForAll; outputs: readonly []; stateMutability: nonpayable; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }, { internalType: address; name: owner; type: address }]; name: setOwner; outputs: readonly []; stateMutability: nonpayable; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }, { internalType: address; name: owner; type: address }, { internalType: address; name: resolver; type: address }, { internalType: uint64; name: ttl; type: uint64 }]; name: setRecord; outputs: readonly []; stateMutability: nonpayable; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }, { internalType: address; name: resolver; type: address }]; name: setResolver; outputs: readonly []; stateMutability: nonpayable; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }, { internalType: bytes32; name: label; type: bytes32 }, { internalType: address; name: owner; type: address }]; name: setSubnodeOwner; outputs: readonly [{ internalType: bytes32; name: ; type: bytes32 }]; stateMutability: nonpayable; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }, { internalType: bytes32; name: label; type: bytes32 }, { internalType: address; name: owner; type: address }, { internalType: address; name: resolver; type: address }, { internalType: uint64; name: ttl; type: uint64 }]; name: setSubnodeRecord; outputs: readonly []; stateMutability: nonpayable; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }, { internalType: uint64; name: ttl; type: uint64 }]; name: setTTL; outputs: readonly []; stateMutability: nonpayable; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }]; name: ttl; outputs: readonly [{ internalType: uint64; name: ; type: uint64 }]; stateMutability: view; type: function }], ContractEvents<readonly [{ inputs: readonly []; stateMutability: nonpayable; type: constructor }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: address; name: owner; type: address }, { indexed: true; internalType: address; name: operator; type: address }, { indexed: false; internalType: bool; name: approved; type: bool }]; name: ApprovalForAll; type: event }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: bytes32; name: node; type: bytes32 }, { indexed: true; internalType: bytes32; name: label; type: bytes32 }, { indexed: false; internalType: address; name: owner; type: address }]; name: NewOwner; type: event }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: bytes32; name: node; type: bytes32 }, { indexed: false; internalType: address; name: resolver; type: address }]; name: NewResolver; type: event }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: bytes32; name: node; type: bytes32 }, { indexed: false; internalType: uint64; name: ttl; type: uint64 }]; name: NewTTL; type: event }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: bytes32; name: node; type: bytes32 }, { indexed: false; internalType: address; name: owner; type: address }]; name: Transfer; type: event }, { inputs: readonly [{ internalType: address; name: owner; type: address }, { internalType: address; name: operator; type: address }]; name: isApprovedForAll; outputs: readonly [{ internalType: bool; name: ; type: bool }]; stateMutability: view; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }]; name: owner; outputs: readonly [{ internalType: address; name: ; type: address }]; stateMutability: view; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }]; name: recordExists; outputs: readonly [{ internalType: bool; name: ; type: bool }]; stateMutability: view; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }]; name: resolver; outputs: readonly [{ internalType: address; name: ; type: address }]; stateMutability: view; type: function }, { inputs: readonly [{ internalType: address; name: operator; type: address }, { internalType: bool; name: approved; type: bool }]; name: setApprovalForAll; outputs: readonly []; stateMutability: nonpayable; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }, { internalType: address; name: owner; type: address }]; name: setOwner; outputs: readonly []; stateMutability: nonpayable; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }, { internalType: address; name: owner; type: address }, { internalType: address; name: resolver; type: address }, { internalType: uint64; name: ttl; type: uint64 }]; name: setRecord; outputs: readonly []; stateMutability: nonpayable; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }, { internalType: address; name: resolver; type: address }]; name: setResolver; outputs: readonly []; stateMutability: nonpayable; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }, { internalType: bytes32; name: label; type: bytes32 }, { internalType: address; name: owner; type: address }]; name: setSubnodeOwner; outputs: readonly [{ internalType: bytes32; name: ; type: bytes32 }]; stateMutability: nonpayable; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }, { internalType: bytes32; name: label; type: bytes32 }, { internalType: address; name: owner; type: address }, { internalType: address; name: resolver; type: address }, { internalType: uint64; name: ttl; type: uint64 }]; name: setSubnodeRecord; outputs: readonly []; stateMutability: nonpayable; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }, { internalType: uint64; name: ttl; type: uint64 }]; name: setTTL; outputs: readonly []; stateMutability: nonpayable; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }]; name: ttl; outputs: readonly [{ internalType: uint64; name: ; type: uint64 }]; stateMutability: view; type: function }]>>
givenProvider
Returns undefined | SupportedProviders<never>
handleRevert
Returns boolean
Parameters
val: boolean
Returns void
maxListenersWarningThreshold
Returns number
Parameters
val: number
Returns void
provider
Returns undefined | Web3BaseProvider<API>
Parameters
provider: undefined | string | SupportedProviders<API>
Returns void
requestManager
Returns Web3RequestManager<API>
subscriptionManager
Returns undefined | Web3SubscriptionManager<API, RegisteredSubs>
transactionBlockTimeout
Returns number
Parameters
val: number
Returns void
transactionBuilder
Returns undefined | TransactionBuilder<unknown>
Parameters
val: undefined | TransactionBuilder<unknown>
Returns void
transactionConfirmationBlocks
Returns number
Parameters
val: number
Returns void
transactionConfirmationPollingInterval
Returns undefined | number
Parameters
val: undefined | number
Returns void
transactionPollingInterval
Returns number
Parameters
val: number
Returns void
transactionPollingTimeout
Returns number
Parameters
val: number
Returns void
transactionReceiptPollingInterval
Returns undefined | number
Parameters
val: undefined | number
Returns void
transactionSendTimeout
Returns number
Parameters
val: number
Returns void
transactionTypeParser
Returns undefined | TransactionTypeParser
Parameters
val: undefined | TransactionTypeParser
Returns void
wallet
Returns undefined | Web3BaseWallet<Web3BaseWalletAccount>
checkNetwork
Returns Promise<string>
emit
Type parameters
- K: CONFIG_CHANGE
Parameters
eventName: K
params: { CONFIG_CHANGE: { name: handleRevert; newValue: boolean; oldValue: boolean } | { name: defaultAccount; newValue: undefined | string; oldValue: undefined | string } | { name: defaultBlock; newValue: BlockNumberOrTag; oldValue: BlockNumberOrTag } | { name: transactionSendTimeout; newValue: number; oldValue: number } | { name: transactionBlockTimeout; newValue: number; oldValue: number } | { name: transactionConfirmationBlocks; newValue: number; oldValue: number } | { name: transactionPollingInterval; newValue: number; oldValue: number } | { name: transactionPollingTimeout; newValue: number; oldValue: number } | { name: transactionReceiptPollingInterval; newValue: undefined | number; oldValue: undefined | number } | { name: transactionConfirmationPollingInterval; newValue: undefined | number; oldValue: undefined | number } | { name: blockHeaderTimeout; newValue: number; oldValue: number } | { name: maxListenersWarningThreshold; newValue: number; oldValue: number } | { name: defaultNetworkId; newValue: undefined | Numbers; oldValue: undefined | Numbers } | { name: defaultChain; newValue: string; oldValue: string } | { name: defaultHardfork; newValue: string; oldValue: string } | { name: defaultCommon; newValue: undefined | Common; oldValue: undefined | Common } | { name: defaultTransactionType; newValue: Numbers; oldValue: Numbers } | { name: defaultMaxPriorityFeePerGas; newValue: Numbers; oldValue: Numbers } | { name: enableExperimentalFeatures; newValue: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean }; oldValue: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean } } | { name: transactionBuilder; newValue: undefined | TransactionBuilder<unknown>; oldValue: undefined | TransactionBuilder<unknown> } | { name: transactionTypeParser; newValue: undefined | TransactionTypeParser; oldValue: undefined | TransactionTypeParser } }[K]
Returns void
eventNames
Returns (string | symbol)[]
getAddress
Parameters
ENSName: string
optionalcoinType: number
Returns Promise<MatchPrimitiveType<bytes, unknown>>
getConfig
Returns Web3ConfigOptions
getContenthash
Parameters
ENSName: string
Returns Promise<MatchPrimitiveType<bytes, unknown>>
getContextObject
Returns Web3ContextObject<EthExecutionAPI & Web3NetAPI, any>
getMaxListeners
Returns number
getOwner
Parameters
name: string
Returns Promise<unknown>
getPubkey
Parameters
ENSName: string
Returns Promise<unknown[] & Record<1, MatchPrimitiveType<bytes32, unknown>> & Record<0, MatchPrimitiveType<bytes32, unknown>> & [] & Record<x, MatchPrimitiveType<bytes32, unknown>> & Record<y, MatchPrimitiveType<bytes32, unknown>>>
getResolver
Parameters
name: string
Returns Promise<Contract<readonly [{ inputs: readonly [{ internalType: contract ENS; name: _ens; type: address }, { internalType: contract INameWrapper; name: wrapperAddress; type: address }, { internalType: address; name: _trustedETHController; type: address }, { internalType: address; name: _trustedReverseRegistrar; type: address }]; stateMutability: nonpayable; type: constructor }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: bytes32; name: node; type: bytes32 }, { indexed: true; internalType: uint256; name: contentType; type: uint256 }]; name: ABIChanged; type: event }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: bytes32; name: node; type: bytes32 }, { indexed: false; internalType: address; name: a; type: address }]; name: AddrChanged; type: event }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: bytes32; name: node; type: bytes32 }, { indexed: false; internalType: uint256; name: coinType; type: uint256 }, { indexed: false; internalType: bytes; name: newAddress; type: bytes }]; name: AddressChanged; type: event }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: address; name: owner; type: address }, { indexed: true; internalType: address; name: operator; type: address }, { indexed: false; internalType: bool; name: approved; type: bool }]; name: ApprovalForAll; type: event }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: bytes32; name: node; type: bytes32 }, { indexed: false; internalType: bytes; name: hash; type: bytes }]; name: ContenthashChanged; type: event }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: bytes32; name: node; type: bytes32 }, { indexed: false; internalType: bytes; name: name; type: bytes }, { indexed: false; internalType: uint16; name: resource; type: uint16 }, { indexed: false; internalType: bytes; name: record; type: bytes }]; name: DNSRecordChanged; type: event }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: bytes32; name: node; type: bytes32 }, { indexed: false; internalType: bytes; name: name; type: bytes }, { indexed: false; internalType: uint16; name: resource; type: uint16 }]; name: DNSRecordDeleted; type: event }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: bytes32; name: node; type: bytes32 }]; name: DNSZoneCleared; type: event }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: bytes32; name: node; type: bytes32 }, { indexed: false; internalType: bytes; name: lastzonehash; type: bytes }, { indexed: false; internalType: bytes; name: zonehash; type: bytes }]; name: DNSZonehashChanged; type: event }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: bytes32; name: node; type: bytes32 }, { indexed: true; internalType: bytes4; name: interfaceID; type: bytes4 }, { indexed: false; internalType: address; name: implementer; type: address }]; name: InterfaceChanged; type: event }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: bytes32; name: node; type: bytes32 }, { indexed: false; internalType: string; name: name; type: string }]; name: NameChanged; type: event }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: bytes32; name: node; type: bytes32 }, { indexed: false; internalType: bytes32; name: x; type: bytes32 }, { indexed: false; internalType: bytes32; name: y; type: bytes32 }]; name: PubkeyChanged; type: event }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: bytes32; name: node; type: bytes32 }, { indexed: true; internalType: string; name: indexedKey; type: string }, { indexed: false; internalType: string; name: key; type: string }]; name: TextChanged; type: event }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }, { internalType: uint256; name: contentTypes; type: uint256 }]; name: ABI; outputs: readonly [{ internalType: uint256; name: ; type: uint256 }, { internalType: bytes; name: ; type: bytes }]; stateMutability: view; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }]; name: addr; outputs: readonly [{ internalType: address payable; name: ; type: address }]; stateMutability: view; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }, { internalType: uint256; name: coinType; type: uint256 }]; name: addr; outputs: readonly [{ internalType: bytes; name: ; type: bytes }]; stateMutability: view; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }]; name: clearDNSZone; outputs: readonly []; stateMutability: nonpayable; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }]; name: contenthash; outputs: readonly [{ internalType: bytes; name: ; type: bytes }]; stateMutability: view; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }, { internalType: bytes32; name: name; type: bytes32 }, { internalType: uint16; name: resource; type: uint16 }]; name: dnsRecord; outputs: readonly [{ internalType: bytes; name: ; type: bytes }]; stateMutability: view; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }, { internalType: bytes32; name: name; type: bytes32 }]; name: hasDNSRecords; outputs: readonly [{ internalType: bool; name: ; type: bool }]; stateMutability: view; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }, { internalType: bytes4; name: interfaceID; type: bytes4 }]; name: interfaceImplementer; outputs: readonly [{ internalType: address; name: ; type: address }]; stateMutability: view; type: function }, { inputs: readonly [{ internalType: address; name: account; type: address }, { internalType: address; name: operator; type: address }]; name: isApprovedForAll; outputs: readonly [{ internalType: bool; name: ; type: bool }]; stateMutability: view; type: function }, { inputs: readonly [{ internalType: bytes[]; name: data; type: bytes[] }]; name: multicall; outputs: readonly [{ internalType: bytes[]; name: results; type: bytes[] }]; stateMutability: nonpayable; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }]; name: name; outputs: readonly [{ internalType: string; name: ; type: string }]; stateMutability: view; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }]; name: pubkey; outputs: readonly [{ internalType: bytes32; name: x; type: bytes32 }, { internalType: bytes32; name: y; type: bytes32 }]; stateMutability: view; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }, { internalType: uint256; name: contentType; type: uint256 }, { internalType: bytes; name: data; type: bytes }]; name: setABI; outputs: readonly []; stateMutability: nonpayable; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }, { internalType: uint256; name: coinType; type: uint256 }, { internalType: bytes; name: a; type: bytes }]; name: setAddr; outputs: readonly []; stateMutability: nonpayable; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }, { internalType: address; name: a; type: address }]; name: setAddr; outputs: readonly []; stateMutability: nonpayable; type: function }, { inputs: readonly [{ internalType: address; name: operator; type: address }, { internalType: bool; name: approved; type: bool }]; name: setApprovalForAll; outputs: readonly []; stateMutability: nonpayable; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }, { internalType: bytes; name: hash; type: bytes }]; name: setContenthash; outputs: readonly []; stateMutability: nonpayable; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }, { internalType: bytes; name: data; type: bytes }]; name: setDNSRecords; outputs: readonly []; stateMutability: nonpayable; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }, { internalType: bytes4; name: interfaceID; type: bytes4 }, { internalType: address; name: implementer; type: address }]; name: setInterface; outputs: readonly []; stateMutability: nonpayable; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }, { internalType: string; name: newName; type: string }]; name: setName; outputs: readonly []; stateMutability: nonpayable; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }, { internalType: bytes32; name: x; type: bytes32 }, { internalType: bytes32; name: y; type: bytes32 }]; name: setPubkey; outputs: readonly []; stateMutability: nonpayable; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }, { internalType: string; name: key; type: string }, { internalType: string; name: value; type: string }]; name: setText; outputs: readonly []; stateMutability: nonpayable; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }, { internalType: bytes; name: hash; type: bytes }]; name: setZonehash; outputs: readonly []; stateMutability: nonpayable; type: function }, { inputs: readonly [{ internalType: bytes4; name: interfaceID; type: bytes4 }]; name: supportsInterface; outputs: readonly [{ internalType: bool; name: ; type: bool }]; stateMutability: view; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }, { internalType: string; name: key; type: string }]; name: text; outputs: readonly [{ internalType: string; name: ; type: string }]; stateMutability: view; type: function }, { inputs: readonly [{ internalType: bytes32; name: node; type: bytes32 }]; name: zonehash; outputs: readonly [{ internalType: bytes; name: ; type: bytes }]; stateMutability: view; type: function }]>>
getTTL
Parameters
name: string
Returns Promise<unknown>
isApprovedForAll
Parameters
owner: string
operator: string
optionalreturnFormat: DataFormat
Returns Promise<unknown>
link
Type parameters
- T: Web3Context<unknown, any, T>
Parameters
parentContext: T
Returns void
listenerCount
Type parameters
- K: CONFIG_CHANGE
Parameters
eventName: K
Returns number
listeners
Type parameters
- K: CONFIG_CHANGE
Parameters
eventName: K
Returns Function[]
off
Type parameters
- K: CONFIG_CHANGE
Parameters
eventName: K
fn: Web3EventCallback<{ CONFIG_CHANGE: { name: handleRevert; newValue: boolean; oldValue: boolean } | { name: defaultAccount; newValue: undefined | string; oldValue: undefined | string } | { name: defaultBlock; newValue: BlockNumberOrTag; oldValue: BlockNumberOrTag } | { name: transactionSendTimeout; newValue: number; oldValue: number } | { name: transactionBlockTimeout; newValue: number; oldValue: number } | { name: transactionConfirmationBlocks; newValue: number; oldValue: number } | { name: transactionPollingInterval; newValue: number; oldValue: number } | { name: transactionPollingTimeout; newValue: number; oldValue: number } | { name: transactionReceiptPollingInterval; newValue: undefined | number; oldValue: undefined | number } | { name: transactionConfirmationPollingInterval; newValue: undefined | number; oldValue: undefined | number } | { name: blockHeaderTimeout; newValue: number; oldValue: number } | { name: maxListenersWarningThreshold; newValue: number; oldValue: number } | { name: defaultNetworkId; newValue: undefined | Numbers; oldValue: undefined | Numbers } | { name: defaultChain; newValue: string; oldValue: string } | { name: defaultHardfork; newValue: string; oldValue: string } | { name: defaultCommon; newValue: undefined | Common; oldValue: undefined | Common } | { name: defaultTransactionType; newValue: Numbers; oldValue: Numbers } | { name: defaultMaxPriorityFeePerGas; newValue: Numbers; oldValue: Numbers } | { name: enableExperimentalFeatures; newValue: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean }; oldValue: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean } } | { name: transactionBuilder; newValue: undefined | TransactionBuilder<unknown>; oldValue: undefined | TransactionBuilder<unknown> } | { name: transactionTypeParser; newValue: undefined | TransactionTypeParser; oldValue: undefined | TransactionTypeParser } }[K]>
Returns void
on
Type parameters
- K: CONFIG_CHANGE
Parameters
eventName: K
fn: Web3EventCallback<{ CONFIG_CHANGE: { name: handleRevert; newValue: boolean; oldValue: boolean } | { name: defaultAccount; newValue: undefined | string; oldValue: undefined | string } | { name: defaultBlock; newValue: BlockNumberOrTag; oldValue: BlockNumberOrTag } | { name: transactionSendTimeout; newValue: number; oldValue: number } | { name: transactionBlockTimeout; newValue: number; oldValue: number } | { name: transactionConfirmationBlocks; newValue: number; oldValue: number } | { name: transactionPollingInterval; newValue: number; oldValue: number } | { name: transactionPollingTimeout; newValue: number; oldValue: number } | { name: transactionReceiptPollingInterval; newValue: undefined | number; oldValue: undefined | number } | { name: transactionConfirmationPollingInterval; newValue: undefined | number; oldValue: undefined | number } | { name: blockHeaderTimeout; newValue: number; oldValue: number } | { name: maxListenersWarningThreshold; newValue: number; oldValue: number } | { name: defaultNetworkId; newValue: undefined | Numbers; oldValue: undefined | Numbers } | { name: defaultChain; newValue: string; oldValue: string } | { name: defaultHardfork; newValue: string; oldValue: string } | { name: defaultCommon; newValue: undefined | Common; oldValue: undefined | Common } | { name: defaultTransactionType; newValue: Numbers; oldValue: Numbers } | { name: defaultMaxPriorityFeePerGas; newValue: Numbers; oldValue: Numbers } | { name: enableExperimentalFeatures; newValue: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean }; oldValue: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean } } | { name: transactionBuilder; newValue: undefined | TransactionBuilder<unknown>; oldValue: undefined | TransactionBuilder<unknown> } | { name: transactionTypeParser; newValue: undefined | TransactionTypeParser; oldValue: undefined | TransactionTypeParser } }[K]>
Returns void
once
Type parameters
- K: CONFIG_CHANGE
Parameters
eventName: K
fn: Web3EventCallback<{ CONFIG_CHANGE: { name: handleRevert; newValue: boolean; oldValue: boolean } | { name: defaultAccount; newValue: undefined | string; oldValue: undefined | string } | { name: defaultBlock; newValue: BlockNumberOrTag; oldValue: BlockNumberOrTag } | { name: transactionSendTimeout; newValue: number; oldValue: number } | { name: transactionBlockTimeout; newValue: number; oldValue: number } | { name: transactionConfirmationBlocks; newValue: number; oldValue: number } | { name: transactionPollingInterval; newValue: number; oldValue: number } | { name: transactionPollingTimeout; newValue: number; oldValue: number } | { name: transactionReceiptPollingInterval; newValue: undefined | number; oldValue: undefined | number } | { name: transactionConfirmationPollingInterval; newValue: undefined | number; oldValue: undefined | number } | { name: blockHeaderTimeout; newValue: number; oldValue: number } | { name: maxListenersWarningThreshold; newValue: number; oldValue: number } | { name: defaultNetworkId; newValue: undefined | Numbers; oldValue: undefined | Numbers } | { name: defaultChain; newValue: string; oldValue: string } | { name: defaultHardfork; newValue: string; oldValue: string } | { name: defaultCommon; newValue: undefined | Common; oldValue: undefined | Common } | { name: defaultTransactionType; newValue: Numbers; oldValue: Numbers } | { name: defaultMaxPriorityFeePerGas; newValue: Numbers; oldValue: Numbers } | { name: enableExperimentalFeatures; newValue: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean }; oldValue: { useRpcCallSpecification: boolean; useSubscriptionWhenCheckingBlockTimeout: boolean } } | { name: transactionBuilder; newValue: undefined | TransactionBuilder<unknown>; oldValue: undefined | TransactionBuilder<unknown> } | { name: transactionTypeParser; newValue: undefined | TransactionTypeParser; oldValue: undefined | TransactionTypeParser } }[K]>
Returns void
recordExists
Parameters
name: string
Returns Promise<unknown>
registerPlugin
Parameters
plugin: Web3PluginBase<unknown>
Returns void
removeAllListeners
Returns EventEmitter
setAddress
Parameters
name: string
address: string
txConfig: NonPayableCallOptions
optionalreturnFormat: DataFormat
Returns Promise<TransactionReceipt | RevertInstructionError>
setApprovalForAll
Parameters
operator: string
approved: boolean
txConfig: NonPayableCallOptions
Returns Promise<TransactionReceipt | RevertInstructionError>
setConfig
Parameters
options: Partial<Web3ConfigOptions>
Returns void
setContenthash
Parameters
name: string
hash: string
txConfig: NonPayableCallOptions
Returns Promise<TransactionReceipt | RevertInstructionError>
setMaxListenerWarningThreshold
Parameters
maxListenersWarningThreshold: number
Returns void
setOwner
Parameters
name: string
address: string
txConfig: NonPayableCallOptions
optionalreturnFormat: DataFormat
Returns Promise<TransactionReceipt | RevertInstructionError>
setProvider
Parameters
optionalprovider: string | SupportedProviders<EthExecutionAPI & Web3NetAPI>
Returns boolean
setPubkey
Parameters
name: string
x: string
y: string
txConfig: NonPayableCallOptions
Returns Promise<TransactionReceipt | RevertInstructionError>
setRecord
Parameters
name: string
owner: string
resolver: string
ttl: number
txConfig: NonPayableCallOptions
Returns Promise<TransactionReceipt | RevertInstructionError>
setResolver
Parameters
name: string
address: string
txConfig: NonPayableCallOptions
optionalreturnFormat: DataFormat
Returns Promise<{ blockHash: string; blockNumber: bigint; contractAddress?: string; cumulativeGasUsed: bigint; effectiveGasPrice?: bigint; from: string; gasUsed: bigint; logs: { readonly id?: string | undefined; readonly removed?: boolean | undefined; readonly logIndex?: bigint | undefined; readonly transactionIndex?: bigint | undefined; readonly transactionHash?: string | undefined; ... 4 more ...; readonly topics?: string[] | undefined; }[]; logsBloom: string; root: string; status: bigint; to: string; transactionHash: string; transactionIndex: bigint; type?: bigint } | { code: bigint; innerError: undefined | { name: string; message: string; stack?: string | undefined; } | { name: string; message: string; stack?: string | undefined; }[]; name: string; reason: string; signature: string; stack: undefined | string; toJSON: any }>
setSubnodeOwner
Parameters
node: string
label: string
address: string
txConfig: NonPayableCallOptions
optionalreturnFormat: DataFormat
Returns Promise<TransactionReceipt | RevertInstructionError>
setSubnodeRecord
Parameters
name: string
label: string
owner: string
resolver: string
ttl: number
txConfig: NonPayableCallOptions
optionalreturnFormat: DataFormat
Returns Promise<TransactionReceipt | RevertInstructionError>
setTTL
Parameters
name: string
ttl: number
txConfig: NonPayableCallOptions
Returns Promise<TransactionReceipt | RevertInstructionError>
supportsInterface
Parameters
ENSName: string
interfaceId: string
Returns Promise<MatchPrimitiveType<bool, unknown>>
use
Type parameters
- T: Web3Context<unknown, any, T>
- T2: unknown[]
Parameters
ContextRef: Web3ContextConstructor<T, T2>
rest...args: [...T2[]]
Returns T
staticfromContextObject
Type parameters
- T: Web3Context<unknown, any, T>
- T3: unknown[]
Parameters
this: Web3ContextConstructor<T, T3>
rest...args: [Web3ContextObject<unknown, any>, ...T3[]]
Returns T
constregistryAddresses
Type declaration
[T string]: string
iban
Iban
Re-exports Iban
default
Renames and re-exports Iban
IbanOptions
Type declaration
identifier: string
institution: string
personal
Personal
Re-exports Personal
default
Renames and re-exports Personal
Classes
LogsSubscription
constructor
Parameters
args: { address?: string | string[]; fromBlock?: BlockNumberOrTag; topics?: string[] }
options: { requestManager: Web3RequestManager<EthExecutionAPI>; returnFormat?: DataFormat }
Returns LogsSubscription
readonlyargs
Type declaration
optionalreadonlyaddress?: string | string[]
optionalreadonlyfromBlock?: BlockNumberOrTag
optionalreadonlytopics?: string[]
id
Returns undefined | string
lastBlock
Returns undefined | BlockOutput
_processSubscriptionError
Parameters
error: Error
Returns void
_processSubscriptionResult
Parameters
data: LogsOutput
Returns void
emit
Type parameters
- K: Web3EventKey<CommonSubscriptionEvents & { data: LogsOutput }>
Parameters
eventName: K
params: CommonSubscriptionEvents & { data: LogsOutput }[K]
Returns void
eventNames
Returns (string | symbol)[]
getMaxListeners
Returns number
listenerCount
Type parameters
- K: Web3EventKey<CommonSubscriptionEvents & { data: LogsOutput }>
Parameters
eventName: K
Returns number
listeners
Type parameters
- K: Web3EventKey<CommonSubscriptionEvents & { data: LogsOutput }>
Parameters
eventName: K
Returns Function[]
off
Type parameters
- K: Web3EventKey<CommonSubscriptionEvents & { data: LogsOutput }>
Parameters
eventName: K
fn: Web3EventCallback<CommonSubscriptionEvents & { data: LogsOutput }[K]>
Returns void
on
Type parameters
- K: Web3EventKey<CommonSubscriptionEvents & { data: LogsOutput }>
Parameters
eventName: K
fn: Web3EventCallback<CommonSubscriptionEvents & { data: LogsOutput }[K]>
Returns void
once
Type parameters
- K: Web3EventKey<CommonSubscriptionEvents & { data: LogsOutput }>
Parameters
eventName: K
fn: Web3EventCallback<CommonSubscriptionEvents & { data: LogsOutput }[K]>
Returns void
removeAllListeners
Returns EventEmitter
resubscribe
Returns Promise<void>
setMaxListenerWarningThreshold
Parameters
maxListenersWarningThreshold: number
Returns void
subscribe
Returns Promise<void>
unsubscribe
Returns Promise<void>
NewHeadsSubscription
constructor
Parameters
args: any
options: { requestManager: Web3RequestManager<EthExecutionAPI>; returnFormat?: DataFormat }
Returns NewHeadsSubscription
readonlyargs
id
Returns undefined | string
lastBlock
Returns undefined | BlockOutput
emit
Type parameters
- K: Web3EventKey<CommonSubscriptionEvents & { data: BlockHeaderOutput }>
Parameters
eventName: K
params: CommonSubscriptionEvents & { data: BlockHeaderOutput }[K]
Returns void
eventNames
Returns (string | symbol)[]
getMaxListeners
Returns number
listenerCount
Type parameters
- K: Web3EventKey<CommonSubscriptionEvents & { data: BlockHeaderOutput }>
Parameters
eventName: K
Returns number
listeners
Type parameters
- K: Web3EventKey<CommonSubscriptionEvents & { data: BlockHeaderOutput }>
Parameters
eventName: K
Returns Function[]
off
Type parameters
- K: Web3EventKey<CommonSubscriptionEvents & { data: BlockHeaderOutput }>
Parameters
eventName: K
fn: Web3EventCallback<CommonSubscriptionEvents & { data: BlockHeaderOutput }[K]>
Returns void
on
Type parameters
- K: Web3EventKey<CommonSubscriptionEvents & { data: BlockHeaderOutput }>
Parameters
eventName: K
fn: Web3EventCallback<CommonSubscriptionEvents & { data: BlockHeaderOutput }[K]>
Returns void
once
Type parameters
- K: Web3EventKey<CommonSubscriptionEvents & { data: BlockHeaderOutput }>
Parameters
eventName: K
fn: Web3EventCallback<CommonSubscriptionEvents & { data: BlockHeaderOutput }[K]>
Returns void
removeAllListeners
Returns EventEmitter
resubscribe
Returns Promise<void>
setMaxListenerWarningThreshold
Parameters
maxListenersWarningThreshold: number
Returns void
subscribe
Returns Promise<void>
unsubscribe
Returns Promise<void>
NewPendingTransactionsSubscription
constructor
Parameters
args: any
options: { requestManager: Web3RequestManager<EthExecutionAPI>; returnFormat?: DataFormat }
Returns NewPendingTransactionsSubscription
readonlyargs
id
Returns undefined | string
lastBlock
Returns undefined | BlockOutput
emit
Type parameters
- K: Web3EventKey<CommonSubscriptionEvents & { data: string }>
Parameters
eventName: K
params: CommonSubscriptionEvents & { data: string }[K]
Returns void
eventNames
Returns (string | symbol)[]
getMaxListeners
Returns number
listenerCount
Type parameters
- K: Web3EventKey<CommonSubscriptionEvents & { data: string }>
Parameters
eventName: K
Returns number
listeners
Type parameters
- K: Web3EventKey<CommonSubscriptionEvents & { data: string }>
Parameters
eventName: K
Returns Function[]
off
Type parameters
- K: Web3EventKey<CommonSubscriptionEvents & { data: string }>
Parameters
eventName: K
fn: Web3EventCallback<CommonSubscriptionEvents & { data: string }[K]>
Returns void
on
Type parameters
- K: Web3EventKey<CommonSubscriptionEvents & { data: string }>
Parameters
eventName: K
fn: Web3EventCallback<CommonSubscriptionEvents & { data: string }[K]>
Returns void
once
Type parameters
- K: Web3EventKey<CommonSubscriptionEvents & { data: string }>
Parameters
eventName: K
fn: Web3EventCallback<CommonSubscriptionEvents & { data: string }[K]>
Returns void
removeAllListeners
Returns EventEmitter
resubscribe
Returns Promise<void>
setMaxListenerWarningThreshold
Parameters
maxListenersWarningThreshold: number
Returns void
subscribe
Returns Promise<void>
unsubscribe
Returns Promise<void>
SyncingSubscription
constructor
Parameters
args: any
options: { requestManager: Web3RequestManager<EthExecutionAPI>; returnFormat?: DataFormat }
Returns SyncingSubscription
readonlyargs
id
Returns undefined | string
lastBlock
Returns undefined | BlockOutput
emit
Type parameters
- K: Web3EventKey<CommonSubscriptionEvents & { changed: boolean; data: SyncOutput }>
Parameters
eventName: K
params: CommonSubscriptionEvents & { changed: boolean; data: SyncOutput }[K]
Returns void
eventNames
Returns (string | symbol)[]
getMaxListeners
Returns number
listenerCount
Type parameters
- K: Web3EventKey<CommonSubscriptionEvents & { changed: boolean; data: SyncOutput }>
Parameters
eventName: K
Returns number
listeners
Type parameters
- K: Web3EventKey<CommonSubscriptionEvents & { changed: boolean; data: SyncOutput }>
Parameters
eventName: K
Returns Function[]
off
Type parameters
- K: Web3EventKey<CommonSubscriptionEvents & { changed: boolean; data: SyncOutput }>
Parameters
eventName: K
fn: Web3EventCallback<CommonSubscriptionEvents & { changed: boolean; data: SyncOutput }[K]>
Returns void
on
Type parameters
- K: Web3EventKey<CommonSubscriptionEvents & { changed: boolean; data: SyncOutput }>
Parameters
eventName: K
fn: Web3EventCallback<CommonSubscriptionEvents & { changed: boolean; data: SyncOutput }[K]>
Returns void
once
Type parameters
- K: Web3EventKey<CommonSubscriptionEvents & { changed: boolean; data: SyncOutput }>
Parameters
eventName: K
fn: Web3EventCallback<CommonSubscriptionEvents & { changed: boolean; data: SyncOutput }[K]>
Returns void
removeAllListeners
Returns EventEmitter
resubscribe
Returns Promise<void>
setMaxListenerWarningThreshold
Parameters
maxListenersWarningThreshold: number
Returns void
subscribe
Returns Promise<void>
unsubscribe
Returns Promise<void>
Interfaces
RevertReason
optionaldata
reason
optionalsignature
RevertReasonWithCustomError
customErrorArguments
customErrorDecodedSignature
customErrorName
optionaldata
reason
optionalsignature
SendSignedTransactionOptions
Type parameters
- ResolveType = TransactionReceipt
optionalcheckRevertBeforeSending
optionalcontractAbi
optionaltransactionResolver
Parameters
receipt: TransactionReceipt
Returns ResolveType
SendTransactionOptions
Type parameters
- ResolveType = TransactionReceipt
optionalcheckRevertBeforeSending
optionalcontractAbi
optionalignoreGasPricing
optionaltransactionResolver
Parameters
receipt: TransactionReceipt
Returns ResolveType
Type Aliases
InternalTransaction
SendSignedTransactionEvents
Type parameters
- ReturnFormat: DataFormat
Type declaration
confirmation: { confirmations: FormatType<Numbers, ReturnFormat>; latestBlockHash: FormatType<Bytes, ReturnFormat>; receipt: FormatType<TransactionReceipt, ReturnFormat> }
confirmations: FormatType<Numbers, ReturnFormat>
latestBlockHash: FormatType<Bytes, ReturnFormat>
receipt: FormatType<TransactionReceipt, ReturnFormat>
error: TransactionRevertedWithoutReasonError<FormatType<TransactionReceipt, ReturnFormat>> | TransactionRevertInstructionError<FormatType<TransactionReceipt, ReturnFormat>> | TransactionRevertWithCustomError<FormatType<TransactionReceipt, ReturnFormat>> | InvalidResponseError | ContractExecutionError
receipt: FormatType<TransactionReceipt, ReturnFormat>
sending: FormatType<Bytes, typeof ETH_DATA_FORMAT>
sent: FormatType<Bytes, typeof ETH_DATA_FORMAT>
transactionHash: FormatType<Bytes, ReturnFormat>
SendTransactionEvents
Type parameters
- ReturnFormat: DataFormat
Type declaration
confirmation: { confirmations: FormatType<Numbers, ReturnFormat>; latestBlockHash: FormatType<Bytes, ReturnFormat>; receipt: FormatType<TransactionReceipt, ReturnFormat> }
confirmations: FormatType<Numbers, ReturnFormat>
latestBlockHash: FormatType<Bytes, ReturnFormat>
receipt: FormatType<TransactionReceipt, ReturnFormat>
error: TransactionRevertedWithoutReasonError<FormatType<TransactionReceipt, ReturnFormat>> | TransactionRevertInstructionError<FormatType<TransactionReceipt, ReturnFormat>> | TransactionRevertWithCustomError<FormatType<TransactionReceipt, ReturnFormat>> | InvalidResponseError | ContractExecutionError
receipt: FormatType<TransactionReceipt, ReturnFormat>
sending: FormatType<Transaction, typeof ETH_DATA_FORMAT>
sent: FormatType<Transaction, typeof ETH_DATA_FORMAT>
transactionHash: FormatType<Bytes, ReturnFormat>
Variables
constaccessListItemSchema
Type declaration
properties: { address: { eth: string }; storageKeys: { items: { eth: string }; type: string } }
address: { eth: string }
eth: string
storageKeys: { items: { eth: string }; type: string }
items: { eth: string }
eth: string
type: string
type: string
constaccessListResultSchema
Type declaration
properties: { accessList: { items: { properties: { address: { eth: string }; storageKeys: { items: { eth: string }; type: string } }; type: string }; type: string }; gasUsed: { type: string } }
accessList: { items: { properties: { address: { eth: string }; storageKeys: { items: { eth: string }; type: string } }; type: string }; type: string }
items: { properties: { address: { eth: string }; storageKeys: { items: { eth: string }; type: string } }; type: string }
properties: { address: { eth: string }; storageKeys: { items: { eth: string }; type: string } }
address: { eth: string }
eth: string
storageKeys: { items: { eth: string }; type: string }
items: { eth: string }
eth: string
type: string
type: string
type: string
gasUsed: { type: string }
type: string
type: string
constaccessListSchema
Type declaration
items: { properties: { address: { eth: string }; storageKeys: { items: { eth: string }; type: string } }; type: string }
properties: { address: { eth: string }; storageKeys: { items: { eth: string }; type: string } }
address: { eth: string }
eth: string
storageKeys: { items: { eth: string }; type: string }
items: { eth: string }
eth: string
type: string
type: string
type: string
constaccountSchema
Type declaration
properties: { accountProof: { items: { eth: string }; type: string }; balance: { eth: string }; codeHash: { eth: string }; nonce: { eth: string }; storageHash: { eth: string }; storageProof: { items: { properties: { key: { eth: string }; proof: { items: { eth: string }; type: string }; value: { eth: string } }; type: string }; type: string } }
accountProof: { items: { eth: string }; type: string }
items: { eth: string }
eth: string
type: string
balance: { eth: string }
eth: string
codeHash: { eth: string }
eth: string
nonce: { eth: string }
eth: string
storageHash: { eth: string }
eth: string
storageProof: { items: { properties: { key: { eth: string }; proof: { items: { eth: string }; type: string }; value: { eth: string } }; type: string }; type: string }
items: { properties: { key: { eth: string }; proof: { items: { eth: string }; type: string }; value: { eth: string } }; type: string }
properties: { key: { eth: string }; proof: { items: { eth: string }; type: string }; value: { eth: string } }
key: { eth: string }
eth: string
proof: { items: { eth: string }; type: string }
items: { eth: string }
eth: string
type: string
value: { eth: string }
eth: string
type: string
type: string
type: string
constblockHeaderSchema
Type declaration
properties: { difficulty: { eth: string }; extraData: { eth: string }; gasLimit: { eth: string }; gasUsed: { eth: string }; logsBloom: { eth: string }; miner: { eth: string }; nonce: { eth: string }; number: { eth: string }; parentHash: { eth: string }; receiptRoot: { eth: string }; sha3Uncles: { eth: string }; stateRoot: { eth: string }; timestamp: { eth: string }; transactionsRoot: { eth: string } }
difficulty: { eth: string }
eth: string
extraData: { eth: string }
eth: string
gasLimit: { eth: string }
eth: string
gasUsed: { eth: string }
eth: string
logsBloom: { eth: string }
eth: string
miner: { eth: string }
eth: string
nonce: { eth: string }
eth: string
number: { eth: string }
eth: string
parentHash: { eth: string }
eth: string
receiptRoot: { eth: string }
eth: string
sha3Uncles: { eth: string }
eth: string
stateRoot: { eth: string }
eth: string
timestamp: { eth: string }
eth: string
transactionsRoot: { eth: string }
eth: string
type: string
constblockSchema
Type declaration
properties: { baseFeePerGas: { eth: string }; difficulty: { eth: string }; extraData: { eth: string }; gasLimit: { eth: string }; gasUsed: { eth: string }; hash: { eth: string }; logsBloom: { eth: string }; miner: { eth: string }; mixHash: { eth: string }; nonce: { eth: string }; number: { eth: string }; parentHash: { eth: string }; receiptsRoot: { eth: string }; sha3Uncles: { eth: string }; size: { eth: string }; stateRoot: { eth: string }; timestamp: { eth: string }; totalDifficulty: { eth: string }; transactions: { oneOf: ({ items: { eth?: undefined; properties: { accessList: { items: { properties: { address: { eth: string }; storageKeys: { items: { eth: string }; type: string } }; type: string }; type: string }; blockHash: { eth: string }; blockNumber: { eth: string }; chain: { enum: string[]; type: string }; chainId: { eth: string }; common: { properties: { baseChain: { enum: string[]; type: string }; customChain: { properties: { chainId: { eth: string }; name: { eth: string }; networkId: { eth: string } }; type: string }; hardfork: { enum: string[]; type: string } }; type: string }; data: { eth: string }; effectiveGasPrice: { eth: string }; from: { eth: string }; gas: { eth: string }; gasLimit: { eth: string }; gasPrice: { eth: string }; hardfork: { enum: string[]; type: string }; hash: { eth: string }; input: { eth: string }; maxFeePerGas: { eth: string }; maxPriorityFeePerGas: { eth: string }; networkId: { eth: string }; nonce: { eth: string }; r: { eth: string }; s: { eth: string }; to: { oneOf: ({ eth: string; type?: undefined } | { eth?: undefined; type: string })[] }; transactionIndex: { eth: string }; type: { eth: string }; v: { eth: string }; value: { eth: string } }; type: string }; type: string } | { items: { eth: string }; type: string })[] }; transactionsRoot: { eth: string }; uncles: { items: { eth: string }; type: string } }
baseFeePerGas: { eth: string }
eth: string
difficulty: { eth: string }
eth: string
extraData: { eth: string }
eth: string
gasLimit: { eth: string }
eth: string
gasUsed: { eth: string }
eth: string
hash: { eth: string }
eth: string
logsBloom: { eth: string }
eth: string
miner: { eth: string }
eth: string
mixHash: { eth: string }
eth: string
nonce: { eth: string }
eth: string
number: { eth: string }
eth: string
parentHash: { eth: string }
eth: string
receiptsRoot: { eth: string }
eth: string
sha3Uncles: { eth: string }
eth: string
size: { eth: string }
eth: string
stateRoot: { eth: string }
eth: string
timestamp: { eth: string }
eth: string
totalDifficulty: { eth: string }
eth: string
transactions: { oneOf: ({ items: { eth?: undefined; properties: { accessList: { items: { properties: { address: { eth: string }; storageKeys: { items: { eth: string }; type: string } }; type: string }; type: string }; blockHash: { eth: string }; blockNumber: { eth: string }; chain: { enum: string[]; type: string }; chainId: { eth: string }; common: { properties: { baseChain: { enum: string[]; type: string }; customChain: { properties: { chainId: { eth: string }; name: { eth: string }; networkId: { eth: string } }; type: string }; hardfork: { enum: string[]; type: string } }; type: string }; data: { eth: string }; effectiveGasPrice: { eth: string }; from: { eth: string }; gas: { eth: string }; gasLimit: { eth: string }; gasPrice: { eth: string }; hardfork: { enum: string[]; type: string }; hash: { eth: string }; input: { eth: string }; maxFeePerGas: { eth: string }; maxPriorityFeePerGas: { eth: string }; networkId: { eth: string }; nonce: { eth: string }; r: { eth: string }; s: { eth: string }; to: { oneOf: ({ eth: string; type?: undefined } | { eth?: undefined; type: string })[] }; transactionIndex: { eth: string }; type: { eth: string }; v: { eth: string }; value: { eth: string } }; type: string }; type: string } | { items: { eth: string }; type: string })[] }
oneOf: ({ items: { eth?: undefined; properties: { accessList: { items: { properties: { address: { eth: string }; storageKeys: { items: { eth: string }; type: string } }; type: string }; type: string }; blockHash: { eth: string }; blockNumber: { eth: string }; chain: { enum: string[]; type: string }; chainId: { eth: string }; common: { properties: { baseChain: { enum: string[]; type: string }; customChain: { properties: { chainId: { eth: string }; name: { eth: string }; networkId: { eth: string } }; type: string }; hardfork: { enum: string[]; type: string } }; type: string }; data: { eth: string }; effectiveGasPrice: { eth: string }; from: { eth: string }; gas: { eth: string }; gasLimit: { eth: string }; gasPrice: { eth: string }; hardfork: { enum: string[]; type: string }; hash: { eth: string }; input: { eth: string }; maxFeePerGas: { eth: string }; maxPriorityFeePerGas: { eth: string }; networkId: { eth: string }; nonce: { eth: string }; r: { eth: string }; s: { eth: string }; to: { oneOf: ({ eth: string; type?: undefined } | { eth?: undefined; type: string })[] }; transactionIndex: { eth: string }; type: { eth: string }; v: { eth: string }; value: { eth: string } }; type: string }; type: string } | { items: { eth: string }; type: string })[]
transactionsRoot: { eth: string }
eth: string
uncles: { items: { eth: string }; type: string }
items: { eth: string }
eth: string
type: string
type: string
constchainSchema
Type declaration
enum: string[]
type: string
constcustomChainSchema
Type declaration
properties: { chainId: { eth: string }; name: { eth: string }; networkId: { eth: string } }
chainId: { eth: string }
eth: string
name: { eth: string }
eth: string
networkId: { eth: string }
eth: string
type: string
constfeeHistorySchema
Type declaration
properties: { baseFeePerGas: { items: { eth: string }; type: string }; gasUsedRatio: { items: { type: string }; type: string }; oldestBlock: { eth: string }; reward: { items: { items: { eth: string }; type: string }; type: string } }
baseFeePerGas: { items: { eth: string }; type: string }
items: { eth: string }
eth: string
type: string
gasUsedRatio: { items: { type: string }; type: string }
items: { type: string }
type: string
type: string
oldestBlock: { eth: string }
eth: string
reward: { items: { items: { eth: string }; type: string }; type: string }
items: { items: { eth: string }; type: string }
items: { eth: string }
eth: string
type: string
type: string
type: string
consthardforkSchema
Type declaration
enum: string[]
type: string
constlogSchema
Type declaration
properties: { address: { eth: string }; blockHash: { eth: string }; blockNumber: { eth: string }; data: { eth: string }; logIndex: { eth: string }; removed: { eth: string }; topics: { items: { eth: string }; type: string }; transactionHash: { eth: string }; transactionIndex: { eth: string } }
address: { eth: string }
eth: string
blockHash: { eth: string }
eth: string
blockNumber: { eth: string }
eth: string
data: { eth: string }
eth: string
logIndex: { eth: string }
eth: string
removed: { eth: string }
eth: string
topics: { items: { eth: string }; type: string }
items: { eth: string }
eth: string
type: string
transactionHash: { eth: string }
eth: string
transactionIndex: { eth: string }
eth: string
type: string
constregisteredSubscriptions
Type declaration
logs: typeof LogsSubscription
newBlockHeaders: typeof NewHeadsSubscription
newHeads: typeof NewHeadsSubscription
newPendingTransactions: typeof NewPendingTransactionsSubscription
pendingTransactions: typeof NewPendingTransactionsSubscription
syncing: typeof SyncingSubscription
conststorageProofSchema
Type declaration
properties: { key: { eth: string }; proof: { items: { eth: string }; type: string }; value: { eth: string } }
key: { eth: string }
eth: string
proof: { items: { eth: string }; type: string }
items: { eth: string }
eth: string
type: string
value: { eth: string }
eth: string
type: string
constsyncSchema
Type declaration
properties: { currentBlock: { eth: string }; highestBlock: { eth: string }; knownStates: { eth: string }; pulledStates: { eth: string }; startingBlock: { eth: string } }
currentBlock: { eth: string }
eth: string
highestBlock: { eth: string }
eth: string
knownStates: { eth: string }
eth: string
pulledStates: { eth: string }
eth: string
startingBlock: { eth: string }
eth: string
type: string
consttransactionInfoSchema
Type declaration
properties: { accessList: { items: { properties: { address: { eth: string }; storageKeys: { items: { eth: string }; type: string } }; type: string }; type: string }; blockHash: { eth: string }; blockNumber: { eth: string }; chain: { enum: string[]; type: string }; chainId: { eth: string }; common: { properties: { baseChain: { enum: string[]; type: string }; customChain: { properties: { chainId: { eth: string }; name: { eth: string }; networkId: { eth: string } }; type: string }; hardfork: { enum: string[]; type: string } }; type: string }; data: { eth: string }; effectiveGasPrice: { eth: string }; from: { eth: string }; gas: { eth: string }; gasLimit: { eth: string }; gasPrice: { eth: string }; hardfork: { enum: string[]; type: string }; hash: { eth: string }; input: { eth: string }; maxFeePerGas: { eth: string }; maxPriorityFeePerGas: { eth: string }; networkId: { eth: string }; nonce: { eth: string }; r: { eth: string }; s: { eth: string }; to: { oneOf: ({ eth: string; type?: undefined } | { eth?: undefined; type: string })[] }; transactionIndex: { eth: string }; type: { eth: string }; v: { eth: string }; value: { eth: string } }
accessList: { items: { properties: { address: { eth: string }; storageKeys: { items: { eth: string }; type: string } }; type: string }; type: string }
items: { properties: { address: { eth: string }; storageKeys: { items: { eth: string }; type: string } }; type: string }
properties: { address: { eth: string }; storageKeys: { items: { eth: string }; type: string } }
address: { eth: string }
eth: string
storageKeys: { items: { eth: string }; type: string }
items: { eth: string }
eth: string
type: string
type: string
type: string
blockHash: { eth: string }
eth: string
blockNumber: { eth: string }
eth: string
chain: { enum: string[]; type: string }
enum: string[]
type: string
chainId: { eth: string }
eth: string
common: { properties: { baseChain: { enum: string[]; type: string }; customChain: { properties: { chainId: { eth: string }; name: { eth: string }; networkId: { eth: string } }; type: string }; hardfork: { enum: string[]; type: string } }; type: string }
properties: { baseChain: { enum: string[]; type: string }; customChain: { properties: { chainId: { eth: string }; name: { eth: string }; networkId: { eth: string } }; type: string }; hardfork: { enum: string[]; type: string } }
baseChain: { enum: string[]; type: string }
enum: string[]
type: string
customChain: { properties: { chainId: { eth: string }; name: { eth: string }; networkId: { eth: string } }; type: string }
properties: { chainId: { eth: string }; name: { eth: string }; networkId: { eth: string } }
chainId: { eth: string }
eth: string
name: { eth: string }
eth: string
networkId: { eth: string }
eth: string
type: string
hardfork: { enum: string[]; type: string }
enum: string[]
type: string
type: string
data: { eth: string }
eth: string
effectiveGasPrice: { eth: string }
eth: string
from: { eth: string }
eth: string
gas: { eth: string }
eth: string
gasLimit: { eth: string }
eth: string
gasPrice: { eth: string }
eth: string
hardfork: { enum: string[]; type: string }
enum: string[]
type: string
hash: { eth: string }
eth: string
input: { eth: string }
eth: string
maxFeePerGas: { eth: string }
eth: string
maxPriorityFeePerGas: { eth: string }
eth: string
networkId: { eth: string }
eth: string
nonce: { eth: string }
eth: string
r: { eth: string }
eth: string
s: { eth: string }
eth: string
to: { oneOf: ({ eth: string; type?: undefined } | { eth?: undefined; type: string })[] }
oneOf: ({ eth: string; type?: undefined } | { eth?: undefined; type: string })[]
transactionIndex: { eth: string }
eth: string
type: { eth: string }
eth: string
v: { eth: string }
eth: string
value: { eth: string }
eth: string
type: string
consttransactionReceiptSchema
Type declaration
properties: { blockHash: { eth: string }; blockNumber: { eth: string }; contractAddress: { eth: string }; cumulativeGasUsed: { eth: string }; effectiveGasPrice: { eth: string }; from: { eth: string }; gasUsed: { eth: string }; logs: { items: { properties: { address: { eth: string }; blockHash: { eth: string }; blockNumber: { eth: string }; data: { eth: string }; logIndex: { eth: string }; removed: { eth: string }; topics: { items: { eth: string }; type: string }; transactionHash: { eth: string }; transactionIndex: { eth: string } }; type: string }; type: string }; logsBloom: { eth: string }; root: { eth: string }; status: { eth: string }; to: { eth: string }; transactionHash: { eth: string }; transactionIndex: { eth: string }; type: { eth: string } }
blockHash: { eth: string }
eth: string
blockNumber: { eth: string }
eth: string
contractAddress: { eth: string }
eth: string
cumulativeGasUsed: { eth: string }
eth: string
effectiveGasPrice: { eth: string }
eth: string
from: { eth: string }
eth: string
gasUsed: { eth: string }
eth: string
logs: { items: { properties: { address: { eth: string }; blockHash: { eth: string }; blockNumber: { eth: string }; data: { eth: string }; logIndex: { eth: string }; removed: { eth: string }; topics: { items: { eth: string }; type: string }; transactionHash: { eth: string }; transactionIndex: { eth: string } }; type: string }; type: string }
items: { properties: { address: { eth: string }; blockHash: { eth: string }; blockNumber: { eth: string }; data: { eth: string }; logIndex: { eth: string }; removed: { eth: string }; topics: { items: { eth: string }; type: string }; transactionHash: { eth: string }; transactionIndex: { eth: string } }; type: string }
properties: { address: { eth: string }; blockHash: { eth: string }; blockNumber: { eth: string }; data: { eth: string }; logIndex: { eth: string }; removed: { eth: string }; topics: { items: { eth: string }; type: string }; transactionHash: { eth: string }; transactionIndex: { eth: string } }
address: { eth: string }
eth: string
blockHash: { eth: string }
eth: string
blockNumber: { eth: string }
eth: string
data: { eth: string }
eth: string
logIndex: { eth: string }
eth: string
removed: { eth: string }
eth: string
topics: { items: { eth: string }; type: string }
items: { eth: string }
eth: string
type: string
transactionHash: { eth: string }
eth: string
transactionIndex: { eth: string }
eth: string
type: string
type: string
logsBloom: { eth: string }
eth: string
root: { eth: string }
eth: string
status: { eth: string }
eth: string
to: { eth: string }
eth: string
transactionHash: { eth: string }
eth: string
transactionIndex: { eth: string }
eth: string
type: { eth: string }
eth: string
type: string
consttransactionSchema
Type declaration
properties: { accessList: { items: { properties: { address: { eth: string }; storageKeys: { items: { eth: string }; type: string } }; type: string }; type: string }; chain: { enum: string[]; type: string }; chainId: { eth: string }; common: { properties: { baseChain: { enum: string[]; type: string }; customChain: { properties: { chainId: { eth: string }; name: { eth: string }; networkId: { eth: string } }; type: string }; hardfork: { enum: string[]; type: string } }; type: string }; data: { eth: string }; effectiveGasPrice: { eth: string }; from: { eth: string }; gas: { eth: string }; gasLimit: { eth: string }; gasPrice: { eth: string }; hardfork: { enum: string[]; type: string }; input: { eth: string }; maxFeePerGas: { eth: string }; maxPriorityFeePerGas: { eth: string }; networkId: { eth: string }; nonce: { eth: string }; r: { eth: string }; s: { eth: string }; to: { oneOf: ({ eth: string; type?: undefined } | { eth?: undefined; type: string })[] }; type: { eth: string }; v: { eth: string }; value: { eth: string } }
accessList: { items: { properties: { address: { eth: string }; storageKeys: { items: { eth: string }; type: string } }; type: string }; type: string }
items: { properties: { address: { eth: string }; storageKeys: { items: { eth: string }; type: string } }; type: string }
properties: { address: { eth: string }; storageKeys: { items: { eth: string }; type: string } }
address: { eth: string }
eth: string
storageKeys: { items: { eth: string }; type: string }
items: { eth: string }
eth: string
type: string
type: string
type: string
chain: { enum: string[]; type: string }
enum: string[]
type: string
chainId: { eth: string }
eth: string
common: { properties: { baseChain: { enum: string[]; type: string }; customChain: { properties: { chainId: { eth: string }; name: { eth: string }; networkId: { eth: string } }; type: string }; hardfork: { enum: string[]; type: string } }; type: string }
properties: { baseChain: { enum: string[]; type: string }; customChain: { properties: { chainId: { eth: string }; name: { eth: string }; networkId: { eth: string } }; type: string }; hardfork: { enum: string[]; type: string } }
baseChain: { enum: string[]; type: string }
enum: string[]
type: string
customChain: { properties: { chainId: { eth: string }; name: { eth: string }; networkId: { eth: string } }; type: string }
properties: { chainId: { eth: string }; name: { eth: string }; networkId: { eth: string } }
chainId: { eth: string }
eth: string
name: { eth: string }
eth: string
networkId: { eth: string }
eth: string
type: string
hardfork: { enum: string[]; type: string }
enum: string[]
type: string
type: string
data: { eth: string }
eth: string
effectiveGasPrice: { eth: string }
eth: string
from: { eth: string }
eth: string
gas: { eth: string }
eth: string
gasLimit: { eth: string }
eth: string
gasPrice: { eth: string }
eth: string
hardfork: { enum: string[]; type: string }
enum: string[]
type: string
input: { eth: string }
eth: string
maxFeePerGas: { eth: string }
eth: string
maxPriorityFeePerGas: { eth: string }
eth: string
networkId: { eth: string }
eth: string
nonce: { eth: string }
eth: string
r: { eth: string }
eth: string
s: { eth: string }
eth: string
to: { oneOf: ({ eth: string; type?: undefined } | { eth?: undefined; type: string })[] }
oneOf: ({ eth: string; type?: undefined } | { eth?: undefined; type: string })[]
type: { eth: string }
eth: string
v: { eth: string }
eth: string
value: { eth: string }
eth: string
type: string
Functions
call
Type parameters
- ReturnFormat: DataFormat
Parameters
web3Context: Web3Context<EthExecutionAPI, any>
transaction: TransactionCall
blockNumber: undefined | BlockNumberOrTag
returnFormat: ReturnFormat
Returns Promise<string>
createAccessList
Type parameters
- ReturnFormat: DataFormat
Parameters
web3Context: Web3Context<EthExecutionAPI, any>
transaction: TransactionForAccessList
blockNumber: undefined | BlockNumberOrTag
returnFormat: ReturnFormat
Returns Promise<{ accessList?: { address?: string; storageKeys?: string[] }[]; gasUsed?: NumberTypes[ReturnFormat[number]] }>
detectTransactionType
Parameters
transaction: { accessList?: { readonly address?: string | undefined; readonly storageKeys?: string[] | undefined; }[]; chain?: ValidChains; chainId?: string; common?: { customChain: { name?: string | undefined; networkId: string; chainId: string; }; baseChain?: ValidChains | undefined; hardfork?: Hardfork | undefined; }; data?: string; from?: string; gas?: string; gasLimit?: string; gasPrice?: string; hardfork?: Hardfork; input?: string; maxFeePerGas?: string; maxPriorityFeePerGas?: string; networkId?: string; nonce?: string; r?: string; s?: string; to?: null | string; type?: string; v?: string; value?: string; yParity?: string }
optionalweb3Context: Web3Context<EthExecutionAPI, any>
Returns undefined | string
estimateGas
Type parameters
- ReturnFormat: DataFormat
Parameters
web3Context: Web3Context<EthExecutionAPI, any>
transaction: Transaction
blockNumber: undefined | BlockNumberOrTag
returnFormat: ReturnFormat
Returns Promise<NumberTypes[ReturnFormat[number]]>
formatTransaction
Type parameters
- ReturnFormat: DataFormat = { bytes: HEX; number: BIGINT }
- TransactionType: Transaction = Transaction
Parameters
transaction: TransactionType
optionalreturnFormat: ReturnFormat
optionaloptions: { transactionSchema: { properties: { accessList: { items: { properties: { address: { eth: string }; storageKeys: { items: { eth: string }; type: string } }; type: string }; type: string }; chain: { enum: string[]; type: string }; chainId: { eth: string }; common: { properties: { baseChain: { enum: string[]; type: string }; customChain: { properties: { chainId: { eth: string }; name: { eth: string }; networkId: { eth: string } }; type: string }; hardfork: { enum: string[]; type: string } }; type: string }; data: { eth: string }; effectiveGasPrice: { eth: string }; from: { eth: string }; gas: { eth: string }; gasLimit: { eth: string }; gasPrice: { eth: string }; hardfork: { enum: string[]; type: string }; input: { eth: string }; maxFeePerGas: { eth: string }; maxPriorityFeePerGas: { eth: string }; networkId: { eth: string }; nonce: { eth: string }; r: { eth: string }; s: { eth: string }; to: { oneOf: ({ eth: string; type?: undefined } | { eth?: undefined; type: string })[] }; type: { eth: string }; v: { eth: string }; value: { eth: string } }; type: string } | ValidationSchemaInput }
Returns FormatType<TransactionType, ReturnFormat>
getBalance
Type parameters
- ReturnFormat: DataFormat
Parameters
web3Context: Web3Context<EthExecutionAPI, any>
address: string
blockNumber: undefined | BlockNumberOrTag
returnFormat: ReturnFormat
Returns Promise<NumberTypes[ReturnFormat[number]]>
getBlock
Type parameters
- ReturnFormat: DataFormat
Parameters
web3Context: Web3Context<EthExecutionAPI, any>
block: undefined | string | number | bigint | Buffer | ArrayBuffer | Uint8Array
hydrated: undefined | boolean
returnFormat: ReturnFormat
Returns Promise<{ baseFeePerGas?: NumberTypes[ReturnFormat[number]]; difficulty?: NumberTypes[ReturnFormat[number]]; extraData: ByteTypes[ReturnFormat[bytes]]; gasLimit: NumberTypes[ReturnFormat[number]]; gasUsed: NumberTypes[ReturnFormat[number]]; hash?: ByteTypes[ReturnFormat[bytes]]; logsBloom?: ByteTypes[ReturnFormat[bytes]]; miner: ByteTypes[ReturnFormat[bytes]]; mixHash: ByteTypes[ReturnFormat[bytes]]; nonce: NumberTypes[ReturnFormat[number]]; number: NumberTypes[ReturnFormat[number]]; parentHash: ByteTypes[ReturnFormat[bytes]]; receiptsRoot: ByteTypes[ReturnFormat[bytes]]; sha3Uncles: ByteTypes[ReturnFormat[bytes]]; size: NumberTypes[ReturnFormat[number]]; stateRoot: ByteTypes[ReturnFormat[bytes]]; timestamp: NumberTypes[ReturnFormat[number]]; totalDifficulty: NumberTypes[ReturnFormat[number]]; transactions: string[] | { accessList?: { address?: string; storageKeys?: string[] }[]; blockHash?: ByteTypes[ReturnFormat[bytes]]; blockNumber?: NumberTypes[ReturnFormat[number]]; chain?: ValidChains; chainId?: NumberTypes[ReturnFormat[number]]; common?: { baseChain?: ValidChains; customChain: { chainId: NumberTypes[ReturnFormat[number]]; name?: string; networkId: NumberTypes[ReturnFormat[number]] }; hardfork?: Hardfork }; data?: ByteTypes[ReturnFormat[bytes]]; from: string; gas?: NumberTypes[ReturnFormat[number]]; gasLimit?: NumberTypes[ReturnFormat[number]]; gasPrice?: NumberTypes[ReturnFormat[number]]; hardfork?: Hardfork; hash: ByteTypes[ReturnFormat[bytes]]; input?: ByteTypes[ReturnFormat[bytes]]; maxFeePerGas?: NumberTypes[ReturnFormat[number]]; maxPriorityFeePerGas?: NumberTypes[ReturnFormat[number]]; networkId?: NumberTypes[ReturnFormat[number]]; nonce?: NumberTypes[ReturnFormat[number]]; r?: ByteTypes[ReturnFormat[bytes]]; s?: ByteTypes[ReturnFormat[bytes]]; to?: string | null; transactionIndex?: NumberTypes[ReturnFormat[number]]; type?: NumberTypes[ReturnFormat[number]]; v?: NumberTypes[ReturnFormat[number]]; value?: NumberTypes[ReturnFormat[number]]; yParity?: string }[]; transactionsRoot: ByteTypes[ReturnFormat[bytes]]; uncles: string[] }>
getBlockNumber
Type parameters
- ReturnFormat: DataFormat
Parameters
web3Context: Web3Context<EthExecutionAPI, any>
returnFormat: ReturnFormat
Returns Promise<NumberTypes[ReturnFormat[number]]>
getBlockTransactionCount
Type parameters
- ReturnFormat: DataFormat
Parameters
web3Context: Web3Context<EthExecutionAPI, any>
block: undefined | string | number | bigint | Buffer | ArrayBuffer | Uint8Array
returnFormat: ReturnFormat
Returns Promise<NumberTypes[ReturnFormat[number]]>
getBlockUncleCount
Type parameters
- ReturnFormat: DataFormat
Parameters
web3Context: Web3Context<EthExecutionAPI, any>
block: undefined | string | number | bigint | Buffer | ArrayBuffer | Uint8Array
returnFormat: ReturnFormat
Returns Promise<NumberTypes[ReturnFormat[number]]>
getChainId
Type parameters
- ReturnFormat: DataFormat
Parameters
web3Context: Web3Context<EthExecutionAPI, any>
returnFormat: ReturnFormat
Returns Promise<NumberTypes[ReturnFormat[number]]>
getCode
Type parameters
- ReturnFormat: DataFormat
Parameters
web3Context: Web3Context<EthExecutionAPI, any>
address: string
blockNumber: undefined | BlockNumberOrTag
returnFormat: ReturnFormat
Returns Promise<string>
getCoinbase
Parameters
web3Context: Web3Context<EthExecutionAPI, any>
Returns Promise<string>
getFeeHistory
Type parameters
- ReturnFormat: DataFormat
Parameters
web3Context: Web3Context<EthExecutionAPI, any>
blockCount: Numbers
newestBlock: undefined | BlockNumberOrTag
rewardPercentiles: Numbers[]
returnFormat: ReturnFormat
Returns Promise<{ baseFeePerGas: NumberTypes[ReturnFormat[number]]; gasUsedRatio: NumberTypes[ReturnFormat[number]][]; oldestBlock: NumberTypes[ReturnFormat[number]]; reward: NumberTypes[ReturnFormat[number]][][] }>
getGasPrice
Type parameters
- ReturnFormat: DataFormat
Parameters
web3Context: Web3Context<EthExecutionAPI, any>
returnFormat: ReturnFormat
Returns Promise<NumberTypes[ReturnFormat[number]]>
getHashRate
Type parameters
- ReturnFormat: DataFormat
Parameters
web3Context: Web3Context<EthExecutionAPI, any>
returnFormat: ReturnFormat
Returns Promise<NumberTypes[ReturnFormat[number]]>
getLogs
Type parameters
- ReturnFormat: DataFormat
Parameters
web3Context: Web3Context<Web3EthExecutionAPI, any>
filter: Filter
returnFormat: ReturnFormat
Returns Promise<(string | { address?: string; blockHash?: ByteTypes[ReturnFormat[bytes]]; blockNumber?: NumberTypes[ReturnFormat[number]]; data?: ByteTypes[ReturnFormat[bytes]]; id?: string; logIndex?: NumberTypes[ReturnFormat[number]]; removed?: boolean; topics?: ByteTypes[ReturnFormat[bytes]][]; transactionHash?: ByteTypes[ReturnFormat[bytes]]; transactionIndex?: NumberTypes[ReturnFormat[number]] })[]>
getPendingTransactions
Type parameters
- ReturnFormat: DataFormat
Parameters
web3Context: Web3Context<EthExecutionAPI, any>
returnFormat: ReturnFormat
Returns Promise<{ accessList?: { address?: string; storageKeys?: string[] }[]; chain?: ValidChains; chainId?: NumberTypes[ReturnFormat[number]]; common?: { baseChain?: ValidChains; customChain: { chainId: NumberTypes[ReturnFormat[number]]; name?: string; networkId: NumberTypes[ReturnFormat[number]] }; hardfork?: Hardfork }; data?: ByteTypes[ReturnFormat[bytes]]; from?: string; gas?: NumberTypes[ReturnFormat[number]]; gasLimit?: NumberTypes[ReturnFormat[number]]; gasPrice?: NumberTypes[ReturnFormat[number]]; hardfork?: Hardfork; input?: ByteTypes[ReturnFormat[bytes]]; maxFeePerGas?: NumberTypes[ReturnFormat[number]]; maxPriorityFeePerGas?: NumberTypes[ReturnFormat[number]]; networkId?: NumberTypes[ReturnFormat[number]]; nonce?: NumberTypes[ReturnFormat[number]]; r?: ByteTypes[ReturnFormat[bytes]]; s?: ByteTypes[ReturnFormat[bytes]]; to?: string | null; type?: NumberTypes[ReturnFormat[number]]; v?: NumberTypes[ReturnFormat[number]]; value?: NumberTypes[ReturnFormat[number]]; yParity?: string }[]>
getProof
Type parameters
- ReturnFormat: DataFormat
Parameters
web3Context: Web3Context<Web3EthExecutionAPI, any>
address: string
storageKeys: Bytes[]
blockNumber: undefined | BlockNumberOrTag
returnFormat: ReturnFormat
Returns Promise<{ accountProof: ByteTypes[ReturnFormat[bytes]][]; balance: NumberTypes[ReturnFormat[number]]; codeHash: ByteTypes[ReturnFormat[bytes]]; nonce: NumberTypes[ReturnFormat[number]]; storageHash: ByteTypes[ReturnFormat[bytes]]; storageProof: { key: ByteTypes[ReturnFormat[bytes]]; proof: ByteTypes[ReturnFormat[bytes]][]; value: NumberTypes[ReturnFormat[number]] }[] }>
getProtocolVersion
Parameters
web3Context: Web3Context<EthExecutionAPI, any>
Returns Promise<string>
getStorageAt
Type parameters
- ReturnFormat: DataFormat
Parameters
web3Context: Web3Context<EthExecutionAPI, any>
address: string
storageSlot: Numbers
blockNumber: undefined | BlockNumberOrTag
returnFormat: ReturnFormat
Returns Promise<string>
getTransaction
Type parameters
- ReturnFormat: DataFormat
Parameters
web3Context: Web3Context<EthExecutionAPI, any>
transactionHash: Bytes
returnFormat: ReturnFormat
Returns Promise<{ accessList: { address?: string; storageKeys?: string[] }[]; blockHash?: string; blockNumber?: string; chainId?: string; data?: string; from: string; gas: string; hash: string; input: string; maxFeePerGas: string; maxPriorityFeePerGas: string; nonce: string; r: string; s: string; to?: string | null; transactionIndex?: string; type: string; value: string; yParity: string } | { accessList: { address?: string; storageKeys?: string[] }[]; blockHash?: string; blockNumber?: string; chainId?: string; data?: string; from: string; gas: string; gasPrice: string; hash: string; input: string; nonce: string; r: string; s: string; to?: string | null; transactionIndex?: string; type: string; value: string; yParity: string } | { blockHash?: string; blockNumber?: string; chainId?: string; data?: string; from: string; gas: string; gasPrice: string; hash: string; input: string; nonce: string; r: string; s: string; to?: string | null; transactionIndex?: string; type: string; v: string; value: string } | undefined>
getTransactionCount
Type parameters
- ReturnFormat: DataFormat
Parameters
web3Context: Web3Context<EthExecutionAPI, any>
address: string
blockNumber: undefined | BlockNumberOrTag
returnFormat: ReturnFormat
Returns Promise<NumberTypes[ReturnFormat[number]]>
getTransactionFromBlock
Type parameters
- ReturnFormat: DataFormat
Parameters
web3Context: Web3Context<EthExecutionAPI, any>
block: undefined | string | number | bigint | Buffer | ArrayBuffer | Uint8Array
transactionIndex: Numbers
returnFormat: ReturnFormat
Returns Promise<{ accessList: { address?: string; storageKeys?: string[] }[]; blockHash?: string; blockNumber?: string; chainId?: string; data?: string; from: string; gas: string; hash: string; input: string; maxFeePerGas: string; maxPriorityFeePerGas: string; nonce: string; r: string; s: string; to?: string | null; transactionIndex?: string; type: string; value: string; yParity: string } | { accessList: { address?: string; storageKeys?: string[] }[]; blockHash?: string; blockNumber?: string; chainId?: string; data?: string; from: string; gas: string; gasPrice: string; hash: string; input: string; nonce: string; r: string; s: string; to?: string | null; transactionIndex?: string; type: string; value: string; yParity: string } | { blockHash?: string; blockNumber?: string; chainId?: string; data?: string; from: string; gas: string; gasPrice: string; hash: string; input: string; nonce: string; r: string; s: string; to?: string | null; transactionIndex?: string; type: string; v: string; value: string } | undefined>
getTransactionReceipt
Type parameters
- ReturnFormat: DataFormat
Parameters
web3Context: Web3Context<EthExecutionAPI, any>
transactionHash: Bytes
returnFormat: ReturnFormat
Returns Promise<TransactionReceipt | undefined>
getUncle
Type parameters
- ReturnFormat: DataFormat
Parameters
web3Context: Web3Context<EthExecutionAPI, any>
block: undefined | string | number | bigint | Buffer | ArrayBuffer | Uint8Array
uncleIndex: Numbers
returnFormat: ReturnFormat
Returns Promise<{ baseFeePerGas?: NumberTypes[ReturnFormat[number]]; difficulty?: NumberTypes[ReturnFormat[number]]; extraData: ByteTypes[ReturnFormat[bytes]]; gasLimit: NumberTypes[ReturnFormat[number]]; gasUsed: NumberTypes[ReturnFormat[number]]; hash?: ByteTypes[ReturnFormat[bytes]]; logsBloom?: ByteTypes[ReturnFormat[bytes]]; miner: ByteTypes[ReturnFormat[bytes]]; mixHash: ByteTypes[ReturnFormat[bytes]]; nonce: NumberTypes[ReturnFormat[number]]; number: NumberTypes[ReturnFormat[number]]; parentHash: ByteTypes[ReturnFormat[bytes]]; receiptsRoot: ByteTypes[ReturnFormat[bytes]]; sha3Uncles: ByteTypes[ReturnFormat[bytes]]; size: NumberTypes[ReturnFormat[number]]; stateRoot: ByteTypes[ReturnFormat[bytes]]; timestamp: NumberTypes[ReturnFormat[number]]; totalDifficulty: NumberTypes[ReturnFormat[number]]; transactions: string[] | { accessList?: { address?: string; storageKeys?: string[] }[]; blockHash?: ByteTypes[ReturnFormat[bytes]]; blockNumber?: NumberTypes[ReturnFormat[number]]; chain?: ValidChains; chainId?: NumberTypes[ReturnFormat[number]]; common?: { baseChain?: ValidChains; customChain: { chainId: NumberTypes[ReturnFormat[number]]; name?: string; networkId: NumberTypes[ReturnFormat[number]] }; hardfork?: Hardfork }; data?: ByteTypes[ReturnFormat[bytes]]; from: string; gas?: NumberTypes[ReturnFormat[number]]; gasLimit?: NumberTypes[ReturnFormat[number]]; gasPrice?: NumberTypes[ReturnFormat[number]]; hardfork?: Hardfork; hash: ByteTypes[ReturnFormat[bytes]]; input?: ByteTypes[ReturnFormat[bytes]]; maxFeePerGas?: NumberTypes[ReturnFormat[number]]; maxPriorityFeePerGas?: NumberTypes[ReturnFormat[number]]; networkId?: NumberTypes[ReturnFormat[number]]; nonce?: NumberTypes[ReturnFormat[number]]; r?: ByteTypes[ReturnFormat[bytes]]; s?: ByteTypes[ReturnFormat[bytes]]; to?: string | null; transactionIndex?: NumberTypes[ReturnFormat[number]]; type?: NumberTypes[ReturnFormat[number]]; v?: NumberTypes[ReturnFormat[number]]; value?: NumberTypes[ReturnFormat[number]]; yParity?: string }[]; transactionsRoot: ByteTypes[ReturnFormat[bytes]]; uncles: string[] }>
isAccessList
Parameters
value: AccessList
Returns boolean
isAccessListEntry
Parameters
value: AccessListEntry
Returns boolean
isBaseTransaction
Parameters
value: BaseTransactionAPI
Returns boolean
isMining
Parameters
web3Context: Web3Context<EthExecutionAPI, any>
Returns Promise<boolean>
isSyncing
Parameters
web3Context: Web3Context<EthExecutionAPI, any>
Returns Promise<SyncingStatusAPI>
isTransaction1559Unsigned
Parameters
value: Transaction1559UnsignedAPI
Returns boolean
isTransaction2930Unsigned
Parameters
value: Transaction2930UnsignedAPI
Returns boolean
isTransactionCall
Parameters
value: TransactionCall
Returns boolean
isTransactionLegacyUnsigned
Parameters
value: TransactionLegacyUnsignedAPI
Returns boolean
isTransactionWithSender
Parameters
value: TransactionWithSenderAPI
Returns boolean
prepareTransactionForSigning
Parameters
transaction: Transaction
web3Context: Web3Context<EthExecutionAPI, any>
optionalprivateKey: string | Buffer
Returns Promise<TypedTransaction>
sendSignedTransaction
Type parameters
- ReturnFormat: DataFormat
- ResolveType = { blockHash: ByteTypes[ReturnFormat[bytes]]; blockNumber: NumberTypes[ReturnFormat[number]]; contractAddress?: string; cumulativeGasUsed: NumberTypes[ReturnFormat[number]]; effectiveGasPrice?: NumberTypes[ReturnFormat[number]]; from: string; gasUsed: NumberTypes[ReturnFormat[number]]; logs: { readonly id?: string | undefined; readonly removed?: boolean | undefined; readonly logIndex?: NumberTypes[ReturnFormat["number"]] | undefined; ... 6 more ...; readonly topics?: ByteTypes[ReturnFormat["bytes"]][] | undefined; }[]; logsBloom: ByteTypes[ReturnFormat[bytes]]; root: ByteTypes[ReturnFormat[bytes]]; status: NumberTypes[ReturnFormat[number]]; to: string; transactionHash: ByteTypes[ReturnFormat[bytes]]; transactionIndex: NumberTypes[ReturnFormat[number]]; type?: NumberTypes[ReturnFormat[number]] }
Parameters
web3Context: Web3Context<EthExecutionAPI, any>
signedTransaction: Bytes
returnFormat: ReturnFormat
optionaloptions: SendSignedTransactionOptions<ResolveType>
Returns Web3PromiEvent<ResolveType, SendSignedTransactionEvents<ReturnFormat>>
sendTransaction
Type parameters
- ReturnFormat: DataFormat
- ResolveType = { blockHash: ByteTypes[ReturnFormat[bytes]]; blockNumber: NumberTypes[ReturnFormat[number]]; contractAddress?: string; cumulativeGasUsed: NumberTypes[ReturnFormat[number]]; effectiveGasPrice?: NumberTypes[ReturnFormat[number]]; from: string; gasUsed: NumberTypes[ReturnFormat[number]]; logs: { readonly id?: string | undefined; readonly removed?: boolean | undefined; readonly logIndex?: NumberTypes[ReturnFormat["number"]] | undefined; ... 6 more ...; readonly topics?: ByteTypes[ReturnFormat["bytes"]][] | undefined; }[]; logsBloom: ByteTypes[ReturnFormat[bytes]]; root: ByteTypes[ReturnFormat[bytes]]; status: NumberTypes[ReturnFormat[number]]; to: string; transactionHash: ByteTypes[ReturnFormat[bytes]]; transactionIndex: NumberTypes[ReturnFormat[number]]; type?: NumberTypes[ReturnFormat[number]] }
Parameters
web3Context: Web3Context<EthExecutionAPI, any>
transaction: Transaction | TransactionWithFromLocalWalletIndex | TransactionWithToLocalWalletIndex | TransactionWithFromAndToLocalWalletIndex
returnFormat: ReturnFormat
optionaloptions: SendTransactionOptions<ResolveType>
Returns Web3PromiEvent<ResolveType, SendTransactionEvents<ReturnFormat>>
sign
Type parameters
- ReturnFormat: DataFormat
Parameters
web3Context: Web3Context<EthExecutionAPI, any>
message: Bytes
addressOrIndex: string | number
returnFormat: ReturnFormat
Returns Promise<string | { message?: string; messageHash: string; r: string; s: string; signature: string; v: string }>
signTransaction
Type parameters
- ReturnFormat: DataFormat
Parameters
web3Context: Web3Context<EthExecutionAPI, any>
transaction: Transaction
returnFormat: ReturnFormat
Returns Promise<SignedTransactionInfoAPI>
transactionBuilder
Type parameters
- ReturnType_1 = Record<string, unknown>
Parameters
options: { privateKey?: string | Buffer; transaction: Transaction; web3Context: Web3Context<EthExecutionAPI, any> }
Returns Promise<ReturnType_1>
validateBaseChain
Parameters
transaction: { accessList?: { readonly address?: string | undefined; readonly storageKeys?: string[] | undefined; }[]; chain?: ValidChains; chainId?: string; common?: { customChain: { name?: string | undefined; networkId: string; chainId: string; }; baseChain?: ValidChains | undefined; hardfork?: Hardfork | undefined; }; data?: string; from?: string; gas?: string; gasLimit?: string; gasPrice?: string; hardfork?: Hardfork; input?: string; maxFeePerGas?: string; maxPriorityFeePerGas?: string; networkId?: string; nonce?: string; r?: string; s?: string; to?: null | string; type?: string; v?: string; value?: string; yParity?: string }
Returns void
validateChainInfo
Parameters
transaction: { accessList?: { readonly address?: string | undefined; readonly storageKeys?: string[] | undefined; }[]; chain?: ValidChains; chainId?: string; common?: { customChain: { name?: string | undefined; networkId: string; chainId: string; }; baseChain?: ValidChains | undefined; hardfork?: Hardfork | undefined; }; data?: string; from?: string; gas?: string; gasLimit?: string; gasPrice?: string; hardfork?: Hardfork; input?: string; maxFeePerGas?: string; maxPriorityFeePerGas?: string; networkId?: string; nonce?: string; r?: string; s?: string; to?: null | string; type?: string; v?: string; value?: string; yParity?: string }
Returns void
validateCustomChainInfo
Parameters
transaction: { accessList?: { readonly address?: string | undefined; readonly storageKeys?: string[] | undefined; }[]; chain?: ValidChains; chainId?: string; common?: { customChain: { name?: string | undefined; networkId: string; chainId: string; }; baseChain?: ValidChains | undefined; hardfork?: Hardfork | undefined; }; data?: string; from?: string; gas?: string; gasLimit?: string; gasPrice?: string; hardfork?: Hardfork; input?: string; maxFeePerGas?: string; maxPriorityFeePerGas?: string; networkId?: string; nonce?: string; r?: string; s?: string; to?: null | string; type?: string; v?: string; value?: string; yParity?: string }
Returns void
validateFeeMarketGas
Parameters
transaction: { accessList?: { readonly address?: string | undefined; readonly storageKeys?: string[] | undefined; }[]; chain?: ValidChains; chainId?: string; common?: { customChain: { name?: string | undefined; networkId: string; chainId: string; }; baseChain?: ValidChains | undefined; hardfork?: Hardfork | undefined; }; data?: string; from?: string; gas?: string; gasLimit?: string; gasPrice?: string; hardfork?: Hardfork; input?: string; maxFeePerGas?: string; maxPriorityFeePerGas?: string; networkId?: string; nonce?: string; r?: string; s?: string; to?: null | string; type?: string; v?: string; value?: string; yParity?: string }
Returns void
validateGas
Parameters
transaction: { accessList?: { readonly address?: string | undefined; readonly storageKeys?: string[] | undefined; }[]; chain?: ValidChains; chainId?: string; common?: { customChain: { name?: string | undefined; networkId: string; chainId: string; }; baseChain?: ValidChains | undefined; hardfork?: Hardfork | undefined; }; data?: string; from?: string; gas?: string; gasLimit?: string; gasPrice?: string; hardfork?: Hardfork; input?: string; maxFeePerGas?: string; maxPriorityFeePerGas?: string; networkId?: string; nonce?: string; r?: string; s?: string; to?: null | string; type?: string; v?: string; value?: string; yParity?: string }
Returns void
validateHardfork
Parameters
transaction: { accessList?: { readonly address?: string | undefined; readonly storageKeys?: string[] | undefined; }[]; chain?: ValidChains; chainId?: string; common?: { customChain: { name?: string | undefined; networkId: string; chainId: string; }; baseChain?: ValidChains | undefined; hardfork?: Hardfork | undefined; }; data?: string; from?: string; gas?: string; gasLimit?: string; gasPrice?: string; hardfork?: Hardfork; input?: string; maxFeePerGas?: string; maxPriorityFeePerGas?: string; networkId?: string; nonce?: string; r?: string; s?: string; to?: null | string; type?: string; v?: string; value?: string; yParity?: string }
Returns void
validateLegacyGas
Parameters
transaction: { accessList?: { readonly address?: string | undefined; readonly storageKeys?: string[] | undefined; }[]; chain?: ValidChains; chainId?: string; common?: { customChain: { name?: string | undefined; networkId: string; chainId: string; }; baseChain?: ValidChains | undefined; hardfork?: Hardfork | undefined; }; data?: string; from?: string; gas?: string; gasLimit?: string; gasPrice?: string; hardfork?: Hardfork; input?: string; maxFeePerGas?: string; maxPriorityFeePerGas?: string; networkId?: string; nonce?: string; r?: string; s?: string; to?: null | string; type?: string; v?: string; value?: string; yParity?: string }
Returns void
validateTransactionCall
Parameters
value: TransactionCall
Returns void
validateTransactionForSigning
Parameters
transaction: { accessList?: { readonly address?: string | undefined; readonly storageKeys?: string[] | undefined; }[]; chain?: ValidChains; chainId?: string; common?: { customChain: { name?: string | undefined; networkId: string; chainId: string; }; baseChain?: ValidChains | undefined; hardfork?: Hardfork | undefined; }; data?: string; from?: string; gas?: string; gasLimit?: string; gasPrice?: string; hardfork?: Hardfork; input?: string; maxFeePerGas?: string; maxPriorityFeePerGas?: string; networkId?: string; nonce?: string; r?: string; s?: string; to?: null | string; type?: string; v?: string; value?: string; yParity?: string }
optionaloverrideMethod: (transaction: { accessList?: { readonly address?: string | undefined; readonly storageKeys?: string[] | undefined; }[]; chain?: ValidChains; chainId?: string; common?: { customChain: { name?: string | undefined; networkId: string; chainId: string; }; baseChain?: ValidChains | undefined; hardfork?: Hardfork | undefined; }; data?: string; from?: string; gas?: string; gasLimit?: string; gasPrice?: string; hardfork?: Hardfork; input?: string; maxFeePerGas?: string; maxPriorityFeePerGas?: string; networkId?: string; nonce?: string; r?: string; s?: string; to?: null | string; type?: string; v?: string; value?: string; yParity?: string }) => void
Returns void
validateTransactionWithSender
Parameters
value: TransactionWithSenderAPI
Returns void