Skip to content

Commit

Permalink
docs: update instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
ppoliani committed Jan 31, 2024
1 parent 1c81c36 commit 63c1442
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
10 changes: 5 additions & 5 deletions DEVELOPER.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ docker pull imikushin/zkbitcoin

```shell
docker create --restart=always -v keys:/keys --name zkbtc-node -p 8891:8891 imikushin/zkbitcoin \
zkbtc start-committee-node \
zkbtc-admin start-committee-node \
--key-path=/keys/key.json --publickey-package-path=/keys/publickey-package.json \
--address=0.0.0.0:8891
```
Expand Down Expand Up @@ -113,19 +113,19 @@ Now re-run steps 2 and 4 from above: create the container and then start it (the
### Generate committee with trusted dealer

```shell
cargo run -- generate-committee --num 3 --threshold 2 --output-dir tests/
cargo run --bin zktbct-admin -- generate-committee --num 3 --threshold 2 --output-dir tests/
```

### Start a committee node

```shell
RUST_LOG=debug cargo run -- start-committee-node --key-path examples/committee/key-0.json --publickey-package-path examples/committee/publickey-package.json --address "127.0.0.1:8891"
RUST_LOG=debug cargo run --bin zktbct-admin -- start-committee-node --key-path examples/committee/key-0.json --publickey-package-path examples/committee/publickey-package.json --address "127.0.0.1:8891"
```

### Start an orchestrator/coordinator

```shell
RUST_LOG=debug cargo run -- start-orchestrator --publickey-package-path examples/committee/publickey-package.json --committee-cfg-path examples/committee/committee-cfg.json --address "127.0.0.1:8891"
RUST_LOG=debug cargo run --bin zktbct-admin -- start-orchestrator --publickey-package-path examples/committee/publickey-package.json --committee-cfg-path examples/committee/committee-cfg.json --address "127.0.0.1:8891"
```

then you can query it like so:
Expand Down Expand Up @@ -170,4 +170,4 @@ or with the unlock funds CLI command.
* `sudo systemctl restart nginx`
* `git clone https://github.com/sigma0-xyz/zkbitcoin`
* `cd zkbitcoin`
* `RUST_LOG=debug cargo run -- start-committee-node --key-path examples/committee/key-0.json --publickey-package-path examples/committee/publickey-package.json --address "127.0.0.1:8891"`
* `RUST_LOG=debug cargo run --bin zktbct-admin -- start-committee-node --key-path examples/committee/key-0.json --publickey-package-path examples/committee/publickey-package.json --address "127.0.0.1:8891"`
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ export RPC_AUTH="username:password"

### zkbtc: the zkBitcoin CLI

To install `zkbtc`, run the following command:
To install `zkbtc` and `zkbtc-admin`, run the following command:

```shell
cargo install --git https://github.com/sigma0-xyz/zkbitcoin.git
Expand Down

0 comments on commit 63c1442

Please sign in to comment.