Skip to main content

MeltQuote

Struct MeltQuote 

Source
pub struct MeltQuote {
Show 14 fields pub id: QuoteId, pub unit: CurrencyUnit, pub request: MeltPaymentRequest, pub state: MeltQuoteState, pub expiry: u64, pub payment_proof: Option<String>, pub request_lookup_id: Option<PaymentIdentifier>, pub options: Option<MeltOptions>, pub created_time: u64, pub paid_time: Option<u64>, pub payment_method: PaymentMethod, pub extra_json: Option<Value>, pub estimated_blocks: Option<u32>, pub selected_fee_index: Option<u32>, /* private fields */
}
Expand description

Melt Quote Info

Fields§

§id: QuoteId

Quote id

§unit: CurrencyUnit

Quote unit

§request: MeltPaymentRequest

Quote Payment request e.g. bolt11

§state: MeltQuoteState

Quote state

§expiry: u64

Expiration time of quote

§payment_proof: Option<String>

Payment proof (e.g. Lightning preimage or onchain outpoint)

§request_lookup_id: Option<PaymentIdentifier>

Value used by ln backend to look up state of request

§options: Option<MeltOptions>

Payment options

Used for amountless invoices and MPP payments

§created_time: u64

Unix time quote was created

§paid_time: Option<u64>

Unix time quote was paid

§payment_method: PaymentMethod

Payment method

§extra_json: Option<Value>

Extra payment-method-specific response fields

§estimated_blocks: Option<u32>

Estimated confirmation target in blocks for onchain quotes

§selected_fee_index: Option<u32>

Selected fee option index once an onchain quote is executed

Implementations§

Source§

impl MeltQuote

Source

pub fn new( id: Option<QuoteId>, request: MeltPaymentRequest, unit: CurrencyUnit, amount: Amount<CurrencyUnit>, fee_reserve: Amount<CurrencyUnit>, expiry: u64, request_lookup_id: Option<PaymentIdentifier>, options: Option<MeltOptions>, payment_method: PaymentMethod, extra_json: Option<Value>, estimated_blocks: Option<u32>, ) -> Self

Create new MeltQuote

Source

pub fn new_onchain( id: Option<QuoteId>, request: MeltPaymentRequest, unit: CurrencyUnit, amount: Amount<CurrencyUnit>, expiry: u64, request_lookup_id: Option<PaymentIdentifier>, extra_json: Option<Value>, fee_options: Vec<MeltQuoteOnchainFeeOption>, ) -> Result<Self, Error>

Create a new onchain MeltQuote with explicit fee_options.

Preserves backend-provided fee_index values and validates that the quote contains at least one option (OnchainFeeOptionsEmpty).

fee_reserve is initialized to the lowest-fee option so the quote has a definite reserve before the wallet selects a tier. Once the wallet calls MeltQuote::select_onchain_fee_option the reserve is updated to match the selected option. fee_options itself is never mutated after this call; that invariant is enforced by making the field private.

Source

pub fn fee_options(&self) -> &[MeltQuoteOnchainFeeOption]

Onchain fee options for this quote.

For non-onchain quotes this returns an empty slice. For onchain quotes this is guaranteed non-empty (enforced at construction in MeltQuote::new_onchain and on reload in MeltQuote::from_db).

Source

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

Quote amount

Source

pub fn fee_reserve(&self) -> Amount<CurrencyUnit>

Fee reserve

Source

pub fn select_onchain_fee_option(&mut self, fee_index: u32) -> Result<(), Error>

Select an onchain fee option by its fee_index.

Source

pub fn into_response( self, change: Option<Vec<BlindSignature>>, ) -> MeltQuoteResponse<QuoteId>

Convert into MeltQuoteResponse, overriding change on the inner response with the provided signatures.

Dispatches to the per-variant From<MeltQuote> conversions so that field mapping stays centralized. Note that MeltQuoteBolt12Response is a type alias for MeltQuoteBolt11Response, so both Bolt11 and Bolt12 go through the same conversion.

Source

pub fn total_needed(&self) -> Result<Amount, Error>

Total amount needed (amount + fee_reserve)

Source

pub fn from_db( id: QuoteId, unit: CurrencyUnit, request: MeltPaymentRequest, amount: u64, fee_reserve: u64, state: MeltQuoteState, expiry: u64, payment_proof: Option<String>, request_lookup_id: Option<PaymentIdentifier>, options: Option<MeltOptions>, created_time: u64, paid_time: Option<u64>, payment_method: PaymentMethod, extra_json: Option<Value>, estimated_blocks: Option<u32>, fee_options: Vec<MeltQuoteOnchainFeeOption>, selected_fee_index: Option<u32>, ) -> Result<Self, Error>

Create MeltQuote from database fields (for deserialization)

Trait Implementations§

Source§

impl Clone for MeltQuote

Source§

fn clone(&self) -> MeltQuote

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for MeltQuote

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for MeltQuote

Source§

impl From<&MeltQuote> for MeltQuoteBolt11Response<QuoteId>

Source§

fn from(melt_quote: &MeltQuote) -> MeltQuoteBolt11Response<QuoteId>

Converts to this type from the input type.
Source§

impl<Q> From<MeltQuote> for MeltQuoteResponse<Q>
where Q: From<QuoteId>,

Available on crate feature mint only.
Source§

fn from(value: MeltQuote) -> Self

Converts to this type from the input type.
Source§

impl From<MeltQuote> for MeltQuoteOnchainResponse<QuoteId>

Source§

fn from(quote: MeltQuote) -> Self

Converts to this type from the input type.
Source§

impl From<MeltQuote> for MeltQuoteCustomResponse<QuoteId>

Source§

fn from(melt_quote: MeltQuote) -> Self

Converts to this type from the input type.
Source§

impl From<MeltQuote> for MeltQuoteBolt11Response<QuoteId>

Source§

fn from(melt_quote: MeltQuote) -> MeltQuoteBolt11Response<QuoteId>

Converts to this type from the input type.
Source§

impl Hash for MeltQuote

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for MeltQuote

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl StructuralPartialEq for MeltQuote

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more