lndwrap

Documentation

Overview

Package lndwrap wraps various calls to lndclient for convenience. It offers wrapping for paginated queries that will obtain all entries from a desired index onwards.

Index

• func ListChannels(ctx context.Context, lnd lndclient.LightningClient, publicOnly bool) func() ([]lndclient.ChannelInfo, error)
• func ListForwards(ctx context.Context, maxForwards uint64, startTime, endTime time.Time, ...) ([]lndclient.ForwardingEvent, error)
• func ListInvoices(ctx context.Context, startOffset, maxInvoices uint64, ...) ([]lndclient.Invoice, error)
• func ListPayments(ctx context.Context, startOffset, maxPayments uint64, ...) ([]lndclient.Payment, error)

Functions

func ListChannels

func ListChannels(ctx context.Context, lnd lndclient.LightningClient,
	publicOnly bool) func() ([]lndclient.ChannelInfo, error)

ListChannels wraps the listchannels call to lnd, with a publicOnly bool that can be used to toggle whether private channels are included.

func ListForwards

func ListForwards(ctx context.Context, maxForwards uint64, startTime,
	endTime time.Time, lnd lndclient.LightningClient) (
	[]lndclient.ForwardingEvent, error)

ListForwards makes paginated calls to our forwarding events api.

func ListInvoices

func ListInvoices(ctx context.Context, startOffset, maxInvoices uint64,
	lnd lndclient.LightningClient) ([]lndclient.Invoice, error)

ListInvoices makes paginated calls to lnd to get our full set of invoices.

func ListPayments

func ListPayments(ctx context.Context, startOffset, maxPayments uint64,
	lnd lndclient.LightningClient) ([]lndclient.Payment, error)

ListPayments makes a set of paginated calls to lnd to get our full set of payments.