import * as bindings from '../bindings.mjs'
+/**
+ * An update generated by the underlying Channel itself which contains some new information the
+ * ChannelMonitor should be made aware of.
+ */
export class ChannelMonitorUpdate extends CommonBase {
/* @internal */
public constructor(_dummy: object, ptr: number) {
super(ptr, bindings.ChannelMonitorUpdate_free);
}
+ /**
+ * 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.
+ */
public get_update_id(): bigint {
const ret: bigint = bindings.ChannelMonitorUpdate_get_update_id(this.ptr);
return ret;
}
+ /**
+ * 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.
+ */
public set_update_id(val: bigint): void {
bindings.ChannelMonitorUpdate_set_update_id(this.ptr, val);
}
return ret;
}
+ /**
+ * Creates a copy of the ChannelMonitorUpdate
+ */
public clone(): ChannelMonitorUpdate {
const ret: number = bindings.ChannelMonitorUpdate_clone(this.ptr);
const ret_hu_conv: ChannelMonitorUpdate = new ChannelMonitorUpdate(null, ret);
return ret_hu_conv;
}
+ /**
+ * Serialize the ChannelMonitorUpdate object into a byte array which can be read by ChannelMonitorUpdate_read
+ */
public write(): Uint8Array {
const ret: number = bindings.ChannelMonitorUpdate_write(this.ptr);
const ret_conv: Uint8Array = bindings.decodeUint8Array(ret);
return ret_conv;
}
+ /**
+ * Read a ChannelMonitorUpdate from a byte array, created by ChannelMonitorUpdate_write
+ */
public static constructor_read(ser: Uint8Array): Result_ChannelMonitorUpdateDecodeErrorZ {
const ret: number = bindings.ChannelMonitorUpdate_read(bindings.encodeUint8Array(ser));
const ret_hu_conv: Result_ChannelMonitorUpdateDecodeErrorZ = Result_ChannelMonitorUpdateDecodeErrorZ.constr_from_ptr(ret);