Struct lightning::chain::channelmonitor::ChannelMonitorUpdate

pub struct ChannelMonitorUpdate {
    pub update_id: u64,
    // some fields omitted
}

An update generated by the underlying Channel itself which contains some new information the ChannelMonitor should be made aware of.

Fields

update_id: u64

The sequence number of this update. Updates must be replayed in-order according to this sequence number (and updates may panic if they are not). The update_id values are strictly increasing and increase by one for each new update, with one exception specified below.

This sequence number is also used to track up to which points updates which returned ChannelMonitorUpdateErr::TemporaryFailure have been applied to all copies of a given ChannelMonitor when ChannelManager::channel_monitor_updated is called.

The only instance where update_id values are not strictly increasing is the case where we allow post-force-close updates with a special update ID of CLOSED_CHANNEL_UPDATE_ID. See its docs for more details.

Trait Implementations

impl Clone for ChannelMonitorUpdate

fn clone(&self) -> ChannelMonitorUpdate

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Readable for ChannelMonitorUpdate

fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError>

Reads a Self in from the given Read

impl Writeable for ChannelMonitorUpdate

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

Writes self out to the given Writer

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

Writes self out to a Vec

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

Writes self out to a Vec

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.