Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated public API methods containing blockNumber #1402

Merged
merged 8 commits into from
Sep 25, 2023
Merged

Updated public API methods containing blockNumber #1402

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
e680e14
Updated public API methods containing blockNumber
mjsmike62 Sep 14, 2023
066390b
Merge branch 'main' into 1385-update-parameter-description
mjsmike62 Sep 14, 2023
83f5357
Updated API methods containing blockNumber w/additional edits
mjsmike62 Sep 21, 2023
985cbb3
Updated API methods containing blockNumber w/correct quantity types
mjsmike62 Sep 22, 2023
38c81da
Changed 'decimal' to 'decimal integer' for API methods containing `bl…
mjsmike62 Sep 25, 2023
28a8b9c
Files were changed for Docusaurus upgrade
mjsmike62 Sep 25, 2023
e67e069
Merge branch 'main' into 1385-update-parameter-description
mjsmike62 Sep 25, 2023
fab2ec3
Apply suggestions from code review
mjsmike62 Sep 25, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions docs/private-networks/reference/api/index.md
View file
Open in desktop
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)
mjsmike62 marked this conversation as resolved.
Show resolved Hide resolved

#### 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 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)
mjsmike62 marked this conversation as resolved.
Show resolved Hide resolved

- `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 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)
mjsmike62 marked this conversation as resolved.
Show resolved Hide resolved

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 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)
mjsmike62 marked this conversation as resolved.
Show resolved Hide resolved

- `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 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)
mjsmike62 marked this conversation as resolved.
Show resolved Hide resolved

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)
mjsmike62 marked this conversation as resolved.
Show resolved Hide resolved

#### 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)
mjsmike62 marked this conversation as resolved.
Show resolved Hide resolved

#### 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)
mjsmike62 marked this conversation as resolved.
Show resolved Hide resolved

#### 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)
mjsmike62 marked this conversation as resolved.
Show resolved Hide resolved

#### 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 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)
mjsmike62 marked this conversation as resolved.
Show resolved Hide resolved

- `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 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)
mjsmike62 marked this conversation as resolved.
Show resolved Hide resolved

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)
mjsmike62 marked this conversation as resolved.
Show resolved Hide resolved

#### Returns

Expand Down
Loading