feat: Base45 (#116)

Add support for Base54 encoding/decoding.

Fixes #100.

Author: mriise

Cargo.lock

@@ -12,13 +12,14 @@ keywords = ["ipld", "ipfs", "multihash", "cid", "no_std"]
 
 [features]
 default = ["std"]
-std = ["data-encoding/std"]
+std = ["data-encoding/std", "base45/std"]
 
 [dependencies]
 base-x = { version = "0.2.7", default-features = false }
 base256emoji = "1.0.2"
 data-encoding = { version = "2.3.1", default-features = false, features = ["alloc"] }
 data-encoding-macro = "0.1.9"
+base45 = { version = "3.2.0", default-features = false }
 
 [dev-dependencies]
 criterion = "0.7"

Cargo.toml

@@ -84,6 +84,7 @@ impl fmt::Display for StrBase {
             Base::Base32Z => "base32z",
             Base::Base36Lower => "base36lower",
             Base::Base36Upper => "base36upper",
+            Base::Base45 => "base45",
             Base::Base58Flickr => "base58flickr",
             Base::Base58Btc => "base58btc",
             Base::Base64 => "base64",
@@ -118,6 +119,7 @@ impl FromStr for StrBase {
             "base32z" => Ok(Base::Base32Z),
             "base36lower" => Ok(Base::Base36Lower),
             "base36upper" => Ok(Base::Base36Upper),
+            "base45" => Ok(Base::Base45),
             "base58flickr" => Ok(Base::Base58Flickr),
             "base58btc" => Ok(Base::Base58Btc),
             "base64" => Ok(Base::Base64),

cli/main.rs

@@ -82,6 +82,8 @@ build_base_enum! {
     'k' => Base36Lower,
     /// Base36, [0-9A-Z] no padding (alphabet: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ).
     'K' => Base36Upper,
+    /// Base45, rfc9285 (alphabet: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ $%*+-./:).
+    'R' => Base45,
     /// Base58 flicker (alphabet: 123456789abcdefghijkmnopqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ).
     'Z' => Base58Flickr,
     /// Base58 bitcoin (alphabet: 123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz).

src/base.rs

@@ -41,3 +41,9 @@ impl From<data_encoding::DecodeError> for Error {
         Self::InvalidBaseString
     }
 }
+
+impl From<base45::DecodeError> for Error {
+    fn from(_: base45::DecodeError) -> Self {
+        Self::InvalidBaseString
+    }
+}

src/error.rs

@@ -158,3 +158,17 @@ impl BaseCodec for Base36Upper {
         Ok(base_x::decode(encoding::BASE36_UPPER, &uppercased)?)
     }
 }
+
+/// Base45, rfc9285 (alphabet: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ $%*+-./:).
+pub(crate) struct Base45;
+
+impl BaseCodec for Base45 {
+    fn encode<I: AsRef<[u8]>>(input: I) -> String {
+        base45::encode(input.as_ref())
+    }
+
+    fn decode<I: AsRef<str>>(input: I) -> Result<Vec<u8>> {
+        let uppercased = input.as_ref().to_ascii_uppercase();
+        Ok(base45::decode(&uppercased)?)
+    }
+}

src/impls.rs

@@ -58,6 +58,7 @@ fn test_basic() {
         (Base32Z, "hxf1zgedpcfzg1ebb"),
         (Base36Lower, "k2lcpzo5yikidynfl"),
         (Base36Upper, "K2LCPZO5YIKIDYNFL"),
+        (Base45, "RRFF.OEB$D5/DZ24"),
         (Base58Flickr, "Z7Pznk19XTTzBtx"),
         (Base58Btc, "z7paNL19xttacUY"),
         (Base64, "meWVzIG1hbmkgIQ"),
@@ -90,6 +91,7 @@ fn preserves_leading_zero() {
         (Base32Z, "hybhskh3ypiosh4jyrr"),
         (Base36Lower, "k02lcpzo5yikidynfl"),
         (Base36Upper, "K02LCPZO5YIKIDYNFL"),
+        (Base45, "RV206$CL44CEC2DDX0"),
         (Base58Flickr, "Z17Pznk19XTTzBtx"),
         (Base58Btc, "z17paNL19xttacUY"),
         (Base64, "mAHllcyBtYW5pICE"),
@@ -122,6 +124,7 @@ fn preserves_two_leading_zeroes() {
         (Base32Z, "hyyy813murbssn5ujryoo"),
         (Base36Lower, "k002lcpzo5yikidynfl"),
         (Base36Upper, "K002LCPZO5YIKIDYNFL"),
+        (Base45, "R000RFF.OEB$D5/DZ24"),
         (Base58Flickr, "Z117Pznk19XTTzBtx"),
         (Base58Btc, "z117paNL19xttacUY"),
         (Base64, "mAAB5ZXMgbWFuaSAh"),
@@ -149,6 +152,7 @@ fn case_insensitivity() {
         (Base32HexPadUpper, "Td1imor3f41RMUSJCCG======"),
         (Base36Lower, "kfUvrsIvVnfRbjWaJo"),
         (Base36Upper, "KfUVrSIVVnFRbJWAJo"),
+        (Base45, "R+8d vd82ek4f.kea2"),
     ];
     for (base, output) in test_cases {
         assert_eq!(decode(output).unwrap(), (base, input.to_vec()));