Struct PartnerFeeFields 

pub struct PartnerFeeFields {
    pub user_pk: UserPk,
    pub prop_fee: Option<Ppm>,
    pub base_fee: Option<Amount>,
    pub revshare: Option<Decimal>,
}

Information about the partner fees for a specific payment.

The total fee is calculated as:

total_fee (sats) = base_fee + prop_fee * payment_value

Where payment_value is the “sticker price” of the payment:

• Receives: payment_value := recvd_amount + skimmed_fee
• Sends: payment_value := amount_sent

The partner’s revshare tier is determined by total_fee / payment_value, which is converted to a concrete partner revshare proportion based on the revshare schedule here: https://docs.lexe.tech/partner-fees/

Fields

user_pk: UserPk

The user_pk of the partner setting this fee.

prop_fee: Option<Ppm>

The partner-chosen proportional fee. Values of None are currently not allowed.

Minimum: 5000 ppm (LSP_USERNODE_SKIM_FEE_PPM) Maximum: 500,000 ppm (50%)

base_fee: Option<Amount>

The partner-chosen base fee.

This base fee can be set for outbound payments or inbound invoice payments with encoded payment amounts. Due to technical reasons, base fees cannot be set on amountless inbound invoices.

revshare: Option<Decimal>

The partner’s proportion of the total fee, expressed as a decimal.

Example: 0.8 represents an 80% partner share of total_fee.

Currently, only four values are allowed: [0.2, 0.5, 0.7, 0.8], but different revshare tiers may be adopted in the future.

For inbound payments, this is populated during PaymentClaimable.

Implementations

impl PartnerFeeFields

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

pub fn total_fee(&self, payment_value: Amount) -> Amount

total_fee := base_fee + prop_fee * payment_value

Trait Implementations

impl Clone for PartnerFeeFields

fn clone(&self) -> PartnerFeeFields

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PartnerFeeFields

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PartnerFeeFields

fn deserialize<__D>( __deserializer: __D, ) -> Result<PartnerFeeFields, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for PartnerFeeFields

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for PartnerFeeFields

impl Eq for PartnerFeeFields

impl StructuralPartialEq for PartnerFeeFields