ln

Documentation

Index

• type Invoice
• type LNDclient
  • func NewLNDclient(lndOptions LNDoptions) (LNDclient, error)
  • func (c LNDclient) AddInvoice(value int64, memo string, descriptionHash []byte, private bool) (Invoice, error)
  • func (c LNDclient) GetInvoice(paymentHashStr string) (Invoice, error)
  • func (c LNDclient) NewAddress() (string, error)
• type LNDoptions

Types

type Invoice

type Invoice struct {
	PaymentHash    string `json:"payment_hash"`
	PaymentRequest string `json:"payment_request"`
	Settled        bool   `json:"settled"`
}

thanks https://github.com/philippgille/ln-paywall/ Invoice is a Lightning Network invoice and contains the typical invoice string and the payment hash.

type LNDclient

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

func NewLNDclient

func NewLNDclient(lndOptions LNDoptions) (LNDclient, error)

func (LNDclient) AddInvoice

func (c LNDclient) AddInvoice(value int64, memo string, descriptionHash []byte, private bool) (Invoice, error)

AddInvoice generates an invoice with the given price and memo.

func (LNDclient) GetInvoice

func (c LNDclient) GetInvoice(paymentHashStr string) (Invoice, error)

GetInvoice takes an invoice ID and returns the invoice details including settlement details An error is returned if no corresponding invoice was found.

func (LNDclient) NewAddress

func (c LNDclient) NewAddress() (string, error)

NewAddress gets the next BTC onchain address.

type LNDoptions

type LNDoptions struct {
	Address      string
	CertFile     string
	CertHex      string
	MacaroonFile string
	MacaroonHex  string
	TorExePath   string // used when connecting through tor to LND
}

LNDoptions are the options for the connection to the lnd node.