Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve documentation #340

Merged
merged 10 commits into from
Feb 10, 2022
Merged

Improve documentation #340

Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
269bde0
Remove unnecessary capitalisation
tcharding Nov 17, 2021
5e07e75
Add period to sentences
tcharding Nov 17, 2021
c3be285
Fix size constant docs
tcharding Nov 17, 2021
d25431c
Use 3rd person tense for function docs
tcharding Nov 17, 2021
f5e68f3
Add ticks around code snippet
tcharding Nov 18, 2021
3fa6762
Add link to referenced commit
tcharding Nov 18, 2021
c9e6ca1
Use rust-bitcoin module doc style
tcharding Nov 18, 2021
f95e91a
Use isn't instead of shouldn't
tcharding Feb 10, 2022
c79eb97
Remove unnecessary explanation
tcharding Feb 10, 2022
c73eb2f
Use 'extra' instead of 'cheap'
tcharding Feb 10, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -414,9 +414,10 @@ impl<C: Context> Secp256k1<C> {
(bytes + word_size - 1) / word_size
}

/// (Re)randomizes the Secp256k1 context for cheap sidechannel resistance;
/// see comment in libsecp256k1 commit d2275795f by Gregory Maxwell. Requires
/// compilation with "rand" feature.
/// (Re)randomizes the Secp256k1 context for cheap sidechannel resistance.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In 3fa6762:

Let's replace "cheap" with "extra". The cost is comparable to a signing operation.

///
/// Requires compilation with "rand" feature. See comment by Gregory Maxwell in
/// [libsecp256k1](https://github.com/bitcoin-core/secp256k1/commit/d2275795ff22a6f4738869f5528fbbb61738aa48).
#[cfg(any(test, feature = "rand"))]
#[cfg_attr(docsrs, doc(cfg(feature = "rand")))]
pub fn randomize<R: Rng + ?Sized>(&mut self, rng: &mut R) {
Expand Down