Struct PaymentRequest 

pub struct PaymentRequest { /* private fields */ }

NUT-18 Payment Request

A payment request that can be shared to request Cashu tokens. Encoded as a string with the creqA prefix.

Implementations

impl PaymentRequest

pub fn from_string(encoded: String) -> Result<Arc<Self>, FfiError>

Parse a payment request from its encoded string representation

pub fn to_string_encoded(&self) -> String

Encode the payment request to a string

pub fn to_bech32_string(&self) -> Result<String, FfiError>

Encode the payment request to a NUT-26 bech32m string (creqB prefix)

pub fn to_bip321( &self, bolt11: Option<String>, bolt12: Option<String>, ) -> Result<String, FfiError>

Convert this payment request to a BIP 321 bitcoin: URI string.

The cashu payment request is encoded as a NUT-26 bech32m CREQB1... string in the creq= query parameter. Optionally include a BOLT11 invoice (lightning=) and/or BOLT12 offer (lno=) as fallback payment methods for wallets that don’t support cashu.

val request = PaymentRequest.fromString("CREQB1...")
val uri = request.toBip321(
    bolt11 = "lnbc100n1p...",
    bolt12 = "lno1qgsq..."
)
// => "bitcoin:?creq=CREQB1...&lightning=lnbc100n1p...&lno=lno1qgsq..."

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

Get the payment ID

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

Get the requested amount

pub fn unit(&self) -> Option<CurrencyUnit>

Get the currency unit

pub fn single_use(&self) -> Option<bool>

Get whether this is a single-use request

pub fn mints(&self) -> Vec<String>

Get the list of acceptable mint URLs

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

Get the description

pub fn transports(&self) -> Vec<Transport>

Get the transports for delivering the payment

Trait Implementations

impl Debug for PaymentRequest

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

Formats the value using the given formatter.

impl<UT> LiftRef<UT> for PaymentRequest

type LiftType = Arc<PaymentRequest>

impl<UT> LowerError<UT> for PaymentRequest

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for PaymentRequest

type ReturnType = <Arc<PaymentRequest> 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 PaymentRequest

const TYPE_ID_META: MetadataBuffer