1 package org.ldk.structs;
3 import org.ldk.impl.bindings;
4 import org.ldk.enums.*;
6 import java.util.Arrays;
7 import java.lang.ref.Reference;
8 import javax.annotation.Nullable;
11 * A trait which should be implemented to provide feerate information on a number of time
14 * Note that all of the functions implemented here *must* be reentrant-safe (obviously - they're
15 * called from inside the library in response to chain events, P2P events, or timer events).
17 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
18 public class FeeEstimator extends CommonBase {
19 final bindings.LDKFeeEstimator bindings_instance;
20 FeeEstimator(Object _dummy, long ptr) { super(ptr); bindings_instance = null; }
21 private FeeEstimator(bindings.LDKFeeEstimator arg) {
22 super(bindings.LDKFeeEstimator_new(arg));
23 this.ptrs_to.add(arg);
24 this.bindings_instance = arg;
26 @Override @SuppressWarnings("deprecation")
27 protected void finalize() throws Throwable {
28 if (ptr != 0) { bindings.FeeEstimator_free(ptr); } super.finalize();
31 * Destroys the object, freeing associated resources. After this call, any access
32 * to this object may result in a SEGFAULT or worse.
34 * You should generally NEVER call this method. You should let the garbage collector
35 * do this for you when it finalizes objects. However, it may be useful for types
36 * which represent locks and should be closed immediately to avoid holding locks
39 public void destroy() {
40 if (ptr != 0) { bindings.FeeEstimator_free(ptr); }
43 public static interface FeeEstimatorInterface {
45 * Gets estimated satoshis of fee required per 1000 Weight-Units.
47 * LDK will wrap this method and ensure that the value returned is no smaller than 253
48 * (ie 1 satoshi-per-byte rounded up to ensure later round-downs don't put us below 1 satoshi-per-byte).
50 * The following unit conversions can be used to convert to sats/KW:
51 * satoshis-per-byte * 250
52 * satoshis-per-kbyte / 4
54 int get_est_sat_per_1000_weight(ConfirmationTarget confirmation_target);
56 private static class LDKFeeEstimatorHolder { FeeEstimator held; }
57 public static FeeEstimator new_impl(FeeEstimatorInterface arg) {
58 final LDKFeeEstimatorHolder impl_holder = new LDKFeeEstimatorHolder();
59 impl_holder.held = new FeeEstimator(new bindings.LDKFeeEstimator() {
60 @Override public int get_est_sat_per_1000_weight(ConfirmationTarget confirmation_target) {
61 int ret = arg.get_est_sat_per_1000_weight(confirmation_target);
62 Reference.reachabilityFence(arg);
66 return impl_holder.held;
69 * Gets estimated satoshis of fee required per 1000 Weight-Units.
71 * LDK will wrap this method and ensure that the value returned is no smaller than 253
72 * (ie 1 satoshi-per-byte rounded up to ensure later round-downs don't put us below 1 satoshi-per-byte).
74 * The following unit conversions can be used to convert to sats/KW:
75 * satoshis-per-byte * 250
76 * satoshis-per-kbyte / 4
78 public int get_est_sat_per_1000_weight(org.ldk.enums.ConfirmationTarget confirmation_target) {
79 int ret = bindings.FeeEstimator_get_est_sat_per_1000_weight(this.ptr, confirmation_target);
80 Reference.reachabilityFence(this);
81 Reference.reachabilityFence(confirmation_target);