import org.ldk.enums.*;
import org.ldk.util.*;
import java.util.Arrays;
+import javax.annotation.Nullable;
+
+/**
+ * A route directs a payment from the sender (us) to the recipient. If the recipient supports MPP,
+ * it can take multiple paths. Each path is composed of one or more hops through the network.
+ */
@SuppressWarnings("unchecked") // We correctly assign various generic arrays
public class Route extends CommonBase {
Route(Object _dummy, long ptr) { super(ptr); }
if (ptr != 0) { bindings.Route_free(ptr); }
}
+ /**
+ * The list of routes taken for a single (potentially-)multi-part payment. The pubkey of the
+ * last RouteHop in each path must be the same.
+ * Each entry represents a list of hops, NOT INCLUDING our own, where the last hop is the
+ * destination. Thus, this must always be at least length one. While the maximum length of any
+ * given path is variable, keeping the length of any path to less than 20 should currently
+ * ensure it is viable.
+ */
+ public RouteHop[][] get_paths() {
+ long[][] ret = bindings.Route_get_paths(this.ptr);
+ RouteHop[][] ret_conv_12_arr = new RouteHop[ret.length][];
+ for (int m = 0; m < ret.length; m++) {
+ long[] ret_conv_12 = ret[m];
+ RouteHop[] ret_conv_12_conv_10_arr = new RouteHop[ret_conv_12.length];
+ for (int k = 0; k < ret_conv_12.length; k++) {
+ long ret_conv_12_conv_10 = ret_conv_12[k];
+ RouteHop ret_conv_12_conv_10_hu_conv = new RouteHop(null, ret_conv_12_conv_10);
+ ret_conv_12_conv_10_hu_conv.ptrs_to.add(this);
+ ret_conv_12_conv_10_arr[k] = ret_conv_12_conv_10_hu_conv;
+ }
+ ret_conv_12_arr[m] = ret_conv_12_conv_10_arr;
+ }
+ return ret_conv_12_arr;
+ }
+
+ /**
+ * The list of routes taken for a single (potentially-)multi-part payment. The pubkey of the
+ * last RouteHop in each path must be the same.
+ * Each entry represents a list of hops, NOT INCLUDING our own, where the last hop is the
+ * destination. Thus, this must always be at least length one. While the maximum length of any
+ * given path is variable, keeping the length of any path to less than 20 should currently
+ * ensure it is viable.
+ */
public void set_paths(RouteHop[][] val) {
- bindings.Route_set_paths(this.ptr, Arrays.stream(val).map(arr_conv_12 -> Arrays.stream(arr_conv_12).mapToLong(arr_conv_10 -> arr_conv_10 == null ? 0 : arr_conv_10.ptr & ~1).toArray()).toArray(long[][]::new));
- /* TODO 2 RouteHop[] */;
+ 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);
+ for (RouteHop[] val_conv_12: val) { for (RouteHop val_conv_12_conv_10: val_conv_12) { this.ptrs_to.add(val_conv_12_conv_10); }; };
}
- public static Route constructor_new(RouteHop[][] paths_arg) {
- long ret = bindings.Route_new(Arrays.stream(paths_arg).map(arr_conv_12 -> Arrays.stream(arr_conv_12).mapToLong(arr_conv_10 -> arr_conv_10 == null ? 0 : arr_conv_10.ptr & ~1).toArray()).toArray(long[][]::new));
+ /**
+ * Constructs a new Route given each field
+ */
+ public static Route of(RouteHop[][] paths_arg) {
+ 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);
+ if (ret < 1024) { return null; }
Route ret_hu_conv = new Route(null, ret);
ret_hu_conv.ptrs_to.add(ret_hu_conv);
- /* TODO 2 RouteHop[] */;
+ for (RouteHop[] paths_arg_conv_12: paths_arg) { for (RouteHop paths_arg_conv_12_conv_10: paths_arg_conv_12) { ret_hu_conv.ptrs_to.add(paths_arg_conv_12_conv_10); }; };
return ret_hu_conv;
}
+ /**
+ * Creates a copy of the Route
+ */
public Route clone() {
long ret = bindings.Route_clone(this.ptr);
+ if (ret < 1024) { return null; }
Route ret_hu_conv = new Route(null, ret);
ret_hu_conv.ptrs_to.add(this);
return ret_hu_conv;
}
+ /**
+ * Checks if two Routes contain equal inner contents.
+ */
+ public long hash() {
+ long ret = bindings.Route_hash(this.ptr);
+ return ret;
+ }
+
+ /**
+ * Checks if two Routes contain equal inner contents.
+ * This ignores pointers and is_owned flags and looks at the values in fields.
+ * Two objects with NULL inner values will be considered "equal" here.
+ */
+ public boolean eq(Route b) {
+ boolean ret = bindings.Route_eq(this.ptr, b == null ? 0 : b.ptr & ~1);
+ this.ptrs_to.add(b);
+ return ret;
+ }
+
+ /**
+ * Returns the total amount of fees paid on this [`Route`].
+ *
+ * This doesn't include any extra payment made to the recipient, which can happen in excess of
+ * the amount passed to [`get_route`]'s `final_value_msat`.
+ */
+ public long get_total_fees() {
+ long ret = bindings.Route_get_total_fees(this.ptr);
+ return ret;
+ }
+
+ /**
+ * Returns the total amount paid on this [`Route`], excluding the fees.
+ */
+ public long get_total_amount() {
+ long ret = bindings.Route_get_total_amount(this.ptr);
+ return ret;
+ }
+
+ /**
+ * Serialize the Route object into a byte array which can be read by Route_read
+ */
public byte[] write() {
byte[] ret = bindings.Route_write(this.ptr);
return ret;
}
- public static Result_RouteDecodeErrorZ constructor_read(byte[] ser) {
+ /**
+ * Read a Route from a byte array, created by Route_write
+ */
+ public static Result_RouteDecodeErrorZ read(byte[] ser) {
long ret = bindings.Route_read(ser);
+ if (ret < 1024) { return null; }
Result_RouteDecodeErrorZ ret_hu_conv = Result_RouteDecodeErrorZ.constr_from_ptr(ret);
return ret_hu_conv;
}