lightning

Documentation

Overview

Package lightning connects to the lightning network daemon and exposes an interface with the methods available to use.

Index

• type Client
  • func NewClient(config config.Config) (Client, error)

Types

type Client

type Client interface {
	ChannelAcceptor(ctx context.Context, opts ...grpc.CallOption) (lnrpc.Lightning_ChannelAcceptorClient, error)
	GetInfo(ctx context.Context, in *lnrpc.GetInfoRequest, opts ...grpc.CallOption) (*lnrpc.GetInfoResponse, error)
	GetNodeInfo(ctx context.Context, in *lnrpc.NodeInfoRequest, opts ...grpc.CallOption) (*lnrpc.NodeInfo, error)
}

Client represents a lightning node client.

func NewClient

func NewClient(config config.Config) (Client, error)

NewClient returns a new lightning client.