Skip to main content
Home
This release is 2 versions behind 2.41.2 — the latest version of @wevm/viem. Jump to latest

@wevm/viem@2.40.4
Built and signed on GitHub Actions

TypeScript Interface for Ethereum

This package works with Cloudflare Workers, Node.js, Deno, Bun, Browsers
This package works with Cloudflare Workers
This package works with Node.js
This package works with Deno
This package works with Bun
This package works with Browsers
JSR Score
41%
Published
a week ago (2.40.4)
c
AbiConstructorNotFoundError
No documentation available
T
AbiConstructorNotFoundErrorType
No documentation available
c
AbiConstructorParamsNotFoundError
No documentation available
T
AbiConstructorParamsNotFoundErrorType
No documentation available
c
AbiDecodingDataSizeInvalidError
No documentation available
T
AbiDecodingDataSizeInvalidErrorType
No documentation available
T
AbiDecodingDataSizeTooSmallErrorType
No documentation available
c
AbiDecodingZeroDataError
No documentation available
T
AbiDecodingZeroDataErrorType
No documentation available
c
AbiEncodingArrayLengthMismatchError
No documentation available
T
AbiEncodingArrayLengthMismatchErrorType
No documentation available
c
AbiEncodingBytesSizeMismatchError
No documentation available
T
AbiEncodingBytesSizeMismatchErrorType
No documentation available
c
AbiEncodingLengthMismatchError
No documentation available
T
AbiEncodingLengthMismatchErrorType
No documentation available
c
AbiErrorInputsNotFoundError
No documentation available
T
AbiErrorInputsNotFoundErrorType
No documentation available
c
AbiErrorNotFoundError
No documentation available
T
AbiErrorNotFoundErrorType
No documentation available
c
AbiErrorSignatureNotFoundError
No documentation available
T
AbiErrorSignatureNotFoundErrorType
No documentation available
c
AbiEventNotFoundError
No documentation available
T
AbiEventNotFoundErrorType
No documentation available
T
AbiEventParametersToPrimitiveTypes
No documentation available
c
AbiEventSignatureEmptyTopicsError
No documentation available
T
AbiEventSignatureEmptyTopicsErrorType
No documentation available
c
AbiEventSignatureNotFoundError
No documentation available
T
AbiEventSignatureNotFoundErrorType
No documentation available
c
AbiFunctionNotFoundError
No documentation available
T
AbiFunctionNotFoundErrorType
No documentation available
c
AbiFunctionOutputsNotFoundError
No documentation available
T
AbiFunctionOutputsNotFoundErrorType
No documentation available
c
AbiFunctionSignatureNotFoundError
No documentation available
T
AbiFunctionSignatureNotFoundErrorType
No documentation available
T
AbiItem
No documentation available
T
AbiItemArgs
No documentation available
T
AbiItemName
No documentation available
T
AccessList
No documentation available
c
AccountStateConflictError
No documentation available
T
AccountStateConflictErrorType
No documentation available
f
assertRequest
No documentation available
T
AssertRequestErrorType
No documentation available
f
assertTransactionEIP1559
No documentation available
T
AssertTransactionEIP1559ErrorType
No documentation available
f
assertTransactionEIP2930
No documentation available
T
AssertTransactionEIP2930ErrorType
No documentation available
f
assertTransactionLegacy
No documentation available
T
AssertTransactionLegacyErrorType
No documentation available
T
AssetGateway
No documentation available
T
AssetGatewayUrls
No documentation available
c
AtomicityNotSupportedError
No documentation available
T
AtomicityNotSupportedErrorType

Subclass for an "Atomicity not supported" EIP-5792 error.

c
AtomicReadyWalletRejectedUpgradeError
No documentation available
T
AtomicReadyWalletRejectedUpgradeErrorType

Subclass for an "Atomic-ready wallet rejected upgrade" EIP-5792 error.

T
AuthorizationRequest
No documentation available
T
BaseErrorType
No documentation available
c
BaseFeeScalarError
No documentation available
T
BaseFeeScalarErrorType
No documentation available
T
BlobSidecar
No documentation available
T
BlobSidecars
No documentation available
f
blobsToCommitments

Compute commitments from a list of blobs.

T
BlobsToCommitmentsErrorType
No documentation available
T
BlobsToCommitmentsParameters
No documentation available
T
BlobsToCommitmentsReturnType
No documentation available
f
blobsToProofs

Compute the proofs for a list of blobs and their commitments.

T
blobsToProofsErrorType
No documentation available
T
T
blobsToProofsReturnType
No documentation available
T
BlockIdentifier
No documentation available
c
BlockNotFoundError
No documentation available
T
BlockNotFoundErrorType
No documentation available
T
BlockNumber

Represents a block number in the blockchain.

T
BlockTag

Specifies a particular block in the blockchain.

f
boolToBytes

Encodes a boolean into a byte array.

T
BoolToBytesErrorType
No documentation available
T
BoolToBytesOpts
No documentation available
f
boolToHex

Encodes a boolean into a hex string

T
BoolToHexErrorType
No documentation available
T
BoolToHexOpts
No documentation available
T
Branded

Creates a branded type of T with the brand U.

c
BundleFailedError
No documentation available
T
BundleFailedErrorType
No documentation available
T
BundlerRpcSchema
No documentation available
c
BundleTooLargeError
No documentation available
T
BundleTooLargeErrorType

Subclass for an "Bundle too large" EIP-5792 error.

T
ByteArray
No documentation available
c
BytesSizeMismatchError
No documentation available
T
BytesSizeMismatchErrorType
No documentation available
f
bytesToBigInt

Decodes a byte array into a bigint.

T
BytesToBigIntErrorType
No documentation available
T
BytesToBigIntOpts
No documentation available
f
bytesToBool

Decodes a byte array into a boolean.

T
BytesToBoolErrorType
No documentation available
T
BytesToBoolOpts
No documentation available
f
bytesToHex

Encodes a bytes array into a hex string

T
BytesToHexErrorType
No documentation available
T
BytesToHexOpts
No documentation available
f
bytesToNumber

Decodes a byte array into a number.

T
BytesToNumberErrorType
No documentation available
T
BytesToNumberOpts
No documentation available
f
bytesToRlp
No documentation available
T
BytesToRlpErrorType
No documentation available
f
bytesToString

Decodes a byte array into a UTF-8 string.

T
BytesToStringErrorType
No documentation available
T
BytesToStringOpts
No documentation available
T
Call
No documentation available
c
CallExecutionError
No documentation available
T
CallExecutionErrorType
No documentation available
T
Calls
No documentation available
T
Capabilities
No documentation available
T
CapabilitiesSchema
No documentation available
f
ccipRequest
No documentation available
T
CcipRequestErrorType
No documentation available
T
CcipRequestParameters
No documentation available
T
ChainConfig
No documentation available
T
ChainContract
No documentation available
c
ChainDisconnectedError
No documentation available
T
ChainDisconnectedErrorType

Subclass for an "Chain Disconnected" EIP-1193 error.

c
ChainDoesNotSupportContract
No documentation available
T
ChainDoesNotSupportContractErrorType
No documentation available
T
ChainEstimateFeesPerGasFn
No documentation available
T
ChainEstimateFeesPerGasFnParameters
No documentation available
T
ChainFeesFnParameters
No documentation available
T
ChainFormatter
No documentation available
T
ChainMaxPriorityFeePerGasFn
No documentation available
c
ChainMismatchError
No documentation available
T
ChainMismatchErrorType
No documentation available
c
ChainNotFoundError
No documentation available
T
ChainNotFoundErrorType
No documentation available
T
ChainSerializers
No documentation available
f
checksumAddress
No documentation available
T
ChecksumAddressErrorType
No documentation available
T
Client
No documentation available
c
ClientChainNotConfiguredError
No documentation available
T
ClientChainNotConfiguredErrorType
No documentation available
f
commitmentsToVersionedHashes

Transform a list of commitments to their versioned hashes.

T
CommitmentsToVersionedHashesErrorType
No documentation available
T
CommitmentsToVersionedHashesReturnType
No documentation available
f
commitmentToVersionedHash

Transform a commitment to it's versioned hash.

T
CommitmentToVersionedHashErrorType
No documentation available
T
CommitmentToVersionedHashReturnType
No documentation available
T
CompactSignature
No documentation available
f
compactSignatureToHex
No documentation available
T
CompactSignatureToHexErrorType
No documentation available
f
compactSignatureToSignature
No documentation available
T
CompactSignatureToSignatureErrorType
No documentation available
f
concat
No documentation available
f
concatBytes
No documentation available
T
ConcatBytesErrorType
No documentation available
T
ConcatErrorType
No documentation available
f
concatHex
No documentation available
T
ConcatHexErrorType
No documentation available
T
ConcatReturnType
No documentation available
T
ContractConstructorArgs
No documentation available
T
ContractErrorArgs
No documentation available
T
ContractErrorName
No documentation available
T
ContractEventArgs
No documentation available
T
ContractEventArgsFromTopics
No documentation available
T
ContractEventName
No documentation available
T
ContractFunctionArgs
No documentation available
T
ContractFunctionExecutionErrorType
No documentation available
T
ContractFunctionName
No documentation available
T
ContractFunctionParameters
No documentation available
T
ContractFunctionReturnType
No documentation available
T
ContractFunctionRevertedErrorType
No documentation available
c
ContractFunctionZeroDataError
No documentation available
T
ContractFunctionZeroDataErrorType
No documentation available
c
CounterfactualDeploymentFailedError
No documentation available
T
CounterfactualDeploymentFailedErrorType
No documentation available
f
createClient
No documentation available
T
CreateClientErrorType
No documentation available
f
createPublicClient

Creates a Public Client with a given Transport configured for a Chain.

T
CreatePublicClientErrorType
No documentation available
f
createTestClient

Creates a Test Client with a given Transport configured for a Chain.

T
CreateTestClientErrorType
No documentation available
f
createTransport
No documentation available
T
CreateTransportErrorType
No documentation available
f
createWalletClient

Creates a Wallet Client with a given Transport configured for a Chain.

T
CreateWalletClientErrorType
No documentation available
f
custom
No documentation available
T
CustomTransport
No documentation available
T
CustomTransportErrorType
No documentation available
T
DebugBundlerRpcSchema
No documentation available
f
decodeAbiParameters
No documentation available
T
DecodeAbiParametersErrorType
No documentation available
T
DecodeAbiParametersReturnType
No documentation available
f
decodeDeployData
No documentation available
T
DecodeDeployDataErrorType
No documentation available
T
DecodeDeployDataParameters
No documentation available
T
DecodeDeployDataReturnType
No documentation available
f
decodeErrorResult
No documentation available
T
DecodeErrorResultErrorType
No documentation available
T
DecodeErrorResultParameters
No documentation available
T
DecodeErrorResultReturnType
No documentation available
f
decodeEventLog
No documentation available
T
DecodeEventLogErrorType
No documentation available
T
DecodeEventLogReturnType
No documentation available
f
decodeFunctionData
No documentation available
T
DecodeFunctionDataErrorType
No documentation available
T
DecodeFunctionDataParameters
No documentation available
T
DecodeFunctionDataReturnType
No documentation available
f
decodeFunctionResult
No documentation available
T
DecodeFunctionResultErrorType
No documentation available
T
DecodeFunctionResultParameters
No documentation available
T
DecodeFunctionResultReturnType
No documentation available
c
DecodeLogDataMismatch
No documentation available
T
DecodeLogDataMismatchErrorType
No documentation available
c
DecodeLogTopicsMismatch
No documentation available
T
DecodeLogTopicsMismatchErrorType
No documentation available
v
defineBlock
No documentation available
T
DefineBlockErrorType
No documentation available
f
defineKzg

Defines a KZG interface.

T
DefineKzgErrorType
No documentation available
T
DefineKzgParameters
No documentation available
T
DefineKzgReturnType
No documentation available
v
defineTransaction
No documentation available
T
DefineTransactionErrorType
No documentation available
v
defineTransactionReceipt
No documentation available
T
DefineTransactionReceiptErrorType
No documentation available
v
defineTransactionRequest
No documentation available
T
DefineTransactionRequestErrorType
No documentation available
v
deploylessCallViaBytecodeBytecode
No documentation available
v
deploylessCallViaFactoryBytecode
No documentation available
T
DeriveAccount
No documentation available
T
DeriveChain
No documentation available
f
domainSeparator
No documentation available
T
DomainSeparatorErrorType
No documentation available
T
DropTransactionErrorType
No documentation available
c
DuplicateIdError
No documentation available
T
DuplicateIdErrorType

Subclass for an "Duplicate ID" EIP-5792 error.

T
EIP1193Events
No documentation available
T
EIP1193Parameters
No documentation available
T
EIP1193Provider
No documentation available
c
EIP1193ProviderRpcError
No documentation available
T
EIP1193ProviderRpcErrorType
No documentation available
T
EIP1193RequestFn
No documentation available
T
EIP1474Methods
No documentation available
c
Eip1559FeesNotSupportedError
No documentation available
T
Eip1559FeesNotSupportedErrorType
No documentation available
T
EIP712DomainDefinition
No documentation available
f
encodeAbiParameters
No documentation available
T
EncodeAbiParametersErrorType
No documentation available
T
EncodeAbiParametersReturnType
No documentation available
f
encodeDeployData
No documentation available
T
EncodeDeployDataErrorType
No documentation available
T
EncodeDeployDataParameters
No documentation available
T
EncodeDeployDataReturnType
No documentation available
f
encodeErrorResult
No documentation available
T
EncodeErrorResultErrorType
No documentation available
T
EncodeErrorResultParameters
No documentation available
T
EncodeErrorResultReturnType
No documentation available
f
encodeEventTopics
No documentation available
T
EncodeEventTopicsErrorType
No documentation available
T
EncodeEventTopicsParameters
No documentation available
T
EncodeEventTopicsReturnType
No documentation available
f
encodeFunctionData
No documentation available
T
EncodeFunctionDataErrorType
No documentation available
T
EncodeFunctionDataParameters
No documentation available
T
EncodeFunctionDataReturnType
No documentation available
f
encodeFunctionResult
No documentation available
T
EncodeFunctionResultErrorType
No documentation available
T
EncodeFunctionResultParameters
No documentation available
T
EncodeFunctionResultReturnType
No documentation available
f
encodePacked
No documentation available
T
EncodePackedErrorType
No documentation available
c
EnsAvatarInvalidMetadataError
No documentation available
T
EnsAvatarInvalidMetadataErrorType
No documentation available
c
EnsAvatarInvalidNftUriError
No documentation available
T
EnsAvatarInvalidNftUriErrorType
No documentation available
c
EnsAvatarUnsupportedNamespaceError
No documentation available
T
EnsAvatarUnsupportedNamespaceErrorType
No documentation available
c
EnsAvatarUriResolutionError
No documentation available
T
EnsAvatarUriResolutionErrorType
No documentation available
c
EnsInvalidChainIdError
No documentation available
T
EnsInvalidChainIdErrorType
No documentation available
v
erc20Abi_bytes32

bytes32-flavored ERC-20 for tokens (ie. Maker) that use bytes32 instead of string.

v
erc6492SignatureValidatorAbi
No documentation available
v
erc6492SignatureValidatorByteCode
No documentation available
c
EstimateGasExecutionError
No documentation available
T
EstimateGasExecutionErrorType
No documentation available
v
ethAddress
No documentation available
v
etherUnits
No documentation available
T
EventDefinition
No documentation available
T
ExactPartial
No documentation available
T
ExactRequired
No documentation available
c
ExecutionRevertedError
No documentation available
T
ExtractAbiFunctionForArgs
No documentation available
T
ExtractAbiItem
No documentation available
T
ExtractAbiItemForArgs
No documentation available
T
ExtractAbiItemNames
No documentation available
T
ExtractCapabilities
No documentation available
T
ExtractChainFormatterExclude
No documentation available
T
ExtractChainFormatterParameters
No documentation available
T
ExtractChainFormatterReturnType
No documentation available
f
fallback
No documentation available
T
FallbackTransport
No documentation available
T
FallbackTransportErrorType
No documentation available
c
FeeCapTooHighError
No documentation available
T
FeeCapTooHighErrorType
No documentation available
c
FeeCapTooLowError
No documentation available
T
FeeCapTooLowErrorType
No documentation available
c
FeeConflictError
No documentation available
T
FeeConflictErrorType
No documentation available
T
FeeValues
No documentation available
T
FeeValuesType
No documentation available
T
Filter
No documentation available
T
FilterType
No documentation available
c
FilterTypeNotSupportedError
No documentation available
T
FilterTypeNotSupportedErrorType
No documentation available
f
formatBlock
No documentation available
T
FormatBlockErrorType
No documentation available
f
formatEther

