🍣 Nigiri Bitcoin
A dockerized environment hosting a bitcoin and liquid daemons in regtest network with an electrum server that indexes and keeps track of all UTXOs.
Utensils
Ingredients
Directions
| Preparation Time: 5 min | Cooking Difficulty: Easy |
|---|
Clone the repo:
$ git clone https://github.com/vulpemventures/nigiri.git
Enter project directory and install dependencies:
nigiri $ bash scripts/install
Build binary (Mac version):
nigiri $ bash scripts/build darwin amd64
At the moment bitcoind, liquidd and electrs are started on regtest network.
Initialize nigiri:
nigiri/build $ nigiri-linux-amd64 init
Initialize nigiri configuation file at at path ~/.nigiri/nigiri.config.json.
Create and run nigiri environment:
nigiri/build $ nigiri-linux-amd64 create
This will start 3 containers for regtest bitcoin network that run the following services respectevely:
- bitcoin daemon
- electrs REST server
- API passthrough with optional faucet and mining capabilities (nigiri-chopsticks)
After command has finished, nigiri start listening at http://localhost:3000/.
Start/Stop nigiri:
nigiri/build $ nigiri-linux-amd64 start|stop
Stop and delete nigiri environment:
nigiri/build $ nigiri-linux-amd64 delete
Nutrition Facts
The list of all available endpoints can be extended with one more POST /faucet which expects a body { "address": <receiving_address> } by enabling faucet.
Footnotes
If you really do love Sathoshi's favourite dish like us at Vulpem Ventures, check the real recipe out and enjoy your own, delicious, hand made nigiri sushi.
Roadmap
- router
- electrum server
- bitcoin daemon
- liquid daemon
- faucet