[Java] Update auto-generated bindings to 0.0.117
[ldk-java] / src / main / java / org / ldk / structs / TrustedCommitmentTransaction.java
index 0816d27cc90f0484a8c3ea9d4fff3a2ae36417ae..9e7aa762aa85e60bb79c7e0c7093f9feedcd5e0c 100644 (file)
@@ -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;
 
 
@@ -29,6 +30,7 @@ public class TrustedCommitmentTransaction extends CommonBase {
         */
        public byte[] txid() {
                byte[] ret = bindings.TrustedCommitmentTransaction_txid(this.ptr);
+               Reference.reachabilityFence(this);
                return ret;
        }
 
@@ -37,9 +39,10 @@ public class TrustedCommitmentTransaction extends CommonBase {
         */
        public BuiltCommitmentTransaction built_transaction() {
                long ret = bindings.TrustedCommitmentTransaction_built_transaction(this.ptr);
+               Reference.reachabilityFence(this);
                if (ret >= 0 && ret <= 4096) { return null; }
-               BuiltCommitmentTransaction ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new BuiltCommitmentTransaction(null, ret); }
-               ret_hu_conv.ptrs_to.add(this);
+               org.ldk.structs.BuiltCommitmentTransaction ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.BuiltCommitmentTransaction(null, ret); }
+               if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
                return ret_hu_conv;
        }
 
@@ -48,9 +51,22 @@ public class TrustedCommitmentTransaction extends CommonBase {
         */
        public TxCreationKeys keys() {
                long ret = bindings.TrustedCommitmentTransaction_keys(this.ptr);
+               Reference.reachabilityFence(this);
                if (ret >= 0 && ret <= 4096) { return null; }
-               TxCreationKeys ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new TxCreationKeys(null, ret); }
-               ret_hu_conv.ptrs_to.add(this);
+               org.ldk.structs.TxCreationKeys ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.TxCreationKeys(null, ret); }
+               if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
+               return ret_hu_conv;
+       }
+
+       /**
+        * Should anchors be used.
+        */
+       public ChannelTypeFeatures channel_type_features() {
+               long ret = bindings.TrustedCommitmentTransaction_channel_type_features(this.ptr);
+               Reference.reachabilityFence(this);
+               if (ret >= 0 && ret <= 4096) { return null; }
+               org.ldk.structs.ChannelTypeFeatures ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.ChannelTypeFeatures(null, ret); }
+               if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
                return ret_hu_conv;
        }
 
@@ -59,12 +75,62 @@ public class TrustedCommitmentTransaction extends CommonBase {
         * which HTLCOutputInCommitment::transaction_output_index.is_some()).
         * 
         * The returned Vec has one entry for each HTLC, and in the same order.
+        * 
+        * This function is only valid in the holder commitment context, it always uses EcdsaSighashType::All.
+        */
+       public Result_CVec_ECDSASignatureZNoneZ get_htlc_sigs(byte[] htlc_base_key, org.ldk.structs.DirectedChannelTransactionParameters channel_parameters, org.ldk.structs.EntropySource entropy_source) {
+               long ret = bindings.TrustedCommitmentTransaction_get_htlc_sigs(this.ptr, InternalUtils.check_arr_len(htlc_base_key, 32), channel_parameters == null ? 0 : channel_parameters.ptr, entropy_source.ptr);
+               Reference.reachabilityFence(this);
+               Reference.reachabilityFence(htlc_base_key);
+               Reference.reachabilityFence(channel_parameters);
+               Reference.reachabilityFence(entropy_source);
+               if (ret >= 0 && ret <= 4096) { return null; }
+               Result_CVec_ECDSASignatureZNoneZ ret_hu_conv = Result_CVec_ECDSASignatureZNoneZ.constr_from_ptr(ret);
+               if (this != null) { this.ptrs_to.add(channel_parameters); };
+               if (this != null) { this.ptrs_to.add(entropy_source); };
+               return ret_hu_conv;
+       }
+
+       /**
+        * Returns the index of the revokeable output, i.e. the `to_local` output sending funds to
+        * the broadcaster, in the built transaction, if any exists.
+        * 
+        * There are two cases where this may return `None`:
+        * - The balance of the revokeable output is below the dust limit (only found on commitments
+        * early in the channel's lifetime, i.e. before the channel reserve is met).
+        * - This commitment was created before LDK 0.0.117. In this case, the
+        * commitment transaction previously didn't contain enough information to locate the
+        * revokeable output.
+        */
+       public Option_usizeZ revokeable_output_index() {
+               long ret = bindings.TrustedCommitmentTransaction_revokeable_output_index(this.ptr);
+               Reference.reachabilityFence(this);
+               if (ret >= 0 && ret <= 4096) { return null; }
+               org.ldk.structs.Option_usizeZ ret_hu_conv = org.ldk.structs.Option_usizeZ.constr_from_ptr(ret);
+               if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
+               return ret_hu_conv;
+       }
+
+       /**
+        * Helper method to build an unsigned justice transaction spending the revokeable
+        * `to_local` output to a destination script. Fee estimation accounts for the expected
+        * revocation witness data that will be added when signed.
+        * 
+        * This method will error if the given fee rate results in a fee greater than the value
+        * of the output being spent, or if there exists no revokeable `to_local` output on this
+        * commitment transaction. See [`Self::revokeable_output_index`] for more details.
+        * 
+        * The built transaction will allow fee bumping with RBF, and this method takes
+        * `feerate_per_kw` as an input such that multiple copies of a justice transaction at different
+        * fee rates may be built.
         */
-       public Result_CVec_SignatureZNoneZ get_htlc_sigs(byte[] htlc_base_key, DirectedChannelTransactionParameters channel_parameters) {
-               long ret = bindings.TrustedCommitmentTransaction_get_htlc_sigs(this.ptr, htlc_base_key, channel_parameters == null ? 0 : channel_parameters.ptr & ~1);
+       public Result_TransactionNoneZ build_to_local_justice_tx(long feerate_per_kw, byte[] destination_script) {
+               long ret = bindings.TrustedCommitmentTransaction_build_to_local_justice_tx(this.ptr, feerate_per_kw, destination_script);
+               Reference.reachabilityFence(this);
+               Reference.reachabilityFence(feerate_per_kw);
+               Reference.reachabilityFence(destination_script);
                if (ret >= 0 && ret <= 4096) { return null; }
-               Result_CVec_SignatureZNoneZ ret_hu_conv = Result_CVec_SignatureZNoneZ.constr_from_ptr(ret);
-               this.ptrs_to.add(channel_parameters);
+               Result_TransactionNoneZ ret_hu_conv = Result_TransactionNoneZ.constr_from_ptr(ret);
                return ret_hu_conv;
        }