milksad
/
rust-secp256k1-unsafe-fast
14
0
Fork 0
Code Issues Pull Requests Activity

Add documentation about rand-std feature 

We recently implemented opportunistic randomization of the context
object if the the `rand-std` feature is enabled. Both for the global
context and also for signing context constructors.

Add documentation about `rand-std` feature in relation to the context
object.
This commit is contained in:
Tobin Harding 2022-02-01 16:29:33 +11:00
parent 1693d51ce7
commit cf1496b64e
1 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
src/lib.rs
View File

@ -20,9 +20,13 @@
//! and its derivatives. //! and its derivatives.
//! //!
//! To minimize dependencies, some functions are feature-gated. To generate //! To minimize dependencies, some functions are feature-gated. To generate
//! random keys or to re-randomize a context object, compile with the "rand" //! random keys or to re-randomize a context object, compile with the
//! feature. To de/serialize objects with serde, compile with "serde". //! `rand-std` feature. If you are willing to use the `rand-std` feature, we
//! **Important**: `serde` encoding is **not** the same as consensus encoding! //! have enabled an additional defense-in-depth sidechannel protection for
//! our context objects, which re-blinds certain operations on secret key
//! data. To de/serialize objects with serde, compile with "serde".
//! **Important**: `serde` encoding is **not** the same as consensus
//! encoding!
//! //!
//! Where possible, the bindings use the Rust type system to ensure that //! Where possible, the bindings use the Rust type system to ensure that
//! API usage errors are impossible. For example, the library uses context //! API usage errors are impossible. For example, the library uses context