Skip to content

Allow bech32m subcommand to add and remove multi-character prefix strings #211

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
casey merged 3 commits into from
Jan 23, 2026
+75 −23
Merged

Allow bech32m subcommand to add and remove multi-character prefix strings #211

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
887195c
Allow bech32m encode and decode to add and remove prefix strings
casey Jan 23, 2026
5c28fed
Amend
casey Jan 23, 2026
0950979
Modify
casey Jan 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions src/error.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,14 @@ pub enum Error {
backtrace: Option<Backtrace>,
source: bech32::primitives::hrp::Error,
},
#[snafu(display("invalid bech32m prefix character `{character}`"))]
Bech32mPrefix {
backtrace: Option<Backtrace>,
character: char,
source: bech32::primitives::gf32::FromCharError,
},
#[snafu(display("bech32m prefix missing"))]
Bech32mPrefixMissing { backtrace: Option<Backtrace> },
#[snafu(display("invalid bech32m version character `{version}`"))]
Bech32mVersion {
backtrace: Option<Backtrace>,
Expand Down
54 changes: 31 additions & 23 deletions src/subcommand/bech32m.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,20 @@ pub(crate) struct Bech32m {
encode: Option<String>,
#[arg(help = "Prefix bech32m with human-readable part <HRP>", long)]
hrp: Option<String>,
#[arg(help = "Strip or add <VERSION> character", long)]
version: Option<char>,
#[arg(help = "Strip or add <PREFIX> characters", long)]
prefix: Option<String>,
}

impl Bech32m {
pub(crate) fn run(self) -> Result {
let version = self
.version
.map(|version| Fe32::from_char(version).context(error::Bech32mVersion { version }))
let prefix = self
.prefix
.map(|prefix| {
prefix
.chars()
.map(|character| Fe32::from_char(character).context(error::Bech32mPrefix { character }))
.collect::<Result<Vec<Fe32>>>()
})
.transpose()?;

if let Some(bech32m) = self.decode {
Expand All @@ -37,38 +42,41 @@ impl Bech32m {
bech32m: bech32m.clone(),
})?;

let mut fe32s = hrp_string.fe32_iter::<std::vec::IntoIter<u8>>();
let mut fe32s = hrp_string
.fe32_iter::<std::vec::IntoIter<u8>>()
.collect::<Vec<Fe32>>();

if let Some(expected) = version {
let actual = fe32s.next().context(error::Bech32mVersionMissing)?;
if let Some(prefix) = prefix {
ensure! {
fe32s.starts_with(&prefix),
error::Bech32mPrefixMissing,
}

ensure!(
actual == expected,
error::Bech32mVersionMismatch { actual, expected },
);
fe32s.drain(..prefix.len());
}

let bytes = fe32s.fes_to_bytes().collect::<Vec<u8>>();
let bytes = fe32s.into_iter().fes_to_bytes().collect::<Vec<u8>>();
let hex = hex::encode(bytes);
println!("{hex}");
} else {
let hrp = Hrp::parse(&self.hrp.unwrap()).context(error::Bech32mHrp)?;
let hex = self.encode.unwrap();
let hex = hex::decode(&hex).context(error::Hex { hex })?;

let iter = hex
.iter()
.copied()
.bytes_to_fes()
.with_checksum::<bech32::Bech32m>(&hrp);

let iter = if let Some(v) = version {
iter.with_witness_version(v)
let fe32s = if let Some(prefix) = prefix {
prefix
.into_iter()
.chain(hex.iter().copied().bytes_to_fes())
.collect::<Vec<Fe32>>()
} else {
iter
hex.iter().copied().bytes_to_fes().collect::<Vec<Fe32>>()
};

for c in iter.chars() {
for c in fe32s
.into_iter()
.with_checksum::<bech32::Bech32m>(&hrp)
.chars()
{
print!("{c}");
}

Expand Down
36 changes: 36 additions & 0 deletions tests/bech32m.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,22 @@ fn decode_invalid_bech32m() {
.failure();
}

#[test]
fn decode_prefix_missing() {
Test::new()
.args(["bech32m", "--decode", "foo1vehk7e3xjxp", "--prefix", "q"])
.stderr("error: bech32m prefix missing\n")
.failure();
}

#[test]
fn decode_with_prefix() {
Test::new()
.args(["bech32m", "--decode", "foo1qvehk7ml2uzp", "--prefix", "q"])
.stdout("666f6f\n")
.success();
}

#[test]
fn encode() {
Test::new()
Expand All @@ -40,6 +56,16 @@ fn encode_invalid_hrp() {
.failure();
}

#[test]
fn encode_invalid_prefix() {
Test::new()
.args([
"bech32m", "--encode", "666f6f", "--hrp", "foo", "--prefix", "!",
])
.stderr_regex("error: invalid bech32m prefix character `!`\n.*")
.failure();
}

#[test]
fn encode_requires_hrp() {
Test::new()
Expand All @@ -48,6 +74,16 @@ fn encode_requires_hrp() {
.status(2);
}

#[test]
fn encode_with_prefix() {
Test::new()
.args([
"bech32m", "--encode", "666f6f", "--hrp", "foo", "--prefix", "q",
])
.stdout("foo1qvehk7ml2uzp\n")
.success();
}

#[test]
fn source_required() {
Test::new()
Expand Down