🍣 Nigiri Bitcoin
Nigiri provides a selection of docker-compose
batteries included to have ready-to-use bitcoin environment thats supports different networks and sidechains.
No time to make a Nigiri yourself?
- Download and install
nigiri
command line interface
$ curl https://getnigiri.vulpem.com | bash
- Lauch Docker daemon (Mac OSX)
$ open -a Docker
$ nigiri start
Utensils
Ingredients
Directions
Preparation Time: 5 min |
Cooking Difficulty: Easy |
$ git clone https://github.com/vulpemventures/nigiri.git
- Enter project directory and install dependencies:
$ bash scripts/install
This will create ~/.nigiri
copying there the cli/resources/
directory.
# MacOSX
$ bash scripts/build darwin amd64
# Linux
$ bash scripts/build linux amd64
- Go in
build
folder, rename and move the binary and give permissions to it
$ cd build
# MacOSX
$ mv nigiri-darwin-amd64 /usr/local/bin/nigiri
$ chmod +x /usr/local/bin/nigiri
# Linux
$ mv nigiri-linux-amd64 /usr/bin/nigiri
$ chmod +x /usr/bin/nigiri
Tasting
At the moment bitcoind, liquidd and electrs are started on regtest network. testnet and mainnet compose files will be released soon.
$ nigiri start
Use the --liquid
flag to let you do experiments with the Liquid sidechain. A liquid daemon and a block explorer are also started when passing this flag.
$ nigiri stop
Use the --delete
flag to not just stop Docker containers but also to remove them and delete the config file and any new data written in volumes.
Nigiri uses the default directory ~/.nigiri
to store configuration files and docker-compose files.
To set a custom directory use the --datadir
flag.
Run the help
command to see the full list of available flags.
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.
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.