Struct PaymentRequest 

pub struct PaymentRequest {
    pub payment_id: Option<String>,
    pub amount: Option<Amount>,
    pub unit: Option<CurrencyUnit>,
    pub single_use: Option<bool>,
    pub mints: Vec<MintUrl>,
    pub description: Option<String>,
    pub transports: Vec<Transport>,
    pub nut10: Option<Nut10SecretRequest>,
}

Payment Request

Fields

payment_id: Option<String>

Payment id

amount: Option<Amount>

Amount

unit: Option<CurrencyUnit>

Unit

single_use: Option<bool>

Single use

mints: Vec<MintUrl>

Mints

description: Option<String>

Description

transports: Vec<Transport>

Transport

nut10: Option<Nut10SecretRequest>

Nut10

Implementations

impl PaymentRequest

pub fn builder() -> PaymentRequestBuilder

Create a new PaymentRequestBuilder

impl PaymentRequest

CREQ-B encoding and decoding implementation

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

Encodes a payment request to CREQB1 bech32m format.

This function serializes a payment request according to the NUT-26 specification and encodes it using the bech32m encoding scheme with the “creqb” human-readable part (HRP). The output is always uppercase for optimal QR code compatibility.

Returns

Returns a Result containing:

• Ok(String) - The bech32m-encoded payment request string in uppercase
• Err(Error) - If serialization or encoding fails

Errors

This function will return an error if:

• The payment request cannot be serialized to TLV format
• The bech32m encoding process fails

Specification

See NUT-26 for the complete specification of the CREQB1 payment request format.

Examples

use std::str::FromStr;

use cashu::nuts::nut18::PaymentRequest;
use cashu::{Amount, MintUrl};

let payment_request = PaymentRequest {
    payment_id: Some("test123".to_string()),
    amount: Some(Amount::from(1000)),
    unit: Some(cashu::nuts::CurrencyUnit::Sat),
    single_use: None,
    mints: vec![MintUrl::from_str("https://mint.example.com")?],
    description: None,
    transports: vec![],
    nut10: None,
};

let encoded = payment_request.to_bech32_string()?;
assert!(encoded.starts_with("CREQB1"));

pub fn from_bech32_string(s: &str) -> Result<PaymentRequest, Error>

Decodes a payment request from CREQB1 bech32m format.

This function takes a bech32m-encoded payment request string (case-insensitive) with the “creqb” human-readable part and deserializes it back into a payment request according to the NUT-26 specification.

Arguments

• s - The bech32m-encoded payment request string (case-insensitive)

Returns

Returns a Result containing:

• Ok(PaymentRequest) - The decoded payment request
• Err(Error) - If decoding or deserialization fails

Errors

This function will return an error if:

• The input string is not valid bech32m encoding
• The human-readable part is not “creqb” (case-insensitive)
• The decoded data cannot be deserialized into a valid payment request
• The TLV structure is malformed

Specification

See NUT-26 for the complete specification of the CREQB1 payment request format.

Examples

use cashu::nuts::nut18::PaymentRequest;

let encoded = "CREQB1QYQQWAR9WD6RZV3NQ5QPS6R5W3C8XW309AKKJMN59EJHSCTDWPKX2TNRDAKS4U8XXF";
let payment_request = PaymentRequest::from_bech32_string(encoded)?;
assert_eq!(payment_request.payment_id, Some("test123".to_string()));

Trait Implementations

impl AsRef<Option<String>> for PaymentRequest

fn as_ref(&self) -> &Option<String>

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for PaymentRequest

fn clone(&self) -> PaymentRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PaymentRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PaymentRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for PaymentRequest

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

Formats the value using the given formatter.

impl FromStr for PaymentRequest

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<PaymentRequest, <PaymentRequest as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for PaymentRequest

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

where __H: Hasher,

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 PaymentRequest

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for PaymentRequest

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.

impl Eq for PaymentRequest

impl StructuralPartialEq for PaymentRequest