substrate-docs icon indicating copy to clipboard operation
substrate-docs copied to clipboard

Inconsistent information and other improvements/comments for transaction-format page

Open IkerAlus opened this issue 3 years ago • 0 comments

Is there an existing issue?

  • [X] I have searched the existing issues

Experiencing problems? Have you tried our Stack Exchange first?

  • [X] This is not a support question.

What browsers are you seeing the problem on?

Chrome

Bug report for the website

Inconsistency: In the section How transactions are constructed of transaction-format page, first it is mentioned that "some additional data that's not part of what gets signed is required" however, some lines later additional data is said to be part of the signature: "The SCALE encoded data is then signed (i.e. (call, extra, additional))...".

Improvement: In the section mentioned before, the point "Then, some additional data that's not part of what gets signed is required, which includes:" should be indented at the same level as previous two points for "The actual call, composed of:" and "Some extra information..."

Improvement: It would be better for readability to define call, extra and additional before they are firstly introduced in "The SCALE encoded data is then signed (i.e. (call, extra, additional))...". This should happen in lines 44, 48 and 54 respectively.

Unclarity: The sentence "An extrinsic is encoded into the following sequence of bytes just prior to being hex encoded" is unclear to me. What does "hex encoded" mean in this context? A byte array is a byte array regardless if it is shown in hexadecimal, binary or decimal formats.

General comment: There is a bit of overlapping between the first part of the section and the part starting from "An extrinsic is encoded into the following sequence...". It would be nice to clearly differentiate the part where the exact byte array composing the extrinsic is described from the part where the transaction construction process is described.

Steps to reproduce the problem

No response

IkerAlus avatar Jul 19 '22 16:07 IkerAlus