[Java] Update auto-generated bindings to LDK 0.0.118
[ldk-java] / src / main / java / org / ldk / structs / NetworkGraph.java
index e69a40b6687c632351f732f6e5e09c344d9be3b3..adb402ffd7005505f900d715d833bcd664639cfe 100644 (file)
@@ -21,16 +21,25 @@ public class NetworkGraph extends CommonBase {
        }
 
        /**
-        * Constructs a new EventHandler which calls the relevant methods on this_arg.
-        * This copies the `inner` pointer in this_arg and thus the returned EventHandler must be freed before this_arg is
+        * Handles any network updates originating from [`Event`]s.
+        * Note that this will skip applying any [`NetworkUpdate::ChannelUpdateMessage`] to avoid
+        * leaking possibly identifying information of the sender to the public network.
+        * 
+        * [`Event`]: crate::events::Event
         */
-       public EventHandler as_EventHandler() {
-               long ret = bindings.NetworkGraph_as_EventHandler(this.ptr);
+       public void handle_network_update(org.ldk.structs.NetworkUpdate network_update) {
+               bindings.NetworkGraph_handle_network_update(this.ptr, network_update == null ? 0 : network_update.ptr);
                Reference.reachabilityFence(this);
-               if (ret >= 0 && ret <= 4096) { return null; }
-               EventHandler ret_hu_conv = new EventHandler(null, ret);
-               ret_hu_conv.ptrs_to.add(this);
-               return ret_hu_conv;
+               Reference.reachabilityFence(network_update);
+       }
+
+       /**
+        * Gets the chain hash for this network graph.
+        */
+       public byte[] get_chain_hash() {
+               byte[] ret = bindings.NetworkGraph_get_chain_hash(this.ptr);
+               Reference.reachabilityFence(this);
+               return ret;
        }
 
        /**
@@ -45,27 +54,27 @@ public class NetworkGraph extends CommonBase {
        /**
         * Read a NetworkGraph from a byte array, created by NetworkGraph_write
         */
-       public static Result_NetworkGraphDecodeErrorZ read(byte[] ser, Logger arg) {
-               long ret = bindings.NetworkGraph_read(ser, arg == null ? 0 : arg.ptr);
+       public static Result_NetworkGraphDecodeErrorZ read(byte[] ser, org.ldk.structs.Logger arg) {
+               long ret = bindings.NetworkGraph_read(ser, arg.ptr);
                Reference.reachabilityFence(ser);
                Reference.reachabilityFence(arg);
                if (ret >= 0 && ret <= 4096) { return null; }
                Result_NetworkGraphDecodeErrorZ ret_hu_conv = Result_NetworkGraphDecodeErrorZ.constr_from_ptr(ret);
-               ret_hu_conv.ptrs_to.add(arg);
+               if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(arg); };
                return ret_hu_conv;
        }
 
        /**
         * Creates a new, empty, network graph.
         */
-       public static NetworkGraph of(byte[] genesis_hash, Logger logger) {
-               long ret = bindings.NetworkGraph_new(InternalUtils.check_arr_len(genesis_hash, 32), logger == null ? 0 : logger.ptr);
-               Reference.reachabilityFence(genesis_hash);
+       public static NetworkGraph of(org.ldk.enums.Network network, org.ldk.structs.Logger logger) {
+               long ret = bindings.NetworkGraph_new(network, logger.ptr);
+               Reference.reachabilityFence(network);
                Reference.reachabilityFence(logger);
                if (ret >= 0 && ret <= 4096) { return null; }
                org.ldk.structs.NetworkGraph ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.NetworkGraph(null, ret); }
-               ret_hu_conv.ptrs_to.add(ret_hu_conv);
-               ret_hu_conv.ptrs_to.add(logger);
+               if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(ret_hu_conv); };
+               if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(logger); };
                return ret_hu_conv;
        }
 
@@ -77,7 +86,7 @@ public class NetworkGraph extends CommonBase {
                Reference.reachabilityFence(this);
                if (ret >= 0 && ret <= 4096) { return null; }
                org.ldk.structs.ReadOnlyNetworkGraph ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.ReadOnlyNetworkGraph(null, ret); }