Converts numerical wei to a string representation of ether.

T
FormatEtherErrorType
No documentation available
f
formatGwei

Converts numerical wei to a string representation of gwei.

T
FormatGweiErrorType
No documentation available
f
formatLog
No documentation available
T
FormatLogErrorType
No documentation available
T
FormattedBlock
No documentation available
T
FormattedTransaction
No documentation available
T
FormattedTransactionReceipt
No documentation available
T
FormattedTransactionRequest
No documentation available
f
formatTransaction
No documentation available
T
FormatTransactionErrorType
No documentation available
f
formatTransactionReceipt
No documentation available
T
FormatTransactionReceiptErrorType
No documentation available
f
formatTransactionRequest
No documentation available
T
FormatTransactionRequestErrorType
No documentation available
f
formatUnits

Divides a number by a given exponent of base 10 (10exponent), and formats it into a string representation of the number..

T
FormatUnitsErrorType
No documentation available
f
fromBlobs
No documentation available
T
FromBlobsErrorType
No documentation available
T
FromBlobsParameters
No documentation available
T
FromBlobsReturnType
No documentation available
f
fromBytes

Decodes a byte array into a UTF-8 string, hex value, number, bigint or boolean.

T
FromBytesErrorType
No documentation available
T
FromBytesParameters
No documentation available
f
fromHex

Decodes a hex string into a string, number, bigint, boolean, or byte array.

T
FromHexErrorType
No documentation available
f
fromRlp
No documentation available
T
FromRlpErrorType
No documentation available
T
FromRlpReturnType
No documentation available
f
getAbiItem
No documentation available
T
GetAbiItemErrorType
No documentation available
T
GetAbiItemParameters
No documentation available
T
GetAbiItemReturnType
No documentation available
f
getAddress
No documentation available
T
GetAddressErrorType
No documentation available
T
GetChainParameter
No documentation available
f
getContract

Gets type-safe interface for performing contract-related actions with a specific abi and address.

f
getContractAddress
No documentation available
T
GetContractAddressOptions
No documentation available
f
getContractError
No documentation available
T
GetContractErrorReturnType
No documentation available
T
GetContractErrorType
No documentation available
T
GetContractParameters
No documentation available
T
GetContractReturnType
No documentation available
f
getCreate2Address
No documentation available
T
GetCreate2AddressErrorType
No documentation available
T
GetCreate2AddressOptions
No documentation available
f
getCreateAddress
No documentation available
T
GetCreateAddressErrorType
No documentation available
T
GetCreateAddressOptions
No documentation available
T
GetEventArgs
No documentation available
T
GetMutabilityAwareValue
No documentation available
T
GetPollOptions
No documentation available
T
GetSerializedTransactionType
No documentation available
f
getSerializedTransactionType
No documentation available
T
GetSerializedTransactionTypeErrorType
No documentation available
T
GetTransactionRequestKzgParameter
No documentation available
T
GetTransactionType
No documentation available
f
getTransactionType
No documentation available
T
GetTransactionTypeErrorType
No documentation available
T
GetTransportConfig
No documentation available
f
getTypesForEIP712Domain
No documentation available
T
GetTypesForEIP712DomainErrorType
No documentation available
T
GetValue
No documentation available
v
gweiUnits
No documentation available
T
Hash
No documentation available
f
hashDomain
No documentation available
T
HashDomainErrorType
No documentation available
f
hashMessage
No documentation available
T
HashMessageErrorType
No documentation available
f
hashStruct
No documentation available
T
HashStructErrorType
No documentation available
f
hashTypedData
No documentation available
T
HashTypedDataErrorType
No documentation available
T
HashTypedDataParameters
No documentation available
T
HashTypedDataReturnType
No documentation available
T
Hex
No documentation available
f
hexToBigInt

Decodes a hex value into a bigint.

T
HexToBigIntErrorType
No documentation available
f
hexToBool

Decodes a hex value into a boolean.

T
HexToBoolErrorType
No documentation available
f
hexToBytes

Encodes a hex string into a byte array.

T
HexToBytesErrorType
No documentation available
T
HexToBytesOpts
No documentation available
f
hexToCompactSignature
No documentation available
T
HexToCompactSignatureErrorType
No documentation available
f
hexToNumber

Decodes a hex string into a number.

T
HexToNumberErrorType
No documentation available
f
hexToRlp
No documentation available
T
HexToRlpErrorType
No documentation available
f
hexToSignature
No documentation available
T
HexToSignatureErrorType
No documentation available
f
hexToString

Decodes a hex value into a UTF-8 string.

T
HexToStringErrorType
No documentation available
f
http
No documentation available
c
HttpRequestError
No documentation available
T
HttpRequestErrorType
No documentation available
T
HttpTransport
No documentation available
T
HttpTransportErrorType
No documentation available
T
Index
No documentation available
c
InsufficientFundsError
No documentation available
T
InsufficientFundsErrorType
No documentation available
c
IntegerOutOfRangeError
No documentation available
T
IntegerOutOfRangeErrorType
No documentation available
c
InternalRpcError
No documentation available
T
InternalRpcErrorType

Subclass for an "Internal error" EIP-1474 error.

c
IntrinsicGasTooHighError
No documentation available
T
IntrinsicGasTooHighErrorType
No documentation available
c
IntrinsicGasTooLowError
No documentation available
T
IntrinsicGasTooLowErrorType
No documentation available
c
InvalidAbiDecodingTypeError
No documentation available
T
InvalidAbiDecodingTypeErrorType
No documentation available
c
InvalidAbiEncodingTypeError
No documentation available
T
InvalidAbiEncodingTypeErrorType
No documentation available
c
InvalidAddressError
No documentation available
T
InvalidAddressErrorType
No documentation available
c
InvalidArrayError
No documentation available
T
InvalidArrayErrorType
No documentation available
c
InvalidBytesBooleanError
No documentation available
T
InvalidBytesBooleanErrorType
No documentation available
c
InvalidChainIdError
No documentation available
T
InvalidChainIdErrorType
No documentation available
c
InvalidDecimalNumberError
No documentation available
T
InvalidDecimalNumberErrorType
No documentation available
c
InvalidDefinitionTypeError
No documentation available
T
InvalidDefinitionTypeErrorType
No documentation available
c
InvalidDomainError
No documentation available
T
InvalidDomainErrorType
No documentation available
c
InvalidHexBooleanError
No documentation available
T
InvalidHexBooleanErrorType
No documentation available
c
InvalidHexValueError
No documentation available
T
InvalidHexValueErrorType
No documentation available
c
InvalidInputRpcError
No documentation available
T
InvalidInputRpcErrorType

Subclass for an "Invalid input" EIP-1474 error.

c
InvalidLegacyVError
No documentation available
T
InvalidLegacyVErrorType
No documentation available
c
InvalidParamsRpcError
No documentation available
T
InvalidParamsRpcErrorType

Subclass for an "Invalid params" EIP-1474 error.

c
InvalidPrimaryTypeError
No documentation available
T
InvalidPrimaryTypeErrorType
No documentation available
c
InvalidRequestRpcError
No documentation available
T
InvalidRequestRpcErrorType

Subclass for a "Invalid request" EIP-1474 error.

c
InvalidSerializableTransactionError
No documentation available
T
InvalidSerializableTransactionErrorType
No documentation available
T
InvalidSerializedTransactionErrorType
No documentation available
T
InvalidSerializedTransactionTypeErrorType
No documentation available
c
InvalidStorageKeySizeError
No documentation available
T
InvalidStorageKeySizeErrorType
No documentation available
c
InvalidStructTypeError
No documentation available
T
InvalidStructTypeErrorType
No documentation available
f
isAddress
No documentation available
f
isAddressEqual
No documentation available
T
IsAddressEqualErrorType
No documentation available
T
IsAddressEqualReturnType
No documentation available
T
IsAddressErrorType
No documentation available
T
IsAddressOptions
No documentation available
f
isBytes
No documentation available
T
IsBytesErrorType
No documentation available
f
isErc6492Signature

Whether or not the signature is an ERC-6492 formatted signature.

T
IsErc6492SignatureErrorType
No documentation available
T
IsErc6492SignatureParameters
No documentation available
T
IsErc6492SignatureReturnType
No documentation available
f
isErc8010Signature

Whether or not the signature is an ERC-8010 formatted signature.

T
IsErc8010SignatureErrorType
No documentation available
T
IsErc8010SignatureParameters
No documentation available
T
IsErc8010SignatureReturnType
No documentation available
f
isHash
No documentation available
T
IsHashErrorType
No documentation available
f
isHex
No documentation available
T
IsHexErrorType
No documentation available
T
IsNarrowable
No documentation available
T
IsNever
No documentation available
T
IsUndefined
No documentation available
T
IsUnion
No documentation available
c
JsonRpcVersionUnsupportedError
No documentation available
T
JsonRpcVersionUnsupportedErrorType

Subclass for a "JSON-RPC version not supported" EIP-1474 error.

f
keccak256
No documentation available
T
Keccak256ErrorType
No documentation available
T
Keccak256Hash
No documentation available
T
Kzg
No documentation available
c
LimitExceededRpcError
No documentation available
T
LimitExceededRpcErrorType

Subclass for a "Limit exceeded" EIP-1474 error.

T
Log
No documentation available
T
LogTopic
No documentation available
c
MaxFeePerGasTooLowError
No documentation available
T
MaxFeePerGasTooLowErrorType
No documentation available
v
maxInt104
No documentation available
v
maxInt112
No documentation available
v
maxInt120
No documentation available
v
maxInt128
No documentation available
v
maxInt136
No documentation available
v
maxInt144
No documentation available
v
maxInt152
No documentation available
v
maxInt16
No documentation available
v
maxInt160
No documentation available
v
maxInt168
No documentation available
v
maxInt176
No documentation available
v
maxInt184
No documentation available
v
maxInt192
No documentation available
v
maxInt200
No documentation available
v
maxInt208
No documentation available
v
maxInt216
No documentation available
v
maxInt224
No documentation available
v
maxInt232
No documentation available
v
maxInt24
No documentation available
v
maxInt240
No documentation available
v
maxInt248
No documentation available
v
maxInt256
No documentation available
v
maxInt32
No documentation available
v
maxInt40
No documentation available
v
maxInt48
No documentation available
v
maxInt56
No documentation available
v
maxInt64
No documentation available
v
maxInt72
No documentation available
v
maxInt8
No documentation available
v
maxInt80
No documentation available
v
maxInt88
No documentation available
v
maxInt96
No documentation available
v
maxUint104
No documentation available
v
maxUint112
No documentation available
v
maxUint120
No documentation available
v
maxUint128
No documentation available
v
maxUint136
No documentation available
v
maxUint144
No documentation available
v
maxUint152
No documentation available
v
maxUint16
No documentation available
v
maxUint160
No documentation available
v
maxUint168
No documentation available
v
maxUint176
No documentation available
v
maxUint184
No documentation available
v
maxUint192
No documentation available
v
maxUint200
No documentation available
v
maxUint208
No documentation available
v
maxUint216
No documentation available
v
maxUint224
No documentation available
v
maxUint232
No documentation available
v
maxUint24
No documentation available
v
maxUint240
No documentation available
v
maxUint248
No documentation available
v
maxUint256
No documentation available
v
maxUint32
No documentation available
v
maxUint40
No documentation available
v
maxUint48
No documentation available
v
maxUint56
No documentation available
v
maxUint64
No documentation available
v
maxUint72
No documentation available
v
maxUint8
No documentation available
v
maxUint80
No documentation available
v
maxUint88
No documentation available
v
maxUint96
No documentation available
T
MaybeAbiEventName
No documentation available
T
MaybeExtractEventArgsFromAbi
No documentation available
T
MaybePartial
No documentation available
T
MaybePromise
No documentation available
T
MaybeRequired
No documentation available
T
MessageDefinition
No documentation available
c
MethodNotFoundRpcError
No documentation available
T
MethodNotFoundRpcErrorType

Subclass for a "Method not found" EIP-1474 error.

c
MethodNotSupportedRpcError
No documentation available
T
MethodNotSupportedRpcErrorType

Subclass for a "Method not supported" EIP-1474 error.

v
minInt104
No documentation available
v
minInt112
No documentation available
v
minInt120
No documentation available
v
minInt128
No documentation available
v
minInt136
No documentation available
v
minInt144
No documentation available
v
minInt152
No documentation available
v
minInt16
No documentation available
v
minInt160
No documentation available
v
minInt168
No documentation available
v
minInt176
No documentation available
v
minInt184
No documentation available
v
minInt192
No documentation available
v
minInt200
No documentation available
v
minInt208
No documentation available
v
minInt216
No documentation available
v
minInt224
No documentation available
v
minInt232
No documentation available
v
minInt24
No documentation available
v
minInt240
No documentation available
v
minInt248
No documentation available
v
minInt256
No documentation available
v
minInt32
No documentation available
v
minInt40
No documentation available
v
minInt48
No documentation available
v
minInt56
No documentation available
v
minInt64
No documentation available
v
minInt72
No documentation available
v
minInt8
No documentation available
v
minInt80
No documentation available
v
minInt88
No documentation available
v
minInt96
No documentation available
v
multicall3Abi
No documentation available
T
T
MulticallContracts
No documentation available
T
MulticallResponse
No documentation available
T
MulticallResults
No documentation available
T
Mutable

Removes readonly from all properties of an object.

T
NoInfer
No documentation available
c
NonceMaxValueError
No documentation available
T
NonceMaxValueErrorType
No documentation available
c
NonceTooHighError
No documentation available
T
NonceTooHighErrorType
No documentation available
c
NonceTooLowError
No documentation available
T
NonceTooLowErrorType
No documentation available
f
numberToBytes

Encodes a number into a byte array.

T
NumberToBytesErrorType
No documentation available
f
numberToHex

Encodes a number or bigint into a hex string

T
NumberToHexErrorType
No documentation available
T
NumberToHexOpts
No documentation available
f
offchainLookup
No documentation available
v
offchainLookupAbiItem
No documentation available
T
OffchainLookupErrorType
No documentation available
v
offchainLookupSignature
No documentation available
T
OneOf
No documentation available
T
Or
No documentation available
f
pad
No documentation available
f
padBytes
No documentation available
T
PadBytesErrorType
No documentation available
T
PadErrorType
No documentation available
f
padHex
No documentation available
T
PadHexErrorType
No documentation available
T
PadReturnType
No documentation available
T
ParseAccount
No documentation available
f
parseErc6492Signature
No documentation available
T
ParseErc6492SignatureErrorType
No documentation available
T
ParseErc6492SignatureParameters
No documentation available
T
ParseErc6492SignatureReturnType
No documentation available
f
parseErc8010Signature
No documentation available
T
ParseErc8010SignatureErrorType
No documentation available
T
ParseErc8010SignatureParameters
No documentation available
T
ParseErc8010SignatureReturnType
No documentation available
f
parseEther

Converts a string representation of ether to numerical wei.

T
ParseEtherErrorType
No documentation available
f
parseEventLogs

Extracts & decodes logs matching the provided signature(s) (abi + optional eventName) from a set of opaque logs.

T
ParseEventLogsErrorType
No documentation available
T
ParseEventLogsReturnType
No documentation available
f
parseGwei

Converts a string representation of gwei to numerical wei.

T
ParseGweiErrorType
No documentation available
c
ParseRpcError
No documentation available
T
ParseRpcErrorType

Subclass for a "Parse error" EIP-1474 error.

f
parseTransaction
No documentation available
T
ParseTransactionErrorType
No documentation available
T
ParseTransactionReturnType
No documentation available
f
parseUnits

Multiplies a string representation of a number by a given exponent of base 10 (10exponent).

T
ParseUnitsErrorType
No documentation available
T
PaymasterRpcSchema
No documentation available
f
prepareEncodeFunctionData
No documentation available
T
PrepareEncodeFunctionDataErrorType
No documentation available
T
PrepareEncodeFunctionDataParameters
No documentation available
T
PrepareTransactionRequestParameterType
No documentation available
T
PrepareTransactionRequestRequest
No documentation available
v
presignMessagePrefix
No documentation available
T
ProviderConnectInfo
No documentation available
c
ProviderDisconnectedError
No documentation available
T
ProviderDisconnectedErrorType

Subclass for an "Disconnected" EIP-1193 error.

T
ProviderMessage
No documentation available
c
ProviderRpcError
No documentation available
T
ProviderRpcErrorCode
No documentation available
T
ProviderRpcErrorType

Error subclass implementing Ethereum Provider errors per EIP-1193.

