Struct Refund

pub struct Refund { /* private fields */ }

A Refund is a request to send an Bolt12Invoice without a preceding Offer.

Typically, after an invoice is paid, the recipient may publish a refund allowing the sender to recoup their funds. A refund may be used more generally as an “offer for money”, such as with a bitcoin ATM.

Implementations

impl Refund

pub fn description(&self) -> PrintableString<'_>

A complete description of the purpose of the refund. Intended to be displayed to the user but with the caveat that it has not been verified in any way.

pub fn absolute_expiry(&self) -> Option<Duration>

Duration since the Unix epoch when an invoice should no longer be sent.

If None, the refund does not expire.

pub fn is_expired(&self) -> bool

Whether the refund has expired.

pub fn issuer(&self) -> Option<PrintableString<'_>>

The issuer of the refund, possibly beginning with user@domain or domain. Intended to be displayed to the user but with the caveat that it has not been verified in any way.

pub fn paths(&self) -> &[BlindedPath]

Paths to the sender originating from publicly reachable nodes. Blinded paths provide sender privacy by obfuscating its node id.

pub fn payer_metadata(&self) -> &[u8]

An unpredictable series of bytes, typically containing information about the derivation of payer_id.

pub fn chain(&self) -> ChainHash

A chain that the refund is valid for.

pub fn amount_msats(&self) -> u64

The amount to refund in msats (i.e., the minimum lightning-payable unit for chain).

pub fn features(&self) -> &Features<InvoiceRequestContext>

Features pertaining to requesting an invoice.

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

The quantity of an item that refund is for.

pub fn payer_id(&self) -> PublicKey

A public node id to send to in the case where there are no paths. Otherwise, a possibly transient pubkey.

pub fn payer_note(&self) -> Option<PrintableString<'_>>

Payer provided note to include in the invoice.

pub fn respond_with( &self, payment_paths: Vec<(BlindedPayInfo, BlindedPath)>, payment_hash: PaymentHash, signing_pubkey: PublicKey, ) -> Result<InvoiceBuilder<'_, ExplicitSigningPubkey>, Bolt12SemanticError>

Creates an InvoiceBuilder for the refund with the given required fields and using the Duration since std::time::SystemTime::UNIX_EPOCH as the creation time.

See Refund::respond_with_no_std for further details where the aforementioned creation time is used for the created_at parameter.

This is not exported to bindings users as builder patterns don’t map outside of move semantics.

pub fn respond_with_no_std( &self, payment_paths: Vec<(BlindedPayInfo, BlindedPath)>, payment_hash: PaymentHash, signing_pubkey: PublicKey, created_at: Duration, ) -> Result<InvoiceBuilder<'_, ExplicitSigningPubkey>, Bolt12SemanticError>

Creates an InvoiceBuilder for the refund with the given required fields.

Unless InvoiceBuilder::relative_expiry is set, the invoice will expire two hours after created_at, which is used to set Bolt12Invoice::created_at. Useful for no-std builds where std::time::SystemTime is not available.

The caller is expected to remember the preimage of payment_hash in order to claim a payment for the invoice.

The signing_pubkey is required to sign the invoice since refunds are not in response to an offer, which does have a signing_pubkey.

The payment_paths parameter is useful for maintaining the payment recipient’s privacy. It must contain one or more elements ordered from most-preferred to least-preferred, if there’s a preference. Note, however, that any privacy is lost if a public node id is used for signing_pubkey.

Errors if the request contains unknown required features.

This is not exported to bindings users as builder patterns don’t map outside of move semantics.

pub fn respond_using_derived_keys<ES>( &self, payment_paths: Vec<(BlindedPayInfo, BlindedPath)>, payment_hash: PaymentHash, expanded_key: &ExpandedKey, entropy_source: ES, ) -> Result<InvoiceBuilder<'_, DerivedSigningPubkey>, Bolt12SemanticError>

where ES: Deref, <ES as Deref>::Target: EntropySource,

Creates an InvoiceBuilder for the refund using the given required fields and that uses derived signing keys to sign the Bolt12Invoice.

See Refund::respond_with for further details.

This is not exported to bindings users as builder patterns don’t map outside of move semantics.

pub fn respond_using_derived_keys_no_std<ES>( &self, payment_paths: Vec<(BlindedPayInfo, BlindedPath)>, payment_hash: PaymentHash, created_at: Duration, expanded_key: &ExpandedKey, entropy_source: ES, ) -> Result<InvoiceBuilder<'_, DerivedSigningPubkey>, Bolt12SemanticError>

where ES: Deref, <ES as Deref>::Target: EntropySource,

Creates an InvoiceBuilder for the refund using the given required fields and that uses derived signing keys to sign the Bolt12Invoice.

See Refund::respond_with_no_std for further details.

This is not exported to bindings users as builder patterns don’t map outside of move semantics.

Trait Implementations

impl AsRef<[u8]> for Refund

fn as_ref(&self) -> &[u8]

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

impl Clone for Refund

fn clone(&self) -> Refund

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Refund

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

Formats the value using the given formatter.

impl Display for Refund

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

Formats the value using the given formatter.

impl FromStr for Refund

type Err = Bolt12ParseError

The associated error which can be returned from parsing.

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

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

impl TryFrom<Vec<u8>> for Refund

type Error = Bolt12ParseError

The type returned in the event of a conversion error.

fn try_from( bytes: Vec<u8>, ) -> Result<Refund, <Refund as TryFrom<Vec<u8>>>::Error>

Performs the conversion.

impl Writeable for Refund

fn write<W>(&self, writer: &mut W) -> Result<(), Error>

where W: Writer,

Writes self out to the given Writer.

fn encode(&self) -> Vec<u8>

Writes self out to a Vec<u8>.

fn serialized_length(&self) -> usize

Gets the length of this object after it has been serialized. This can be overridden to optimize cases where we prepend an object with its length.