-               ret_hu_conv.ptrs_to.add(this);
+               if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
                return ret_hu_conv;
        }
 
@@ -90,7 +99,7 @@ public class NetworkGraph extends CommonBase {
                Reference.reachabilityFence(this);
                if (ret >= 0 && ret <= 4096) { return null; }
                org.ldk.structs.Option_u32Z ret_hu_conv = org.ldk.structs.Option_u32Z.constr_from_ptr(ret);
-               ret_hu_conv.ptrs_to.add(this);
+               if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
                return ret_hu_conv;
        }
 
@@ -112,13 +121,13 @@ public class NetworkGraph extends CommonBase {
         * 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.
         */
-       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);
+       public Result_NoneLightningErrorZ update_node_from_announcement(org.ldk.structs.NodeAnnouncement msg) {
+               long ret = bindings.NetworkGraph_update_node_from_announcement(this.ptr, msg == null ? 0 : msg.ptr);
                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);
+               if (this != null) { this.ptrs_to.add(msg); };
                return ret_hu_conv;
        }
 
@@ -128,35 +137,54 @@ public class NetworkGraph extends CommonBase {
         * given the associated signatures here we cannot relay the node announcement to any of our
         * peers.
         */
-       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);
+       public Result_NoneLightningErrorZ update_node_from_unsigned_announcement(org.ldk.structs.UnsignedNodeAnnouncement msg) {
+               long ret = bindings.NetworkGraph_update_node_from_unsigned_announcement(this.ptr, msg == null ? 0 : msg.ptr);
                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);
+               if (this != null) { this.ptrs_to.add(msg); };
                return ret_hu_conv;
        }
 
        /**
         * Store or update channel info from a channel announcement.
         * 
-        * You probably don't want to call this directly, instead relying on a P2PGossipSync's
-        * RoutingMessageHandler implementation to call it indirectly. This may be useful to accept
+        * You probably don't want to call this directly, instead relying on a [`P2PGossipSync`]'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 a `chain::Access` object is provided via `chain_access`, it will be called to verify
+        * If a [`UtxoLookup`] object is provided via `utxo_lookup`, 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, Option_AccessZ chain_access) {
-               long ret = bindings.NetworkGraph_update_channel_from_announcement(this.ptr, msg == null ? 0 : msg.ptr & ~1, chain_access.ptr);
+       public Result_NoneLightningErrorZ update_channel_from_announcement(org.ldk.structs.ChannelAnnouncement msg, org.ldk.structs.Option_UtxoLookupZ utxo_lookup) {
+               long ret = bindings.NetworkGraph_update_channel_from_announcement(this.ptr, msg == null ? 0 : msg.ptr, utxo_lookup.ptr);
+               Reference.reachabilityFence(this);
+               Reference.reachabilityFence(msg);
+               Reference.reachabilityFence(utxo_lookup);
+               if (ret >= 0 && ret <= 4096) { return null; }
+               Result_NoneLightningErrorZ ret_hu_conv = Result_NoneLightningErrorZ.constr_from_ptr(ret);
+               if (this != null) { this.ptrs_to.add(msg); };
+               if (this != null) { this.ptrs_to.add(utxo_lookup); };
+               return ret_hu_conv;
+       }
+
+       /**
+        * Store or update channel info from a channel announcement.
+        * 
+        * You probably don't want to call this directly, instead relying on a [`P2PGossipSync`]'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.
+        * 
+        * This will skip verification of if the channel is actually on-chain.
+        */
+       public Result_NoneLightningErrorZ update_channel_from_announcement_no_lookup(org.ldk.structs.ChannelAnnouncement msg) {
+               long ret = bindings.NetworkGraph_update_channel_from_announcement_no_lookup(this.ptr, msg == null ? 0 : msg.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);
+               if (this != null) { this.ptrs_to.add(msg); };
                return ret_hu_conv;
        }
 
@@ -165,18 +193,18 @@ public class NetworkGraph extends CommonBase {
         * signatures. Because we aren't given the associated signatures here we cannot relay the
         * channel announcement to any of our peers.
         * 
-        * If a `chain::Access` object is provided via `chain_access`, it will be called to verify
+        * If a [`UtxoLookup`] object is provided via `utxo_lookup`, 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, Option_AccessZ chain_access) {
-               long ret = bindings.NetworkGraph_update_channel_from_unsigned_announcement(this.ptr, msg == null ? 0 : msg.ptr & ~1, chain_access.ptr);
+       public Result_NoneLightningErrorZ update_channel_from_unsigned_announcement(org.ldk.structs.UnsignedChannelAnnouncement msg, org.ldk.structs.Option_UtxoLookupZ utxo_lookup) {
+               long ret = bindings.NetworkGraph_update_channel_from_unsigned_announcement(this.ptr, msg == null ? 0 : msg.ptr, utxo_lookup.ptr);
                Reference.reachabilityFence(this);
                Reference.reachabilityFence(msg);
-               Reference.reachabilityFence(chain_access);
+               Reference.reachabilityFence(utxo_lookup);
                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);
+               if (this != null) { this.ptrs_to.add(msg); };
+               if (this != null) { this.ptrs_to.add(utxo_lookup); };
                return ret_hu_conv;
        }
 
@@ -188,8 +216,8 @@ public class NetworkGraph extends CommonBase {
         * 
         * All other parameters as used in [`msgs::UnsignedChannelAnnouncement`] fields.
         */
-       public Result_NoneLightningErrorZ add_channel_from_partial_announcement(long short_channel_id, long timestamp, ChannelFeatures features, byte[] node_id_1, byte[] node_id_2) {
-               long ret = bindings.NetworkGraph_add_channel_from_partial_announcement(this.ptr, short_channel_id, timestamp, features == null ? 0 : features.ptr & ~1, InternalUtils.check_arr_len(node_id_1, 33), InternalUtils.check_arr_len(node_id_2, 33));
+       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) {
+               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));
                Reference.reachabilityFence(this);
                Reference.reachabilityFence(short_channel_id);
                Reference.reachabilityFence(timestamp);
@@ -198,30 +226,29 @@ public class NetworkGraph extends CommonBase {
                Reference.reachabilityFence(node_id_2);
                if (ret >= 0 && ret <= 4096) { return null; }
                Result_NoneLightningErrorZ ret_hu_conv = Result_NoneLightningErrorZ.constr_from_ptr(ret);
+               if (this != null) { this.ptrs_to.add(features); };
                return ret_hu_conv;
        }
 
        /**
-        * Marks a channel in the graph as failed if a corresponding HTLC fail was sent.
-        * If permanent, removes a channel from the local storage.
-        * May cause the removal of nodes too, if this was their last channel.
-        * If not permanent, makes channels unavailable for routing.
+        * Marks a channel in the graph as failed permanently.
+        * 
+        * The channel and any node for which this was their last channel are removed from the graph.
         */
