Fix a few mistakes in the Penumbra Protocol docs #3710
Merged
Conversation
This file contains 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
Just noticed this while reading the Penumbra protocol. Signed-off-by: Jesse Pinho <jesse@jessepinho.com>
Signed-off-by: Jesse Pinho <jesse@jessepinho.com>
jessepinho
changed the title
jessepinho
changed the title
Signed-off-by: Jesse Pinho <jesse@jessepinho.com>
Signed-off-by: Jesse Pinho <jesse@jessepinho.com>
jessepinho
commented
Jan 31, 2024
| @@ -62,5 +62,4 @@ addresses, allowing fine-grained control of delegation. | |||
|
|
|||
| This diagram shows only the user-visible parts of the key hierarchy. | |||
| Internally, each of these keys has different components, described in detail in | |||
| the [Addresses and Keys](../protocol/addresses_keys.md) section of the | |||
| [Cryptographic Protocol](../protocol.md) chapter. | |||
| the [Addresses and Keys](../protocol/addresses_keys.md) chapter. | |||
There was a problem hiding this comment.
Addresses and Keys is now its own chapter, rather than being under the Cryptographic Protocol chapter.
jessepinho
commented
Jan 31, 2024
| @@ -61,7 +61,7 @@ description leaves the value balance unchanged. | |||
| transaction's value balance, burning them, and producing a swap commitment for | |||
| use in the second stage; | |||
|
|
|||
| - **Sweep** descriptions perform the second phase of | |||
| - **SwapClaim** descriptions perform the second phase of | |||
There was a problem hiding this comment.
Reviewers: please confirm that this change is correct.
There was a problem hiding this comment.
Yep! Another terminology change we didn't update
hdevalence
reviewed
Jan 31, 2024
Comment on lines
38
to
40
| - **Commission** descriptions are used by validators to [claim commission on | ||
| staking rewards](../stake/validator-rewards.md) into shielded notes, | ||
| adding unbonded stake to the transaction's value balance; |
There was a problem hiding this comment.
We actually got rid of these entirely, now the commission is paid out by the chain, so we could delete this bullet point.
There was a problem hiding this comment.
Got it — removed.
hdevalence
approved these changes
Jan 31, 2024
Signed-off-by: Jesse Pinho <jesse@jessepinho.com>
TalDerei
pushed a commit
that referenced
this pull request
Feb 8, 2024
* Fix repeated language in Transactions docs Just noticed this while reading the Penumbra protocol. Signed-off-by: Jesse Pinho <jesse@jessepinho.com> * Fix reference to SwapClaims Signed-off-by: Jesse Pinho <jesse@jessepinho.com> * Fix references to addresses + keys chapter Signed-off-by: Jesse Pinho <jesse@jessepinho.com> * Remove reference to addresses + keys, which is now in its own chapter Signed-off-by: Jesse Pinho <jesse@jessepinho.com> * Remove outdated bullet point Signed-off-by: Jesse Pinho <jesse@jessepinho.com> --------- Signed-off-by: Jesse Pinho <jesse@jessepinho.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Just a couple things I noticed while reading the Penumbra protocol.