docs: improve contextOrHash parameter documentation #574
Conversation
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
✅ Deploy Preview for oasisprotocol-sapphire-paratime canceled.
|
rube-de
force-pushed
the
rube/331-docs-better-document-the-usagebehavior-of-contextorhash-for-sign-and-verify
branch
3 times, most recently
from
61fb588 to
a2a7e96
Compare
rube-de
force-pushed
the
rube/331-docs-better-document-the-usagebehavior-of-contextorhash-for-sign-and-verify
branch
from
a2a7e96 to
6e1d840
Compare
Enhance the documentation for the `sign()` and `verify()` functions in Sapphire.sol to clarify how the `contextOrHash` parameter should be used with different signing algorithms:
- Correct the expected hash size for Secp384r1PrehashedSha384 from 32 bytes to 48 bytes
- Add detailed explanations of parameter behavior for each algorithm type
- Explicitly document that Sr25519 signatures MUST use "substrate" as the context for compatibility with Substrate off-chain signing using { withType: true }
- Add clear code examples showing proper usage for different algorithms
- Maintain consistent documentation between sign() and verify() functions
rube-de
force-pushed
the
rube/331-docs-better-document-the-usagebehavior-of-contextorhash-for-sign-and-verify
branch
from
6e1d840 to
0abb3ff
Compare
rube-de
deleted the
rube/331-docs-better-document-the-usagebehavior-of-contextorhash-for-sign-and-verify
branch
github-actions bot
added a commit
that referenced
this pull request
Apr 29, 2025
…be/331-docs-better-document-the-usagebehavior-of-contextorhash-for-sign-and-verify docs: improve contextOrHash parameter documentation b245ffd
github-actions bot
added a commit
that referenced
this pull request
Apr 29, 2025
…ube/331-docs-better-document-the-usagebehavior-of-contextorhash-for-sign-and-verify docs: improve contextOrHash parameter documentation b245ffd
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.
Enhance the documentation for the
sign()andverify()functions in Sapphire.sol to clarify how thecontextOrHashparameter should be used with different signing algorithms: