Update auto-updated Java files
[ldk-java] / src / main / java / org / ldk / structs / NetworkGraph.java
index 69d615eddae0afd08b200a5f0b08942a47962e06..e2f17ce1fcfbf7c912055ee2c64ca9f9c495ec15 100644 (file)
@@ -4,6 +4,8 @@ import org.ldk.impl.bindings;
 import org.ldk.enums.*;
 import org.ldk.util.*;
 import java.util.Arrays;
+import java.lang.ref.Reference;
+import javax.annotation.Nullable;
 
 
 /**
@@ -18,12 +20,20 @@ public class NetworkGraph extends CommonBase {
                if (ptr != 0) { bindings.NetworkGraph_free(ptr); }
        }
 
+       long clone_ptr() {
+               long ret = bindings.NetworkGraph_clone_ptr(this.ptr);
+               Reference.reachabilityFence(this);
+               return ret;
+       }
+
        /**
         * Creates a copy of the NetworkGraph
         */
        public NetworkGraph clone() {
                long ret = bindings.NetworkGraph_clone(this.ptr);
-               NetworkGraph ret_hu_conv = new NetworkGraph(null, ret);
+               Reference.reachabilityFence(this);
+               if (ret >= 0 && ret <= 4096) { return null; }
+               NetworkGraph ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new NetworkGraph(null, ret); }
                ret_hu_conv.ptrs_to.add(this);
                return ret_hu_conv;
        }
@@ -33,6 +43,7 @@ public class NetworkGraph extends CommonBase {
         */
        public byte[] write() {
                byte[] ret = bindings.NetworkGraph_write(this.ptr);
+               Reference.reachabilityFence(this);
                return ret;
        }
 
@@ -41,6 +52,8 @@ public class NetworkGraph extends CommonBase {
         */
        public static Result_NetworkGraphDecodeErrorZ read(byte[] ser) {
                long ret = bindings.NetworkGraph_read(ser);
+               Reference.reachabilityFence(ser);
+               if (ret >= 0 && ret <= 4096) { return null; }
                Result_NetworkGraphDecodeErrorZ ret_hu_conv = Result_NetworkGraphDecodeErrorZ.constr_from_ptr(ret);
                return ret_hu_conv;
        }
@@ -49,12 +62,26 @@ public class NetworkGraph extends CommonBase {
         * Creates a new, empty, network graph.
         */
        public static NetworkGraph of(byte[] genesis_hash) {
-               long ret = bindings.NetworkGraph_new(genesis_hash);
-               NetworkGraph ret_hu_conv = new NetworkGraph(null, ret);
+               long ret = bindings.NetworkGraph_new(InternalUtils.check_arr_len(genesis_hash, 32));
+               Reference.reachabilityFence(genesis_hash);
+               if (ret >= 0 && ret <= 4096) { return null; }
+               NetworkGraph ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new NetworkGraph(null, ret); }
                ret_hu_conv.ptrs_to.add(ret_hu_conv);
                return ret_hu_conv;
        }
 
+       /**
+        * Returns a read-only view of the network graph.
+        */
+       public ReadOnlyNetworkGraph read_only() {
+               long ret = bindings.NetworkGraph_read_only(this.ptr);
+               Reference.reachabilityFence(this);
+               if (ret >= 0 && ret <= 4096) { return null; }
+               ReadOnlyNetworkGraph ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new ReadOnlyNetworkGraph(null, ret); }
+               ret_hu_conv.ptrs_to.add(this);
+               return ret_hu_conv;
+       }
+
        /**
         * For an already known node (from channel announcements), update its stored properties from a
         * given node announcement.
@@ -65,6 +92,9 @@ public class NetworkGraph extends CommonBase {
         */
        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);
+               Reference.reachabilityFence(this);
+               Reference.reachabilityFence(msg);
+               if (ret >= 0 && ret <= 4096) { return null; }
                Result_NoneLightningErrorZ ret_hu_conv = Result_NoneLightningErrorZ.constr_from_ptr(ret);
                this.ptrs_to.add(msg);
                return ret_hu_conv;
@@ -78,6 +108,9 @@ public class NetworkGraph extends CommonBase {
         */
        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);
+               Reference.reachabilityFence(this);
+               Reference.reachabilityFence(msg);
+               if (ret >= 0 && ret <= 4096) { return null; }
                Result_NoneLightningErrorZ ret_hu_conv = Result_NoneLightningErrorZ.constr_from_ptr(ret);
                this.ptrs_to.add(msg);
                return ret_hu_conv;
@@ -93,8 +126,12 @@ public class NetworkGraph extends CommonBase {
         * 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);
+       public Result_NoneLightningErrorZ update_channel_from_announcement(ChannelAnnouncement msg, Option_AccessZ chain_access) {
+               long ret = bindings.NetworkGraph_update_channel_from_announcement(this.ptr, msg == null ? 0 : msg.ptr & ~1, chain_access.ptr);
+               Reference.reachabilityFence(this);
+               Reference.reachabilityFence(msg);
+               Reference.reachabilityFence(chain_access);
+               if (ret >= 0 && ret <= 4096) { return null; }
                Result_NoneLightningErrorZ ret_hu_conv = Result_NoneLightningErrorZ.constr_from_ptr(ret);
                this.ptrs_to.add(msg);
                this.ptrs_to.add(chain_access);
@@ -109,8 +146,12 @@ public class NetworkGraph extends CommonBase {
         * 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);
+       public Result_NoneLightningErrorZ update_channel_from_unsigned_announcement(UnsignedChannelAnnouncement msg, Option_AccessZ chain_access) {
+               long ret = bindings.NetworkGraph_update_channel_from_unsigned_announcement(this.ptr, msg == null ? 0 : msg.ptr & ~1, chain_access.ptr);
+               Reference.reachabilityFence(this);
+               Reference.reachabilityFence(msg);
+               Reference.reachabilityFence(chain_access);
+               if (ret >= 0 && ret <= 4096) { return null; }
                Result_NoneLightningErrorZ ret_hu_conv = Result_NoneLightningErrorZ.constr_from_ptr(ret);
                this.ptrs_to.add(msg);
                this.ptrs_to.add(chain_access);
@@ -125,6 +166,37 @@ public class NetworkGraph extends CommonBase {
         */
        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);
+               Reference.reachabilityFence(this);
+               Reference.reachabilityFence(short_channel_id);
+               Reference.reachabilityFence(is_permanent);
+       }
+
+       /**
+        * Marks a node in the graph as failed.
+        */
+       public void fail_node(byte[] _node_id, boolean is_permanent) {
+               bindings.NetworkGraph_fail_node(this.ptr, InternalUtils.check_arr_len(_node_id, 33), is_permanent);
+               Reference.reachabilityFence(this);
+               Reference.reachabilityFence(_node_id);
+               Reference.reachabilityFence(is_permanent);
+       }
+
+       /**
+        * Removes information about channels that we haven't heard any updates about in some time.
+        * This can be used regularly to prune the network graph of channels that likely no longer
+        * exist.
+        * 
+        * While there is no formal requirement that nodes regularly re-broadcast their channel
+        * updates every two weeks, the non-normative section of BOLT 7 currently suggests that
+        * pruning occur for updates which are at least two weeks old, which we implement here.
+        * 
+        * This function takes the current unix time as an argument. For users with the `std` feature
+        * enabled, [`NetworkGraph::remove_stale_channels`] may be preferable.
+        */
+       public void remove_stale_channels_with_time(long current_time_unix) {
+               bindings.NetworkGraph_remove_stale_channels_with_time(this.ptr, current_time_unix);
+               Reference.reachabilityFence(this);
+               Reference.reachabilityFence(current_time_unix);
        }
 
        /**
@@ -134,9 +206,15 @@ public class NetworkGraph extends CommonBase {
         * 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 built with `no-std`, any updates with a timestamp more than two weeks in the past or
+        * materially in the future will be rejected.
         */
        public Result_NoneLightningErrorZ update_channel(ChannelUpdate msg) {
                long ret = bindings.NetworkGraph_update_channel(this.ptr, msg == null ? 0 : msg.ptr & ~1);
+               Reference.reachabilityFence(this);
+               Reference.reachabilityFence(msg);
+               if (ret >= 0 && ret <= 4096) { return null; }
                Result_NoneLightningErrorZ ret_hu_conv = Result_NoneLightningErrorZ.constr_from_ptr(ret);
                this.ptrs_to.add(msg);
                return ret_hu_conv;
@@ -146,9 +224,15 @@ public class NetworkGraph extends CommonBase {
         * 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.
+        * 
+        * If built with `no-std`, any updates with a timestamp more than two weeks in the past or
+        * materially in the future will be rejected.
         */
        public Result_NoneLightningErrorZ update_channel_unsigned(UnsignedChannelUpdate msg) {
                long ret = bindings.NetworkGraph_update_channel_unsigned(this.ptr, msg == null ? 0 : msg.ptr & ~1);
+               Reference.reachabilityFence(this);
+               Reference.reachabilityFence(msg);
+               if (ret >= 0 && ret <= 4096) { return null; }
                Result_NoneLightningErrorZ ret_hu_conv = Result_NoneLightningErrorZ.constr_from_ptr(ret);
                this.ptrs_to.add(msg);
                return ret_hu_conv;