Skip to content

Commit d2fb869

Browse files
committed
address readme comments
1 parent 57ec247 commit d2fb869

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

crates/dkg-cli/README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,25 @@
22

33
** WARNING: This is WIP. Do not use. **
44

5-
Command-line tool for Distributed Key Generation (DKG) and key rotation protocols. A DKG process involves a coordinator and a set of participating members. Here we describe the processes for both a fresh DKG and a DKG key rotation.
5+
Command-line tool for Distributed Key Generation (DKG) and key rotation protocols. A DKG process involves a coordinator and a set of participating members. Here we describe the processes for both a fresh DKG and a key rotation.
66

77
Both fresh DKG and key rotation has 3 phases.
88

9-
- **Phase 1 (Registration)**: Members register their public keys onchain.
10-
- **Phase 2 (Message Creation)**: Members create and share DKG messages offchain.
9+
- **Phase 1 (Registration)**: Members generate and register their encryption keys onchain.- **Phase 2 (Message Creation)**: Members create and share DKG messages offchain.
1110
- **Phase 3 (Finalization)**: Members process messages, propose committee onchain.
1211

1312
The coordinator signals when to proceed from one phase to the next.
1413

1514
## Prerequisites
16-
- Install Sui (See [more](https://docs.sui.io/guides/developer/getting-started/sui-install)).
17-
- Install python
15+
16+
1. Install Sui (See [more](https://docs.sui.io/guides/developer/getting-started/sui-install)).
17+
2. Clone the [Seal](https://github.com/MystenLabs/seal) repo locally and set to working directory.
18+
3. Install python and the dependencies in `/seal`.
1819

1920
```bash
2021
brew install python # if needed
2122
cd seal/
23+
2224
# for the first time
2325
python -m venv .venv
2426
source .venv/bin/activate
@@ -55,7 +57,7 @@ COMMITTEE_PKG: 0x3358b7f7150efe9a0487ad354e5959771c56556737605848231b09cca5b791c
5557
COMMITTEE_ID: 0x46540663327da161b688786cbebbafbd32e0f344c85f8dc3bfe874c65a613418
5658
```
5759
58-
3. Share the `dkg.yaml` file with members. Announce to all members to begin Phase 1.
60+
3. Share the `dkg.yaml` file with all members. Announce to all members to begin Phase 1.
5961

6062
4. Monitor onchain state until all members are registered using the check-committee script.
6163

@@ -171,7 +173,7 @@ python crates/dkg-cli/scripts/dkg-scripts.py init-rotation -c crates/dkg-cli/scr
171173

172174
This will initialize rotation and append the new `COMMITTEE_ID` to your config. Share this file with all members.
173175

174-
2. Phase 1, 2, 3: Follow the same steps as fresh DKG. Announce each phase to members and monitor progress. Also announce DKG completion.
176+
2. Phase 1, 2, 3: Follow the same steps as fresh DKG. Announce each phase to members and monitor progress. Also announce key rotation completion.
175177

176178
#### Member Runbook
177179

0 commit comments

Comments
 (0)