Skip to content

Commit d681f15

Browse files
Updated public API methods containing blockNumber (#1402)
* Updated public API methods containing blockNumber Signed-off-by: Mike Sanko <[email protected]> * Updated API methods containing blockNumber w/additional edits Signed-off-by: Mike Sanko <[email protected]> * Updated API methods containing blockNumber w/correct quantity types Signed-off-by: Mike Sanko <[email protected]> * Changed 'decimal' to 'decimal integer' for API methods containing `blockNumber` Signed-off-by: Mike Sanko <[email protected]> * Files were changed for Docusaurus upgrade Signed-off-by: Mike Sanko <[email protected]> * Apply suggestions from code review Co-authored-by: Alexandra Tran Carrillo <[email protected]> Signed-off-by: Mike Sanko <[email protected]> --------- Signed-off-by: Mike Sanko <[email protected]> Co-authored-by: Alexandra Tran Carrillo <[email protected]>
1 parent 26a8cbd commit d681f15

File tree

4 files changed

+394
-178
lines changed

4 files changed

+394
-178
lines changed

docs/private-networks/reference/api/index.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ Lists [signers for the specified block].
6767

6868
#### Parameters
6969

70-
`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)
70+
`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)
7171

7272
#### Returns
7373

@@ -111,9 +111,9 @@ Provides the following validator metrics for the specified range:
111111

112112
#### Parameters
113113

114-
- `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)
114+
- `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)
115115

116-
- `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)
116+
- `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)
117117

118118
If you specify:
119119

@@ -469,9 +469,9 @@ Provides the following validator metrics for the specified range:
469469

470470
#### Parameters
471471

472-
- `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)
472+
- `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)
473473

474-
- `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)
474+
- `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)
475475

476476
If you specify:
477477

@@ -579,7 +579,7 @@ Lists the validators defined in the specified block.
579579

580580
#### Parameters
581581

582-
- `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)
582+
- `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)
583583

584584
#### Returns
585585

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

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

994-
- `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)
994+
- `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)
995995

996996
#### Returns
997997

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

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

1114-
- `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)
1114+
- `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)
11151115

11161116
#### Returns
11171117

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

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

1291-
- `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)
1291+
- `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)
12921292

12931293
#### Returns
12941294

@@ -1960,9 +1960,9 @@ Provides the following validator metrics for the specified range:
19601960
19611961
#### Parameters
19621962
1963-
- `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)
1963+
- `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)
19641964
1965-
- `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)
1965+
- `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)
19661966
19671967
If you specify:
19681968
@@ -2070,7 +2070,7 @@ Lists the validators defined in the specified block.
20702070
20712071
#### Parameters
20722072
2073-
- `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)
2073+
- `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)
20742074
20752075
#### Returns
20762076

0 commit comments

Comments
 (0)