X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Forg%2Fldk%2Fstructs%2FFeeEstimator.java;h=e8e14de5c3d9bdfa40807b71ffa37a29b75e5945;hb=6fe917116a65d7b62123226c4240d77ea2719783;hp=910edae72d6ab5cc0ad9c6a3cedc3514252fb299;hpb=b2b0222f51397c5d7e0b3bf0cad6439edde3c1f3;p=ldk-java

diff --git a/src/main/java/org/ldk/structs/FeeEstimator.java b/src/main/java/org/ldk/structs/FeeEstimator.java
index 910edae7..e8e14de5 100644
--- a/src/main/java/org/ldk/structs/FeeEstimator.java
+++ b/src/main/java/org/ldk/structs/FeeEstimator.java
@@ -4,7 +4,16 @@ 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.
+ * 
+ * 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,21 +29,44 @@ 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 return a value 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 method can be implemented with the following unit conversions:
+		 * max(satoshis-per-byte * 250, 253)
+		 * max(satoshis-per-kbyte / 4, 253)
+		 */
+		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);
+				Reference.reachabilityFence(arg);
 				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 return a value 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 method can be implemented with the following unit conversions:
+	 * max(satoshis-per-byte * 250, 253)
+	 * max(satoshis-per-kbyte / 4, 253)
+	 */
+	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;
 	}