Struct RoutedPayment

pub struct RoutedPayment {
    pub incoming: OrderedMap<ChannelId, u64>,
    pub outgoing: OrderedMap<ChannelId, u64>,
    pub preimage: Option<PaymentPreimage>,
}

Keeps track of incoming and outgoing HTLCs for a routed payment

Fields

incoming: OrderedMap<ChannelId, u64>

Incoming payments per channel in satoshi

outgoing: OrderedMap<ChannelId, u64>

Outgoing payments per channel in satoshi

preimage: Option<PaymentPreimage>

The preimage for the hash, filled in on success

Implementations

impl RoutedPayment

pub fn new() -> RoutedPayment

Create an empty routed payment

pub fn is_fulfilled(&self) -> bool

Whether we know the preimage, and therefore the incoming is claimable

pub fn is_no_incoming(&self) -> bool

Whether there is any incoming payment

pub fn is_no_outgoing(&self) -> bool

Whether there is no outgoing payment

pub fn updated_incoming_outgoing( &self, channel_id: &ChannelId, incoming_amount_sat: u64, outgoing_amount_sat: u64, ) -> (u64, u64)

The total incoming and outgoing, if this channel updates to the specified values

pub fn incoming_outgoing(&self) -> (u64, u64)

The total incoming and outgoing, in satoshi

pub fn apply( &mut self, channel_id: &ChannelId, incoming_amount_sat: u64, outgoing_amount_sat: u64, )

Apply incoming and outgoing payment for a channel, in satoshi

Trait Implementations

impl Clone for RoutedPayment

fn clone(&self) -> RoutedPayment

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RoutedPayment

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

Formats the value using the given formatter.