f
publicActions
No documentation available
T
PublicClient
No documentation available
T
PublicClientConfig
No documentation available
T
PublicRpcSchema
No documentation available
T
Quantity
No documentation available
c
RawContractError
No documentation available
T
RawContractErrorType
No documentation available
f
recoverAddress
No documentation available
T
RecoverAddressErrorType
No documentation available
T
RecoverAddressParameters
No documentation available
T
RecoverAddressReturnType
No documentation available
f
recoverMessageAddress
No documentation available
T
RecoverMessageAddressErrorType
No documentation available
T
RecoverMessageAddressReturnType
No documentation available
f
recoverPublicKey
No documentation available
T
RecoverPublicKeyErrorType
No documentation available
T
RecoverPublicKeyParameters
No documentation available
T
RecoverPublicKeyReturnType
No documentation available
f
recoverTransactionAddress
No documentation available
T
RecoverTransactionAddressErrorType
No documentation available
T
RecoverTransactionAddressReturnType
No documentation available
f
recoverTypedDataAddress
No documentation available
T
RecoverTypedDataAddressErrorType
No documentation available
T
RecoverTypedDataAddressParameters
No documentation available
T
RecoverTypedDataAddressReturnType
No documentation available
I
Register
No documentation available
T
RequiredBy
No documentation available
T
ResolvedRegister
No documentation available
c
ResourceNotFoundRpcError
No documentation available
T
ResourceNotFoundRpcErrorType

Subclass for a "Resource not found" EIP-1474 error.

c
ResourceUnavailableRpcError
No documentation available
T
ResourceUnavailableRpcErrorType

Subclass for a "Resource unavailable" EIP-1474 error.

f
ripemd160
No documentation available
T
Ripemd160ErrorType
No documentation available
T
Ripemd160Hash
No documentation available
T
RpcBlock
No documentation available
T
RpcBlockIdentifier
No documentation available
T
RpcBlockNumber
No documentation available
c
RpcError
No documentation available
T
RpcErrorCode
No documentation available
T
RpcErrorType

Error subclass implementing JSON RPC 2.0 errors and Ethereum RPC errors per EIP-1474.

T
RpcFeeHistory
No documentation available
T
RpcFeeValues
No documentation available
T
RpcLog
No documentation available
T
RpcProof
No documentation available
c
RpcRequestError
No documentation available
T
RpcRequestErrorType
No documentation available
T
RpcSchema
No documentation available
f
rpcSchema

Defines a typed JSON-RPC schema for the client. Note: This is a runtime noop function.

T
RpcSchemaOverride
No documentation available
T
RpcStateMapping

A key-value mapping of slot and storage values (supposedly 32 bytes each)

T
RpcStateOverride
No documentation available
T
RpcTransaction
No documentation available
T
RpcTransactionReceipt
No documentation available
T
RpcTransactionRequest
No documentation available
T
RpcUncle
No documentation available
T
SendTransactionRequest
No documentation available
T
SendTransactionSyncRequest
No documentation available
f
serializeAccessList
No documentation available
T
SerializeAccessListErrorType
No documentation available
T
SerializedTransactionReturnType
No documentation available
f
serializeErc6492Signature
No documentation available
T
SerializeErc6492SignatureErrorType
No documentation available
T
SerializeErc6492SignatureReturnType
No documentation available
f
serializeErc8010Signature
No documentation available
T
SerializeErc8010SignatureErrorType
No documentation available
T
SerializeErc8010SignatureReturnType
No documentation available
T
SerializeSignatureParameters
No documentation available
T
SerializeSignatureReturnType
No documentation available
f
serializeTransaction
No documentation available
T
SerializeTransactionErrorType
No documentation available
T
SerializeTransactionFn
No documentation available
f
serializeTypedData
No documentation available
T
SerializeTypedDataErrorType
No documentation available
f
setErrorConfig
No documentation available
f
setupKzg

Sets up and returns a KZG interface.

T
SetupKzgErrorType
No documentation available
T
SetupKzgParameters
No documentation available
T
SetupKzgReturnType
No documentation available
f
sha256
No documentation available
T
Sha256ErrorType
No documentation available
T
Sha256Hash
No documentation available
f
shouldThrow
No documentation available
f
sidecarsToVersionedHashes

Transforms a list of sidecars to their versioned hashes.

T
SidecarsToVersionedHashesErrorType
No documentation available
T
SidecarsToVersionedHashesReturnType
No documentation available
T
SignableMessage
No documentation available
T
Signature
No documentation available
f
signatureToCompactSignature
No documentation available
T
SignatureToCompactSignatureErrorType
No documentation available
f
size
No documentation available
T
SizeErrorType
No documentation available
c
SizeExceedsPaddingSizeError
No documentation available
T
SizeExceedsPaddingSizeErrorType
No documentation available
c
SizeOverflowError
No documentation available
T
SizeOverflowErrorType
No documentation available
f
slice
No documentation available
f
sliceBytes
No documentation available
T
SliceBytesErrorType
No documentation available
T
SliceErrorType
No documentation available
f
sliceHex
No documentation available
T
SliceHexErrorType
No documentation available
c
SliceOffsetOutOfBoundsError
No documentation available
T
SliceOffsetOutOfBoundsErrorType
No documentation available
c
SocketClosedError
No documentation available
T
SocketClosedErrorType
No documentation available
T
Some
No documentation available
c
StateAssignmentConflictError
No documentation available
T
StateAssignmentConflictErrorType
No documentation available
T
StateMapping
No documentation available
T
StateOverride
No documentation available
T
Status
No documentation available
v
stringify
No documentation available
T
StringifyErrorType
No documentation available
f
stringToBytes

Encodes a UTF-8 string into a byte array.

T
StringToBytesErrorType
No documentation available
T
StringToBytesOpts
No documentation available
f
stringToHex

Encodes a UTF-8 string into a hex string

T
StringToHexErrorType
No documentation available
T
StringToHexOpts
No documentation available
c
SwitchChainError
No documentation available
f
testActions
No documentation available
T
TestClient
No documentation available
T
TestClientConfig
No documentation available
T
TestRpcSchema
No documentation available
c
TimeoutError
No documentation available
T
TimeoutErrorType
No documentation available
c
TipAboveFeeCapError
No documentation available
T
TipAboveFeeCapErrorType
No documentation available
f
toBlobs

Transforms arbitrary data to blobs.

T
ToBlobsErrorType
No documentation available
f
toBlobSidecars

Transforms arbitrary data (or blobs, commitments, & proofs) into a sidecar array.

T
ToBlobSidecarsErrorType
No documentation available
T
ToBlobSidecarsParameters
No documentation available
T
ToBlobSidecarsReturnType
No documentation available
T
ToBlobsParameters
No documentation available
T
ToBlobsReturnType
No documentation available
f
toBytes

Encodes a UTF-8 string, hex value, bigint, number or boolean to a byte array.

T
ToBytesErrorType
No documentation available
T
ToBytesParameters
No documentation available
f
toEventHash

Returns the hash (of the function/event signature) for a given event or function definition.

T
ToEventHashErrorType
No documentation available
v
toEventSelector

Returns the event selector for a given event definition.

T
ToEventSelectorErrorType
No documentation available
f
toEventSignature

Returns the signature for a given function or event definition.

T
ToEventSignatureErrorType
No documentation available
f
toFunctionSelector

Returns the function selector for a given function definition.

T
ToFunctionSelectorErrorType
No documentation available
f
toHex

Encodes a string, number, bigint, or ByteArray into a hex string

T
ToHexErrorType
No documentation available
T
ToHexParameters
No documentation available
f
toPrefixedMessage
No documentation available
T
ToPrefixedMessageErrorType
No documentation available
f
toRlp
No documentation available
T
ToRlpErrorType
No documentation available
T
ToRlpReturnType
No documentation available
T
Transaction
No documentation available
T
TransactionEIP1559
No documentation available
T
TransactionEIP2930
No documentation available
T
TransactionEIP4844
No documentation available
T
TransactionEIP7702
No documentation available
c
TransactionExecutionError
No documentation available
T
TransactionExecutionErrorType
No documentation available
T
TransactionLegacy
No documentation available
c
TransactionNotFoundError
No documentation available
T
TransactionNotFoundErrorType
No documentation available
c
TransactionReceiptNotFoundError
No documentation available
T
TransactionReceiptNotFoundErrorType
No documentation available
c
TransactionRejectedRpcError
No documentation available
T
TransactionRejectedRpcErrorType

Subclass for a "Transaction rejected" EIP-1474 error.

T
TransactionRequest
No documentation available
T
TransactionRequestEIP1559
No documentation available
T
TransactionRequestEIP2930
No documentation available
T
TransactionRequestEIP4844
No documentation available
T
TransactionRequestEIP7702
No documentation available
T
TransactionRequestGeneric
No documentation available
T
TransactionRequestLegacy
No documentation available
T
TransactionSerializable
No documentation available
T
TransactionSerializableBase
No documentation available
T
TransactionSerializableEIP1559
No documentation available
T
TransactionSerializableEIP2930
No documentation available
T
TransactionSerializableEIP4844
No documentation available
T
TransactionSerializableEIP7702
No documentation available
T
TransactionSerializableGeneric
No documentation available
T
TransactionSerializableLegacy
No documentation available
T
TransactionSerialized
No documentation available
T
TransactionSerializedEIP1559
No documentation available
T
TransactionSerializedEIP2930
No documentation available
T
TransactionSerializedEIP4844
No documentation available
T
TransactionSerializedEIP7702
No documentation available
T
TransactionSerializedGeneric
No documentation available
T
TransactionSerializedLegacy
No documentation available
T
TransactionType
No documentation available
v
transactionType
No documentation available
c
T
TransactionTypeNotSupportedErrorType
No documentation available
T
Transport
No documentation available
f
trim
No documentation available
T
TrimErrorType
No documentation available
T
TrimReturnType
No documentation available
T
TypedDataDefinition
No documentation available
c
UnauthorizedProviderError
No documentation available
T
UnauthorizedProviderErrorType

Subclass for an "Unauthorized" EIP-1193 error.

T
Uncle
No documentation available
T
UnionEvaluate
No documentation available
T
UnionOmit
No documentation available
T
UnionPartialBy
No documentation available
T
UnionPick
No documentation available
T
UnionRequiredBy
No documentation available
T
UnionToTuple
No documentation available
T
UnionWiden
No documentation available
c
UnknownBundleIdError
No documentation available
T
UnknownBundleIdErrorType

Subclass for an "Unknown bundle ID" EIP-5792 error.

c
UnknownNodeError
No documentation available
T
UnknownNodeErrorType
No documentation available
c
UnknownRpcError
No documentation available
T
UnknownRpcErrorType

Subclass for an unknown RPC error.

c
UnsupportedChainIdError
No documentation available
T
UnsupportedChainIdErrorType

Subclass for an "Unsupported chain id" EIP-5792 error.

c
UnsupportedNonOptionalCapabilityError
No documentation available
T
UnsupportedNonOptionalCapabilityErrorType

Subclass for an "Unsupported non-optional capability" EIP-5792 error.

c
UnsupportedPackedAbiType
No documentation available
T
UnsupportedPackedAbiTypeErrorType
No documentation available
c
UnsupportedProviderMethodError
No documentation available
T
UnsupportedProviderMethodErrorType

Subclass for an "Unsupported Method" EIP-1193 error.

c
UrlRequiredError
No documentation available
T
UrlRequiredErrorType
No documentation available
c
UserRejectedRequestError
No documentation available
T
UserRejectedRequestErrorType

Subclass for a "User Rejected Request" EIP-1193 error.

f
validateTypedData
No documentation available
T
ValidateTypedDataErrorType
No documentation available
f
verifyHash

Verify that a message was signed by the provided address.

T
VerifyHashErrorType
No documentation available
T
VerifyHashParameters
No documentation available
T
VerifyHashReturnType
No documentation available
f
verifyMessage

Verify that a message was signed by the provided address.

T
VerifyMessageErrorType
No documentation available
T
VerifyMessageReturnType
No documentation available
f
verifyTypedData

Verify that typed data was signed by the provided address.

T
VerifyTypedDataErrorType
No documentation available
T
VerifyTypedDataParameters
No documentation available
T
VerifyTypedDataReturnType
No documentation available
c
WaitForCallsStatusTimeoutError
No documentation available
c
WaitForTransactionReceiptTimeoutError
No documentation available
T
WaitForTransactionReceiptTimeoutErrorType
No documentation available
T
WalletCapabilitiesRecord
No documentation available
T
WalletClient
No documentation available
T
WalletClientConfig
No documentation available
T
WalletGetAssetsReturnType
No documentation available
T
WalletPermissionCaveat
No documentation available
T
WalletRpcSchema
No documentation available
T
WalletSendCallsParameters
No documentation available
T
WalletSendCallsReturnType
No documentation available
T
WatchAssetParams
No documentation available
T
WatchContractEventOnLogsFn
No documentation available
T
WatchContractEventOnLogsParameter
No documentation available
T
WatchEventErrorType
No documentation available
f
webSocket
No documentation available
c
WebSocketRequestError
No documentation available
T
WebSocketRequestErrorType
No documentation available
T
WebSocketTransport
No documentation available
T
WebSocketTransportErrorType
No documentation available
v
weiUnits
No documentation available
T
Widen
No documentation available
f
withCache
No documentation available
T
Withdrawal
No documentation available
f
withRetry
No documentation available
T
WithRetryErrorType
No documentation available
f
withTimeout
No documentation available
T
WithTimeoutErrorType
No documentation available
v
zeroAddress
No documentation available
v
zeroHash
No documentation available
T
Account
No documentation available
T
AccountSource
No documentation available
f
createNonceManager

Creates a nonce manager for auto-incrementing transaction nonces.

T
CreateNonceManagerParameters
No documentation available
f
generateMnemonic
No documentation available
T
GenerateMnemonicErrorType
No documentation available
f
generatePrivateKey
No documentation available
T
GeneratePrivateKeyErrorType
No documentation available
T
HDAccount
No documentation available
f
hdKeyToAccount
No documentation available
T
HDKeyToAccountErrorType
No documentation available
T
HDKeyToAccountOptions
No documentation available
T
HDOptions
No documentation available
T
JsonRpcAccount
No documentation available
T
LocalAccount
No documentation available
f
mnemonicToAccount
No documentation available
T
MnemonicToAccountErrorType
No documentation available
T
MnemonicToAccountOptions
No documentation available
T
NonceManager
No documentation available
v
nonceManager

Default Nonce Manager with a JSON-RPC source.

T
NonceManagerSource
No documentation available
f
parseAccount
No documentation available
T
ParseAccountErrorType
No documentation available
T
PrivateKeyAccount
No documentation available
f
privateKeyToAccount
No documentation available
T
PrivateKeyToAccountErrorType
No documentation available
T
PrivateKeyToAccountOptions
No documentation available
f
privateKeyToAddress
No documentation available
T
PrivateKeyToAddressErrorType
No documentation available
f
publicKeyToAddress
No documentation available
T
PublicKeyToAddressErrorType
No documentation available
f
setSignEntropy

Sets extra entropy for signing functions.

f
sign
No documentation available
f
signatureToHex
No documentation available
T
SignatureToHexErrorType
No documentation available
f
signAuthorization

Signs an Authorization hash in EIP-7702 format: keccak256('0x05' || rlp([chain_id, address, nonce])).

T
SignAuthorizationErrorType
No documentation available
T
SignAuthorizationParameters
No documentation available
T
SignAuthorizationReturnType
No documentation available
T
SignErrorType
No documentation available
f
signMessage
No documentation available
T
SignMessageErrorType
No documentation available
T
SignMessageParameters
No documentation available
T
SignMessageReturnType
No documentation available
T
SignParameters
No documentation available
T
SignReturnType
No documentation available
f
signTransaction
No documentation available
T
SignTransactionErrorType
No documentation available
T
SignTransactionReturnType
No documentation available
f
signTypedData
No documentation available
T
SignTypedDataErrorType
No documentation available
T
SignTypedDataParameters
No documentation available
T
SignTypedDataReturnType
No documentation available
f
toAccount
No documentation available
T
ToAccountErrorType
No documentation available
c
AccountNotDeployedError
No documentation available
T
AccountNotDeployedErrorType
No documentation available
f
bundlerActions
No documentation available
T
BundlerClient
No documentation available
T
BundlerClientConfig
No documentation available
T
CoinbaseSmartAccountImplementation
No documentation available
f
createBundlerClient

Creates a Bundler Client with a given Transport configured for a Chain.

T
CreateBundlerClientErrorType
No documentation available
f
createPaymasterClient