-       public void channel_failed(long short_channel_id, boolean is_permanent) {
-               bindings.NetworkGraph_channel_failed(this.ptr, short_channel_id, is_permanent);
+       public void channel_failed_permanent(long short_channel_id) {
+               bindings.NetworkGraph_channel_failed_permanent(this.ptr, short_channel_id);
                Reference.reachabilityFence(this);
                Reference.reachabilityFence(short_channel_id);
-               Reference.reachabilityFence(is_permanent);
        }
 
        /**
-        * Marks a node in the graph as failed.
+        * Marks a node in the graph as permanently failed, effectively removing it and its channels
+        * from local storage.
         */
-       public void node_failed(byte[] _node_id, boolean is_permanent) {
-               bindings.NetworkGraph_node_failed(this.ptr, InternalUtils.check_arr_len(_node_id, 33), is_permanent);
+       public void node_failed_permanent(byte[] node_id) {
+               bindings.NetworkGraph_node_failed_permanent(this.ptr, InternalUtils.check_arr_len(node_id, 33));
                Reference.reachabilityFence(this);
-               Reference.reachabilityFence(_node_id);
-               Reference.reachabilityFence(is_permanent);
+               Reference.reachabilityFence(node_id);
        }
 
        /**
@@ -236,11 +263,14 @@ public class NetworkGraph extends CommonBase {
         * Note that for users of the `lightning-background-processor` crate this method may be
         * automatically called regularly for you.
         * 
+        * This method will also cause us to stop tracking removed nodes and channels if they have been
+        * in the map for a while so that these can be resynced from gossip in the future.
+        * 
         * This method is only available with the `std` feature. See
-        * [`NetworkGraph::remove_stale_channels_with_time`] for `no-std` use.
+        * [`NetworkGraph::remove_stale_channels_and_tracking_with_time`] for `no-std` use.
         */
-       public void remove_stale_channels() {
-               bindings.NetworkGraph_remove_stale_channels(this.ptr);
+       public void remove_stale_channels_and_tracking() {
+               bindings.NetworkGraph_remove_stale_channels_and_tracking(this.ptr);
                Reference.reachabilityFence(this);
        }
 
@@ -253,11 +283,14 @@ public class NetworkGraph extends CommonBase {
         * 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 method will also cause us to stop tracking removed nodes and channels if they have been
+        * in the map for a while so that these can be resynced from gossip in the future.
+        * 
         * This function takes the current unix time as an argument. For users with the `std` feature
-        * enabled, [`NetworkGraph::remove_stale_channels`] may be preferable.
+        * enabled, [`NetworkGraph::remove_stale_channels_and_tracking`] 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);
+       public void remove_stale_channels_and_tracking_with_time(long current_time_unix) {
+               bindings.NetworkGraph_remove_stale_channels_and_tracking_with_time(this.ptr, current_time_unix);
                Reference.reachabilityFence(this);
                Reference.reachabilityFence(current_time_unix);
        }
@@ -266,20 +299,20 @@ public class NetworkGraph extends CommonBase {
         * For an already known (from announcement) channel, update info about one of the directions
         * of the channel.
         * 
-        * You probably don't want to call this directly, instead relying on a P2PGossipSync's
-        * RoutingMessageHandler implementation to call it indirectly. This may be useful to accept
+        * You probably don't want to call this directly, instead relying on a [`P2PGossipSync`]'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);
+       public Result_NoneLightningErrorZ update_channel(org.ldk.structs.ChannelUpdate msg) {
+               long ret = bindings.NetworkGraph_update_channel(this.ptr, msg == null ? 0 : msg.ptr);
                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);
+               if (this != null) { this.ptrs_to.add(msg); };
                return ret_hu_conv;
        }
 
@@ -291,13 +324,31 @@ public class NetworkGraph extends CommonBase {
         * 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);
+       public Result_NoneLightningErrorZ update_channel_unsigned(org.ldk.structs.UnsignedChannelUpdate msg) {
+               long ret = bindings.NetworkGraph_update_channel_unsigned(this.ptr, msg == null ? 0 : msg.ptr);
+               Reference.reachabilityFence(this);
+               Reference.reachabilityFence(msg);
+               if (ret >= 0 && ret <= 4096) { return null; }
+               Result_NoneLightningErrorZ ret_hu_conv = Result_NoneLightningErrorZ.constr_from_ptr(ret);
+               if (this != null) { this.ptrs_to.add(msg); };
+               return ret_hu_conv;
+       }
+
+       /**
+        * For an already known (from announcement) channel, verify the given [`ChannelUpdate`].
+        * 
+        * This checks whether the update currently is applicable by [`Self::update_channel`].
+        * 
+        * 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 verify_channel_update(org.ldk.structs.ChannelUpdate msg) {
+               long ret = bindings.NetworkGraph_verify_channel_update(this.ptr, msg == null ? 0 : msg.ptr);
                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);
+               if (this != null) { this.ptrs_to.add(msg); };
                return ret_hu_conv;
        }