import org.ldk.impl.bindings;
import org.ldk.enums.*;
+import org.ldk.util.*;
+import java.util.Arrays;
+import java.lang.ref.Reference;
+import javax.annotation.Nullable;
+
+/**
+ * An [`update_add_htlc`] message to be sent to or received from a peer.
+ *
+ * [`update_add_htlc`]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#adding-an-htlc-update_add_htlc
+ */
+@SuppressWarnings("unchecked") // We correctly assign various generic arrays
public class UpdateAddHTLC extends CommonBase {
UpdateAddHTLC(Object _dummy, long ptr) { super(ptr); }
@Override @SuppressWarnings("deprecation")
protected void finalize() throws Throwable {
- bindings.UpdateAddHTLC_free(ptr); super.finalize();
+ super.finalize();
+ if (ptr != 0) { bindings.UpdateAddHTLC_free(ptr); }
+ }
+
+ /**
+ * The channel ID
+ */
+ public byte[] get_channel_id() {
+ byte[] ret = bindings.UpdateAddHTLC_get_channel_id(this.ptr);
+ Reference.reachabilityFence(this);
+ return ret;
}
- public UpdateAddHTLC(UpdateAddHTLC orig) {
- super(bindings.UpdateAddHTLC_clone(orig == null ? 0 : orig.ptr & ~1));
- this.ptrs_to.add(orig);
+ /**
+ * The channel ID
+ */
+ public void set_channel_id(byte[] val) {
+ bindings.UpdateAddHTLC_set_channel_id(this.ptr, InternalUtils.check_arr_len(val, 32));
+ Reference.reachabilityFence(this);
+ Reference.reachabilityFence(val);
}
- public byte[] get_channel_id(UpdateAddHTLC this_ptr) {
- byte[] ret = bindings.UpdateAddHTLC_get_channel_id(this_ptr == null ? 0 : this_ptr.ptr & ~1);
- this.ptrs_to.add(this_ptr);
+ /**
+ * The HTLC ID
+ */
+ public long get_htlc_id() {
+ long ret = bindings.UpdateAddHTLC_get_htlc_id(this.ptr);
+ Reference.reachabilityFence(this);
return ret;
}
- public void set_channel_id(UpdateAddHTLC this_ptr, byte[] val) {
- bindings.UpdateAddHTLC_set_channel_id(this_ptr == null ? 0 : this_ptr.ptr & ~1, val);
- this.ptrs_to.add(this_ptr);
+ /**
+ * The HTLC ID
+ */
+ public void set_htlc_id(long val) {
+ bindings.UpdateAddHTLC_set_htlc_id(this.ptr, val);
+ Reference.reachabilityFence(this);
+ Reference.reachabilityFence(val);
}
- public long get_htlc_id(UpdateAddHTLC this_ptr) {
- long ret = bindings.UpdateAddHTLC_get_htlc_id(this_ptr == null ? 0 : this_ptr.ptr & ~1);
- this.ptrs_to.add(this_ptr);
+ /**
+ * The HTLC value in milli-satoshi
+ */
+ public long get_amount_msat() {
+ long ret = bindings.UpdateAddHTLC_get_amount_msat(this.ptr);
+ Reference.reachabilityFence(this);
return ret;
}
- public void set_htlc_id(UpdateAddHTLC this_ptr, long val) {
- bindings.UpdateAddHTLC_set_htlc_id(this_ptr == null ? 0 : this_ptr.ptr & ~1, val);
- this.ptrs_to.add(this_ptr);
+ /**
+ * The HTLC value in milli-satoshi
+ */
+ public void set_amount_msat(long val) {
+ bindings.UpdateAddHTLC_set_amount_msat(this.ptr, val);
+ Reference.reachabilityFence(this);
+ Reference.reachabilityFence(val);
+ }
+
+ /**
+ * The payment hash, the pre-image of which controls HTLC redemption
+ */
+ public byte[] get_payment_hash() {
+ byte[] ret = bindings.UpdateAddHTLC_get_payment_hash(this.ptr);
+ Reference.reachabilityFence(this);
+ return ret;
+ }
+
+ /**
+ * The payment hash, the pre-image of which controls HTLC redemption
+ */
+ public void set_payment_hash(byte[] val) {
+ bindings.UpdateAddHTLC_set_payment_hash(this.ptr, InternalUtils.check_arr_len(val, 32));
+ Reference.reachabilityFence(this);
+ Reference.reachabilityFence(val);
+ }
+
+ /**
+ * The expiry height of the HTLC
+ */
+ public int get_cltv_expiry() {
+ int ret = bindings.UpdateAddHTLC_get_cltv_expiry(this.ptr);
+ Reference.reachabilityFence(this);
+ return ret;
+ }
+
+ /**
+ * The expiry height of the HTLC
+ */
+ public void set_cltv_expiry(int val) {
+ bindings.UpdateAddHTLC_set_cltv_expiry(this.ptr, val);
+ Reference.reachabilityFence(this);
+ Reference.reachabilityFence(val);
+ }
+
+ /**
+ * The extra fee skimmed by the sender of this message. See
+ * [`ChannelConfig::accept_underpaying_htlcs`].
+ *
+ * [`ChannelConfig::accept_underpaying_htlcs`]: crate::util::config::ChannelConfig::accept_underpaying_htlcs
+ */
+ public Option_u64Z get_skimmed_fee_msat() {
+ long ret = bindings.UpdateAddHTLC_get_skimmed_fee_msat(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 extra fee skimmed by the sender of this message. See
+ * [`ChannelConfig::accept_underpaying_htlcs`].
+ *
+ * [`ChannelConfig::accept_underpaying_htlcs`]: crate::util::config::ChannelConfig::accept_underpaying_htlcs
+ */
+ public void set_skimmed_fee_msat(org.ldk.structs.Option_u64Z val) {
+ bindings.UpdateAddHTLC_set_skimmed_fee_msat(this.ptr, val.ptr);
+ Reference.reachabilityFence(this);
+ Reference.reachabilityFence(val);
+ if (this != null) { this.ptrs_to.add(val); };
+ }
+
+ /**
+ * The onion routing packet with encrypted data for the next hop.
+ */
+ public OnionPacket get_onion_routing_packet() {
+ long ret = bindings.UpdateAddHTLC_get_onion_routing_packet(this.ptr);
+ Reference.reachabilityFence(this);
+ if (ret >= 0 && ret <= 4096) { return null; }
+ org.ldk.structs.OnionPacket ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.OnionPacket(null, ret); }
+ if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
+ return ret_hu_conv;
+ }
+
+ /**
+ * The onion routing packet with encrypted data for the next hop.
+ */
+ public void set_onion_routing_packet(org.ldk.structs.OnionPacket val) {
+ bindings.UpdateAddHTLC_set_onion_routing_packet(this.ptr, val == null ? 0 : val.ptr);
+ Reference.reachabilityFence(this);
+ Reference.reachabilityFence(val);
+ if (this != null) { this.ptrs_to.add(val); };
}
- public long get_amount_msat(UpdateAddHTLC this_ptr) {
- long ret = bindings.UpdateAddHTLC_get_amount_msat(this_ptr == null ? 0 : this_ptr.ptr & ~1);
- this.ptrs_to.add(this_ptr);
+ /**
+ * Provided if we are relaying or receiving a payment within a blinded path, to decrypt the onion
+ * routing packet and the recipient-provided encrypted payload within.
+ *
+ * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
+ */
+ @Nullable
+ public byte[] get_blinding_point() {
+ byte[] ret = bindings.UpdateAddHTLC_get_blinding_point(this.ptr);
+ Reference.reachabilityFence(this);
return ret;
}
- public void set_amount_msat(UpdateAddHTLC this_ptr, long val) {
- bindings.UpdateAddHTLC_set_amount_msat(this_ptr == null ? 0 : this_ptr.ptr & ~1, val);
- this.ptrs_to.add(this_ptr);
+ /**
+ * Provided if we are relaying or receiving a payment within a blinded path, to decrypt the onion
+ * routing packet and the recipient-provided encrypted payload within.
+ *
+ * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
+ */
+ public void set_blinding_point(@Nullable byte[] val) {
+ bindings.UpdateAddHTLC_set_blinding_point(this.ptr, InternalUtils.check_arr_len(val, 33));
+ Reference.reachabilityFence(this);
+ Reference.reachabilityFence(val);
}
- public byte[] get_payment_hash(UpdateAddHTLC this_ptr) {
- byte[] ret = bindings.UpdateAddHTLC_get_payment_hash(this_ptr == null ? 0 : this_ptr.ptr & ~1);
- this.ptrs_to.add(this_ptr);
+ /**
+ * Constructs a new UpdateAddHTLC given each field
+ *
+ * Note that blinding_point_arg (or a relevant inner pointer) may be NULL or all-0s to represent None
+ */
+ public static UpdateAddHTLC of(byte[] channel_id_arg, long htlc_id_arg, long amount_msat_arg, byte[] payment_hash_arg, int cltv_expiry_arg, org.ldk.structs.Option_u64Z skimmed_fee_msat_arg, org.ldk.structs.OnionPacket onion_routing_packet_arg, @Nullable byte[] blinding_point_arg) {
+ long ret = bindings.UpdateAddHTLC_new(InternalUtils.check_arr_len(channel_id_arg, 32), htlc_id_arg, amount_msat_arg, InternalUtils.check_arr_len(payment_hash_arg, 32), cltv_expiry_arg, skimmed_fee_msat_arg.ptr, onion_routing_packet_arg == null ? 0 : onion_routing_packet_arg.ptr, InternalUtils.check_arr_len(blinding_point_arg, 33));
+ Reference.reachabilityFence(channel_id_arg);
+ Reference.reachabilityFence(htlc_id_arg);
+ Reference.reachabilityFence(amount_msat_arg);
+ Reference.reachabilityFence(payment_hash_arg);
+ Reference.reachabilityFence(cltv_expiry_arg);
+ Reference.reachabilityFence(skimmed_fee_msat_arg);
+ Reference.reachabilityFence(onion_routing_packet_arg);
+ Reference.reachabilityFence(blinding_point_arg);
+ if (ret >= 0 && ret <= 4096) { return null; }
+ org.ldk.structs.UpdateAddHTLC ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.UpdateAddHTLC(null, ret); }
+ if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(ret_hu_conv); };
+ if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(skimmed_fee_msat_arg); };
+ if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(onion_routing_packet_arg); };
+ return ret_hu_conv;
+ }
+
+ long clone_ptr() {
+ long ret = bindings.UpdateAddHTLC_clone_ptr(this.ptr);
+ Reference.reachabilityFence(this);
return ret;
}
- public void set_payment_hash(UpdateAddHTLC this_ptr, byte[] val) {
- bindings.UpdateAddHTLC_set_payment_hash(this_ptr == null ? 0 : this_ptr.ptr & ~1, val);
- this.ptrs_to.add(this_ptr);
+ /**
+ * Creates a copy of the UpdateAddHTLC
+ */
+ public UpdateAddHTLC clone() {
+ long ret = bindings.UpdateAddHTLC_clone(this.ptr);
+ Reference.reachabilityFence(this);
+ if (ret >= 0 && ret <= 4096) { return null; }
+ org.ldk.structs.UpdateAddHTLC ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.UpdateAddHTLC(null, ret); }
+ if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
+ return ret_hu_conv;
}
- public int get_cltv_expiry(UpdateAddHTLC this_ptr) {
- int ret = bindings.UpdateAddHTLC_get_cltv_expiry(this_ptr == null ? 0 : this_ptr.ptr & ~1);
- this.ptrs_to.add(this_ptr);
+ /**
+ * Generates a non-cryptographic 64-bit hash of the UpdateAddHTLC.
+ */
+ public long hash() {
+ long ret = bindings.UpdateAddHTLC_hash(this.ptr);
+ Reference.reachabilityFence(this);
return ret;
}
- public void set_cltv_expiry(UpdateAddHTLC this_ptr, int val) {
- bindings.UpdateAddHTLC_set_cltv_expiry(this_ptr == null ? 0 : this_ptr.ptr & ~1, val);
- this.ptrs_to.add(this_ptr);
+ @Override public int hashCode() {
+ return (int)this.hash();
+ }
+ /**
+ * Checks if two UpdateAddHTLCs 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.UpdateAddHTLC b) {
+ boolean ret = bindings.UpdateAddHTLC_eq(this.ptr, b == null ? 0 : 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 UpdateAddHTLC)) return false;
+ return this.eq((UpdateAddHTLC)o);
+ }
+ /**
+ * Serialize the UpdateAddHTLC object into a byte array which can be read by UpdateAddHTLC_read
+ */
+ public byte[] write() {
+ byte[] ret = bindings.UpdateAddHTLC_write(this.ptr);
+ Reference.reachabilityFence(this);
+ return ret;
}
- // Skipped UpdateAddHTLC_write
- public UpdateAddHTLC(byte[] ser) {
- super(bindings.UpdateAddHTLC_read(ser));
+ /**
+ * Read a UpdateAddHTLC from a byte array, created by UpdateAddHTLC_write
+ */
+ public static Result_UpdateAddHTLCDecodeErrorZ read(byte[] ser) {
+ long ret = bindings.UpdateAddHTLC_read(ser);
+ Reference.reachabilityFence(ser);
+ if (ret >= 0 && ret <= 4096) { return null; }
+ Result_UpdateAddHTLCDecodeErrorZ ret_hu_conv = Result_UpdateAddHTLCDecodeErrorZ.constr_from_ptr(ret);
+ return ret_hu_conv;
}
}