Re-generate auto-generated bindings + add Mac OS generated bindings
[ldk-java] / src / main / java / org / ldk / structs / FeeEstimator.java
index 910edae72d6ab5cc0ad9c6a3cedc3514252fb299..c58b4796e57d336c93bf43c7a6f74bcb7eab7c28 100644 (file)
@@ -5,6 +5,13 @@ import org.ldk.enums.*;
 import org.ldk.util.*;
 import java.util.Arrays;
 
+/**
+ * A trait which should be implemented to provide feerate information on a number of time
+ * horizons.
+ * 
+ * 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).
+ */
 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
 public class FeeEstimator extends CommonBase {
        final bindings.LDKFeeEstimator bindings_instance;
@@ -20,20 +27,40 @@ public class FeeEstimator extends CommonBase {
        }
 
        public static interface FeeEstimatorInterface {
-               int get_est_sat_per_1000_weight(LDKConfirmationTarget confirmation_target);
+               /**
+                * Gets estimated satoshis of fee required per 1000 Weight-Units.
+                * 
+                * Must be 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).
+                * 
+                * This translates to:
+                * satoshis-per-byte * 250
+                * ceil(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(LDKConfirmationTarget confirmation_target) {
+                       @Override public int get_est_sat_per_1000_weight(ConfirmationTarget confirmation_target) {
                                int ret = arg.get_est_sat_per_1000_weight(confirmation_target);
                                return ret;
                        }
                });
                return impl_holder.held;
        }
-       public int get_est_sat_per_1000_weight(LDKConfirmationTarget confirmation_target) {
+       /**
+        * Gets estimated satoshis of fee required per 1000 Weight-Units.
+        * 
+        * Must be 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).
+        * 
+        * This translates to:
+        * satoshis-per-byte * 250
+        * ceil(satoshis-per-kbyte / 4)
+        */
+       public int get_est_sat_per_1000_weight(ConfirmationTarget confirmation_target) {
                int ret = bindings.FeeEstimator_get_est_sat_per_1000_weight(this.ptr, confirmation_target);
                return ret;
        }