1 package org.ldk.structs;
3 import org.ldk.impl.bindings;
4 import org.ldk.enums.*;
6 import java.util.Arrays;
7 import java.lang.ref.Reference;
8 import javax.annotation.Nullable;
12 * An update generated by the underlying channel itself which contains some new information the
13 * [`ChannelMonitor`] should be made aware of.
15 * Because this represents only a small number of updates to the underlying state, it is generally
16 * much smaller than a full [`ChannelMonitor`]. However, for large single commitment transaction
17 * updates (e.g. ones during which there are hundreds of HTLCs pending on the commitment
18 * transaction), a single update may reach upwards of 1 MiB in serialized size.
20 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
21 public class ChannelMonitorUpdate extends CommonBase {
22 ChannelMonitorUpdate(Object _dummy, long ptr) { super(ptr); }
23 @Override @SuppressWarnings("deprecation")
24 protected void finalize() throws Throwable {
26 if (ptr != 0) { bindings.ChannelMonitorUpdate_free(ptr); }
30 * The sequence number of this update. Updates *must* be replayed in-order according to this
31 * sequence number (and updates may panic if they are not). The update_id values are strictly
32 * increasing and increase by one for each new update, with two exceptions specified below.
34 * This sequence number is also used to track up to which points updates which returned
35 * [`ChannelMonitorUpdateStatus::InProgress`] have been applied to all copies of a given
36 * ChannelMonitor when ChannelManager::channel_monitor_updated is called.
38 * The only instances we allow where update_id values are not strictly increasing have a
39 * special update ID of [`CLOSED_CHANNEL_UPDATE_ID`]. This update ID is used for updates that
40 * will force close the channel by broadcasting the latest commitment transaction or
41 * special post-force-close updates, like providing preimages necessary to claim outputs on the
42 * broadcast commitment transaction. See its docs for more details.
44 * [`ChannelMonitorUpdateStatus::InProgress`]: super::ChannelMonitorUpdateStatus::InProgress
46 public long get_update_id() {
47 long ret = bindings.ChannelMonitorUpdate_get_update_id(this.ptr);
48 Reference.reachabilityFence(this);
53 * The sequence number of this update. Updates *must* be replayed in-order according to this
54 * sequence number (and updates may panic if they are not). The update_id values are strictly
55 * increasing and increase by one for each new update, with two exceptions specified below.
57 * This sequence number is also used to track up to which points updates which returned
58 * [`ChannelMonitorUpdateStatus::InProgress`] have been applied to all copies of a given
59 * ChannelMonitor when ChannelManager::channel_monitor_updated is called.
61 * The only instances we allow where update_id values are not strictly increasing have a
62 * special update ID of [`CLOSED_CHANNEL_UPDATE_ID`]. This update ID is used for updates that
63 * will force close the channel by broadcasting the latest commitment transaction or
64 * special post-force-close updates, like providing preimages necessary to claim outputs on the
65 * broadcast commitment transaction. See its docs for more details.
67 * [`ChannelMonitorUpdateStatus::InProgress`]: super::ChannelMonitorUpdateStatus::InProgress
69 public void set_update_id(long val) {
70 bindings.ChannelMonitorUpdate_set_update_id(this.ptr, val);
71 Reference.reachabilityFence(this);
72 Reference.reachabilityFence(val);
76 long ret = bindings.ChannelMonitorUpdate_clone_ptr(this.ptr);
77 Reference.reachabilityFence(this);
82 * Creates a copy of the ChannelMonitorUpdate
84 public ChannelMonitorUpdate clone() {
85 long ret = bindings.ChannelMonitorUpdate_clone(this.ptr);
86 Reference.reachabilityFence(this);
87 if (ret >= 0 && ret <= 4096) { return null; }
88 org.ldk.structs.ChannelMonitorUpdate ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.ChannelMonitorUpdate(null, ret); }
89 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
94 * Checks if two ChannelMonitorUpdates contain equal inner contents.
95 * This ignores pointers and is_owned flags and looks at the values in fields.
96 * Two objects with NULL inner values will be considered "equal" here.
98 public boolean eq(org.ldk.structs.ChannelMonitorUpdate b) {
99 boolean ret = bindings.ChannelMonitorUpdate_eq(this.ptr, b == null ? 0 : b.ptr);
100 Reference.reachabilityFence(this);
101 Reference.reachabilityFence(b);
102 if (this != null) { this.ptrs_to.add(b); };
106 @Override public boolean equals(Object o) {
107 if (!(o instanceof ChannelMonitorUpdate)) return false;
108 return this.eq((ChannelMonitorUpdate)o);
111 * Serialize the ChannelMonitorUpdate object into a byte array which can be read by ChannelMonitorUpdate_read
113 public byte[] write() {
114 byte[] ret = bindings.ChannelMonitorUpdate_write(this.ptr);
115 Reference.reachabilityFence(this);
120 * Read a ChannelMonitorUpdate from a byte array, created by ChannelMonitorUpdate_write
122 public static Result_ChannelMonitorUpdateDecodeErrorZ read(byte[] ser) {
123 long ret = bindings.ChannelMonitorUpdate_read(ser);
124 Reference.reachabilityFence(ser);
125 if (ret >= 0 && ret <= 4096) { return null; }
126 Result_ChannelMonitorUpdateDecodeErrorZ ret_hu_conv = Result_ChannelMonitorUpdateDecodeErrorZ.constr_from_ptr(ret);