aljaz/nigiri
1
0
Fork 0
mirror of https://github.com/aljazceru/nigiri.git synced 2026-02-23 15:24:18 +01:00
Code Issues Packages Projects Releases Wiki Activity

update README

Browse Source
This commit is contained in:
altafan
2019-04-05 14:37:42 +02:00
parent 495f6f1115
commit e44ce795a1
1 changed files with 9 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@@ -37,27 +37,23 @@ nigiri $ bash scripts/build darwin amd64
At the moment bitcoind, liquidd and electrs are started on *regtest* network.
Initialize nigiri:
```bash
nigiri/build $ nigiri-linux-amd64 init
```
Initialize nigiri configuation file at at path `~/.nigiri/nigiri.config.json`.
Create and run nigiri environment:
Create nigiri environment:
```bash
nigiri/build $ nigiri-linux-amd64 create
```
This will start 3 containers for `regtest` bitcoin network that run the following services respectevely:
Nigiri uses the default directory `~/.nigiri` to store the configuration file and docker stuff.
To set a custom directory use the `--datadir` flag, but do not forget to always pass this flag to other commands, just as you do with your `bitcoind`.
The environment will start with 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/`.
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.
Start/Stop nigiri:
@@ -71,6 +67,8 @@ Stop and delete nigiri environment:
nigiri/build $ nigiri-linux-amd64 delete
```
This command stops and deletes any active contained and deletes the configuration file and all the Docker-generated files and directories.
## Nutrition Facts
The [list](https://github.com/blockstream/esplora/blob/master/API.md) of all available endpoints can be extended with one more `POST /faucet` which expects a body `{ "address": <receiving_address> }` by enabling faucet.