Enum InputType

pub enum InputType {
    BitcoinAddress {
        address: BitcoinAddressData,
    },
    LiquidAddress {
        address: LiquidAddressData,
    },
    Bolt11 {
        invoice: LNInvoice,
    },
    Bolt12Offer {
        offer: LNOffer,
        bip353_address: Option<String>,
    },
    NodeId {
        node_id: String,
    },
    Url {
        url: String,
    },
    LnUrlPay {
        data: LnUrlPayRequestData,
        bip353_address: Option<String>,
    },
    LnUrlWithdraw {
        data: LnUrlWithdrawRequestData,
    },
    LnUrlAuth {
        data: LnUrlAuthRequestData,
    },
    LnUrlError {
        data: LnUrlErrorData,
    },
}

Different kinds of inputs supported by parse, including any relevant details extracted from the input

Variants

BitcoinAddress

Supported standards

• plain on-chain BTC address
• BIP21

Fields

address: BitcoinAddressData

LiquidAddress

Supported standards

• plain on-chain liquid address
• BIP21 on liquid/liquidtestnet/liquidregtest

Fields

address: LiquidAddressData

Bolt11

Also covers URIs like bitcoin:...&lightning=bolt11. In this case, it returns the BOLT11 and discards all other data.

Fields

invoice: LNInvoice

Bolt12Offer

Fields

offer: LNOffer

bip353_address: Option<String>

The BIP353 address from which this InputType was resolved

NodeId

Fields

node_id: String

Url

Fields

url: String

LnUrlPay

Supported standards

• LUD-01 LNURL bech32 encoding
• LUD-06 payRequest spec
• LUD-16 LN Address
• LUD-17 Support for lnurlp prefix with non-bech32-encoded LNURL URLs

Fields

data: LnUrlPayRequestData

bip353_address: Option<String>

The BIP353 address from which this InputType was resolved

LnUrlWithdraw

Supported standards

• LUD-01 LNURL bech32 encoding
• LUD-03 withdrawRequest spec
• LUD-17 Support for lnurlw prefix with non-bech32-encoded LNURL URLs

Not supported (yet)

• LUD-14 balanceCheck: reusable withdrawRequests
• LUD-19 Pay link discoverable from withdraw link

Fields

data: LnUrlWithdrawRequestData

LnUrlAuth

Supported standards

• LUD-01 LNURL bech32 encoding
• LUD-04 auth base spec
• LUD-17 Support for keyauth prefix with non-bech32-encoded LNURL URLs

Fields

data: LnUrlAuthRequestData

LnUrlError

Error returned by the LNURL endpoint

Fields

data: LnUrlErrorData

Trait Implementations

impl Clone for InputType

fn clone(&self) -> InputType

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InputType

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for InputType

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<LnUrlRequestData> for InputType

fn from(lnurl_data: LnUrlRequestData) -> InputType

Converts to this type from the input type.

impl Serialize for InputType

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.