X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Forg%2Fldk%2Fstructs%2FFeeEstimator.java;h=1dea94b1dd4c4889dd87a367769029fca93949ad;hb=5e9de82b3a7712a41189756d9d16d946142b2ac5;hp=dd7c05f28434b1f2c5e5129a688bdda9754c1d01;hpb=aa0e2aade37133339f4113a0cd7465b111f0a0d0;p=ldk-java diff --git a/src/main/java/org/ldk/structs/FeeEstimator.java b/src/main/java/org/ldk/structs/FeeEstimator.java index dd7c05f2..1dea94b1 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,18 +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. + * + * 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); } - public FeeEstimator(FeeEstimatorInterface arg) { - this(new bindings.LDKFeeEstimator() { - @Override public int get_est_sat_per_1000_weight(LDKConfirmationTarget 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; } - public int get_est_sat_per_1000_weight(LDKConfirmationTarget confirmation_target) { + /** + * 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; }