Creates a Paymaster Client.

T
CreatePaymasterClientErrorType
No documentation available
f
createWebAuthnCredential
No documentation available
T
CreateWebAuthnCredentialParameters
No documentation available
T
CreateWebAuthnCredentialReturnType
No documentation available
T
DeriveEntryPointVersion
No documentation available
T
DeriveSmartAccount
No documentation available
v
entryPoint06Abi
No documentation available
v
entryPoint06Address
No documentation available
v
entryPoint07Abi
No documentation available
v
entryPoint07Address
No documentation available
v
entryPoint08Abi
No documentation available
v
entryPoint08Address
No documentation available
T
EntryPointVersion
No documentation available
f
estimateUserOperationGas

Returns an estimate of gas values necessary to execute the User Operation.

T
EstimateUserOperationGasErrorType
No documentation available
T
EstimateUserOperationGasParameters
No documentation available
T
EstimateUserOperationGasReturnType
No documentation available
c
FailedToSendToBeneficiaryError
No documentation available
T
FailedToSendToBeneficiaryErrorType
No documentation available
f
formatUserOperation
No documentation available
T
FormatUserOperationErrorType
No documentation available
f
formatUserOperationGas
No documentation available
T
FormatUserOperationGasErrorType
No documentation available
f
formatUserOperationReceipt
No documentation available
T
FormatUserOperationReceiptErrorType
No documentation available
f
formatUserOperationRequest
No documentation available
T
FormatUserOperationRequestErrorType
No documentation available
c
GasValuesOverflowError
No documentation available
T
GasValuesOverflowErrorType
No documentation available
f
getBundlerError
No documentation available
T
GetBundlerErrorParameters
No documentation available
T
GetBundlerErrorReturnType
No documentation available
f
getPaymasterData

Retrieves paymaster-related User Operation properties to be used for sending the User Operation.

T
GetPaymasterDataErrorType
No documentation available
T
GetPaymasterDataParameters
No documentation available
T
GetPaymasterDataReturnType
No documentation available
f
getPaymasterStubData

Retrieves paymaster-related User Operation properties to be used for gas estimation.

T
GetPaymasterStubDataErrorType
No documentation available
T
GetPaymasterStubDataParameters
No documentation available
T
GetPaymasterStubDataReturnType
No documentation available
T
GetSmartAccountParameter
No documentation available
f
getSupportedEntryPoints

Returns the EntryPoints that the bundler supports.

T
GetSupportedEntryPointsErrorType
No documentation available
T
GetSupportedEntryPointsReturnType
No documentation available
f
getUserOperation

Retrieves information about a User Operation given a hash.

f
getUserOperationError
No documentation available
T
GetUserOperationErrorErrorType
No documentation available
T
GetUserOperationErrorParameters
No documentation available
T
GetUserOperationErrorReturnType
No documentation available
T
GetUserOperationErrorType
No documentation available
f
getUserOperationHash
No documentation available
T
GetUserOperationHashReturnType
No documentation available
T
GetUserOperationParameters
No documentation available
f
getUserOperationReceipt

Returns the User Operation Receipt given a User Operation hash.

T
GetUserOperationReceiptErrorType
No documentation available
T
GetUserOperationReceiptParameters
No documentation available
T
GetUserOperationReceiptReturnType
No documentation available
T
GetUserOperationReturnType
No documentation available
f
getUserOperationTypedData
No documentation available
T
GetUserOperationTypedDataReturnType
No documentation available
c
HandleOpsOutOfGasError
No documentation available
T
HandleOpsOutOfGasErrorType
No documentation available
c
InitCodeFailedError
No documentation available
T
InitCodeFailedErrorType
No documentation available
c
InitCodeMustCreateSenderError
No documentation available
T
InitCodeMustCreateSenderErrorType
No documentation available
c
InitCodeMustReturnSenderError
No documentation available
T
InitCodeMustReturnSenderErrorType
No documentation available
c
InsufficientPrefundError
No documentation available
T
InsufficientPrefundErrorType
No documentation available
c
InternalCallOnlyError
No documentation available
T
InternalCallOnlyErrorType
No documentation available
c
InvalidAggregatorError
No documentation available
T
InvalidAggregatorErrorType
No documentation available
c
InvalidBeneficiaryError
No documentation available
T
InvalidBeneficiaryErrorType
No documentation available
c
InvalidPaymasterAndDataError
No documentation available
T
InvalidPaymasterAndDataErrorType
No documentation available
T
P256Credential
No documentation available
f
paymasterActions
No documentation available
T
PaymasterClient
No documentation available
T
PaymasterClientConfig
No documentation available
c
PaymasterDepositTooLowError
No documentation available
T
PaymasterDepositTooLowErrorType
No documentation available
c
PaymasterFunctionRevertedError
No documentation available
T
PaymasterFunctionRevertedErrorType
No documentation available
c
PaymasterNotDeployedError
No documentation available
T
PaymasterNotDeployedErrorType
No documentation available
c
T
PaymasterPostOpFunctionRevertedErrorType
No documentation available
f
prepareUserOperation

Prepares a User Operation and fills in missing properties.

T
PrepareUserOperationErrorType
No documentation available
T
PrepareUserOperationParameters
No documentation available
T
PrepareUserOperationParameterType
No documentation available
T
PrepareUserOperationRequest
No documentation available
T
PrepareUserOperationReturnType
No documentation available
T
RpcEstimateUserOperationGasReturnType
No documentation available
T
RpcGetUserOperationByHashReturnType
No documentation available
T
RpcUserOperation
No documentation available
T
RpcUserOperationReceipt
No documentation available
T
RpcUserOperationRequest
No documentation available
c
SenderAlreadyConstructedError
No documentation available
T
SenderAlreadyConstructedErrorType
No documentation available
f
sendUserOperation

Broadcasts a User Operation to the Bundler.

T
SendUserOperationErrorType
No documentation available
T
SendUserOperationParameters
No documentation available
T
SendUserOperationReturnType
No documentation available
T
Simple7702SmartAccountImplementation
No documentation available
T
SmartAccount
No documentation available
c
SmartAccountFunctionRevertedError
No documentation available
T
SmartAccountFunctionRevertedErrorType
No documentation available
T
SmartAccountImplementation
No documentation available
T
SoladySmartAccountImplementation
No documentation available
f
toCoinbaseSmartAccount
No documentation available
T
ToCoinbaseSmartAccountReturnType
No documentation available
f
toPackedUserOperation
No documentation available
f
toSimple7702SmartAccount
No documentation available
T
ToSimple7702SmartAccountReturnType
No documentation available
f
toSmartAccount
No documentation available
T
ToSmartAccountParameters
No documentation available
T
ToSmartAccountReturnType
No documentation available
f
toSoladySmartAccount
No documentation available
T
ToSoladySmartAccountReturnType
No documentation available
v
toUserOperation
No documentation available
f
toWebAuthnAccount
No documentation available
T
ToWebAuthnAccountErrorType
No documentation available
T
ToWebAuthnAccountReturnType
No documentation available
c
UnknownBundlerError
No documentation available
T
UnknownBundlerErrorType
No documentation available
T
UserOperation
No documentation available
c
UserOperationExecutionError
No documentation available
T
UserOperationExecutionErrorType
No documentation available
c
UserOperationExpiredError
No documentation available
T
UserOperationExpiredErrorType
No documentation available
c
UserOperationNotFoundError
No documentation available
T
UserOperationNotFoundErrorType
No documentation available
c
UserOperationPaymasterExpiredError
No documentation available
T
UserOperationPaymasterExpiredErrorType
No documentation available
c
T
UserOperationPaymasterSignatureErrorType
No documentation available
c
UserOperationReceiptNotFoundError
No documentation available
T
UserOperationReceiptNotFoundErrorType
No documentation available
T
UserOperationRequest
No documentation available
c
UserOperationSignatureError
No documentation available
T
UserOperationSignatureErrorType
No documentation available
c
VerificationGasLimitExceededError
No documentation available
T
VerificationGasLimitExceededErrorType
No documentation available
c
VerificationGasLimitTooLowError
No documentation available
T
VerificationGasLimitTooLowErrorType
No documentation available
f
waitForUserOperationReceipt

Waits for the User Operation to be included on a Block (one confirmation), and then returns the User Operation receipt.

T
WaitForUserOperationReceiptErrorType
No documentation available
T
WaitForUserOperationReceiptReturnType
No documentation available
c
WaitForUserOperationReceiptTimeoutError
No documentation available
T
T
WebAuthnSignReturnType
No documentation available
f
addChain

Adds an EVM chain to the wallet.

T
AddChainErrorType
No documentation available
T
AddChainParameters
No documentation available
f
call

Executes a new message call immediately without submitting a transaction to the network.

T
CallErrorType
No documentation available
T
CallParameters
No documentation available
T
CallReturnType
No documentation available
f
createAccessList

Creates an EIP-2930 access list.

T
CreateAccessListErrorType
No documentation available
T
CreateAccessListParameters
No documentation available
T
CreateAccessListReturnType
No documentation available
f
createBlockFilter

Creates a Filter to listen for new block hashes that can be used with getFilterChanges.

T
CreateBlockFilterErrorType
No documentation available
T
CreateBlockFilterReturnType
No documentation available
f
createContractEventFilter

Creates a Filter to retrieve event logs that can be used with getFilterChanges or getFilterLogs.

T
CreateContractEventFilterErrorType
No documentation available
T
CreateContractEventFilterParameters
No documentation available
T
CreateContractEventFilterReturnType
No documentation available
f
createEventFilter

Creates a Filter to listen for new events that can be used with getFilterChanges.

T
CreateEventFilterErrorType
No documentation available
T
CreateEventFilterParameters
No documentation available
T
CreateEventFilterReturnType
No documentation available
f
createPendingTransactionFilter

Creates a Filter to listen for new pending transaction hashes that can be used with getFilterChanges.

T
CreatePendingTransactionFilterErrorType
No documentation available
T
CreatePendingTransactionFilterReturnType
No documentation available
v
defaultPrepareTransactionRequestParameters
No documentation available
f
deployContract

Deploys a contract to the network, given bytecode and constructor arguments.

T
DeployContractErrorType
No documentation available
T
DeployContractParameters
No documentation available
T
DeployContractReturnType
No documentation available
f
dropTransaction

Removes a transaction from the mempool.

T
DropTransactionParameters
No documentation available
f
dumpState

