Add HRN resolver to Node and UnifiedPayment

Introduce the hrn_resolver dependency into the main Node struct and
plumb it through to the UnifiedPayment component. This is necessary to
allow the node to resolve offers presented via a Human-Readable Name (HRN).

Author: chuksys

src/builder.rs

@@ -18,6 +18,7 @@ use bdk_wallet::{KeychainKind, Wallet as BdkWallet};
 use bitcoin::bip32::{ChildNumber, Xpriv};
 use bitcoin::secp256k1::PublicKey;
 use bitcoin::{BlockHash, Network};
+use bitcoin_payment_instructions::onion_message_resolver::LDKOnionMessageDNSSECHrnResolver;
 use lightning::chain::{chainmonitor, BestBlock, Watch};
 use lightning::io::Cursor;
 use lightning::ln::channelmanager::{self, ChainParameters, ChannelManagerReadArgs};
@@ -1479,6 +1480,8 @@ fn build_with_store_internal(
 		})?;
 	}
 
+	let hrn_resolver = Arc::new(LDKOnionMessageDNSSECHrnResolver::new(Arc::clone(&network_graph)));
+
 	// Initialize the PeerManager
 	let onion_messenger: Arc<OnionMessenger> =
 		if let Some(AsyncPaymentsRole::Server) = async_payments_role {
@@ -1490,7 +1493,7 @@ fn build_with_store_internal(
 				message_router,
 				Arc::clone(&channel_manager),
 				Arc::clone(&channel_manager),
-				IgnoringMessageHandler {},
+				Arc::clone(&hrn_resolver),
 				IgnoringMessageHandler {},
 			))
 		} else {
@@ -1502,7 +1505,7 @@ fn build_with_store_internal(
 				message_router,
 				Arc::clone(&channel_manager),
 				Arc::clone(&channel_manager),
-				IgnoringMessageHandler {},
+				Arc::clone(&hrn_resolver),
 				IgnoringMessageHandler {},
 			))
 		};
@@ -1634,6 +1637,12 @@ fn build_with_store_internal(
 		Arc::clone(&keys_manager),
 	));
 
+	let peer_manager_clone = Arc::clone(&peer_manager);
+
+	hrn_resolver.register_post_queue_action(Box::new(move || {
+		peer_manager_clone.process_events();
+	}));
+
 	liquidity_source.as_ref().map(|l| l.set_peer_manager(Arc::clone(&peer_manager)));
 
 	gossip_source.set_gossip_verifier(
@@ -1741,6 +1750,7 @@ fn build_with_store_internal(
 		node_metrics,
 		om_mailbox,
 		async_payments_role,
+		hrn_resolver,
 	})
 }
 

src/lib.rs

@@ -158,8 +158,8 @@ use peer_store::{PeerInfo, PeerStore};
 use rand::Rng;
 use runtime::Runtime;
 use types::{
-	Broadcaster, BumpTransactionEventHandler, ChainMonitor, ChannelManager, Graph, KeysManager,
-	OnionMessenger, PaymentStore, PeerManager, Router, Scorer, Sweeper, Wallet,
+	Broadcaster, BumpTransactionEventHandler, ChainMonitor, ChannelManager, Graph, HRNResolver,
+	KeysManager, OnionMessenger, PaymentStore, PeerManager, Router, Scorer, Sweeper, Wallet,
 };
 pub use types::{
 	ChannelDetails, CustomTlvRecord, DynStore, PeerDetails, SyncAndAsyncKVStore, UserChannelId,
@@ -208,6 +208,7 @@ pub struct Node {
 	node_metrics: Arc<RwLock<NodeMetrics>>,
 	om_mailbox: Option<Arc<OnionMessageMailbox>>,
 	async_payments_role: Option<AsyncPaymentsRole>,
+	hrn_resolver: Arc<HRNResolver>,
 }
 
 impl Node {
@@ -961,6 +962,7 @@ impl Node {
 			self.bolt12_payment().into(),
 			Arc::clone(&self.config),
 			Arc::clone(&self.logger),
+			Arc::clone(&self.hrn_resolver),
 		)
 	}
 
@@ -981,6 +983,7 @@ impl Node {
 			self.bolt12_payment(),
 			Arc::clone(&self.config),
 			Arc::clone(&self.logger),
+			Arc::clone(&self.hrn_resolver),
 		))
 	}
 

src/payment/unified.rs

@@ -5,29 +5,33 @@
 // http://opensource.org/licenses/MIT>, at your option. You may not use this file except in
 // accordance with one or both of these licenses.
 
-//! Holds a payment handler allowing to create [BIP 21] URIs with an on-chain, [BOLT 11], and [BOLT 12] payment
+//! Holds a payment handler allowing to create [BIP 21] URIs with on-chain, [BOLT 11], and [BOLT 12] payment
 //! options.
 //!
+//! Also allows to send payments using these URIs as well as [BIP 353] HRNs.
+//!
 //! [BIP 21]: https://github.com/bitcoin/bips/blob/master/bip-0021.mediawiki
+//! [BIP 353]: https://github.com/bitcoin/bips/blob/master/bip-0353.mediawiki
 //! [BOLT 11]: https://github.com/lightning/bolts/blob/master/11-payment-encoding.md
 //! [BOLT 12]: https://github.com/lightning/bolts/blob/master/12-offer-encoding.md
