docs: update documentation for ToRistrettoPoint opcode
#113
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
SWvheerden
pushed a commit
to tari-project/tari
that referenced
this pull request
Nov 21, 2023
Description --- Updates the handling of the `ToRistrettoPoint` opcode. Closes #5818. Motivation and Context --- The `ToRistrettoPoint` opcode now requires that stack input be the canonical encoding of a Ristretto secret key. This PR updates the opcode documentation and adds a test for proper handling of invalid encoding. It also corrects the error returned on invalid stack input. There is a [separate PR](tari-project/rfcs#113) that updates the RFC documentation. How Has This Been Tested? --- Existing tests pass. A modified test passes. What process can a PR reviewer use to test or verify this change? --- Check that the updated documentation reflects the opcode handling. Check that the modified test correctly detects invalid input. Check that the error returned on invalid input is correct.
sdbondi
pushed a commit
to sdbondi/tari
that referenced
this pull request
Nov 27, 2023
Description --- Updates the handling of the `ToRistrettoPoint` opcode. Closes tari-project#5818. Motivation and Context --- The `ToRistrettoPoint` opcode now requires that stack input be the canonical encoding of a Ristretto secret key. This PR updates the opcode documentation and adds a test for proper handling of invalid encoding. It also corrects the error returned on invalid stack input. There is a [separate PR](tari-project/rfcs#113) that updates the RFC documentation. How Has This Been Tested? --- Existing tests pass. A modified test passes. What process can a PR reviewer use to test or verify this change? --- Check that the updated documentation reflects the opcode handling. Check that the modified test correctly detects invalid input. Check that the error returned on invalid input is correct.
CjS77
reviewed
Dec 5, 2023
AaronFeickert
force-pushed
the
update-point-opcode
branch
from
7c8bb00
to
643ec2f
Compare
Done! |
CjS77
approved these changes
Dec 6, 2023
CjS77
pushed a commit
that referenced
this pull request
Dec 19, 2023
Description --- Updates the documentation for the `ToRistrettoPoint` opcode. Motivation and Context --- This opcode now requires a canonical scalar parsing. Further, the existing documentation was somewhat unclear. This PR updates the documentation for clarity and correctness. How Has This Been Tested? --- It renders as expected.
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.
Description
Updates the documentation for the
ToRistrettoPointopcode.Motivation and Context
This opcode now requires a canonical scalar parsing. Further, the existing documentation was somewhat unclear. This PR updates the documentation for clarity and correctness.
How Has This Been Tested?
It renders as expected.