https://github.com/briansipple/lightning-network-node-cluster-vscode-setup
Starter project for running a local cluster of Lightning Network nodes using VSCode
https://github.com/briansipple/lightning-network-node-cluster-vscode-setup
bitcoin lightning lightning-network lnd starter-kit
Last synced: 4 months ago
JSON representation
Starter project for running a local cluster of Lightning Network nodes using VSCode
- Host: GitHub
- URL: https://github.com/briansipple/lightning-network-node-cluster-vscode-setup
- Owner: BrianSipple
- Created: 2018-12-07T05:15:53.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2018-12-28T07:36:48.000Z (almost 7 years ago)
- Last Synced: 2025-05-30T00:40:49.793Z (5 months ago)
- Topics: bitcoin, lightning, lightning-network, lnd, starter-kit
- Language: Shell
- Homepage:
- Size: 56.6 KB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ⚡️ Lightning Network Node Cluster VSCode Setup
This project was originally started to follow along with the official [Lightning Network Developers tutorial](https://dev.lightning.community/tutorial/), utilizing a set of VSCode task configurations.
Eventually, though, it became a more general-purpose starter skeleton for setting up a local Lightning Network node cluster, operating it with `lnd` and `lncli`, and running `bitcoind` as a background daemon.
## Basic Flow
The basic flow for operating a local LND note on your machine is as follows:
- Create a wallet
- Unlock the wallet
- Generate an address for the wallet
- Fund your wallet address
- Connect to peer nodes and open payment channels with them.
## Getting Started
### Requirements
- [lnd & lncli](https://github.com/lightningnetwork/lnd/blob/master/docs/INSTALL.md)
+ [See also](https://dev.lightning.community/guides/installation/)
- [bitcoind & bitcoin-cli](https://www.google.com/search?q=install+bitcoind)
- [jq](https://github.com/stedolan/jq) (for running [block count scripts](./bin/))
### Project Setup
The only local configuration you should need to do before getting things up and running is setting the `externalip` option in your `lnd.conf` files. [Additional `lnd.conf` tweaks](https://github.com/lightningnetwork/lnd/blob/master/sample-lnd.conf) can be made as needed.
## Taking it to Mainnet
This project is setup to use the Bitcoin Testnet by default. This is advisable until you feel comfortable with what you're doing.
When you _are_ ready to jump over to Mainnet, be sure to tweak any testnet-specific configuration settings, such as those in `lnd.conf` and the `--macaroonpath` argument in `.vscode/tasks.json`.
### Opening Channels
If you're looking to open up some initial channel connections, feel free to reach out to me at [037e7ab1c6168741e52601d1c109bcebd315c6415472c6ba746e6c3277bfff5368@71.190.202.78:9735](https://explore.casa/nodes/037e7ab1c6168741e52601d1c109bcebd315c6415472c6ba746e6c3277bfff5368).
If you open up a GitHub Issue to claim your connection (providing a funding transaction ID or node pub key), I'll do my best to reciprocate.