Struct ChannelMonitorUpdate

pub struct ChannelMonitorUpdate {
    pub update_id: u64,
    /* private fields */
}

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

Because this represents only a small number of updates to the underlying state, it is generally much smaller than a full ChannelMonitor. However, for large single commitment transaction updates (e.g. ones during which there are hundreds of HTLCs pending on the commitment transaction), a single update may reach upwards of 1 MiB in serialized size.

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 two exceptions specified below.

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

The only instances we allow where update_id values are not strictly increasing have a special update ID of CLOSED_CHANNEL_UPDATE_ID. This update ID is used for updates that will force close the channel by broadcasting the latest commitment transaction or special post-force-close updates, like providing preimages necessary to claim outputs on the broadcast commitment transaction. 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 Debug for ChannelMonitorUpdate

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

Formats the value using the given formatter.

impl PartialEq for ChannelMonitorUpdate

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

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

where R: Read,

Reads a Self in from the given Read.

impl Writeable for ChannelMonitorUpdate

fn write<W>(&self, w: &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.

impl Eq for ChannelMonitorUpdate

impl StructuralPartialEq for ChannelMonitorUpdate