Merge pull request #17 from webb-tools/m

make getrandom behind the wasm feature flag
LFDT-Lockness · Feb 15, 2024 · c3754c6 · c3754c6
2 parents 3de295d + e628fde
commit c3754c6
Show file tree

Hide file tree

Showing 12 changed files with 63 additions and 34 deletions.
diff --git a/.github/workflows/rust.yml b/.github/workflows/rust.yml
@@ -44,7 +44,7 @@ jobs:
       with:
         cache-on-failure: "true"
     - name: Run tests
-      run: cargo test --all-features
+      run: cargo test --all-features --workspace --exclude nostd-example
   fmt:
     runs-on: ubuntu-latest
     steps:
@@ -59,7 +59,7 @@ jobs:
       with:
         cache-on-failure: "true"
     - name: Run clippy
-      run: cargo clippy --all --lib --all-features --exclude generic-ec-tests -- --no-deps -D clippy::all -D clippy::unwrap_used -D clippy::expect_used
+      run: cargo clippy --all --lib --workspace --all-features --exclude generic-ec-tests --exclude nostd-example -- --no-deps -D clippy::all -D clippy::unwrap_used -D clippy::expect_used
   clippy-nostd:
     runs-on: ubuntu-latest
     steps:
@@ -77,7 +77,7 @@ jobs:
       with:
         cache-on-failure: "true"
     - name: Run clippy tests
-      run: cargo clippy --tests --all-features -- -D clippy::all
+      run: cargo clippy --workspace --tests --all-features --exclude nostd-example -- -D clippy::all
   check-doc:
     runs-on: ubuntu-latest
     steps:
@@ -87,7 +87,7 @@ jobs:
       with:
         cache-on-failure: "true"
     - name: Check docs
-      run: RUSTDOCFLAGS="--cfg docsrs -D warnings" cargo +nightly doc --all-features --no-deps
+      run: RUSTDOCFLAGS="--cfg docsrs -D warnings" cargo +nightly doc --workspace --all-features --no-deps --exclude nostd-example
   build-wasm:
     runs-on: ubuntu-latest
     steps:
@@ -99,10 +99,23 @@ jobs:
       run: rustup target add wasm32-unknown-unknown
     - name: Build on wasm32-unknown-unknown
       run:
-        cargo check -p generic-ec --target wasm32-unknown-unknown --features wasm,all-curves
+        cargo check -p generic-ec --target wasm32-unknown-unknown --features all-curves
     - name: Install wasm-pack
       uses: baptiste0928/cargo-install@v1
       with:
         crate: wasm-pack
     - name: wasm-pack an example project
       run: (cd wasm/wasm-example; wasm-pack build)
+
+  build-wasm-nostd:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - uses: Swatinem/rust-cache@v2
+      with:
+        cache-on-failure: "true"
+    - name: Install wasm32-unknown-unknown toolchain
+      run: rustup target add wasm32-unknown-unknown
+    - name: Build on wasm32-unknown-unknown (no_std)
+      run:
+        cargo build -p nostd-example --target wasm32-unknown-unknown
diff --git a/Cargo.toml b/Cargo.toml
@@ -6,5 +6,6 @@ members = [
   "generic-ec-curves",
   "generic-ec-zkp",
   "wasm/wasm-example",
+  "wasm/nostd",
   "tests",
 ]
diff --git a/generic-ec-curves/Cargo.toml b/generic-ec-curves/Cargo.toml
@@ -9,18 +9,18 @@ repository = "https://github.com/dfns/generic-ec"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-generic-ec-core = "0.1"
+generic-ec-core = { version = "0.1", path = "../generic-ec-core", default-features = false }
 
 subtle = { version = "2.4", default-features = false }
 rand_core = { version = "0.6", default-features = false }
 zeroize = { version = "1", default-features = false }
 
-crypto-bigint = { version = "0.5", optional = true }
-elliptic-curve = { version = "0.13", features = ["sec1", "hash2curve"], optional = true }
-k256 = { version = "0.13", optional = true, features = ["hash2curve"] }
-p256 = { version = "0.13", optional = true, features = ["hash2curve"] }
-sha2 = { version = "0.10", optional = true }
-stark-curve = { version = "0.1", optional = true }
+crypto-bigint = { version = "0.5", default-features = false, optional = true }
+elliptic-curve = { version = "0.13", default-features = false, features = ["sec1", "hash2curve"], optional = true }
+k256 = { version = "0.13", optional = true, default-features = false, features = ["hash2curve"] }
+p256 = { version = "0.13", optional = true, default-features = false, features = ["hash2curve"] }
+sha2 = { version = "0.10", default-features = false, optional = true }
+stark-curve = { version = "0.1", default-features = false, optional = true }
 
 group = { version = "0.13", default-features = false, optional = true }
 
@@ -33,7 +33,6 @@ optional = true
 
 [features]
 default = []
-
 rust-crypto = ["elliptic-curve", "crypto-bigint"]
 secp256k1 = ["rust-crypto", "k256", "sha2"]
 secp256r1 = ["rust-crypto", "p256", "sha2"]

