Types

BlockTag

A BlockTag specifies a specific block location in the Blockchain.

Networkish

A Networkish may be any of the following:

Network

A Network represents an Ethereum network.

network.name string

The human-readable name of the network, such as homestead. If the network name is unknown, this will be "unknown".

network.chainId number

The Chain ID of the network.

network.ensAddress string< Address >

The address at which the ENS registry is deployed on this network.

FeeData

A FeeData object encapsulates the necessary fee data required to send a transaction, based on the best available recommendations.

feeData.gasPrice BigNumber

The gasPrice to use for legacy transactions or networks which do not support EIP-1559.

feeData.maxFeePerGas BigNumber

The maxFeePerGas to use for a transaction. This is based on the most recent block's baseFee.

feeData.maxPriorityFeePerGas BigNumber

The maxPriorityFeePerGas to use for a transaction. This accounts for the uncle risk and for the majority of current MEV risk.

Block

block.hash string< DataHexString< 32 > >

The hash of this block.

block.parentHash string< DataHexString< 32 > >

The hash of the previous block.

block.number number

The height (number) of this block.

block.timestamp number

The timestamp of this block.

block.nonce string< DataHexString >

The nonce used as part of the proof-of-work to mine this block.

This property is generally of little interest to developers.

block.difficulty number

The difficulty target required to be met by the miner of the block.

This property is generally of little interest to developers.

block.gasLimit BigNumber

The maximum amount of gas that this block was permitted to use. This is a value that can be voted up or voted down by miners and is used to automatically adjust the bandwidth requirements of the network.

This property is generally of little interest to developers.

block.gasUsed BigNumber

The total amount of gas used by all transactions in this block.

block.miner string

The coinbase address of this block, which indicates the address the miner that mined this block would like the subsidy reward to go to.

block.extraData string

This is extra data a miner may choose to include when mining a block.

This property is generally of little interest to developers.

Block (with transaction hashes)

Often only the hashes of the transactions included in a block are needed, so by default a block only contains this information, as it is substantially less data.

block.transactions Array< string< DataHexString< 32 > > >

A list of the transactions hashes for each transaction this block includes.

BlockWithTransactions inherits Block

If all transactions for a block are needed, this object instead includes the full details on each transaction.

block.transactions Array< TransactionResponse >

A list of the transactions this block includes.

Events and Logs

EventFilter

filter.address string< Address >

The address to filter by, or null to match any address.

filter.topics Array< string< Data< 32 > > | Array< string< Data< 32 > > > >

The topics to filter by or null to match any topics.

Each entry represents an AND condition that must match, or may be null to match anything. If a given entry is an Array, then that entry is treated as an OR for any value in the entry.

See Filters for more details and examples on specifying complex filters.

Filter inherits EventFilter

filter.fromBlock BlockTag

The starting block (inclusive) to search for logs matching the filter criteria.

filter.toBlock BlockTag

The end block (inclusive) to search for logs matching the filter criteria.

FilterByBlockHash inherits EventFilter

filter.blockHash string< DataHexString< 32 > >

The specific block (by its block hash) to search for logs matching the filter criteria.

Log

log.blockNumber number

The block height (number) of the block including the transaction of this log.

log.blockHash string< DataHexString< 32 > >

The block hash of the block including the transaction of this log.

log.removed boolean

During a re-org, if a transaction is orphaned, this will be set to true to indicate the Log entry has been removed; it will likely be emitted again in the near future when another block is mined with the transaction that triggered this log, but keep in mind the values may change.

log.transactionLogIndex number

The index of this log in the transaction.

log.address string< Address >

The address of the contract that generated this log.

log.data string< DataHexString >

The data included in this log.

log.topics Array< string< DataHexString< 32 > > >

The list of topics (indexed properties) for this log.

log.transactionHash string< DataHexString< 32 > >

The transaction hash of the transaction of this log.

log.transactionIndex number

The index of the transaction in the block of the transaction of this log.

log.logIndex number

The index of this log across all logs in the entire block.

Transactions

TransactionRequest

A transaction request describes a transaction that is to be sent to the network or otherwise processed.

All fields are optional and may be a promise which resolves to the required type.

transactionRequest.to string | Promise< string >

The address (or ENS name) this transaction it to.

transactionRequest.from string< Address > | Promise< string< Address > >

The address this transaction is from.

transactionRequest.nonce number | Promise< number >

