25f4fea9f7
add same docker support modify sample docker compose file include lndk-cli in the docker image fix docker compose file update dockerfile to use github and use slimmer image lower grace period use better lnd paths add some lnd config |
||
|---|---|---|
| .cargo | ||
| .github | ||
| docs | ||
| lnd@d22b3937ea | ||
| proto | ||
| src | ||
| tests | ||
| .gitignore | ||
| .gitmodules | ||
| ARCH.md | ||
| build.rs | ||
| Cargo.lock | ||
| Cargo.toml | ||
| CHANGELOG.md | ||
| cliff.toml | ||
| code_of_conduct.md | ||
| config_spec.toml | ||
| CONTRIBUTING.md | ||
| Dockerfile | ||
| LICENSE | ||
| MAINTAINERS.md | ||
| Makefile | ||
| README.md | ||
| rust-toolchain.toml | ||
| sample-docker-compose.yaml | ||
| sample-lndk.conf | ||
LNDK
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.
Resources
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.
Setting up LNDK
Compiling LND
To run LNDK, you will need a LND node running at least LND v0.18.0.
You will need to compile LND with the peersrpc, signerrpc, and walletrpc sub-servers enabled:
make install tags="peersrpc signrpc walletrpc"
Note that this guide assumes some familiarity with setting up LND. If you're looking to get up to speed, try this guide.
Running LND
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
Two options for LNDK
Now that we have LND set up properly, there are two key things you can do with LNDK:
- Forward onion messages. By increasing the number of Lightning nodes out there that can forward onion messages, this increases the anonymity set and helps to bootstrap BOLT 12 for more private payments.
- Pay BOLT 12 offers, a more private standard for receiving payments over Lightning, which also allows for static invoices.
To accomplish #1, follow the instructions below to get the LNDK binary up and running. Once you have LNDK up and running, you can accomplish #2
here with either lndk-cli or setting up your own gRPC client.
Running LNDK
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.
As you can see in LNDK's config specifications file, there's two ways to pass in the credentials:
- By path with the
cert-pathandmacaroon-patharguments. - Directly, with the
cert-pemandmacaroon-hexarguments.
With that in mind, there are two ways to pass in the arguments to LNDK:
- These values can be passed in via the command line when running the
LNDKprogram, like this:
cargo run --bin=lndk -- --address=<ADDRESS> --cert-path=<TLSPATH> --macaroon-path=<MACAROONPATH>
Or in a more concrete example:
cargo run --bin=lndk -- --address=https://localhost:10009 --cert-path=/home/<USERNAME>/.lnd/tls.cert --macaroon-path=/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-path="<TLSPATH>"macaroon-path="<MACAROONPATH>"
- Run
cargo run --bin=lndk -- --conf lndk.conf
- Use any of the commands with the --help option for more information about each argument.
Custom macaroon
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 uri:/verrpc.Versioner/GetVersion
Security
NOTE: It is recommended to always use cargo-crev to verify the trustworthiness of each of your dependencies, including this one.