lnd-binary

lnd-binary

install lnd from npm https://github.com/lightningnetwork/lnd ⚡️

This package will download and install a precompiled lnd binary. The installed binary is verified against the official lnd binary checksums to ensure its integrity.

By default, the latest supported lnd release for your platform/architecture will be installed. Alternatively, a specific version can be specified using the configuration options below.

The lnd binary gets installed into the vendor directory inside the module folder and symlinked into your node bin directory.

Table of Contents

• Install
• Usage
• Maintainers
• Contribute
• License

Install

npm install lnd-binary --save

Usage

> npm install lnd-binary
> npx lnd --version
lnd version 0.4.2-beta

Configuration

lnd-binary supports different configuration parameters to change settings related to the lnd binary such as binary name, binary path or alternative download path. Following parameters are supported by lnd-binary:

Variable name	package.json	.npmrc parameter	Process argument	Value
LND_BINARY_NAME	binaryName	lnd_binary_name	--lnd-binary-name	String
LND_BINARY_SITE	binarySite	lnd_binary_site	--lnd-binary-site	URL
LND_BINARY_PATH	binaryPath	lnd_binary_path	--lnd-binary-path	Path
LND_BINARY_DIR	binaryDir	lnd_binary_dir	--lnd-binary-dir	Path
LND_BINARY_PLATFORM	binaryPlatform	lnd_binary_platform	--lnd-binary-platform	Platform
LND_BINARY_ARCH	binaryArch	lnd_binary_arch	--lnd-binary-arch	Architecture
LND_BINARY_VERSION	binaryVersion	lnd_binary_version	--lnd-binary-version	Version

These parameters can be used in package.json config section:

• E.g.

{
  "config": {
    "lnd-binary": {
      "binaryVersion": "0.4.2-beta"
    }
  }
}

These parameters can be used as environment variable:

• E.g. export LND_BINARY_VERSION=0.4.2-beta

As local or global .npmrc configuration file:

• E.g. lnd_binary_version=0.4.2-beta

As a process argument:

• E.g. npm install lnd-binary --lnd-binary-version 0.4.2-beta

Testing

Run the tests suite:

  npm test

Run with debugging output on:

  DEBUG='lnd-binary' npm test

Maintainers

@Tom Kirkpatrick (mrfelton).

Contribute

Feel free to dive in! Open an issue or submit PRs.

lnd-binary follows the Contributor Covenant Code of Conduct.

License

MIT © Tom Kirkpatrick