Struct lightning::routing::network_graph::NetworkGraph

pub struct NetworkGraph { /* fields omitted */ }

Represents the network as nodes and channels between them

Implementations

impl NetworkGraph

pub fn get_channels<'a>(&'a self) -> &'a BTreeMap<u64, ChannelInfo>

Returns all known valid channels’ short ids along with announced channel info.

(C-not exported) because we have no mapping for BTreeMaps

pub fn get_nodes<'a>(&'a self) -> &'a BTreeMap<PublicKey, NodeInfo>

Returns all known nodes’ public keys along with announced node info.

(C-not exported) because we have no mapping for BTreeMaps

pub fn get_addresses<'a>(
    &'a self,
    pubkey: &PublicKey
) -> Option<&'a Vec<NetAddress>>

Get network addresses by node id. Returns None if the requested node is completely unknown, or if node announcement for the node was never received.

(C-not exported) as there is no practical way to track lifetimes of returned values.

pub fn new(genesis_hash: BlockHash) -> NetworkGraph

Creates a new, empty, network graph.

pub fn update_node_from_announcement<T: Verification>(
    &mut self,
    msg: &NodeAnnouncement,
    secp_ctx: &Secp256k1<T>
) -> Result<(), LightningError>

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 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.

pub fn update_node_from_unsigned_announcement(
    &mut self,
    msg: &UnsignedNodeAnnouncement
) -> Result<(), LightningError>

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.

pub fn update_channel_from_announcement<T: Verification, C: Deref>(
    &mut self,
    msg: &ChannelAnnouncement,
    chain_access: &Option<C>,
    secp_ctx: &Secp256k1<T>
) -> Result<(), LightningError> where
    C::Target: Access, 

Store or update channel info from a channel announcement.

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 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.

pub fn update_channel_from_unsigned_announcement<C: Deref>(
    &mut self,
    msg: &UnsignedChannelAnnouncement,
    chain_access: &Option<C>
) -> Result<(), LightningError> where
    C::Target: Access, 

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 chain::Access object is provided via chain_access, it will be called to verify the corresponding UTXO exists on chain and is correctly-formatted.

pub fn close_channel_from_update(
    &mut self,
    short_channel_id: u64,
    is_permanent: bool
)

Close a channel 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.

pub fn update_channel<T: Verification>(
    &mut self,
    msg: &ChannelUpdate,
    secp_ctx: &Secp256k1<T>
) -> Result<(), LightningError>

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 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.

pub fn update_channel_unsigned(
    &mut self,
    msg: &UnsignedChannelUpdate
) -> Result<(), LightningError>

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.

Trait Implementations

impl Clone for NetworkGraph

fn clone(&self) -> NetworkGraph

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Display for NetworkGraph

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl PartialEq<NetworkGraph> for NetworkGraph

fn eq(&self, other: &NetworkGraph) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &NetworkGraph) -> bool

This method tests for !=.

impl Readable for NetworkGraph

fn read<R: Read>(reader: &mut R) -> Result<NetworkGraph, DecodeError>

Reads a Self in from the given Read

impl Writeable for NetworkGraph

fn write<W: Writer>(&self, writer: &mut W) -> Result<(), Error>

Writes self out to the given Writer

fn encode(&self) -> Vec<u8>

Writes self out to a Vec

fn encode_with_len(&self) -> Vec<u8>

Writes self out to a Vec

fn serialized_length(&self) -> usize

Gets the length of this object after it has been serialized. This can be overridden to optimize cases where we prepend an object with its length.

impl StructuralPartialEq for NetworkGraph