Enum PaymentMethod 

pub enum PaymentMethod {
    Ark(Address),
    Bitcoin(Address<NetworkUnchecked>),
    OutputScript(ScriptBuf),
    Invoice(Invoice),
    Offer(Offer),
    LightningAddress(LightningAddress),
    Lnurl(LnUrl),
    Custom(String),
}

Provides a typed mechanism for describing the recipient in a MovementDestination.

Variants

Ark(Address)

An ark::Address for bark.

Bitcoin(Address<NetworkUnchecked>)

An onchain bitcoin::Address.

OutputScript(ScriptBuf)

An onchain bitcoin::ScriptBuf output, typically used for non-address formats like OP_RETURN.

Invoice(Invoice)

Any supported form of lightning Invoice, e.g., Bolt11Invoice and Bolt12Invoice.

Offer(Offer)

A reusable BOLT12 Offer for lightning payments.

LightningAddress(LightningAddress)

An email-like format used to retrieve a Bolt11Invoice.

Lnurl(LnUrl)

A bech32-encoded LNURL-pay link (lnurl1…) resolved to a Bolt11Invoice via an LNURL-Pay request.

Custom(String)

An alternative payment method that isn’t native to bark.

Implementations

impl PaymentMethod

pub fn is_ark(&self) -> bool

pub fn is_bitcoin(&self) -> bool

pub fn is_custom(&self) -> bool

pub fn is_lightning(&self) -> bool

Returns whether the payment method is a lightning payment method, e.g., BOLT11.

pub fn type_str(&self) -> &'static str

Returns the type tag string for this payment method.

pub fn value_string(&self) -> String

Returns the value as a plain string for this payment method.

pub fn supports_comment(&self) -> bool

Returns whether the payment method supports a comment on payment.

pub fn requires_amount(&self) -> bool

Returns whether the payment method needs an externally provided amount, either because it cannot carry one itself or because it doesn’t carry one.

Invoices and offers can carry their own amount; only amountless ones require an amount upfront. An offer denominated in a fiat currency has no bitcoin amount, so it also requires one.

For PaymentMethod::Custom we can’t tell whether an amount is needed, so we never require one and leave it to whoever handles the custom method.

pub fn from_type_value(type_str: &str, value: &str) -> Result<Self>

Construct a PaymentMethod from a type tag and value string.

Trait Implementations

impl Clone for PaymentMethod

fn clone(&self) -> PaymentMethod

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PaymentMethod

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PaymentMethod

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for PaymentMethod

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

Formats the value using the given formatter.

impl Eq for PaymentMethod

impl From<Address<NetworkUnchecked>> for PaymentMethod

fn from(addr: Address<NetworkUnchecked>) -> Self

Converts to this type from the input type.

impl From<Address> for PaymentMethod

fn from(addr: Address) -> Self

Converts to this type from the input type.

impl From<Address> for PaymentMethod

fn from(addr: Address<NetworkChecked>) -> Self

Converts to this type from the input type.

impl From<Bolt11Invoice> for PaymentMethod

fn from(invoice: Bolt11Invoice) -> Self

Converts to this type from the input type.

impl From<Bolt12Invoice> for PaymentMethod

fn from(invoice: Bolt12Invoice) -> Self

Converts to this type from the input type.

impl From<Invoice> for PaymentMethod

fn from(invoice: Invoice) -> Self

Converts to this type from the input type.

impl From<LightningAddress> for PaymentMethod

fn from(addr: LightningAddress) -> Self

Converts to this type from the input type.

impl From<LnUrl> for PaymentMethod

fn from(lnurl: LnUrl) -> Self

Converts to this type from the input type.

impl From<Offer> for PaymentMethod

fn from(offer: Offer) -> Self

Converts to this type from the input type.

impl Hash for PaymentMethod

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for PaymentMethod

fn eq(&self, other: &PaymentMethod) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for PaymentMethod

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for PaymentMethod