Overblock is a development example website for receiving bitcoin lightning payments, inspired by Acinq's starblocks.
See the guides for a walkthrough. But please note:
- The project is in development and they may be slightly out of date
- Production guides are coming later
A live version can be viewed at overblock.dev.
Overblock is written as a collection of microservices. Since some of the
dependencies are executables (such as btcd and lnd), it's nice to separate
the concerns and just wrap them in containers. It would also be easier to
scale.
The microservices are listed in the ./docker-compose.yaml file.
| Microservice | Purpose |
|---|---|
btc |
The bitcoin node. |
lnd |
The lightning node. |
lnd-gateway |
Websocket API server, makes gRPC calls to lnd. |
web |
Basic web server serving up flat files, written in React and compiled with Webpack. |
Optional microservices
| Microservice | Purpose |
|---|---|
rtl |
Ride the Lightning, a web interface for managing the lightning node. |
Build and run all services:
docker-compose up
Building will take some time, and it will take btcd up to a day or two to
sync the testnet blockchain. Before then, behavior of the web app is undefined.
The guides go into depth about what each service does and why, configuration, and local development.