Struct ChannelGraph

Source
pub struct ChannelGraph { /* private fields */ }
Expand description

Implements a HOPR payment channel graph (directed) cached in-memory.

This structure is useful for tracking channel state changes and packet path finding.

The edges are updated only from the Indexer, and therefore the graph contains only the channels seen on-chain. The nodes and their qualities are updated as they are observed on the network.

Using this structure is much faster than querying the DB and therefore is preferred for per-packet path-finding computations. Per default, the graph does not track channels in the Closed state and therefore cannot detect channel re-openings.

When a node reaches zero quality and there are no edges (channels) containing this node, it is removed from the graph entirely.

Implementations§

Source§

impl ChannelGraph

Source

pub const INTERMEDIATE_HOPS: usize = 3usize

The maximum number of intermediate hops the automatic path-finding algorithm will look for.

Source

pub fn new(me: Address, cfg: ChannelGraphConfig) -> Self

Creates a new instance with the given self Address.

Source

pub fn count_channels(&self) -> usize

Number of channels (edges) in the graph.

Source

pub fn count_nodes(&self) -> usize

Number of nodes in the graph.

Source

pub fn is_own_channel(&self, channel: &ChannelEntry) -> bool

Checks if the channel is incoming to or outgoing from this node

Source

pub fn my_address(&self) -> Address

Convenience method to get this node’s own address

Source

pub fn get_channel( &self, source: &Address, destination: &Address, ) -> Option<&ChannelEntry>

Looks up an Open or PendingToClose channel given the source and destination. Returns None if no such edge exists in the graph.

Source

pub fn get_node(&self, node: &Address) -> Option<&Node>

Gets the node information. Returns None if no such node exists in the graph.

Source

pub fn open_channels_from( &self, source: Address, ) -> impl Iterator<Item = (&Node, &ChannelEdge)>

Gets all Open outgoing channels going from the given source.

Source

pub fn has_path(&self, source: &Address, destination: &Address) -> bool

Checks whether there is any path via Open channels that connects source and destination This does not need to be necessarily a multi-hop path.

Source

pub fn update_channel( &mut self, channel: ChannelEntry, ) -> Option<Vec<ChannelChange>>

Inserts or updates the given channel in the channel graph. Returns a set of changes if the channel was already present in the graphs or None if the channel was not previously present in the channel graph.

Source

pub fn update_node_score( &mut self, address: &Address, score_update: NodeScoreUpdate, )

Updates the quality of a node (inserting it into the graph if it does not exist yet), based on the given NodeScoreUpdate.

Source

pub fn update_channel_score( &mut self, source: &Address, destination: &Address, score: f64, )

Updates the score value of network connection between source and destination The given score value must always be non-negative.

Source

pub fn get_channel_score( &self, source: &Address, destination: &Address, ) -> Option<f64>

Gets quality of the given channel. Returns None if no such channel exists, or no quality has been set for that channel.

Source

pub fn contains_channel(&self, channel: &ChannelEntry) -> bool

Checks whether the given channel is in the graph already.

Source

pub fn contains_node(&self, address: &Address) -> bool

Checks whether the given node is in the channel graph.

Source

pub fn as_dot(&self, cfg: GraphExportConfig) -> String

Outputs the channel graph in the DOT (graphviz) format with the given config.

Trait Implementations§

Source§

impl Clone for ChannelGraph

Source§

fn clone(&self) -> ChannelGraph

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ChannelGraph

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for ChannelGraph

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for ChannelGraph

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
§

impl<'de, T> BorrowedRpcObject<'de> for T
where T: RpcBorrow<'de> + RpcSend,

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

§

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<'de, T> RpcBorrow<'de> for T
where T: Deserialize<'de> + Debug + Send + Sync + Unpin,

§

impl<T> RpcObject for T
where T: RpcSend + RpcRecv,

§

impl<T> RpcRecv for T
where T: DeserializeOwned + Debug + Send + Sync + Unpin + 'static,

§

impl<T> RpcSend for T
where T: Serialize + Clone + Debug + Send + Sync + Unpin,