X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Forg%2Fldk%2Fstructs%2FNetworkGraph.java;fp=src%2Fmain%2Fjava%2Forg%2Fldk%2Fstructs%2FNetworkGraph.java;h=b397b47a10f621dde77c6e84d3b41abf398d7694;hb=1b870a3ffab1c0024411e30102bc6d198300f095;hp=b8badcc5c149c8b043de7baa55cc1f75a8e6a717;hpb=246459dcbc3be28c38b4951140a5933f4b3aa024;p=ldk-java

diff --git a/src/main/java/org/ldk/structs/NetworkGraph.java b/src/main/java/org/ldk/structs/NetworkGraph.java
index b8badcc5..b397b47a 100644
--- a/src/main/java/org/ldk/structs/NetworkGraph.java
+++ b/src/main/java/org/ldk/structs/NetworkGraph.java
@@ -5,6 +5,10 @@ import org.ldk.enums.*;
 import org.ldk.util.*;
 import java.util.Arrays;
 
+
+/**
+ * Represents the network as nodes and channels between them
+ */
 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
 public class NetworkGraph extends CommonBase {
 	NetworkGraph(Object _dummy, long ptr) { super(ptr); }
@@ -14,6 +18,9 @@ public class NetworkGraph extends CommonBase {
 		if (ptr != 0) { bindings.NetworkGraph_free(ptr); }
 	}
 
+	/**
+	 * Creates a copy of the NetworkGraph
+	 */
 	public NetworkGraph clone() {
 		long ret = bindings.NetworkGraph_clone(this.ptr);
 		NetworkGraph ret_hu_conv = new NetworkGraph(null, ret);
@@ -21,17 +28,26 @@ public class NetworkGraph extends CommonBase {
 		return ret_hu_conv;
 	}
 
+	/**
+	 * Serialize the NetworkGraph object into a byte array which can be read by NetworkGraph_read
+	 */
 	public byte[] write() {
 		byte[] ret = bindings.NetworkGraph_write(this.ptr);
 		return ret;
 	}
 
+	/**
+	 * Read a NetworkGraph from a byte array, created by NetworkGraph_write
+	 */
 	public static Result_NetworkGraphDecodeErrorZ constructor_read(byte[] ser) {
 		long ret = bindings.NetworkGraph_read(ser);
 		Result_NetworkGraphDecodeErrorZ ret_hu_conv = Result_NetworkGraphDecodeErrorZ.constr_from_ptr(ret);
 		return ret_hu_conv;
 	}
 
+	/**
+	 * Creates a new, empty, network graph.
+	 */
 	public static NetworkGraph constructor_new(byte[] genesis_hash) {
 		long ret = bindings.NetworkGraph_new(genesis_hash);
 		NetworkGraph ret_hu_conv = new NetworkGraph(null, ret);
@@ -39,6 +55,14 @@ public class NetworkGraph extends CommonBase {
 		return ret_hu_conv;
 	}
 
+	/**
+	 * For an already known node (from channel announcements), update its stored properties from a
+	 * given node announcement.
+	 * 
+	 * You probably don't want to call this directly, instead relying on a NetGraphMsgHandler's
+	 * RoutingMessageHandler implementation to call it indirectly. This may be useful to accept
+	 * routing messages from a source using a protocol other than the lightning P2P protocol.
+	 */
 	public Result_NoneLightningErrorZ update_node_from_announcement(NodeAnnouncement msg) {
 		long ret = bindings.NetworkGraph_update_node_from_announcement(this.ptr, msg == null ? 0 : msg.ptr & ~1);
 		Result_NoneLightningErrorZ ret_hu_conv = Result_NoneLightningErrorZ.constr_from_ptr(ret);
@@ -46,6 +70,12 @@ public class NetworkGraph extends CommonBase {
 		return ret_hu_conv;
 	}
 
+	/**
+	 * For an already known node (from channel announcements), update its stored properties from a
+	 * given node announcement without verifying the associated signatures. Because we aren't
+	 * given the associated signatures here we cannot relay the node announcement to any of our
+	 * peers.
+	 */
 	public Result_NoneLightningErrorZ update_node_from_unsigned_announcement(UnsignedNodeAnnouncement msg) {
 		long ret = bindings.NetworkGraph_update_node_from_unsigned_announcement(this.ptr, msg == null ? 0 : msg.ptr & ~1);
 		Result_NoneLightningErrorZ ret_hu_conv = Result_NoneLightningErrorZ.constr_from_ptr(ret);
@@ -53,6 +83,16 @@ public class NetworkGraph extends CommonBase {
 		return ret_hu_conv;
 	}
 
+	/**
+	 * Store or update channel info from a channel announcement.
+	 * 
+	 * You probably don't want to call this directly, instead relying on a NetGraphMsgHandler's
+	 * RoutingMessageHandler implementation to call it indirectly. This may be useful to accept
+	 * routing messages from a source using a protocol other than the lightning P2P protocol.
+	 * 
+	 * If a `chain::Access` object is provided via `chain_access`, it will be called to verify
+	 * the corresponding UTXO exists on chain and is correctly-formatted.
+	 */
 	public Result_NoneLightningErrorZ update_channel_from_announcement(ChannelAnnouncement msg, Access chain_access) {
 		long ret = bindings.NetworkGraph_update_channel_from_announcement(this.ptr, msg == null ? 0 : msg.ptr & ~1, chain_access == null ? 0 : chain_access.ptr);
 		Result_NoneLightningErrorZ ret_hu_conv = Result_NoneLightningErrorZ.constr_from_ptr(ret);
@@ -61,6 +101,14 @@ public class NetworkGraph extends CommonBase {
 		return ret_hu_conv;
 	}
 
+	/**
+	 * Store or update channel info from a channel announcement without verifying the associated
+	 * signatures. Because we aren't given the associated signatures here we cannot relay the
+	 * channel announcement to any of our peers.
+	 * 
+	 * If a `chain::Access` object is provided via `chain_access`, it will be called to verify
+	 * the corresponding UTXO exists on chain and is correctly-formatted.
+	 */
 	public Result_NoneLightningErrorZ update_channel_from_unsigned_announcement(UnsignedChannelAnnouncement msg, Access chain_access) {
 		long ret = bindings.NetworkGraph_update_channel_from_unsigned_announcement(this.ptr, msg == null ? 0 : msg.ptr & ~1, chain_access == null ? 0 : chain_access.ptr);
 		Result_NoneLightningErrorZ ret_hu_conv = Result_NoneLightningErrorZ.constr_from_ptr(ret);
@@ -69,10 +117,24 @@ public class NetworkGraph extends CommonBase {
 		return ret_hu_conv;
 	}
 
+	/**
+	 * Close a channel if a corresponding HTLC fail was sent.
+	 * If permanent, removes a channel from the local storage.
+	 * May cause the removal of nodes too, if this was their last channel.
+	 * If not permanent, makes channels unavailable for routing.
+	 */
 	public void close_channel_from_update(long short_channel_id, boolean is_permanent) {
 		bindings.NetworkGraph_close_channel_from_update(this.ptr, short_channel_id, is_permanent);
 	}
 
+	/**
+	 * For an already known (from announcement) channel, update info about one of the directions
+	 * of the channel.
+	 * 
+	 * You probably don't want to call this directly, instead relying on a NetGraphMsgHandler's
+	 * RoutingMessageHandler implementation to call it indirectly. This may be useful to accept
+	 * routing messages from a source using a protocol other than the lightning P2P protocol.
+	 */
 	public Result_NoneLightningErrorZ update_channel(ChannelUpdate msg) {
 		long ret = bindings.NetworkGraph_update_channel(this.ptr, msg == null ? 0 : msg.ptr & ~1);
 		Result_NoneLightningErrorZ ret_hu_conv = Result_NoneLightningErrorZ.constr_from_ptr(ret);
@@ -80,6 +142,11 @@ public class NetworkGraph extends CommonBase {
 		return ret_hu_conv;
 	}
 
+	/**
+	 * For an already known (from announcement) channel, update info about one of the directions
+	 * of the channel without verifying the associated signatures. Because we aren't given the
+	 * associated signatures here we cannot relay the channel update to any of our peers.
+	 */
 	public Result_NoneLightningErrorZ update_channel_unsigned(UnsignedChannelUpdate msg) {
 		long ret = bindings.NetworkGraph_update_channel_unsigned(this.ptr, msg == null ? 0 : msg.ptr & ~1);
 		Result_NoneLightningErrorZ ret_hu_conv = Result_NoneLightningErrorZ.constr_from_ptr(ret);