The nonce for this transaction. This should be set to the number of transactions ever sent from this address.

transactionRequest.data DataHexString | Promise< DataHexString >

The transaction data.

transactionRequest.value BigNumber | Promise< BigNumber >

The amount (in wei) this transaction is sending.

transactionRequest.gasLimit BigNumber | Promise< BigNumber >

The maximum amount of gas this transaction is permitted to use.

If left unspecified, ethers will use estimateGas to determine the value to use. For transactions with unpredicatable gas estiamtes, this may be required to specify explicitly.

transactionRequest.gasPrice BigNumber | Promise< BigNumber >

The price (in wei) per unit of gas this transaction will pay.

This may not be specified for transactions with type set to 1 or 2, or if maxFeePerGas or maxPriorityFeePerGas is given.

transactionRequest.maxFeePerGas BigNumber | Promise< BigNumber >

The maximum price (in wei) per unit of gas this transaction will pay for the EIP-1559 base fee.

Most developers should leave this unspecified and use the default value that ethers determines from the network.

This may not be specified for transactions with type set to 0 or if gasPrice is specified..

transactionRequest.maxPriorityFeePerGas BigNumber | Promise< BigNumber >

The price (in wei) per unit of gas this transaction will pay for the EIP-1559 priority fee. This is included in the maxFeePerGass, so this will not affect the total maximum cost set with maxFeePerGas.

Most developers should leave this unspecified and use the default value that ethers determines from the network.

This may not be specified for transactions with type set to 0 or if gasPrice is specified.

transactionRequest.chainId number | Promise< number >

The chain ID this transaction is authorized on, as specified by EIP-155.

If the chain ID is 0 will disable EIP-155 and the transaction will be valid on any network. This can be dangerous and care should be taken, since it allows transactions to be replayed on networks that were possibly not intended. Intentionally-replayable transactions are also disabled by default on recent versions of Geth and require configuration to enable.

transactionRequest.type null | number

The EIP-2718 type of this transaction envelope, or null for to use the network default. To force using a lagacy transaction without an envelope, use type 0.

transactionRequest.accessList AccessListish

The AccessList to include; only available for EIP-2930 and EIP-1559 transactions.

TransactionResponse inherits Transaction

A TransactionResponse includes all properties of a Transaction as well as several properties that are useful once it has been mined.

transaction.blockNumber number

The number ("height") of the block this transaction was mined in. If the block has not been mined, this is null.

transaction.blockHash string< DataHexString< 32 > >

The hash of the block this transaction was mined in. If the block has not been mined, this is null.

transaction.timestamp number

The timestamp of the block this transaction was mined in. If the block has not been mined, this is null.

transaction.confirmations number

The number of blocks that have been mined (including the initial block) since this transaction was mined.

transaction.raw string< DataHexString >

The serialized transaction. This may be null as some backends do not rpopulate it. If this is required, it can be computed from a TransactionResponse object using this cookbook recipe.

transaction.wait( [ confirms = 1 ] ) Promise< TransactionReceipt >

Resolves to the TransactionReceipt once the transaction has been included in the chain for confirms blocks. If confirms is 0, and the transaction has not been mined, null is returned.

If the transaction execution failed (i.e. the receipt status is 0), a CALL_EXCEPTION error will be rejected with the following properties:

  • error.transaction - the original transaction
  • error.transactionHash - the hash of the transaction
  • error.receipt - the actual receipt, with the status of 0

If the transaction is replaced by another transaction, a TRANSACTION_REPLACED error will be rejected with the following properties:

  • error.hash - the hash of the original transaction which was replaced
  • error.reason - a string reason; one of "repriced", "cancelled" or "replaced"
  • error.cancelled - a boolean; a "repriced" transaction is not considered cancelled, but "cancelled" and "replaced" are
  • error.replacement - the replacement transaction (a TransactionResponse)
  • error.receipt - the receipt of the replacement transaction (a TransactionReceipt)

Transactions are replaced when the user uses an option in their client to send a new transaction from the same account with the original nonce. This is usually to speed up a transaction or to cancel one, by bribing miners with additional fees to prefer the new transaction over the original one.

transactionRequest.type number

The EIP-2718 type of this transaction. If the transaction is a legacy transaction without an envelope, it will have the type 0.

transactionRequest.accessList AccessList

The AccessList included, or null for transaction types which do not support access lists.