diff --git a/generic-ec-curves/src/ed25519.rs b/generic-ec-curves/src/ed25519.rs
@@ -124,7 +124,7 @@ impl core::cmp::Ord for Point {
 }
 
 impl core::hash::Hash for Point {
-    fn hash<H: std::hash::Hasher>(&self, state: &mut H) {
+    fn hash<H: core::hash::Hasher>(&self, state: &mut H) {
         self.0.compress().as_bytes().hash(state)
     }
 }

diff --git a/generic-ec-curves/src/lib.rs b/generic-ec-curves/src/lib.rs
@@ -6,6 +6,7 @@
 //! [`generic-ec` crate]: https://docs.rs/generic-ec
 
 #![cfg_attr(not(test), deny(clippy::unwrap_used, clippy::expect_used))]
+#![no_std]
 
 #[cfg(feature = "ed25519")]
 pub mod ed25519;

diff --git a/generic-ec-zkp/Cargo.toml b/generic-ec-zkp/Cargo.toml
@@ -12,13 +12,13 @@ keywords = ["elliptic-curves", "zk-proof"]
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-generic-ec = { version = "0.1", default-features = false }
+generic-ec = { version = "0.1", path = "../generic-ec", default-features = false }
 udigest = { version = "0.1", features = ["derive"], optional = true }
 
-subtle = "2.4"
-rand_core = "0.6"
+subtle = { version = "2.4", default-features = false }
+rand_core = { version = "0.6", default-features = false }
 
-serde = { version = "1", features = ["derive"], optional = true }
+serde = { version = "1", default-features = false, features = ["derive"], optional = true }
 
 # We don't depend on this crates directly, but need to specify features to make it compile
 generic-array = "0.14"
@@ -30,12 +30,12 @@ sha2 = "0.10"
 
 generic-tests = "0.1"
 
-generic-ec = { version = "0.1", default-features = false, features = ["all-curves"] }
+generic-ec = { version = "0.1", path = "../generic-ec", default-features = false, features = ["all-curves"] }
 
 [features]
 default = ["std"]
 std = ["alloc"]
-alloc = ["udigest/alloc"]
+alloc = ["udigest?/alloc", "serde?/alloc"]
 serde = ["dep:serde", "generic-ec/serde", "generic-array/serde"]
 udigest = ["dep:udigest", "generic-ec/udigest"]
 

diff --git a/generic-ec/Cargo.toml b/generic-ec/Cargo.toml
@@ -13,8 +13,8 @@ keywords = ["elliptic-curves"]
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-generic-ec-core = "0.1"
-generic-ec-curves = { version = "0.1", optional = true }
+generic-ec-core = { version = "0.1", path = "../generic-ec-core" }
+generic-ec-curves = { version = "0.1", path = "../generic-ec-curves", optional = true }
 udigest = { version = "0.1", features = ["derive"], optional = true }
 
 subtle = { version = "2.4", default-features = false }
@@ -27,9 +27,6 @@ hex = { version = "0.4", default-features = false, optional = true }
 
 phantom-type = { version = "0.4", default-features = false }
 
-# We don't depend on this crate directly, but we need to enable certain features when wasm is required
-getrandom = "0.2"
-
 [dev-dependencies]
 rand = "0.8"
 serde_json = "1"
@@ -47,9 +44,7 @@ curve-secp256k1 = ["curves", "generic-ec-curves/secp256k1"]
 curve-secp256r1 = ["curves", "generic-ec-curves/secp256r1"]
 curve-stark = ["curves", "generic-ec-curves/stark"]
 curve-ed25519 = ["curves", "generic-ec-curves/ed25519"]
-all-curves = ["curve-secp256k1", "curve-secp256r1", "curve-stark"]
-
-wasm = ["getrandom/js"]
+all-curves = ["curve-secp256k1", "curve-secp256r1", "curve-stark", "curve-ed25519"]
 
 [package.metadata.docs.rs]
 all-features = true

diff --git a/generic-ec/src/lib.rs b/generic-ec/src/lib.rs
@@ -182,10 +182,6 @@
 #[cfg(feature = "alloc")]
 extern crate alloc;
 
-// We do not use getrandom directly, we just need to enable certain features
-// when `wasm` is required
-use getrandom as _;
-
 pub use generic_ec_core as core;
 
 mod arithmetic;

diff --git a/generic-ec/src/serde.rs b/generic-ec/src/serde.rs
@@ -74,6 +74,7 @@
 //! # Ok(()) }
 //! ```
 
+#![cfg(feature = "serde")]
 use core::{convert::TryInto, fmt};
 
 use phantom_type::PhantomType;

diff --git a/wasm/nostd/Cargo.toml b/wasm/nostd/Cargo.toml
@@ -0,0 +1,10 @@
+[package]
+name = "nostd-example"
+version = "0.1.0"
+edition = "2021"
+publish = false
+
+[dependencies]
+generic-ec = { path = "../../generic-ec", default-features = false, features = ["udigest", "all-curves"] }
+generic-ec-curves = { path = "../../generic-ec-curves", default-features = false }
+generic-ec-zkp = { path = "../../generic-ec-zkp", default-features = false, features = ["udigest"] }
diff --git a/wasm/nostd/src/lib.rs b/wasm/nostd/src/lib.rs
@@ -0,0 +1,12 @@
+#![no_std]
+
+use ::core::panic::PanicInfo;
+
+pub use generic_ec::*;
+pub use generic_ec_curves::*;
+pub use generic_ec_zkp::*;
+
+#[panic_handler]
+fn panic(_panic: &PanicInfo<'_>) -> ! {
+    loop {}
+}
diff --git a/wasm/wasm-example/Cargo.toml b/wasm/wasm-example/Cargo.toml
@@ -8,9 +8,10 @@ publish = false
 crate-type = ["cdylib", "rlib"]
 
 [dependencies]
-generic-ec = { path = "../../generic-ec", features = ["all-curves", "wasm"] }
-rand_core = "0.6"
+generic-ec = { path = "../../generic-ec", features = ["all-curves"] }
+rand_core = { version = "0.6", features = ["getrandom"] }
 wasm-bindgen = "0.2.84"
+getrandom = { version = "0.2", features = ["js"] }
 
 [dev-dependencies]
 wasm-bindgen-test = "0.3.34"