feat: formatter utils

.github/workflows/test.yml

@@ -10,9 +10,7 @@ jobs:
       - name: Step 1 - Check out main branch
         uses: actions/checkout@v3
       - name: Step 2 - Getting scarb
-        uses: software-mansion/setup-scarb@v1
-        with:
-          scarb-version: 2.4.0-rc2
+        uses: software-mansion/setup-scarb@v1.3.2
       - name: Step 3 - Trying to build
         run: scarb build
 
@@ -24,9 +22,7 @@ jobs:
       - name: Step 1 - Check out main branch
         uses: actions/checkout@v3
       - name: Step 2 - Getting scarb
-        uses: software-mansion/setup-scarb@v1
-        with:
-          scarb-version: 2.4.0-rc2
+        uses: software-mansion/setup-scarb@v1.3.2
       - name: Step 3 - Running tests
         run: scarb test
 
@@ -38,8 +34,6 @@ jobs:
       - name: Step 1 - Check out main branch
         uses: actions/checkout@v3
       - name: Step 2 - Getting scarb
-        uses: software-mansion/setup-scarb@v1
-        with:
-          scarb-version: 2.4.0-rc2
+        uses: software-mansion/setup-scarb@v1.3.2
       - name: Step 3 - Checking formatting
         run: scarb fmt --check

.tool-versions

@@ -1 +1 @@
-scarb 2.4.0-rc2
+scarb 2.4.0

Scarb.lock

@@ -67,3 +67,7 @@ version = "0.1.0"
 [[package]]
 name = "alexandria_storage"
 version = "0.3.0"
+
+[[package]]
+name = "alexandria_utils"
+version = "0.1.0"

Scarb.toml

@@ -11,14 +11,15 @@ members = [
   "src/storage",
   "src/ascii",
   "src/bytes",
+  "src/utils",
 ]
 name = "alexandria"
 version = "0.1.0"
 description = "Community maintained Cairo and Starknet libraries"
 homepage = "https://github.com/keep-starknet-strange/alexandria/"
 
 [workspace.dependencies]
-starknet = ">=2.4.0-rc2"
+starknet = ">=2.4.0"
 
 [workspace.tool.fmt]
 sort-module-level-items = true

src/utils/README.md

@@ -0,0 +1,3 @@
+# Utils
+
+A set of utilities.

src/utils/Scarb.toml

@@ -0,0 +1,11 @@
+[package]
+name = "alexandria_utils"
+version = "0.1.0"
+description = "Cairo utilities"
+homepage = "https://github.com/keep-starknet-strange/alexandria/tree/src/utils"
+
+[tool]
+fmt.workspace = true
+
+[dependencies]
+starknet.workspace = true

src/utils/src/fmt.cairo

@@ -0,0 +1,67 @@
+use core::fmt::{Display, Debug, Formatter, Error};
+use starknet::{ContractAddress, EthAddress, ClassHash, StorageAddress, StorageBaseAddress};
+
+
+/// Display
+mod display_felt252_based {
+    use core::fmt::{Display, Formatter, Error};
+    use core::to_byte_array::AppendFormattedToByteArray;
+    impl TDisplay<T, +Into<T, felt252>, +Copy<T>> of Display<T> {
+        fn fmt(self: @T, ref f: Formatter) -> Result<(), Error> {
+            let value: felt252 = (*self).into();
+            Display::<u256>::fmt(@value.into(), ref f)
+        }
+    }
+}
+
+impl EthAddressDisplay = display_felt252_based::TDisplay<EthAddress>;
+impl ContractAddressDisplay = display_felt252_based::TDisplay<ContractAddress>;
+impl ClassHashDisplay = display_felt252_based::TDisplay<ClassHash>;
+impl StorageAddressDisplay = display_felt252_based::TDisplay<StorageAddress>;
+
+/// Debug
+mod debug_display_based {
+    use core::fmt::{Display, Debug, Formatter, Error};
+    use core::to_byte_array::AppendFormattedToByteArray;
+    impl TDebug<T, +Display<T>> of Debug<T> {
+        fn fmt(self: @T, ref f: Formatter) -> Result<(), Error> {
+            Display::fmt(self, ref f)
+        }
+    }
+}
+
+
+impl EthAddressDebug = debug_display_based::TDebug<EthAddress>;
+impl ContractAddressDebug = debug_display_based::TDebug<ContractAddress>;
+impl ClassHashDebug = debug_display_based::TDebug<ClassHash>;
+impl StorageAddressDebug = debug_display_based::TDebug<StorageAddress>;
+
+impl ArrayTDebug<T, +Display<T>, +Copy<T>> of Debug<Array<T>> {
+    fn fmt(self: @Array<T>, ref f: Formatter) -> Result<(), Error> {
+        Debug::fmt(@self.span(), ref f)
+    }
+}
+
+impl SpanTDebug<T, +Display<T>, +Copy<T>> of Debug<Span<T>> {
+    fn fmt(self: @Span<T>, ref f: Formatter) -> Result<(), Error> {
+        let mut self = *self;
+        write!(f, "[")?;
+        loop {
+            match self.pop_front() {
+                Option::Some(value) => {
+                    if Display::fmt(value, ref f).is_err() {
+                        break Result::Err(Error {});
+                    };
+                    if self.len() == 0 {
+                        break Result::Ok(());
+                    }
+                    if write!(f, ", ").is_err() {
+                        break Result::Err(Error {});
+                    };
+                },
+                Option::None => { break Result::Ok(()); }
+            };
+        }?;
+        write!(f, "]")
+    }
+}

src/utils/src/lib.cairo

@@ -0,0 +1 @@
+mod fmt;