Serializes the current state (including contracts code, contract's storage, accounts properties, etc.) into a savable data blob.

T
DumpStateErrorType
No documentation available
T
DumpStateReturnType
No documentation available
f
estimateContractGas

Estimates the gas required to successfully execute a contract write function call.

T
EstimateContractGasErrorType
No documentation available
T
EstimateContractGasParameters
No documentation available
T
EstimateContractGasReturnType
No documentation available
f
estimateFeesPerGas

Returns an estimate for the fees per gas (in wei) for a transaction to be likely included in the next block. Defaults to chain.fees.estimateFeesPerGas if set.

T
EstimateFeesPerGasErrorType
No documentation available
T
EstimateFeesPerGasParameters
No documentation available
T
EstimateFeesPerGasReturnType
No documentation available
f
estimateGas

Estimates the gas necessary to complete a transaction without submitting it to the network.

T
EstimateGasErrorType
No documentation available
T
EstimateGasParameters
No documentation available
T
EstimateGasReturnType
No documentation available
f
estimateMaxPriorityFeePerGas

Returns an estimate for the max priority fee per gas (in wei) for a transaction to be likely included in the next block. Defaults to chain.fees.defaultPriorityFee if set.

T
EstimateMaxPriorityFeePerGasErrorType
No documentation available
T
EstimateMaxPriorityFeePerGasParameters
No documentation available
T
EstimateMaxPriorityFeePerGasReturnType
No documentation available
f
fillTransaction

Fills a transaction request with the necessary fields to be signed over.

T
FillTransactionErrorType
No documentation available
T
FillTransactionParameters
No documentation available
T
FillTransactionReturnType
No documentation available
f
getAddresses

Returns a list of account addresses owned by the wallet or client.

T
GetAddressesErrorType
No documentation available
T
GetAddressesReturnType
No documentation available
f
getAutomine

Returns the automatic mining status of the node.

T
GetAutomineErrorType
No documentation available
T
GetAutomineReturnType
No documentation available
f
getBalance

Returns the balance of an address in wei.

T
GetBalanceErrorType
No documentation available
T
GetBalanceParameters
No documentation available
T
GetBalanceReturnType
No documentation available
f
getBlobBaseFee

Returns the base fee per blob gas in wei.

T
GetBlobBaseFeeErrorType
No documentation available
T
GetBlobBaseFeeReturnType
No documentation available
f
getBlock

Returns information about a block at a block number, hash, or tag.

T
GetBlockErrorType
No documentation available
f
getBlockNumber

Returns the number of the most recent block seen.

T
GetBlockNumberErrorType
No documentation available
T
GetBlockNumberParameters
No documentation available
T
GetBlockNumberReturnType
No documentation available
T
GetBlockParameters
No documentation available
T
GetBlockReturnType
No documentation available
f
getBlockTransactionCount

Returns the number of Transactions at a block number, hash, or tag.

T
GetBlockTransactionCountErrorType
No documentation available
T
GetBlockTransactionCountParameters
No documentation available
T
GetBlockTransactionCountReturnType
No documentation available
f
getBytecode

Retrieves the bytecode at an address.

T
GetBytecodeErrorType
No documentation available
T
GetBytecodeParameters
No documentation available
T
GetBytecodeReturnType
No documentation available
f
getCallsStatus

Returns the status of a call batch that was sent via sendCalls.

T
GetCallsStatusErrorType
No documentation available
T
GetCallsStatusParameters
No documentation available
T
GetCallsStatusReturnType
No documentation available
f
getCapabilities

Extract capabilities that a connected wallet supports (e.g. paymasters, session keys, etc).

T
GetCapabilitiesErrorType
No documentation available
T
GetCapabilitiesParameters
No documentation available
T
GetCapabilitiesReturnType
No documentation available
f
getChainId

Returns the chain ID associated with the current network.

T
GetChainIdErrorType
No documentation available
T
GetChainIdReturnType
No documentation available
f
getContractEvents

Returns a list of event logs emitted by a contract.

T
GetContractEventsErrorType
No documentation available
T
GetContractEventsParameters
No documentation available
T
GetContractEventsReturnType
No documentation available
f
getEip712Domain

Reads the EIP-712 domain from a contract, based on the ERC-5267 specification.

T
GetEip712DomainErrorType
No documentation available
T
GetEip712DomainParameters
No documentation available
f
getEnsAddress

Gets address for ENS name.

T
GetEnsAddressErrorType
No documentation available
T
GetEnsAddressParameters
No documentation available
T
GetEnsAddressReturnType
No documentation available
f
getEnsAvatar

Gets the avatar of an ENS name.

T
GetEnsAvatarErrorType
No documentation available
T
GetEnsAvatarParameters
No documentation available
T
GetEnsAvatarReturnType
No documentation available
f
getEnsName

Gets primary name for specified address.

T
GetEnsNameErrorType
No documentation available
T
GetEnsNameParameters
No documentation available
T
GetEnsNameReturnType
No documentation available
f
getEnsResolver

Gets resolver for ENS name.

T
GetEnsResolverErrorType
No documentation available
T
GetEnsResolverParameters
No documentation available
T
GetEnsResolverReturnType
No documentation available
f
getEnsText

Gets a text record for specified ENS name.

T
GetEnsTextErrorType
No documentation available
T
GetEnsTextParameters
No documentation available
T
GetEnsTextReturnType
No documentation available
f
getFeeHistory

Returns a collection of historical gas information.

T
GetFeeHistoryErrorType
No documentation available
T
GetFeeHistoryParameters
No documentation available
T
GetFeeHistoryReturnType
No documentation available
f
getFilterChanges

Returns a list of logs or hashes based on a Filter since the last time it was called.

T
GetFilterChangesErrorType
No documentation available
T
GetFilterChangesParameters
No documentation available
T
GetFilterChangesReturnType
No documentation available
f
getFilterLogs

Returns a list of event logs since the filter was created.

T
GetFilterLogsErrorType
No documentation available
T
GetFilterLogsParameters
No documentation available
T
GetFilterLogsReturnType
No documentation available
f
getGasPrice

Returns the current price of gas (in wei).

T
GetGasPriceErrorType
No documentation available
T
GetGasPriceReturnType
No documentation available
f
getLogs

Returns a list of event logs matching the provided parameters.

T
GetLogsErrorType
No documentation available
T
GetLogsParameters
No documentation available
T
GetLogsReturnType
No documentation available
f
getPermissions

Gets the wallets current permissions.

T
GetPermissionsErrorType
No documentation available
T
GetPermissionsReturnType
No documentation available
f
getProof

Returns the account and storage values of the specified account including the Merkle-proof.

T
GetProofErrorType
No documentation available
T
GetProofParameters
No documentation available
T
GetProofReturnType
No documentation available
f
getStorageAt

Returns the value from a storage slot at a given address.

T
GetStorageAtErrorType
No documentation available
T
GetStorageAtParameters
No documentation available
T
GetStorageAtReturnType
No documentation available
f
getTransaction

Returns information about a Transaction given a hash or block identifier.

f
getTransactionConfirmations

Returns the number of blocks passed (confirmations) since the transaction was processed on a block.

T
GetTransactionConfirmationsErrorType
No documentation available
T
GetTransactionConfirmationsParameters
No documentation available
T
GetTransactionConfirmationsReturnType
No documentation available
f
getTransactionCount

Returns the number of Transactions an Account has sent.

T
GetTransactionCountErrorType
No documentation available
T
GetTransactionCountParameters
No documentation available
T
GetTransactionCountReturnType
No documentation available
T
GetTransactionErrorType
No documentation available
T
GetTransactionParameters
No documentation available
T
GetTransactionReceiptErrorType
No documentation available
T
GetTransactionReceiptParameters
No documentation available
T
GetTransactionReceiptReturnType
No documentation available
T
GetTransactionReturnType
No documentation available
f
getTxpoolContent

Returns the details of all transactions currently pending for inclusion in the next block(s), as well as the ones that are being scheduled for future execution only.

T
GetTxpoolContentErrorType
No documentation available
T
GetTxpoolContentReturnType
No documentation available
f
getTxpoolStatus

Returns a summary of all the transactions currently pending for inclusion in the next block(s), as well as the ones that are being scheduled for future execution only.

T
GetTxpoolStatusErrorType
No documentation available
T
GetTxpoolStatusReturnType
No documentation available
f
impersonateAccount

Impersonate an account or contract address. This lets you send transactions from that account even if you don't have access to its private key.

T
ImpersonateAccountErrorType
No documentation available
T
ImpersonateAccountParameters
No documentation available
f
increaseTime

Jump forward in time by the given amount of time, in seconds.

T
IncreaseTimeErrorType
No documentation available
T
IncreaseTimeParameters
No documentation available
f
inspectTxpool

Returns a summary of all the transactions currently pending for inclusion in the next block(s), as well as the ones that are being scheduled for future execution only.

T
InspectTxpoolErrorType
No documentation available
T
InspectTxpoolReturnType
No documentation available
f
loadState

Adds state previously dumped with dumpState to the current chain.

T
LoadStateErrorType
No documentation available
T
LoadStateParameters
No documentation available
T
LoadStateReturnType
No documentation available
f
mine

Mine a specified number of blocks.

T
MineErrorType
No documentation available
T
MineParameters
No documentation available
f
multicall

Similar to readContract, but batches up multiple functions on a contract in a single RPC call via the multicall3 contract.

T
MulticallErrorType
No documentation available
T
MulticallParameters
No documentation available
T
MulticallReturnType
No documentation available
T
OnBlock
No documentation available
T
OnBlockNumberFn
No documentation available
T
OnBlockNumberParameter
No documentation available
T
OnBlockParameter
No documentation available
T
OnTransactionsFn
No documentation available
T
OnTransactionsParameter
No documentation available
f
prepareAuthorization

Prepares an EIP-7702 Authorization object for signing. This Action will fill the required fields of the Authorization object if they are not provided (e.g. nonce and chainId).

T
PrepareAuthorizationErrorType
No documentation available
T
PrepareAuthorizationParameters
No documentation available
T
PrepareAuthorizationReturnType
No documentation available
f
prepareTransactionRequest

Prepares a transaction request for signing.

T
PrepareTransactionRequestErrorType
No documentation available
T
PrepareTransactionRequestParameters
No documentation available
T
PrepareTransactionRequestReturnType
No documentation available
f
readContract

Calls a read-only function on a contract, and returns the response.

T
ReadContractErrorType
No documentation available
T
ReadContractParameters
No documentation available
T
ReadContractReturnType
No documentation available
T
RemoveBlockTimestampIntervalErrorType
No documentation available
T
ReplacementReason
No documentation available
f
requestAddresses

Requests a list of accounts managed by a wallet.

T
RequestAddressesErrorType
No documentation available
T
RequestAddressesReturnType
No documentation available
f
requestPermissions

Requests permissions for a wallet.

T
RequestPermissionsErrorType
No documentation available
T
RequestPermissionsParameters
No documentation available
T
RequestPermissionsReturnType
No documentation available
f
reset

Resets fork back to its original state.

T
ResetErrorType
No documentation available
T
ResetParameters
No documentation available
f
revert

Revert the state of the blockchain at the current block.

T
RevertErrorType
No documentation available
T
RevertParameters
No documentation available
f
sendCalls

Requests the connected wallet to send a batch of calls.

T
SendCallsErrorType
No documentation available
T
SendCallsParameters
No documentation available
T
SendCallsReturnType
No documentation available
f
sendCallsSync

Requests the connected wallet to send a batch of calls, and waits for the calls to be included in a block.

T
SendCallsSyncErrorType
No documentation available
T
SendCallsSyncParameters
No documentation available
T
SendCallsSyncReturnType
No documentation available
f
sendRawTransaction

Sends a signed transaction to the network

T
SendRawTransactionErrorType
No documentation available
T
SendRawTransactionReturnType
No documentation available
f
sendRawTransactionSync

Sends a signed transaction to the network synchronously, and waits for the transaction to be included in a block.

T
SendRawTransactionSyncErrorType
No documentation available
T
SendRawTransactionSyncReturnType
No documentation available
f
sendTransaction

Creates, signs, and sends a new transaction to the network.

T
SendTransactionErrorType
No documentation available
T
SendTransactionParameters
No documentation available
T
SendTransactionReturnType
No documentation available
f
sendTransactionSync

Creates, signs, and sends a new transaction to the network synchronously. Returns the transaction receipt.

T
SendTransactionSyncErrorType
No documentation available
T
SendTransactionSyncParameters
No documentation available
T
SendTransactionSyncReturnType
No documentation available
f
sendUnsignedTransaction

Executes a transaction regardless of the signature.

T
SendUnsignedTransactionErrorType
No documentation available
T
SendUnsignedTransactionParameters
No documentation available
T
SendUnsignedTransactionReturnType
No documentation available
f
setAutomine

Enables or disables the automatic mining of new blocks with each new transaction submitted to the network.

T
SetAutomineErrorType
No documentation available
f
setBalance

Modifies the balance of an account.

T
SetBalanceErrorType
No documentation available
T
SetBalanceParameters
No documentation available
f
setBlockGasLimit

Sets the block's gas limit.

T
SetBlockGasLimitErrorType
No documentation available
T
SetBlockGasLimitParameters
No documentation available
f
setBlockTimestampInterval

Similar to increaseTime, but sets a block timestamp interval. The timestamp of future blocks will be computed as lastBlock_timestamp + interval.

T
SetBlockTimestampIntervalErrorType
No documentation available
T
f
setCode

Modifies the bytecode stored at an account's address.

T
SetCodeErrorType
No documentation available
T
SetCodeParameters
No documentation available
f
setCoinbase

Sets the coinbase address to be used in new blocks.

T
SetCoinbaseErrorType
No documentation available
T
SetCoinbaseParameters
No documentation available
f
setIntervalMining

Sets the automatic mining interval (in seconds) of blocks. Setting the interval to 0 will disable automatic mining.

T
SetIntervalMiningErrorType
No documentation available
T
SetIntervalMiningParameters
No documentation available
f
setLoggingEnabled

Enable or disable logging on the test node network.

T
SetLoggingEnabledErrorType
No documentation available
f
setMinGasPrice

Change the minimum gas price accepted by the network (in wei).

T
SetMinGasPriceErrorType
No documentation available
T
SetMinGasPriceParameters
No documentation available
f
setNextBlockBaseFeePerGas

Sets the next block's base fee per gas.

T
SetNextBlockBaseFeePerGasErrorType
No documentation available
f
setNextBlockTimestamp

Sets the next block's timestamp.

T
SetNextBlockTimestampErrorType
No documentation available
T
SetNextBlockTimestampParameters
No documentation available
f
setNonce

Modifies (overrides) the nonce of an account.

T
SetNonceErrorType
No documentation available
T
SetNonceParameters
No documentation available
f
setRpcUrl

Sets the backend RPC URL.

T
SetRpcUrlErrorType
No documentation available
f
setStorageAt

Writes to a slot of an account's storage.

T
SetStorageAtErrorType
No documentation available
T
SetStorageAtParameters
No documentation available
f
showCallsStatus

Requests for the wallet to show information about a call batch that was sent via sendCalls.

T
ShowCallsStatusErrorType
No documentation available
T
ShowCallsStatusParameters
No documentation available
T
ShowCallsStatusReturnType
No documentation available
T
SignAuthorizationErrorType
No documentation available
T
SignAuthorizationParameters
No documentation available
T
SignAuthorizationReturnType
No documentation available
f
signMessage

Calculates an Ethereum-specific signature in EIP-191 format: keccak256("\x19Ethereum Signed Message:\n" + len(message) + message)).

T
SignMessageErrorType
No documentation available
T
SignMessageParameters
No documentation available
T
SignMessageReturnType
No documentation available
f
signTransaction

Signs a transaction.

T
SignTransactionErrorType
No documentation available
T
SignTransactionParameters
No documentation available
T
SignTransactionReturnType
No documentation available
f
signTypedData

Signs typed data and calculates an Ethereum-specific signature in https://eips.ethereum.org/EIPS/eip-712: sign(keccak256("\x19\x01" ‖ domainSeparator ‖ hashStruct(message)))

T
SignTypedDataErrorType
No documentation available
T
SignTypedDataParameters
No documentation available
T
SignTypedDataReturnType
No documentation available
f
simulateBlocks

Simulates a set of calls on block(s) with optional block and state overrides.

T
SimulateBlocksErrorType
No documentation available
T
SimulateBlocksParameters
No documentation available
T
SimulateBlocksReturnType
No documentation available
f
simulateCalls

Simulates execution of a batch of calls.

T
SimulateCallsErrorType
No documentation available
T
SimulateCallsParameters
No documentation available
f
simulateContract

Simulates/validates a contract interaction. This is useful for retrieving return data and revert reasons of contract write functions.

T
SimulateContractErrorType
No documentation available
T
SimulateContractParameters
No documentation available
T
SimulateContractReturnType
No documentation available
f
snapshot

Snapshot the state of the blockchain at the current block.

T
SnapshotErrorType
No documentation available
f
stopImpersonatingAccount

Stop impersonating an account after having previously used impersonateAccount.

T
StopImpersonatingAccountErrorType
No documentation available
T
StopImpersonatingAccountParameters
No documentation available
f
switchChain

Switch the target chain in a wallet.

T
SwitchChainErrorType
No documentation available
T
SwitchChainParameters
No documentation available
f
uninstallFilter

Destroys a Filter.

T
UninstallFilterErrorType
No documentation available
T
UninstallFilterParameters
No documentation available
T
UninstallFilterReturnType
No documentation available
f
verifyHash

Verifies a message hash onchain using ERC-6492.

T
VerifyHashErrorType
No documentation available
T
VerifyHashParameters
No documentation available
T
VerifyHashReturnType
No documentation available
f
verifyMessage

Verify that a message was signed by the provided address.

T
VerifyMessageErrorType
No documentation available
T
VerifyMessageParameters
No documentation available
T
VerifyMessageReturnType
No documentation available
f
verifyTypedData

Verify that typed data was signed by the provided address.

T
VerifyTypedDataErrorType
No documentation available
T
VerifyTypedDataParameters
No documentation available
T
VerifyTypedDataReturnType
No documentation available
f
waitForCallsStatus

Waits for the status & receipts of a call bundle that was sent via sendCalls.

T
WaitForCallsStatusErrorType
No documentation available
T
WaitForCallsStatusReturnType
No documentation available
T
WaitForCallsStatusTimeoutErrorType
No documentation available
f
waitForTransactionReceipt

Waits for the Transaction to be included on a Block (one confirmation), and then returns the Transaction Receipt.

T
WaitForTransactionReceiptErrorType
No documentation available
T
WaitForTransactionReceiptReturnType
No documentation available
f
watchAsset

Adds an EVM chain to the wallet.

T
WatchAssetErrorType
No documentation available
T
WatchAssetParameters
No documentation available
T
WatchAssetReturnType
No documentation available
f
watchBlockNumber

Watches and returns incoming block numbers.

T
WatchBlockNumberErrorType
No documentation available
T
WatchBlockNumberParameters
No documentation available
T
WatchBlockNumberReturnType
No documentation available
f
watchBlocks

Watches and returns information for incoming blocks.

T
WatchBlocksErrorType
No documentation available
T
WatchBlocksParameters
No documentation available
T
WatchBlocksReturnType
No documentation available
f
watchContractEvent

Watches and returns emitted contract event logs.

T
WatchContractEventErrorType
No documentation available
T
WatchContractEventParameters
No documentation available
T
WatchContractEventReturnType
No documentation available
f
watchEvent

Watches and returns emitted Event Logs.

T
WatchEventOnLogsFn
No documentation available
T
WatchEventOnLogsParameter
No documentation available
T
WatchEventParameters
No documentation available
T
WatchEventReturnType
No documentation available
f
watchPendingTransactions

Watches and returns pending transaction hashes.

T
WatchPendingTransactionsErrorType
No documentation available
T
WatchPendingTransactionsParameters
No documentation available
T
WatchPendingTransactionsReturnType
No documentation available
f
N
writeContract

Executes a write function on a contract.

f
writeContract.internal
No documentation available
T
WriteContractErrorType
No documentation available
T
WriteContractParameters
No documentation available
T
WriteContractReturnType
No documentation available
f
writeContractSync

Executes a write function on a contract synchronously. Returns the transaction receipt.

