6 namespace org { namespace ldk { namespace structs {
10 * Represents the network as nodes and channels between them
12 public class NetworkGraph : CommonBase {
13 internal NetworkGraph(object _dummy, long ptr) : base(ptr) { }
15 if (ptr != 0) { bindings.NetworkGraph_free(ptr); }
19 * Handles any network updates originating from [`Event`]s.
21 * [`Event`]: crate::util::events::Event
23 public void handle_network_update(org.ldk.structs.NetworkUpdate network_update) {
24 bindings.NetworkGraph_handle_network_update(this.ptr, network_update == null ? 0 : network_update.ptr);
26 GC.KeepAlive(network_update);
30 * Serialize the NetworkGraph object into a byte array which can be read by NetworkGraph_read
32 public byte[] write() {
33 byte[] ret = bindings.NetworkGraph_write(this.ptr);
39 * Read a NetworkGraph from a byte array, created by NetworkGraph_write
41 public static Result_NetworkGraphDecodeErrorZ read(byte[] ser, org.ldk.structs.Logger arg) {
42 long ret = bindings.NetworkGraph_read(ser, arg == null ? 0 : arg.ptr);
45 if (ret >= 0 && ret <= 4096) { return null; }
46 Result_NetworkGraphDecodeErrorZ ret_hu_conv = Result_NetworkGraphDecodeErrorZ.constr_from_ptr(ret);
47 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.AddLast(arg); };
52 * Creates a new, empty, network graph.
54 public static NetworkGraph of(byte[] genesis_hash, org.ldk.structs.Logger logger) {
55 long ret = bindings.NetworkGraph_new(InternalUtils.check_arr_len(genesis_hash, 32), logger == null ? 0 : logger.ptr);
56 GC.KeepAlive(genesis_hash);
58 if (ret >= 0 && ret <= 4096) { return null; }
59 org.ldk.structs.NetworkGraph ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.NetworkGraph(null, ret); }
60 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.AddLast(ret_hu_conv); };
61 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.AddLast(logger); };
66 * Returns a read-only view of the network graph.
68 public ReadOnlyNetworkGraph read_only() {
69 long ret = bindings.NetworkGraph_read_only(this.ptr);
71 if (ret >= 0 && ret <= 4096) { return null; }
72 org.ldk.structs.ReadOnlyNetworkGraph ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.ReadOnlyNetworkGraph(null, ret); }
73 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.AddLast(this); };
78 * The unix timestamp provided by the most recent rapid gossip sync.
79 * It will be set by the rapid sync process after every sync completion.
81 public Option_u32Z get_last_rapid_gossip_sync_timestamp() {
82 long ret = bindings.NetworkGraph_get_last_rapid_gossip_sync_timestamp(this.ptr);
84 if (ret >= 0 && ret <= 4096) { return null; }
85 org.ldk.structs.Option_u32Z ret_hu_conv = org.ldk.structs.Option_u32Z.constr_from_ptr(ret);
86 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.AddLast(this); };
91 * Update the unix timestamp provided by the most recent rapid gossip sync.
92 * This should be done automatically by the rapid sync process after every sync completion.
94 public void set_last_rapid_gossip_sync_timestamp(int last_rapid_gossip_sync_timestamp) {
95 bindings.NetworkGraph_set_last_rapid_gossip_sync_timestamp(this.ptr, last_rapid_gossip_sync_timestamp);
97 GC.KeepAlive(last_rapid_gossip_sync_timestamp);
101 * For an already known node (from channel announcements), update its stored properties from a
102 * given node announcement.
104 * You probably don't want to call this directly, instead relying on a P2PGossipSync's
105 * RoutingMessageHandler implementation to call it indirectly. This may be useful to accept
106 * routing messages from a source using a protocol other than the lightning P2P protocol.
108 public Result_NoneLightningErrorZ update_node_from_announcement(org.ldk.structs.NodeAnnouncement msg) {
109 long ret = bindings.NetworkGraph_update_node_from_announcement(this.ptr, msg == null ? 0 : msg.ptr);
112 if (ret >= 0 && ret <= 4096) { return null; }
113 Result_NoneLightningErrorZ ret_hu_conv = Result_NoneLightningErrorZ.constr_from_ptr(ret);
114 if (this != null) { this.ptrs_to.AddLast(msg); };
119 * For an already known node (from channel announcements), update its stored properties from a
120 * given node announcement without verifying the associated signatures. Because we aren't
121 * given the associated signatures here we cannot relay the node announcement to any of our
124 public Result_NoneLightningErrorZ update_node_from_unsigned_announcement(org.ldk.structs.UnsignedNodeAnnouncement msg) {
125 long ret = bindings.NetworkGraph_update_node_from_unsigned_announcement(this.ptr, msg == null ? 0 : msg.ptr);
128 if (ret >= 0 && ret <= 4096) { return null; }
129 Result_NoneLightningErrorZ ret_hu_conv = Result_NoneLightningErrorZ.constr_from_ptr(ret);
130 if (this != null) { this.ptrs_to.AddLast(msg); };
135 * Store or update channel info from a channel announcement.
137 * You probably don't want to call this directly, instead relying on a P2PGossipSync's
138 * RoutingMessageHandler implementation to call it indirectly. This may be useful to accept
139 * routing messages from a source using a protocol other than the lightning P2P protocol.
141 * If a `chain::Access` object is provided via `chain_access`, it will be called to verify
142 * the corresponding UTXO exists on chain and is correctly-formatted.
144 public Result_NoneLightningErrorZ update_channel_from_announcement(org.ldk.structs.ChannelAnnouncement msg, org.ldk.structs.Option_AccessZ chain_access) {
145 long ret = bindings.NetworkGraph_update_channel_from_announcement(this.ptr, msg == null ? 0 : msg.ptr, chain_access.ptr);
148 GC.KeepAlive(chain_access);
149 if (ret >= 0 && ret <= 4096) { return null; }
150 Result_NoneLightningErrorZ ret_hu_conv = Result_NoneLightningErrorZ.constr_from_ptr(ret);
151 if (this != null) { this.ptrs_to.AddLast(msg); };
152 if (this != null) { this.ptrs_to.AddLast(chain_access); };
157 * Store or update channel info from a channel announcement without verifying the associated
158 * signatures. Because we aren't given the associated signatures here we cannot relay the
159 * channel announcement to any of our peers.
161 * If a `chain::Access` object is provided via `chain_access`, it will be called to verify
162 * the corresponding UTXO exists on chain and is correctly-formatted.
164 public Result_NoneLightningErrorZ update_channel_from_unsigned_announcement(org.ldk.structs.UnsignedChannelAnnouncement msg, org.ldk.structs.Option_AccessZ chain_access) {
165 long ret = bindings.NetworkGraph_update_channel_from_unsigned_announcement(this.ptr, msg == null ? 0 : msg.ptr, chain_access.ptr);
168 GC.KeepAlive(chain_access);
169 if (ret >= 0 && ret <= 4096) { return null; }
170 Result_NoneLightningErrorZ ret_hu_conv = Result_NoneLightningErrorZ.constr_from_ptr(ret);
171 if (this != null) { this.ptrs_to.AddLast(msg); };
172 if (this != null) { this.ptrs_to.AddLast(chain_access); };
177 * Update channel from partial announcement data received via rapid gossip sync
179 * `timestamp: u64`: Timestamp emulating the backdated original announcement receipt (by the
180 * rapid gossip sync server)
182 * All other parameters as used in [`msgs::UnsignedChannelAnnouncement`] fields.
184 public Result_NoneLightningErrorZ add_channel_from_partial_announcement(long short_channel_id, long timestamp, org.ldk.structs.ChannelFeatures features, byte[] node_id_1, byte[] node_id_2) {
185 long ret = bindings.NetworkGraph_add_channel_from_partial_announcement(this.ptr, short_channel_id, timestamp, features == null ? 0 : features.ptr, InternalUtils.check_arr_len(node_id_1, 33), InternalUtils.check_arr_len(node_id_2, 33));
187 GC.KeepAlive(short_channel_id);
188 GC.KeepAlive(timestamp);
189 GC.KeepAlive(features);
190 GC.KeepAlive(node_id_1);
191 GC.KeepAlive(node_id_2);
192 if (ret >= 0 && ret <= 4096) { return null; }
193 Result_NoneLightningErrorZ ret_hu_conv = Result_NoneLightningErrorZ.constr_from_ptr(ret);
194 if (this != null) { this.ptrs_to.AddLast(features); };
199 * Marks a channel in the graph as failed if a corresponding HTLC fail was sent.
200 * If permanent, removes a channel from the local storage.
201 * May cause the removal of nodes too, if this was their last channel.
202 * If not permanent, makes channels unavailable for routing.
204 public void channel_failed(long short_channel_id, bool is_permanent) {
205 bindings.NetworkGraph_channel_failed(this.ptr, short_channel_id, is_permanent);
207 GC.KeepAlive(short_channel_id);
208 GC.KeepAlive(is_permanent);
212 * Marks a node in the graph as permanently failed, effectively removing it and its channels
213 * from local storage.
215 public void node_failed_permanent(byte[] node_id) {
216 bindings.NetworkGraph_node_failed_permanent(this.ptr, InternalUtils.check_arr_len(node_id, 33));
218 GC.KeepAlive(node_id);
222 * Removes information about channels that we haven't heard any updates about in some time.
223 * This can be used regularly to prune the network graph of channels that likely no longer
226 * While there is no formal requirement that nodes regularly re-broadcast their channel
227 * updates every two weeks, the non-normative section of BOLT 7 currently suggests that
228 * pruning occur for updates which are at least two weeks old, which we implement here.
230 * Note that for users of the `lightning-background-processor` crate this method may be
231 * automatically called regularly for you.
233 * This method will also cause us to stop tracking removed nodes and channels if they have been
234 * in the map for a while so that these can be resynced from gossip in the future.
236 * This method is only available with the `std` feature. See
237 * [`NetworkGraph::remove_stale_channels_and_tracking_with_time`] for `no-std` use.
239 public void remove_stale_channels_and_tracking() {
240 bindings.NetworkGraph_remove_stale_channels_and_tracking(this.ptr);
245 * Removes information about channels that we haven't heard any updates about in some time.
246 * This can be used regularly to prune the network graph of channels that likely no longer
249 * While there is no formal requirement that nodes regularly re-broadcast their channel
250 * updates every two weeks, the non-normative section of BOLT 7 currently suggests that
251 * pruning occur for updates which are at least two weeks old, which we implement here.
253 * This method will also cause us to stop tracking removed nodes and channels if they have been
254 * in the map for a while so that these can be resynced from gossip in the future.
256 * This function takes the current unix time as an argument. For users with the `std` feature
257 * enabled, [`NetworkGraph::remove_stale_channels_and_tracking`] may be preferable.
259 public void remove_stale_channels_and_tracking_with_time(long current_time_unix) {
260 bindings.NetworkGraph_remove_stale_channels_and_tracking_with_time(this.ptr, current_time_unix);
262 GC.KeepAlive(current_time_unix);
266 * For an already known (from announcement) channel, update info about one of the directions
269 * You probably don't want to call this directly, instead relying on a P2PGossipSync's
270 * RoutingMessageHandler implementation to call it indirectly. This may be useful to accept
271 * routing messages from a source using a protocol other than the lightning P2P protocol.
273 * If built with `no-std`, any updates with a timestamp more than two weeks in the past or
274 * materially in the future will be rejected.
276 public Result_NoneLightningErrorZ update_channel(org.ldk.structs.ChannelUpdate msg) {
277 long ret = bindings.NetworkGraph_update_channel(this.ptr, msg == null ? 0 : msg.ptr);
280 if (ret >= 0 && ret <= 4096) { return null; }
281 Result_NoneLightningErrorZ ret_hu_conv = Result_NoneLightningErrorZ.constr_from_ptr(ret);
282 if (this != null) { this.ptrs_to.AddLast(msg); };
287 * For an already known (from announcement) channel, update info about one of the directions
288 * of the channel without verifying the associated signatures. Because we aren't given the
289 * associated signatures here we cannot relay the channel update to any of our peers.
291 * If built with `no-std`, any updates with a timestamp more than two weeks in the past or
292 * materially in the future will be rejected.
294 public Result_NoneLightningErrorZ update_channel_unsigned(org.ldk.structs.UnsignedChannelUpdate msg) {
295 long ret = bindings.NetworkGraph_update_channel_unsigned(this.ptr, msg == null ? 0 : msg.ptr);
298 if (ret >= 0 && ret <= 4096) { return null; }
299 Result_NoneLightningErrorZ ret_hu_conv = Result_NoneLightningErrorZ.constr_from_ptr(ret);
300 if (this != null) { this.ptrs_to.AddLast(msg); };