lnd

Documentation

Index

• type LND
  • func (lnd *LND) AddHoldInvoice(preimageHash []byte, value int64, expiry int64, memo string) (*invoicesrpc.AddHoldInvoiceResp, error)
  • func (lnd *LND) AddInvoice(value int64, preimage []byte, expiry int64, memo string) (*lnrpc.AddInvoiceResponse, error)
  • func (lnd *LND) CancelInvoice(preimageHash []byte) (*invoicesrpc.CancelInvoiceResp, error)
  • func (lnd *LND) Connect() error
  • func (lnd *LND) ConnectPeer(pubKey string, host string) (*lnrpc.ConnectPeerResponse, error)
  • func (lnd *LND) EstimateFee(confTarget int32) (*walletrpc.EstimateFeeResponse, error)
  • func (lnd *LND) GetChannelInfo(channelId uint64) (*lnrpc.ChannelEdge, error)
  • func (lnd *LND) GetInfo() (*lnrpc.GetInfoResponse, error)
  • func (lnd *LND) ListChannels() (*lnrpc.ListChannelsResponse, error)
  • func (lnd *LND) LookupInvoice(preimageHash []byte) (*lnrpc.Invoice, error)
  • func (lnd *LND) NewAddress() (string, error)
  • func (lnd *LND) PayInvoice(invoice string, maxParts uint32, timeoutSeconds int32) (*lnrpc.Payment, error)
  • func (lnd *LND) PendingChannels() (*lnrpc.PendingChannelsResponse, error)
  • func (lnd *LND) RegisterBlockListener(channel chan *chainrpc.BlockEpoch) error
  • func (lnd *LND) SettleInvoice(preimage []byte) (*invoicesrpc.SettleInvoiceResp, error)
  • func (lnd *LND) SubscribeSingleInvoice(preimageHash []byte, channel chan *lnrpc.Invoice, errChannel chan error)
• type LightningClient

Types

type LND

type LND struct {
	Host        string `long:"lnd.host" description:"gRPC host of the LND node"`
	Port        int    `long:"lnd.port" description:"gRPC port of the LND node"`
	Macaroon    string `long:"lnd.macaroon" description:"Path to a macaroon file of the LND node"`
	Certificate string `long:"lnd.certificate" description:"Path to a certificate file of the LND node"`

	ChainParams *chaincfg.Params
	// contains filtered or unexported fields
}

func (*LND) AddHoldInvoice

func (lnd *LND) AddHoldInvoice(preimageHash []byte, value int64, expiry int64, memo string) (*invoicesrpc.AddHoldInvoiceResp, error)

func (*LND) AddInvoice

func (lnd *LND) AddInvoice(value int64, preimage []byte, expiry int64, memo string) (*lnrpc.AddInvoiceResponse, error)

func (*LND) CancelInvoice

func (lnd *LND) CancelInvoice(preimageHash []byte) (*invoicesrpc.CancelInvoiceResp, error)

func (*LND) Connect

func (lnd *LND) Connect() error

func (*LND) ConnectPeer

func (lnd *LND) ConnectPeer(pubKey string, host string) (*lnrpc.ConnectPeerResponse, error)

func (*LND) EstimateFee

func (lnd *LND) EstimateFee(confTarget int32) (*walletrpc.EstimateFeeResponse, error)

func (*LND) GetChannelInfo

func (lnd *LND) GetChannelInfo(channelId uint64) (*lnrpc.ChannelEdge, error)

func (*LND) GetInfo

func (lnd *LND) GetInfo() (*lnrpc.GetInfoResponse, error)

func (*LND) ListChannels

func (lnd *LND) ListChannels() (*lnrpc.ListChannelsResponse, error)

func (*LND) LookupInvoice

func (lnd *LND) LookupInvoice(preimageHash []byte) (*lnrpc.Invoice, error)

func (*LND) NewAddress

func (lnd *LND) NewAddress() (string, error)

func (*LND) PayInvoice

func (lnd *LND) PayInvoice(invoice string, maxParts uint32, timeoutSeconds int32) (*lnrpc.Payment, error)

func (*LND) PendingChannels

func (lnd *LND) PendingChannels() (*lnrpc.PendingChannelsResponse, error)

func (*LND) RegisterBlockListener

func (lnd *LND) RegisterBlockListener(channel chan *chainrpc.BlockEpoch) error

func (*LND) SettleInvoice

func (lnd *LND) SettleInvoice(preimage []byte) (*invoicesrpc.SettleInvoiceResp, error)

func (*LND) SubscribeSingleInvoice

func (lnd *LND) SubscribeSingleInvoice(preimageHash []byte, channel chan *lnrpc.Invoice, errChannel chan error)

type LightningClient

type LightningClient interface {
	GetInfo() (*lnrpc.GetInfoResponse, error)
	GetNodeInfo(pubkey string) (*lnrpc.NodeInfo, error)
	ListChannels() (*lnrpc.ListChannelsResponse, error)
	ClosedChannels() (*lnrpc.ClosedChannelsResponse, error)
	GetChannelInfo(chanId uint64) (*lnrpc.ChannelEdge, error)
	ListInactiveChannels() (*lnrpc.ListChannelsResponse, error)
	ForceCloseChannel(channelPoint string) (lnrpc.Lightning_CloseChannelClient, error)
}