Ethersv5 API

Types and Interfaces

Definitions and interfaces used in ZKsync Era.

These types and interfaces are essential for developers working with the ZKsync blockchain, as they define the structures and enumerations for different components of the system.

AccountAbstractionVersion

Enumerated list of account abstraction versions.

AccountNonceOrdering

Enumerated list of account nonce ordering formats.

Address

0x-prefixed, hex-encoded, Ethereum account address as string.

ApprovalBasedPaymasterInput

Interface representation of approval-based paymaster input.

BalancesMap

Type defining a map object containing accounts and their balances.

  • { [key: string]: BigNumber }

BatchDetails

Interface representation of batch details.

Block

Interface representation of a block that extends the Ethers providers.Block definition with additional fields.

BlockDetails

Interface representation of block details.

BlockTag

Pipe-delimited list of block labels that includes block number in binary and hex plus block statuses.

BlockWithTransaction

Interface representation of block with transaction(s) that extends the Ethers BlockWithTransactions definition with additional fields.

ContractAccountInfo

Interface representation for contract account information containing information on account abstraction version and nonce ordering format.

DeploymentInfo

Interface representation of deployment information.

DeploymentType

Pipe-delimited choice of two deployment types that support all create2 variants.

Eip712Meta

Contains EIP712 transaction metadata.

EthereumSignature

Interface representation of an Ethereum signature.

EventFilter

Interface representation of event filter which allows efficiently filtering logs (also known as events) using bloom filters included within blocks.

Fee

Interface representation of transaction fee parameters.

FeeParams

Interface representation of fee parameter configuration.

FinalizeWithdrawalParams

Interface representation of finalize withdrawal parameters.

FullDepositFee

Interface representation of full deposit fee containing fees for both L1 and L2 transactions.

GeneralPaymasterInput

Interface representation of general paymaster input.

L2ToL1Log

Interface representation of a layer 2 to layer 1 transaction log.

Log

Interface representation of log that extends Ethers providers.Log and supplies the layer 1 batch number.

LogProof

Interface representation of message proof.

MessageProof

Interface representation of message proof.

Deprecated in favor of [LogProof](#logproof)

Network

Enumerated list of networks and their ids.

PaymasterInput

Type definition for a paymaster input specified as either approval based or general.

PaymasterParams

Type defining a paymaster by address and the bytestream input.

PayloadSigner

Signs various types of payloads, optionally using some kind of secret.

PriorityOpResponse

Interface representation of priority op response that extends TransactionResponse and adds a function that waits to commit a layer 1 transaction, including when given an optional confirmation number.

PriorityOpTree

Enumerated list of priority operation tree types.

PriorityQueueType

Enumerated list of priority queue types.

ProtocolVersion

Interface representation of protocol version.

RawBlockTransaction

Interface representation of raw block with transactions.

Signature

0x-prefixed, hex-encoded, ECDSA signature as string.

SmartAccountSigner

Encapsulates the required input parameters for creating a signer for SmartAccount.

StorageProof

Interface representation of Merkle proofs for storage values.

Token

Interface representation of bridged token.

TransactionBuilder

Populates missing fields in a transaction with default values.

TransactionDetails

Interface representation of transaction details.

TransactionReceipt

Interface representation of transaction receipt that extends from Ethers providers.TransactionReceipt with additional fields.

TransactionRequest

Interface representation of transaction request that extends from Ethers providers.TransactionRequest which adds an optional field for EIP-712 transactions.

TransactionResponse

Interface representation of transaction response that extends from Ethers providers.TransactionResponse with additional fields.

TransactionStatus

Enumerated list of transaction statuses.

TransactionWithDetailedOutput

Interface representation of transaction with detailed output.


Made with ❤️ by the ZKsync Community