Struct InFlightHtlcs

pub struct InFlightHtlcs(/* private fields */);

A data structure for tracking in-flight HTLCs. May be used during pathfinding to account for in-use channel liquidity.

Implementations

impl InFlightHtlcs

pub fn new() -> InFlightHtlcs

Constructs an empty InFlightHtlcs.

pub fn process_path(&mut self, path: &Path, payer_node_id: PublicKey)

Takes in a path with payer’s node id and adds the path’s details to InFlightHtlcs.

pub fn add_inflight_htlc( &mut self, source: &NodeId, target: &NodeId, channel_scid: u64, used_msat: u64, )

Adds a known HTLC given the public key of the HTLC source, target, and short channel id.

pub fn used_liquidity_msat( &self, source: &NodeId, target: &NodeId, channel_scid: u64, ) -> Option<u64>

Returns liquidity in msat given the public key of the HTLC source, target, and short channel id.

Trait Implementations

impl Clone for InFlightHtlcs

fn clone(&self) -> InFlightHtlcs

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Readable for InFlightHtlcs

fn read<R>(reader: &mut R) -> Result<InFlightHtlcs, DecodeError>

where R: Read,

Reads a Self in from the given Read.

impl Writeable for InFlightHtlcs

fn write<W>(&self, writer: &mut W) -> Result<(), Error>

where W: Writer,

Writes self out to the given Writer.

fn encode(&self) -> Vec<u8>

Writes self out to a Vec<u8>.

fn serialized_length(&self) -> usize

Gets the length of this object after it has been serialized. This can be overridden to optimize cases where we prepend an object with its length.