_ Git - ldk-java/blob - src/main/java/org/ldk/structs/NetGraphMsgHandler.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
   8
   9 /**
  10  * Receives and validates network updates from peers,
  11  * stores authentic and relevant data as a network graph.
  12  * This network graph is then used for routing payments.
  13  * Provides interface to help with initial routing sync by
  14  * serving historical announcements.
  15  */
  16 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
  17 public class NetGraphMsgHandler extends CommonBase {
  18         NetGraphMsgHandler(Object _dummy, long ptr) { super(ptr); }
  19         @Override @SuppressWarnings("deprecation")
  20         protected void finalize() throws Throwable {
  21                 super.finalize();
  22                 if (ptr != 0) { bindings.NetGraphMsgHandler_free(ptr); }
  23         }
  24
  25         /**
  26          * Creates a new tracker of the actual state of the network of channels and nodes,
  27          * assuming a fresh network graph.
  28          * Chain monitor is used to make sure announced channels exist on-chain,
  29          * channel data is correct, and that the announcement is signed with
  30          * channel owners' keys.
  31          *
  32          * Note that chain_access (or a relevant inner pointer) may be NULL or all-0s to represent None
  33          */
  34         public static NetGraphMsgHandler of(byte[] genesis_hash, @Nullable Access chain_access, Logger logger) {
  35                 long ret = bindings.NetGraphMsgHandler_new(genesis_hash, chain_access == null ? 0 : chain_access.ptr, logger == null ? 0 : logger.ptr);
  36                 if (ret < 1024) { return null; }
  37                 NetGraphMsgHandler ret_hu_conv = new NetGraphMsgHandler(null, ret);
  38                 ret_hu_conv.ptrs_to.add(ret_hu_conv);
  39                 ret_hu_conv.ptrs_to.add(chain_access);
  40                 ret_hu_conv.ptrs_to.add(logger);
  41                 return ret_hu_conv;
  42         }
  43
  44         /**
  45          * Creates a new tracker of the actual state of the network of channels and nodes,
  46          * assuming an existing Network Graph.
  47          *
  48          * Note that chain_access (or a relevant inner pointer) may be NULL or all-0s to represent None
  49          */
  50         public static NetGraphMsgHandler from_net_graph(@Nullable Access chain_access, Logger logger, NetworkGraph network_graph) {
  51                 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);
  52                 if (ret < 1024) { return null; }
  53                 NetGraphMsgHandler ret_hu_conv = new NetGraphMsgHandler(null, ret);
  54                 ret_hu_conv.ptrs_to.add(ret_hu_conv);
  55                 ret_hu_conv.ptrs_to.add(chain_access);
  56                 ret_hu_conv.ptrs_to.add(logger);
  57                 ret_hu_conv.ptrs_to.add(network_graph);
  58                 return ret_hu_conv;
  59         }
  60
  61         /**
  62          * Adds a provider used to check new announcements. Does not affect
  63          * existing announcements unless they are updated.
  64          * Add, update or remove the provider would replace the current one.
  65          *
  66          * Note that chain_access (or a relevant inner pointer) may be NULL or all-0s to represent None
  67          */
  68         public void add_chain_access(@Nullable Access chain_access) {
  69                 bindings.NetGraphMsgHandler_add_chain_access(this.ptr, chain_access == null ? 0 : chain_access.ptr);
  70                 this.ptrs_to.add(chain_access);
  71         }
  72
  73         /**
  74          * Take a read lock on the network_graph and return it in the C-bindings
  75          * newtype helper. This is likely only useful when called via the C
  76          * bindings as you can call `self.network_graph.read().unwrap()` in Rust
  77          * yourself.
  78          */
  79         public LockedNetworkGraph read_locked_graph() {
  80                 long ret = bindings.NetGraphMsgHandler_read_locked_graph(this.ptr);
  81                 if (ret < 1024) { return null; }
  82                 LockedNetworkGraph ret_hu_conv = new LockedNetworkGraph(null, ret);
  83                 ret_hu_conv.ptrs_to.add(this);
  84                 return ret_hu_conv;
  85         }
  86
  87         /**
  88          * Constructs a new RoutingMessageHandler which calls the relevant methods on this_arg.
  89          * This copies the `inner` pointer in this_arg and thus the returned RoutingMessageHandler must be freed before this_arg is
  90          */
  91         public RoutingMessageHandler as_RoutingMessageHandler() {
  92                 long ret = bindings.NetGraphMsgHandler_as_RoutingMessageHandler(this.ptr);
  93                 if (ret < 1024) { return null; }
  94                 RoutingMessageHandler ret_hu_conv = new RoutingMessageHandler(null, ret);
  95                 ret_hu_conv.ptrs_to.add(this);
  96                 return ret_hu_conv;
  97         }
  98
  99         /**
 100          * Constructs a new MessageSendEventsProvider which calls the relevant methods on this_arg.
 101          * This copies the `inner` pointer in this_arg and thus the returned MessageSendEventsProvider must be freed before this_arg is
 102          */
 103         public MessageSendEventsProvider as_MessageSendEventsProvider() {
 104                 long ret = bindings.NetGraphMsgHandler_as_MessageSendEventsProvider(this.ptr);
 105                 if (ret < 1024) { return null; }
 106                 MessageSendEventsProvider ret_hu_conv = new MessageSendEventsProvider(null, ret);
 107                 ret_hu_conv.ptrs_to.add(this);
 108                 return ret_hu_conv;
 109         }
 110
 111 }