LNDK is a standalone daemon that connects to LND (via its grpc API) that aims to implement bolt 12 functionality externally to LND. LNDK leverages the lightning development kit to provide functionality, acting as a thin "shim" between LND's APIs and LDK's lightning library.
Project Milestones:
Please note that this project is still experimental.
When you encounter a problem with LNDK, Feel free to file issues or start a discussion. If your question doesn't fit in either place, find us in the BOLT 12 Discord in the lndk channel.
To run LNDK, you require access to a LND node running at least LND v0.17.0.
You will need to compile LND in dev mode (to enable protocol-level feature handling externally) and enable the peersrpc, signerrpc, and walletrpc sub-servers:
make install tags="peersrpc signrpc walletrpc dev"
Note that this guide assumes some familiarity with setting up LND. If you're looking to get up to speed, try this guide.
Once you're ready to run LND, the binary must be run with --protocol.custom-message=513 to allow it to report onion messages to LNDK as well as --protocol.custom-nodeann=39 --protocol.custom-init=39 for advertising the onion message feature bits.
There are two ways you can do this:
- Pass these options directly to
LNDwhen running it:
lnd --protocol.custom-message=513 --protocol.custom-nodeann=39 --protocol.custom-init=39
- Adding these to the config file
lnd.conf:
[protocol]
protocol.custom-message=513
protocol.custom-nodeann=39
protocol.custom-init=39
Now we need to set up LNDK. To start:
git clone https://github.com/lndk-org/lndk
cd lndk
In order for LNDK successfully connect to LND, we need to pass in the grpc address and authentication credentials. There are two ways to do this:
- These values can be passed in via the command line when running the
LNDKprogram, like this:
cargo run --bin=lndk -- --address=<ADDRESS> --cert=<TLSPATH> --macaroon=<MACAROONPATH>
Or in a more concrete example:
cargo run --bin=lndk -- --address=https://localhost:10009 --cert=/home/<USERNAME>/.lnd/tls.cert --macaroon=/home/<USERNAME>/.lnd/data/chain/bitcoin/regtest/admin.macaroon
Remember that the grpc address must start with https:// for the program to work.
- Alternatively, you can use a configuration file to add the required arguments.
- In the lndk directory, create file named
lndk.conf. - Add the following lines to the file:
address="<ADDRESS"cert="<TLSPATH>"macaroon="<MACAROONPATH>"
- Run
cargo run --bin=lndk -- --conf lndk.conf
- Use any of the commands with the --help option for more information about each argument.
Rather than use the admin.macaroon with unrestricted permission to an LND node, we can bake a macaroon using lncli with much more specific permissions for better security. With this command, generate a macaroon which will give LNDK only the specific grpc endpoints it's designed to hit:
lncli bakemacaroon --save_to=<FILEPATH>/lndk.macaroon uri:/lnrpc.Lightning/GetInfo uri:/lnrpc.Lightning/ListPeers uri:/lnrpc.Lightning/SubscribePeerEvents uri:/lnrpc.Lightning/SendCustomMessage uri:/lnrpc.Lightning/SubscribeCustomMessages uri:/peersrpc.Peers/UpdateNodeAnnouncement uri:/signrpc.Signer/DeriveSharedKey
NOTE: It is recommended to always use cargo-crev to verify the trustworthiness of each of your dependencies, including this one.