Struct ChannelUpdate

pub struct ChannelUpdate {
    pub signature: Vec<u8>,
    pub chain_hash: Vec<u8>,
    pub chan_id: u64,
    pub timestamp: u32,
    pub message_flags: u32,
    pub channel_flags: u32,
    pub time_lock_delta: u32,
    pub htlc_minimum_msat: u64,
    pub base_fee: u32,
    pub fee_rate: u32,
    pub htlc_maximum_msat: u64,
    pub extra_opaque_data: Vec<u8>,
}

Fields

signature: Vec<u8>

The signature that validates the announced data and proves the ownership of node id.

chain_hash: Vec<u8>

The target chain that this channel was opened within. This value should be the genesis hash of the target chain. Along with the short channel ID, this uniquely identifies the channel globally in a blockchain.

chan_id: u64

The unique description of the funding transaction.

timestamp: u32

A timestamp that allows ordering in the case of multiple announcements. We should ignore the message if timestamp is not greater than the last-received.

message_flags: u32

The bitfield that describes whether optional fields are present in this update. Currently, the least-significant bit must be set to 1 if the optional field MaxHtlc is present.

channel_flags: u32

The bitfield that describes additional meta-data concerning how the update is to be interpreted. Currently, the least-significant bit must be set to 0 if the creating node corresponds to the first node in the previously sent channel announcement and 1 otherwise. If the second bit is set, then the channel is set to be disabled.

time_lock_delta: u32

The minimum number of blocks this node requires to be added to the expiry of HTLCs. This is a security parameter determined by the node operator. This value represents the required gap between the time locks of the incoming and outgoing HTLC’s set to this node.

htlc_minimum_msat: u64

The minimum HTLC value which will be accepted.

base_fee: u32

The base fee that must be used for incoming HTLC’s to this particular channel. This value will be tacked onto the required for a payment independent of the size of the payment.

fee_rate: u32

The fee rate that will be charged per millionth of a satoshi.

htlc_maximum_msat: u64

The maximum HTLC value which will be accepted.

extra_opaque_data: Vec<u8>

The set of data that was appended to this message, some of which we may not actually know how to iterate or parse. By holding onto this data, we ensure that we’re able to properly validate the set of signatures that cover these new fields, and ensure we’re able to make upgrades to the network in a forwards compatible manner.

Trait Implementations

impl Clone for ChannelUpdate

fn clone(&self) -> ChannelUpdate

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ChannelUpdate

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

Formats the value using the given formatter.

impl Default for ChannelUpdate

fn default() -> ChannelUpdate

Returns the “default value” for a type.

impl Message for ChannelUpdate

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message to a buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for ChannelUpdate

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