Update auto-generated bindings
[ldk-java] / src / main / java / org / ldk / structs / UnsignedChannelUpdate.java
index 9f50b5c6f25be35534125c17e72610f6d4b4b754..294ca4b36522af4de74cdde043f83026ed26b14b 100644 (file)
@@ -79,7 +79,14 @@ public class UnsignedChannelUpdate extends CommonBase {
        }
 
        /**
-        * The number of blocks to subtract from incoming HTLC cltv_expiry values
+        * 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);
@@ -87,7 +94,14 @@ public class UnsignedChannelUpdate extends CommonBase {
        }
 
        /**
-        * The number of blocks to subtract from incoming HTLC cltv_expiry values
+        * 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);