lightning

Documentation

Overview

Wrap lightning network node implementations.

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 Lightning
  • func New(c channeler, i invoicer, r router) Lightning
  • func (l Lightning) AddInvoice(ctx context.Context, amount Satoshi) (Invoice, error)
  • func (l Lightning) DescribeGraph(ctx context.Context) (*Graph, error)
  • func (l Lightning) ForwardingHistory(ctx context.Context, since time.Time) ([]Forward, error)
  • func (l Lightning) GetChannel(ctx context.Context, channelID ChannelID) (Channel, error)
  • func (l Lightning) GetInfo(ctx context.Context) (*Info, error)
  • func (l Lightning) ListChannels(ctx context.Context) (Channels, error)
  • func (l Lightning) SendPayment(ctx context.Context, invoice Invoice, outChannelID ChannelID, ...) (Satoshi, error)
  • func (l Lightning) SetFees(ctx context.Context, channelID ChannelID, fee FeePPM) error
• type Node
  • func (n Node) Clearnet() bool
• 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    string
	Node2    string
}

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 string
}

Info of a node.

type Invoice

type Invoice string

Invoice for lightning payment.

type Lightning

type Lightning struct {
	// contains filtered or unexported fields
}

Lightning client backed by LND node.

func New

func New(c channeler, i invoicer, r router) Lightning

New Lightning instance.

func (Lightning) AddInvoice

func (l Lightning) AddInvoice(ctx context.Context, amount Satoshi) (Invoice, error)

AddInvoice of amount.

func (Lightning) DescribeGraph

func (l Lightning) DescribeGraph(ctx context.Context) (*Graph, error)

DescribeGraph of the Lightning Network.

func (Lightning) ForwardingHistory

func (l Lightning) ForwardingHistory(ctx context.Context, since time.Time) ([]Forward, error)

ForwardingHistory of node since the time give, capped at 50,000 events.

func (Lightning) GetChannel

func (l Lightning) GetChannel(ctx context.Context, channelID ChannelID) (Channel, error)

GetChannel with ID.

func (Lightning) GetInfo

func (l Lightning) GetInfo(ctx context.Context) (*Info, error)

GetInfo of local node.

func (Lightning) ListChannels

func (l Lightning) ListChannels(ctx context.Context) (Channels, error)

ListChannels of local node.

func (Lightning) SendPayment

func (l Lightning) SendPayment(ctx context.Context, invoice Invoice, outChannelID ChannelID, lastHopPubkey string, maxFee Satoshi) (Satoshi, error)

SendPayment to pay for invoice.

func (Lightning) SetFees

func (l Lightning) SetFees(ctx context.Context, channelID ChannelID, fee FeePPM) error

SetFees for channel with rate in ppm.

type Node

type Node struct {
	PubKey    string
	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 Satoshi

type Satoshi int64

Satoshi unit of bitcoin.

func (Satoshi) BTC

func (s Satoshi) BTC() float64

BTC value of Satoshi.