feat: introduce no_std support for ff and crypto

AbdelStark · tdelabro · commit 6614cf5265cf · 2023-02-23T14:11:48.000+01:00
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -48,4 +48,7 @@ url = "2.2.2"
 [features]
 default = ["bigdecimal"]
 bigdecimal = ["starknet-core/bigdecimal"]
-no_unknown_fields = ["starknet-core/no_unknown_fields", "starknet-providers/no_unknown_fields"]
+no_unknown_fields = [
+    "starknet-core/no_unknown_fields",
+    "starknet-providers/no_unknown_fields",
+]
diff --git a/starknet-core/Cargo.toml b/starknet-core/Cargo.toml
@@ -17,7 +17,9 @@ all-features = true
 
 [dependencies]
 starknet-crypto = { version = "0.2.0", path = "../starknet-crypto" }
-starknet-ff = { version = "0.2.0", path = "../starknet-ff", default-features = false }
+starknet-ff = { version = "0.2.0", path = "../starknet-ff", features = [
+    "serde",
+] }
 base64 = "0.13.0"
 ethereum-types = "0.12.1"
 flate2 = "1.0.24"
@@ -37,7 +39,7 @@ wasm-bindgen-test = "0.3.29"
 
 [features]
 default = ["bigdecimal"]
-bigdecimal = ["starknet-ff/bigdecimal"]
+bigdecimal = ["starknet-ff/bigdecimal", "starknet-crypto/bigdecimal"]
 no_unknown_fields = []
 
 [[bench]]
diff --git a/starknet-crypto-codegen/Cargo.toml b/starknet-crypto-codegen/Cargo.toml
@@ -10,12 +10,12 @@ homepage = "https://starknet.rs/"
 description = """
 Codegen macros for `starknet-crypto`
 """
-keywords = ["ethereum", "starknet", "web3"]
+keywords = ["ethereum", "starknet", "web3", "no_std"]
 
 [lib]
 proc-macro = true
 
 [dependencies]
-starknet-curve = { version = "0.1.0", path = "../starknet-curve" }
-starknet-ff = { version = "0.2.0", path = "../starknet-ff" }
-syn = "1.0.96"
+starknet-curve = { version = "0.1.0", path = "../starknet-curve", default-features = false }
+starknet-ff = { version = "0.2.0", path = "../starknet-ff", default-features = false }
+syn = { version = "1.0.96", default-features = false }
diff --git a/starknet-crypto/Cargo.toml b/starknet-crypto/Cargo.toml
@@ -10,22 +10,29 @@ homepage = "https://starknet.rs/"
 description = """
 Low-level cryptography utilities for Starknet
 """
-keywords = ["ethereum", "starknet", "web3"]
+keywords = ["ethereum", "starknet", "web3", "no_std"]
 
 [dependencies]
 starknet-crypto-codegen = { version = "0.1.0", path = "../starknet-crypto-codegen" }
 starknet-curve = { version = "0.1.0", path = "../starknet-curve" }
-starknet-ff = { version = "0.2.0", path = "../starknet-ff" }
-crypto-bigint = "0.4.9"
-hmac = "0.12.1"
-num-bigint = "0.4.3"
-num-integer = "0.1.44"
-num-traits = "0.2.14"
-rfc6979 = "0.3.1"
-sha2 = "0.10.6"
-thiserror = "1.0.30"
-zeroize = "1.5.0"
-hex = "0.4.3"
+starknet-ff = { version = "0.2.0", path = "../starknet-ff", default-features = false }
+crypto-bigint = { version = "0.4.9", default-features = false }
+hmac = { version = "0.12.1", default-features = false }
+num-bigint = { version = "0.4.3", default-features = false }
+num-integer = { version = "0.1.44", default-features = false }
+num-traits = { version = "0.2.14", default-features = false }
+rfc6979 = { version = "0.3.1", default-features = false }
+sha2 = { version = "0.10.6", default-features = false }
+zeroize = { version = "1.5.0", default-features = false }
+hashbrown = { version = "0.13.2", default-features = false }
+hex = { version = "0.4.3", default-features = false, optional = true }
+
+[features]
+default = ["std"]
+std = []
+alloc = ["hex?/alloc"]
+signature-display = ["dep:hex", "alloc"]
+bigdecimal = ["starknet-curve/bigdecimal", "starknet-ff/bigdecimal"]
 
 [dev-dependencies]
 criterion = { version = "0.4.0", default-features = false }
diff --git a/starknet-crypto/src/ecdsa.rs b/starknet-crypto/src/ecdsa.rs
@@ -7,7 +7,6 @@ use crate::{
     fe_utils::{add_unbounded, bigint_mul_mod_floor, mod_inverse, mul_mod_floor},
     FieldElement, SignError, VerifyError,
 };
