Skip to content

Commit

Permalink
Updated public API methods containing blockNumber (#1402)
Browse files Browse the repository at this point in the history 
* Updated public API methods containing blockNumber

Signed-off-by: Mike Sanko <mike.sanko@consensys.net>

* Updated API methods containing blockNumber w/additional edits

Signed-off-by: Mike Sanko <mike.sanko@consensys.net>

* Updated API methods containing blockNumber w/correct quantity types

Signed-off-by: Mike Sanko <mike.sanko@consensys.net>

* Changed 'decimal' to 'decimal integer' for API methods containing `blockNumber`

Signed-off-by: Mike Sanko <mike.sanko@consensys.net>

* Files were changed for Docusaurus upgrade

Signed-off-by: Mike Sanko <mike.sanko@consensys.net>

* Apply suggestions from code review

Co-authored-by: Alexandra Tran Carrillo <12214231+alexandratran@users.noreply.github.com>
Signed-off-by: Mike Sanko <mike.sanko@consensys.net>

---------

Signed-off-by: Mike Sanko <mike.sanko@consensys.net>
Co-authored-by: Alexandra Tran Carrillo <12214231+alexandratran@users.noreply.github.com>
  • Loading branch information
@mjsmike62 @alexandratran
mjsmike62 and alexandratran authored Sep 25, 2023
1 parent 26a8cbd commit d681f15
Show file tree
Hide file tree
Showing 4 changed files with 394 additions and 178 deletions.
24 changes: 12 additions & 12 deletions docs/private-networks/reference/api/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ Lists [signers for the specified block].

#### Parameters

`blockNumber`: _string_ - integer representing a block number or one of the string tags `latest`, `earliest`, or `pending`, as described in [Block Parameter](../../../public-networks/how-to/use-besu-api/json-rpc.md#block-parameter)
`blockNumber`: _string_ - hexadecimal or decimal integer representing a block number or one of the string tags `latest`, `earliest`, `pending`, `finalized`, or `safe`, as described in [block parameter](../../../public-networks/how-to/use-besu-api/json-rpc.md#block-parameter)

#### Returns

Expand Down Expand Up @@ -111,9 +111,9 @@ Provides the following validator metrics for the specified range:

#### Parameters

- `fromBlockNumber`: _string_ - integer representing a block number or the string tag `earliest`, as described in [Block Parameter](../../../public-networks/how-to/use-besu-api/json-rpc.md#block-parameter)
- `fromBlockNumber`: _string_ - hexadecimal or decimal integer representing a block number or the string tags `latest`, `earliest`, `pending`, `finalized`, or `safe`, as described in [block parameter](../../../public-networks/how-to/use-besu-api/json-rpc.md#block-parameter)

- `toBlockNumber`: _string_ - integer representing a block number or one of the string tags `latest` or `pending`, as described in [Block Parameter](../../../public-networks/how-to/use-besu-api/json-rpc.md#block-parameter)
- `toBlockNumber`: _string_ - hexadecimal or decimal integer representing a block number or one of the string tags `latest`, `earliest`, `pending`, `finalized`, or `safe`, as described in [block parameter](../../../public-networks/how-to/use-besu-api/json-rpc.md#block-parameter)

If you specify:

Expand Down Expand Up @@ -469,9 +469,9 @@ Provides the following validator metrics for the specified range:

#### Parameters

- `fromBlockNumber`: _string_ - integer representing a block number or the string tag `earliest` as described in [Block Parameter](../../../public-networks/how-to/use-besu-api/json-rpc.md#block-parameter)
- `fromBlockNumber`: _string_ - hexadecimal or decimal integer representing a block number or the string tags `latest`, `earliest`, `pending`, `finalized`, or `safe`, as described in [block parameter](../../../public-networks/how-to/use-besu-api/json-rpc.md#block-parameter)

- `toBlockNumber`: _string_ - integer representing a block number or one of the string tags `latest` or `pending`, as described in [Block Parameter](../../../public-networks/how-to/use-besu-api/json-rpc.md#block-parameter)
- `toBlockNumber`: _string_ - hexadecimal or decimal integer representing a block number or one of the string tags `latest`, `earliest`, `pending`, `finalized`, or `safe`, as described in [block parameter](../../../public-networks/how-to/use-besu-api/json-rpc.md#block-parameter)

If you specify:

Expand Down Expand Up @@ -579,7 +579,7 @@ Lists the validators defined in the specified block.

#### Parameters

- `blockNumber`: _string_ - integer representing a block number or one of the string tags `latest`, `earliest`, or `pending`, as described in [Block Parameter](../../../public-networks/how-to/use-besu-api/json-rpc.md#block-parameter)
- `blockNumber`: _string_ - hexadecimal or decimal integer representing a block number or one of the string tags `latest`, `earliest`, `pending`, `finalized`, or `safe`, as described in [block parameter](../../../public-networks/how-to/use-besu-api/json-rpc.md#block-parameter)

#### Returns

Expand Down Expand Up @@ -991,7 +991,7 @@ For private contracts, `priv_call` is the same as [`eth_call`](../../../public-n

- `call`: _object_ - [transaction call object](../../../public-networks/reference/api/objects.md#transaction-call-object)

- `blockNumber`: _string_ - integer representing a block number or one of the string tags `latest`, `earliest`, or `pending`, as described in [Block Parameter](../../../public-networks/how-to/use-besu-api/json-rpc.md#block-parameter)
- `blockNumber`: _string_ - hexadecimal or decimal integer representing a block number or one of the string tags `latest`, `earliest`, `pending`, `finalized`, or `safe`, as described in [block parameter](../../../public-networks/how-to/use-besu-api/json-rpc.md#block-parameter)

#### Returns

Expand Down Expand Up @@ -1111,7 +1111,7 @@ Returns the state root of the specified privacy group at the specified block.

- `privacyGroupId`: _string_ - 32-byte [privacy Group ID](../../concepts/privacy/privacy-groups.md)

- `blockNumber`: _string_ - integer representing a block number or one of the string tags `latest`, `earliest`, or `pending`, as described in [Block Parameter](../../../public-networks/how-to/use-besu-api/json-rpc.md#block-parameter)
- `blockNumber`: _string_ - hexadecimal or decimal integer representing a block number or one of the string tags `latest`, `earliest`, `pending`, `finalized`, or `safe`, as described in [block parameter](../../../public-networks/how-to/use-besu-api/json-rpc.md#block-parameter)

#### Returns

Expand Down Expand Up @@ -1288,7 +1288,7 @@ Returns the code of the private smart contract at the specified address. Compile

- `address`: _string_ - 20-byte contract address

- `blockNumber`: _string_ - integer representing a block number or one of the string tags `latest`, `earliest`, or `pending`, as described in [Block Parameter](../../../public-networks/how-to/use-besu-api/json-rpc.md#block-parameter)
- `blockNumber`: _string_ - hexadecimal or decimal integer representing a block number or one of the string tags `latest`, `earliest`, `pending`, `finalized`, or `safe`, as described in [block parameter](../../../public-networks/how-to/use-besu-api/json-rpc.md#block-parameter)

#### Returns

Expand Down Expand Up @@ -1960,9 +1960,9 @@ Provides the following validator metrics for the specified range:
#### Parameters
- `fromBlockNumber`: _string_ - integer representing a block number or the string tag `earliest` as described in [Block Parameter](../../../public-networks/how-to/use-besu-api/json-rpc.md#block-parameter)
- `fromBlockNumber`: _string_ - hexadecimal or decimal integer representing a block number or the string tags `latest`, `earliest`, `pending`, `finalized`, or `safe`, as described in [block parameter](../../../public-networks/how-to/use-besu-api/json-rpc.md#block-parameter)
- `toBlockNumber`: _string_ - integer representing a block number or one of the string tags `latest` or `pending`, as described in [Block Parameter](../../../public-networks/how-to/use-besu-api/json-rpc.md#block-parameter)
- `toBlockNumber`: _string_ - hexadecimal or decimal integer representing a block number or one of the string tags `latest`, `earliest`, `pending`, `finalized`, or `safe`, as described in [block parameter](../../../public-networks/how-to/use-besu-api/json-rpc.md#block-parameter)
If you specify:
Expand Down Expand Up @@ -2070,7 +2070,7 @@ Lists the validators defined in the specified block.
#### Parameters
- `blockNumber`: _string_ - integer representing a block number or one of the string tags `latest`, `earliest`, or `pending`, as described in [Block Parameter](../../../public-networks/how-to/use-besu-api/json-rpc.md#block-parameter)
- `blockNumber`: _string_ - hexadecimal or decimal integer representing a block number or one of the string tags `latest`, `earliest`, `pending`, `finalized`, or `safe`, as described in [block parameter](../../../public-networks/how-to/use-besu-api/json-rpc.md#block-parameter)
#### Returns
Expand Down
Loading

0 comments on commit d681f15

Please sign in to comment.