docs: name the two private key formats - #87
Merged
Conversation
The note told readers to trim a 128-character key without saying what the trailing half is or why it is there. Name the long form as the Iroha SDK format, state that a private key is 64 characters, and keep the trimming instruction for anyone holding the longer string. Signed-off-by: Dmitrii Creed <creeed22@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
The note added last week told readers to use the first 64 characters of a 128-character private key, without saying what the trailing half is or why the field hands it over. That documents the wart instead of explaining it, and it reads as an arbitrary incantation.
What changed
Both notes now name the two forms: a private key is 64 characters, and Iroha SDK format appends the public key to make 128. The Iroha SDKs want the long form, every other library wants the short one, and the trimming instruction stays for anyone holding a 128-character string.
The wording is accurate both today and after the Web App exposes the two formats as separate copy actions, so it needs no follow-up edit.
Verification
pnpm docs:buildandprettier --checkpass.57e711...e630a.