boltz_lnd

package module
v1.2.7 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 3, 2023 License: MIT Imports: 12 Imported by: 0

README

Boltz LND

This repository contains a Boltz client for LND. It supports Normal Submarine Swaps (from onchain to Lightning coins) and Reverse ones (from Lightning to onchain coins).

The full documentation can be found here or in the docs folder

Building

To build Go version 1.14 or higher is required. boltz-lnd also has C dependencies which means a C compiler has to be installed to compile the daemon successfully.

The build process requires patches for dependencies, and some build flags, therefore the Makefile in the repository root should be used.

go mod vendor
make build

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Config added in v1.2.7

type Config struct {
	DataDir string `short:"d" long:"datadir" description:"Data directory of boltz-lnd"`

	ConfigFile string `short:"c" long:"configfile" description:"Path to configuration file"`

	LogFile   string `short:"l" long:"logfile" description:"Path to the log file"`
	LogPrefix string `long:"logprefix" description:"Prefix of all log messages"`

	Boltz    *boltz.Boltz         `group:"Boltz Options"`
	LND      *lnd.LND             `group:"LND Options"`
	RPC      *rpcserver.RpcServer `group:"RPC options"`
	Database *database.Database   `group:"Database options"`

	MempoolApi string `long:"mempool" description:"mempool.space API to use for fee estimations; set to empty string to disable"`

	Help *helpOptions `group:"Help Options"`
}

func LoadConfig

func LoadConfig() *Config

Directories

Path Synopsis
Package boltzrpc is a reverse proxy.
Package boltzrpc is a reverse proxy.
cmd

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL