feat: no_std support for starknet-core (#428)

Adds a new `std` feature to `starknet-core` that's enabled by default.
When disabled, the crate compiles in a `no_std` environment.

Author: xJonathanLEI

.github/workflows/test.yaml

@@ -168,3 +168,9 @@ jobs:
             --target thumbv6m-none-eabi \
             --no-default-features \
             --features alloc
+
+      - name: Build starknet-core
+        run: |
+          cargo build --package starknet-core \
+            --target thumbv6m-none-eabi \
+            --no-default-features

starknet-core/Cargo.toml

@@ -16,18 +16,16 @@ keywords = ["ethereum", "starknet", "web3"]
 all-features = true
 
 [dependencies]
-starknet-crypto = { version = "0.5.1", path = "../starknet-crypto" }
-starknet-ff = { version = "0.3.4", path = "../starknet-ff", features = [
-    "serde",
-] }
-base64 = "0.21.0"
-flate2 = "1.0.25"
-hex = "0.4.3"
-serde = { version = "1.0.160", features = ["derive"] }
+starknet-crypto = { version = "0.5.1", path = "../starknet-crypto", default-features = false, features = [ "alloc" ] }
+starknet-ff = { version = "0.3.4", path = "../starknet-ff", default-features = false, features = ["serde"] }
+base64 = { version = "0.21.0", default-features = false, features = ["alloc"] }
+flate2 = { version = "1.0.25", optional = true }
+hex = { version = "0.4.3", default-features = false }
+serde = { version = "1.0.160", default-features = false, features = ["derive"] }
 serde_json = { version = "1.0.96", default-features = false, features = ["alloc", "raw_value"] }
 serde_json_pythonic = { version = "0.1.2", default-features = false, features = ["alloc", "raw_value"] }
-serde_with = "2.3.2"
-sha3 = "0.10.7"
+serde_with = { version = "2.3.2", default-features = false, features = ["alloc", "macros"] }
+sha3 = { version = "0.10.7", default-features = false }
 
 [dev-dependencies]
 criterion = { version = "0.4.0", default-features = false }
@@ -37,7 +35,8 @@ starknet-core = { path = ".", features = ["no_unknown_fields"] }
 wasm-bindgen-test = "0.3.34"
 
 [features]
-default = ["bigdecimal"]
+default = ["std", "bigdecimal"]
+std = ["dep:flate2", "starknet-ff/std", "starknet-crypto/std"]
 bigdecimal = ["starknet-ff/bigdecimal", "starknet-crypto/bigdecimal"]
 no_unknown_fields = []
 

starknet-core/src/crypto.rs

@@ -5,7 +5,6 @@ use starknet_crypto::{rfc6979_generate_k, sign, verify, SignError, VerifyError};
 
 mod errors {
     use core::fmt::{Display, Formatter, Result};
-    use std::error::Error;
 
     #[derive(Debug)]
     pub enum EcdsaSignError {
@@ -20,7 +19,8 @@ mod errors {
         SignatureSOutOfRange,
     }
 
-    impl Error for EcdsaSignError {}
+    #[cfg(feature = "std")]
+    impl std::error::Error for EcdsaSignError {}
 
     impl Display for EcdsaSignError {
         fn fmt(&self, f: &mut Formatter<'_>) -> Result {
@@ -30,7 +30,8 @@ mod errors {
         }
     }
 
-    impl Error for EcdsaVerifyError {}
+    #[cfg(feature = "std")]
+    impl std::error::Error for EcdsaVerifyError {}
 
     impl Display for EcdsaVerifyError {
         fn fmt(&self, f: &mut Formatter<'_>) -> Result {

starknet-core/src/lib.rs

@@ -1,3 +1,4 @@
+#![cfg_attr(not(feature = "std"), no_std)]
 #![allow(clippy::comparison_chain)]
 #![doc = include_str!("../README.md")]
 
@@ -10,3 +11,5 @@ pub mod crypto;
 pub mod utils;
 
 pub mod chain_id;
+
+extern crate alloc;

starknet-core/src/serde/byte_array.rs

@@ -1,4 +1,6 @@
 pub mod base64 {
+    use alloc::{format, string::String, vec::Vec};
+
     use base64::{engine::general_purpose::STANDARD, Engine};
     use serde::{Deserialize, Deserializer, Serializer};
 

starknet-core/src/serde/num_hex.rs

@@ -1,4 +1,6 @@
 pub mod u64 {
+    use alloc::{format, string::String};
+
     use serde::{Deserialize, Deserializer, Serializer};
 
     pub fn serialize<S>(value: &u64, serializer: S) -> Result<S::Ok, S::Error>

starknet-core/src/serde/unsigned_field_element.rs

@@ -1,3 +1,5 @@
+use alloc::{format, string::String};
+
 use serde::{de::Error as DeError, Deserialize, Deserializer, Serializer};
 use serde_with::{DeserializeAs, SerializeAs};
 

starknet-core/src/types/codegen.rs

@@ -3,7 +3,7 @@
 //     https://github.com/xJonathanLEI/starknet-jsonrpc-codegen
 
 // Code generated with version:
-//     https://github.com/xJonathanLEI/starknet-jsonrpc-codegen#73397c9d87962949675bca8fdc08faa88aa8ffb4
+//     https://github.com/xJonathanLEI/starknet-jsonrpc-codegen#5dbdcd62529ab8e3af4e9ef752945f8ae7e85ab9
 
 // Code generation requested but not implemented for these types:
 // - `BLOCK_ID`
@@ -18,7 +18,7 @@
 // - `TXN`
 // - `TXN_RECEIPT`
 
-use std::sync::Arc;
+use alloc::{format, string::String, vec::Vec};
 
 use serde::{Deserialize, Deserializer, Serialize, Serializer};
 use serde_with::serde_as;
@@ -30,6 +30,11 @@ use crate::{
 
 use super::{serde_impls::NumAsHex, *};
 
+#[cfg(all(not(no_rc), not(no_sync), target_has_atomic = "ptr"))]
+pub type OwnedPtr<T> = alloc::sync::Arc<T>;
+#[cfg(not(all(not(no_rc), not(no_sync), target_has_atomic = "ptr")))]
+pub type OwnedPtr<T> = alloc::boxed::Box<T>;
+
 /// Block status.
 ///
 /// The status of the block.
@@ -127,7 +132,7 @@ pub struct BroadcastedDeclareTransactionV1 {
     /// Nonce
     pub nonce: FieldElement,
     /// The class to be declared
-    pub contract_class: Arc<CompressedLegacyContractClass>,
+    pub contract_class: OwnedPtr<CompressedLegacyContractClass>,
     /// The address of the account contract sending the declaration transaction
     pub sender_address: FieldElement,
 }
@@ -144,7 +149,7 @@ pub struct BroadcastedDeclareTransactionV2 {
     /// Nonce
     pub nonce: FieldElement,
     /// The class to be declared
-    pub contract_class: Arc<FlattenedSierraClass>,
+    pub contract_class: OwnedPtr<FlattenedSierraClass>,
     /// The address of the account contract sending the declaration transaction
     pub sender_address: FieldElement,
     /// The hash of the cairo assembly resulting from the sierra compilation
@@ -1016,10 +1021,11 @@ pub enum StarknetError {
     ClassAlreadyDeclared,
 }
 
+#[cfg(feature = "std")]
 impl std::error::Error for StarknetError {}
 
-impl std::fmt::Display for StarknetError {
-    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+impl core::fmt::Display for StarknetError {
+    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
         match self {
             Self::FailedToReceiveTransaction => write!(f, "Failed to write transaction"),
             Self::ContractNotFound => write!(f, "Contract not found"),
@@ -1481,7 +1487,7 @@ impl<'de> Deserialize<'de> for BroadcastedDeclareTransactionV1 {
             max_fee: tagged.max_fee,
             signature: tagged.signature,
             nonce: tagged.nonce,
-            contract_class: Arc::new(tagged.contract_class),
+            contract_class: OwnedPtr::new(tagged.contract_class),
             sender_address: tagged.sender_address,
         })
     }
@@ -1565,7 +1571,7 @@ impl<'de> Deserialize<'de> for BroadcastedDeclareTransactionV2 {
             max_fee: tagged.max_fee,
             signature: tagged.signature,
             nonce: tagged.nonce,
-            contract_class: Arc::new(tagged.contract_class),
+            contract_class: OwnedPtr::new(tagged.contract_class),
             sender_address: tagged.sender_address,
             compiled_class_hash: tagged.compiled_class_hash,
         })

starknet-core/src/types/contract/legacy.rs

@@ -1,23 +1,28 @@
+use alloc::{boxed::Box, collections::BTreeMap, format, string::String, vec::Vec};
+
 use crate::{
     crypto::compute_hash_on_elements,
     serde::{num_hex::u64 as u64_hex, unsigned_field_element::UfeHex},
     types::{
-        contract::{CompressProgramError, ComputeClassHashError, JsonError},
-        CompressedLegacyContractClass, FieldElement, FunctionStateMutability,
-        LegacyContractAbiEntry, LegacyContractEntryPoint, LegacyEntryPointsByType,
-        LegacyEventAbiEntry, LegacyEventAbiType, LegacyFunctionAbiEntry, LegacyFunctionAbiType,
-        LegacyStructAbiEntry, LegacyStructAbiType, LegacyStructMember, LegacyTypedParameter,
+        contract::{ComputeClassHashError, JsonError},
+        FieldElement, FunctionStateMutability, LegacyContractAbiEntry, LegacyContractEntryPoint,
+        LegacyEntryPointsByType, LegacyEventAbiEntry, LegacyEventAbiType, LegacyFunctionAbiEntry,
+        LegacyFunctionAbiType, LegacyStructAbiEntry, LegacyStructAbiType, LegacyStructMember,
+        LegacyTypedParameter,
     },
     utils::{cairo_short_string_to_felt, starknet_keccak},
 };
 
-use flate2::{write::GzEncoder, Compression};
 use serde::{
     de::Error as DeError, ser::SerializeSeq, Deserialize, Deserializer, Serialize, Serializer,
 };
 use serde_json_pythonic::to_string_pythonic;
 use serde_with::{serde_as, SerializeAs};
-use std::{collections::BTreeMap, io::Write};
+
+#[cfg(feature = "std")]
+use crate::types::{contract::CompressProgramError, CompressedLegacyContractClass};
+#[cfg(feature = "std")]
+use flate2::{write::GzEncoder, Compression};
 
 const API_VERSION: FieldElement = FieldElement::ZERO;
 
@@ -396,13 +401,13 @@ impl<'de> Deserialize<'de> for RawLegacyAbiEntry {
 
 impl LegacyContractClass {
     pub fn class_hash(&self) -> Result<FieldElement, ComputeClassHashError> {
-        let mut elements = vec![];
+        let mut elements = Vec::new();
 
         elements.push(API_VERSION);
 
         // Hashes external entry points
         elements.push({
-            let mut buffer = vec![];
+            let mut buffer = Vec::new();
             for entrypoint in self.entry_points_by_type.external.iter() {
                 buffer.push(entrypoint.selector);
                 buffer.push(entrypoint.offset.into());
@@ -412,7 +417,7 @@ impl LegacyContractClass {
 
         // Hashes L1 handler entry points
         elements.push({
-            let mut buffer = vec![];
+            let mut buffer = Vec::new();
             for entrypoint in self.entry_points_by_type.l1_handler.iter() {
                 buffer.push(entrypoint.selector);
                 buffer.push(entrypoint.offset.into());
@@ -422,7 +427,7 @@ impl LegacyContractClass {
 
         // Hashes constructor entry points
         elements.push({
-            let mut buffer = vec![];
+            let mut buffer = Vec::new();
             for entrypoint in self.entry_points_by_type.constructor.iter() {
                 buffer.push(entrypoint.selector);
                 buffer.push(entrypoint.offset.into());
@@ -474,6 +479,7 @@ impl LegacyContractClass {
         Ok(starknet_keccak(serialized.as_bytes()))
     }
 
+    #[cfg(feature = "std")]
     pub fn compress(&self) -> Result<CompressedLegacyContractClass, CompressProgramError> {
         Ok(CompressedLegacyContractClass {
             program: self.program.compress()?,
@@ -490,7 +496,10 @@ impl LegacyContractClass {
 }
 
 impl LegacyProgram {
+    #[cfg(feature = "std")]
     pub fn compress(&self) -> Result<Vec<u8>, CompressProgramError> {
+        use std::io::Write;
+
         #[serde_as]
         #[derive(Serialize)]
         pub struct ProgramWithoutDebugInfo<'a> {

starknet-core/src/types/contract/mod.rs

@@ -1,3 +1,5 @@
+use alloc::{format, string::String, vec::Vec};
+
 use serde::{ser::SerializeSeq, Deserialize, Deserializer, Serialize, Serializer};
 use serde_json_pythonic::to_string_pythonic;
 use serde_with::serde_as;
@@ -239,15 +241,16 @@ pub enum EventFieldKind {
 }
 
 mod errors {
+    use alloc::string::String;
     use core::fmt::{Display, Formatter, Result};
-    use std::error::Error;
 
     #[derive(Debug)]
     pub enum ComputeClassHashError {
         InvalidBuiltinName,
         Json(JsonError),
     }
 
+    #[cfg(feature = "std")]
     #[derive(Debug)]
     pub enum CompressProgramError {
         Json(JsonError),
@@ -259,7 +262,8 @@ mod errors {
         pub(crate) message: String,
     }
 
-    impl Error for ComputeClassHashError {}
+    #[cfg(feature = "std")]
+    impl std::error::Error for ComputeClassHashError {}
 
     impl Display for ComputeClassHashError {
         fn fmt(&self, f: &mut Formatter<'_>) -> Result {
@@ -270,8 +274,10 @@ mod errors {
         }
     }
 
-    impl Error for CompressProgramError {}
+    #[cfg(feature = "std")]
+    impl std::error::Error for CompressProgramError {}
 
+    #[cfg(feature = "std")]
     impl Display for CompressProgramError {
         fn fmt(&self, f: &mut Formatter<'_>) -> Result {
             match self {
@@ -281,15 +287,19 @@ mod errors {
         }
     }
 
-    impl Error for JsonError {}
+    #[cfg(feature = "std")]
+    impl std::error::Error for JsonError {}
 
     impl Display for JsonError {
         fn fmt(&self, f: &mut Formatter<'_>) -> Result {
             write!(f, "{}", self.message)
         }
     }
 }
-pub use errors::{CompressProgramError, ComputeClassHashError, JsonError};
+pub use errors::{ComputeClassHashError, JsonError};
+
+#[cfg(feature = "std")]
+pub use errors::CompressProgramError;
 
 impl SierraClass {
     pub fn class_hash(&self) -> Result<FieldElement, ComputeClassHashError> {