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;
12 * A route directs a payment from the sender (us) to the recipient. If the recipient supports MPP,
13 * it can take multiple paths. Each path is composed of one or more hops through the network.
15 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
16 public class Route extends CommonBase {
17 Route(Object _dummy, long ptr) { super(ptr); }
18 @Override @SuppressWarnings("deprecation")
19 protected void finalize() throws Throwable {
21 if (ptr != 0) { bindings.Route_free(ptr); }
25 * The list of routes taken for a single (potentially-)multi-part payment. The pubkey of the
26 * last RouteHop in each path must be the same.
27 * Each entry represents a list of hops, NOT INCLUDING our own, where the last hop is the
28 * destination. Thus, this must always be at least length one. While the maximum length of any
29 * given path is variable, keeping the length of any path to less than 20 should currently
30 * ensure it is viable.
32 public RouteHop[][] get_paths() {
33 long[][] ret = bindings.Route_get_paths(this.ptr);
34 Reference.reachabilityFence(this);
35 int ret_conv_12_len = ret.length;
36 RouteHop[][] ret_conv_12_arr = new RouteHop[ret_conv_12_len][];
37 for (int m = 0; m < ret_conv_12_len; m++) {
38 long[] ret_conv_12 = ret[m];
39 int ret_conv_12_conv_10_len = ret_conv_12.length;
40 RouteHop[] ret_conv_12_conv_10_arr = new RouteHop[ret_conv_12_conv_10_len];
41 for (int k = 0; k < ret_conv_12_conv_10_len; k++) {
42 long ret_conv_12_conv_10 = ret_conv_12[k];
43 RouteHop ret_conv_12_conv_10_hu_conv = null; if (ret_conv_12_conv_10 < 0 || ret_conv_12_conv_10 > 4096) { ret_conv_12_conv_10_hu_conv = new RouteHop(null, ret_conv_12_conv_10); }
44 ret_conv_12_conv_10_hu_conv.ptrs_to.add(this);
45 ret_conv_12_conv_10_arr[k] = ret_conv_12_conv_10_hu_conv;
47 ret_conv_12_arr[m] = ret_conv_12_conv_10_arr;
49 return ret_conv_12_arr;
53 * The list of routes taken for a single (potentially-)multi-part payment. The pubkey of the
54 * last RouteHop in each path must be the same.
55 * Each entry represents a list of hops, NOT INCLUDING our own, where the last hop is the
56 * destination. Thus, this must always be at least length one. While the maximum length of any
57 * given path is variable, keeping the length of any path to less than 20 should currently
58 * ensure it is viable.
60 public void set_paths(RouteHop[][] val) {
61 bindings.Route_set_paths(this.ptr, val != null ? Arrays.stream(val).map(val_conv_12 -> val_conv_12 != null ? Arrays.stream(val_conv_12).mapToLong(val_conv_12_conv_10 -> val_conv_12_conv_10 == null ? 0 : val_conv_12_conv_10.ptr & ~1).toArray() : null).toArray(long[][]::new) : null);
62 Reference.reachabilityFence(this);
63 Reference.reachabilityFence(val);
67 * The `payment_params` parameter passed to [`find_route`].
68 * This is used by `ChannelManager` to track information which may be required for retries,
69 * provided back to you via [`Event::PaymentPathFailed`].
71 * [`Event::PaymentPathFailed`]: crate::util::events::Event::PaymentPathFailed
73 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
76 public PaymentParameters get_payment_params() {
77 long ret = bindings.Route_get_payment_params(this.ptr);
78 Reference.reachabilityFence(this);
79 if (ret >= 0 && ret <= 4096) { return null; }
80 PaymentParameters ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new PaymentParameters(null, ret); }
81 ret_hu_conv.ptrs_to.add(this);
86 * The `payment_params` parameter passed to [`find_route`].
87 * This is used by `ChannelManager` to track information which may be required for retries,
88 * provided back to you via [`Event::PaymentPathFailed`].
90 * [`Event::PaymentPathFailed`]: crate::util::events::Event::PaymentPathFailed
92 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
94 public void set_payment_params(@Nullable PaymentParameters val) {
95 bindings.Route_set_payment_params(this.ptr, val == null ? 0 : val.ptr & ~1);
96 Reference.reachabilityFence(this);
97 Reference.reachabilityFence(val);
101 * Constructs a new Route given each field
103 public static Route of(RouteHop[][] paths_arg, PaymentParameters payment_params_arg) {
104 long ret = bindings.Route_new(paths_arg != null ? Arrays.stream(paths_arg).map(paths_arg_conv_12 -> paths_arg_conv_12 != null ? Arrays.stream(paths_arg_conv_12).mapToLong(paths_arg_conv_12_conv_10 -> paths_arg_conv_12_conv_10 == null ? 0 : paths_arg_conv_12_conv_10.ptr & ~1).toArray() : null).toArray(long[][]::new) : null, payment_params_arg == null ? 0 : payment_params_arg.ptr & ~1);
105 Reference.reachabilityFence(paths_arg);
106 Reference.reachabilityFence(payment_params_arg);
107 if (ret >= 0 && ret <= 4096) { return null; }
108 Route ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new Route(null, ret); }
109 ret_hu_conv.ptrs_to.add(ret_hu_conv);
114 long ret = bindings.Route_clone_ptr(this.ptr);
115 Reference.reachabilityFence(this);
120 * Creates a copy of the Route
122 public Route clone() {
123 long ret = bindings.Route_clone(this.ptr);
124 Reference.reachabilityFence(this);
125 if (ret >= 0 && ret <= 4096) { return null; }
126 Route ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new Route(null, ret); }
127 ret_hu_conv.ptrs_to.add(this);
132 * Checks if two Routes contain equal inner contents.
135 long ret = bindings.Route_hash(this.ptr);
136 Reference.reachabilityFence(this);
140 @Override public int hashCode() {
141 return (int)this.hash();
144 * Checks if two Routes contain equal inner contents.
145 * This ignores pointers and is_owned flags and looks at the values in fields.
146 * Two objects with NULL inner values will be considered "equal" here.
148 public boolean eq(Route b) {
149 boolean ret = bindings.Route_eq(this.ptr, b == null ? 0 : b.ptr & ~1);
150 Reference.reachabilityFence(this);
151 Reference.reachabilityFence(b);
156 @Override public boolean equals(Object o) {
157 if (!(o instanceof Route)) return false;
158 return this.eq((Route)o);
161 * Returns the total amount of fees paid on this [`Route`].
163 * This doesn't include any extra payment made to the recipient, which can happen in excess of
164 * the amount passed to [`find_route`]'s `params.final_value_msat`.
166 public long get_total_fees() {
167 long ret = bindings.Route_get_total_fees(this.ptr);
168 Reference.reachabilityFence(this);
173 * Returns the total amount paid on this [`Route`], excluding the fees.
175 public long get_total_amount() {
176 long ret = bindings.Route_get_total_amount(this.ptr);
177 Reference.reachabilityFence(this);
182 * Serialize the Route object into a byte array which can be read by Route_read
184 public byte[] write() {
185 byte[] ret = bindings.Route_write(this.ptr);
186 Reference.reachabilityFence(this);
191 * Read a Route from a byte array, created by Route_write
193 public static Result_RouteDecodeErrorZ read(byte[] ser) {
194 long ret = bindings.Route_read(ser);
195 Reference.reachabilityFence(ser);
196 if (ret >= 0 && ret <= 4096) { return null; }
197 Result_RouteDecodeErrorZ ret_hu_conv = Result_RouteDecodeErrorZ.constr_from_ptr(ret);