offers

Documentation

Index

• Constants
• Variables
• func DecodeOfferStr(offerStr string) (*lnwire.Offer, error)
• func DisableLog()
• func UseLogger(logger btclog.Logger)

Constants

const Subsystem = "B12-OFR"

Subsystem defines the logging code for this subsystem.

Variables

var (
	// ErrIncorrectSplit is returned when an offer string contains "+"
	// joins that are incorrectly placed - either consecutive, or starting/
	// ending the offers string
	ErrIncorrectSplit = errors.New("consecutive, prefix or suffix + invalid")

	// ErrNotInCharset is returned when a character in an offer string is
	// not part of our charset.
	ErrNotInCharset = errors.New("invalid character, not in charset")
)

var (
	// ErrInvalidOfferStr is returned when we fail to decode a bech32
	// encoded offer string.
	ErrInvalidOfferStr = errors.New("invalid offer string")

	// ErrBadHRP is returned when an offer string has the wrong bech32
	// human readable prefix.
	ErrBadHRP = fmt.Errorf("incorrect bech32 hrp, should be: %v", offerHRP)
)

Functions

func DecodeOfferStr

func DecodeOfferStr(offerStr string) (*lnwire.Offer, error)

DecodeOfferStr decodes a bech32 encoded offer string, returning our offer type with the information contained in the offer.

func DisableLog

func DisableLog()

DisableLog disables all library log output. Logging output is disabled by default until UseLogger is called.

func UseLogger

func UseLogger(logger btclog.Logger)

UseLogger uses a specified Logger to output package logging info. This should be used in preference to SetLogWriter if the caller is also using btclog.