lntypes

Documentation

Index

• Constants
• func Max[N Number](op1 N, op2 N) N
• func Min[N Number](op1 N, op2 N) N
• type Hash
  • func MakeHash(newHash []byte) (Hash, error)
  • func MakeHashFromStr(newHash string) (Hash, error)
  • func (hash Hash) String() string
• type Number
• type Preimage
  • 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
• type VByte
  • func (vb VByte) String() string
  • func (vb VByte) ToWU() WeightUnit
• type WeightUnit
  • func (wu WeightUnit) String() string
  • func (wu WeightUnit) ToVB() VByte

Constants

const HashSize = 32

HashSize of array used to store hashes.

const PreimageSize = 32

PreimageSize of array used to store preimagees.

Functions

func Max

func Max[N Number](op1 N, op2 N) N

Max returns the greater of the two inputs.

func Min

func Min[N Number](op1 N, op2 N) N

Min returns the lesser of the two inputs.

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 MakeHash

func MakeHash(newHash []byte) (Hash, error)

MakeHash returns a new Hash from a byte slice. An error is returned if the number of bytes passed in is not HashSize.

func MakeHashFromStr

func MakeHashFromStr(newHash string) (Hash, error)

MakeHashFromStr creates a Hash from a hex hash string.

func (Hash) String

func (hash Hash) String() string

String returns the Hash as a hexadecimal string.

type Number

type Number interface {
	constraints.Integer | constraints.Float
}

Number defines a type constraint for numbers.

type Preimage

type Preimage [PreimageSize]byte

Preimage is used in several of the lightning messages and common structures. It represents a payment 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.

type VByte

type VByte uint64

VByte defines a unit to express the transaction size. One virtual byte is 1/4th of a weight unit. The tx virtual bytes is calculated using `TxWeight / 4`.

func (VByte) String

func (vb VByte) String() string

String returns the string representation of the virtual byte.

func (VByte) ToWU

func (vb VByte) ToWU() WeightUnit

ToWU converts a value expressed in virtual bytes to weight units.

type WeightUnit

type WeightUnit uint64

WeightUnit defines a unit to express the transaction size. One weight unit is 1/4_000_000 of the max block size. The tx weight is calculated using `Base tx size * 3 + Total tx size`.

• Base tx size is size of the transaction serialized without the witness data.
• Total tx size is the transaction size in bytes serialized according #BIP144.

func (WeightUnit) String

func (wu WeightUnit) String() string

String returns the string representation of the weight unit.

func (WeightUnit) ToVB

func (wu WeightUnit) ToVB() VByte

ToVB converts a value expressed in weight units to virtual bytes.