Skip to content

Commit 37273e7

Browse files
committed
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.
1 parent 7f8b0cd commit 37273e7

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

src/lib.rs

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

0 commit comments

Comments
 (0)