Skip to content

feat: add BIP353 DNS payment instructions #236

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

Open
sdmg15 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat: add BIP353 DNS payment instructions #236

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
93 changes: 93 additions & 0 deletions Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 3 additions & 1 deletion Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ shlex = { version = "1.3.0", optional = true }
payjoin = { version = "=1.0.0-rc.1", features = ["v1", "v2", "io", "_test-utils"], optional = true}
reqwest = { version = "0.13.2", default-features = false, optional = true }
url = { version = "2.5.8", optional = true }
bitcoin-payment-instructions = { version = "0.7.0", optional = true}

[features]
default = ["repl", "sqlite"]
Expand All @@ -52,7 +53,8 @@ redb = ["bdk_redb"]
cbf = ["bdk_kyoto", "_payjoin-dependencies"]
electrum = ["bdk_electrum", "_payjoin-dependencies"]
esplora = ["bdk_esplora", "_payjoin-dependencies"]
rpc = ["bdk_bitcoind_rpc", "_payjoin-dependencies"]
rpc = ["bdk_bitcoind_rpc", "_payjoin-dependencies"]
dns_payment = ["bitcoin-payment-instructions"]

# Internal features
_payjoin-dependencies = ["payjoin", "reqwest", "url"]
Expand Down
21 changes: 21 additions & 0 deletions src/commands.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,16 @@
//! All subcommands are defined in the below enums.

#![allow(clippy::large_enum_variant)]

use bdk_wallet::bitcoin::{
Address, Network, OutPoint, ScriptBuf,
bip32::{DerivationPath, Xpriv},
};
use clap::{Args, Parser, Subcommand, ValueEnum, value_parser};
use clap_complete::Shell;

#[cfg(feature = "dns_payment")]
use crate::utils::parse_dns_recipient;
#[cfg(any(feature = "electrum", feature = "esplora", feature = "rpc"))]
use crate::utils::parse_proxy_auth;
use crate::utils::{parse_address, parse_outpoint, parse_recipient};
Expand Down Expand Up @@ -182,6 +185,16 @@ pub enum CliSubCommand {
#[arg(value_enum)]
shell: Shell,
},

#[cfg(feature = "dns_payment")]
/// Resolves BIP-353 DNS payment instructions for a human-readable name.
ResolveDnsRecipient {
/// Human-readable name (e.g. user@domain.com)
hrn: String,
/// DNS resolver address
#[arg(long, default_value = "8.8.8.8")]
resolver: String,
},
}

/// Wallet operation subcommands.
Expand Down Expand Up @@ -354,6 +367,14 @@ pub enum OfflineWalletSubCommand {
// Address and amount parsing is done at run time in handler function.
#[arg(env = "ADDRESS:SAT", long = "to", required = true, value_parser = parse_recipient)]
recipients: Vec<(ScriptBuf, u64)>,
#[cfg(feature = "dns_payment")]
/// Adds DNS recipients to the transaction
#[arg(long = "to_dns", value_parser = parse_dns_recipient)]
dns_recipients: Vec<(String, u64)>,
#[cfg(feature = "dns_payment")]
/// Custom resolver DNS IP to be used for resolution.
#[arg(long = "dns_resolver", default_value = "8.8.8.8:53")]
Copy link
Copy Markdown
Contributor

@va-an va-an May 15, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The default DNS resolver value is inconsistent between the two commands:

  • ResolveDnsRecipient::resolver -> "8.8.8.8"
  • CreateTx::dns_resolver -> "8.8.8.8:53"

parse_dns_instructions already appends :53 when no port is present, so the :53 suffix in CreateTx is redundant. Drop it to keep the defaults aligned.

Also worth aligning the flag names themselves - --resolver in one command and --dns_resolver in the other forces users to remember two names for the same thing.

Same value also keeps getting renamed as it travels through the call stack. For the resolve command:

  • commands.rs -> resolver
  • handlers.rs::handle_resolve_dns_recipient_command(... resolver: String ...)
  • dns_payment_instructions.rs::resolve_dns_recipient(... ip: String)
  • dns_payment_instructions.rs::parse_dns_instructions(... resolver_ip: String)

Three different names for the same value makes the flow harder to follow. Use dns_resolver everywhere - both as the CLI flag (--dns_resolver) and as the field/parameter name across all functions.

dns_resolver: String,
/// Sends all the funds (or all the selected utxos). Requires only one recipient with value 0.
#[arg(long = "send_all", short = 'a')]
send_all: bool,
Expand Down
Loading