X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Forg%2Fldk%2Fstructs%2FFeeEstimator.java;h=e9f6ba9e435a8807225555e897ef702f6b896bb4;hb=ca313f2eee377bec222fa82b2939751fa9eab32e;hp=3e247df2364a86e9116dd64f1f546edf65106364;hpb=17113550a5fefab21f39f27fbfe02646b8db53ae;p=ldk-java diff --git a/src/main/java/org/ldk/structs/FeeEstimator.java b/src/main/java/org/ldk/structs/FeeEstimator.java index 3e247df2..e9f6ba9e 100644 --- a/src/main/java/org/ldk/structs/FeeEstimator.java +++ b/src/main/java/org/ldk/structs/FeeEstimator.java @@ -4,11 +4,18 @@ 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). */ @@ -25,26 +32,39 @@ public class FeeEstimator extends CommonBase { protected void finalize() throws Throwable { 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. * - * 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). + * 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). * - * This translates to: + * The following unit conversions can be used to convert to sats/KW: * satoshis-per-byte * 250 - * ceil(satoshis-per-kbyte / 4) + * satoshis-per-kbyte / 4 */ - int get_est_sat_per_1000_weight(LDKConfirmationTarget confirmation_target); + 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; } }); @@ -53,15 +73,17 @@ public class FeeEstimator extends CommonBase { /** * 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). + * 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). * - * This translates to: + * The following unit conversions can be used to convert to sats/KW: * satoshis-per-byte * 250 - * ceil(satoshis-per-kbyte / 4) + * satoshis-per-kbyte / 4 */ - public int get_est_sat_per_1000_weight(LDKConfirmationTarget confirmation_target) { + 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; }