Fix: Key splitting command #112
Conversation
README.md
Outdated
| @@ -122,7 +122,7 @@ mkdir split_keys | |||
| # E.g., keystore-0.json keystore-0.txt | |||
|
|
|||
| # Split these keystores into "n" (--nodes) key shares with "t" (--threshold) as threshold for a distributed validator | |||
| docker run --rm -v $(pwd):/opt/charon obolnetwork/charon:v0.14.0 create cluster --split-existing-keys --split-keys-dir=/opt/charon/split_keys --threshold 4 --nodes 6 | |||
| docker run --rm -v $(pwd):/opt/charon obolnetwork/charon:v0.14.0 create cluster --name="mycluster" --withdrawal-addresses="0x000000000000000000000000000000000000dead" --fee-recipient-addresses="0x000000000000000000000000000000000000dead" --split-existing-keys --split-keys-dir=/opt/charon/split_keys --threshold 4 --nodes 6 | |||
There was a problem hiding this comment.
Hope this command is directly taken from the latest docs - https://docs.obol.tech/docs/int/quickstart/quickstart-alone#step-2-create-the-artifacts-needed-to-run-a-dv-cluster ?
There was a problem hiding this comment.
Don't think we should use 0xdead addresses, rather specify that the user should provide a proper address.
WITHDRAWAL_ADDR=<put your withdrawal here>
FEE_RECIPIENT_ADDR=<...>
docker run --rm -v $(pwd):/opt/charon obolnetwork/charon:v0.14.0 create cluster --name="mycluster" --withdrawal-addresses="${WITHDRAWAL_ADDR}" --fee-recipient-addresses="${FEE_RECIPIENT_ADDR}" --split-existing-keys --split-keys-dir=/opt/charon/split_keys --threshold 4 --nodes 6
README.md
Outdated
| @@ -122,7 +122,7 @@ mkdir split_keys | |||
| # E.g., keystore-0.json keystore-0.txt | |||
|
|
|||
| # Split these keystores into "n" (--nodes) key shares with "t" (--threshold) as threshold for a distributed validator | |||
| docker run --rm -v $(pwd):/opt/charon obolnetwork/charon:v0.14.0 create cluster --split-existing-keys --split-keys-dir=/opt/charon/split_keys --threshold 4 --nodes 6 | |||
| docker run --rm -v $(pwd):/opt/charon obolnetwork/charon:v0.14.0 create cluster --name="mycluster" --withdrawal-addresses="0x000000000000000000000000000000000000dead" --fee-recipient-addresses="0x000000000000000000000000000000000000dead" --split-existing-keys --split-keys-dir=/opt/charon/split_keys --threshold 4 --nodes 6 | |||
There was a problem hiding this comment.
Don't think we should use 0xdead addresses, rather specify that the user should provide a proper address.
WITHDRAWAL_ADDR=<put your withdrawal here>
FEE_RECIPIENT_ADDR=<...>
docker run --rm -v $(pwd):/opt/charon obolnetwork/charon:v0.14.0 create cluster --name="mycluster" --withdrawal-addresses="${WITHDRAWAL_ADDR}" --fee-recipient-addresses="${FEE_RECIPIENT_ADDR}" --split-existing-keys --split-keys-dir=/opt/charon/split_keys --threshold 4 --nodes 6
|
Hey @EridianAlpha |
|
Hey @dB2510, I've updated this PR with the variable addresses to match the updated docs. Would it be worth also adding a variable for the |
| @@ -45,8 +45,11 @@ Ensure you have [docker](https://docs.docker.com/engine/install/) and [git](http | |||
| 1. Create the artifacts needed to run a testnet distributed validator cluster | |||
|
|
|||
| ```sh | |||
| # Enter required validator addresses | |||
| WITHDRAWAL_ADDR=<ENTER YOUR WITHDRAWAL ADDRESS HERE> | |||
There was a problem hiding this comment.
can you please add FEE_RECIPIENT_ADDR and --name to this section?
| @@ -90,7 +93,10 @@ in the future. Read more about our client support [here](https://github.com/Obol | |||
| Create some testnet private keys for a six node distributed validator cluster with the command: | |||
|
|
|||
| ```sh | |||
| docker run --rm -v "$(pwd):/opt/charon" ghcr.io/obolnetwork/charon:v0.14.0 create cluster --withdrawal-address="0x000000000000000000000000000000000000dead" --nodes 6 --threshold 5 | |||
| # Enter required validator addresses | |||
| WITHDRAWAL_ADDR=<ENTER YOUR WITHDRAWAL ADDRESS HERE> | |||
There was a problem hiding this comment.
can you please add FEE_RECIPIENT_ADDR and --name to this section too?
|
Hey @EridianAlpha
I think we are fine without --name. It is not as critical as address flags. Also we cannot omit --name flag as it is a required flag. |
No description provided.