TransactionReceipt

receipt.to string< Address >

The address this transaction is to. This is null if the transaction was an init transaction, used to deploy a contract.

receipt.from string< Address >

The address this transaction is from.

receipt.contractAddress string< Address >

If this transaction has a null to address, it is an init transaction used to deploy a contract, in which case this is the address created by that contract.

To compute a contract address, the getContractAddress utility function can also be used with a TransactionResponse object, which requires the transaction nonce and the address of the sender.

receipt.transactionIndex number

The index of this transaction in the list of transactions included in the block this transaction was mined in.

receipt.type number

The EIP-2718 type of this transaction. If the transaction is a legacy transaction without an envelope, it will have the type 0.

receipt.root string

The intermediate state root of a receipt.

Only transactions included in blocks before the Byzantium Hard Fork have this property, as it was replaced by the status property.

The property is generally of little use to developers. At the time it could be used to verify a state transition with a fraud-proof only considering the single transaction; without it the full block must be considered.

receipt.gasUsed BigNumber

The amount of gas actually used by this transaction.

receipt.logsBloom string< DataHexString >

A bloom-filter, which includes all the addresses and topics included in any log in this transaction.

receipt.blockHash string< DataHexString< 32 > >

The block hash of the block that this transaction was included in.

receipt.transactionHash string< DataHexString< 32 > >

The transaction hash of this transaction.

receipt.logs Array< Log >

All the logs emitted by this transaction.

receipt.blockNumber number

The block height (number) of the block that this transaction was included in.

receipt.confirmations number

The number of blocks that have been mined since this transaction, including the actual block it was mined in.

receipt.cumulativeGasUsed BigNumber

For the block this transaction was included in, this is the sum of the gas used by each transaction in the ordered list of transactions up to (and including) this transaction.

This is generally of little interest to developers.

receipt.byzantium boolean

This is true if the block is in a post-Byzantium Hard Fork block.

receipt.status boolean

The status of a transaction is 1 is successful or 0 if it was reverted. Only transactions included in blocks post-Byzantium Hard Fork have this property.

Access Lists

An Access List is optional an includes a list of addresses and storage slots for that address which should be warmed or pre-fetched for use within the execution of this transaction. A warmed value has an additional upfront cost to access, but is discounted throughout the code execution for reading and writing.

AccessListish

A looser description of an AccessList, which will be converted internally using accessListify.

It may be any of:

When using the object form (the last option), the addresses and storage slots will be sorted. If an explicit order for the access list is required, one of the other forms must be used. Most developers do not require explicit order.

equivalent to the AccessList example below
// Option 1: // AccessList // see below // Option 2: // Array< [ Address, Array<Bytes32> ] > accessList = [ [ "0x0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e", [ "0x0000000000000000000000000000000000000000000000000000000000000004", "0x0bcad17ecf260d6506c6b97768bdc2acfb6694445d27ffd3f9c1cfbee4a9bd6d" ] ], [ "0x5FfC014343cd971B7eb70732021E26C35B744cc4", [ "0x0000000000000000000000000000000000000000000000000000000000000001" ] ] ]; // Option 3: // Record<Address, Array<Bytes32>> accessList = { "0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e": [ "0x0000000000000000000000000000000000000000000000000000000000000004", "0x0bcad17ecf260d6506c6b97768bdc2acfb6694445d27ffd3f9c1cfbee4a9bd6d" ], "0x5FfC014343cd971B7eb70732021E26C35B744cc4": [ "0x0000000000000000000000000000000000000000000000000000000000000001" ] };

AccessList

An EIP-2930 transaction allows an optional AccessList which causes a transaction to warm (i.e. pre-cache) another addresses state and the specified storage keys.

This incurs an increased intrinsic cost for the transaction, but provides discounts for storage and state access throughout the execution of the transaction.

example access list
// Array of objects with the form: // { // address: Address, // storageKey: Array< DataHexString< 32 > > // } accessList = [ { address: "0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e", storageKeys: [ "0x0000000000000000000000000000000000000000000000000000000000000004", "0x0bcad17ecf260d6506c6b97768bdc2acfb6694445d27ffd3f9c1cfbee4a9bd6d" ] }, { address: "0x5FfC014343cd971B7eb70732021E26C35B744cc4", storageKeys: [ "0x0000000000000000000000000000000000000000000000000000000000000001" ] } ];