Fixing documentation for BIP 340-related functions#307
Merged
apoelstra merged 1 commit intorust-bitcoin:masterfrom Nov 2, 2021
Merged
Fixing documentation for BIP 340-related functions#307apoelstra merged 1 commit intorust-bitcoin:masterfrom
apoelstra merged 1 commit intorust-bitcoin:masterfrom
Conversation
Member
|
nit: in one place you wrote needs rebase. concept ACK |
dr-orlovsky
force-pushed
the
fix/schorr-docs
branch
from
5393558 to
3c7a981
Compare
Contributor
Author
|
@apoelstra rebased & fixed |
apoelstra
reviewed
Sep 8, 2021
src/schnorrsig.rs
Outdated
| /// | ||
| /// Panics if internal representation of the provided [`SecretKey`] does not hold correct secret | ||
| /// key value obtained from Secp256k1 library previously, for instance when the corresponding | ||
| /// public key is not even key. |
Member
There was a problem hiding this comment.
To be clearer: this will panic on out-of-range keys (0 or in excess of the group order).
apoelstra
reviewed
Sep 8, 2021
src/schnorrsig.rs
Outdated
| /// key value obtained from Secp256k1 library previously, for instance when the corresponding | ||
| /// public key is not even key. | ||
| // TODO: Consider returning `Result`, since even if the secret key is constructed with Secp256k1 | ||
| // library, the function still will panic on keys producing odd public key values. |
Member
There was a problem hiding this comment.
This doesn't sound right. AFAIK if the resultant public key were to be odd, it will simply be negated.
Member
There was a problem hiding this comment.
No, it's even simpler than that, the keypair type simply has no restrictions on key parity.
dr-orlovsky
force-pushed
the
fix/schorr-docs
branch
from
3c7a981 to
50da5ac
Compare
dr-orlovsky
force-pushed
the
fix/schorr-docs
branch
from
50da5ac to
931b560
Compare
Contributor
Author
|
@apoelstra addressed your comments and rebased |
thomaseizinger
approved these changes
Sep 28, 2021
Contributor
thomaseizinger
left a comment
thomaseizinger
left a comment
There was a problem hiding this comment.
Nice! Much prefer referring to errors via their type instead of importing variants directly.
ACK 931b560
apoelstra
approved these changes
Nov 2, 2021
chain-forgexcr45
added a commit
to chain-forgexcr45/rust-secp256k1
that referenced
this pull request
Sep 28, 2025
…40-related functions
931b560dc7a339c7544a1eb719b1e4d450456836 Fixing documentation for BIP 340-related functions (Dr Maxim Orlovsky)
Pull request description:
ACKs for top commit:
thomaseizinger:
ACK 931b560dc7a339c7544a1eb719b1e4d450456836
apoelstra:
ACK 931b560dc7a339c7544a1eb719b1e4d450456836
Tree-SHA512: d78fbda138e636c04c6f356e2a41fcdd0270eea710a9af6c965ff90acfd6740bd650a8909638c558badd52d307cbdcd914fa25846236b064ca8c38faccec8be8
william2332-limf
added a commit
to william2332-limf/rust-secp256k1
that referenced
this pull request
Oct 2, 2025
…40-related functions
931b560dc7a339c7544a1eb719b1e4d450456836 Fixing documentation for BIP 340-related functions (Dr Maxim Orlovsky)
Pull request description:
ACKs for top commit:
thomaseizinger:
ACK 931b560dc7a339c7544a1eb719b1e4d450456836
apoelstra:
ACK 931b560dc7a339c7544a1eb719b1e4d450456836
Tree-SHA512: d78fbda138e636c04c6f356e2a41fcdd0270eea710a9af6c965ff90acfd6740bd650a8909638c558badd52d307cbdcd914fa25846236b064ca8c38faccec8be8
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
3 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.
No description provided.