No std (#192)

* cargo.toml changes and started no_std support

* importing alloc Vec and Box when no_std

* alloc Vec and Box

* halo2derive alloc imports

* lazy_static spin_no_std feature

* alloc imports fix

* maybe_rayon

* cfg std typo fix

* fixed -> ln(), imports and to_raw_bytes is std only method

* cargo.toml -> group optional deps

* maybe_rayon::join

* serde_arrays 0.2.0 for no_std support

* using std with asm

* core::arch::asm instead of std::arch::asm

* chore: clean deps

* bn256-table ci fix

* derive_serde CI fix

* No std ci (#1)

* removed std from cargo.toml features in default, bn256-table and derive_serde

* wip: fixing tests

* run ci on no_std_ci for checks

* typo fix

* removed comment

* removed ci_check branch from ci

* Ci (#2)

---------

Co-authored-by: David Nevado <[email protected]>

Author: milosdjurica

.github/workflows/ci.yml

@@ -34,6 +34,29 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
+  no_std:
+    if: github.event.pull_request.draft == false
+    name: no_std-compatibility
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        feature: [default, bn256-table, derive_serde, ""]
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions-rs/toolchain@v1
+
+      - name: Download no_std target
+        run: rustup target add thumbv7em-none-eabi
+
+      #  Check if build passes on `thumbv7em-none-eabi` no_std target with and without specific features (default, bn256-table and derive_serde)
+      - name: Build
+        # Script that checks if feature is empty or script should be ran with feature
+        run: |
+          if [ -z "${{ matrix.feature }}" ]; then
+            cargo build --release --target thumbv7em-none-eabi --no-default-features
+          else
+            cargo build --release --target thumbv7em-none-eabi --no-default-features --features ${{ matrix.feature }}
+          fi
   compat:
     if: github.event.pull_request.draft == false
     name: Wasm-compatibility
@@ -119,7 +142,7 @@ jobs:
       - uses: actions/checkout@v4
       - name: Use typos with config file
         uses: crate-ci/typos@master
-        with: 
+        with:
           config: .config/typos.toml
 
   bench:

Cargo.toml

@@ -11,49 +11,60 @@ rust-version = "1.63.0"
 
 [dev-dependencies]
 criterion = { version = "0.3", features = ["html_reports"] }
-rand_xorshift = "0.3"
 ark-std = { version = "0.3" }
 bincode = "1.3.3"
 serde_json = "1.0.105"
-hex = "0.4"
 rand_chacha = "0.3.1"
+rand_xorshift = "0.3"
 impls = "1"
+rand_core = { version = "0.6", features = ["getrandom"] }
+
 
 # Added to make sure we are able to build the lib in the CI.
 # Notice this will never be loaded for someone using this lib as dep.
 [target.'cfg(all(target_arch = "wasm32", target_os = "unknown"))'.dev-dependencies]
 getrandom = { version = "0.2", features = ["js"] }
 
 [dependencies]
-halo2derive = {path = "derive", version="0.1.0"}
-subtle = "2.5"
+halo2derive = { path = "derive", version = "0.1.0", default-features = false }
 ff = { version = "0.13.0", default-features = false, features = ["std"] }
-group = "0.13.0"
-pairing = "0.23.0"
-static_assertions = "1.1.0"
-rand = "0.8"
+group = { version = "0.13.0", default-features = false }
+pairing = { version = "0.23.0", default-features = false }
+subtle = { version = "2.5", default-features = false }
+
+static_assertions = { version = "1.1.0", default-features = false }
 rand_core = { version = "0.6", default-features = false }
-lazy_static = "1.4.0"
-num-bigint = "0.4.3"
-num-integer = "0.1.46"
-num-traits = "0.2"
-paste = "1.0.11"
+lazy_static = { version = "1.4.0", default-features = false, features = [
+    "spin_no_std",
+] }
+num-bigint = { version = "0.4.3", default-features = false }
+num-integer = { version = "0.1.46", default-features = false }
+num-traits = { version = "0.2", default-features = false }
+paste = { version = "1.0.11", default-features = false }
+hex = { version = "0.4", optional = true, default-features = false, features = [
+    "alloc",
+    "serde",
+] }
+sha2 = { version = "0.10.8", default-features = false }
+digest = { version = "0.10.7", default-features = false }
+
+plonky2_maybe_rayon = { version = "1.0.0", default-features = false }
+rayon = { version = "1.8", default-features = false, optional = true }
+
+libm = { version = "0.2.11", default-features = false }
+
 serde = { version = "1.0", default-features = false, optional = true }
-serde_arrays = { version = "0.1.0", optional = true }
-hex = { version = "0.4", optional = true, default-features = false, features = ["alloc", "serde"] }
-rayon = "1.8"
-unroll = "0.1.5"
-blake2 = "0.10.6"
-sha2 = "0.10.8"
-digest = "0.10.7"
+serde_arrays = { version = "0.2.0", optional = true }
 
 [features]
 default = ["bits"]
-asm = ["halo2derive/asm"]
+asm = ["halo2derive/asm", "std"]
 bits = ["ff/bits"]
 bn256-table = []
 derive_serde = ["serde/derive", "serde_arrays", "hex"]
 print-trace = ["ark-std/print-trace"]
+std = ["rayon", "halo2derive/std", "plonky2_maybe_rayon/parallel"]
+
 
 [profile.bench]
 opt-level = 3
@@ -83,6 +94,7 @@ harness = false
 [[bench]]
 name = "msm"
 harness = false
+required-features = ["std"]
 
 [[bench]]
 name = "pairing"

benches/curve.rs

@@ -9,7 +9,7 @@ use criterion::{black_box, criterion_group, criterion_main, Criterion, Throughpu
 use ff::Field;
 use group::prime::PrimeCurveAffine;
 use halo2curves::{bn256::G1, CurveExt};
-use rand::SeedableRng;
+use rand_core::SeedableRng;
 use rand_xorshift::XorShiftRng;
 
 fn bench_curve_ops<G: CurveExt>(c: &mut Criterion, name: &'static str) {

benches/fft.rs

@@ -18,7 +18,7 @@ use std::{ops::Range, time::SystemTime};
 use criterion::{BenchmarkId, Criterion};
 use group::ff::Field;
 use halo2curves::{bn256::Fr as Scalar, fft::best_fft};
-use rand::{RngCore, SeedableRng};
+use rand_core::{RngCore, SeedableRng};
 use rand_xorshift::XorShiftRng;
 
 const RANGE: Range<u32> = 3..19;

benches/field_arith.rs

@@ -11,7 +11,7 @@ use halo2curves::{
     ff::Field,
     ff_ext::Legendre,
 };
-use rand::{RngCore, SeedableRng};
+use rand_core::{RngCore, SeedableRng};
 use rand_xorshift::XorShiftRng;
 
 const SEED: [u8; 16] = [

benches/hash_to_curve.rs

@@ -5,12 +5,11 @@
 //!
 //!     cargo bench --bench hash_to_curve
 
-use std::iter;
+use core::iter;
 
 use criterion::{black_box, criterion_group, criterion_main, Criterion, Throughput};
 use halo2curves::{bn256::G1, CurveExt};
-use rand::SeedableRng;
-use rand_core::RngCore;
+use rand_core::{RngCore, SeedableRng};
 use rand_xorshift::XorShiftRng;
 
 const SEED: [u8; 16] = [

benches/pairing.rs

@@ -10,7 +10,7 @@ use ff::Field;
 use group::prime::PrimeCurveAffine;
 use halo2curves::bn256::Bn256;
 use pairing::Engine;
-use rand::SeedableRng;
+use rand_core::SeedableRng;
 use rand_xorshift::XorShiftRng;
 
 const SEED: [u8; 16] = [

derive/Cargo.toml

@@ -12,13 +12,15 @@ rust-version = "1.63.0"
 proc-macro = true
 
 [dependencies]
-num-bigint = "0.4"
-num-integer = "0.1"
-num-traits = "0.2"
-proc-macro2 = "1.0"
-quote = "1.0"
-syn = {version = "1.0", features = ["full"]}
+num-bigint = { version = "0.4", default-features = false }
+num-integer = { version = "0.1", default-features = false }
+num-traits = { version = "0.2", default-features = false }
+proc-macro2 = { version = "1.0", default-features = false }
+quote = { version = "1.0", default-features = false }
+syn = { version = "1.0", features = ["full"] }
+
 
 [features]
-default = []
+default = ["std"]
 asm = []
+std = []

derive/src/field/arith.rs

@@ -1,3 +1,8 @@
+#[cfg(not(feature = "std"))]
+extern crate alloc;
+#[cfg(not(feature = "std"))]
+use alloc::vec::Vec;
+
 use proc_macro2::TokenStream;
 use quote::{format_ident as fmtid, quote};
 

derive/src/field/asm/limb4.rs

@@ -2,7 +2,7 @@ use proc_macro2::TokenStream;
 
 pub(crate) fn impl_arith(field: &syn::Ident, inv: u64) -> TokenStream {
     quote::quote! {
-        use std::arch::asm;
+        use core::arch::asm;
         impl #field {
             /// Doubles this field element.
             #[inline]