lightning

Documentation

Index

• Constants
• type Hash
  • func (hash Hash) String() string
• type Invoice
• type Preimage
  • func GetPreimage() (Preimage, error)
  • func MakePreimage(newPreimage []byte) (Preimage, error)
  • func MakePreimageFromStr(newPreimage string) (Preimage, error)
  • func (p *Preimage) Hash() Hash
  • func (p *Preimage) Matches(h Hash) bool
  • func (p Preimage) String() string

Constants

const HashSize = 32

HashSize of array used to store hashes.

const PreimageSize = 32

PreimageSize of array used to store preimagees.

Types

type Hash

type Hash [HashSize]byte

Hash is used in several of the lightning messages and common structures. It typically represents a payment hash.

var ZeroHash Hash

ZeroHash is a predefined hash containing all zeroes.

func (Hash) String

func (hash Hash) String() string

String returns the Hash as a hexadecimal string.

type Invoice

type Invoice struct {
	PHash       string
	Amount      uint64
	Description string
}

Invoice defines the neccessary parts for decodepayreq

type Preimage

type Preimage [PreimageSize]byte

Preimage is used in several of the lightning messages and common structures. It represents a payment preimage.

func GetPreimage

func GetPreimage() (Preimage, error)

RandomPreimage returns a random Preimage

func MakePreimage

func MakePreimage(newPreimage []byte) (Preimage, error)

MakePreimage returns a new Preimage from a bytes slice. An error is returned if the number of bytes passed in is not PreimageSize.

func MakePreimageFromStr

func MakePreimageFromStr(newPreimage string) (Preimage, error)

MakePreimageFromStr creates a Preimage from a hex preimage string.

func (*Preimage) Hash

func (p *Preimage) Hash() Hash

Hash returns the sha256 hash of the preimage.

func (*Preimage) Matches

func (p *Preimage) Matches(h Hash) bool

Matches returns whether this preimage is the preimage of the given hash.

func (Preimage) String

func (p Preimage) String() string

String returns the Preimage as a hexadecimal string.