T
WriteContractSyncParameters
No documentation available
T
WriteContractSyncReturnType
No documentation available
T
CeloBlock
No documentation available
T
CeloRpcBlock
No documentation available
T
CeloRpcTransaction
No documentation available
T
CeloRpcTransactionRequest
No documentation available
T
CeloTransaction
No documentation available
T
CeloTransactionRequest
No documentation available
T
CeloTransactionSerializable
No documentation available
T
CeloTransactionSerialized
No documentation available
T
CeloTransactionType
No documentation available
f
parseTransaction
No documentation available
T
ParseTransactionReturnType
No documentation available
T
RpcTransactionCIP42
No documentation available
T
RpcTransactionCIP64
No documentation available
T
RpcTransactionRequestCIP64
No documentation available
f
serializeTransaction
No documentation available
T
SerializeTransactionCIP64ReturnType
No documentation available
T
TransactionCIP42
No documentation available
T
TransactionCIP64
No documentation available
T
TransactionRequestCIP64
No documentation available
T
TransactionSerializableCIP42
No documentation available
T
TransactionSerializableCIP64
No documentation available
T
TransactionSerializedCIP42
No documentation available
T
TransactionSerializedCIP64
No documentation available
v
abey
No documentation available
v
abstract
No documentation available
v
abstractTestnet
No documentation available
v
acala
No documentation available
v
acria
No documentation available
v
adf
No documentation available
v
agungTestnet
No documentation available
v
aioz
No documentation available
v
alephZero
No documentation available
v
alephZeroTestnet
No documentation available
v
alienx
No documentation available
v
alienxHalTestnet
No documentation available
v
ancient8
No documentation available
v
ancient8Sepolia
No documentation available
v
anvil
No documentation available
v
apeChain
No documentation available
v
apexTestnet
No documentation available
v
arbitrum
No documentation available
v
arbitrumGoerli
No documentation available
v
arbitrumNova
No documentation available
v
arbitrumSepolia
No documentation available
v
arcTestnet
No documentation available
v
arenaz
No documentation available
v
areonNetwork
No documentation available
v
areonNetworkTestnet
No documentation available
v
areum
No documentation available
v
artelaTestnet
No documentation available
v
arthera
No documentation available
v
artheraTestnet
No documentation available
f
assertTransactionCIP42Celo
No documentation available
f
assertTransactionCIP64Celo
No documentation available
f
assertTransactionDepositOpStack
No documentation available
v
assetChain
No documentation available
v
assetChainTestnet
No documentation available
T
Assign
No documentation available
v
astar
No documentation available
v
astarZkEVM
No documentation available
v
astarZkyoto
No documentation available
v
atletaOlympia
No documentation available
v
aurora
No documentation available
v
auroraTestnet
No documentation available
v
auroria
No documentation available
v
autheoTestnet
No documentation available
v
avalanche
No documentation available
v
avalancheFuji
No documentation available
v
b3
No documentation available
v
b3Sepolia
No documentation available
v
bahamut
No documentation available
v
base
No documentation available
v
basecampTestnet
No documentation available
v
baseGoerli
No documentation available
v
basePreconf
No documentation available
v
baseSepolia
No documentation available
v
baseSepoliaPreconf
No documentation available
v
beam
No documentation available
v
beamTestnet
No documentation available
v
bearNetworkChainMainnet
No documentation available
v
bearNetworkChainTestnet
No documentation available
v
berachain
No documentation available
v
berachainBepolia
No documentation available
v
berachainTestnet
No documentation available
v
berachainTestnetbArtio
No documentation available
v
bevmMainnet
No documentation available
v
bifrost
No documentation available
v
birdlayer
No documentation available
v
bitgert
No documentation available
v
bitkub
No documentation available
v
bitkubTestnet
No documentation available
v
bitlayer
No documentation available
v
bitlayerTestnet
No documentation available
v
bitrock
No documentation available
v
bitTorrent
No documentation available
v
bitTorrentTestnet
No documentation available
v
blast
No documentation available
v
blastSepolia
No documentation available
v
bob
No documentation available
v
boba
No documentation available
v
bobaSepolia
No documentation available
v
bobSepolia
No documentation available
v
boolBetaMainnet
No documentation available
v
botanix
No documentation available
v
botanixTestnet
No documentation available
v
bounceBit
No documentation available
v
bounceBitTestnet
No documentation available
v
bronos
No documentation available
v
bronosTestnet
No documentation available
v
bsc
No documentation available
v
bscGreenfield
No documentation available
v
bscTestnet
No documentation available
v
bsquared
No documentation available
v
bsquaredTestnet
No documentation available
v
btr
No documentation available
v
btrTestnet
No documentation available
v
bxn
No documentation available
v
bxnTestnet
No documentation available
v
cannon
No documentation available
v
canto
No documentation available
v
celo
No documentation available
v
celoAlfajores
No documentation available
v
celoSepolia
No documentation available
T
Chain
No documentation available
T
ChainEIP712
No documentation available
v
chang
No documentation available
v
chiliz
No documentation available
v
chips
No documentation available
v
citreaTestnet
No documentation available
v
classic
No documentation available
v
coinbit
No documentation available
v
coinex
No documentation available
v
confluxESpace
No documentation available
v
confluxESpaceTestnet
No documentation available
v
coreDao
No documentation available
v
coreTestnet1
No documentation available
v
coreTestnet2
No documentation available
v
corn
No documentation available
v
cornTestnet
No documentation available
v
crab
No documentation available
v
creatorTestnet
No documentation available
v
creditCoin3Devnet
No documentation available
v
creditCoin3Mainnet
No documentation available
v
creditCoin3Testnet
No documentation available
v
cronos
No documentation available
v
cronosTestnet
No documentation available
v
cronoszkEVM
No documentation available
v
cronoszkEVMTestnet
No documentation available
v
crossbell
No documentation available
v
crossfi
No documentation available
v
curtis
No documentation available
v
cyber
No documentation available
v
cyberTestnet
No documentation available
v
dailyNetwork
No documentation available
v
dailyNetworkTestnet
No documentation available
v
darwinia
No documentation available
v
dbkchain
No documentation available
v
dchain
No documentation available
v
dchainTestnet
No documentation available
v
defichainEvm
No documentation available
v
defichainEvmTestnet
No documentation available
v
degen
No documentation available
v
dfk
No documentation available
v
diode
No documentation available
v
disChain
No documentation available
v
dodochainTestnet
No documentation available
v
dogechain
No documentation available
v
domaTestnet
No documentation available
v
donatuz
No documentation available
v
dosChain
No documentation available
v
dosChainTestnet
No documentation available
v
dreyerxMainnet
No documentation available
v
dreyerxTestnet
No documentation available
v
dustboyIoT
No documentation available
v
dymension
No documentation available
v
edexa
No documentation available
v
edexaTestnet
No documentation available
v
edgeless
No documentation available
v
edgelessTestnet
No documentation available
v
edgeware
No documentation available
v
edgewareTestnet
No documentation available
v
eduChain
No documentation available
v
eduChainTestnet
No documentation available
v
ekta
No documentation available
v
ektaTestnet
No documentation available
v
elastos
No documentation available
v
elastosTestnet
No documentation available
v
electroneum
No documentation available
v
electroneumTestnet
No documentation available
v
elysiumTestnet
No documentation available
v
energy
No documentation available
v
eni
No documentation available
v
eniTestnet
No documentation available
v
enuls
No documentation available
v
eon
No documentation available
v
eos
No documentation available
v
eosTestnet
No documentation available
v
eteria
No documentation available
v
etherlinkShadownetTestnet
No documentation available
v
etherlinkTestnet
No documentation available
v
ethernity
No documentation available
v
etp
No documentation available
v
evmos
No documentation available
v
evmosTestnet
No documentation available
v
excelonMainnet
No documentation available
v
expanse
No documentation available
v
exsat
No documentation available
v
exsatTestnet
No documentation available
v
fantom
No documentation available
v
fantomSonicTestnet
No documentation available
v
fantomTestnet
No documentation available
v
fibo
No documentation available
v
filecoin
No documentation available
v
filecoinCalibration
No documentation available
v
filecoinHyperspace
No documentation available
v
fireChain
No documentation available
v
flame
No documentation available
v
flare
No documentation available
v
flareTestnet
No documentation available
v
flowMainnet
No documentation available
v
flowPreviewnet
No documentation available
v
flowTestnet
No documentation available
v
fluence
No documentation available
v
fluenceStage
No documentation available
v
fluenceTestnet
No documentation available
v
fluentTestnet
No documentation available
v
form
No documentation available
v
forma
No documentation available
v
formicarium
No documentation available
v
formTestnet
No documentation available
v
forta
No documentation available
v
foundry
No documentation available
v
fraxtal
No documentation available
v
fraxtalTestnet
No documentation available
v
funkiMainnet
No documentation available
v
funkiSepolia
No documentation available
v
fuse
No documentation available
v
fuseSparknet
No documentation available
v
fusion
No documentation available
v
fusionTestnet
No documentation available
v
garnet
No documentation available
v
gatechain
No documentation available
v
geist
No documentation available
v
genesys
No documentation available
v
giwaSepolia
No documentation available
v
glideL1Protocol
No documentation available
v
glideL2Protocol
No documentation available
v
gnosis
No documentation available
v
gnosisChiado
No documentation available
v
goat
No documentation available
v
gobi
No documentation available
v
goChain
No documentation available
v
godwoken
No documentation available
v
goerli
No documentation available
v
graphite
No documentation available
v
graphiteTestnet
No documentation available
v
gravity
No documentation available
v
gunz
No documentation available
v
guruNetwork
No documentation available
v
guruTestnet
No documentation available
v
ham
No documentation available
v
happychainTestnet
No documentation available
v
haqqMainnet
No documentation available
v
haqqTestedge2
No documentation available
v
hardhat
No documentation available
v
harmonyOne
No documentation available
v
hashkey
No documentation available
v
hashkeyTestnet
No documentation available
v
haustTestnet
No documentation available
v
hedera
No documentation available
v
hederaPreviewnet
No documentation available
v
hederaTestnet
No documentation available
v
hela
No documentation available
v
heliosTestnet
No documentation available
v
hemi
No documentation available
v
hemiSepolia
No documentation available
v
holesky
No documentation available
v
hoodi
No documentation available
v
hpb
No documentation available
v
huddle01Mainnet
No documentation available
v
huddle01Testnet
No documentation available
v
humanity
No documentation available
v
humanityTestnet
No documentation available
v
humanode
No documentation available
v
humanodeTestnet5
No documentation available
v
hychain
No documentation available
v
hychainTestnet
No documentation available
v
hyperEvm
No documentation available
v
hyperliquidEvmTestnet
No documentation available
v
icbNetwork
No documentation available
v
idchain
No documentation available
v
immutableZkEvm
No documentation available
v
immutableZkEvmTestnet
No documentation available
v
inEVM
No documentation available
v
initVerse
No documentation available
v
initVerseGenesis
No documentation available
v
injective
No documentation available
v
injectiveTestnet
No documentation available
v
ink
No documentation available
v
inkSepolia
No documentation available
v
iota
No documentation available
v
iotaTestnet
No documentation available
v
iotex
No documentation available
v
iotexTestnet
No documentation available
v
iSunCoin
No documentation available
v
jasmyChain
No documentation available
v
jasmyChainTestnet
No documentation available
v
jbc
No documentation available
v
jbcTestnet
No documentation available
v
jocMainnet
No documentation available
v
jocTestnet
No documentation available
v
jovay
No documentation available
v
jovaySepolia
No documentation available
v
juneo
No documentation available
v
juneoBCH1Chain
No documentation available
v
juneoDAI1Chain
No documentation available
v
juneoDOGE1Chain
No documentation available
v
juneoEUR1Chain
No documentation available
v
juneoGLD1Chain
No documentation available
v
juneoLINK1Chain
No documentation available
v
juneoLTC1Chain
No documentation available
v
juneomBTC1Chain
No documentation available
v
juneoSGD1Chain
No documentation available
v
juneoSocotraTestnet
No documentation available
v
juneoUSD1Chain
No documentation available
v
juneoUSDT1Chain
No documentation available
v
kaia
No documentation available
v
kairos
No documentation available
v
kakarotSepolia
No documentation available
v
kakarotStarknetSepolia
No documentation available
v
kardiaChain
No documentation available
v
karura
No documentation available
v
katana
No documentation available
v
kava
No documentation available
v
kavaTestnet
No documentation available
v
kcc
No documentation available
v
kiiTestnetOro
No documentation available
v
kinto
No documentation available
v
klaytn
No documentation available
v
klaytnBaobab
No documentation available
v
koi
No documentation available
v
kroma
No documentation available
v
kromaSepolia
No documentation available
v
l3x
No documentation available
v
l3xTestnet
No documentation available
v
lavita
No documentation available
v
lens
No documentation available
v
lensTestnet
No documentation available
v
lestnet
No documentation available
v
lightlinkPegasus
No documentation available
v
lightlinkPhoenix
No documentation available
v
linea
No documentation available
v
lineaGoerli
No documentation available
v
lineaSepolia
No documentation available
v
lineaTestnet
No documentation available
v
lisk
No documentation available
v
liskSepolia
No documentation available
v
loadAlphanet
No documentation available
v
localhost
No documentation available
v
loop
No documentation available
v
lukso
No documentation available
v
luksoTestnet
No documentation available
v
lumiaMainnet
No documentation available
v
lumiaTestnet
No documentation available
v
lumoz
No documentation available
v
lumozTestnet
No documentation available
v
lycan
No documentation available
v
lyra
No documentation available
v
mainnet
No documentation available
v
mandala
No documentation available
v
manta
No documentation available
v
mantaSepoliaTestnet
No documentation available
v
mantaTestnet
No documentation available
v
mantle
No documentation available
v
mantleSepoliaTestnet
No documentation available
v
mantleTestnet
No documentation available
v
mantraDuKongEVMTestnet
No documentation available
v
mantraEVM
No documentation available
v
mapProtocol
No documentation available
v
matchain
No documentation available
v
matchainTestnet
No documentation available
v
mchVerse
No documentation available
v
megaethTestnet
No documentation available
v
mekong
No documentation available
v
meld
No documentation available
v
memecore
No documentation available
v
merlin
No documentation available
v
merlinErigonTestnet
No documentation available
v
metachain
No documentation available
v
metachainIstanbul
No documentation available
v
metadium
No documentation available
v
metalL2
No documentation available
v
meter
No documentation available
v
meterTestnet
No documentation available
v
metis
No documentation available
v
metisGoerli
No documentation available
v
metisSepolia
No documentation available
v
mev
No documentation available
v
mevTestnet
No documentation available
v
mint
No documentation available
v
mintSepoliaTestnet
No documentation available
v
mitosisTestnet
No documentation available
v
mode
No documentation available
v
modeTestnet
No documentation available
v
monad
No documentation available
v
monadTestnet
No documentation available
v
moonbaseAlpha
No documentation available
v
moonbeam
No documentation available
v
moonbeamDev
No documentation available
v
moonriver
No documentation available
v
morph
No documentation available
v
morphHolesky
No documentation available
v
morphSepolia
No documentation available
v
nahmii
No documentation available
v
nautilus
No documentation available
v
near
No documentation available
v
nearTestnet
No documentation available
v
neonDevnet
No documentation available
v
neonMainnet
No documentation available
v
neoxMainnet
No documentation available
v
neoxT4
No documentation available
v
newton
No documentation available
v
nexi
No documentation available
v
nexilix
No documentation available
v
nibiru
No documentation available
v
nitrographTestnet
No documentation available
v
nomina
No documentation available
v
oasisTestnet
No documentation available
v
oasys
No documentation available
v
odysseyTestnet
No documentation available
v
okc
No documentation available
v
omax
No documentation available
T
Omit

Strict version of built-in Omit type

