Enum OfferKind

pub enum OfferKind {
    Pocket {
        id: String,
        exchange_rate: ExchangeRate,
        topup_value_minor_units: u64,
        topup_value_sats: Option<u64>,
        exchange_fee_minor_units: u64,
        exchange_fee_rate_permyriad: u16,
        lightning_payout_fee: Option<Amount>,
        error: Option<PocketOfferError>,
    },
}

Variants

Pocket

An offer related to a topup using the Pocket exchange Values are denominated in the fiat currency the user sent to the exchange. The currency code can be found in exchange_rate.

Fields

id: String

exchange_rate: ExchangeRate

The exchange rate used by the exchange to exchange fiat to sats.

topup_value_minor_units: u64

The original fiat amount sent to the exchange.

topup_value_sats: Option<u64>

The sat amount after the exchange. Isn’t available for topups collected before version v0.30.0-beta.

exchange_fee_minor_units: u64

The fee paid to perform the exchange from fiat to sats.

exchange_fee_rate_permyriad: u16

The rate of the fee expressed in permyriad (e.g. 1.5% would be 150).

lightning_payout_fee: Option<Amount>

Optional payout fees collected by pocket.

error: Option<PocketOfferError>

The optional error that might have occurred in the offer withdrawal process.

Trait Implementations

impl Clone for OfferKind

fn clone(&self) -> OfferKind

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OfferKind

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

Formats the value using the given formatter.

impl PartialEq for OfferKind

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

impl StructuralPartialEq for OfferKind