X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Forg%2Fldk%2Fstructs%2FRoute.java;h=c4d4d81faee95d7773dfbc8888c14c8b7f2d4aa7;hb=17113550a5fefab21f39f27fbfe02646b8db53ae;hp=a05f15b662ac184a97818da4abc0f0d6eb577b2f;hpb=d69a40d071871d3c0e4160744202c6e85941a4cc;p=ldk-java

diff --git a/src/main/java/org/ldk/structs/Route.java b/src/main/java/org/ldk/structs/Route.java
index a05f15b6..c4d4d81f 100644
--- a/src/main/java/org/ldk/structs/Route.java
+++ b/src/main/java/org/ldk/structs/Route.java
@@ -5,6 +5,11 @@ import org.ldk.enums.*;
 import org.ldk.util.*;
 import java.util.Arrays;
 
+
+/**
+ * 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); }
@@ -14,11 +19,22 @@ public class Route extends CommonBase {
 		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 void set_paths(RouteHop[][] val) {
 		bindings.Route_set_paths(this.ptr, Arrays.stream(val).map(val_conv_12 -> 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()).toArray(long[][]::new));
 		/* TODO 2 RouteHop[]  */;
 	}
 
+	/**
+	 * Constructs a new Route given each field
+	 */
 	public static Route constructor_new(RouteHop[][] paths_arg) {
 		long ret = bindings.Route_new(Arrays.stream(paths_arg).map(paths_arg_conv_12 -> 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()).toArray(long[][]::new));
 		Route ret_hu_conv = new Route(null, ret);
@@ -27,6 +43,9 @@ public class Route extends CommonBase {
 		return ret_hu_conv;
 	}
 
+	/**
+	 * Creates a copy of the Route
+	 */
 	public Route clone() {
 		long ret = bindings.Route_clone(this.ptr);
 		Route ret_hu_conv = new Route(null, ret);
@@ -34,11 +53,17 @@ public class Route extends CommonBase {
 		return ret_hu_conv;
 	}
 
+	/**
+	 * 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;
 	}
 
+	/**
+	 * Read a Route from a byte array, created by Route_write
+	 */
 	public static Result_RouteDecodeErrorZ constructor_read(byte[] ser) {
 		long ret = bindings.Route_read(ser);
 		Result_RouteDecodeErrorZ ret_hu_conv = Result_RouteDecodeErrorZ.constr_from_ptr(ret);