lightning

package
v0.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 6, 2024 License: MIT Imports: 10 Imported by: 0

Documentation

Index

Constants

View Source
const (
	InvoiceExpiryMins         = 10
	FeePercent        float64 = 0.01
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Client

type Client interface {
	CreateInvoice(amount uint64) (Invoice, error)
	InvoiceStatus(hash string) (Invoice, error)
	FeeReserve(amount uint64) uint64
	SendPayment(request string, amount uint64) (string, error)
}

Client interface to interact with a Lightning backend

type Invoice

type Invoice struct {
	PaymentRequest string
	PaymentHash    string
	Settled        bool
	Amount         uint64
	Expiry         uint64
}

type LndClient

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

func SetupLndClient added in v0.2.0

func SetupLndClient(config LndConfig) (*LndClient, error)

func (*LndClient) CreateInvoice

func (lnd *LndClient) CreateInvoice(amount uint64) (Invoice, error)

func (*LndClient) FeeReserve

func (lnd *LndClient) FeeReserve(amount uint64) uint64

func (*LndClient) InvoiceStatus added in v0.2.0

func (lnd *LndClient) InvoiceStatus(hash string) (Invoice, error)

func (*LndClient) SendPayment

func (lnd *LndClient) SendPayment(request string, amount uint64) (string, error)

type LndConfig added in v0.2.0

type LndConfig struct {
	GRPCHost string
	Cert     credentials.TransportCredentials
	Macaroon macaroons.MacaroonCredential
}

type SendPaymentResponse added in v0.2.0

type SendPaymentResponse struct {
	PaymentError    string `json:"payment_error"`
	PaymentPreimage string `json:"payment_preimage"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL