_ 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 javax.annotation.Nullable;
   8
   9
  10 /**
  11  * Represents the network as nodes and channels between them
  12  */
  13 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
  14 public class NetworkGraph extends CommonBase {
  15         NetworkGraph(Object _dummy, long ptr) { super(ptr); }
  16         @Override @SuppressWarnings("deprecation")
  17         protected void finalize() throws Throwable {
  18                 super.finalize();
  19                 if (ptr != 0) { bindings.NetworkGraph_free(ptr); }
  20         }
  21
  22         /**
  23          * Serialize the NetworkGraph object into a byte array which can be read by NetworkGraph_read
  24          */
  25         public byte[] write() {
  26                 byte[] ret = bindings.NetworkGraph_write(this.ptr);
  27                 return ret;
  28         }
  29
  30         /**
  31          * Read a NetworkGraph from a byte array, created by NetworkGraph_write
  32          */
  33         public static Result_NetworkGraphDecodeErrorZ read(byte[] ser) {
  34                 long ret = bindings.NetworkGraph_read(ser);
  35                 if (ret < 1024) { return null; }
  36                 Result_NetworkGraphDecodeErrorZ ret_hu_conv = Result_NetworkGraphDecodeErrorZ.constr_from_ptr(ret);
  37                 return ret_hu_conv;
  38         }
  39
  40         /**
  41          * Creates a new, empty, network graph.
  42          */
  43         public static NetworkGraph of(byte[] genesis_hash) {
  44                 long ret = bindings.NetworkGraph_new(genesis_hash);
  45                 if (ret < 1024) { return null; }
  46                 NetworkGraph ret_hu_conv = new NetworkGraph(null, ret);
  47                 ret_hu_conv.ptrs_to.add(ret_hu_conv);
  48                 return ret_hu_conv;
  49         }
  50
  51         /**
  52          * Returns a read-only view of the network graph.
  53          */
  54         public ReadOnlyNetworkGraph read_only() {
  55                 long ret = bindings.NetworkGraph_read_only(this.ptr);
  56                 if (ret < 1024) { return null; }
  57                 ReadOnlyNetworkGraph ret_hu_conv = new ReadOnlyNetworkGraph(null, ret);
  58                 ret_hu_conv.ptrs_to.add(this);
  59                 return ret_hu_conv;
  60         }
  61
  62         /**
  63          * For an already known node (from channel announcements), update its stored properties from a
  64          * given node announcement.
  65          *
  66          * You probably don't want to call this directly, instead relying on a NetGraphMsgHandler's
  67          * RoutingMessageHandler implementation to call it indirectly. This may be useful to accept
  68          * routing messages from a source using a protocol other than the lightning P2P protocol.
  69          */
  70         public Result_NoneLightningErrorZ update_node_from_announcement(NodeAnnouncement msg) {
  71                 long ret = bindings.NetworkGraph_update_node_from_announcement(this.ptr, msg == null ? 0 : msg.ptr & ~1);
  72                 if (ret < 1024) { return null; }
  73                 Result_NoneLightningErrorZ ret_hu_conv = Result_NoneLightningErrorZ.constr_from_ptr(ret);
  74                 this.ptrs_to.add(msg);
  75                 return ret_hu_conv;
  76         }
  77
  78         /**
  79          * For an already known node (from channel announcements), update its stored properties from a
  80          * given node announcement without verifying the associated signatures. Because we aren't
  81          * given the associated signatures here we cannot relay the node announcement to any of our
  82          * peers.
  83          */
  84         public Result_NoneLightningErrorZ update_node_from_unsigned_announcement(UnsignedNodeAnnouncement msg) {
  85                 long ret = bindings.NetworkGraph_update_node_from_unsigned_announcement(this.ptr, msg == null ? 0 : msg.ptr & ~1);
  86                 if (ret < 1024) { return null; }
  87                 Result_NoneLightningErrorZ ret_hu_conv = Result_NoneLightningErrorZ.constr_from_ptr(ret);
  88                 this.ptrs_to.add(msg);
  89                 return ret_hu_conv;
  90         }
  91
  92         /**
  93          * Store or update channel info from a channel announcement.
  94          *
  95          * You probably don't want to call this directly, instead relying on a NetGraphMsgHandler's
  96          * RoutingMessageHandler implementation to call it indirectly. This may be useful to accept
  97          * routing messages from a source using a protocol other than the lightning P2P protocol.
  98          *
  99          * If a `chain::Access` object is provided via `chain_access`, it will be called to verify
 100          * the corresponding UTXO exists on chain and is correctly-formatted.
 101          */
 102         public Result_NoneLightningErrorZ update_channel_from_announcement(ChannelAnnouncement msg, Option_AccessZ chain_access) {
 103                 long ret = bindings.NetworkGraph_update_channel_from_announcement(this.ptr, msg == null ? 0 : msg.ptr & ~1, chain_access.ptr);
 104                 if (ret < 1024) { return null; }
 105                 Result_NoneLightningErrorZ ret_hu_conv = Result_NoneLightningErrorZ.constr_from_ptr(ret);
 106                 this.ptrs_to.add(msg);
 107                 return ret_hu_conv;
 108         }
 109
 110         /**
 111          * Store or update channel info from a channel announcement without verifying the associated
 112          * signatures. Because we aren't given the associated signatures here we cannot relay the
 113          * channel announcement to any of our peers.
 114          *
 115          * If a `chain::Access` object is provided via `chain_access`, it will be called to verify
 116          * the corresponding UTXO exists on chain and is correctly-formatted.
 117          */
 118         public Result_NoneLightningErrorZ update_channel_from_unsigned_announcement(UnsignedChannelAnnouncement msg, Option_AccessZ chain_access) {
 119                 long ret = bindings.NetworkGraph_update_channel_from_unsigned_announcement(this.ptr, msg == null ? 0 : msg.ptr & ~1, chain_access.ptr);
 120                 if (ret < 1024) { return null; }
 121                 Result_NoneLightningErrorZ ret_hu_conv = Result_NoneLightningErrorZ.constr_from_ptr(ret);
 122                 this.ptrs_to.add(msg);
 123                 return ret_hu_conv;
 124         }
 125
 126         /**
 127          * Close a channel if a corresponding HTLC fail was sent.
 128          * If permanent, removes a channel from the local storage.
 129          * May cause the removal of nodes too, if this was their last channel.
 130          * If not permanent, makes channels unavailable for routing.
 131          */
 132         public void close_channel_from_update(long short_channel_id, boolean is_permanent) {
 133                 bindings.NetworkGraph_close_channel_from_update(this.ptr, short_channel_id, is_permanent);
 134         }
 135
 136         /**
 137          * Marks a node in the graph as failed.
 138          */
 139         public void fail_node(byte[] _node_id, boolean is_permanent) {
 140                 bindings.NetworkGraph_fail_node(this.ptr, _node_id, is_permanent);
 141         }
 142
 143         /**
 144          * For an already known (from announcement) channel, update info about one of the directions
 145          * of the channel.
 146          *
 147          * You probably don't want to call this directly, instead relying on a NetGraphMsgHandler's
 148          * RoutingMessageHandler implementation to call it indirectly. This may be useful to accept
 149          * routing messages from a source using a protocol other than the lightning P2P protocol.
 150          */
 151         public Result_NoneLightningErrorZ update_channel(ChannelUpdate msg) {
 152                 long ret = bindings.NetworkGraph_update_channel(this.ptr, msg == null ? 0 : msg.ptr & ~1);
 153                 if (ret < 1024) { return null; }
 154                 Result_NoneLightningErrorZ ret_hu_conv = Result_NoneLightningErrorZ.constr_from_ptr(ret);
 155                 this.ptrs_to.add(msg);
 156                 return ret_hu_conv;
 157         }
 158
 159         /**
 160          * For an already known (from announcement) channel, update info about one of the directions
 161          * of the channel without verifying the associated signatures. Because we aren't given the
 162          * associated signatures here we cannot relay the channel update to any of our peers.
 163          */
 164         public Result_NoneLightningErrorZ update_channel_unsigned(UnsignedChannelUpdate msg) {
 165                 long ret = bindings.NetworkGraph_update_channel_unsigned(this.ptr, msg == null ? 0 : msg.ptr & ~1);
 166                 if (ret < 1024) { return null; }
 167                 Result_NoneLightningErrorZ ret_hu_conv = Result_NoneLightningErrorZ.constr_from_ptr(ret);
 168                 this.ptrs_to.add(msg);
 169                 return ret_hu_conv;
 170         }
 171
 172 }