Payment

breez_sdk_spark

Struct Payment

pub struct Payment {
    pub id: String,
    pub payment_type: PaymentType,
    pub status: PaymentStatus,
    pub amount: u128,
    pub fees: u128,
    pub timestamp: u64,
    pub method: PaymentMethod,
    pub details: Option<PaymentDetails>,
    pub conversion_details: Option<ConversionDetails>,
}

Expand description

Represents a payment (sent or received)

Fields§

§id: String

Unique identifier for the payment

§payment_type: PaymentType

Type of payment (send or receive)

§status: PaymentStatus

Status of the payment

§amount: u128

Amount in satoshis or token base units

§fees: u128

Fee paid in satoshis or token base units

§timestamp: u64

Timestamp of when the payment was created

§method: PaymentMethod

Method of payment. Sometimes the payment details is empty so this field is used to determine the payment method.

§details: Option<PaymentDetails>

Details of the payment

§conversion_details: Option<ConversionDetails>

If set, this payment involved a conversion before the payment

Implementations§

impl Payment

pub fn from_lightning( payment: LightningSendPayment, amount_sat: u128, transfer_id: String, htlc_details: SparkHtlcDetails, ) -> Result<Self, SdkError>

Creates a Payment from a [LightningSendPayment] and its associated HTLC details.

The htlc_details may be stale (e.g. captured at payment creation time), so this method reconciles them with the current state of the payment:

The preimage is taken from htlc_details if present, otherwise from the payment.
If a preimage is available from either source, the HTLC status is set to SparkHtlcStatus::PreimageShared.

Trait Implementations§

impl Clone for Payment

fn clone(&self) -> Payment

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for Payment

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for Payment

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl Serialize for Payment

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

Serialize this value into the given Serde serializer. Read more

impl TryFrom<&Payment> for ConversionStep

Converts a Spark or Token payment into a ConversionStep. Fees are a sum of the payment fee and the conversion fee, if applicable, from the payment details. Token metadata should only be set for a token payment.

type Error = SdkError

The type returned in the event of a conversion error.

fn try_from(payment: &Payment) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<WalletTransfer> for Payment

type Error = SdkError

The type returned in the event of a conversion error.

fn try_from(transfer: WalletTransfer) -> Result<Self, Self::Error>

Performs the conversion.

Auto Trait Implementations§

impl Freeze for Payment

impl RefUnwindSafe for Payment

impl Send for Payment

impl Sync for Payment

impl Unpin for Payment

impl UnwindSafe for Payment

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> FromBase64 for T
where T: for<'de> Deserialize<'de>,

fn from_base64<Input>(raw: &Input) -> Result<T, Error>
where Input: AsRef<[u8]> + ?Sized,

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

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> IntoRequest<T> for T

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request

impl<T> Same for T

type Output = T

Should always be Self

impl<C> SignWithKey<String> for C
where C: ToBase64,

fn sign_with_key(self, key: &impl SigningAlgorithm) -> Result<String, Error>

impl<T> ToBase64 for T
where T: Serialize,

fn to_base64(&self) -> Result<Cow<'_, str>, Error>

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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.

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

impl<T> ErasedDestructor for T
where T: 'static,