X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Forg%2Fldk%2Fstructs%2FUnsignedChannelUpdate.java;h=758565871ae17eb78e4497b4e2ba6bdc1cc5b356;hb=b6cc0960eaee5a5bbc7fde79a56152d6dcd649d8;hp=d9ca14447338eb2832baa589a4477c9c9c43a3ba;hpb=aa0e2aade37133339f4113a0cd7465b111f0a0d0;p=ldk-java

diff --git a/src/main/java/org/ldk/structs/UnsignedChannelUpdate.java b/src/main/java/org/ldk/structs/UnsignedChannelUpdate.java
index d9ca1444..75856587 100644
--- a/src/main/java/org/ldk/structs/UnsignedChannelUpdate.java
+++ b/src/main/java/org/ldk/structs/UnsignedChannelUpdate.java
@@ -5,6 +5,10 @@ import org.ldk.enums.*;
 import org.ldk.util.*;
 import java.util.Arrays;
 
+
+/**
+ * The unsigned part of a channel_update
+ */
 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
 public class UnsignedChannelUpdate extends CommonBase {
 	UnsignedChannelUpdate(Object _dummy, long ptr) { super(ptr); }
@@ -14,94 +18,164 @@ public class UnsignedChannelUpdate extends CommonBase {
 		if (ptr != 0) { bindings.UnsignedChannelUpdate_free(ptr); }
 	}
 
-	public static UnsignedChannelUpdate constructor_clone(UnsignedChannelUpdate orig) {
-		long ret = bindings.UnsignedChannelUpdate_clone(orig == null ? 0 : orig.ptr & ~1);
-		UnsignedChannelUpdate ret_hu_conv = new UnsignedChannelUpdate(null, ret);
-		ret_hu_conv.ptrs_to.add(orig);
-		return ret_hu_conv;
-	}
-
+	/**
+	 * The genesis hash of the blockchain where the channel is to be opened
+	 */
 	public byte[] get_chain_hash() {
 		byte[] ret = bindings.UnsignedChannelUpdate_get_chain_hash(this.ptr);
 		return ret;
 	}
 
+	/**
+	 * The genesis hash of the blockchain where the channel is to be opened
+	 */
 	public void set_chain_hash(byte[] val) {
 		bindings.UnsignedChannelUpdate_set_chain_hash(this.ptr, val);
 	}
 
+	/**
+	 * The short channel ID
+	 */
 	public long get_short_channel_id() {
 		long ret = bindings.UnsignedChannelUpdate_get_short_channel_id(this.ptr);
 		return ret;
 	}
 
+	/**
+	 * The short channel ID
+	 */
 	public void set_short_channel_id(long val) {
 		bindings.UnsignedChannelUpdate_set_short_channel_id(this.ptr, val);
 	}
 
+	/**
+	 * A strictly monotonic announcement counter, with gaps allowed, specific to this channel
+	 */
 	public int get_timestamp() {
 		int ret = bindings.UnsignedChannelUpdate_get_timestamp(this.ptr);
 		return ret;
 	}
 
+	/**
+	 * A strictly monotonic announcement counter, with gaps allowed, specific to this channel
+	 */
 	public void set_timestamp(int val) {
 		bindings.UnsignedChannelUpdate_set_timestamp(this.ptr, val);
 	}
 
+	/**
+	 * Channel flags
+	 */
 	public byte get_flags() {
 		byte ret = bindings.UnsignedChannelUpdate_get_flags(this.ptr);
 		return ret;
 	}
 
+	/**
+	 * Channel flags
+	 */
 	public void set_flags(byte val) {
 		bindings.UnsignedChannelUpdate_set_flags(this.ptr, val);
 	}
 
+	/**
+	 * The number of blocks such that if:
+	 * `incoming_htlc.cltv_expiry < outgoing_htlc.cltv_expiry + cltv_expiry_delta`
+	 * then we need to fail the HTLC backwards. When forwarding an HTLC, cltv_expiry_delta determines
+	 * the outgoing HTLC's minimum cltv_expiry value -- so, if an incoming HTLC comes in with a
+	 * cltv_expiry of 100000, and the node we're forwarding to has a cltv_expiry_delta value of 10,
+	 * then we'll check that the outgoing HTLC's cltv_expiry value is at least 100010 before
+	 * forwarding. Note that the HTLC sender is the one who originally sets this value when
+	 * constructing the route.
+	 */
 	public short get_cltv_expiry_delta() {
 		short ret = bindings.UnsignedChannelUpdate_get_cltv_expiry_delta(this.ptr);
 		return ret;
 	}
 
+	/**
+	 * The number of blocks such that if:
+	 * `incoming_htlc.cltv_expiry < outgoing_htlc.cltv_expiry + cltv_expiry_delta`
+	 * then we need to fail the HTLC backwards. When forwarding an HTLC, cltv_expiry_delta determines
+	 * the outgoing HTLC's minimum cltv_expiry value -- so, if an incoming HTLC comes in with a
+	 * cltv_expiry of 100000, and the node we're forwarding to has a cltv_expiry_delta value of 10,
+	 * then we'll check that the outgoing HTLC's cltv_expiry value is at least 100010 before
+	 * forwarding. Note that the HTLC sender is the one who originally sets this value when
+	 * constructing the route.
+	 */
 	public void set_cltv_expiry_delta(short val) {
 		bindings.UnsignedChannelUpdate_set_cltv_expiry_delta(this.ptr, val);
 	}
 
+	/**
+	 * The minimum HTLC size incoming to sender, in milli-satoshi
+	 */
 	public long get_htlc_minimum_msat() {
 		long ret = bindings.UnsignedChannelUpdate_get_htlc_minimum_msat(this.ptr);
 		return ret;
 	}
 
+	/**
+	 * The minimum HTLC size incoming to sender, in milli-satoshi
+	 */
 	public void set_htlc_minimum_msat(long val) {
 		bindings.UnsignedChannelUpdate_set_htlc_minimum_msat(this.ptr, val);
 	}
 
+	/**
+	 * The base HTLC fee charged by sender, in milli-satoshi
+	 */
 	public int get_fee_base_msat() {
 		int ret = bindings.UnsignedChannelUpdate_get_fee_base_msat(this.ptr);
 		return ret;
 	}
 
+	/**
+	 * The base HTLC fee charged by sender, in milli-satoshi
+	 */
 	public void set_fee_base_msat(int val) {
 		bindings.UnsignedChannelUpdate_set_fee_base_msat(this.ptr, val);
 	}
 
+	/**
+	 * The amount to fee multiplier, in micro-satoshi
+	 */
 	public int get_fee_proportional_millionths() {
 		int ret = bindings.UnsignedChannelUpdate_get_fee_proportional_millionths(this.ptr);
 		return ret;
 	}
 
+	/**
+	 * The amount to fee multiplier, in micro-satoshi
+	 */
 	public void set_fee_proportional_millionths(int val) {
 		bindings.UnsignedChannelUpdate_set_fee_proportional_millionths(this.ptr, val);
 	}
 
-	public byte[] write(UnsignedChannelUpdate obj) {
-		byte[] ret = bindings.UnsignedChannelUpdate_write(obj == null ? 0 : obj.ptr & ~1);
-		this.ptrs_to.add(obj);
+	/**
+	 * Creates a copy of the UnsignedChannelUpdate
+	 */
+	public UnsignedChannelUpdate clone() {
+		long ret = bindings.UnsignedChannelUpdate_clone(this.ptr);
+		UnsignedChannelUpdate ret_hu_conv = new UnsignedChannelUpdate(null, ret);
+		ret_hu_conv.ptrs_to.add(this);
+		return ret_hu_conv;
+	}
+
+	/**
+	 * Serialize the UnsignedChannelUpdate object into a byte array which can be read by UnsignedChannelUpdate_read
+	 */
+	public byte[] write() {
+		byte[] ret = bindings.UnsignedChannelUpdate_write(this.ptr);
 		return ret;
 	}
 
-	public static UnsignedChannelUpdate constructor_read(byte[] ser) {
+	/**
+	 * Read a UnsignedChannelUpdate from a byte array, created by UnsignedChannelUpdate_write
+	 */
+	public static Result_UnsignedChannelUpdateDecodeErrorZ read(byte[] ser) {
 		long ret = bindings.UnsignedChannelUpdate_read(ser);
-		UnsignedChannelUpdate ret_hu_conv = new UnsignedChannelUpdate(null, ret);
+		Result_UnsignedChannelUpdateDecodeErrorZ ret_hu_conv = Result_UnsignedChannelUpdateDecodeErrorZ.constr_from_ptr(ret);
 		return ret_hu_conv;
 	}