v
omni
No documentation available
v
omniOmega
No documentation available
v
oneWorld
No documentation available
v
oortMainnetDev
No documentation available
v
opBNB
No documentation available
v
opBNBTestnet
No documentation available
v
openledger
No documentation available
T
OpStackBlock
No documentation available
T
OpStackBlockOverrides
No documentation available
T
OpStackDepositTransaction
No documentation available
T
OpStackRpcBlock
No documentation available
T
OpStackRpcBlockOverrides
No documentation available
T
OpStackRpcDepositTransaction
No documentation available
T
OpStackRpcTransaction
No documentation available
T
OpStackRpcTransactionReceipt
No documentation available
T
OpStackTransaction
No documentation available
T
OpStackTransactionReceipt
No documentation available
T
OpStackTransactionSerializable
No documentation available
T
OpStackTransactionSerialized
No documentation available
T
OpStackTransactionType
No documentation available
v
optimism
No documentation available
v
optimismGoerli
No documentation available
v
optimismSepolia
No documentation available
v
optopia
No documentation available
v
optopiaTestnet
No documentation available
v
orderly
No documentation available
v
orderlySepolia
No documentation available
v
otimDevnet
No documentation available
v
palm
No documentation available
v
palmTestnet
No documentation available
T
PartialBy
No documentation available
v
peaq
No documentation available
v
pgn
No documentation available
v
pgnTestnet
No documentation available
v
phoenix
No documentation available
v
planq
No documentation available
v
plasma
No documentation available
v
plasmaDevnet
No documentation available
v
plasmaTestnet
No documentation available
v
playfiAlbireo
No documentation available
v
plinga
No documentation available
v
plume
No documentation available
v
plumeDevnet
No documentation available
v
plumeMainnet
No documentation available
v
plumeSepolia
No documentation available
v
plumeTestnet
No documentation available
v
polterTestnet
No documentation available
v
polygon
No documentation available
v
polygonAmoy
No documentation available
v
polygonMumbai
No documentation available
v
polygonZkEvm
No documentation available
v
polygonZkEvmCardona
No documentation available
v
polygonZkEvmTestnet
No documentation available
v
polynomial
No documentation available
v
polynomialSepolia
No documentation available
v
potos
No documentation available
v
potosTestnet
No documentation available
v
premiumBlockTestnet
No documentation available
T
Prettify
No documentation available
v
pulsechain
No documentation available
v
pulsechainV4
No documentation available
v
pumpfiTestnet
No documentation available
v
pyrope
No documentation available
v
ql1
No documentation available
v
qMainnet
No documentation available
v
qTestnet
No documentation available
v
quai
No documentation available
v
quaiTestnet
No documentation available
v
reactiveTestnet
No documentation available
v
real
No documentation available
v
redbellyMainnet
No documentation available
v
redbellyTestnet
No documentation available
v
reddio
No documentation available
v
reddioSepolia
No documentation available
v
redstone
No documentation available
v
rei
No documentation available
v
reyaNetwork
No documentation available
v
riseTestnet
No documentation available
v
rivalz
No documentation available
v
rollux
No documentation available
v
rolluxTestnet
No documentation available
v
ronin
No documentation available
v
root
No documentation available
v
rootPorcini
No documentation available
v
rootstock
No documentation available
v
rootstockTestnet
No documentation available
v
rss3
No documentation available
v
rss3Sepolia
No documentation available
v
saakuru
No documentation available
v
saga
No documentation available
v
saigon
No documentation available
v
sanko
No documentation available
v
sapphire
No documentation available
v
sapphireTestnet
No documentation available
v
satoshiVM
No documentation available
v
satoshiVMTestnet
No documentation available
v
scroll
No documentation available
v
scrollSepolia
No documentation available
v
sei
No documentation available
v
seiDevnet
No documentation available
v
seismicDevnet
No documentation available
v
seiTestnet
No documentation available
v
sepolia
No documentation available
v
serializersCelo
No documentation available
v
serializersOpStack
No documentation available
T
SerializeTransactionDepositReturnType
No documentation available
T
SerializeTransactionErrorType
No documentation available
f
serializeTransactionOpStack
No documentation available
T
SerializeTransactionReturnType
No documentation available
v
shape
No documentation available
v
shapeSepolia
No documentation available
v
shardeum
No documentation available
v
shardeumSphinx
No documentation available
v
shibarium
No documentation available
v
shibariumTestnet
No documentation available
v
shiden
No documentation available
v
shimmer
No documentation available
v
shimmerTestnet
No documentation available
v
sidraChain
No documentation available
v
silentData
No documentation available
v
silicon
No documentation available
v
siliconSepolia
No documentation available
v
sixProtocol
No documentation available
v
skaleBlockBrawlers
No documentation available
v
skaleCalypso
No documentation available
v
skaleCalypsoTestnet
No documentation available
v
skaleCryptoBlades
No documentation available
v
skaleCryptoColosseum
No documentation available
v
skaleEuropa
No documentation available
v
skaleEuropaTestnet
No documentation available
v
skaleExorde
No documentation available
v
skaleHumanProtocol
No documentation available
v
skaleNebula
No documentation available
v
skaleNebulaTestnet
No documentation available
v
skaleRazor
No documentation available
v
skaleTitan
No documentation available
v
skaleTitanTestnet
No documentation available
v
sketchpad
No documentation available
v
snax
No documentation available
v
snaxTestnet
No documentation available
v
somniaTestnet
No documentation available
v
soneium
No documentation available
v
soneiumMinato
No documentation available
v
songbird
No documentation available
v
songbirdTestnet
No documentation available
v
sonic
No documentation available
v
sonicBlazeTestnet
No documentation available
v
sonicTestnet
No documentation available
v
sophon
No documentation available
v
sophonTestnet
No documentation available
v
sova
No documentation available
v
sovaSepolia
No documentation available
v
spicy
No documentation available
v
statusSepolia
No documentation available
v
step
No documentation available
v
story
No documentation available
v
storyAeneid
No documentation available
v
stratis
No documentation available
v
superlumio
No documentation available
v
superposition
No documentation available
v
superseed
No documentation available
v
superseedSepolia
No documentation available
v
surgeTestnet
No documentation available
v
swan
No documentation available
v
swanProximaTestnet
No documentation available
v
swanSaturnTestnet
No documentation available
v
swellchain
No documentation available
v
swellchainTestnet
No documentation available
v
swissdlt
No documentation available
v
syscoin
No documentation available
v
syscoinTestnet
No documentation available
v
tac
No documentation available
v
tacSPB
No documentation available
v
taiko
No documentation available
v
taikoHekla
No documentation available
v
taikoJolnir
No documentation available
v
taikoKatla
No documentation available
v
taikoTestnetSepolia
No documentation available
v
taraxa
No documentation available
v
taraxaTestnet
No documentation available
v
teaSepolia
No documentation available
v
telcoinTestnet
No documentation available
v
telos
No documentation available
v
telosTestnet
No documentation available
v
tenet
No documentation available
v
ternoa
No documentation available
v
thaiChain
No documentation available
v
that
No documentation available
v
theta
No documentation available
v
thetaTestnet
No documentation available
v
thunderCore
No documentation available
v
thunderTestnet
No documentation available
v
tiktrixTestnet
No documentation available
v
tomb
No documentation available
T
TransactionRequestEIP712
No documentation available
T
TransactionSerializableDeposit
No documentation available
T
TransactionSerializedDeposit
No documentation available
v
treasure
No documentation available
v
treasureTopaz
No documentation available
v
tron
No documentation available
v
tronNile
No documentation available
v
tronShasta
No documentation available
v
ubiq
No documentation available
v
ultra
No documentation available
v
ultraTestnet
No documentation available
v
ultron
No documentation available
v
ultronTestnet
No documentation available
v
unichain
No documentation available
v
unichainSepolia
No documentation available
T
UnionLooseOmit
No documentation available
v
unique
No documentation available
v
uniqueOpal
No documentation available
v
uniqueQuartz
No documentation available
v
unreal
No documentation available
v
vana
No documentation available
v
vanaMoksha
No documentation available
v
vanar
No documentation available
v
vechain
No documentation available
v
velas
No documentation available
v
viction
No documentation available
v
victionTestnet
No documentation available
v
vision
No documentation available
v
visionTestnet
No documentation available
v
wanchain
No documentation available
v
wanchainTestnet
No documentation available
v
wemix
No documentation available
v
wemixTestnet
No documentation available
v
westendAssetHub
No documentation available
v
whitechain
No documentation available
v
whitechainTestnet
No documentation available
v
wmcTestnet
No documentation available
v
worldchain
No documentation available
v
worldchainSepolia
No documentation available
v
worldLand
No documentation available
v
x1Testnet
No documentation available
v
xai
No documentation available
v
xaiTestnet
No documentation available
v
xdc
No documentation available
v
xdcTestnet
No documentation available
v
xLayer
No documentation available
v
xoneMainnet
No documentation available
v
xoneTestnet
No documentation available
v
xphereMainnet
No documentation available
v
xphereTestnet
No documentation available
v
xrOne
No documentation available
v
xrplevmDevnet
No documentation available
v
xrplevmTestnet
No documentation available
v
xrSepolia
No documentation available
v
yooldoVerse
No documentation available
v
yooldoVerseTestnet
No documentation available
v
zenchainTestnet
No documentation available
v
zeniq
No documentation available
v
zeroG
No documentation available
v
zeroGGalileoTestnet
No documentation available
v
zeroGMainnet
No documentation available
v
zeroGTestnet
No documentation available
v
zeroNetwork
No documentation available
v
zetachain
No documentation available
v
zetachainAthensTestnet
No documentation available
v
zhejiang
No documentation available
v
zilliqa
No documentation available
v
zilliqaTestnet
No documentation available
v
zircuit
No documentation available
v
zircuitGarfieldTestnet
No documentation available
v
zircuitTestnet
No documentation available
v
zkFair
No documentation available
v
zkFairTestnet
No documentation available
v
zkLinkNova
No documentation available
v
zkLinkNovaSepoliaTestnet
No documentation available
v
zkSync
No documentation available
T
ZkSyncBlock
No documentation available
v
zkSyncInMemoryNode
No documentation available
v
zksyncLocalCustomHyperchain
No documentation available
v
zksyncLocalHyperchain
No documentation available
v
zksyncLocalHyperchainL1
No documentation available
v
zkSyncLocalNode
No documentation available
T
ZkSyncLog
No documentation available
T
ZkSyncRawBlockTransactions
No documentation available
T
ZkSyncRpcBlock
No documentation available
T
ZkSyncRpcLog
No documentation available
T
ZkSyncRpcTransaction
No documentation available
T
ZkSyncRpcTransactionEIP712
No documentation available
T
ZkSyncRpcTransactionPriority
No documentation available
T
ZkSyncRpcTransactionReceipt
No documentation available
T
ZkSyncRpcTransactionRequest
No documentation available
T
ZkSyncRpcTransactionRequestEIP712
No documentation available
v
zkSyncSepoliaTestnet
No documentation available
T
ZkSyncTransaction
No documentation available
T
ZkSyncTransactionEIP712
No documentation available
T
ZkSyncTransactionReceipt
No documentation available
T
ZkSyncTransactionRequest
No documentation available
T
ZkSyncTransactionRequest_internal
No documentation available
T
ZkSyncTransactionRequestEIP712
No documentation available
T
ZkSyncTransactionSerializable
No documentation available
T
ZkSyncTransactionSerializableEIP712
No documentation available
T
ZkSyncTransactionSerialized
No documentation available
T
ZkSyncTransactionSerializedEIP712
No documentation available
T
ZkSyncTransactionType
No documentation available
v
zora
No documentation available
v
zoraSepolia
No documentation available
v
zoraTestnet
No documentation available
v
storyOdyssey
No documentation available
v
storyTestnet
No documentation available
v
weaveVMAlphanet
No documentation available
f
assertCurrentChain
No documentation available
T
AssertCurrentChainErrorType
No documentation available
f
defineChain
No documentation available
f
extractChain
No documentation available
T
ExtractChainErrorType
No documentation available
T
ExtractChainParameters
No documentation available
T
ExtractChainReturnType
No documentation available
f
getChainContractAddress
No documentation available
T
GetChainContractAddressErrorType
No documentation available
f
labelhash
No documentation available
T
LabelhashErrorType
No documentation available
f
namehash
No documentation available
T
NamehashErrorType
No documentation available
f
normalize
No documentation available
T
NormalizeErrorType
No documentation available
f
packetToBytes
No documentation available
T
PacketToBytesErrorType
No documentation available
f
parseAvatarRecord
No documentation available
T
ParseAvatarRecordErrorType
No documentation available
f
toCoinType
No documentation available
T
ToCoinTypeError
No documentation available
T
Authorization
No documentation available
T
AuthorizationList
No documentation available
f
eip5792Actions

A suite of EIP-5792 Wallet Actions.

f
eip7702Actions
No documentation available
T
Erc7715Actions
No documentation available
f
erc7715Actions

A suite of ERC-7715 Wallet Actions.

T
Erc7739Actions
No documentation available
f
erc7739Actions

A suite of Actions based on Solady contracts.

T
Erc7739ActionsParameters
No documentation available
T
Erc7811Actions
No documentation available
f
erc7811Actions

A suite of ERC-7811 Wallet Actions.

f
erc7821Actions

A suite of Actions for ERC-7821.

T
Erc7846Actions
No documentation available
f
erc7846Actions

A suite of ERC-7846 Wallet Actions.

T
Erc7895Actions
No documentation available
f
erc7895Actions

A suite of ERC-7895 Wallet Actions.

f
grantPermissions

Request permissions from a wallet to perform actions on behalf of a user.

T
GrantPermissionsParameters
No documentation available
f
hashAuthorization

Computes an Authorization hash in EIP-7702 format: keccak256('0x05' || rlp([chain_id, address, nonce])).

T
HashAuthorizationErrorType
No documentation available
T
HashAuthorizationParameters
No documentation available
T
HashAuthorizationReturnType
No documentation available
f
recoverAuthorizationAddress
No documentation available
T
RecoverAuthorizationAddressErrorType
No documentation available
T
RecoverAuthorizationAddressParameters
No documentation available
T
RecoverAuthorizationAddressReturnType
No documentation available
T
T
RpcAuthorizationList
No documentation available
f
serializeAuthorizationList
No documentation available
T
SerializeAuthorizationListErrorType
No documentation available
T
SerializeAuthorizationListReturnType
No documentation available
T
SerializedAuthorization
No documentation available
T
SerializedAuthorizationList
No documentation available
T
SignedAuthorization
No documentation available
T
SignedAuthorizationList
No documentation available
f
verifyAuthorization

Verify that an Authorization object was signed by the provided address.

T
VerifyAuthorizationErrorType
No documentation available
T
VerifyAuthorizationParameters
No documentation available
T
VerifyAuthorizationReturnType
No documentation available
T
WriteContractFunctionParameters
No documentation available
f
writeContracts

Requests for the wallet to sign and broadcast a batch of write contract calls (transactions) to the network.

T
WriteContractsErrorType
No documentation available
T
WriteContractsParameters
No documentation available
T
WriteContractsReturnType
No documentation available
f
estimateGas

Estimates the gas and fees per gas necessary to complete a transaction without submitting it to the network.

T
EstimateGasParameters
No documentation available
f
getIpcRpcClient
No documentation available
f
ipc
No documentation available
T
IpcRpcClient
No documentation available
T
IpcTransport
No documentation available
T
IpcTransportErrorType
No documentation available
v
mainnetTrustedSetupPath
No documentation available
f
buildDepositTransaction

Prepares parameters for a deposit transaction to be initiated on an L1.

T
BuildDepositTransactionErrorType
No documentation available
T
BuildDepositTransactionParameters
No documentation available
T
BuildDepositTransactionReturnType
No documentation available
f
buildInitiateWithdrawal

Prepares parameters for a withdrawal from an L2 to the L1.

T
BuildInitiateWithdrawalErrorType
No documentation available
T
BuildInitiateWithdrawalParameters
No documentation available
T
BuildInitiateWithdrawalReturnType
No documentation available
f
buildProveWithdrawal

Builds the transaction that proves a withdrawal was initiated on an L2. Used in the Withdrawal flow.

T
BuildProveWithdrawalErrorType
No documentation available
T
BuildProveWithdrawalParameters
No documentation available
T
BuildProveWithdrawalReturnType
No documentation available
f
depositTransaction

Initiates a deposit transaction on an L1, which executes a transaction on L2.

T
DepositTransactionErrorType
No documentation available
T
DepositTransactionParameters
No documentation available
T
DepositTransactionReturnType
No documentation available
f
estimateContractL1Fee

Estimates the L1 data fee required to execute an L2 contract write.

T
EstimateContractL1FeeErrorType
No documentation available
T
EstimateContractL1FeeParameters
No documentation available
T
EstimateContractL1FeeReturnType
No documentation available
f
estimateContractL1Gas

Estimates the L1 data gas required to successfully execute a contract write function call.

T
EstimateContractL1GasErrorType
No documentation available
T
EstimateContractL1GasParameters
No documentation available
T
EstimateContractL1GasReturnType
No documentation available
f
estimateContractTotalFee

Estimates the L1 data fee + L2 fee to execute an L2 contract write.

T
EstimateContractTotalFeeErrorType
No documentation available
T
EstimateContractTotalFeeParameters
No documentation available
T
EstimateContractTotalFeeReturnType
No documentation available
f
estimateContractTotalGas

Estimates the L1 data gas + L2 gas required to successfully execute a contract write function call.

T
EstimateContractTotalGasErrorType
No documentation available
T
EstimateContractTotalGasParameters
No documentation available
T
EstimateContractTotalGasReturnType
No documentation available
f
estimateL1Fee

Estimates the L1 data fee required to execute an L2 transaction.

T
EstimateL1FeeErrorType
No documentation available
T
EstimateL1FeeParameters
No documentation available
T
EstimateL1FeeReturnType
No documentation available
f
estimateL1Gas

Estimates the L1 data gas required to execute an L2 transaction.

T
EstimateL1GasErrorType
No documentation available
T
EstimateL1GasParameters
No documentation available
T
EstimateL1GasReturnType
No documentation available
f
estimateOperatorFee

Estimates the operator fee required to execute an L2 transaction.

T
EstimateOperatorFeeErrorType
No documentation available
T
EstimateOperatorFeeParameters
No documentation available
T
EstimateOperatorFeeReturnType
No documentation available
f
estimateTotalFee

Estimates the L1 data fee + L2 fee + operator fee to execute an L2 transaction.

T
EstimateTotalFeeErrorType
No documentation available
T
EstimateTotalFeeParameters
No documentation available
T
EstimateTotalFeeReturnType
No documentation available
f
estimateTotalGas

Estimates the amount of L1 data gas + L2 gas required to execute an L2 transaction.

T
EstimateTotalGasErrorType
No documentation available
T
EstimateTotalGasParameters
No documentation available
T
EstimateTotalGasReturnType
No documentation available
f
extractTransactionDepositedLogs
No documentation available
T
ExtractTransactionDepositedLogsErrorType
No documentation available
T
T
ExtractTransactionDepositedLogsReturnType
No documentation available
f
extractWithdrawalMessageLogs
No documentation available
T
ExtractWithdrawalMessageLogsErrorType
No documentation available
T
ExtractWithdrawalMessageLogsParameters
No documentation available
T
ExtractWithdrawalMessageLogsReturnType
No documentation available
f
finalizeWithdrawal

Finalizes a withdrawal that occurred on an L2. Used in the Withdrawal flow.

T
FinalizeWithdrawalErrorType
No documentation available
T
FinalizeWithdrawalParameters
No documentation available
T
FinalizeWithdrawalReturnType
No documentation available
f
getGame

Retrieves a valid dispute game on an L2 that occurred after a provided L2 block number.

T
GetGameErrorType
No documentation available
T
GetGameParameters
No documentation available
T
GetGameReturnType
No documentation available
f
getGames

