Skip to content

Commit

Permalink
Merge pull request #95 from paritytech/lexnv/archive_body
Browse files Browse the repository at this point in the history
archive/body: Keep description consistent with chainHead
  • Loading branch information
lexnv authored Sep 19, 2023
2 parents 7de90b1 + bb68af1 commit dfd4fd8
Show file tree
Hide file tree
Showing 5 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion src/api/archive_unstable_body.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

**Parameters**:

- `hash`: String containing the hexadecimal-encoded hash of the header of the block whose body must be retrieved.
- `hash`: String containing a hexadecimal-encoded hash of the header of the block whose body will be retrieved.

**Return value**: If a block with that hash is found, an array of strings containing the hexadecimal-encoded SCALE-codec-encoded transactions in that block. If no block with that hash is found, `null`.

Expand Down
2 changes: 1 addition & 1 deletion src/api/archive_unstable_hashByHeight.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

- `height`: Integer representing the height of the block.

**Return value**: Array (possibly empty) of strings containing an hexadecimal-encoded hash of a block header.
**Return value**: Array (possibly empty) of strings containing a hexadecimal-encoded hash of a block header.

The JSON-RPC client must find the blocks (zero, one, or more) whose height is the one passed as parameter. If the `height` is inferior or equal to the finalized block height, then only finalized blocks must be fetched and returned.

Expand Down
2 changes: 1 addition & 1 deletion src/api/archive_unstable_storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

**Parameters**:

- `hash`: String containing an hexadecimal-encoded hash of the header of the block whose storage to fetch.
- `hash`: String containing a hexadecimal-encoded hash of the header of the block whose storage to fetch.
- `key`: String containing the hexadecimal-encoded key to fetch in the storage.
- `childTrie`: `null` for main storage look-ups, or a string containing the hexadecimal-encoded key of the child trie of the "default" namespace.
- `includeDescendants`: Boolean indicating whether the key-values of all the descendants of the `key` should be returned as well.
Expand Down
2 changes: 1 addition & 1 deletion src/api/chainHead_unstable_body.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
**Parameters**:

- `followSubscription`: An opaque string that was returned by `chainHead_unstable_follow`.
- `hash`: String containing an hexadecimal-encoded hash of the header of the block whose body to fetch.
- `hash`: String containing a hexadecimal-encoded hash of the header of the block whose body will be retrieved.

**Return value**: A JSON object.

Expand Down
2 changes: 1 addition & 1 deletion src/api/chainHead_unstable_storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
**Parameters**:

- `followSubscription`: An opaque string that was returned by `chainHead_unstable_follow`.
- `hash`: String containing an hexadecimal-encoded hash of the header of the block whose storage to fetch.
- `hash`: String containing a hexadecimal-encoded hash of the header of the block whose storage to fetch.
- `items`: Array of objects. The structure of these objects is found below.
- `childTrie`: `null` for main storage look-ups, or a string containing the hexadecimal-encoded key of the child trie of the "default" namespace.

Expand Down

0 comments on commit dfd4fd8

Please sign in to comment.