Add docs about wasm and no_std. Fix std not being default

Signed-off-by: maurges <[email protected]>

Author: maurges

README.md

@@ -21,6 +21,7 @@
 - [HD wallets support](#hd-wallets-support)
 - [SPOF code: Key Import and Export](#spof-code-key-import-and-export)
 - [Big integer implementation](#big-integer-implementation)
+- [no\_std compatability](#no_std-compatability)
 - [Differences between the implementation and CGGMP24](#differences-between-the-implementation-and-cggmp24)
 - [Timing attacks](#timing-attacks)
 - [Join us in Discord!](#join-us-in-discord)
@@ -243,6 +244,23 @@ some applications by several times, but requires an LGPL dependency
 - To use num-bigint, select the feature `backend-num-bigint` (selected as
 **default** feature)
 
+## no\_std compatability
+
+Every crate in this project is compatible with no\_std, provided that
+`num-bigint` backend is chosen. The presence of `alloc` is still required. This
+means that `cggmp24` and `cggmp24-keygen` can be run on a
+`wasm32-unknown-unknown` platform.
+
+To compile the crates for `no_std`, you need to disable the default feature
+"std" and instead enable `no_std` for some crates. The dependencies in your
+cargo file should look like this:
+
+```toml
+cggmp24 = { version = "0.7", default-features = false, features = ["no_std", "backend-num-bigint"] }
+cggmp24-keygen = { version = "0.7", default-features = false }
+key-share = { version = "0.6", default-features = false }
+```
+
 ## Differences between the implementation and CGGMP24
 [CGGMP24] only defines a non-threshold protocol. To support general thresholds,
 we defined our own CGGMP24-like key generation and threshold signing

cggmp24/CHANGELOG.md

@@ -4,7 +4,7 @@
 
 Changes:
 * All protocols have been updated to follow the latest CGGMP24 paper revision.
-* Change big integer backend to be abstract, selectable between rug and num-bigint [#13]
+* Change big integer backend to be abstract, selectable between rug and num-bigint
 
 Breaking changes:
 * The structure `cggmp24::key_share::AuxInfo` has been updated and consequently `cggmp24::KeyShare`

cggmp24/Cargo.toml

@@ -46,7 +46,7 @@ rand_dev = { workspace = true }
 generic-tests = { workspace = true }
 
 [features]
-default = ["backend-num-bigint"]
+default = ["std", "backend-num-bigint"]
 
 all-curves = ["curve-secp256k1", "curve-secp256r1", "curve-stark"]
 curve-secp256k1 = ["generic-ec/curve-secp256k1", "hd-wallet?/curve-secp256k1"]

cggmp24/src/lib.rs

@@ -267,6 +267,23 @@
 //! - To use num-bigint, select the feature `backend-num-bigint` (selected as
 //! **default** feature)
 //!
+//! ## no\_std compatability
+//!
+//! Every crate in this project is compatible with no\_std, provided that
+//! `num-bigint` backend is chosen. The presence of `alloc` is still required. This
+//! means that `cggmp24` and `cggmp24-keygen` can be run on a
+//! `wasm32-unknown-unknown` platform.
+//!
+//! To compile the crates for `no_std`, you need to disable the default feature
+//! "std" and instead enable `no_std` for some crates. The dependencies in your
+//! cargo file should look like this:
+//!
+//! ```toml
+//! cggmp24 = { version = "0.7", default-features = false, features = ["no_std", "backend-num-bigint"] }
+//! cggmp24-keygen = { version = "0.7", default-features = false }
+//! key-share = { version = "0.6", default-features = false }
+//! ```
+//!
 //! ## Differences between the implementation and CGGMP24
 //! [CGGMP24] only defines a non-threshold protocol. To support general thresholds,
 //! we defined our own CGGMP24-like key generation and threshold signing

docs/toc-cggmp24.md

@@ -12,6 +12,7 @@
 - [HD wallets support](#hd-wallets-support)
 - [SPOF code: Key Import and Export](#spof-code-key-import-and-export)
 - [Big integer implementation](#big-integer-implementation)
+- [no\_std compatability](#no_std-compatability)
 - [Differences between the implementation and CGGMP24](#differences-between-the-implementation-and-cggmp24)
 - [Timing attacks](#timing-attacks)
 - [Join us in Discord!](#join-us-in-discord)

paillier-zk/CHANGELOG.md

@@ -2,7 +2,7 @@
 
 ## v0.7.0
 * Proofs are updated to follow the latest CGGMP24 paper revision.
-* Change big integer backend to be abstract, selectable between rug and num-bigint [#13]
+* Change big integer backend to be abstract, selectable between rug and num-bigint
 
 # CGGMP21 releases