Skip to content

Latest commit

 

History

History
143 lines (97 loc) · 3.79 KB

README.md

File metadata and controls

143 lines (97 loc) · 3.79 KB
Raw

LND-Tools: A proxy tool for LND

Requirements

  • Node.JS v18

Usage

For these instructions, I will use the dev command (i.e. lnd-tools.js), but if using a binary, you should replace lnd-tools.js with your appropriate binary file.

Server

To run your server, you'll need to create an authentication private/public key pair.

./lnd-tools.js keygen

This will output a private and public key pair to auth.key and auth.pub. By default, it will create and place the files in $HOME/.lnd-tools.

The public key (auth.pub) will be used by the server to authenticate requests. The private key (auth.key) will be used by a client (either the included client or your custom external client) to sign requests to the server.

Start the server with

./lnd-tools.js serve

The above command uses several defaults and creates a data directory in $HOME/.lnd-tools. See the Configuration section below

Client

Once the server is running, you can use the client to:

  • Add/Remove/Get whitelist entries for accepting channel open requests.
  • Configure a custom response when denying a channel open request.

Examples:

Get all whitelist entries

./lnd-tools.js client -k auth.key whitelist list

Add a new public key to the whitelist

./lnd-tools.js client -k auth.key whitelist add 037f1bbdc42d775c0d3ac4cbae2a676065d98128758718bbbc98c4d0616f7b5eb4

Remove a public key from the whitelist

./lnd-tools.js client -k auth.key whitelist rm 037f1bbdc42d775c0d3ac4cbae2a676065d98128758718bbbc98c4d0616f7b5eb4

Get the current channel request reject message

./lnd-tools.js client -k auth.key config getRejectMessage

Set a new channel request reject message

./lnd-tools.js client -k auth.key config setRejectMessage "This is the new message"

Remove the custom channel request reject message. This will result in the default message being shown.

./lnd-tools.js client -k auth.key config rmRejectMessage

Dev & Debug

Clone the repo then run:

cd lnd-tools
npm install

I would recommend using Polar and set up a network. Choose an LND node to be "your" node and point --lnddir to its directory (e.g. --lnddir $HOME/.polar/networks/1/volumes/lnd/alice). Don't forget to also set --lndnetwork and --lndrpc.

Execute the program by running

./lnd-tools.js <...args>

Configuration

Any of the flags shown in lnd-tools serve --help can be put into a simple key=value config file.

Exceptions: for obvious reasons, the --datadir and --config flags will need to be specified in the command line if customized.

You can optionally specify an environment variable LND_TOOLS_DATADIR the server will use for --datadir.

You can also specify rejectchannelmessage in the config to override Constants.LND.ChannelRejectMessage.

Example: lnd-tools.conf

key=myAuth.pub
lnddir=/home/myUser/custom/lnd/directory
lndconfig=lnd-test.conf
rejectchannelmessage=Please reach out to [email protected] to open a channel.

Build

To build the binaries, simply run

npm run build

or

./build.sh [options]

Running the npm script or ./build.sh without options will build the binaries for your local machine's OS and architecture. You can specify options to ./build.sh to build for other OS's and architectures.

Reproduceable Builds

To build deterministically across various platforms, you must have Docker-compose installed.

docker compose build
docker compose run --rm build ./build.sh [options]

The --rm flag ensures that the container used to run your build is deleted once the build completes. The binaries are still written to ./build

Example:

docker compose run --rm build ./build.sh --os macos,linux --arch x64 --checksum

Testing

To run tests:

npm run test