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

diff --git a/src/main/java/org/ldk/structs/NetGraphMsgHandler.java b/src/main/java/org/ldk/structs/NetGraphMsgHandler.java
index c3e2d406..26ece016 100644
--- a/src/main/java/org/ldk/structs/NetGraphMsgHandler.java
+++ b/src/main/java/org/ldk/structs/NetGraphMsgHandler.java
@@ -5,6 +5,14 @@ import org.ldk.enums.*;
 import org.ldk.util.*;
 import java.util.Arrays;
 
+
+/**
+ * Receives and validates network updates from peers,
+ * stores authentic and relevant data as a network graph.
+ * This network graph is then used for routing payments.
+ * Provides interface to help with initial routing sync by
+ * serving historical announcements.
+ */
 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
 public class NetGraphMsgHandler extends CommonBase {
 	NetGraphMsgHandler(Object _dummy, long ptr) { super(ptr); }
@@ -14,6 +22,13 @@ public class NetGraphMsgHandler extends CommonBase {
 		if (ptr != 0) { bindings.NetGraphMsgHandler_free(ptr); }
 	}
 
+	/**
+	 * Creates a new tracker of the actual state of the network of channels and nodes,
+	 * assuming a fresh network graph.
+	 * Chain monitor is used to make sure announced channels exist on-chain,
+	 * channel data is correct, and that the announcement is signed with
+	 * channel owners' keys.
+	 */
 	public static NetGraphMsgHandler constructor_new(byte[] genesis_hash, Access chain_access, Logger logger) {
 		long ret = bindings.NetGraphMsgHandler_new(genesis_hash, chain_access == null ? 0 : chain_access.ptr, logger == null ? 0 : logger.ptr);
 		NetGraphMsgHandler ret_hu_conv = new NetGraphMsgHandler(null, ret);
@@ -23,6 +38,10 @@ public class NetGraphMsgHandler extends CommonBase {
 		return ret_hu_conv;
 	}
 
+	/**
+	 * Creates a new tracker of the actual state of the network of channels and nodes,
+	 * assuming an existing Network Graph.
+	 */
 	public static NetGraphMsgHandler constructor_from_net_graph(Access chain_access, Logger logger, NetworkGraph network_graph) {
 		long ret = bindings.NetGraphMsgHandler_from_net_graph(chain_access == null ? 0 : chain_access.ptr, logger == null ? 0 : logger.ptr, network_graph == null ? 0 : network_graph.ptr & ~1);
 		NetGraphMsgHandler ret_hu_conv = new NetGraphMsgHandler(null, ret);
@@ -33,11 +52,22 @@ public class NetGraphMsgHandler extends CommonBase {
 		return ret_hu_conv;
 	}
 
+	/**
+	 * Adds a provider used to check new announcements. Does not affect
+	 * existing announcements unless they are updated.
+	 * Add, update or remove the provider would replace the current one.
+	 */
 	public void add_chain_access(Access chain_access) {
 		bindings.NetGraphMsgHandler_add_chain_access(this.ptr, chain_access == null ? 0 : chain_access.ptr);
 		this.ptrs_to.add(chain_access);
 	}
 
+	/**
+	 * Take a read lock on the network_graph and return it in the C-bindings
+	 * newtype helper. This is likely only useful when called via the C
+	 * bindings as you can call `self.network_graph.read().unwrap()` in Rust
+	 * yourself.
+	 */
 	public LockedNetworkGraph read_locked_graph() {
 		long ret = bindings.NetGraphMsgHandler_read_locked_graph(this.ptr);
 		LockedNetworkGraph ret_hu_conv = new LockedNetworkGraph(null, ret);
@@ -45,6 +75,10 @@ public class NetGraphMsgHandler extends CommonBase {
 		return ret_hu_conv;
 	}
 
+	/**
+	 * Constructs a new RoutingMessageHandler which calls the relevant methods on this_arg.
+	 * This copies the `inner` pointer in this_arg and thus the returned RoutingMessageHandler must be freed before this_arg is
+	 */
 	public RoutingMessageHandler as_RoutingMessageHandler() {
 		long ret = bindings.NetGraphMsgHandler_as_RoutingMessageHandler(this.ptr);
 		RoutingMessageHandler ret_hu_conv = new RoutingMessageHandler(null, ret);
@@ -52,6 +86,10 @@ public class NetGraphMsgHandler extends CommonBase {
 		return ret_hu_conv;
 	}
 
+	/**
+	 * Constructs a new MessageSendEventsProvider which calls the relevant methods on this_arg.
+	 * This copies the `inner` pointer in this_arg and thus the returned MessageSendEventsProvider must be freed before this_arg is
+	 */
 	public MessageSendEventsProvider as_MessageSendEventsProvider() {
 		long ret = bindings.NetGraphMsgHandler_as_MessageSendEventsProvider(this.ptr);
 		MessageSendEventsProvider ret_hu_conv = new MessageSendEventsProvider(null, ret);