Struct Bip21 

pub struct Bip21 { /* private fields */ }

A parsed Bitcoin BIP21 URI with optional parameters.

BIP21 URIs have the format: bitcoin:<address>?amount=<amount>&label=<label>&message=<message> They can also include lightning parameters like lightning=<bolt11> or lno=<bolt12>.

Implementations

impl Bip21

pub fn new(s: &str) -> Result<Arc<Self>, LwkError>

Parse a BIP21 URI string

pub fn as_str(&self) -> String

Returns the original URI string

pub fn address(&self) -> Arc<BitcoinAddress>

Returns the Bitcoin address from the BIP21 URI

pub fn amount(&self) -> Option<u64>

Returns the amount in satoshis if present

pub fn label(&self) -> Option<String>

Returns the label if present

pub fn message(&self) -> Option<String>

Returns the message if present

pub fn lightning(&self) -> Option<Arc<Bolt11Invoice>>

Available on crate feature lightning only.

Returns the lightning BOLT11 invoice as a string if present

pub fn offer(&self) -> Option<String>

Returns the BOLT12 offer as a string if present

pub fn payjoin(&self) -> Option<String>

Returns the payjoin endpoint URL if present

pub fn payjoin_output_substitution(&self) -> bool

Returns whether payjoin output substitution is allowed (defaults to true if absent)

pub fn silent_payment_address(&self) -> Option<String>

Returns the silent payment address (BIP-352) if present

Trait Implementations

impl Display for Bip21

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

Formats the value using the given formatter.

impl From<Bip21> for Bip21

fn from(inner: Bip21) -> Self

Converts to this type from the input type.

impl<UT> LiftRef<UT> for Bip21

type LiftType = Arc<Bip21>

impl<UT> LowerError<UT> for Bip21

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for Bip21

type ReturnType = <Arc<Bip21> as LowerReturn<UniFfiTag>>::ReturnType

The type that should be returned by scaffolding functions for this type.

fn lower_return(obj: Self) -> Result<Self::ReturnType, RustCallError>

Lower the return value from an scaffolding call

fn handle_failed_lift( error: LiftArgsError, ) -> Result<Self::ReturnType, RustCallError>

Lower the return value for failed argument lifts

impl<UT> TypeId<UT> for Bip21

const TYPE_ID_META: MetadataBuffer