DirectedLNGraph (DotNetLightning)

DirectedLNGraph Type

Namespace: DotNetLightning.Routing
Assembly: DotNetLightning.Core.dll
Parent Module: Graph
Base Type: obj
All Interfaces: IEquatable<DirectedLNGraph> , IStructuralEquatable , IComparable<DirectedLNGraph> , IComparable , IStructuralComparable

Instance members

Instance member	Description
`this.AddEdge` Full Usage: `this.AddEdge` Parameters: desc : `ChannelDesc` update : `UnsignedChannelUpdateMsg` Returns: `DirectedLNGraph`	desc : `ChannelDesc` update : `UnsignedChannelUpdateMsg` Returns: `DirectedLNGraph`
`this.AddEdge` Full Usage: `this.AddEdge` Parameters: e : `GraphLabel` Returns: `DirectedLNGraph`	e : `GraphLabel` Returns: `DirectedLNGraph`
`this.AddEdges` Full Usage: `this.AddEdges` Parameters: edges : `seq<GraphLabel>` Returns: `DirectedLNGraph`	edges : `seq<GraphLabel>` Returns: `DirectedLNGraph`
`this.AddEdges` Full Usage: `this.AddEdges` Parameters: edges : `seq<ChannelDesc * UnsignedChannelUpdateMsg>` Returns: `DirectedLNGraph`	edges : `seq<ChannelDesc * UnsignedChannelUpdateMsg>` Returns: `DirectedLNGraph`
`this.AddVertex` Full Usage: `this.AddVertex` Parameters: key : `NodeId` Returns: `DirectedLNGraph`	key : `NodeId` Returns: `DirectedLNGraph`
`this.ContainsEdge` Full Usage: `this.ContainsEdge` Parameters: arg0 : `ChannelDesc` Returns: `bool`	arg0 : `ChannelDesc` Returns: `bool`
`this.ContainsVertex` Full Usage: `this.ContainsVertex` Parameters: v : `NodeId` Returns: `bool`	v : `NodeId` Returns: `bool`
`this.EdgeSet` Full Usage: `this.EdgeSet` Returns: `GraphLabel list`	Returns: `GraphLabel list`
`this.GetEdgesBetween` Full Usage: `this.GetEdgesBetween` Parameters: keyA : `NodeId` keyB : `NodeId` Returns: `GraphLabel list`	keyA : `NodeId` keyB : `NodeId` Returns: `GraphLabel list`
`this.IncomingEdgesOf` Full Usage: `this.IncomingEdgesOf` Parameters: v : `NodeId` Returns: `GraphLabel list`	v : `NodeId` Returns: `GraphLabel list`
`this.OutgoingEdgesOf` Full Usage: `this.OutgoingEdgesOf` Parameters: v : `NodeId` Returns: `GraphLabel list`	v : `NodeId` Returns: `GraphLabel list`
`this.PrettyPrint` Full Usage: `this.PrettyPrint` Returns: `string`	Returns: `string`
`this.RemoveEdge` Full Usage: `this.RemoveEdge` Parameters: desc : `ChannelDesc` Returns: `DirectedLNGraph`	desc : `ChannelDesc` Returns: `DirectedLNGraph`
`this.RemoveEdges` Full Usage: `this.RemoveEdges` Parameters: descriptions : `'a` Returns: `DirectedLNGraph`	descriptions : `'a` Returns: `DirectedLNGraph`
`this.RemoveVertex` Full Usage: `this.RemoveVertex` Parameters: key : `NodeId` Returns: `DirectedLNGraph`	key : `NodeId` Returns: `DirectedLNGraph`
`this.TryGetEdge` Full Usage: `this.TryGetEdge` Parameters: arg0 : `GraphLabel` Returns: `GraphLabel option`	arg0 : `GraphLabel` Returns: `GraphLabel option`
`this.TryGetEdge` Full Usage: `this.TryGetEdge` Parameters: desc : `ChannelDesc` Returns: `GraphLabel option`	desc : `ChannelDesc` Returns: `GraphLabel option`
`this.Value` Full Usage: `this.Value` Returns: `Map<NodeId, GraphLabel list>`	Returns: `Map<NodeId, GraphLabel list>`
`this.VertexSet` Full Usage: `this.VertexSet` Returns: `NodeId list`	Returns: `NodeId list`

Static members

Static member Description

Static member	Description
`DirectedLNGraph.Create()` Full Usage: `DirectedLNGraph.Create()` Returns: `DirectedLNGraph`	Returns: `DirectedLNGraph`
`DirectedLNGraph.MakeGraph(channels)` Full Usage: `DirectedLNGraph.MakeGraph(channels)` Parameters: channels : `Map<ShortChannelId, PublicChannel>` Returns: `DirectedLNGraph`	This is the recommended way of creating the network graph. We don't include private channels: they would bloat the graph without providing any value(if they are private they probably don't want to be involved in routing other people's payments). The only private channels we know are ours: we should check them to see if our destination can be reached in a single hop via private channel before using the public network graph channels : `Map<ShortChannelId, PublicChannel>` Returns: `DirectedLNGraph`


                
                  
                    
                      DirectedLNGraph.Create()

Full Usage: DirectedLNGraph.Create()

Returns: DirectedLNGraph

Returns: DirectedLNGraph


                
                  
                    
                      DirectedLNGraph.MakeGraph(channels)

Full Usage: DirectedLNGraph.MakeGraph(channels)

Parameters:

channels : Map<ShortChannelId, PublicChannel>

Returns: DirectedLNGraph

This is the recommended way of creating the network graph. We don't include private channels: they would bloat the graph without providing any value(if they are private they probably don't want to be involved in routing other people's payments). The only private channels we know are ours: we should check them to see if our destination can be reached in a single hop via private channel before using the public network graph

channels : Map<ShortChannelId, PublicChannel>

Returns: DirectedLNGraph