Struct Htlc

pub struct Htlc { /* private fields */ }

Implementations

impl Htlc

pub fn anchors_zero_fee_htlc_tx(&self) -> &bool

Method borrowing Htlc::anchors_zero_fee_htlc_tx field. Set if the feature option_anchors_zero_fee_htlc_tx was negotiated via

pub fn offered_htlcs(&self) -> &BTreeMap<u64, HtlcSecret>

Method borrowing Htlc::offered_htlcs field.

pub fn received_htlcs(&self) -> &BTreeMap<u64, HtlcSecret>

Method borrowing Htlc::received_htlcs field.

pub fn resolved_htlcs(&self) -> &BTreeMap<u64, HtlcKnown>

Method borrowing Htlc::resolved_htlcs field.

pub fn to_self_delay(&self) -> &u16

Method borrowing Htlc::to_self_delay field.

pub fn local_revocation_basepoint(&self) -> &PublicKey

Method borrowing Htlc::local_revocation_basepoint field.

pub fn remote_revocation_basepoint(&self) -> &PublicKey

Method borrowing Htlc::remote_revocation_basepoint field.

pub fn local_basepoint(&self) -> &PublicKey

Method borrowing Htlc::local_basepoint field.

pub fn remote_basepoint(&self) -> &PublicKey

Method borrowing Htlc::remote_basepoint field.

pub fn local_delayed_basepoint(&self) -> &PublicKey

Method borrowing Htlc::local_delayed_basepoint field.

pub fn channel_id(&self) -> &ChannelId

Method borrowing Htlc::channel_id field.

pub fn htlc_minimum_msat(&self) -> &u64

Method borrowing Htlc::htlc_minimum_msat field. indicates the smallest value HTLC this node will accept.

pub fn max_htlc_value_in_flight_msat(&self) -> &u64

Method borrowing Htlc::max_htlc_value_in_flight_msat field.

pub fn max_accepted_htlcs(&self) -> &u16

Method borrowing Htlc::max_accepted_htlcs field.

pub fn next_recieved_htlc_id(&self) -> &u64

Method borrowing Htlc::next_recieved_htlc_id field.

pub fn next_offered_htlc_id(&self) -> &u64

Method borrowing Htlc::next_offered_htlc_id field.

impl Htlc

pub fn offer_htlc( &mut self, amount_msat: u64, payment_hash: HashLock, cltv_expiry: u32, ) -> u64

Trait Implementations

impl ChannelExtension<BoltExt> for Htlc

fn new() -> Box<dyn ChannelExtension<BoltExt>>

where Self: Sized,

Constructs boxed extension objects which can be inserted into channel extension pipeline

fn build_graph( &self, tx_graph: &mut TxGraph<'_>, _as_remote_node: bool, ) -> Result<(), Error>

Applies state to the channel transaction graph

impl Clone for Htlc

fn clone(&self) -> Htlc

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Htlc

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

Formats the value using the given formatter.

impl Default for Htlc

fn default() -> Self

Returns the “default value” for a type.

impl Extension<BoltExt> for Htlc

fn identity(&self) -> BoltExt

fn update_from_local(&mut self, _message: &()) -> Result<(), Error>

Updates extension state from some local data

fn state_change( &mut self, request: &UpdateReq, message: &mut Messages, ) -> Result<(), Error>

Perform a sate change and produce a message which should be communicated to peers notifying them about the state change

fn update_from_peer(&mut self, message: &Messages) -> Result<(), Error>

Updates extension state from the data taken from the message received from the remote peer

fn load_state(&mut self, state: &ChannelState)

fn store_state(&self, state: &mut ChannelState)

impl Hash for Htlc

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 Ord for Htlc

fn cmp(&self, other: &Htlc) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Htlc

fn eq(&self, other: &Htlc) -> bool

Tests for self and other values to be equal, and is used by ==.

const 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 PartialOrd for Htlc

fn partial_cmp(&self, other: &Htlc) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StrictDecode for Htlc

fn strict_decode<D: Read>(d: D) -> Result<Self, Error>

Decode with the given std::io::Read instance; must either construct an instance or return implementation-specific error type.

fn strict_deserialize(data: impl AsRef<[u8]>) -> Result<Self, Error>

Tries to deserialize byte array into the current type using StrictDecode::strict_decode. If there are some data remains in the buffer once deserialization is completed, fails with Error::DataNotEntirelyConsumed. Use io::Cursor over the buffer and StrictDecode::strict_decode to avoid such failures.

fn strict_file_load(path: impl AsRef<Path>) -> Result<Self, Error>

Reads data from file at path and reconstructs object from it. Fails with Error::DataNotEntirelyConsumed if file contains remaining data after the object reconstruction.

impl StrictEncode for Htlc

fn strict_encode<E: Write>(&self, e: E) -> Result<usize, Error>

Encode with the given std::io::Write instance; must return result with either amount of bytes encoded – or implementation-specific error type.

fn strict_serialize(&self) -> Result<Vec<u8>, Error>

Serializes data as a byte array using StrictEncode::strict_encode function

fn strict_file_save(&self, path: impl AsRef<Path>) -> Result<usize, Error>

Saves data to a file at a given path. If the file does not exists, attempts to create the file. If the file already exists, it gets truncated.

impl Eq for Htlc

impl StructuralPartialEq for Htlc