lightning

Documentation

Overview

Lightning Network primitives.

Index

• type Channel
  • func (c Channel) Liquidity() float64
• type ChannelID
• type Channels
• type Edge
• type FeePPM
  • func (f FeePPM) Rate() float64
• type Forward
• type Graph
• type Info
• type Invoice
• type LndClient
  • func NewLndClient(s *lndclient.GrpcLndServices, network string) LndClient
  • func (l LndClient) AddInvoice(ctx context.Context, amount Satoshi) (Invoice, error)
  • func (l LndClient) DescribeGraph(ctx context.Context) (*Graph, error)
  • func (l LndClient) ForwardingHistory(ctx context.Context, since time.Time) ([]Forward, error)
  • func (l LndClient) GetChannel(ctx context.Context, channelID ChannelID) (Channel, error)
  • func (l LndClient) GetInfo(ctx context.Context) (*Info, error)
  • func (l LndClient) ListChannels(ctx context.Context) (Channels, error)
  • func (l LndClient) SendPayment(ctx context.Context, invoice Invoice, outChannelID ChannelID, ...) (Satoshi, error)
  • func (l LndClient) SetFees(ctx context.Context, channelID ChannelID, fee FeePPM, maxHTLC MilliSatoshi) error
  • func (l LndClient) SubscribeChannelUpdates(ctx context.Context) (<-chan Channels, <-chan error, error)
• type MilliSatoshi
• type Node
  • func (n Node) Clearnet() bool
• type PubKey
• type Satoshi
  • func (s Satoshi) BTC() float64
  • func (s Satoshi) Millis() MilliSatoshi

Types

type Channel

type Channel struct {
	Edge
	ChannelID     ChannelID
	LocalBalance  Satoshi
	LocalFee      FeePPM
	RemoteBalance Satoshi
	RemoteNode    Node
	Private       bool
}

Channel between local and remote node.

func (Channel) Liquidity

func (c Channel) Liquidity() float64

Liquidity percent of the channel that is local.

type ChannelID

type ChannelID uint64

ChannelID for channel.

type Channels

type Channels []Channel

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 LndClient

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

LndClient client backed by LND node.

func NewLndClient

func NewLndClient(s *lndclient.GrpcLndServices, network string) LndClient

NewLndClient backed by a single LND lightning node.

func (LndClient) AddInvoice

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

AddInvoice of amount.

func (LndClient) DescribeGraph

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

DescribeGraph of the Lightning Network.

func (LndClient) ForwardingHistory

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

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

func (LndClient) GetChannel

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

GetChannel with ID.

func (LndClient) GetInfo

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

GetInfo of local node.

func (LndClient) ListChannels

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

ListChannels of local node.

func (LndClient) SendPayment

func (l LndClient) SendPayment(ctx context.Context, invoice Invoice, outChannelID ChannelID, lastHopPubKey PubKey, maxFee FeePPM) (Satoshi, error)

SendPayment to pay for invoice.

func (LndClient) SetFees

func (l LndClient) SetFees(ctx context.Context, channelID ChannelID, fee FeePPM, maxHTLC MilliSatoshi) error

SetFees for channel with rate in ppm.

func (LndClient) SubscribeChannelUpdates

func (l LndClient) SubscribeChannelUpdates(ctx context.Context) (<-chan Channels, <-chan error, error)

SubscribeChannelUpdates signals when a channel's liquidity changes.

type MilliSatoshi

type MilliSatoshi int64

MilliSatoshi unit of bitcoin.

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.

func (Satoshi) Millis

func (s Satoshi) Millis() MilliSatoshi

BTC value of Satoshi.