Struct LnUrlPayRequestData

pub struct LnUrlPayRequestData {
    pub callback: String,
    pub min_sendable: u64,
    pub max_sendable: u64,
    pub metadata_str: String,
    pub comment_allowed: u16,
    pub domain: String,
    pub allows_nostr: bool,
    pub nostr_pubkey: Option<String>,
    pub ln_address: Option<String>,
}

Wrapped in a [LnUrlPay], this is the result of parse when given a LNURL-pay endpoint.

It represents the endpoint’s parameters for the LNURL workflow.

See https://github.com/lnurl/luds/blob/luds/06.md

Fields

callback: String

min_sendable: u64

The minimum amount, in millisats, that this LNURL-pay endpoint accepts

max_sendable: u64

The maximum amount, in millisats, that this LNURL-pay endpoint accepts

metadata_str: String

As per LUD-06, metadata is a raw string (e.g. a json representation of the inner map). Use metadata_vec() to get the parsed items.

comment_allowed: u16

The comment length accepted by this endpoint

See https://github.com/lnurl/luds/blob/luds/12.md

domain: String

Indicates the domain of the LNURL-pay service, to be shown to the user when asking for payment input, as per LUD-06 spec.

Note: this is not the domain of the callback, but the domain of the LNURL-pay endpoint.

allows_nostr: bool

Value indicating whether the recipient supports Nostr Zaps through NIP-57.

See https://github.com/nostr-protocol/nips/blob/master/57.md

nostr_pubkey: Option<String>

Optional recipient’s lnurl provider’s Nostr pubkey for NIP-57. If it exists it should be a valid BIP 340 public key in hex.

See https://github.com/nostr-protocol/nips/blob/master/57.md See https://github.com/bitcoin/bips/blob/master/bip-0340.mediawiki

ln_address: Option<String>

If sending to a LN Address, this will be filled.

Implementations

impl LnUrlPayRequestData

pub fn min_sendable_sats(&self) -> u64

The minimum amount, in sats, accepted by this LNURL-pay endpoint

pub fn max_sendable_sats(&self) -> u64

The maximum amount, in sats, accepted by this LNURL-pay endpoint

pub fn metadata_vec(&self) -> Result<Vec<MetadataItem>, Error>

Parsed metadata items. Use metadata_str to get the raw metadata string, as received from the LNURL endpoint.

Trait Implementations

impl Clone for LnUrlPayRequestData

fn clone(&self) -> LnUrlPayRequestData

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for LnUrlPayRequestData

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for LnUrlPayRequestData

fn deserialize<__D>( __deserializer: __D, ) -> Result<LnUrlPayRequestData, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for LnUrlPayRequestData

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.