_ Git - ldk-java/blob - src/main/java/org/ldk/structs/NetworkGraph.java

   1 package org.ldk.structs;
   2
   3 import org.ldk.impl.bindings;
   4 import org.ldk.enums.*;
   5 import org.ldk.util.*;
   6 import java.util.Arrays;
   7 import java.lang.ref.Reference;
   8 import javax.annotation.Nullable;
   9
  10
  11 /**
  12  * Represents the network as nodes and channels between them
  13  */
  14 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
  15 public class NetworkGraph extends CommonBase {
  16         NetworkGraph(Object _dummy, long ptr) { super(ptr); }
  17         @Override @SuppressWarnings("deprecation")
  18         protected void finalize() throws Throwable {
  19                 super.finalize();
  20                 if (ptr != 0) { bindings.NetworkGraph_free(ptr); }
  21         }
  22
  23         /**
  24          * Handles any network updates originating from [`Event`]s.
  25          *
  26          * [`Event`]: crate::events::Event
  27          */
  28         public void handle_network_update(org.ldk.structs.NetworkUpdate network_update) {
  29                 bindings.NetworkGraph_handle_network_update(this.ptr, network_update == null ? 0 : network_update.ptr);
  30                 Reference.reachabilityFence(this);
  31                 Reference.reachabilityFence(network_update);
  32         }
  33
  34         /**
  35          * Serialize the NetworkGraph object into a byte array which can be read by NetworkGraph_read
  36          */
  37         public byte[] write() {
  38                 byte[] ret = bindings.NetworkGraph_write(this.ptr);
  39                 Reference.reachabilityFence(this);
  40                 return ret;
  41         }
  42
  43         /**
  44          * Read a NetworkGraph from a byte array, created by NetworkGraph_write
  45          */
  46         public static Result_NetworkGraphDecodeErrorZ read(byte[] ser, org.ldk.structs.Logger arg) {
  47                 long ret = bindings.NetworkGraph_read(ser, arg.ptr);
  48                 Reference.reachabilityFence(ser);
  49                 Reference.reachabilityFence(arg);
  50                 if (ret >= 0 && ret <= 4096) { return null; }
  51                 Result_NetworkGraphDecodeErrorZ ret_hu_conv = Result_NetworkGraphDecodeErrorZ.constr_from_ptr(ret);
  52                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(arg); };
  53                 return ret_hu_conv;
  54         }
  55
  56         /**
  57          * Creates a new, empty, network graph.
  58          */
  59         public static NetworkGraph of(org.ldk.enums.Network network, org.ldk.structs.Logger logger) {
  60                 long ret = bindings.NetworkGraph_new(network, logger.ptr);
  61                 Reference.reachabilityFence(network);
  62                 Reference.reachabilityFence(logger);
  63                 if (ret >= 0 && ret <= 4096) { return null; }
  64                 org.ldk.structs.NetworkGraph ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.NetworkGraph(null, ret); }
  65                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(ret_hu_conv); };
  66                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(logger); };
  67                 return ret_hu_conv;
  68         }
  69
  70         /**
  71          * Returns a read-only view of the network graph.
  72          */
  73         public ReadOnlyNetworkGraph read_only() {
  74                 long ret = bindings.NetworkGraph_read_only(this.ptr);
  75                 Reference.reachabilityFence(this);
  76                 if (ret >= 0 && ret <= 4096) { return null; }
  77                 org.ldk.structs.ReadOnlyNetworkGraph ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.ReadOnlyNetworkGraph(null, ret); }
  78                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
  79                 return ret_hu_conv;
  80         }
  81
  82         /**
  83          * The unix timestamp provided by the most recent rapid gossip sync.
  84          * It will be set by the rapid sync process after every sync completion.
  85          */
  86         public Option_u32Z get_last_rapid_gossip_sync_timestamp() {
  87                 long ret = bindings.NetworkGraph_get_last_rapid_gossip_sync_timestamp(this.ptr);
  88                 Reference.reachabilityFence(this);
  89                 if (ret >= 0 && ret <= 4096) { return null; }
  90                 org.ldk.structs.Option_u32Z ret_hu_conv = org.ldk.structs.Option_u32Z.constr_from_ptr(ret);
  91                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
  92                 return ret_hu_conv;
  93         }
  94
  95         /**
  96          * Update the unix timestamp provided by the most recent rapid gossip sync.
  97          * This should be done automatically by the rapid sync process after every sync completion.
  98          */
  99         public void set_last_rapid_gossip_sync_timestamp(int last_rapid_gossip_sync_timestamp) {
 100                 bindings.NetworkGraph_set_last_rapid_gossip_sync_timestamp(this.ptr, last_rapid_gossip_sync_timestamp);
 101                 Reference.reachabilityFence(this);
 102                 Reference.reachabilityFence(last_rapid_gossip_sync_timestamp);
 103         }
 104
 105         /**
 106          * For an already known node (from channel announcements), update its stored properties from a
 107          * given node announcement.
 108          *
 109          * You probably don't want to call this directly, instead relying on a P2PGossipSync's
 110          * RoutingMessageHandler implementation to call it indirectly. This may be useful to accept
 111          * routing messages from a source using a protocol other than the lightning P2P protocol.
 112          */
 113         public Result_NoneLightningErrorZ update_node_from_announcement(org.ldk.structs.NodeAnnouncement msg) {
 114                 long ret = bindings.NetworkGraph_update_node_from_announcement(this.ptr, msg == null ? 0 : msg.ptr);
 115                 Reference.reachabilityFence(this);
 116                 Reference.reachabilityFence(msg);
 117                 if (ret >= 0 && ret <= 4096) { return null; }
 118                 Result_NoneLightningErrorZ ret_hu_conv = Result_NoneLightningErrorZ.constr_from_ptr(ret);
 119                 if (this != null) { this.ptrs_to.add(msg); };
 120                 return ret_hu_conv;
 121         }
 122
 123         /**
 124          * For an already known node (from channel announcements), update its stored properties from a
 125          * given node announcement without verifying the associated signatures. Because we aren't
 126          * given the associated signatures here we cannot relay the node announcement to any of our
 127          * peers.
 128          */
 129         public Result_NoneLightningErrorZ update_node_from_unsigned_announcement(org.ldk.structs.UnsignedNodeAnnouncement msg) {
 130                 long ret = bindings.NetworkGraph_update_node_from_unsigned_announcement(this.ptr, msg == null ? 0 : msg.ptr);
 131                 Reference.reachabilityFence(this);
 132                 Reference.reachabilityFence(msg);
 133                 if (ret >= 0 && ret <= 4096) { return null; }
 134                 Result_NoneLightningErrorZ ret_hu_conv = Result_NoneLightningErrorZ.constr_from_ptr(ret);
 135                 if (this != null) { this.ptrs_to.add(msg); };
 136                 return ret_hu_conv;
 137         }
 138
 139         /**
 140          * Store or update channel info from a channel announcement.
 141          *
 142          * You probably don't want to call this directly, instead relying on a P2PGossipSync's
 143          * RoutingMessageHandler implementation to call it indirectly. This may be useful to accept
 144          * routing messages from a source using a protocol other than the lightning P2P protocol.
 145          *
 146          * If a [`UtxoLookup`] object is provided via `utxo_lookup`, it will be called to verify
 147          * the corresponding UTXO exists on chain and is correctly-formatted.
 148          */
 149         public Result_NoneLightningErrorZ update_channel_from_announcement(org.ldk.structs.ChannelAnnouncement msg, org.ldk.structs.Option_UtxoLookupZ utxo_lookup) {
 150                 long ret = bindings.NetworkGraph_update_channel_from_announcement(this.ptr, msg == null ? 0 : msg.ptr, utxo_lookup.ptr);
 151                 Reference.reachabilityFence(this);
 152                 Reference.reachabilityFence(msg);
 153                 Reference.reachabilityFence(utxo_lookup);
 154                 if (ret >= 0 && ret <= 4096) { return null; }
 155                 Result_NoneLightningErrorZ ret_hu_conv = Result_NoneLightningErrorZ.constr_from_ptr(ret);
 156                 if (this != null) { this.ptrs_to.add(msg); };
 157                 if (this != null) { this.ptrs_to.add(utxo_lookup); };
 158                 return ret_hu_conv;
 159         }
 160
 161         /**
 162          * Store or update channel info from a channel announcement without verifying the associated
 163          * signatures. Because we aren't given the associated signatures here we cannot relay the
 164          * channel announcement to any of our peers.
 165          *
 166          * If a [`UtxoLookup`] object is provided via `utxo_lookup`, it will be called to verify
 167          * the corresponding UTXO exists on chain and is correctly-formatted.
 168          */
 169         public Result_NoneLightningErrorZ update_channel_from_unsigned_announcement(org.ldk.structs.UnsignedChannelAnnouncement msg, org.ldk.structs.Option_UtxoLookupZ utxo_lookup) {
 170                 long ret = bindings.NetworkGraph_update_channel_from_unsigned_announcement(this.ptr, msg == null ? 0 : msg.ptr, utxo_lookup.ptr);
 171                 Reference.reachabilityFence(this);
 172                 Reference.reachabilityFence(msg);
 173                 Reference.reachabilityFence(utxo_lookup);
 174                 if (ret >= 0 && ret <= 4096) { return null; }
 175                 Result_NoneLightningErrorZ ret_hu_conv = Result_NoneLightningErrorZ.constr_from_ptr(ret);
 176                 if (this != null) { this.ptrs_to.add(msg); };
 177                 if (this != null) { this.ptrs_to.add(utxo_lookup); };
 178                 return ret_hu_conv;
 179         }
 180
 181         /**
 182          * Update channel from partial announcement data received via rapid gossip sync
 183          *
 184          * `timestamp: u64`: Timestamp emulating the backdated original announcement receipt (by the
 185          * rapid gossip sync server)
 186          *
 187          * All other parameters as used in [`msgs::UnsignedChannelAnnouncement`] fields.
 188          */
 189         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) {
 190                 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));
 191                 Reference.reachabilityFence(this);
 192                 Reference.reachabilityFence(short_channel_id);
 193                 Reference.reachabilityFence(timestamp);
 194                 Reference.reachabilityFence(features);
 195                 Reference.reachabilityFence(node_id_1);
 196                 Reference.reachabilityFence(node_id_2);
 197                 if (ret >= 0 && ret <= 4096) { return null; }
 198                 Result_NoneLightningErrorZ ret_hu_conv = Result_NoneLightningErrorZ.constr_from_ptr(ret);
 199                 if (this != null) { this.ptrs_to.add(features); };
 200                 return ret_hu_conv;
 201         }
 202
 203         /**
 204          * Marks a channel in the graph as failed permanently.
 205          *
 206          * The channel and any node for which this was their last channel are removed from the graph.
 207          */
 208         public void channel_failed_permanent(long short_channel_id) {
 209                 bindings.NetworkGraph_channel_failed_permanent(this.ptr, short_channel_id);
 210                 Reference.reachabilityFence(this);
 211                 Reference.reachabilityFence(short_channel_id);
 212         }
 213
 214         /**
 215          * Marks a node in the graph as permanently failed, effectively removing it and its channels
 216          * from local storage.
 217          */
 218         public void node_failed_permanent(byte[] node_id) {
 219                 bindings.NetworkGraph_node_failed_permanent(this.ptr, InternalUtils.check_arr_len(node_id, 33));
 220                 Reference.reachabilityFence(this);
 221                 Reference.reachabilityFence(node_id);
 222         }
 223
 224         /**
 225          * Removes information about channels that we haven't heard any updates about in some time.
 226          * This can be used regularly to prune the network graph of channels that likely no longer
 227          * exist.
 228          *
 229          * While there is no formal requirement that nodes regularly re-broadcast their channel
 230          * updates every two weeks, the non-normative section of BOLT 7 currently suggests that
 231          * pruning occur for updates which are at least two weeks old, which we implement here.
 232          *
 233          * Note that for users of the `lightning-background-processor` crate this method may be
 234          * automatically called regularly for you.
 235          *
 236          * This method will also cause us to stop tracking removed nodes and channels if they have been
 237          * in the map for a while so that these can be resynced from gossip in the future.
 238          *
 239          * This method is only available with the `std` feature. See
 240          * [`NetworkGraph::remove_stale_channels_and_tracking_with_time`] for `no-std` use.
 241          */
 242         public void remove_stale_channels_and_tracking() {
 243                 bindings.NetworkGraph_remove_stale_channels_and_tracking(this.ptr);
 244                 Reference.reachabilityFence(this);
 245         }
 246
 247         /**
 248          * Removes information about channels that we haven't heard any updates about in some time.
 249          * This can be used regularly to prune the network graph of channels that likely no longer
 250          * exist.
 251          *
 252          * While there is no formal requirement that nodes regularly re-broadcast their channel
 253          * updates every two weeks, the non-normative section of BOLT 7 currently suggests that
 254          * pruning occur for updates which are at least two weeks old, which we implement here.
 255          *
 256          * This method will also cause us to stop tracking removed nodes and channels if they have been
 257          * in the map for a while so that these can be resynced from gossip in the future.
 258          *
 259          * This function takes the current unix time as an argument. For users with the `std` feature
 260          * enabled, [`NetworkGraph::remove_stale_channels_and_tracking`] may be preferable.
 261          */
 262         public void remove_stale_channels_and_tracking_with_time(long current_time_unix) {
 263                 bindings.NetworkGraph_remove_stale_channels_and_tracking_with_time(this.ptr, current_time_unix);
 264                 Reference.reachabilityFence(this);
 265                 Reference.reachabilityFence(current_time_unix);
 266         }
 267
 268         /**
 269          * For an already known (from announcement) channel, update info about one of the directions
 270          * of the channel.
 271          *
 272          * You probably don't want to call this directly, instead relying on a P2PGossipSync's
 273          * RoutingMessageHandler implementation to call it indirectly. This may be useful to accept
 274          * routing messages from a source using a protocol other than the lightning P2P protocol.
 275          *
 276          * If built with `no-std`, any updates with a timestamp more than two weeks in the past or
 277          * materially in the future will be rejected.
 278          */
 279         public Result_NoneLightningErrorZ update_channel(org.ldk.structs.ChannelUpdate msg) {
 280                 long ret = bindings.NetworkGraph_update_channel(this.ptr, msg == null ? 0 : msg.ptr);
 281                 Reference.reachabilityFence(this);
 282                 Reference.reachabilityFence(msg);
 283                 if (ret >= 0 && ret <= 4096) { return null; }
 284                 Result_NoneLightningErrorZ ret_hu_conv = Result_NoneLightningErrorZ.constr_from_ptr(ret);
 285                 if (this != null) { this.ptrs_to.add(msg); };
 286                 return ret_hu_conv;
 287         }
 288
 289         /**
 290          * For an already known (from announcement) channel, update info about one of the directions
 291          * of the channel without verifying the associated signatures. Because we aren't given the
 292          * associated signatures here we cannot relay the channel update to any of our peers.
 293          *
 294          * If built with `no-std`, any updates with a timestamp more than two weeks in the past or
 295          * materially in the future will be rejected.
 296          */
 297         public Result_NoneLightningErrorZ update_channel_unsigned(org.ldk.structs.UnsignedChannelUpdate msg) {
 298                 long ret = bindings.NetworkGraph_update_channel_unsigned(this.ptr, msg == null ? 0 : msg.ptr);
 299                 Reference.reachabilityFence(this);
 300                 Reference.reachabilityFence(msg);
 301                 if (ret >= 0 && ret <= 4096) { return null; }
 302                 Result_NoneLightningErrorZ ret_hu_conv = Result_NoneLightningErrorZ.constr_from_ptr(ret);
 303                 if (this != null) { this.ptrs_to.add(msg); };
 304                 return ret_hu_conv;
 305         }
 306
 307 }