Update docs

Author: survived

Makefile

@@ -1,13 +1,13 @@
 .PHONY: docs docs-open docs-private readme readme-check
 
 docs:
-	RUSTDOCFLAGS="--html-in-header katex-header.html --cfg docsrs" cargo +nightly doc --no-deps
+	RUSTDOCFLAGS="--html-in-header katex-header.html --cfg docsrs" cargo +nightly doc --all-features --no-deps
 
 docs-open:
-	RUSTDOCFLAGS="--html-in-header katex-header.html --cfg docsrs" cargo +nightly doc --no-deps --open
+	RUSTDOCFLAGS="--html-in-header katex-header.html --cfg docsrs" cargo +nightly doc --all-features --no-deps --open
 
 docs-private:
-	RUSTDOCFLAGS="--html-in-header katex-header.html --cfg docsrs" cargo +nightly doc --no-deps --document-private-items
+	RUSTDOCFLAGS="--html-in-header katex-header.html --cfg docsrs" cargo +nightly doc --all-features --no-deps --document-private-items
 
 readme:
 	cargo readme -i src/lib.rs -r cggmp21/ -t ../docs/README.tpl --no-indent-headings \

README.md

@@ -13,6 +13,8 @@ This crate implements:
 * 3+1 rounds threshold and non-threshold signing
 * Auxiliary info generation protocol
 * Key refresh for non-threshold keys
+* HD-wallets support based on [slip10] standard (compatible with [bip32]) \
+  Requires `hd-wallets` feature
 
 We also provide auxiliary tools like:
 * Secret key reconstruction (exporting key from TSS)
@@ -142,6 +144,19 @@ Alternatively, you can generate presignature and use it to sign data:
 **Never reuse presignatures!** If you use the same presignature to sign two different messages,
 it leaks private key to anyone who can observe the signatures.
 
+## HD wallets support
+Library supports non-hardened deterministic key derivation based on [slip10] standard (compatible
+with [bip32]). It allows signers to generate a master key once, and then use it to instantaneously
+derive as many child keys as needed. Child key derivation takes place within signing protocol
+practically at no cost.
+
+In order to use HD wallets, `hd-wallets` feature must be enabled. Then, a master key needs to be
+generated by running a regular key generation protocol with `hd_wallet`(keygen::GenericKeygenBuilder::hd_wallet)
+set to `true`.
+
+When master key is generated, you can issue a signature for child key by setting
+derivation path in the signing.
+
 ## SPOF code: Key Import and Export
 CGGMP21 protocol is designed to avoid Single Point of Failure by guaranteeing that attacker would
 need to compromise threshold amount of nodes to obtain a secret key. However, some use-cases may
@@ -165,6 +180,8 @@ they are all documented in [the spec].
 [CGGMP21]: https://ia.cr/2021/060
 [the spec]: https://dfns.github.io/cggmp21/cggmp21-spec.pdf
 [security guidelines]: #security-guidelines
+[slip10]: https://github.com/satoshilabs/slips/blob/master/slip-0010.md
+[bip32]: https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki
 
 ## Timing attacks
 Timing attacks are type of side-channel attacks that leak sensitive information through duration of

cggmp21/Cargo.toml

@@ -32,7 +32,7 @@ serde = { version = "1", features = ["derive", "rc"] }
 serde_with = { version = "2" }
 hex = { version = "0.4", default-features = false, features = ["serde"] }
 
-slip-10 = { git = "https://github.com/dfns/slip-10", branch = "m", optional = true }
+slip-10 = { git = "https://github.com/dfns/slip-10", branch = "m", optional = true, features = ["std"] }
 
 [dev-dependencies]
 round-based = { version = "0.2", features = ["derive", "dev"] }

cggmp21/src/lib.rs

@@ -13,6 +13,8 @@
 //! * 3+1 rounds threshold and non-threshold signing
 //! * Auxiliary info generation protocol
 //! * Key refresh for non-threshold keys
+//! * HD-wallets support based on [slip10] standard (compatible with [bip32]) \
+//!   Requires `hd-wallets` feature
 //!
 //! We also provide auxiliary tools like:
 //! * [Secret key reconstruction](crate::key_share::reconstruct_secret_key) (exporting key from TSS)
@@ -185,6 +187,19 @@
 //! **Never reuse presignatures!** If you use the same presignature to sign two different messages,
 //! it leaks private key to anyone who can observe the signatures.
 //!
+//! ## HD wallets support
+//! Library supports non-hardened deterministic key derivation based on [slip10] standard (compatible
+//! with [bip32]). It allows signers to generate a master key once, and then use it to instantaneously
+//! derive as many child keys as needed. Child key derivation takes place within signing protocol
+//! practically at no cost.
+//!
+//! In order to use HD wallets, `hd-wallets` feature must be enabled. Then, a master key needs to be
+//! generated by running a regular key generation protocol with [`hd_wallet`](keygen::GenericKeygenBuilder::hd_wallet)
+//! set to `true`.
+//!
+//! When master key is generated, you can issue a signature for child key by setting
+//! [derivation path](signing::SigningBuilder::set_derivation_path) in the signing.
+//!
 //! ## SPOF code: Key Import and Export
 //! CGGMP21 protocol is designed to avoid Single Point of Failure by guaranteeing that attacker would
 //! need to compromise threshold amount of nodes to obtain a secret key. However, some use-cases may
@@ -208,6 +223,8 @@
 //! [CGGMP21]: https://ia.cr/2021/060
 //! [the spec]: https://dfns.github.io/cggmp21/cggmp21-spec.pdf
 //! [security guidelines]: #security-guidelines
+//! [slip10]: https://github.com/satoshilabs/slips/blob/master/slip-0010.md
+//! [bip32]: https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki
 //!
 //! ## Timing attacks
 //! Timing attacks are type of side-channel attacks that leak sensitive information through duration of

cggmp21/src/signing.rs

@@ -292,6 +292,18 @@ where
     }
 
     /// Specifies HD derivation path
+    ///
+    /// ## Example
+    /// Set derivation path to m/1/999
+    ///
+    /// ```rust,no_run
+    /// # let eid = cggmp21::ExecutionId::new(b"protocol nonce");
+    /// # let (i, parties_indexes_at_keygen, key_share): (u16, Vec<u16>, cggmp21::KeyShare<cggmp21::supported_curves::Secp256k1>)
+    /// # = unimplemented!();
+    /// cggmp21::signing(eid, i, &parties_indexes_at_keygen, &key_share)
+    ///     .set_derivation_path([1, 999])?
+    /// # ; Ok::<_, Box<dyn std::error::Error>>(())
+    /// ```
     #[cfg(feature = "hd-wallets")]
     pub fn set_derivation_path<Index>(
         mut self,