+use crate::error::Error;
+use crate::ffi::maybe_wrap;
+use crate::logger::{log_error, LdkLogger, Logger};
+use crate::payment::{Bolt11Payment, Bolt12Payment, OnchainPayment};
+use crate::types::HRNResolver;
+use crate::Config;
 use std::sync::Arc;
 use std::vec::IntoIter;
 
-use bip21::de::ParamKind;
-use bip21::{DeserializationError, DeserializeParams, Param, SerializeParams};
-use bitcoin::address::{NetworkChecked, NetworkUnchecked};
-use bitcoin::{Amount, Txid};
 use lightning::ln::channelmanager::PaymentId;
 use lightning::offers::offer::Offer;
 use lightning::routing::router::RouteParametersConfig;
 use lightning_invoice::{Bolt11Invoice, Bolt11InvoiceDescription, Description};
 
-use crate::error::Error;
-use crate::ffi::maybe_wrap;
-use crate::logger::{log_error, LdkLogger, Logger};
-use crate::payment::{Bolt11Payment, Bolt12Payment, OnchainPayment};
-use crate::Config;
+use bip21::de::ParamKind;
+use bip21::{DeserializationError, DeserializeParams, Param, SerializeParams};
+use bitcoin::address::{NetworkChecked, NetworkUnchecked};
+use bitcoin::{Amount, Txid};
 
 type Uri<'a> = bip21::Uri<'a, NetworkChecked, Extras>;
 
@@ -40,26 +44,31 @@ struct Extras {
 /// A payment handler allowing to create [BIP 21] URIs with an on-chain, [BOLT 11], and [BOLT 12] payment
 /// option.
 ///
-/// Should be retrieved by calling [`Node::unified_qr_payment`]
+/// Should be retrieved by calling [`Node::unified_payment`]
+///
+/// This handler allows you to send payments to these URIs as well as [BIP 353] HRNs.
 ///
 /// [BIP 21]: https://github.com/bitcoin/bips/blob/master/bip-0021.mediawiki
+/// [BIP 353]: https://github.com/bitcoin/bips/blob/master/bip-0353.mediawiki
 /// [BOLT 11]: https://github.com/lightning/bolts/blob/master/11-payment-encoding.md
 /// [BOLT 12]: https://github.com/lightning/bolts/blob/master/12-offer-encoding.md
-/// [`Node::unified_qr_payment`]: crate::Node::unified_qr_payment
+/// [`Node::unified_payment`]: crate::Node::unified_payment
 pub struct UnifiedPayment {
 	onchain_payment: Arc<OnchainPayment>,
 	bolt11_invoice: Arc<Bolt11Payment>,
 	bolt12_payment: Arc<Bolt12Payment>,
 	config: Arc<Config>,
 	logger: Arc<Logger>,
+	hrn_resolver: Arc<HRNResolver>,
 }
 
 impl UnifiedPayment {
 	pub(crate) fn new(
 		onchain_payment: Arc<OnchainPayment>, bolt11_invoice: Arc<Bolt11Payment>,
 		bolt12_payment: Arc<Bolt12Payment>, config: Arc<Config>, logger: Arc<Logger>,
+		hrn_resolver: Arc<HRNResolver>,
 	) -> Self {
-		Self { onchain_payment, bolt11_invoice, bolt12_payment, config, logger }
+		Self { onchain_payment, bolt11_invoice, bolt12_payment, config, logger, hrn_resolver }
 	}
 
 	/// Generates a URI with an on-chain address, [BOLT 11] invoice and [BOLT 12] offer.
@@ -148,6 +157,8 @@ impl UnifiedPayment {
 		let uri: bip21::Uri<NetworkUnchecked, Extras> =
 			uri_str.parse().map_err(|_| Error::InvalidUri)?;
 
+		let _resolver = &self.hrn_resolver;
+
 		let uri_network_checked =
 			uri.clone().require_network(self.config.network).map_err(|_| Error::InvalidNetwork)?;
 

src/types.rs

@@ -10,6 +10,7 @@ use std::sync::{Arc, Mutex};
 
 use bitcoin::secp256k1::PublicKey;
 use bitcoin::OutPoint;
+use bitcoin_payment_instructions::onion_message_resolver::LDKOnionMessageDNSSECHrnResolver;
 use lightning::chain::chainmonitor;
 use lightning::impl_writeable_tlv_based;
 use lightning::ln::channel_state::ChannelDetails as LdkChannelDetails;
@@ -142,10 +143,12 @@ pub(crate) type OnionMessenger = lightning::onion_message::messenger::OnionMesse
 	Arc<MessageRouter>,
 	Arc<ChannelManager>,
 	Arc<ChannelManager>,
-	IgnoringMessageHandler,
+	Arc<HRNResolver>,
 	IgnoringMessageHandler,
 >;
 
+pub(crate) type HRNResolver = LDKOnionMessageDNSSECHrnResolver<Arc<Graph>, Arc<Logger>>;
+
 pub(crate) type MessageRouter = lightning::onion_message::messenger::DefaultMessageRouter<
 	Arc<Graph>,
 	Arc<Logger>,