makeinvoice

README

makeinvoice

A simple function capable of generating an invoice in multiple Lightning backends.

Currently supports Sparko, LND REST, LNbits, LNPay, Eclair and Commando.

Usage

package main

import "github.com/fiatjaf/makeinvoice"

func main () {
	bolt11, err := makeinvoice.MakeInvoice(makeinvoice.Params{
		Msatoshi: 100000,
		Backend: LNDParams{
			Host: "https://my.lnd.com:1234",
			Macaroon: "0201036c6e640258030a10e82b814c2a3871f9753984e0f5e01ffb1201301a160a0761646472657373120472656164120577726974651a170a08696e766f69636573120472656164120577726974651a0f0a076f6e636861696e1204726561640000062087d4b068ad6b4d912680b3e0d912ca02936733a3377f246aa32bf354aa74ab2d",
		},
		DescriptionHash: []byte("fd85a881de24b15942425e61bdccf581a84b70ac2128490b8d14ea53fd6b8815"),
	})
}

See https://pkg.go.dev/github.com/fiatjaf/makeinvoice for the full docs.

Documentation

Index

• Variables
• func MakeInvoice(params Params) (bolt11 string, err error)
• type BackendParams
• type CommandoParams
• type EclairParams
• type LNBitsParams
• type LNDParams
• type LNPayParams
• type Params
• type SparkoParams
• type StrikeParams

Variables

var (
	TorProxyURL = "socks5://127.0.0.1:9050"
	Client      = &http.Client{
		Timeout: 10 * time.Second,
	}
)

Functions

func MakeInvoice

func MakeInvoice(params Params) (bolt11 string, err error)

Types

type BackendParams

type BackendParams interface {
	// contains filtered or unexported methods
}

type CommandoParams

type CommandoParams struct {
	Rune   string
	Host   string
	NodeId string
}

type EclairParams

type EclairParams struct {
	Host     string
	Password string
	Cert     string
}

type LNBitsParams

type LNBitsParams struct {
	Cert string
	Host string
	Key  string
}

type LNDParams

type LNDParams struct {
	Cert     string
	Host     string
	Macaroon string
	Private  bool
}

type LNPayParams

type LNPayParams struct {
	PublicAccessKey  string
	WalletInvoiceKey string
}

type Params

type Params struct {
	Backend     BackendParams
	Msatoshi    int64
	Description string

	// setting this to true will cause .Description to be hashed and used as
	// the description_hash (h) field on the bolt11 invoice
	UseDescriptionHash bool

	Label string // only used for c-lightning
}

type SparkoParams

type SparkoParams struct {
	Cert string
	Host string
	Key  string
}

type StrikeParams

type StrikeParams struct {
	Key      string
	Username string
	Currency string
}