payments

Documentation

Overview

Package payments provides an abstraction above the implementation for handling Lightning Network payments and storing pending payments awaiting session keys.

Index

• type PayChan
  • func (pc PayChan) Receive() <-chan *Payment
  • func (pc PayChan) Send(amount lnwire.MilliSatoshi, id nonce.ID, preimage sha256.Hash) (confirmChan chan bool)
• type Payment
• type PendingPayments
  • func (p PendingPayments) Add(np *Payment) (pp PendingPayments)
  • func (p PendingPayments) Delete(preimage sha256.Hash) (pp PendingPayments)
  • func (p PendingPayments) Find(id nonce.ID) (pp *Payment)
  • func (p PendingPayments) FindPreimage(pi sha256.Hash) (pp *Payment)

Types

type PayChan

type PayChan chan *Payment

func (PayChan) Receive

func (pc PayChan) Receive() <-chan *Payment

Receive waits on receiving a Payment on a PayChan.

func (PayChan) Send

func (pc PayChan) Send(amount lnwire.MilliSatoshi,
	id nonce.ID, preimage sha256.Hash) (confirmChan chan bool)

Send a payment on the PayChan.

type Payment

type Payment struct {
	ID          nonce.ID
	Preimage    sha256.Hash
	Amount      lnwire.MilliSatoshi
	ConfirmChan chan bool
}

type PendingPayments

type PendingPayments []*Payment

func (PendingPayments) Add

func (p PendingPayments) Add(np *Payment) (pp PendingPayments)

func (PendingPayments) Delete

func (p PendingPayments) Delete(preimage sha256.Hash) (pp PendingPayments)

func (PendingPayments) Find

func (p PendingPayments) Find(id nonce.ID) (pp *Payment)

func (PendingPayments) FindPreimage

func (p PendingPayments) FindPreimage(pi sha256.Hash) (pp *Payment)