Enum HrnResolution 

pub enum HrnResolution {
    DNSSEC {
        proof: Option<Vec<u8>>,
        result: String,
    },
    LNURLPay {
        min_value: Amount,
        max_value: Amount,
        expected_description_hash: [u8; 32],
        recipient_description: Option<String>,
        callback: String,
    },
}

The first-step resolution of a Human Readable Name.

It can either represent a resolution using BIP 353 and the DNS or the first step resolution of an LNURL-Pay. The second step, resolving a callback URI to a Bolt11Invoice occurs via HrnResolver::resolve_lnurl.

Variants

DNSSEC

The HRN was resolved using BIP 353 and the DNS. The result should contain a BIP 321 bitcoin: URI as well as a DNSSEC proof which allows later verification of the payment instructions.

Fields

proof: Option<Vec<u8>>

A DNSSEC proof as used in BIP 353.

If the HRN was resolved using BIP 353, this should be set to a full proof which can later be copied to PSBTs for hardware wallet verification or stored as a part of proof of payment.

result: String

The result of the resolution.

This should contain a string which can be parsed as further payment instructions. For a BIP 353 resolution, this will contain a full BIP 321 bitcoin: URI, for a LN-Address resolution this will contain a lightning BOLT 11 invoice.

LNURLPay

The HRN was resolved using LNURL-Pay as an LN-Address. The result contains a callback URI which will be used once we pick an amount to fetch a final Bolt11Invoice.

Fields

min_value: Amount

The minimum amount which can be sent to the recipient, as specified in the LNURL-Pay initial response.

max_value: Amount

The maximum amount which can be sent to the recipient, as specified in the LNURL-Pay initial response.

expected_description_hash: [u8; 32]

The description hash which must appear in the final Bolt11Invoice, committing to the full recipient metadata.

While we could store the full recipient metadata and use it as a committed value in our proof-of-payment, there is no way to ensure it is actually provable against the server/initial payment instructions string because the server can return a Bolt11Invoice signed by any arbitrary public key.

recipient_description: Option<String>

The text/plain description provided in the LNURL-Pay initial response.

This is generally human-readable and can be displayed to the user as with any other recipient description in payment instructions.

callback: String

The callback URI which can be used, with a concrete amount, to fetch a final Bolt11Invoice which can be paid.