Merge remote-tracking branch 'origin/main' into danlaine/contiguous-2

Author: danlaine

.github/workflows/benchmark.yml

@@ -52,6 +52,10 @@ jobs:
             cargo_flags: ""
             file_suffix: ""
             benchmark_name: "commonware-coding"
+          - package: commonware-formatting
+            cargo_flags: ""
+            file_suffix: ""
+            benchmark_name: "commonware-formatting"
           - package: commonware-utils
             cargo_flags: ""
             file_suffix: ""

.github/workflows/publish.yml

@@ -25,6 +25,11 @@ jobs:
       continue-on-error: true
       env:
         CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}
+    - name: Publish formatting
+      run: cargo publish --manifest-path formatting/Cargo.toml
+      continue-on-error: true
+      env:
+        CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}
     - name: Publish conformance-macros
       run: cargo publish --manifest-path conformance/macros/Cargo.toml
       continue-on-error: true

Cargo.lock

@@ -9,6 +9,7 @@ members = [
     "consensus",
     "cryptography",
     "deployer",
+    "formatting",
     "macros",
     "macros/impl",
     "math",
@@ -97,6 +98,7 @@ commonware-conformance-macros = { version = "2026.4.0", path = "conformance/macr
 commonware-consensus = { version = "2026.4.0", path = "consensus" }
 commonware-cryptography = { version = "2026.4.0", path = "cryptography", default-features = false }
 commonware-deployer = { version = "2026.4.0", path = "deployer", default-features = false }
+commonware-formatting = { version = "2026.4.0", path = "formatting", default-features = false }
 commonware-invariants = { version = "2026.4.0", path = "invariants" }
 commonware-macros = { version = "2026.4.0", path = "macros", default-features = false }
 commonware-macros-impl = { version = "2026.4.0", path = "macros/impl" }
@@ -110,6 +112,7 @@ commonware-storage = { version = "2026.4.0", path = "storage", default-features
 commonware-stream = { version = "2026.4.0", path = "stream" }
 commonware-utils = { version = "2026.4.0", path = "utils", default-features = false }
 console-subscriber = "0.5.0"
+const-hex = { version = "1.18.1", default-features = false }
 crc = "3.4.0"
 crc-fast = { version = "1.10.0", default-features = false }
 criterion = "0.7.0"

Cargo.toml

@@ -48,6 +48,7 @@ _Sometimes, we opt to maintain software that is neither a primitive nor an examp
 
 * [docs](./docs): Access information about Commonware at https://commonware.xyz.
 * [docker](./docker): Dockerfiles used for cross-compilation and CI.
+* [formatting](./formatting/README.md): Format and parse encoded data.
 * [invariants](./invariants/README.md): Define and exercise invariants.
 * [macros](./macros/README.md): Augment the development of primitives with procedural macros.
 * [mcp](./mcp/README.md): Interact with the Commonware Library via MCP at https://mcp.commonware.xyz.

README.md

@@ -106,7 +106,7 @@ impl<T: Read> Lazy<T> {
                 }
             } else {
                 Self {
-                    value: T::decode_cfg(bytes.clone(), &cfg).ok(),
+                    value: T::decode_cfg(bytes.as_ref(), &cfg).ok(),
                     pending: Some(Pending { bytes, cfg }),
                 }
             }
@@ -130,7 +130,7 @@ impl<T: Read> Lazy<T> {
                             .pending
                             .as_ref()
                             .expect("Lazy should have pending if value is not initialized");
-                        T::decode_cfg(bytes.clone(), cfg).ok()
+                        T::decode_cfg(bytes.as_ref(), cfg).ok()
                     })
                     .as_ref()
             } else {

codec/src/types/lazy.rs

@@ -14,6 +14,7 @@ workspace = true
 
 [dependencies]
 commonware-conformance-macros.workspace = true
+commonware-formatting.workspace = true
 commonware-macros.workspace = true
 futures.workspace = true
 serde = { workspace = true, features = ["derive"] }

conformance/Cargo.toml

@@ -143,17 +143,6 @@ impl ConformanceFile {
     }
 }
 
-/// Encode bytes as a lowercase hex string.
-fn hex_encode(bytes: &[u8]) -> String {
-    const HEX_CHARS: &[u8; 16] = b"0123456789abcdef";
-    let mut result = String::with_capacity(bytes.len() * 2);
-    for &byte in bytes {
-        result.push(HEX_CHARS[(byte >> 4) as usize] as char);
-        result.push(HEX_CHARS[(byte & 0x0f) as usize] as char);
-    }
-    result
-}
-
 /// Acquire an exclusive lock on the conformance file.
 ///
 /// Uses OS-level file locking which is automatically released when the
@@ -188,7 +177,7 @@ pub async fn compute_conformance_hash<C: Conformance>(n_cases: usize) -> String
         hasher.update(&committed);
     }
 
-    hex_encode(&hasher.finalize())
+    commonware_formatting::hex(&hasher.finalize())
 }
 
 /// Run conformance tests using the [`Conformance`] trait.
@@ -341,14 +330,6 @@ async fn regenerate_conformance<C: Conformance>(type_name: &str, n_cases: usize,
 mod tests {
     use super::*;
 
-    #[test]
-    fn test_hex_encode() {
-        assert_eq!(hex_encode(&[]), "");
-        assert_eq!(hex_encode(&[0x00]), "00");
-        assert_eq!(hex_encode(&[0xff]), "ff");
-        assert_eq!(hex_encode(&[0x12, 0x34, 0xab, 0xcd]), "1234abcd");
-    }
-
     // Test conformance trait with a simple implementation
     struct SimpleConformance;
 

conformance/src/lib.rs

@@ -21,6 +21,7 @@ commonware-broadcast.workspace = true
 commonware-codec.workspace = true
 commonware-coding.workspace = true
 commonware-cryptography.workspace = true
+commonware-formatting.workspace = true
 commonware-macros.workspace = true
 commonware-math.workspace = true
 commonware-parallel.workspace = true

consensus/Cargo.toml

@@ -848,13 +848,13 @@ commonware_macros::stability_scope!(ALPHA {
 
         impl core::fmt::Display for Commitment {
             fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
-                write!(f, "{}", commonware_utils::hex(self.as_ref()))
+                write!(f, "{}", commonware_formatting::Hex(self.as_ref()))
             }
         }
 
         impl core::fmt::Debug for Commitment {
             fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
-                write!(f, "{}", commonware_utils::hex(self.as_ref()))
+                write!(f, "{}", commonware_formatting::Hex(self.as_ref()))
             }
         }
 
@@ -1737,13 +1737,13 @@ mod tests {
 
         impl core::fmt::Display for Digest {
             fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
-                write!(f, "{}", commonware_utils::hex(self.as_ref()))
+                write!(f, "{}", commonware_formatting::Hex(self.as_ref()))
             }
         }
 
         impl core::fmt::Debug for Digest {
             fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
-                write!(f, "Digest({})", commonware_utils::hex(self.as_ref()))
+                write!(f, "Digest({})", commonware_formatting::Hex(self.as_ref()))
             }
         }