import org.ldk.enums.*;
import org.ldk.util.*;
import java.util.Arrays;
+import java.lang.ref.Reference;
+import javax.annotation.Nullable;
+
+/**
+ * Details about a channel (both directions).
+ * Received within a channel announcement.
+ */
@SuppressWarnings("unchecked") // We correctly assign various generic arrays
public class ChannelInfo extends CommonBase {
ChannelInfo(Object _dummy, long ptr) { super(ptr); }
if (ptr != 0) { bindings.ChannelInfo_free(ptr); }
}
+ /**
+ * Protocol features of a channel communicated during its announcement
+ */
public ChannelFeatures get_features() {
long ret = bindings.ChannelInfo_get_features(this.ptr);
- ChannelFeatures ret_hu_conv = new ChannelFeatures(null, ret);
- ret_hu_conv.ptrs_to.add(this);
+ Reference.reachabilityFence(this);
+ if (ret >= 0 && ret <= 4096) { return null; }
+ org.ldk.structs.ChannelFeatures ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.ChannelFeatures(null, ret); }
+ if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
return ret_hu_conv;
}
- public void set_features(ChannelFeatures val) {
- bindings.ChannelInfo_set_features(this.ptr, val == null ? 0 : val.ptr & ~1);
- this.ptrs_to.add(val);
- // Due to rust's strict-ownership memory model, in some cases we need to "move"
- // an object to pass exclusive ownership to the function being called.
- // In most cases, we avoid this being visible in GC'd languages by cloning the object
- // at the FFI layer, creating a new object which Rust can claim ownership of
- // However, in some cases (eg here), there is no way to clone an object, and thus
- // we actually have to pass full ownership to Rust.
- // Thus, after this call, val is reset to null and is now a dummy object.
- val.ptr = 0;
+ /**
+ * Protocol features of a channel communicated during its announcement
+ */
+ public void set_features(org.ldk.structs.ChannelFeatures val) {
+ bindings.ChannelInfo_set_features(this.ptr, val.ptr);
+ Reference.reachabilityFence(this);
+ Reference.reachabilityFence(val);
}
- public byte[] get_node_one() {
- byte[] ret = bindings.ChannelInfo_get_node_one(this.ptr);
- return ret;
+ /**
+ * Source node of the first direction of a channel
+ */
+ public NodeId get_node_one() {
+ long ret = bindings.ChannelInfo_get_node_one(this.ptr);
+ Reference.reachabilityFence(this);
+ if (ret >= 0 && ret <= 4096) { return null; }
+ org.ldk.structs.NodeId ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.NodeId(null, ret); }
+ if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
+ return ret_hu_conv;
}
- public void set_node_one(byte[] val) {
- bindings.ChannelInfo_set_node_one(this.ptr, val);
+ /**
+ * Source node of the first direction of a channel
+ */
+ public void set_node_one(org.ldk.structs.NodeId val) {
+ bindings.ChannelInfo_set_node_one(this.ptr, val.ptr);
+ Reference.reachabilityFence(this);
+ Reference.reachabilityFence(val);
}
- public DirectionalChannelInfo get_one_to_two() {
- long ret = bindings.ChannelInfo_get_one_to_two(this.ptr);
- DirectionalChannelInfo ret_hu_conv = new DirectionalChannelInfo(null, ret);
- ret_hu_conv.ptrs_to.add(this);
+ /**
+ * Source node of the second direction of a channel
+ */
+ public NodeId get_node_two() {
+ long ret = bindings.ChannelInfo_get_node_two(this.ptr);
+ Reference.reachabilityFence(this);
+ if (ret >= 0 && ret <= 4096) { return null; }
+ org.ldk.structs.NodeId ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.NodeId(null, ret); }
+ if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
return ret_hu_conv;
}
- public void set_one_to_two(DirectionalChannelInfo val) {
- bindings.ChannelInfo_set_one_to_two(this.ptr, val == null ? 0 : val.ptr & ~1);
- this.ptrs_to.add(val);
+ /**
+ * Source node of the second direction of a channel
+ */
+ public void set_node_two(org.ldk.structs.NodeId val) {
+ bindings.ChannelInfo_set_node_two(this.ptr, val.ptr);
+ Reference.reachabilityFence(this);
+ Reference.reachabilityFence(val);
}
- public byte[] get_node_two() {
- byte[] ret = bindings.ChannelInfo_get_node_two(this.ptr);
- return ret;
+ /**
+ * The channel capacity as seen on-chain, if chain lookup is available.
+ */
+ public Option_u64Z get_capacity_sats() {
+ long ret = bindings.ChannelInfo_get_capacity_sats(this.ptr);
+ Reference.reachabilityFence(this);
+ if (ret >= 0 && ret <= 4096) { return null; }
+ org.ldk.structs.Option_u64Z ret_hu_conv = org.ldk.structs.Option_u64Z.constr_from_ptr(ret);
+ if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
+ return ret_hu_conv;
+ }
+
+ /**
+ * The channel capacity as seen on-chain, if chain lookup is available.
+ */
+ public void set_capacity_sats(org.ldk.structs.Option_u64Z val) {
+ bindings.ChannelInfo_set_capacity_sats(this.ptr, val.ptr);
+ Reference.reachabilityFence(this);
+ Reference.reachabilityFence(val);
}
- public void set_node_two(byte[] val) {
- bindings.ChannelInfo_set_node_two(this.ptr, val);
+ /**
+ * Details about the first direction of a channel
+ *
+ * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
+ */
+ @Nullable
+ public ChannelUpdateInfo get_one_to_two() {
+ long ret = bindings.ChannelInfo_get_one_to_two(this.ptr);
+ Reference.reachabilityFence(this);
+ if (ret >= 0 && ret <= 4096) { return null; }
+ org.ldk.structs.ChannelUpdateInfo ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.ChannelUpdateInfo(null, ret); }
+ if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
+ return ret_hu_conv;
}
- public DirectionalChannelInfo get_two_to_one() {
+ /**
+ * Details about the first direction of a channel
+ *
+ * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
+ */
+ public void set_one_to_two(@Nullable org.ldk.structs.ChannelUpdateInfo val) {
+ bindings.ChannelInfo_set_one_to_two(this.ptr, val == null ? 0 : val.ptr);
+ Reference.reachabilityFence(this);
+ Reference.reachabilityFence(val);
+ }
+
+ /**
+ * Details about the second direction of a channel
+ *
+ * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
+ */
+ @Nullable
+ public ChannelUpdateInfo get_two_to_one() {
long ret = bindings.ChannelInfo_get_two_to_one(this.ptr);
- DirectionalChannelInfo ret_hu_conv = new DirectionalChannelInfo(null, ret);
- ret_hu_conv.ptrs_to.add(this);
+ Reference.reachabilityFence(this);
+ if (ret >= 0 && ret <= 4096) { return null; }
+ org.ldk.structs.ChannelUpdateInfo ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.ChannelUpdateInfo(null, ret); }
+ if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
return ret_hu_conv;
}
- public void set_two_to_one(DirectionalChannelInfo val) {
- bindings.ChannelInfo_set_two_to_one(this.ptr, val == null ? 0 : val.ptr & ~1);
- this.ptrs_to.add(val);
+ /**
+ * Details about the second direction of a channel
+ *
+ * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
+ */
+ public void set_two_to_one(@Nullable org.ldk.structs.ChannelUpdateInfo val) {
+ bindings.ChannelInfo_set_two_to_one(this.ptr, val == null ? 0 : val.ptr);
+ Reference.reachabilityFence(this);
+ Reference.reachabilityFence(val);
}
+ /**
+ * An initial announcement of the channel
+ * Mostly redundant with the data we store in fields explicitly.
+ * Everything else is useful only for sending out for initial routing sync.
+ * Not stored if contains excess data to prevent DoS.
+ *
+ * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
+ */
+ @Nullable
public ChannelAnnouncement get_announcement_message() {
long ret = bindings.ChannelInfo_get_announcement_message(this.ptr);
- ChannelAnnouncement ret_hu_conv = new ChannelAnnouncement(null, ret);
- ret_hu_conv.ptrs_to.add(this);
+ Reference.reachabilityFence(this);
+ if (ret >= 0 && ret <= 4096) { return null; }
+ org.ldk.structs.ChannelAnnouncement ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.ChannelAnnouncement(null, ret); }
+ if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
+ return ret_hu_conv;
+ }
+
+ /**
+ * An initial announcement of the channel
+ * Mostly redundant with the data we store in fields explicitly.
+ * Everything else is useful only for sending out for initial routing sync.
+ * Not stored if contains excess data to prevent DoS.
+ *
+ * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
+ */
+ public void set_announcement_message(@Nullable org.ldk.structs.ChannelAnnouncement val) {
+ bindings.ChannelInfo_set_announcement_message(this.ptr, val == null ? 0 : val.ptr);
+ Reference.reachabilityFence(this);
+ Reference.reachabilityFence(val);
+ }
+
+ long clone_ptr() {
+ long ret = bindings.ChannelInfo_clone_ptr(this.ptr);
+ Reference.reachabilityFence(this);
+ return ret;
+ }
+
+ /**
+ * Creates a copy of the ChannelInfo
+ */
+ public ChannelInfo clone() {
+ long ret = bindings.ChannelInfo_clone(this.ptr);
+ Reference.reachabilityFence(this);
+ if (ret >= 0 && ret <= 4096) { return null; }
+ org.ldk.structs.ChannelInfo ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.ChannelInfo(null, ret); }
+ if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
+ return ret_hu_conv;
+ }
+
+ /**
+ * Checks if two ChannelInfos contain equal inner contents.
+ * This ignores pointers and is_owned flags and looks at the values in fields.
+ * Two objects with NULL inner values will be considered "equal" here.
+ */
+ public boolean eq(org.ldk.structs.ChannelInfo b) {
+ boolean ret = bindings.ChannelInfo_eq(this.ptr, b.ptr);
+ Reference.reachabilityFence(this);
+ Reference.reachabilityFence(b);
+ if (this != null) { this.ptrs_to.add(b); };
+ return ret;
+ }
+
+ @Override public boolean equals(Object o) {
+ if (!(o instanceof ChannelInfo)) return false;
+ return this.eq((ChannelInfo)o);
+ }
+ /**
+ * Returns a [`ChannelUpdateInfo`] based on the direction implied by the channel_flag.
+ *
+ * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
+ */
+ @Nullable
+ public ChannelUpdateInfo get_directional_info(byte channel_flags) {
+ long ret = bindings.ChannelInfo_get_directional_info(this.ptr, channel_flags);
+ Reference.reachabilityFence(this);
+ Reference.reachabilityFence(channel_flags);
+ if (ret >= 0 && ret <= 4096) { return null; }
+ org.ldk.structs.ChannelUpdateInfo ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.ChannelUpdateInfo(null, ret); }
+ if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
return ret_hu_conv;
}
- public void set_announcement_message(ChannelAnnouncement val) {
- bindings.ChannelInfo_set_announcement_message(this.ptr, val == null ? 0 : val.ptr & ~1);
- this.ptrs_to.add(val);
+ /**
+ * Get the string representation of a ChannelInfo object
+ */
+ public String to_str() {
+ String ret = bindings.ChannelInfo_to_str(this.ptr);
+ Reference.reachabilityFence(this);
+ return ret;
}
+ /**
+ * Serialize the ChannelInfo object into a byte array which can be read by ChannelInfo_read
+ */
public byte[] write() {
byte[] ret = bindings.ChannelInfo_write(this.ptr);
+ Reference.reachabilityFence(this);
return ret;
}
- public static ChannelInfo constructor_read(byte[] ser) {
+ /**
+ * Read a ChannelInfo from a byte array, created by ChannelInfo_write
+ */
+ public static Result_ChannelInfoDecodeErrorZ read(byte[] ser) {
long ret = bindings.ChannelInfo_read(ser);
- ChannelInfo ret_hu_conv = new ChannelInfo(null, ret);
- ret_hu_conv.ptrs_to.add(ret_hu_conv);
+ Reference.reachabilityFence(ser);
+ if (ret >= 0 && ret <= 4096) { return null; }
+ Result_ChannelInfoDecodeErrorZ ret_hu_conv = Result_ChannelInfoDecodeErrorZ.constr_from_ptr(ret);
return ret_hu_conv;
}