Struct breez_sdk_liquid::model::Payment

source ·
pub struct Payment {
    pub destination: Option<String>,
    pub tx_id: Option<String>,
    pub timestamp: u32,
    pub amount_sat: u64,
    pub fees_sat: u64,
    pub payment_type: PaymentType,
    pub status: PaymentState,
    pub details: PaymentDetails,
}
Expand description

Represents an SDK payment.

By default, this is an onchain tx. It may represent a swap, if swap metadata is available.

Fields§

§destination: Option<String>

The destination associated with the payment, if it was created via our SDK. Can be either a Liquid/Bitcoin address, a Liquid BIP21 URI or an invoice

§tx_id: Option<String>§timestamp: u32

Composite timestamp that can be used for sorting or displaying the payment.

If this payment has an associated swap, it is the swap creation time. Otherwise, the point in time when the underlying tx was included in a block. If there is no associated swap available and the underlying tx is not yet confirmed, the value is now().

§amount_sat: u64

The payment amount, which corresponds to the onchain tx amount.

In case of an outbound payment (Send), this is the payer amount. Otherwise it’s the receiver amount.

§fees_sat: u64

Represents the fees paid by this wallet for this payment.

§Swaps

If there is an associated Send Swap, these fees represent the total fees paid by this wallet (the sender). It is the difference between the amount that was sent and the amount received.

If there is an associated Receive Swap, these fees represent the total fees paid by this wallet (the receiver). It is also the difference between the amount that was sent and the amount received.

§Pure onchain txs

If no swap is associated with this payment:

  • for Send payments, this is the onchain tx fee
  • for Receive payments, this is zero
§payment_type: PaymentType

If it is a Send or Receive payment

§status: PaymentState

Composite status representing the overall status of the payment.

If the tx has no associated swap, this reflects the onchain tx status (confirmed or not).

If the tx has an associated swap, this is determined by the swap status (pending or complete).

§details: PaymentDetails

The details of a payment, depending on its destination and type

Trait Implementations§

source§

impl Clone for Payment

source§

fn clone(&self) -> Payment

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Payment

source§

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

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

impl IntoDart for Payment

source§

fn into_dart(self) -> DartAbi

Consumes Self and Performs the conversion.
source§

impl IntoIntoDart<Payment> for Payment

source§

impl PartialEq for Payment

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl Serialize for Payment

source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
source§

impl IntoDartExceptPrimitive for Payment

source§

impl StructuralPartialEq for Payment

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<T> CloneToUninit for T
where T: Clone,

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

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

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

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

§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
§

impl<T> Instrument for T

§

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

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

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> IntoRequest<T> for T

source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

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

§

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>,

§

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>,

§

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.
§

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

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<T> DartSafe for T

§

impl<T> TaskRetFutTrait for T
where T: Send,