lightning

Documentation

Overview

Lightning Network primitives.

Index

• type Channel
  • func (c Channel) Liquidity() float64
  • func (c Channel) LiquidityLevel() ChannelLiquidityLevel
• type ChannelID
• type ChannelLiquidityLevel
• type Channels
  • func (cs Channels) HighLiquidity() Channels
  • func (cs Channels) LowLiquidity() Channels
• type Edge
• type FeePPM
  • func (f FeePPM) Rate() float64
• type Forward
• type Graph
• type Info
• type Invoice
• type Node
  • func (n Node) Clearnet() bool
• type PubKey
• type Satoshi
  • func (s Satoshi) BTC() float64

Types

type Channel

type Channel struct {
	Edge
	ChannelID     ChannelID
	LocalBalance  Satoshi
	RemoteBalance Satoshi
	RemoteNode    Node
}

Channel between local and remote node.

func (Channel) Liquidity

func (c Channel) Liquidity() float64

Liquidity of the channel.

func (Channel) LiquidityLevel

func (c Channel) LiquidityLevel() ChannelLiquidityLevel

LiquidityLevel of the channel.

type ChannelID

type ChannelID uint64

ChannelID for channel.

type ChannelLiquidityLevel

type ChannelLiquidityLevel string

ChannelLiquidityLevel coarse-grained bucket based on current liquidity.

const (
	LowLiquidity      ChannelLiquidityLevel = "low"
	StandardLiquidity ChannelLiquidityLevel = "standard"
	HighLiquidity     ChannelLiquidityLevel = "high"
)

ChannelLiquidityLevels

type Channels

type Channels []Channel

Channels of node.

func (Channels) HighLiquidity

func (cs Channels) HighLiquidity() Channels

HighLiquidity channels of node.

func (Channels) LowLiquidity

func (cs Channels) LowLiquidity() Channels

LowLiquidity channels of node.

type Edge

type Edge struct {
	Capacity Satoshi
	Node1    PubKey
	Node2    PubKey
}

Edge between nodes in the Lightning Network.

type FeePPM

type FeePPM float64

FeePPM is the channel fee in part per million.

func (FeePPM) Rate

func (f FeePPM) Rate() float64

Rate of fee.

type Forward

type Forward struct {
	Timestamp  time.Time
	ChannelIn  ChannelID
	ChannelOut ChannelID
}

Forward routing event.

type Graph

type Graph struct {
	Nodes []Node
	Edges []Edge
}

Graph of nodes and edges of the Lightning Network.

type Info

type Info struct {
	PubKey PubKey
}

Info of a node.

type Invoice

type Invoice string

Invoice for lightning payment.

type Node

type Node struct {
	PubKey    PubKey
	Alias     string
	Updated   time.Time
	Addresses []string
}

Node in the Lightning Network.

func (Node) Clearnet

func (n Node) Clearnet() bool

Clearnet is true if node has a clearnet address.

type PubKey

type PubKey string

PubKey of node.

type Satoshi

type Satoshi int64

Satoshi unit of bitcoin.

func (Satoshi) BTC

func (s Satoshi) BTC() float64

BTC value of Satoshi.