Enum PaymentState

pub enum PaymentState {
    Created = 0,
    Pending = 1,
    Complete = 2,
    Failed = 3,
    TimedOut = 4,
    Refundable = 5,
    RefundPending = 6,
}

The payment state of an individual payment.

Variants

Created = 0

Pending = 1

Receive Swaps

Covers the cases when

• the lockup tx is seen in the mempool or
• our claim tx is broadcast

When the claim tx is broadcast, claim_tx_id is set in the swap.

Send Swaps

This is the status when our lockup tx was broadcast

Chain Swaps

This is the status when the user lockup tx was broadcast

No swap data available

If no associated swap is found, this indicates the underlying tx is not confirmed yet.

Complete = 2

Receive Swaps

Covers the case when the claim tx is confirmed.

Send and Chain Swaps

This is the status when the claim tx is broadcast and we see it in the mempool.

No swap data available

If no associated swap is found, this indicates the underlying tx is confirmed.

Failed = 3

Receive Swaps

This is the status when the swap failed for any reason and the Receive could not complete.

Send and Chain Swaps

This is the status when a swap refund was initiated and the refund tx is confirmed.

TimedOut = 4

Send and Outgoing Chain Swaps

This covers the case when the swap state is still Created and the swap fails to reach the Pending state in time. The TimedOut state indicates the lockup tx should never be broadcast.

Refundable = 5

Incoming Chain Swaps

This covers the case when the swap failed for any reason and there is a user lockup tx. The swap in this case has to be manually refunded with a provided Bitcoin address

RefundPending = 6

Send and Chain Swaps

This is the status when a refund was initiated and/or our refund tx was broadcast

When the refund tx is broadcast, refund_tx_id is set in the swap.

Trait Implementations

impl Clone for PaymentState

fn clone(&self) -> PaymentState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PaymentState

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

Formats the value using the given formatter.

impl FromSql for PaymentState

fn column_result(value: ValueRef<'_>) -> FromSqlResult<Self>

Converts SQLite value into Rust value.

impl Hash for PaymentState

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

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 IntoDart for PaymentState

fn into_dart(self) -> DartAbi

Consumes Self and Performs the conversion.

impl IntoIntoDart<PaymentState> for PaymentState

fn into_into_dart(self) -> PaymentState

impl PartialEq for PaymentState

fn eq(&self, other: &PaymentState) -> 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 PaymentState

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToSql for PaymentState

fn to_sql(&self) -> Result<ToSqlOutput<'_>>

Converts Rust value to SQLite value

impl Copy for PaymentState

impl Eq for PaymentState

impl IntoDartExceptPrimitive for PaymentState

impl StructuralPartialEq for PaymentState