From f96693ae2023f5afef1ede2f1b81cbc588cf1318 Mon Sep 17 00:00:00 2001 From: Alexandru Vasile Date: Mon, 11 Sep 2023 19:52:28 +0300 Subject: [PATCH 1/4] archive/body: Keep description consistent with chainHead Signed-off-by: Alexandru Vasile --- src/api/archive_unstable_body.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/api/archive_unstable_body.md b/src/api/archive_unstable_body.md index f1132dc..da0fb38 100644 --- a/src/api/archive_unstable_body.md +++ b/src/api/archive_unstable_body.md @@ -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 an hexadecimal-encoded hash of the header of the block whose body to fetch. **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`. From de0dd3388dfa9c49c4226070981af509becd6b04 Mon Sep 17 00:00:00 2001 From: Alexandru Vasile <60601340+lexnv@users.noreply.github.com> Date: Wed, 13 Sep 2023 14:51:55 +0300 Subject: [PATCH 2/4] Update src/api/archive_unstable_body.md Co-authored-by: James Wilson --- src/api/archive_unstable_body.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/api/archive_unstable_body.md b/src/api/archive_unstable_body.md index da0fb38..b88d6e1 100644 --- a/src/api/archive_unstable_body.md +++ b/src/api/archive_unstable_body.md @@ -2,7 +2,7 @@ **Parameters**: -- `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**: 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`. From ee6ebcc9fbac7add248a4724c38ea30c95fb2e54 Mon Sep 17 00:00:00 2001 From: Alexandru Vasile Date: Wed, 13 Sep 2023 14:55:12 +0300 Subject: [PATCH 3/4] chainHead/body: Adjust with archive/body Signed-off-by: Alexandru Vasile --- src/api/chainHead_unstable_body.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/api/chainHead_unstable_body.md b/src/api/chainHead_unstable_body.md index 7f9fc3e..f8b6c54 100644 --- a/src/api/chainHead_unstable_body.md +++ b/src/api/chainHead_unstable_body.md @@ -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. From 3d91e51705e0c88068327727a11cac2860401b65 Mon Sep 17 00:00:00 2001 From: Alexandru Vasile Date: Wed, 13 Sep 2023 14:55:57 +0300 Subject: [PATCH 4/4] Fix typo regarding hexadecimal article Signed-off-by: Alexandru Vasile --- src/api/archive_unstable_hashByHeight.md | 4 ++-- src/api/archive_unstable_storage.md | 2 +- src/api/chainHead_unstable_storage.md | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/src/api/archive_unstable_hashByHeight.md b/src/api/archive_unstable_hashByHeight.md index 17b2a4e..fd22bf2 100644 --- a/src/api/archive_unstable_hashByHeight.md +++ b/src/api/archive_unstable_hashByHeight.md @@ -2,9 +2,9 @@ **Parameters**: -- `height`: String containing an hexadecimal-encoded integer. +- `height`: String containing a hexadecimal-encoded integer. -**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. diff --git a/src/api/archive_unstable_storage.md b/src/api/archive_unstable_storage.md index 4fdeaec..248edb0 100644 --- a/src/api/archive_unstable_storage.md +++ b/src/api/archive_unstable_storage.md @@ -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. diff --git a/src/api/chainHead_unstable_storage.md b/src/api/chainHead_unstable_storage.md index 695b600..695d198 100644 --- a/src/api/chainHead_unstable_storage.md +++ b/src/api/chainHead_unstable_storage.md @@ -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.