Merge pull request #2 from n0-computer/refactor-switch-to-hex

refactor: switch to hex

Author: rklaehn

Cargo.lock

@@ -84,6 +84,7 @@ testresult = "0.4.1"
 nested_enum_utils = "0.1.0"
 iroh-io = "0.6.1"
 testdir = "0.9.1"
+data-encoding = "2.6.0"
 
 [features]
 default = ["net", "metrics", "engine", "rpc", "test-utils"]

Cargo.toml

@@ -342,7 +342,7 @@ impl LiveEvent {
 /// engine. Changing the default author will not be persisted.
 ///
 /// If set to `Persistent`, the default author will be loaded from and persisted to the specified
-/// path (as base32 encoded string of the author's public key).
+/// path (as hex encoded string of the author's public key).
 #[derive(Debug)]
 pub enum DefaultAuthorStorage {
     /// Memory storage.

src/engine.rs

@@ -3,7 +3,6 @@
 use std::{cmp::Ordering, fmt, str::FromStr};
 
 use ed25519_dalek::{Signature, SignatureError, Signer, SigningKey, VerifyingKey};
-use iroh_base::base32;
 use rand_core::CryptoRngCore;
 use serde::{Deserialize, Serialize};
 
@@ -160,37 +159,37 @@ impl NamespacePublicKey {
 
 impl fmt::Display for Author {
     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
-        write!(f, "{}", base32::fmt(self.to_bytes()))
+        write!(f, "{}", hex::encode(self.to_bytes()))
     }
 }
 
 impl fmt::Display for NamespaceSecret {
     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
-        write!(f, "{}", base32::fmt(self.to_bytes()))
+        write!(f, "{}", hex::encode(self.to_bytes()))
     }
 }
 
 impl fmt::Display for AuthorPublicKey {
     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
-        write!(f, "{}", base32::fmt(self.as_bytes()))
+        write!(f, "{}", hex::encode(self.as_bytes()))
     }
 }
 
 impl fmt::Display for NamespacePublicKey {
     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
-        write!(f, "{}", base32::fmt(self.as_bytes()))
+        write!(f, "{}", hex::encode(self.as_bytes()))
     }
 }
 
 impl fmt::Display for AuthorId {
     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
-        write!(f, "{}", base32::fmt(self.as_bytes()))
+        write!(f, "{}", hex::encode(self.as_bytes()))
     }
 }
 
 impl fmt::Display for NamespaceId {
     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
-        write!(f, "{}", base32::fmt(self.as_bytes()))
+        write!(f, "{}", hex::encode(self.as_bytes()))
     }
 }
 
@@ -202,13 +201,13 @@ impl fmt::Debug for NamespaceSecret {
 
 impl fmt::Debug for NamespaceId {
     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
-        write!(f, "NamespaceId({})", base32::fmt_short(self.0))
+        write!(f, "NamespaceId({})", hex::encode(self.0))
     }
 }
 
 impl fmt::Debug for AuthorId {
     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
-        write!(f, "AuthorId({})", base32::fmt_short(self.0))
+        write!(f, "AuthorId({})", hex::encode(self.0))
     }
 }
 
@@ -230,35 +229,41 @@ impl fmt::Debug for AuthorPublicKey {
     }
 }
 
+fn parse_hex_array(s: &str) -> anyhow::Result<[u8; 32]> {
+    let mut bytes = [0u8; 32];
+    hex::decode_to_slice(s, &mut bytes)?;
+    Ok(bytes)
+}
+
 impl FromStr for Author {
     type Err = anyhow::Error;
 
     fn from_str(s: &str) -> Result<Self, Self::Err> {
-        Ok(Self::from_bytes(&base32::parse_array(s)?))
+        Ok(Self::from_bytes(&parse_hex_array(s)?))
     }
 }
 
 impl FromStr for NamespaceSecret {
     type Err = anyhow::Error;
 
     fn from_str(s: &str) -> Result<Self, Self::Err> {
-        Ok(Self::from_bytes(&base32::parse_array(s)?))
+        Ok(Self::from_bytes(&parse_hex_array(s)?))
     }
 }
 
 impl FromStr for AuthorPublicKey {
     type Err = anyhow::Error;
 
     fn from_str(s: &str) -> Result<Self, Self::Err> {
-        Self::from_bytes(&base32::parse_array(s)?).map_err(Into::into)
+        Self::from_bytes(&parse_hex_array(s)?).map_err(Into::into)
     }
 }
 
 impl FromStr for NamespacePublicKey {
     type Err = anyhow::Error;
 
     fn from_str(s: &str) -> Result<Self, Self::Err> {
-        Self::from_bytes(&base32::parse_array(s)?).map_err(Into::into)
+        Self::from_bytes(&parse_hex_array(s)?).map_err(Into::into)
     }
 }
 
@@ -386,10 +391,10 @@ impl AuthorId {
         AuthorPublicKey::from_bytes(&self.0)
     }
 
-    /// Convert to a base32 string limited to the first 10 bytes for a friendly string
+    /// Convert to a hex string limited to the first 10 bytes for a friendly string
     /// representation of the key.
     pub fn fmt_short(&self) -> String {
-        base32::fmt_short(self.0)
+        hex::encode(self.0).chars().take(10).collect()
     }
 }
 
@@ -421,10 +426,10 @@ impl NamespaceId {
         NamespacePublicKey::from_bytes(&self.0)
     }
 
-    /// Convert to a base32 string limited to the first 10 bytes for a friendly string
+    /// Convert to a hex string limited to the first 10 bytes for a friendly string
     /// representation of the key.
     pub fn fmt_short(&self) -> String {
-        base32::fmt_short(self.0)
+        hex::encode(self.0).chars().take(10).collect()
     }
 }
 

src/keys.rs

@@ -16,7 +16,7 @@ use std::{
 
 use bytes::{Bytes, BytesMut};
 use ed25519_dalek::{Signature, SignatureError};
-use iroh_base::{base32, hash::Hash};
+use iroh_base::hash::Hash;
 #[cfg(feature = "metrics")]
 use iroh_metrics::{inc, inc_by};
 use serde::{Deserialize, Serialize};
@@ -826,11 +826,11 @@ impl Debug for EntrySignature {
         f.debug_struct("EntrySignature")
             .field(
                 "namespace_signature",
-                &base32::fmt(self.namespace_signature.to_bytes()),
+                &hex::encode(self.namespace_signature.to_bytes()),
             )
             .field(
                 "author_signature",
-                &base32::fmt(self.author_signature.to_bytes()),
+                &hex::encode(self.author_signature.to_bytes()),
             )
             .finish()
     }

src/sync.rs

@@ -66,7 +66,6 @@ mod tests {
     use std::str::FromStr;
 
     use iroh::key::PublicKey;
-    use iroh_base::base32;
     use iroh_test::{assert_eq_hex, hexdump::parse_hexdump};
 
     use super::*;
@@ -89,7 +88,15 @@ mod tests {
             capability: Capability::Read(namespace_id),
             nodes: vec![NodeAddr::from_parts(node_id, None, [])],
         };
-        let base32 = base32::parse_vec(ticket.to_string().strip_prefix("doc").unwrap()).unwrap();
+        let s = ticket.to_string();
+        let base32 = data_encoding::BASE32_NOPAD
+            .decode(
+                s.strip_prefix("doc")
+                    .unwrap()
+                    .to_ascii_uppercase()
+                    .as_bytes(),
+            )
+            .unwrap();
         let expected = parse_hexdump("
             00 # variant
             01 # capability discriminator, 1 = read