Update auto-updated Java files

[ldk-java] / src / main / java / org / ldk / structs / Balance.java

diff --git a/src/main/java/org/ldk/structs/Balance.java b/src/main/java/org/ldk/structs/Balance.java
index 52d28898e2de9afd553febb0f18499d9f88ce657..2640ac69c5f341466c4bf56adaa6b932355b7c3c 100644 (file)
--- a/src/main/java/org/ldk/structs/Balance.java
+++ b/src/main/java/org/ldk/structs/Balance.java
@@ -4,6 +4,7 @@ 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;
 
 
@@ -38,6 +39,11 @@ public class Balance extends CommonBase {
                assert false; return null; // Unreachable without extending the (internal) bindings interface
        }
 
+       /**
+        * The channel is not yet closed (or the commitment or closing transaction has not yet
+        * appeared in a block). The given balance is claimable (less on-chain fees) if the channel is
+        * force-closed now.
+        */
        public final static class ClaimableOnChannelClose extends Balance {
                /**
                 * The amount available to claim, in satoshis, excluding the on-chain fees which will be
@@ -49,6 +55,10 @@ public class Balance extends CommonBase {
                        this.claimable_amount_satoshis = obj.claimable_amount_satoshis;
                }
        }
+       /**
+        * The channel has been closed, and the given balance is ours but awaiting confirmations until
+        * we consider it spendable.
+        */
        public final static class ClaimableAwaitingConfirmations extends Balance {
                /**
                 * The amount available to claim, in satoshis, possibly excluding the on-chain fees which
@@ -66,6 +76,15 @@ public class Balance extends CommonBase {
                        this.confirmation_height = obj.confirmation_height;
                }
        }
+       /**
+        * The channel has been closed, and the given balance should be ours but awaiting spending
+        * transaction confirmation. If the spending transaction does not confirm in time, it is
+        * possible our counterparty can take the funds by broadcasting an HTLC timeout on-chain.
+        * 
+        * Once the spending transaction confirms, before it has reached enough confirmations to be
+        * considered safe from chain reorganizations, the balance will instead be provided via
+        * [`Balance::ClaimableAwaitingConfirmations`].
+        */
        public final static class ContentiousClaimable extends Balance {
                /**
                 * The amount available to claim, in satoshis, excluding the on-chain fees which will be
@@ -83,6 +102,11 @@ public class Balance extends CommonBase {
                        this.timeout_height = obj.timeout_height;
                }
        }
+       /**
+        * HTLCs which we sent to our counterparty which are claimable after a timeout (less on-chain
+        * fees) if the counterparty does not know the preimage for the HTLCs. These are somewhat
+        * likely to be claimed by our counterparty before we do.
+        */
        public final static class MaybeClaimableHTLCAwaitingTimeout extends Balance {
                /**
                 * The amount available to claim, in satoshis, excluding the on-chain fees which will be
@@ -100,11 +124,18 @@ public class Balance extends CommonBase {
                        this.claimable_height = obj.claimable_height;
                }
        }
+       long clone_ptr() {
+               long ret = bindings.Balance_clone_ptr(this.ptr);
+               Reference.reachabilityFence(this);
+               return ret;
+       }
+
        /**
         * Creates a copy of the Balance
         */
        public Balance clone() {
                long ret = bindings.Balance_clone(this.ptr);
+               Reference.reachabilityFence(this);
                if (ret >= 0 && ret <= 4096) { return null; }
                Balance ret_hu_conv = Balance.constr_from_ptr(ret);
                ret_hu_conv.ptrs_to.add(this);
@@ -116,6 +147,7 @@ public class Balance extends CommonBase {
         */
        public static Balance claimable_on_channel_close(long claimable_amount_satoshis) {
                long ret = bindings.Balance_claimable_on_channel_close(claimable_amount_satoshis);
+               Reference.reachabilityFence(claimable_amount_satoshis);
                if (ret >= 0 && ret <= 4096) { return null; }
                Balance ret_hu_conv = Balance.constr_from_ptr(ret);
                ret_hu_conv.ptrs_to.add(ret_hu_conv);
@@ -127,6 +159,8 @@ public class Balance extends CommonBase {
         */
        public static Balance claimable_awaiting_confirmations(long claimable_amount_satoshis, int confirmation_height) {
                long ret = bindings.Balance_claimable_awaiting_confirmations(claimable_amount_satoshis, confirmation_height);
+               Reference.reachabilityFence(claimable_amount_satoshis);
+               Reference.reachabilityFence(confirmation_height);
                if (ret >= 0 && ret <= 4096) { return null; }
                Balance ret_hu_conv = Balance.constr_from_ptr(ret);
                ret_hu_conv.ptrs_to.add(ret_hu_conv);
@@ -138,6 +172,8 @@ public class Balance extends CommonBase {
         */
        public static Balance contentious_claimable(long claimable_amount_satoshis, int timeout_height) {
                long ret = bindings.Balance_contentious_claimable(claimable_amount_satoshis, timeout_height);
+               Reference.reachabilityFence(claimable_amount_satoshis);
+               Reference.reachabilityFence(timeout_height);
                if (ret >= 0 && ret <= 4096) { return null; }
                Balance ret_hu_conv = Balance.constr_from_ptr(ret);
                ret_hu_conv.ptrs_to.add(ret_hu_conv);
@@ -149,6 +185,8 @@ public class Balance extends CommonBase {
         */
        public static Balance maybe_claimable_htlcawaiting_timeout(long claimable_amount_satoshis, int claimable_height) {
                long ret = bindings.Balance_maybe_claimable_htlcawaiting_timeout(claimable_amount_satoshis, claimable_height);
+               Reference.reachabilityFence(claimable_amount_satoshis);
+               Reference.reachabilityFence(claimable_height);
                if (ret >= 0 && ret <= 4096) { return null; }
                Balance ret_hu_conv = Balance.constr_from_ptr(ret);
                ret_hu_conv.ptrs_to.add(ret_hu_conv);
@@ -161,7 +199,13 @@ public class Balance extends CommonBase {
         */
        public boolean eq(Balance b) {
                boolean ret = bindings.Balance_eq(this.ptr, b == null ? 0 : b.ptr & ~1);
+               Reference.reachabilityFence(this);
+               Reference.reachabilityFence(b);
                return ret;
        }
 
+       @Override public boolean equals(Object o) {
+               if (!(o instanceof Balance)) return false;
+               return this.eq((Balance)o);
+       }
 }