-use std::fmt;
 
 const ELEMENT_UPPER_BOUND: FieldElement = FieldElement::from_mont([
     18446743986131435553,
@@ -25,8 +24,9 @@ pub struct Signature {
     pub s: FieldElement,
 }
 
-impl fmt::Display for Signature {
-    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+#[cfg(feature = "hex")]
+impl crate::stdlib::fmt::Display for Signature {
+    fn fmt(&self, f: &mut crate::stdlib::fmt::Formatter) -> crate::stdlib::fmt::Result {
         write!(
             f,
             "{}{}",
diff --git a/starknet-crypto/src/error.rs b/starknet-crypto/src/error.rs
@@ -1,19 +1,45 @@
-/// Errors when performing ECDSA [`sign`](fn.sign) operations
-#[derive(Debug, thiserror::Error)]
-pub enum SignError {
-    #[error("Invalid message hash")]
-    InvalidMessageHash,
-    #[error("Invalid k")]
-    InvalidK,
+mod sign_error {
+    /// Errors when performing ECDSA [`sign`](fn.sign) operations
+    #[derive(Debug)]
+    pub enum SignError {
+        InvalidMessageHash,
+        InvalidK,
+    }
+
+    #[cfg(feature = "std")]
+    impl std::error::Error for SignError {}
+
+    impl core::fmt::Display for SignError {
+        fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
+            match self {
+                Self::InvalidMessageHash => write!(f, "Invalid message hash"),
+                Self::InvalidK => write!(f, "Invalid k"),
+            }
+        }
+    }
 }
+pub use sign_error::SignError;
+
+mod verify_error {
+    /// Errors when performing ECDSA [`verify`](fn.verify) operations
+    #[derive(Debug)]
+    pub enum VerifyError {
+        InvalidMessageHash,
+        InvalidR,
+        InvalidS,
+    }
+
+    #[cfg(feature = "std")]
+    impl std::error::Error for VerifyError {}
 
-/// Errors when performing ECDSA [`verify`](fn.verify) operations
-#[derive(Debug, thiserror::Error)]
-pub enum VerifyError {
-    #[error("Invalid message hash")]
-    InvalidMessageHash,
-    #[error("Invalid r")]
-    InvalidR,
-    #[error("Invalid s")]
-    InvalidS,
+    impl core::fmt::Display for VerifyError {
+        fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
+            match self {
+                Self::InvalidMessageHash => write!(f, "Invalid message hash"),
+                Self::InvalidR => write!(f, "Invalid r"),
+                Self::InvalidS => write!(f, "Invalid s"),
+            }
+        }
+    }
 }
+pub use verify_error::VerifyError;
diff --git a/starknet-crypto/src/fe_utils.rs b/starknet-crypto/src/fe_utils.rs
@@ -1,7 +1,8 @@
+use core::ops::{Add, Mul};
+
 use num_bigint::BigInt;
 use num_integer::Integer;
 use num_traits::{One, Zero};
-use std::ops::{Add, Mul};
 
 use crate::FieldElement;
 
diff --git a/starknet-crypto/src/lib.rs b/starknet-crypto/src/lib.rs
@@ -1,5 +1,9 @@
+#![cfg_attr(not(feature = "std"), no_std)]
 #![doc = include_str!("../README.md")]
 
+#[cfg(any(test, feature = "alloc"))]
+extern crate alloc;
+
 mod ecdsa;
 mod error;
 mod fe_utils;
diff --git a/starknet-crypto/src/rfc6979.rs b/starknet-crypto/src/rfc6979.rs
@@ -81,15 +81,16 @@ where
 mod tests {
     use super::*;
     use crate::test_utils::field_element_from_be_hex;
+    use alloc::vec::Vec;
 
     use serde::Deserialize;
 
     #[derive(Deserialize)]
-    struct Rfc6979TestVecotr {
-        msg_hash: String,
-        priv_key: String,
-        seed: String,
-        k: String,
+    struct Rfc6979TestVecotr<'a> {
+        msg_hash: &'a str,
+        priv_key: &'a str,
+        seed: &'a str,
+        k: &'a str,
     }
 
     #[test]
@@ -110,10 +111,10 @@ mod tests {
         let test_vectors: Vec<Rfc6979TestVecotr> = serde_json::from_str(json_str).unwrap();
 
         for test_vector in test_vectors.iter() {
-            let msg_hash = field_element_from_be_hex(&test_vector.msg_hash);
-            let priv_key = field_element_from_be_hex(&test_vector.priv_key);
-            let seed = field_element_from_be_hex(&test_vector.seed);
-            let expected_k = field_element_from_be_hex(&test_vector.k);
+            let msg_hash = field_element_from_be_hex(test_vector.msg_hash);
+            let priv_key = field_element_from_be_hex(test_vector.priv_key);
+            let seed = field_element_from_be_hex(test_vector.seed);
+            let expected_k = field_element_from_be_hex(test_vector.k);
 
             let k = generate_k(&msg_hash, &priv_key, Some(&seed));
 
diff --git a/starknet-curve/Cargo.toml b/starknet-curve/Cargo.toml
@@ -10,7 +10,10 @@ homepage = "https://starknet.rs/"
 description = """
 Stark curve
 """
-keywords = ["ethereum", "starknet", "web3"]
+keywords = ["ethereum", "starknet", "web3", "no_std"]
 
 [dependencies]
-starknet-ff = { version = "0.2.0", path = "../starknet-ff" }
+starknet-ff = { version = "0.2.0", path = "../starknet-ff", default-features = false }
+
+[features]
+bigdecimal = ["starknet-ff/bigdecimal"]
diff --git a/starknet-curve/src/ec_point.rs b/starknet-curve/src/ec_point.rs
diff --git a/starknet-curve/src/lib.rs b/starknet-curve/src/lib.rs
diff --git a/starknet-ff/Cargo.toml b/starknet-ff/Cargo.toml
diff --git a/starknet-ff/src/lib.rs b/starknet-ff/src/lib.rs
