From 6650132a1aedf12906f0e3795318a2b30d5a7e60 Mon Sep 17 00:00:00 2001 From: m4sterbunny Date: Wed, 25 Sep 2024 18:41:48 +0100 Subject: [PATCH 1/4] proposes alt definition blockNumber Signed-off-by: m4sterbunny --- docs/public-networks/reference/api/index.md | 54 ++++++++++----------- 1 file changed, 27 insertions(+), 27 deletions(-) diff --git a/docs/public-networks/reference/api/index.md b/docs/public-networks/reference/api/index.md index f0f62a876d0..96aa8c18977 100644 --- a/docs/public-networks/reference/api/index.md +++ b/docs/public-networks/reference/api/index.md @@ -996,7 +996,7 @@ Returns the [RLP encoding](https://ethereum.org/en/developers/docs/data-structur #### Parameters -`blockNumber`: _string_ - hexadecimal or decimal integer representing a block number, or one of the +`blockNumber`: _string_ - hexadecimal of the decimal integer representing a block number, or one of the string tags `latest`, `earliest`, `pending`, `finalized`, or `safe`, as described in [block parameter](../../how-to/use-besu-api/json-rpc.md#block-parameter) @@ -1046,7 +1046,7 @@ Returns the [RLP encoding](https://ethereum.org/en/developers/docs/data-structur #### Parameters -`blockNumber`: _string_ - hexadecimal or decimal integer representing a block number, or one of the +`blockNumber`: _string_ - hexadecimal of the decimal integer representing a block number, or one of the string tags `latest`, `earliest`, `pending`, `finalized`, or `safe`, as described in [block parameter](../../how-to/use-besu-api/json-rpc.md#block-parameter) @@ -1102,7 +1102,7 @@ of the transaction receipts of the specified block. #### Parameters -`blockNumber`: _string_ - hexadecimal or decimal integer representing a block number, or one of the +`blockNumber`: _string_ - hexadecimal of the decimal integer representing a block number, or one of the string tags `latest`, `earliest`, `pending`, `finalized`, or `safe`, as described in [block parameter](../../how-to/use-besu-api/json-rpc.md#block-parameter) @@ -1345,7 +1345,7 @@ Re-imports the block matching the specified block number, by rolling the head of #### Parameters -`blockNumber`: _string_ - hexadecimal or decimal integer representing a block number, or one of the +`blockNumber`: _string_ - hexadecimal of the decimal integer representing a block number, or one of the string tags `latest`, `earliest`, `pending`, `finalized`, or `safe`, as described in [block parameter](../../how-to/use-besu-api/json-rpc.md#block-parameter) @@ -1439,7 +1439,7 @@ Sets the current head of the local chain to the block matching the specified blo #### Parameters -`blockNumber`: _string_ - hexadecimal or decimal integer representing a block number, or one of the +`blockNumber`: _string_ - hexadecimal of the decimal integer representing a block number, or one of the string tags `latest`, `earliest`, `pending`, `finalized`, or `safe`, as described in [block parameter](../../how-to/use-besu-api/json-rpc.md#block-parameter) @@ -1914,7 +1914,7 @@ Returns full trace of all invoked opcodes of all transactions included in the bl #### Parameters -- `blockNumber`: _string_ - hexadecimal or decimal integer representing a block number, or one of the +- `blockNumber`: _string_ - hexadecimal of the decimal integer representing a block number, or one of the string tags `latest`, `earliest`, `pending`, `finalized`, or `safe`, as described in [block parameter](../../how-to/use-besu-api/json-rpc.md#block-parameter) @@ -1997,7 +1997,7 @@ Performs an [`eth_call`](#eth_call) within the execution environment of a given - `call`: _object_ - [transaction call object](objects.md#transaction-call-object) -- `blockNumber`: _string_ - hexadecimal or decimal integer representing a block number, or one of the +- `blockNumber`: _string_ - hexadecimal of the decimal integer representing a block number, or one of the string tags `latest`, `earliest`, `pending`, `finalized`, or `safe`, as described in [block parameter](../../how-to/use-besu-api/json-rpc.md#block-parameter) @@ -2287,7 +2287,7 @@ By default, the `eth_call` error response includes the [revert reason](../../../ ::: -- `blockNumber` or `blockHash`: _string_ - hexadecimal or decimal integer representing a block number, +- `blockNumber` or `blockHash`: _string_ - hexadecimal of the decimal integer representing a block number, block hash, or one of the string tags `latest`, `earliest`, `pending`, `finalized`, or `safe`, as described in [block parameter](../../how-to/use-besu-api/json-rpc.md#block-parameter) @@ -2513,7 +2513,7 @@ Creates an [EIP-2930](https://eips.ethereum.org/EIPS/eip-2930) access list that - `transaction`: _object_ - [transaction call object](objects.md#transaction-call-object) -- `blockNumber`: _string_ - hexadecimal or decimal integer representing a block number, or one of +- `blockNumber`: _string_ - hexadecimal of the decimal integer representing a block number, or one of the string tags `latest`, `earliest`, `pending`, `finalized`, or `safe`, as described in [block parameter](../../how-to/use-besu-api/json-rpc.md#block-parameter). @@ -2915,7 +2915,7 @@ Returns the account balance of the specified address. - `address`: _string_ - 20-byte account address from which to retrieve the balance -- `blockNumber` or `blockHash`: _string_ - hexadecimal or decimal integer representing a block +- `blockNumber` or `blockHash`: _string_ - hexadecimal of the decimal integer representing a block number, block hash, or one of the string tags `latest`, `earliest`, `pending`, `finalized`, or `safe`, as described in [block parameter](../../how-to/use-besu-api/json-rpc.md#block-parameter) @@ -3154,7 +3154,7 @@ Returns information about the block matching the specified block number. #### Parameters -- `blockNumber`: _string_ - hexadecimal or decimal integer representing a block number, or one of +- `blockNumber`: _string_ - hexadecimal of the decimal integer representing a block number, or one of the string tags `latest`, `earliest`, `pending`, `finalized`, or `safe`, as described in [block parameter](../../how-to/use-besu-api/json-rpc.md#block-parameter). @@ -3329,7 +3329,7 @@ gas used and any event logs that might have been produced by a smart contract du #### Parameters -`blockNumber`: _string_ - hexadecimal or decimal integer representing a block number, or one of +`blockNumber`: _string_ - hexadecimal of the decimal integer representing a block number, or one of the string tags `latest`, `earliest`, `pending`, `finalized`, or `safe`, as described in [block parameter](../../how-to/use-besu-api/json-rpc.md#block-parameter). @@ -3529,7 +3529,7 @@ Returns the number of transactions in the block matching the specified block has #### Returns -`result`: _number_ - integer representing the number of transactions in the specified block, or `null` if no matching block hash is found +`result`: _number_ - integer representing the number of transactions in the specified block, or `null` if no matching block hash is found. @@ -3610,7 +3610,7 @@ Returns the number of transactions in a block matching the specified block numbe #### Parameters -`blockNumber`: _string_ - hexadecimal or decimal integer representing a block number, or one of +`blockNumber`: _string_ - hexadecimal of the digital integer representing a block number, or one of the string tags `latest`, `earliest`, `pending`, `finalized`, or `safe`, as described in [block parameter](../../how-to/use-besu-api/json-rpc.md#block-parameter). @@ -3701,7 +3701,7 @@ Returns the code of the smart contract at the specified address. Besu stores com - `address`: _string_ - 20-byte contract address -- `blockNumber` or `blockHash`: _string_ - hexadecimal or decimal integer representing a block number, +- `blockNumber` or `blockHash`: _string_ - hexadecimal of the digital integer representing a block number, block hash, or one of the string tags `latest`, `earliest`, `pending`, `finalized`, or `safe`, as described in [block parameter](../../how-to/use-besu-api/json-rpc.md#block-parameter) @@ -4207,7 +4207,7 @@ Returns miner data for the specified block. #### Parameters -`blockNumber`: _string_ - hexadecimal or decimal integer representing a block number, or one of +`blockNumber`: _string_ - hexadecimal of the digital integer representing a block number, or one of the string tags `latest`, `earliest`, `pending`, `finalized`, or `safe`, as described in [block parameter](../../how-to/use-besu-api/json-rpc.md#block-parameter). @@ -4283,7 +4283,7 @@ The API allows IoT devices or mobile apps which are unable to run light clients - `keys`: _array_ of _strings_ - list of 32-byte storage keys to generate proofs for -- `blockNumber` or `blockHash`: _string_ - hexadecimal or decimal integer representing a block +- `blockNumber` or `blockHash`: _string_ - hexadecimal of the digital integer representing a block number, block hash, or one of the string tags `latest`, `earliest`, `pending`, `finalized`, or `safe`, as described in [block parameter](../../how-to/use-besu-api/json-rpc.md#block-parameter) @@ -4388,7 +4388,7 @@ Returns the value of a storage position at a specified address. - `index`: _string_ - integer index of the storage position -- `blockNumber` or `blockHash`: _string_ - hexadecimal or decimal integer representing a block +- `blockNumber` or `blockHash`: _string_ - hexadecimal of the digital integer representing a block number, block hash, or one of the string tags `latest`, `earliest`, `pending`, `finalized`, or `safe`, as described in [block parameter](../../how-to/use-besu-api/json-rpc.md#block-parameter) @@ -4593,7 +4593,7 @@ Returns transaction information for the specified block number and transaction i #### Parameters -- `blockNumber`: _string_ - hexadecimal or decimal integer representing a block number, or one of +- `blockNumber`: _string_ - hexadecimal of the digital integer representing a block number, or one of the string tags `latest`, `earliest`, `pending`, `finalized`, or `safe`, as described in [block parameter](../../how-to/use-besu-api/json-rpc.md#block-parameter) @@ -4843,7 +4843,7 @@ Returns the number of transactions sent from a specified address. Use the `pendi - `address`: _string_ - 20-byte account address -- `blockNumber` or `blockHash`: _string_ - hexadecimal or decimal integer representing a block number, block hash, or one of the string tags `latest`, `earliest`, `pending`, `finalized`, or `safe`, as described in [block parameter](../../how-to/use-besu-api/json-rpc.md#block-parameter) +- `blockNumber` or `blockHash`: _string_ - hexadecimal of the digital integer representing a block number, block hash, or one of the string tags `latest`, `earliest`, `pending`, `finalized`, or `safe`, as described in [block parameter](../../how-to/use-besu-api/json-rpc.md#block-parameter) #### Returns @@ -5206,7 +5206,7 @@ Returns uncle specified by block number and index. #### Parameters -- `blockNumber`: _string_ - hexadecimal or decimal integer representing a block number, or one of +- `blockNumber`: _string_ - hexadecimal of the decimal integer representing a block number, or one of the string tags `latest`, `earliest`, `pending`, `finalized`, or `safe`, as described in [block parameter](../../how-to/use-besu-api/json-rpc.md#block-parameter) @@ -5423,7 +5423,7 @@ Returns the number of uncles in a block matching the specified block number. #### Parameters -`blockNumber`: _string_ - hexadecimal or decimal integer representing a block number, or one of +`blockNumber`: _string_ - hexadecimal of the digital integer representing a block number, or one of the string tags `latest`, `earliest`, `pending`, `finalized`, or `safe`, as described in [block parameter](../../how-to/use-besu-api/json-rpc.md#block-parameter) @@ -5524,7 +5524,7 @@ None - `target`: _string_ - 32-byte required target boundary condition: 2^256 / difficulty -- `blockNumber`: _string_ - hexadecimal integer representing the current block number +- `blockNumber`: _string_ - hexadecimal of the digital integer representing the current block number @@ -7139,7 +7139,7 @@ the requested block must be within the number of #### Parameters -`blockNumber`: _string_ - hexadecimal or decimal integer representing a block number, or one of +`blockNumber`: _string_ - hexadecimal of the decimal integer representing a block number, or one of the string tags `latest`, `earliest`, `pending`, `finalized`, or `safe`, as described in [block parameter](../../how-to/use-besu-api/json-rpc.md#block-parameter) @@ -7249,7 +7249,7 @@ default, 512 from the head of the chain). - `call`: _object_ - [transaction call object](objects.md#transaction-call-object) -- `blockNumber`: _string_ - hexadecimal or decimal integer representing a block number, or one of +- `blockNumber`: _string_ - hexadecimal of the decimal integer representing a block number, or one of the string tags `latest`, `earliest`, `pending`, `finalized`, or `safe`, as described in [block parameter](../../how-to/use-besu-api/json-rpc.md#block-parameter) @@ -7347,7 +7347,7 @@ default, 512 from the head of the chain). - `options`: _array_ of _strings_ - list of tracing options; tracing options are [`trace`, `vmTrace`, and `stateDiff`](../trace-types.md). Specify any combination of the three options including none of them. -- `blockNumber`: _string_ - hexadecimal or decimal integer representing a block number, or one of +- `blockNumber`: _string_ - hexadecimal of the decimal integer representing a block number, or one of the string tags `latest`, `earliest`, `pending`, `finalized`, or `safe`, as described in [block parameter](../../how-to/use-besu-api/json-rpc.md#block-parameter) @@ -7705,7 +7705,7 @@ default, 512 from the head of the chain). #### Parameters -- `blockNumber`: _string_ - hexadecimal or decimal integer representing a block number, or one of +- `blockNumber`: _string_ - hexadecimal of the decimal integer representing a block number, or one of the string tags `latest`, `earliest`, `pending`, `finalized`, or `safe`, as described in [block parameter](../../how-to/use-besu-api/json-rpc.md#block-parameter) From ff9a9504451b6b4b067f651d83d68f6bbc1a7b60 Mon Sep 17 00:00:00 2001 From: m4sterbunny Date: Thu, 26 Sep 2024 13:09:01 +0100 Subject: [PATCH 2/4] adds block hash to supporting methods Signed-off-by: m4sterbunny --- docs/public-networks/reference/api/index.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/public-networks/reference/api/index.md b/docs/public-networks/reference/api/index.md index 96aa8c18977..5dea29f26f2 100644 --- a/docs/public-networks/reference/api/index.md +++ b/docs/public-networks/reference/api/index.md @@ -3329,8 +3329,7 @@ gas used and any event logs that might have been produced by a smart contract du #### Parameters -`blockNumber`: _string_ - hexadecimal of the decimal integer representing a block number, or one of -the string tags `latest`, `earliest`, `pending`, `finalized`, or `safe`, as described in +`blockNumber` or `blockHash`:: _string_ - hexadecimal of the decimal integer representing a block number, block hash, or one of the string tags `latest`, `earliest`, `pending`, `finalized`, or `safe`, as described in [block parameter](../../how-to/use-besu-api/json-rpc.md#block-parameter). :::note From e6f2f9e92c8aaa5744b4e936155787e48fe3a2b0 Mon Sep 17 00:00:00 2001 From: m4sterbunny Date: Fri, 27 Sep 2024 12:42:44 +0100 Subject: [PATCH 3/4] nitpick adjustments per testing Signed-off-by: m4sterbunny --- docs/public-networks/reference/api/index.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/public-networks/reference/api/index.md b/docs/public-networks/reference/api/index.md index 5dea29f26f2..86ee3dab046 100644 --- a/docs/public-networks/reference/api/index.md +++ b/docs/public-networks/reference/api/index.md @@ -2732,7 +2732,7 @@ As of [EIP-4844](https://eips.ethereum.org/EIPS/eip-4844), this method tracks tr `pending` returns the same value as `latest`. ::: -- `array` of `integers` - (optional) A monotonically increasing list of percentile values to sample from each block's effective priority fees per gas in ascending order, weighted by gas used. +- `array` of `integers` - (required) A monotonically increasing list of percentile values to sample from each block's effective priority fees per gas in ascending order, weighted by gas used. Pass empty array for null. #### Returns @@ -4385,7 +4385,7 @@ Returns the value of a storage position at a specified address. - `address`: _string_ - 20-byte storage address -- `index`: _string_ - integer index of the storage position +- `index`: _string_ - hexadecimal or digital integer index of the storage position - `blockNumber` or `blockHash`: _string_ - hexadecimal of the digital integer representing a block number, block hash, or one of the string tags `latest`, `earliest`, `pending`, `finalized`, or @@ -4842,11 +4842,11 @@ Returns the number of transactions sent from a specified address. Use the `pendi - `address`: _string_ - 20-byte account address -- `blockNumber` or `blockHash`: _string_ - hexadecimal of the digital integer representing a block number, block hash, or one of the string tags `latest`, `earliest`, `pending`, `finalized`, or `safe`, as described in [block parameter](../../how-to/use-besu-api/json-rpc.md#block-parameter) +- `blockNumber` or `blockHash`: _string_ - hexadecimal of the decimal integer representing a block number, block hash, or one of the string tags `latest`, `earliest`, `pending`, `finalized`, or `safe`, as described in [block parameter](../../how-to/use-besu-api/json-rpc.md#block-parameter) #### Returns -`result`: _string_ - integer representing the number of transactions sent from the specified address +`result`: _string_ - hexadecimal of the decimal integer representing the number of transactions sent from the specified address From ce7ab95039ce9922db59e4643842d1fdbf2571f6 Mon Sep 17 00:00:00 2001 From: m4sterbunny Date: Fri, 27 Sep 2024 12:43:33 +0100 Subject: [PATCH 4/4] nitpick adjustments per testing Signed-off-by: m4sterbunny --- docs/public-networks/reference/api/objects.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/public-networks/reference/api/objects.md b/docs/public-networks/reference/api/objects.md index e9c8d9c78b3..677e7009552 100644 --- a/docs/public-networks/reference/api/objects.md +++ b/docs/public-networks/reference/api/objects.md @@ -49,7 +49,7 @@ Returned by [`eth_feeHistory`](index.md#eth_feehistory) for the requested block | Key | Type | Value | | --- | :-: | --- | -| `oldestBlock` | Quantity, Integer | Lowest number block of the returned range. | +| `oldestBlock` | Quantity, String | Hexadecimal of the integer of the 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). | | `baseFeePerBlobGas` | Array | Array of base fees per blob gas. Returns zeroes for blocks created before [EIP-4844](https://eips.ethereum.org/EIPS/eip-4844). | | `gasUsedRatio` | Array | Array of block gas used ratios. These are calculated as the ratio of `gasUsed` and `gasLimit`. |