lightning

Documentation

Index

• Constants
• type Client
• type FakeBackend
  • func (fb *FakeBackend) ConnectionStatus() error
  • func (fb *FakeBackend) CreateInvoice(amount uint64) (Invoice, error)
  • func (fb *FakeBackend) FeeReserve(amount uint64) uint64
  • func (fb *FakeBackend) InvoiceStatus(hash string) (Invoice, error)
  • func (fb *FakeBackend) OutgoingPaymentStatus(ctx context.Context, hash string) (PaymentStatus, error)
  • func (fb *FakeBackend) SendPayment(ctx context.Context, request string, amount uint64) (PaymentStatus, error)
• type Invoice
• type LndClient
  • func SetupLndClient(config LndConfig) (*LndClient, error)
  • func (lnd *LndClient) ConnectionStatus() error
  • func (lnd *LndClient) CreateInvoice(amount uint64) (Invoice, error)
  • func (lnd *LndClient) FeeReserve(amount uint64) uint64
  • func (lnd *LndClient) InvoiceStatus(hash string) (Invoice, error)
  • func (lnd *LndClient) OutgoingPaymentStatus(ctx context.Context, hash string) (PaymentStatus, error)
  • func (lnd *LndClient) SendPayment(ctx context.Context, request string, amount uint64) (PaymentStatus, error)
• type LndConfig
• type PaymentStatus
• type State

Constants

const (
	InvoiceExpiryMins         = 10
	FeePercent        float64 = 0.01
)

const (
	FakePreimage = "0000000000000000"
)

Types

type Client

type Client interface {
	ConnectionStatus() error
	CreateInvoice(amount uint64) (Invoice, error)
	InvoiceStatus(hash string) (Invoice, error)
	SendPayment(ctx context.Context, request string, amount uint64) (PaymentStatus, error)
	OutgoingPaymentStatus(ctx context.Context, hash string) (PaymentStatus, error)
	FeeReserve(amount uint64) uint64
}

Client interface to interact with a Lightning backend

type FakeBackend

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

func (*FakeBackend) ConnectionStatus

func (fb *FakeBackend) ConnectionStatus() error

func (*FakeBackend) CreateInvoice

func (fb *FakeBackend) CreateInvoice(amount uint64) (Invoice, error)

func (*FakeBackend) FeeReserve

func (fb *FakeBackend) FeeReserve(amount uint64) uint64

func (*FakeBackend) InvoiceStatus

func (fb *FakeBackend) InvoiceStatus(hash string) (Invoice, error)

func (*FakeBackend) OutgoingPaymentStatus

func (fb *FakeBackend) OutgoingPaymentStatus(ctx context.Context, hash string) (PaymentStatus, error)

func (*FakeBackend) SendPayment

func (fb *FakeBackend) SendPayment(ctx context.Context, request string, amount uint64) (PaymentStatus, error)

type Invoice

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

type LndClient

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

func SetupLndClient

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

func (*LndClient) ConnectionStatus

func (lnd *LndClient) ConnectionStatus() 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

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

func (*LndClient) OutgoingPaymentStatus

func (lnd *LndClient) OutgoingPaymentStatus(ctx context.Context, hash string) (PaymentStatus, error)

func (*LndClient) SendPayment

func (lnd *LndClient) SendPayment(ctx context.Context, request string, amount uint64) (PaymentStatus, error)

type LndConfig

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

type PaymentStatus

type PaymentStatus struct {
	Preimage             string
	PaymentStatus        State
	PaymentFailureReason string
}

type State

type State int

const (
	Succeeded State = iota
	Failed
	Pending
)