X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Forg%2Fldk%2Fstructs%2FScore.java;h=f9855bfa6d4633ff9974590f9bcab0b359a974ac;hb=07d5d868dfe064aadb28a7f7ca6002c16be9723d;hp=3f6f7d1a0b75b13780092d9eefa8355dd564b09c;hpb=1854b5cebef22ace9e9e4dd191f609818df9ce08;p=ldk-java diff --git a/src/main/java/org/ldk/structs/Score.java b/src/main/java/org/ldk/structs/Score.java index 3f6f7d1a..f9855bfa 100644 --- a/src/main/java/org/ldk/structs/Score.java +++ b/src/main/java/org/ldk/structs/Score.java @@ -8,136 +8,77 @@ import java.lang.ref.Reference; import javax.annotation.Nullable; /** - * An interface used to score payment channels for path finding. + * A trait which can both lookup and update routing channel penalty scores. * - * \tScoring is in terms of fees willing to be paid in order to avoid routing through a channel. + * This is used in places where both bounds are required and implemented for all types which + * implement [`ScoreLookUp`] and [`ScoreUpdate`]. + * + * Bindings users may need to manually implement this for their custom scoring implementations. */ @SuppressWarnings("unchecked") // We correctly assign various generic arrays public class Score extends CommonBase { final bindings.LDKScore bindings_instance; Score(Object _dummy, long ptr) { super(ptr); bindings_instance = null; } - private Score(bindings.LDKScore arg) { - super(bindings.LDKScore_new(arg)); + private Score(bindings.LDKScore arg, bindings.LDKScoreLookUp ScoreLookUp, bindings.LDKScoreUpdate ScoreUpdate) { + super(bindings.LDKScore_new(arg, ScoreLookUp, ScoreUpdate)); this.ptrs_to.add(arg); + this.ptrs_to.add(ScoreLookUp); + this.ptrs_to.add(ScoreUpdate); this.bindings_instance = arg; } @Override @SuppressWarnings("deprecation") protected void finalize() throws Throwable { if (ptr != 0) { bindings.Score_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.Score_free(ptr); } + ptr = 0; + } public static interface ScoreInterface { - /** - * Returns the fee in msats willing to be paid to avoid routing `send_amt_msat` through the - * given channel in the direction from `source` to `target`. - * - * The channel's capacity (less any other MPP parts which are also being considered for use in - * the same payment) is given by `channel_capacity_msat`. It may be guessed from various - * sources or assumed from no data at all. - * - * For hints provided in the invoice, we assume the channel has sufficient capacity to accept - * the invoice's full amount, and provide a `channel_capacity_msat` of `None`. In all other - * cases it is set to `Some`, even if we're guessing at the channel value. - * - * Your code should be overflow-safe through a `channel_capacity_msat` of 21 million BTC. - */ - long channel_penalty_msat(long short_channel_id, long send_amt_msat, Option_u64Z channel_capacity_msat, NodeId source, NodeId target); - /** - * Handles updating channel penalties after failing to route through a channel. - */ - void payment_path_failed(RouteHop[] path, long short_channel_id); - /** - * Handles updating channel penalties after successfully routing along a path. - */ - void payment_path_successful(RouteHop[] path); /** * Serialize the object into a byte array */ byte[] write(); } private static class LDKScoreHolder { Score held; } - public static Score new_impl(ScoreInterface arg) { + public static Score new_impl(ScoreInterface arg, ScoreLookUp.ScoreLookUpInterface ScoreLookUp_impl, ScoreUpdate.ScoreUpdateInterface ScoreUpdate_impl) { final LDKScoreHolder impl_holder = new LDKScoreHolder(); impl_holder.held = new Score(new bindings.LDKScore() { - @Override public long channel_penalty_msat(long short_channel_id, long send_amt_msat, long channel_capacity_msat, long source, long target) { - Option_u64Z channel_capacity_msat_hu_conv = Option_u64Z.constr_from_ptr(channel_capacity_msat); - channel_capacity_msat_hu_conv.ptrs_to.add(this); - NodeId source_hu_conv = null; if (source < 0 || source > 4096) { source_hu_conv = new NodeId(null, source); } - NodeId target_hu_conv = null; if (target < 0 || target > 4096) { target_hu_conv = new NodeId(null, target); } - long ret = arg.channel_penalty_msat(short_channel_id, send_amt_msat, channel_capacity_msat_hu_conv, source_hu_conv, target_hu_conv); - return ret; - } - @Override public void payment_path_failed(long[] path, long short_channel_id) { - RouteHop[] path_conv_10_arr = new RouteHop[path.length]; - for (int k = 0; k < path.length; k++) { - long path_conv_10 = path[k]; - RouteHop path_conv_10_hu_conv = null; if (path_conv_10 < 0 || path_conv_10 > 4096) { path_conv_10_hu_conv = new RouteHop(null, path_conv_10); } - path_conv_10_hu_conv.ptrs_to.add(this); - path_conv_10_arr[k] = path_conv_10_hu_conv; - } - arg.payment_path_failed(path_conv_10_arr, short_channel_id); - } - @Override public void payment_path_successful(long[] path) { - RouteHop[] path_conv_10_arr = new RouteHop[path.length]; - for (int k = 0; k < path.length; k++) { - long path_conv_10 = path[k]; - RouteHop path_conv_10_hu_conv = null; if (path_conv_10 < 0 || path_conv_10 > 4096) { path_conv_10_hu_conv = new RouteHop(null, path_conv_10); } - path_conv_10_hu_conv.ptrs_to.add(this); - path_conv_10_arr[k] = path_conv_10_hu_conv; - } - arg.payment_path_successful(path_conv_10_arr); - } @Override public byte[] write() { byte[] ret = arg.write(); + Reference.reachabilityFence(arg); return ret; } - }); + }, ScoreLookUp.new_impl(ScoreLookUp_impl).bindings_instance, ScoreUpdate.new_impl(ScoreUpdate_impl).bindings_instance); return impl_holder.held; } - /** - * Returns the fee in msats willing to be paid to avoid routing `send_amt_msat` through the - * given channel in the direction from `source` to `target`. - * - * The channel's capacity (less any other MPP parts which are also being considered for use in - * the same payment) is given by `channel_capacity_msat`. It may be guessed from various - * sources or assumed from no data at all. - * - * For hints provided in the invoice, we assume the channel has sufficient capacity to accept - * the invoice's full amount, and provide a `channel_capacity_msat` of `None`. In all other - * cases it is set to `Some`, even if we're guessing at the channel value. - * - * Your code should be overflow-safe through a `channel_capacity_msat` of 21 million BTC. - */ - public long channel_penalty_msat(long short_channel_id, long send_amt_msat, Option_u64Z channel_capacity_msat, NodeId source, NodeId target) { - long ret = bindings.Score_channel_penalty_msat(this.ptr, short_channel_id, send_amt_msat, channel_capacity_msat.ptr, source == null ? 0 : source.ptr & ~1, target == null ? 0 : target.ptr & ~1); - Reference.reachabilityFence(this); - Reference.reachabilityFence(short_channel_id); - Reference.reachabilityFence(send_amt_msat); - Reference.reachabilityFence(channel_capacity_msat); - Reference.reachabilityFence(source); - Reference.reachabilityFence(target); - this.ptrs_to.add(source); - this.ptrs_to.add(target); - return ret; - } /** - * Handles updating channel penalties after failing to route through a channel. + * Gets the underlying ScoreLookUp. */ - public void payment_path_failed(RouteHop[] path, long short_channel_id) { - bindings.Score_payment_path_failed(this.ptr, path != null ? Arrays.stream(path).mapToLong(path_conv_10 -> path_conv_10 == null ? 0 : path_conv_10.ptr & ~1).toArray() : null, short_channel_id); - Reference.reachabilityFence(this); - Reference.reachabilityFence(path); - Reference.reachabilityFence(short_channel_id); + public ScoreLookUp get_score_look_up() { + ScoreLookUp res = new ScoreLookUp(null, bindings.LDKScore_get_ScoreLookUp(this.ptr)); + res.ptrs_to.add(this); + return res; } + /** - * Handles updating channel penalties after successfully routing along a path. + * Gets the underlying ScoreUpdate. */ - public void payment_path_successful(RouteHop[] path) { - bindings.Score_payment_path_successful(this.ptr, path != null ? Arrays.stream(path).mapToLong(path_conv_10 -> path_conv_10 == null ? 0 : path_conv_10.ptr & ~1).toArray() : null); - Reference.reachabilityFence(this); - Reference.reachabilityFence(path); + public ScoreUpdate get_score_update() { + ScoreUpdate res = new ScoreUpdate(null, bindings.LDKScore_get_ScoreUpdate(this.ptr)); + res.ptrs_to.add(this); + return res; } /**