Documentation

Documentation »API »Providers »Formatting

Formatting

About provider formatting?

interface BlockParams

a BlockParams encodes the minimal required properties for a formatted block.

PROPERTIES

<src>blockParams.baseFeePerGas⇒ null | bigint

The protocol-defined base fee per gas in an EIP-1559 block.

<src>blockParams.blobGasUsed⇒ null | bigint

The total amount of BLOb gas consumed by transactions within the block. See [[link-eip4844].

<src>blockParams.difficulty⇒ bigint

For proof-of-work networks, the difficulty target is used to adjust the difficulty in mining to ensure a expected block rate.

<src>blockParams.excessBlobGas⇒ null | bigint

The running total of BLOb gas consumed in excess of the target prior to the block. See EIP-4844.

<src>blockParams.extraData⇒ string

Additional data the miner choose to include.

<src>blockParams.gasLimit⇒ bigint

The maximum amount of gas a block can consume.

<src>blockParams.gasUsed⇒ bigint

The amount of gas a block consumed.

<src>blockParams.hash⇒ null | string

The block hash.

<src>blockParams.miner⇒ string

The miner (or author) of a block.

<src>blockParams.nonce⇒ string

A random sequence provided during the mining process for proof-of-work networks.

<src>blockParams.number⇒ number

The block number.

<src>blockParams.parentBeaconBlockRoot⇒ null | string

The hash tree root of the parent beacon block for the given execution block. See EIP-4844.

<src>blockParams.parentHash⇒ string

The hash of the previous block in the blockchain. The genesis block has the parentHash of the ZeroHash.

<src>blockParams.prevRandao⇒ null | string

The latest RANDAO mix of the post beacon state of the previous block.

<src>blockParams.receiptsRoot⇒ null | string

The hash of the transaction receipts trie.

<src>blockParams.stateRoot⇒ null | string

The root hash for the global state after applying changes in this block.

<src>blockParams.timestamp⇒ number

The timestamp for this block, which is the number of seconds since epoch that this block was included.

<src>blockParams.transactions⇒ ReadonlyArray< string | TransactionResponseParams >

The list of transactions in the block.

interface LogParams

a LogParams encodes the minimal required properties for a formatted log.

PROPERTIES

<src>logParams.address⇒ string

The address of the contract that emitted this log.

<src>logParams.blockHash⇒ string

The block hash of the block that included the transaction for this log.

<src>logParams.blockNumber⇒ number

The block number of the block that included the transaction for this log.

<src>logParams.data⇒ string

The data emitted with this log.

<src>logParams.index⇒ number

The index of this log.

<src>logParams.removed⇒ boolean

Whether this log was removed due to the transaction it was included in being removed dur to an orphaned block.

<src>logParams.topics⇒ ReadonlyArray< string >

The topics emitted with this log.

<src>logParams.transactionHash⇒ string

The transaction hash for the transaxction the log occurred in.

<src>logParams.transactionIndex⇒ number

The transaction index of this log.

interface TransactionReceiptParams

a TransactionReceiptParams encodes the minimal required properties for a formatted transaction receipt.

PROPERTIES

<src>transactionReceiptParams.blobGasPrice⇒ null | bigint

The actual BLOb gas price that was charged. See EIP-4844.

<src>transactionReceiptParams.blobGasUsed⇒ null | bigint

The amount of BLOb gas used. See EIP-4844.

<src>transactionReceiptParams.blockHash⇒ string

The block hash of the block that included this transaction.

<src>transactionReceiptParams.blockNumber⇒ number

The block number of the block that included this transaction.

<src>transactionReceiptParams.contractAddress⇒ null | string

If the transaction was directly deploying a contract, the to will be null, the data will be initcode and if successful, this will be the address of the contract deployed.

<src>transactionReceiptParams.cumulativeGasUsed⇒ bigint

The total amount of gas consumed during the entire block up to and including this transaction.

<src>transactionReceiptParams.effectiveGasPrice⇒ null | bigint

The actual gas price per gas charged for this transaction.

<src>transactionReceiptParams.from⇒ string

The sender of the transaction.

<src>transactionReceiptParams.gasPrice⇒ null | bigint

The actual gas price per gas charged for this transaction.

<src>transactionReceiptParams.gasUsed⇒ bigint

The amount of gas consumed executing this transaciton.

<src>transactionReceiptParams.hash⇒ string

The transaction hash.

<src>transactionReceiptParams.index⇒ number

The transaction index.

<src>transactionReceiptParams.logs⇒ ReadonlyArray< LogParams >

The logs emitted during the execution of this transaction.

<src>transactionReceiptParams.logsBloom⇒ string

The bloom filter for the logs emitted during execution of this transaction.

<src>transactionReceiptParams.root⇒ null | string

The root of this transaction in a pre-bazatium block. In post-byzantium blocks this is null.

<src>transactionReceiptParams.status⇒ null | number

The status of the transaction execution. If 1 then the the transaction returned success, if 0 then the transaction was reverted. For pre-byzantium blocks, this is usually null, but some nodes may have backfilled this data.

<src>transactionReceiptParams.to⇒ null | string

The target of the transaction. If null, the transaction was trying to deploy a transaction with the data as the initi=code.

<src>transactionReceiptParams.type⇒ number

The EIP-2718 envelope type.

interface TransactionResponseParams

a TransactionResponseParams encodes the minimal required properties for a formatted transaction response.

PROPERTIES

<src>transactionResponseParams.accessList⇒ null | AccessList

The transaction access list.

<src>transactionResponseParams.blobVersionedHashes⇒ null | Array< string >

The EIP-4844 BLOb versioned hashes.

<src>transactionResponseParams.blockHash⇒ null | string

The block hash of the block that included this transaction.

<src>transactionResponseParams.blockNumber⇒ null | number

The block number of the block that included this transaction.

<src>transactionResponseParams.chainId⇒ bigint

The chain ID this transaction is valid on.

<src>transactionResponseParams.data⇒ string

The transaction data.

<src>transactionResponseParams.from⇒ string

The sender of the transaction.

<src>transactionResponseParams.gasLimit⇒ bigint

The maximum amount of gas this transaction is authorized to consume.

<src>transactionResponseParams.gasPrice⇒ bigint

For legacy transactions, this is the gas price per gas to pay.

<src>transactionResponseParams.hash⇒ string

The transaction hash.

<src>transactionResponseParams.index⇒ number

The transaction index.

<src>transactionResponseParams.maxFeePerBlobGas⇒ null | bigint

For EIP-4844 transactions, this is the maximum fee that will be paid per BLOb.

<src>transactionResponseParams.maxFeePerGas⇒ null | bigint

For EIP-1559 transactions, this is the maximum fee that will be paid.

<src>transactionResponseParams.maxPriorityFeePerGas⇒ null | bigint

For EIP-1559 transactions, this is the maximum priority fee to allow a producer to claim.

<src>transactionResponseParams.nonce⇒ number

The nonce of the transaction, used for replay protection.

<src>transactionResponseParams.signature⇒ Signature

The signature of the transaction.

<src>transactionResponseParams.to⇒ null | string

The target of the transaction. If null, the data is initcode and this transaction is a deployment transaction.

<src>transactionResponseParams.type⇒ number

The EIP-2718 transaction type.

<src>transactionResponseParams.value⇒ bigint

The transaction value (in wei).