* Add Warning to Docs about Restarting Node before Fully Syncing A Node
Signed-off-by: gtrintinalia <gabriel.trintinalia@consensys.net>
* fix vale errors cause by workflow migration
Signed-off-by: Alexandra Tran <alexandra.tran@consensys.net>
* edit sync note
Signed-off-by: Alexandra Tran <alexandra.tran@consensys.net>
Signed-off-by: gtrintinalia <gabriel.trintinalia@consensys.net>
Signed-off-by: Alexandra Tran <alexandra.tran@consensys.net>
Co-authored-by: gtrintinalia <gabriel.trintinalia@consensys.net>
Co-authored-by: Alexandra Tran <alexandra.tran@consensys.net>
@ -18,20 +18,20 @@ Returned by [`priv_getPrivateTransaction`](index.md#priv_getprivatetransaction).
| Key | Type | Value |
|-----|:----:|-------|
| **from** | Data, 20 bytes | Address of the sender. |
| **gas** | Quantity | Gas provided by the sender. |
| **gasPrice** | Quantity | Gas price, in Wei, provided by the sender. |
| **input** | Data | The data to create or invoke a contract. |
| **nonce** | Quantity | Number of transactions made by the sender to the privacy group before this one. |
| **to** | Data, 20 bytes | `null` if a contract creation transaction, otherwise, the contract address. |
| **value** | Quantity | `null` because private transactions cannot transfer Ether. |
| **v** | Quantity | ECDSA Recovery ID. |
| **r** | Data, 32 bytes | ECDSA signature r. |
| **s** | Data, 32 bytes | ECDSA signature s. |
| **privateFrom** | Data, 32 bytes | [Tessera](https://docs.tessera.consensys.net/) public key of the sender. |
| **privateFor** | Array of Data, 32 bytes each | [Tessera](https://docs.tessera.consensys.net/) public keys of recipients. Not returned if using `privacyGroupId` to [send the transaction](../../../private-networks/concepts/privacy/privacy-groups.md#privacy-types). |
| **privacyGroupId** | Data, 32 bytes | [Tessera](https://docs.tessera.consensys.net/) privacy group ID of recipients. Not returned if using `privateFor` to [send the transaction](../../../private-networks/concepts/privacy/privacy-groups.md#privacy-types). |
| **restriction** | String | Must be [`restricted`](../../../private-networks/concepts/privacy/private-transactions/index.md). |
| `from` | Data, 20 bytes | Address of the sender. |
| `gas` | Quantity | Gas provided by the sender. |
| `gasPrice` | Quantity | Gas price, in Wei, provided by the sender. |
| `input` | Data | The data to create or invoke a contract. |
| `nonce` | Quantity | Number of transactions made by the sender to the privacy group before this one. |
| `to` | Data, 20 bytes | `null` if a contract creation transaction, otherwise, the contract address. |
| `value` | Quantity | `null` because private transactions cannot transfer Ether. |
| `v` | Quantity | ECDSA Recovery ID. |
| `r` | Data, 32 bytes | ECDSA signature r. |
| `s` | Data, 32 bytes | ECDSA signature s. |
| `privateFrom` | Data, 32 bytes | [Tessera](https://docs.tessera.consensys.net/) public key of the sender. |
| `privateFor` | Array of Data, 32 bytes each | [Tessera](https://docs.tessera.consensys.net/) public keys of recipients. Not returned if using `privacyGroupId` to [send the transaction](../../../private-networks/concepts/privacy/privacy-groups.md#privacy-types). |
| `privacyGroupId` | Data, 32 bytes | [Tessera](https://docs.tessera.consensys.net/) privacy group ID of recipients. Not returned if using `privateFor` to [send the transaction](../../../private-networks/concepts/privacy/privacy-groups.md#privacy-types). |
| `restriction` | String | Must be [`restricted`](../../../private-networks/concepts/privacy/private-transactions/index.md). |
## Private transaction receipt object
@ -39,17 +39,17 @@ Returned by [`priv_getTransactionReceipt`](index.md#priv_gettransactionreceipt).
| **blockHash** | Data, 32 bytes | Hash of block containing this transaction. |
| **blockNumber** | Quantity | Block number of block containing this transaction. |
| **contractAddress** | Data, 20 bytes | Contract address created if a contract creation transaction, otherwise, `null`. A failed contract creation transaction still produces a contract address value. |
| **from** | Data, 20 bytes | Address of the sender. |
| **logs** | Array | Array of [log objects](../../../public-networks/reference/api/objects.md#log-object) generated by this private transaction. |
| **to** | Data, 20 bytes | Address of the receiver, if sending ether, otherwise, null. |
| **transactionIndex** | Quantity, Integer | Index position of transaction in the block. |
| **revertReason** | String | ABI-encoded string that displays the [reason for reverting the transaction](../../../private-networks/how-to/send-transactions/revert-reason.md). Only available if revert reason is [enabled](../cli/options.md#revert-reason-enabled). |
| **output** | Data | RLP-encoded return value of a contract call if a value returns, otherwise, `null`. |
| **commitmentHash** | Data, 32 bytes | Hash of the privacy marker transaction. |
| **status** | Quantity | Either `0x1` (success) or `0x0` (failure). |
| **privateFrom** | Data, 32 bytes | [Tessera](https://docs.tessera.consensys.net/) public key of the sender. |
| **privateFor** or **privacyGroupId** | Array or Data, 32 bytes | [Tessera](https://docs.tessera.consensys.net/) public keys or privacy group ID of the recipients. |
| **logsBloom** | Data, 256 bytes | Bloom filter for light clients to quickly retrieve related logs. |
| `blockHash` | Data, 32 bytes | Hash of block containing this transaction. |
| `blockNumber` | Quantity | Block number of block containing this transaction. |
| `contractAddress` | Data, 20 bytes | Contract address created if a contract creation transaction, otherwise, `null`. A failed contract creation transaction still produces a contract address value. |
| `from` | Data, 20 bytes | Address of the sender. |
| `logs` | Array | Array of [log objects](../../../public-networks/reference/api/objects.md#log-object) generated by this private transaction. |
| `to` | Data, 20 bytes | Address of the receiver, if sending ether, otherwise, null. |
| `transactionIndex` | Quantity, Integer | Index position of transaction in the block. |
| `revertReason` | String | ABI-encoded string that displays the [reason for reverting the transaction](../../../private-networks/how-to/send-transactions/revert-reason.md). Only available if revert reason is [enabled](../cli/options.md#revert-reason-enabled). |
| `output` | Data | RLP-encoded return value of a contract call if a value returns, otherwise, `null`. |
| `commitmentHash` | Data, 32 bytes | Hash of the privacy marker transaction. |
| `status` | Quantity | Either `0x1` (success) or `0x0` (failure). |
| `privateFrom` | Data, 32 bytes | [Tessera](https://docs.tessera.consensys.net/) public key of the sender. |
| `privateFor` or `privacyGroupId` | Array or Data, 32 bytes | [Tessera](https://docs.tessera.consensys.net/) public keys or privacy group ID of the recipients. |
| `logsBloom` | Data, 256 bytes | Bloom filter for light clients to quickly retrieve related logs. |
@ -97,7 +97,8 @@ across namespaces don't need to be.
!!! note
Namespace-based scoping is not applicable for cluster-wide objects (for example, StorageClass or PersistentVolumes).
Namespace-based scoping is not applicable for cluster-wide objects (for example, Storage Class
or Persistent Volumes).
### Nodes
@ -109,7 +110,7 @@ and member/RPC nodes. For Besu nodes, we only use CLI arguments to keep things c
We encourage using role-based access controls (RBACs) for access to the private key of each node, that is, only a specific pod or statefulset is
allowed to access a specific secret.
If you need to specify a Kube configuration file for each pod, use the KUBE_CONFIG_PATH variable.
If you need to specify a Kube configuration file for each pod, use the `KUBE_CONFIG_PATH` variable.
### Storage
@ -125,9 +126,9 @@ Select the appropriate type of [Storage Class](https://kubernetes.io/docs/concep
on your cloud provider. In the templates, the size of the [volume claims](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims)
is set to 20Gb by default; you can change this depending on your needs. If you have a different storage
account than the one in the charts, you may edit those
@ -21,26 +21,26 @@ Returned by [`eth_getBlockByHash`](index.md#eth_getblockbyhash) and
| Key | Type | Value |
|-----|:----:|-------|
| **number** | *Quantity*, Integer | Block number. `null` when block is pending. |
| **hash** | *Data*, 32 bytes | Hash of the block. `null` when block is pending. |
| **parentHash** | *Data*, 32 bytes | Hash of the parent block. |
| **nonce** | *Data*, 8 bytes | Hash of the generated proof of work. `null` when block is pending. |
| **sha3Uncles** | *Data*, 32 bytes | SHA3 of the uncle's data in the block. |
| **logsBloom** | *Data*, 256 bytes | Bloom filter for the block logs. `null` when block is pending. |
| **transactionsRoot** | *Data*, 32 bytes | Root of the transaction trie for the block. |
| **stateRoot** | Data, 32 bytes | Root of the final state trie for the block. |
| **receiptsRoot** | Data, 32 bytes | Root of the receipts trie for the block. |
| **miner** | Data, 20 bytes | Address to pay mining rewards to. |
| **difficulty** | Quantity, Integer | Difficulty for this block. |
| **totalDifficulty** | Quantity, Integer | Total difficulty of the chain until this block. |
| **extraData** | Data | Extra data field for this block. The first 32 bytes is vanity data you can set using the [`--miner-extra-data`](../cli/options.md#miner-extra-data) command line option. Stores extra data when used with [Clique](../../../private-networks/how-to/configure/consensus/clique.md#genesis-file) and [IBFT](../../../private-networks/how-to/configure/consensus/ibft.md#genesis-file). |
| **size** | Quantity, Integer | Size of block in bytes. |
| **gasLimit** | Quantity | Maximum gas allowed in this block. |
| **gasUsed** | Quantity | Total gas used by all transactions in this block. |
| **transactions** | Array | Array of [transaction objects](#transaction-object), or 32 byte transaction hashes depending on the specified boolean parameter. |
| **uncles** | Array | Array of uncle hashes. |
| **baseFeePerGas** | Quantity | The block's [base fee per gas](../../concepts/transactions/types.md#eip1559-transactions). This field is empty for blocks created before [EIP-1559](https://github.com/ethereum/EIPs/blob/2d8a95e14e56de27c5465d93747b0006bd8ac47f/EIPS/eip-1559.md). |
| `number` | *Quantity*, Integer | Block number. `null` when block is pending. |
| `hash` | *Data*, 32 bytes | Hash of the block. `null` when block is pending. |
| `parentHash` | *Data*, 32 bytes | Hash of the parent block. |
| `nonce` | *Data*, 8 bytes | Hash of the generated proof of work. `null` when block is pending. |
| `sha3Uncles` | *Data*, 32 bytes | SHA3 of the uncle's data in the block. |
| `logsBloom` | *Data*, 256 bytes | Bloom filter for the block logs. `null` when block is pending. |
| `transactionsRoot` | *Data*, 32 bytes | Root of the transaction trie for the block. |
| `stateRoot` | Data, 32 bytes | Root of the final state trie for the block. |
| `receiptsRoot` | Data, 32 bytes | Root of the receipts trie for the block. |
| `miner` | Data, 20 bytes | Address to pay mining rewards to. |
| `difficulty` | Quantity, Integer | Difficulty for this block. |
| `totalDifficulty` | Quantity, Integer | Total difficulty of the chain until this block. |
| `extraData` | Data | Extra data field for this block. The first 32 bytes is vanity data you can set using the [`--miner-extra-data`](../cli/options.md#miner-extra-data) command line option. Stores extra data when used with [Clique](../../../private-networks/how-to/configure/consensus/clique.md#genesis-file) and [IBFT](../../../private-networks/how-to/configure/consensus/ibft.md#genesis-file). |
| `size` | Quantity, Integer | Size of block in bytes. |
| `gasLimit` | Quantity | Maximum gas allowed in this block. |
| `gasUsed` | Quantity | Total gas used by all transactions in this block. |
| `transactions` | Array | Array of [transaction objects](#transaction-object), or 32 byte transaction hashes depending on the specified boolean parameter. |
| `uncles` | Array | Array of uncle hashes. |
| `baseFeePerGas` | Quantity | The block's [base fee per gas](../../concepts/transactions/types.md#eip1559-transactions). This field is empty for blocks created before [EIP-1559](https://github.com/ethereum/EIPs/blob/2d8a95e14e56de27c5465d93747b0006bd8ac47f/EIPS/eip-1559.md). |
## Fee history results object
@ -49,9 +49,9 @@ If blocks in the specified block range are not available, then only the fee hist
| Key | Type | Value |
|-----|:----:|-------|
| **oldestBlock** | Quantity, Integer | Lowest number block of the returned range. |
| **baseFeePerGas** | Array | Array of block base fees per gas, including an extra block value. The extra value is the next block after the newest block in the returned range. Returns zeroes for blocks created before [EIP-1559](https://github.com/ethereum/EIPs/blob/2d8a95e14e56de27c5465d93747b0006bd8ac47f/EIPS/eip-1559.md). |
| **gasUsedRatio** | Array | Array of block gas used ratios. These are calculated as the ratio of `gasUsed` and `gasLimit`. |
| `oldestBlock` | Quantity, Integer | Lowest number block of the returned range. |
| `baseFeePerGas` | Array | Array of block base fees per gas, including an extra block value. The extra value is the next block after the newest block in the returned range. Returns zeroes for blocks created before [EIP-1559](https://github.com/ethereum/EIPs/blob/2d8a95e14e56de27c5465d93747b0006bd8ac47f/EIPS/eip-1559.md). |
| `gasUsedRatio` | Array | Array of block gas used ratios. These are calculated as the ratio of `gasUsed` and `gasLimit`. |
## Filter options object
@ -61,17 +61,17 @@ Used to [`filter logs`](../../how-to/use-besu-api/access-logs.md).
| Key | Type | Required/Optional | Value |
|-----|:----:|:-----------------:|-------|
| **fromBlock** | Quantity | Tag | Optional | Integer block number or `latest`, `pending`, `earliest`. See [Block Parameter](../../how-to/use-besu-api/json-rpc.md#block-parameter). Default is `latest`. |
| **toBlock** | Quantity | Tag | Optional | Integer block number or `latest`, `pending`, `earliest`. See [Block Parameter](../../how-to/use-besu-api/json-rpc.md#block-parameter). Default is `latest`. |
| **address** | Data | Array | Optional | Contract address or array of addresses from which [logs](../../concepts/events-and-logs.md) originate. |
| **topics** | Array of Data, 32 bytes each | Optional | Array of topics by which to [filter logs](../../concepts/events-and-logs.md#topic-filters). |
| `fromBlock` | Quantity | Tag | Optional | Integer block number or `latest`, `pending`, `earliest`. See [Block Parameter](../../how-to/use-besu-api/json-rpc.md#block-parameter). Default is `latest`. |
| `toBlock` | Quantity | Tag | Optional | Integer block number or `latest`, `pending`, `earliest`. See [Block Parameter](../../how-to/use-besu-api/json-rpc.md#block-parameter). Default is `latest`. |
| `address` | Data | Array | Optional | Contract address or array of addresses from which [logs](../../concepts/events-and-logs.md) originate. |
| `topics` | Array of Data, 32 bytes each | Optional | Array of topics by which to [filter logs](../../concepts/events-and-logs.md#topic-filters). |
[`eth_getLogs`](index.md#eth_getlogs) and [`priv_getLogs`](index.md#priv_getlogs) have an
extra key.
| Key | Type | Required/Optional | Value |
|-----|:----:|:-----------------:|-------|
| **blockHash** | Data, 32 bytes | Optional. | Hash of block for which to return logs. If you specify `blockHash`, you cannot specify `fromBlock` and `toBlock`. |
| `blockHash` | Data, 32 bytes | Optional. | Hash of block for which to return logs. If you specify `blockHash`, you cannot specify `fromBlock` and `toBlock`. |
## Log object
@ -80,15 +80,15 @@ Returned by [`eth_getFilterChanges`](index.md#eth_getfilterchanges) and [`priv_g
| Key | Type | Value |
|-----|:----:|-------|
| **removed** | Tag | `true` if log removed because of a chain reorganization. `false` if a valid log. |
| **logIndex** | Quantity, Integer | Log index position in the block. `null` when log is pending. |
| **transactionIndex** | Quantity, Integer | Index position of the starting transaction for the log. `null` when log is pending. |
| **transactionHash** | Data, 32 bytes | Hash of the starting transaction for the log. `null` when log is pending. |
| **blockHash** | Data, 32 bytes | Hash of the block that includes the log. `null` when log is pending. |
| **blockNumber** | Quantity | Number of block that includes the log. `null` when log is pending. |
| **data** | Data | Non-indexed arguments of the log. |
| **topics** | Array of Data, 32 bytes each | [Event signature hash](../../concepts/events-and-logs.md#event-signature-hash) and 0 to 3 [indexed log arguments](../../concepts/events-and-logs.md#event-parameters). |
| `removed` | Tag | `true` if log removed because of a chain reorganization. `false` if a valid log. |
| `logIndex` | Quantity, Integer | Log index position in the block. `null` when log is pending. |
| `transactionIndex` | Quantity, Integer | Index position of the starting transaction for the log. `null` when log is pending. |
| `transactionHash` | Data, 32 bytes | Hash of the starting transaction for the log. `null` when log is pending. |
| `blockHash` | Data, 32 bytes | Hash of the block that includes the log. `null` when log is pending. |
| `blockNumber` | Quantity | Number of block that includes the log. `null` when log is pending. |
| `data` | Data | Non-indexed arguments of the log. |
| `topics` | Array of Data, 32 bytes each | [Event signature hash](../../concepts/events-and-logs.md#event-signature-hash) and 0 to 3 [indexed log arguments](../../concepts/events-and-logs.md#event-parameters). |
## Miner data object
@ -97,15 +97,15 @@ Returned by [`eth_getMinerDataByBlockHash`](index.md#eth_getminerdatabyblockhash
| Key | Type | Value |
|-----|:----:|-------|
| **netBlockReward** | Quantity, Integer | The net block reward, in Wei, is `staticBlockReward + transactionFee + uncleInclusionReward`. |
| **staticBlockReward** | Quantity, Integer | The static block reward, in Wei, is preset on a hard fork. |
| **transactionFee** | Quantity, Integer | The transaction fee, in Wei, is `sum of upfront cost - refund amount for all transactions`. |
| **uncleInclusionReward** | Quantity, Integer | The uncle inclusion reward, in Wei, is `static block reward * number of ommers/32`. |
| **uncleRewards** | Map | Map of uncle block hashes and uncle miner coinbase addresses. |
| **extraData** | Data | Extra data field for this block. The first 32 bytes is vanity data you can set using the [`--miner-extra-data`](../cli/options.md#miner-extra-data) command line option. |
| **difficulty** | Quantity, Integer | Difficulty of this block. |
| **totalDifficulty** | Quantity, Integer | Total difficulty of the chain until this block. |
| `netBlockReward` | Quantity, Integer | The net block reward, in Wei, is `staticBlockReward + transactionFee + uncleInclusionReward`. |
| `staticBlockReward` | Quantity, Integer | The static block reward, in Wei, is preset on a hard fork. |
| `transactionFee` | Quantity, Integer | The transaction fee, in Wei, is `sum of upfront cost - refund amount for all transactions`. |
| `uncleInclusionReward` | Quantity, Integer | The uncle inclusion reward, in Wei, is `static block reward * number of ommers/32`. |
| `uncleRewards` | Map | Map of uncle block hashes and uncle miner coinbase addresses. |
| `extraData` | Data | Extra data field for this block. The first 32 bytes is vanity data you can set using the [`--miner-extra-data`](../cli/options.md#miner-extra-data) command line option. |
| `difficulty` | Quantity, Integer | Difficulty of this block. |
| `totalDifficulty` | Quantity, Integer | Total difficulty of the chain until this block. |
## Pending transaction object
@ -113,21 +113,21 @@ Returned by [`txpool_besuPendingTransactions`](index.md#txpool_besupendingtransa
| Key | Type | Value |
|-----|:----:|-------|
| **accessList** | Array | (Optional) List of addresses and storage keys the transaction plans to access. Used in [`ACCESS_LIST` transactions](../../concepts/transactions/types.md#access_list-transactions) and may be used in [`EIP1559` transactions](../../concepts/transactions/types.md#eip1559-transactions). |
| **from** | Data, 20 bytes | Address of the sender. |
| **gas** | Quantity | Gas provided by the sender. |
| **gasPrice** | Quantity | (Optional) Gas price, in Wei, provided by the sender. Not used only in [`EIP1559` transactions](../../concepts/transactions/types.md#eip1559-transactions). |
| **maxPriorityFeePerGas** | Quantity, Integer | (Optional) Maximum fee, in Wei, the sender is willing to pay per gas above the base fee. Used only in [`EIP1559` transactions](../../concepts/transactions/types.md#eip1559-transactions). |
| **maxFeePerGas** | Quantity, Integer | (Optional) Maximum total fee (base fee + priority fee), in Wei, the sender is willing to pay per gas. Used only in [`EIP1559` transactions](../../concepts/transactions/types.md#eip1559-transactions). |
| **hash** | Data, 32 bytes | Hash of the transaction. |
| **input** | Data | Data sent with the transaction to create or invoke a contract. |
| **nonce** | Quantity | Number of transactions made by the sender before this one. |
| **to** | Data, 20 bytes | Address of the receiver. `null` if a contract creation transaction. |
| **value** | Quantity | Value transferred, in Wei. |
| **v** | Quantity | ECDSA Recovery ID. |
| **r** | Data, 32 bytes | ECDSA signature r. |
| **s** | Data, 32 bytes | ECDSA signature s. |
| `accessList` | Array | (Optional) List of addresses and storage keys the transaction plans to access. Used in [`ACCESS_LIST` transactions](../../concepts/transactions/types.md#access_list-transactions) and may be used in [`EIP1559` transactions](../../concepts/transactions/types.md#eip1559-transactions). |
| `from` | Data, 20 bytes | Address of the sender. |
| `gas` | Quantity | Gas provided by the sender. |
| `gasPrice` | Quantity | (Optional) Gas price, in Wei, provided by the sender. Not used only in [`EIP1559` transactions](../../concepts/transactions/types.md#eip1559-transactions). |
| `maxPriorityFeePerGas` | Quantity, Integer | (Optional) Maximum fee, in Wei, the sender is willing to pay per gas above the base fee. Used only in [`EIP1559` transactions](../../concepts/transactions/types.md#eip1559-transactions). |
| `maxFeePerGas` | Quantity, Integer | (Optional) Maximum total fee (base fee + priority fee), in Wei, the sender is willing to pay per gas. Used only in [`EIP1559` transactions](../../concepts/transactions/types.md#eip1559-transactions). |
| `hash` | Data, 32 bytes | Hash of the transaction. |
| `input` | Data | Data sent with the transaction to create or invoke a contract. |
| `nonce` | Quantity | Number of transactions made by the sender before this one. |
| `to` | Data, 20 bytes | Address of the receiver. `null` if a contract creation transaction. |
| `value` | Quantity | Value transferred, in Wei. |
| `v` | Quantity | ECDSA Recovery ID. |
| `r` | Data, 32 bytes | ECDSA signature r. |
| `s` | Data, 32 bytes | ECDSA signature s. |
## Range object
@ -135,8 +135,8 @@ Returned by [`debug_storageRangeAt`](index.md#debug_storagerangeat).
| Key | Type | Value |
|-----|:----:|-------|
| **storage** | Object | Key hash and value. Pre-image key is `null` if it falls outside the cache. |
| **nextKey** | Hash | Hash of next key if further storage in range. Otherwise, not included. |
| `storage` | Object | Key hash and value. Pre-image key is `null` if it falls outside the cache. |
| `nextKey` | Hash | Hash of next key if further storage in range. Otherwise, not included. |
### Structured log object
@ -144,15 +144,15 @@ Log information returned as part of the [Trace object](#trace-object).
| Key | Type | Value |
|-----|:----:|-------|
| **pc** | Integer | Current program counter. |
| **op** | String | Current OpCode. |
| **gas** | Integer | Gas remaining. |
| **gasCost** | Integer | Cost in wei of each gas unit. |
| **depth** | Integer | Execution depth. |
| **exceptionalHaltReasons** | Array | One or more strings representing an error condition causing the EVM execution to terminate. These strings suggest that EVM execution terminated for reasons such as running out of gas or attempting to execute an unknown instruction. Generally a single exceptional halt reason returns but it's possible for more than one to occur at once. |
| **stack** | Array of 32 byte arrays | EVM execution stack before executing current operation. |
| **memory** | Array of 32 byte arrays | Memory space of the contract before executing current operation. |
| **storage** | Object | Storage entries changed by the current transaction. |
| `pc` | Integer | Current program counter. |
| `op` | String | Current OpCode. |
| `gas` | Integer | Gas remaining. |
| `gasCost` | Integer | Cost in wei of each gas unit. |
| `depth` | Integer | Execution depth. |
| `exceptionalHaltReasons` | Array | One or more strings representing an error condition causing the EVM execution to terminate. These strings suggest that EVM execution terminated for reasons such as running out of gas or attempting to execute an unknown instruction. Generally a single exceptional halt reason returns but it's possible for more than one to occur at once. |
| `stack` | Array of 32 byte arrays | EVM execution stack before executing current operation. |
| `memory` | Array of 32 byte arrays | Memory space of the contract before executing current operation. |
| `storage` | Object | Storage entries changed by the current transaction. |
## Trace object
@ -163,10 +163,10 @@ Returned by [`debug_traceBlock`](index.md#debug_traceblock),
| Key | Type | Value |
|-----|:----:|-------|
| **gas** | Integer | Gas used by the transaction. |
@ -174,12 +174,12 @@ Parameter for [`trace_filter`](index.md#trace_filter). All parameters are option
| Key | Type | Value |
|-----|:----:|-------|
| **fromBLock** | String | Tag | Trace starts at this block. |
| **toBlock** | String | Tag | Trace stops at this block. |
| **fromAddress** | String | Include only traces sent from this address. |
| **toAddress** | String | Include only traces with this destination address. |
| **after** | Quantity | The offset trace number. |
| **count** | Integer | Number of traces to display in a batch. |
| `fromBLock` | String | Tag | Trace starts at this block. |
| `toBlock` | String | Tag | Trace stops at this block. |
| `fromAddress` | String | Include only traces sent from this address. |
| `toAddress` | String | Include only traces with this destination address. |
| `after` | Quantity | The offset trace number. |
| `count` | Integer | Number of traces to display in a batch. |
## Transaction object
@ -190,27 +190,27 @@ and
| Key | Type | Value |
|-----|:----:|-------|
| **accessList** | Array | (Optional) List of addresses and storage keys the transaction plans to access. Used in [`ACCESS_LIST` transactions](../../concepts/transactions/types.md#access_list-transactions) and may be used in [`EIP1559` transactions](../../concepts/transactions/types.md#eip1559-transactions). |
| **blockHash** | Data, 32 bytes | Hash of the block containing this transaction. `null` when transaction is pending. |
| **blockNumber** | Quantity | Block number of the block containing this transaction. `null` when transaction is pending. |
| **from** | Data, 20 bytes | Address of the sender. |
| **gas** | Quantity | Gas provided by the sender. |
| **gasPrice** | Quantity | (Optional) Gas price, in Wei, provided by the sender. Used only in non-[`EIP1559`](../../concepts/transactions/types.md#eip1559-transactions) transactions. |
| **maxPriorityFeePerGas** | Quantity, Integer | (Optional) Maximum fee, in Wei, the sender is willing to pay per gas above the base fee. Used only in [`EIP1559` transactions](../../concepts/transactions/types.md#eip1559-transactions). |
| **maxFeePerGas** | Quantity, Integer | (Optional) Maximum total fee (base fee + priority fee), in Wei, the sender is willing to pay per gas. Used only in [`EIP1559` transactions](../../concepts/transactions/types.md#eip1559-transactions). |
| **hash** | Data, 32 bytes | Hash of the transaction. |
| **input** | Data | Data sent with the transaction to create or invoke a contract. For [private transactions](../../../private-networks/concepts/privacy/index.md), it's a pointer to the transaction location in [Tessera](https://docs.tessera.consensys.net/). |
| **nonce** | Quantity | Number of transactions made by the sender before this one. |
| **publicKey** | Data, 64 bytes | Public key of the sender. |
| **raw** | Data | This signed transaction in Recursive Length Prefix (RLP) encoded form. |
| **to** | Data, 20 bytes | Address of the receiver. `null` if a contract creation transaction. |
| **transactionIndex** | Quantity, Integer | Index position of the transaction in the block. `null` when transaction is pending. |
| **value** | Quantity | Value transferred, in Wei. |
| **v** | Quantity | ECDSA Recovery ID. |
| **r** | Data, 32 bytes | ECDSA signature r. |
| **s** | Data, 32 bytes | ECDSA signature s. |
| `accessList` | Array | (Optional) List of addresses and storage keys the transaction plans to access. Used in [`ACCESS_LIST` transactions](../../concepts/transactions/types.md#access_list-transactions) and may be used in [`EIP1559` transactions](../../concepts/transactions/types.md#eip1559-transactions). |
| `blockHash` | Data, 32 bytes | Hash of the block containing this transaction. `null` when transaction is pending. |
| `blockNumber` | Quantity | Block number of the block containing this transaction. `null` when transaction is pending. |
| `from` | Data, 20 bytes | Address of the sender. |
| `gas` | Quantity | Gas provided by the sender. |
| `gasPrice` | Quantity | (Optional) Gas price, in Wei, provided by the sender. Used only in non-[`EIP1559`](../../concepts/transactions/types.md#eip1559-transactions) transactions. |
| `maxPriorityFeePerGas` | Quantity, Integer | (Optional) Maximum fee, in Wei, the sender is willing to pay per gas above the base fee. Used only in [`EIP1559` transactions](../../concepts/transactions/types.md#eip1559-transactions). |
| `maxFeePerGas` | Quantity, Integer | (Optional) Maximum total fee (base fee + priority fee), in Wei, the sender is willing to pay per gas. Used only in [`EIP1559` transactions](../../concepts/transactions/types.md#eip1559-transactions). |
| `hash` | Data, 32 bytes | Hash of the transaction. |
| `input` | Data | Data sent with the transaction to create or invoke a contract. For [private transactions](../../../private-networks/concepts/privacy/index.md), it's a pointer to the transaction location in [Tessera](https://docs.tessera.consensys.net/). |
| `nonce` | Quantity | Number of transactions made by the sender before this one. |
| `publicKey` | Data, 64 bytes | Public key of the sender. |
| `raw` | Data | This signed transaction in Recursive Length Prefix (RLP) encoded form. |
| `to` | Data, 20 bytes | Address of the receiver. `null` if a contract creation transaction. |
| `transactionIndex` | Quantity, Integer | Index position of the transaction in the block. `null` when transaction is pending. |
| `value` | Quantity | Value transferred, in Wei. |
| `v` | Quantity | ECDSA Recovery ID. |
| `r` | Data, 32 bytes | ECDSA signature r. |
| `s` | Data, 32 bytes | ECDSA signature s. |
## Transaction call object
@ -221,15 +221,15 @@ All transaction call object parameters are optional.
| Key | Type | Value |
|-----|:----:|-------|
| **from** | Data, 20 bytes | Address of the sender. |
| **to** | Data, 20 bytes | Address of the action receiver. |
| **gas** | Quantity, Integer | Gas provided by the sender. `eth_call` consumes zero gas, but other executions might need this parameter. `eth_estimateGas` ignores this value. |
| **gasPrice** | Quantity, Integer | Gas price, in Wei, provided by the sender. The default is `0`. Used only in non-[`EIP1559`](../../concepts/transactions/types.md#eip1559-transactions) transactions. |
| **maxPriorityFeePerGas** | Quantity, Integer | Maximum fee, in Wei, the sender is willing to pay per gas above the base fee. Can be used only in [`EIP1559` transactions](../../concepts/transactions/types.md#eip1559-transactions). If used, must specify `maxFeePerGas`. |
| **maxFeePerGas** | Quantity, Integer | Maximum total fee (base fee + priority fee), in Wei, the sender is willing to pay per gas. Can be used only in [`EIP1559` transactions](../../concepts/transactions/types.md#eip1559-transactions). If used, must specify `maxPriorityFeePerGas`. |
| **value** | Quantity, Integer | Value transferred, in Wei. |
| **data** | Data | Hash of the method signature and encoded parameters. For details, see [Ethereum Contract ABI](https://solidity.readthedocs.io/en/develop/abi-spec.html). |
| **strict** | Tag | If `true`, checks that the `from` account’s ether balance is sufficient to cover the transaction and gas fee. If `false`, the `gasPrice` and `baseFee` are set to zero, in order to simulate a transaction without enforcing a balance check. The default is `false`. |
| `from` | Data, 20 bytes | Address of the sender. |
| `to` | Data, 20 bytes | Address of the action receiver. |
| `gas` | Quantity, Integer | Gas provided by the sender. `eth_call` consumes zero gas, but other executions might need this parameter. `eth_estimateGas` ignores this value. |
| `gasPrice` | Quantity, Integer | Gas price, in Wei, provided by the sender. The default is `0`. Used only in non-[`EIP1559`](../../concepts/transactions/types.md#eip1559-transactions) transactions. |
| `maxPriorityFeePerGas` | Quantity, Integer | Maximum fee, in Wei, the sender is willing to pay per gas above the base fee. Can be used only in [`EIP1559` transactions](../../concepts/transactions/types.md#eip1559-transactions). If used, must specify `maxFeePerGas`. |
| `maxFeePerGas` | Quantity, Integer | Maximum total fee (base fee + priority fee), in Wei, the sender is willing to pay per gas. Can be used only in [`EIP1559` transactions](../../concepts/transactions/types.md#eip1559-transactions). If used, must specify `maxPriorityFeePerGas`. |
| `value` | Quantity, Integer | Value transferred, in Wei. |
| `data` | Data | Hash of the method signature and encoded parameters. For details, see [Ethereum Contract ABI](https://solidity.readthedocs.io/en/develop/abi-spec.html). |
| `strict` | Tag | If `true`, checks that the `from` account’s ether balance is sufficient to cover the transaction and gas fee. If `false`, the `gasPrice` and `baseFee` are set to zero, in order to simulate a transaction without enforcing a balance check. The default is `false`. |
## Transaction receipt object
@ -237,21 +237,21 @@ Returned by [`eth_getTransactionReceipt`](index.md#eth_gettransactionreceipt).
| Key | Type | Value |
|-----|:----:|-------|
| **blockHash** | Data, 32 bytes | Hash of block containing this transaction. |
| **blockNumber** | Quantity | Block number of block containing this transaction. |
| **contractAddress** | Data, 20 bytes | Contract address created, if contract creation transaction, otherwise, `null`. A failed contract creation transaction still produces a contract address value. |
| **cumulativeGasUsed** | Quantity | Total amount of gas used by previous transactions in the block and this transaction. |
| **effectiveGasPrice** | Quantity | The [actual value per gas deducted](../../concepts/transactions/types.md#eip1559-transactions) from the sender's account. |
| **from** | Data, 20 bytes | Address of the sender. |
| **gasUsed** | Quantity | Amount of gas used by this specific transaction. |
| **logs** | Array | Array of [log objects](#log-object) generated by this transaction. |
| **logsBloom** | Data, 256 bytes | Bloom filter for light clients to quickly retrieve related logs. |
| **status** | Quantity | Either `0x0` (failure), `0x1` (success), or `0x2` (invalid). |
| **to** | Data, 20 bytes | Address of the receiver, if sending ether, otherwise, null. |
| **transactionHash** | Data, 32 bytes | Hash of the transaction. |
| **transactionIndex** | Quantity, Integer | Index position of transaction in the block. |
| **revertReason** | String | ABI-encoded string that displays the [reason for reverting the transaction](../../../private-networks/how-to/send-transactions/revert-reason.md). Only available if revert reason is [enabled](../cli/options.md#revert-reason-enabled). |
| `blockHash` | Data, 32 bytes | Hash of block containing this transaction. |
| `blockNumber` | Quantity | Block number of block containing this transaction. |
| `contractAddress` | Data, 20 bytes | Contract address created, if contract creation transaction, otherwise, `null`. A failed contract creation transaction still produces a contract address value. |
| `cumulativeGasUsed` | Quantity | Total amount of gas used by previous transactions in the block and this transaction. |
| `effectiveGasPrice` | Quantity | The [actual value per gas deducted](../../concepts/transactions/types.md#eip1559-transactions) from the sender's account. |
| `from` | Data, 20 bytes | Address of the sender. |
| `gasUsed` | Quantity | Amount of gas used by this specific transaction. |
| `logs` | Array | Array of [log objects](#log-object) generated by this transaction. |
| `logsBloom` | Data, 256 bytes | Bloom filter for light clients to quickly retrieve related logs. |
| `status` | Quantity | Either `0x0` (failure), `0x1` (success), or `0x2` (invalid). |
| `to` | Data, 20 bytes | Address of the receiver, if sending ether, otherwise, null. |
| `transactionHash` | Data, 32 bytes | Hash of the transaction. |
| `transactionIndex` | Quantity, Integer | Index position of transaction in the block. |
| `revertReason` | String | ABI-encoded string that displays the [reason for reverting the transaction](../../../private-networks/how-to/send-transactions/revert-reason.md). Only available if revert reason is [enabled](../cli/options.md#revert-reason-enabled). |
!!!note
@ -260,7 +260,7 @@ Returned by [`eth_getTransactionReceipt`](index.md#eth_gettransactionreceipt).
| Key | Type | Value |
|-----|:----:|-------|
| **root** | Data, 32 bytes | Post-transaction state root |
| `root` | Data, 32 bytes | Post-transaction state root |
## Transaction trace object
@ -268,8 +268,8 @@ Returned by [`trace_replayBlockTransactions`](index.md#trace_replayblocktransact
| Key | Type | Value |
|-----|:----:|-------|
| **output** | Boolean | Transaction result. 1 for success and 0 for failure. |
| **stateDiff** | Object | [State changes in the requested block](../trace-types.md#statediff). |
| **trace** | Array | [Ordered list of calls to other contracts](../trace-types.md#trace). |
| **vmTrace** | Object | [Ordered list of EVM actions](../trace-types.md#vmtrace). |
| **transactionHash** | Data, 32 bytes | Hash of the replayed transaction. |
| `output` | Boolean | Transaction result. 1 for success and 0 for failure. |
| `stateDiff` | Object | [State changes in the requested block](../trace-types.md#statediff). |
| `trace` | Array | [Ordered list of calls to other contracts](../trace-types.md#trace). |
| `vmTrace` | Object | [Ordered list of EVM actions](../trace-types.md#vmtrace). |
| `transactionHash` | Data, 32 bytes | Hash of the replayed transaction. |
Gabriel-Trintinalia
2 years ago
committed by
GitHub