org.ldk.structs.NetworkGraph Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ldk-java Show documentation
Show all versions of ldk-java Show documentation
LDK Java Bindings and Release Binaries
package org.ldk.structs;
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;
/**
* Represents the network as nodes and channels between them
*/
@SuppressWarnings("unchecked") // We correctly assign various generic arrays
public class NetworkGraph extends CommonBase {
NetworkGraph(Object _dummy, long ptr) { super(ptr); }
@Override @SuppressWarnings("deprecation")
protected void finalize() throws Throwable {
super.finalize();
if (ptr != 0) { bindings.NetworkGraph_free(ptr); }
}
/**
* 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 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);
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;
}
/**
* Serialize the NetworkGraph object into a byte array which can be read by NetworkGraph_read
*/
public byte[] write() {
byte[] ret = bindings.NetworkGraph_write(this.ptr);
Reference.reachabilityFence(this);
return ret;
}
/**
* Read a NetworkGraph from a byte array, created by NetworkGraph_write
*/
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);
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(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); }
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;
}
/**
* 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; }
org.ldk.structs.ReadOnlyNetworkGraph ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.ReadOnlyNetworkGraph(null, ret); }
if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
return ret_hu_conv;
}
/**
* The unix timestamp provided by the most recent rapid gossip sync.
* It will be set by the rapid sync process after every sync completion.
*/
public Option_u32Z get_last_rapid_gossip_sync_timestamp() {
long ret = bindings.NetworkGraph_get_last_rapid_gossip_sync_timestamp(this.ptr);
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);
if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
return ret_hu_conv;
}
/**
* Update the unix timestamp provided by the most recent rapid gossip sync.
* This should be done automatically by the rapid sync process after every sync completion.
*/
public void set_last_rapid_gossip_sync_timestamp(int last_rapid_gossip_sync_timestamp) {
bindings.NetworkGraph_set_last_rapid_gossip_sync_timestamp(this.ptr, last_rapid_gossip_sync_timestamp);
Reference.reachabilityFence(this);
Reference.reachabilityFence(last_rapid_gossip_sync_timestamp);
}
/**
* For an already known node (from channel announcements), update its stored properties from a
* given node 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.
*/
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);
if (this != null) { this.ptrs_to.add(msg); };
return ret_hu_conv;
}
/**
* For an already known node (from channel announcements), update its stored properties from a
* given node announcement without verifying the associated signatures. Because we aren't
* given the associated signatures here we cannot relay the node announcement to any of our
* peers.
*/
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);
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
* routing messages from a source using a protocol other than the lightning P2P protocol.
*
* 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(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);
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;
}
/**
* Store or update channel info from a channel announcement without verifying the associated
* signatures. Because we aren't given the associated signatures here we cannot relay the
* channel announcement to any of our peers.
*
* 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(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(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;
}
/**
* Update channel from partial announcement data received via rapid gossip sync
*
* `timestamp: u64`: Timestamp emulating the backdated original announcement receipt (by the
* rapid gossip sync server)
*
* All other parameters as used in [`msgs::UnsignedChannelAnnouncement`] fields.
*/
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);
Reference.reachabilityFence(features);
Reference.reachabilityFence(node_id_1);
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 permanently.
*
* The channel and any node for which this was their last channel are removed from the graph.
*/
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);
}
/**
* Marks a node in the graph as permanently failed, effectively removing it and its channels
* from local storage.
*/
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);
}
/**
* 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.
*
* 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_and_tracking_with_time`] for `no-std` use.
*/
public void remove_stale_channels_and_tracking() {
bindings.NetworkGraph_remove_stale_channels_and_tracking(this.ptr);
Reference.reachabilityFence(this);
}
/**
* 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 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_and_tracking`] may be preferable.
*/
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);
}
/**
* 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
* 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(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);
if (this != null) { this.ptrs_to.add(msg); };
return ret_hu_conv;
}
/**
* 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(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);
if (this != null) { this.ptrs_to.add(msg); };
return ret_hu_conv;
}
}