GitHubHelp

bitodt/lnd-stack

lnd stack with a btcd and demo transactions

★ 0Forks 0ShellGitHub ↗Compare

README

btcd & lnd stack

CAUTION

This setup should only be used for development purposes, and by default on simnet. Do not use on mainchain with real sats.

Installation (requires an active kubernetes cluster and helm)

The stack uses images generated with these Dockerfiles.

To install the stack, you need a kubernetes cluster, and the command-line tools kubectl and helm. For a quick local setup, please check out minikube.

To install the stack, just run in a shell (namespace and release name are optional):

export NAMESPACE=default
export RELEASE_NAME=lndstack
helm upgrade $RELEASE_NAME --install .

Verify everything is running smoothly

kubectl -n $NAMESPACE get pods

You should see 2 completed jobs:

  • alice-lndinit
  • bob-lndinit

and 4 running pods:

  • alice-deployment
  • bob-deployment
  • btcd
  • debugger

The 2 lndinit jobs create the lnd wallets required by the lnd deployments.

Alice and Bob deployments are lnd nodes (on simnet), each using a separate wallet and connecting to the same btcd.

The btcd deployment is a btcd node on simnet.

The debugger deployment is a debian pod with all volumes and secrets mounted, for debugging purposes. You can enter its shell with

kubectl -n $NAMESPACE exec -it debugger_pod_name -- bash

and check out mounted volumes as seen in the debugger.yaml volumeMounts section.

Monitoring

The lndmon monitoring solution is automatically installed with the lnd stack.

You can use kubernetes port-forwarding to see the dashboards.

kubectl -n $NAMESPACE port-forward services/$RELEASE_NAME-lnd-stack-grafana-svc 3000

and access Grafana with your browser at localhost:3000. Default credentials are admin:admin.

Demo

After making sure everything is up and running, run the demo script.

The demo script generates blocks, creates a payment channel from Alice to Bob, sends a payment and then closes the channel.

cd scripts
export RELEASE_NAME=lndstack # same as used for installation
./run_demo.sh

It can be run multiple times (not in parallel), and each time it will create a new default address (for minted coins, in Alice's wallet), and a new channel.

Uninstall

Remove your installation with

helm uninstall $RELEASE_NAME

and delete the wallets with

kubectl -n $NAMESPACE delete secret $RELEASE_NAME-lnd-stack-alice-wallet-secret
kubectl -n $NAMESPACE delete secret $RELEASE_NAME-lnd-stack-bob-wallet-secret

TODO

  • Better security should be considered if we move this to production
  • Better configurability of the chart
  • Error handling in charts
  • Error handling in scripts
  • More scripts for easier operations (i.e. quickly open a new channel, create and pay invoices); maybe split run_demo.sh into smaller parts/functions
  • Make debugger optional, activated by a flag in values.yaml
  • Make monitoring optional, activated by a flag in values.yaml
  • Split Prometheus/Grafana stack to 2, separate for each LND node
    • Grafana is shared, with the 2 separate Prometheus instances as data sources.
  • The setup currently works for the default namespace. Test in other namespaces, make changes if required.

Contributors

bitodt

Issues