-
Notifications
You must be signed in to change notification settings - Fork 130
Add support for resolving BIP 353 Human-Readable Names #630
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.
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
base: main
Are you sure you want to change the base?
Changes from 1 commit
b699f3e
e83f2cf
f816e83
a1b980f
a4d5613
ea7b1ce
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -128,6 +128,7 @@ pub(crate) const LNURL_AUTH_TIMEOUT_SECS: u64 = 15; | |
| /// | `anchor_channels_config` | Some(..) | | ||
| /// | `route_parameters` | None | | ||
| /// | `tor_config` | None | | ||
| /// | `hrn_config` | HumanReadableNamesConfig::default() | | ||
| /// | ||
| /// See [`AnchorChannelsConfig`] and [`RouteParametersConfig`] for more information regarding their | ||
| /// respective default values. | ||
|
|
@@ -199,6 +200,10 @@ pub struct Config { | |
| /// | ||
| /// **Note**: If unset, connecting to peer OnionV3 addresses will fail. | ||
| pub tor_config: Option<TorConfig>, | ||
| /// Configuration options for Human-Readable Names ([BIP 353]). | ||
| /// | ||
| /// [BIP 353]: https://github.com/bitcoin/bips/blob/master/bip-0353.mediawiki | ||
| pub hrn_config: HumanReadableNamesConfig, | ||
| } | ||
|
|
||
| impl Default for Config { | ||
|
|
@@ -214,6 +219,58 @@ impl Default for Config { | |
| tor_config: None, | ||
| route_parameters: None, | ||
| node_alias: None, | ||
| hrn_config: HumanReadableNamesConfig::default(), | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /// Configuration options for how our node resolves Human-Readable Names (BIP 353). | ||
| /// | ||
| /// [BIP 353]: https://github.com/bitcoin/bips/blob/master/bip-0353.mediawiki | ||
| #[derive(Debug, Clone)] | ||
| #[cfg_attr(feature = "uniffi", derive(uniffi::Enum))] | ||
| pub enum HRNResolverConfig { | ||
| /// Use [bLIP-32] to ask other nodes to resolve names for us. | ||
| /// | ||
| /// [bLIP-32]: https://github.com/lightning/blips/blob/master/blip-0032.md | ||
| Blip32, | ||
| /// Resolve names locally using a specific DNS server. | ||
| Dns { | ||
| /// The IP and port of the DNS server. | ||
| /// **Default:** `8.8.8.8:53` (Google Public DNS) | ||
| dns_server_address: String, | ||
| /// If set to true, this allows others to use our node for HRN resolutions. | ||
| /// | ||
| /// **Note:** Enabling `enable_hrn_resolution_service` allows your node to act | ||
| /// as a resolver for the rest of the network. For this to work, your node must | ||
| /// be announceable (publicly visible in the network graph) so that other nodes | ||
| /// can route resolution requests to you via Onion Messages. This does not affect | ||
| /// your node's ability to resolve names for its own outgoing payments. | ||
| enable_hrn_resolution_service: bool, | ||
| }, | ||
| } | ||
|
|
||
| /// Configuration options for Human-Readable Names ([BIP 353]). | ||
| /// | ||
| /// [BIP 353]: https://github.com/bitcoin/bips/blob/master/bip-0353.mediawiki | ||
| #[derive(Debug, Clone)] | ||
| #[cfg_attr(feature = "uniffi", derive(uniffi::Record))] | ||
| pub struct HumanReadableNamesConfig { | ||
| /// This sets how our node resolves names when we want to send a payment. | ||
| /// | ||
| /// By default, this uses the `Dns` variant with the following settings: | ||
| /// * **DNS Server**: `8.8.8.8:53` (Google Public DNS) | ||
| /// * **Resolution Service**: Enabled (`true`) | ||
| pub resolution_config: HRNResolverConfig, | ||
| } | ||
|
|
||
| impl Default for HumanReadableNamesConfig { | ||
| fn default() -> Self { | ||
| HumanReadableNamesConfig { | ||
| resolution_config: HRNResolverConfig::Dns { | ||
| dns_server_address: "8.8.8.8:53".to_string(), | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Please document the default choices in the |
||
| enable_hrn_resolution_service: true, | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. As mentioned on the last review pass, I think we unfortunately need to default to |
||
| }, | ||
| } | ||
| } | ||
| } | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Shouldn't this be a
SocketAddressas we use elsewhere?