[Java] Update auto-generated bindings to LDK 0.0.123
[ldk-java] / src / main / java / org / ldk / structs / FeeEstimator.java
index 3959317b497cbd7b0faef208fa97507b621cd5f2..ffb05837bae6d058377e63d6e5744f8898f95f44 100644 (file)
@@ -1,16 +1,94 @@
 package org.ldk.structs;
 
 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;
 
+/**
+ * A trait which should be implemented to provide feerate information on a number of time
+ * horizons.
+ * 
+ * If access to a local mempool is not feasible, feerate estimates should be fetched from a set of
+ * third-parties hosting them. Note that this enables them to affect the propagation of your
+ * pre-signed transactions at any time and therefore endangers the safety of channels funds. It
+ * should be considered carefully as a deployment.
+ * 
+ * Note that all of the functions implemented here *must* be reentrant-safe (obviously - they're
+ * called from inside the library in response to chain events, P2P events, or timer events).
+ * 
+ * LDK may generate a substantial number of fee-estimation calls in some cases. You should
+ * pre-calculate and cache the fee estimate results to ensure you don't substantially slow HTLC
+ * handling.
+ */
+@SuppressWarnings("unchecked") // We correctly assign various generic arrays
 public class FeeEstimator extends CommonBase {
-       FeeEstimator(Object _dummy, long ptr) { super(ptr); }
-       public FeeEstimator(bindings.LDKFeeEstimator arg) {
+       final bindings.LDKFeeEstimator bindings_instance;
+       FeeEstimator(Object _dummy, long ptr) { super(ptr); bindings_instance = null; }
+       private FeeEstimator(bindings.LDKFeeEstimator arg) {
                super(bindings.LDKFeeEstimator_new(arg));
                this.ptrs_to.add(arg);
+               this.bindings_instance = arg;
        }
        @Override @SuppressWarnings("deprecation")
        protected void finalize() throws Throwable {
-               bindings.FeeEstimator_free(ptr); super.finalize();
+               if (ptr != 0) { bindings.FeeEstimator_free(ptr); } super.finalize();
+       }
+       /**
+        * Destroys the object, freeing associated resources. After this call, any access
+        * to this object may result in a SEGFAULT or worse.
+        *
+        * You should generally NEVER call this method. You should let the garbage collector
+        * do this for you when it finalizes objects. However, it may be useful for types
+        * which represent locks and should be closed immediately to avoid holding locks
+        * until the GC runs.
+        */
+       public void destroy() {
+               if (ptr != 0) { bindings.FeeEstimator_free(ptr); }
+               ptr = 0;
+       }
+       public static interface FeeEstimatorInterface {
+               /**
+                * Gets estimated satoshis of fee required per 1000 Weight-Units.
+                * 
+                * LDK will wrap this method and ensure that the value returned is no smaller than 253
+                * (ie 1 satoshi-per-byte rounded up to ensure later round-downs don't put us below 1 satoshi-per-byte).
+                * 
+                * The following unit conversions can be used to convert to sats/KW:
+                * satoshis-per-byte * 250
+                * satoshis-per-kbyte / 4
+                */
+               int get_est_sat_per_1000_weight(ConfirmationTarget confirmation_target);
+       }
+       private static class LDKFeeEstimatorHolder { FeeEstimator held; }
+       public static FeeEstimator new_impl(FeeEstimatorInterface arg) {
+               final LDKFeeEstimatorHolder impl_holder = new LDKFeeEstimatorHolder();
+               impl_holder.held = new FeeEstimator(new bindings.LDKFeeEstimator() {
+                       @Override public int get_est_sat_per_1000_weight(ConfirmationTarget confirmation_target) {
+                               int ret = arg.get_est_sat_per_1000_weight(confirmation_target);
+                               Reference.reachabilityFence(arg);
+                               return ret;
+                       }
+               });
+               return impl_holder.held;
+       }
+       /**
+        * Gets estimated satoshis of fee required per 1000 Weight-Units.
+        * 
+        * LDK will wrap this method and ensure that the value returned is no smaller than 253
+        * (ie 1 satoshi-per-byte rounded up to ensure later round-downs don't put us below 1 satoshi-per-byte).
+        * 
+        * The following unit conversions can be used to convert to sats/KW:
+        * satoshis-per-byte * 250
+        * satoshis-per-kbyte / 4
+        */
+       public int get_est_sat_per_1000_weight(org.ldk.enums.ConfirmationTarget confirmation_target) {
+               int ret = bindings.FeeEstimator_get_est_sat_per_1000_weight(this.ptr, confirmation_target);
+               Reference.reachabilityFence(this);
+               Reference.reachabilityFence(confirmation_target);
+               return ret;
        }
 
 }