6 namespace org { namespace ldk { namespace structs {
10 * An update generated by the underlying channel itself which contains some new information the
11 * [`ChannelMonitor`] should be made aware of.
13 * Because this represents only a small number of updates to the underlying state, it is generally
14 * much smaller than a full [`ChannelMonitor`]. However, for large single commitment transaction
15 * updates (e.g. ones during which there are hundreds of HTLCs pending on the commitment
16 * transaction), a single update may reach upwards of 1 MiB in serialized size.
18 public class ChannelMonitorUpdate : CommonBase {
19 internal ChannelMonitorUpdate(object _dummy, long ptr) : base(ptr) { }
20 ~ChannelMonitorUpdate() {
21 if (ptr != 0) { bindings.ChannelMonitorUpdate_free(ptr); }
25 * The sequence number of this update. Updates *must* be replayed in-order according to this
26 * sequence number (and updates may panic if they are not). The update_id values are strictly
27 * increasing and increase by one for each new update, with two exceptions specified below.
29 * This sequence number is also used to track up to which points updates which returned
30 * [`ChannelMonitorUpdateStatus::InProgress`] have been applied to all copies of a given
31 * ChannelMonitor when ChannelManager::channel_monitor_updated is called.
33 * The only instances we allow where update_id values are not strictly increasing have a
34 * special update ID of [`CLOSED_CHANNEL_UPDATE_ID`]. This update ID is used for updates that
35 * will force close the channel by broadcasting the latest commitment transaction or
36 * special post-force-close updates, like providing preimages necessary to claim outputs on the
37 * broadcast commitment transaction. See its docs for more details.
39 * [`ChannelMonitorUpdateStatus::InProgress`]: super::ChannelMonitorUpdateStatus::InProgress
41 public long get_update_id() {
42 long ret = bindings.ChannelMonitorUpdate_get_update_id(this.ptr);
48 * The sequence number of this update. Updates *must* be replayed in-order according to this
49 * sequence number (and updates may panic if they are not). The update_id values are strictly
50 * increasing and increase by one for each new update, with two exceptions specified below.
52 * This sequence number is also used to track up to which points updates which returned
53 * [`ChannelMonitorUpdateStatus::InProgress`] have been applied to all copies of a given
54 * ChannelMonitor when ChannelManager::channel_monitor_updated is called.
56 * The only instances we allow where update_id values are not strictly increasing have a
57 * special update ID of [`CLOSED_CHANNEL_UPDATE_ID`]. This update ID is used for updates that
58 * will force close the channel by broadcasting the latest commitment transaction or
59 * special post-force-close updates, like providing preimages necessary to claim outputs on the
60 * broadcast commitment transaction. See its docs for more details.
62 * [`ChannelMonitorUpdateStatus::InProgress`]: super::ChannelMonitorUpdateStatus::InProgress
64 public void set_update_id(long val) {
65 bindings.ChannelMonitorUpdate_set_update_id(this.ptr, val);
71 * The channel ID associated with these updates.
73 * Will be `None` for `ChannelMonitorUpdate`s constructed on LDK versions prior to 0.0.121 and
74 * always `Some` otherwise.
76 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
78 public ChannelId get_channel_id() {
79 long ret = bindings.ChannelMonitorUpdate_get_channel_id(this.ptr);
81 if (ret >= 0 && ret <= 4096) { return null; }
82 org.ldk.structs.ChannelId ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.ChannelId(null, ret); }
83 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.AddLast(this); };
88 * The channel ID associated with these updates.
90 * Will be `None` for `ChannelMonitorUpdate`s constructed on LDK versions prior to 0.0.121 and
91 * always `Some` otherwise.
93 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
95 public void set_channel_id(org.ldk.structs.ChannelId val) {
96 bindings.ChannelMonitorUpdate_set_channel_id(this.ptr, val == null ? 0 : val.ptr);
99 if (this != null) { this.ptrs_to.AddLast(val); };
102 internal long clone_ptr() {
103 long ret = bindings.ChannelMonitorUpdate_clone_ptr(this.ptr);
109 * Creates a copy of the ChannelMonitorUpdate
111 public ChannelMonitorUpdate clone() {
112 long ret = bindings.ChannelMonitorUpdate_clone(this.ptr);
114 if (ret >= 0 && ret <= 4096) { return null; }
115 org.ldk.structs.ChannelMonitorUpdate ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.ChannelMonitorUpdate(null, ret); }
116 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.AddLast(this); };
121 * Checks if two ChannelMonitorUpdates contain equal inner contents.
122 * This ignores pointers and is_owned flags and looks at the values in fields.
123 * Two objects with NULL inner values will be considered "equal" here.
125 public bool eq(org.ldk.structs.ChannelMonitorUpdate b) {
126 bool ret = bindings.ChannelMonitorUpdate_eq(this.ptr, b.ptr);
129 if (this != null) { this.ptrs_to.AddLast(b); };
133 public override bool Equals(object o) {
134 if (!(o is ChannelMonitorUpdate)) return false;
135 return this.eq((ChannelMonitorUpdate)o);
138 * Serialize the ChannelMonitorUpdate object into a byte array which can be read by ChannelMonitorUpdate_read
140 public byte[] write() {
141 long ret = bindings.ChannelMonitorUpdate_write(this.ptr);
143 if (ret >= 0 && ret <= 4096) { return null; }
144 byte[] ret_conv = InternalUtils.decodeUint8Array(ret);
149 * Read a ChannelMonitorUpdate from a byte array, created by ChannelMonitorUpdate_write
151 public static Result_ChannelMonitorUpdateDecodeErrorZ read(byte[] ser) {
152 long ret = bindings.ChannelMonitorUpdate_read(InternalUtils.encodeUint8Array(ser));
154 if (ret >= 0 && ret <= 4096) { return null; }
155 Result_ChannelMonitorUpdateDecodeErrorZ ret_hu_conv = Result_ChannelMonitorUpdateDecodeErrorZ.constr_from_ptr(ret);