Retrieves dispute games for an L2.

T
GetGamesErrorType
No documentation available
T
GetGamesParameters
No documentation available
T
GetGamesReturnType
No documentation available
f
getL1BaseFee

get the L1 base fee

T
GetL1BaseFeeErrorType
No documentation available
T
GetL1BaseFeeParameters
No documentation available
T
GetL1BaseFeeReturnType
No documentation available
f
getL2Output

Retrieves the first L2 output proposal that occurred after a provided block number.

T
GetL2OutputErrorType
No documentation available
T
GetL2OutputParameters
No documentation available
f
getL2TransactionHash
No documentation available
T
GetL2TransactionHashErrorType
No documentation available
f
getL2TransactionHashes
No documentation available
T
GetL2TransactionHashesErrorType
No documentation available
T
GetL2TransactionHashesParameters
No documentation available
T
GetL2TransactionHashesReturnType
No documentation available
T
GetL2TransactionHashParameters
No documentation available
T
GetL2TransactionHashReturnType
No documentation available
f
getPortalVersion

Retrieves the current version of the Portal contract.

T
GetPortalVersionErrorType
No documentation available
T
GetPortalVersionParameters
No documentation available
T
GetPortalVersionReturnType
No documentation available
f
getSourceHash
No documentation available
T
GetSourceHashErrorType
No documentation available
T
GetSourceHashParameters
No documentation available
T
GetSourceHashReturnType
No documentation available
f
getTimeToFinalize

Returns the time until the withdrawal transaction can be finalized. Used for the Withdrawal flow.

T
GetTimeToFinalizeErrorType
No documentation available
T
GetTimeToFinalizeParameters
No documentation available
f
getTimeToNextGame

Returns the time until the next L2 dispute game (after the provided block number) is submitted. Used for the Withdrawal flow.

T
GetTimeToNextGameErrorType
No documentation available
T
GetTimeToNextGameParameters
No documentation available
f
getTimeToNextL2Output

Returns the time until the next L2 output (after the provided block number) is submitted. Used for the Withdrawal flow.

T
GetTimeToNextL2OutputErrorType
No documentation available
T
GetTimeToNextL2OutputParameters
No documentation available
f
getTimeToProve

Returns the time until the withdrawal transaction is ready to prove. Used for the Withdrawal flow.

T
GetTimeToProveErrorType
No documentation available
T
GetTimeToProveParameters
No documentation available
T
GetTimeToProveReturnType
No documentation available
f
getWithdrawalHashStorageSlot
No documentation available
T
GetWithdrawalHashStorageSlotErrorType
No documentation available
T
GetWithdrawalHashStorageSlotReturnType
No documentation available
f
getWithdrawals
No documentation available
T
GetWithdrawalsErrorType
No documentation available
T
GetWithdrawalsParameters
No documentation available
T
GetWithdrawalsReturnType
No documentation available
f
getWithdrawalStatus

Returns the current status of a withdrawal. Used for the Withdrawal flow.

T
GetWithdrawalStatusErrorType
No documentation available
T
GetWithdrawalStatusParameters
No documentation available
T
GetWithdrawalStatusReturnType
No documentation available
f
initiateWithdrawal

Initiates a withdrawal on an L2 to the L1.

T
InitiateWithdrawalErrorType
No documentation available
T
InitiateWithdrawalParameters
No documentation available
T
InitiateWithdrawalReturnType
No documentation available
f
opaqueDataToDepositData
No documentation available
T
OpaqueDataToDepositDataErrorType
No documentation available
T
OpaqueDataToDepositDataParameters
No documentation available
f
parseTransaction
No documentation available
T
ParseTransactionErrorType
No documentation available
T
ParseTransactionReturnType
No documentation available
f
proveWithdrawal

Proves a withdrawal that occurred on an L2. Used in the Withdrawal flow.

T
ProveWithdrawalErrorType
No documentation available
T
ProveWithdrawalParameters
No documentation available
T
ProveWithdrawalReturnType
No documentation available
f
publicActionsL1

A suite of Public Actions for suited for development with Layer 2 (OP Stack) chains.

f
publicActionsL2

A suite of Public Actions for suited for development with Layer 2 (OP Stack) chains.

f
waitForNextGame

Waits for the next dispute game (after the provided block number) to be submitted.

T
WaitForNextGameErrorType
No documentation available
T
WaitForNextGameParameters
No documentation available
T
WaitForNextGameReturnType
No documentation available
f
waitForNextL2Output

Waits for the next L2 output (after the provided block number) to be submitted.

T
WaitForNextL2OutputErrorType
No documentation available
T
WaitForNextL2OutputParameters
No documentation available
T
WaitForNextL2OutputReturnType
No documentation available
f
waitToFinalize

Waits until the withdrawal transaction can be finalized. Used for the Withdrawal flow.

T
WaitToFinalizeErrorType
No documentation available
T
WaitToFinalizeParameters
No documentation available
T
WaitToFinalizeReturnType
No documentation available
f
waitToProve

Waits until the L2 withdrawal transaction is ready to be proved. Used for the Withdrawal flow.

T
WaitToProveErrorType
No documentation available
T
WaitToProveParameters
No documentation available
T
WaitToProveReturnType
No documentation available
f
walletActionsL1

A suite of Wallet Actions for suited for development with Layer 2 (OP Stack) chains.

T
WalletActionsL2
No documentation available
f
walletActionsL2

A suite of Wallet Actions for suited for development with Layer 2 (OP Stack) chains.

f
createSiweMessage
No documentation available
T
CreateSiweMessageErrorType
No documentation available
T
CreateSiweMessageParameters
No documentation available
T
CreateSiweMessageReturnType
No documentation available
f
generateSiweNonce
No documentation available
f
parseSiweMessage
No documentation available
c
SiweInvalidMessageFieldError
No documentation available
T
SiweInvalidMessageFieldErrorType
No documentation available
f
validateSiweMessage
No documentation available
T
ValidateSiweMessageReturnType
No documentation available
f
verifySiweMessage

Verifies EIP-4361 formatted message was signed.

T
VerifySiweMessageErrorType
No documentation available
T
VerifySiweMessageParameters
No documentation available
T
VerifySiweMessageReturnType
No documentation available
v
arrayRegex
No documentation available
T
AssertEndOffsetErrorType
No documentation available
T
AssertSizeErrorType
No documentation available
T
AssertStartOffsetErrorType
No documentation available
f
buildRequest
No documentation available
v
bytesRegex
No documentation available
f
containsNodeError
No documentation available
f
defineFormatter
No documentation available
T
DefineFormatterErrorType
No documentation available
T
EncodeArgErrorType
No documentation available
f
extract
No documentation available
T
ExtractErrorType
No documentation available
f
formatAbiItem
No documentation available
T
FormatAbiItemErrorType
No documentation available
f
formatAbiItemWithArgs
No documentation available
T
FormatAbiItemWithArgsErrorType
No documentation available
T
FormatAbiParamErrorType
No documentation available
f
formatAbiParams
No documentation available
T
FormatAbiParamsErrorType
No documentation available
T
FromBytesReturnType
No documentation available
T
FromHexParameters
No documentation available
T
FromHexReturnType
No documentation available
f
getAction

Retrieves and returns an action from the client (if exists), and falls back to the tree-shakable action.

f
getCallError
No documentation available
T
GetCallErrorReturnType
No documentation available
f
getEstimateGasError
No documentation available
T
GetEstimateGasErrorReturnType
No documentation available
f
getHttpRpcClient
No documentation available
f
getNodeError
No documentation available
T
GetNodeErrorParameters
No documentation available
T
GetNodeErrorReturnType
No documentation available
f
getSocketRpcClient
No documentation available
T
GetSocketRpcClientErrorType
No documentation available
f
getTransactionError
No documentation available
T
GetTransactionErrorParameters
No documentation available
T
GetTransactionErrorReturnType
No documentation available
f
getWebSocketRpcClient
No documentation available
T
HashMessageReturnType
No documentation available
T
HexToBigIntOpts
No documentation available
T
HexToBoolOpts
No documentation available
T
HexToNumberOpts
No documentation available
T
HexToStringOpts
No documentation available
T
HttpRequestErrorType
No documentation available
T
HttpRequestReturnType
No documentation available
T
HttpRpcClient
No documentation available
v
integerRegex
No documentation available
T
RequestErrorType
No documentation available
v
rpc
No documentation available
T
SliceReturnType
No documentation available
T
Socket
No documentation available
v
socketClientCache
No documentation available
T
WebSocketAsyncErrorType
No documentation available
T
WebSocketAsyncOptions
No documentation available
T
WebSocketAsyncReturnType
No documentation available
T
WebSocketErrorType
No documentation available
T
WebSocketOptions
No documentation available
T
WebSocketReturnType
No documentation available
f
getSocket
No documentation available
f
claimFailedDeposit

Withdraws funds from the initiated deposit, which failed when finalizing on L2. If the deposit L2 transaction has failed, it sends an L1 transaction calling claimFailedDeposit method of the L1 bridge, which results in returning L1 tokens back to the depositor.

T
ClaimFailedDepositErrorType
No documentation available
T
ClaimFailedDepositParameters
No documentation available
T
ClaimFailedDepositReturnType
No documentation available
f
deployContract

Deploys a contract to the network, given bytecode and constructor arguments using EIP712 transaction.

T
DeployContractErrorType
No documentation available
T
DeployContractParameters
No documentation available
T
DeployContractReturnType
No documentation available
f
deposit

Transfers the specified token from the associated account on the L1 network to the target account on the L2 network. The token can be either ETH or any ERC20 token. For ERC20 tokens, enough approved tokens must be associated with the specified L1 bridge (default one or the one defined in bridgeAddress). In this case, depending on is the chain ETH-based or not approveToken or approveBaseToken can be enabled to perform token approval. If there are already enough approved tokens for the L1 bridge, token approval will be skipped.

T
DepositErrorType
No documentation available
T
DepositParameters
No documentation available
T
DepositReturnType
No documentation available
T
EIP712Domain
No documentation available
T
EIP712DomainFn
No documentation available
f
eip712WalletActions
No documentation available
f
encodeDeployData
No documentation available
T
EncodeDeployDataErrorType
No documentation available
f
estimateFee
No documentation available
T
EstimateFeeParameters
No documentation available
T
EstimateFeeReturnType
No documentation available
f
finalizeWithdrawal

Proves the inclusion of the L2->L1 withdrawal message.

T
FinalizeWithdrawalErrorType
No documentation available
T
FinalizeWithdrawalParameters
No documentation available
T
FinalizeWithdrawalReturnType
No documentation available
f
getAllBalances
No documentation available
T
GetAllBalancesParameters
No documentation available
T
GetAllBalancesReturnType
No documentation available
f
getApprovalBasedPaymasterInput
No documentation available
T
GetApprovalBasedPaymasterInputReturnType
No documentation available
f
getBlockDetails
No documentation available
T
GetBlockDetailsParameters
No documentation available
T
GetBlockDetailsReturnType
No documentation available
f
getBridgehubContractAddress
No documentation available
f
getDefaultBridgeAddresses
No documentation available
T
GetDefaultBridgeAddressesReturnType
No documentation available
f
getGasPerPubdata
No documentation available
T
GetGasPerPubdataReturnType
No documentation available
f
getGeneralPaymasterInput
No documentation available
T
T
GetGeneralPaymasterInputReturnType
No documentation available
f
getL1Allowance
No documentation available
T
GetL1AllowanceErrorType
No documentation available
T
GetL1AllowanceParameters
No documentation available
T
GetL1AllowanceReturnType
No documentation available
f
getL1Balance
No documentation available
T
GetL1BalanceErrorType
No documentation available
T
GetL1BalanceParameters
No documentation available
T
GetL1BalanceReturnType
No documentation available
f
getL1BatchBlockRange
No documentation available
T
T
GetL1BatchBlockRangeReturnParameters
No documentation available
f
getL1BatchDetails
No documentation available
T
GetL1BatchDetailsParameters
No documentation available
T
GetL1BatchDetailsReturnType
No documentation available
f
getL1BatchNumber
No documentation available
f
getL1ChainId
No documentation available
f
getL1TokenAddress

Returns the L1 token address equivalent for a L2 token address as they are not equal. ETH address is set to zero address.

T
GetL1TokenAddressParameters
No documentation available
T
GetL1TokenAddressReturnType
No documentation available
f
getL1TokenBalance
No documentation available
T
GetL1TokenBalanceErrorType
No documentation available
T
GetL1TokenBalanceParameters
No documentation available
T
GetL1TokenBalanceReturnType
No documentation available
f
getL2HashFromPriorityOp

Returns the hash of the L2 priority operation from a given L1 transaction receipt.

T
GetL2HashFromPriorityOpErrorType
No documentation available
f
getL2TokenAddress

Returns the L2 token address equivalent for a L1 token address as they are not equal. ETH address is set to zero address.

T
T
GetL2TokenAddressReturnType
No documentation available
f
getLogProof
No documentation available
T
GetLogProofParameters
No documentation available
T
GetLogProofReturnType
No documentation available
f
getMainContractAddress
No documentation available
f
getRawBlockTransactions
No documentation available
T
GetRawBlockTransactionsParameters
No documentation available
T
GetRawBlockTransactionsReturnType
No documentation available
f
getTestnetPaymasterAddress
No documentation available
f
getTransactionDetails
No documentation available
T
GetTransactionDetailsParameters
No documentation available
T
GetTransactionDetailsReturnType
No documentation available
T
GetWithdrawalL2ToL1LogParameters
No documentation available
T
GetWithdrawalLogParameters
No documentation available
T
GetWithdrawalLogReturnType
No documentation available
f
hashBytecode
No documentation available
T
HashBytecodeErrorType
No documentation available
f
isWithdrawalFinalized

Returns whether the withdrawal transaction is finalized on the L1 network.

T
IsWithdrawalFinalizedErrorType
No documentation available
T
IsWithdrawalFinalizedReturnType
No documentation available
v
l2BaseTokenAddress

The address of the base token.

v
legacyEthAddress

The address of the L1 ETH token.

f
parseEip712Transaction
No documentation available
f
publicActionsL1
No documentation available
f
publicActionsL2
No documentation available
T
PublicZksyncRpcSchema
No documentation available
T
RawBlockTransactions
No documentation available
f
requestExecute

Requests execution of a L2 transaction from L1.

T
RequestExecuteErrorType
No documentation available
T
RequestExecuteParameters
No documentation available
T
RequestExecuteReturnType
No documentation available
f
sendEip712Transaction

Creates, signs, and sends a new EIP712 transaction to the network.

T
SendEip712TransactionErrorType
No documentation available
T
SendEip712TransactionParameters
No documentation available
T
SendEip712TransactionReturnType
No documentation available
f
sendTransaction

Creates, signs, and sends a new transaction to the network.

T
SendTransactionErrorType
No documentation available
T
SendTransactionParameters
No documentation available
T
SendTransactionReturnType
No documentation available
f
serializeTransaction
No documentation available
f
signEip712Transaction

Signs an EIP712 transaction.

T
SignEip712TransactionErrorType
No documentation available
T
SignEip712TransactionParameters
No documentation available
T
SignEip712TransactionReturnType
No documentation available
f
signTransaction

Signs a transaction.

T
SignTransactionErrorType
No documentation available
T
SignTransactionParameters
No documentation available
T
SignTransactionReturnType
No documentation available
f
toMultisigSmartAccount

Creates a ZKsync Smart Account from a Contract Address and an array of Private Keys belonging to the owners.

f
toSinglesigSmartAccount

Creates a ZKsync Smart Account from a Contract Address and a Private Key belonging to the owner.

f
toSmartAccount

Creates a ZKsync Smart Account from a Contract Address and a custom sign function.

T
ToSmartAccountErrorType
No documentation available
T
ToSmartAccountParameters
No documentation available
f
undoL1ToL2Alias

Converts and returns the msg.sender viewed on L2 to the address that submitted a transaction to the inbox on L1.

f
walletActionsL1
No documentation available
T
WalletActionsL2
No documentation available
f
walletActionsL2
No documentation available
f
withdraw

Initiates the withdrawal process which withdraws ETH or any ERC20 token from the associated account on L2 network to the target account on L1 network.

T
WithdrawErrorType
No documentation available
T
WithdrawParameters
No documentation available
T
WithdrawReturnType
No documentation available
T
ZksyncBatchDetails
No documentation available
T
ZksyncNumberParameter
No documentation available
T
ZksyncSmartAccount
No documentation available

New Ticket: Report package

Please provide a reason for reporting this package. We will review your report and take appropriate action.

Please review the JSR usage policy before submitting a report.