Skip to content

Commit 536076a

Browse files
committed
address more readme comments
1 parent 85900a5 commit 536076a

File tree

1 file changed

+22
-15
lines changed

1 file changed

+22
-15
lines changed

crates/dkg-cli/README.md

Lines changed: 22 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -51,17 +51,18 @@ c. Members register the encryption and signing public keys, and the URL of their
5151

5252
```bash
5353
YOUR_SERVER_URL="replace your url here"
54-
sui client switch --address $ADDRESS_0 # replace your address
54+
# replace your address.
55+
sui client switch --address $ADDRESS_0
5556

5657
sui client call --package $COMMITTEE_PKG --module seal_committee \
5758
--function register \
5859
--args $COMMITTEE_ID x"$DKG_ENC_PK" x"$DKG_SIGNING_PK" "$YOUR_SERVER_URL"
5960
```
6061

61-
d. Admin notifies all members once registration is done.
62+
d. The coordinator notifies all members once registration is done.
6263

63-
e. Each member initialize the DKG protocol locally. The `/dkg-state` directory created is sensitive
64-
and contains the private keys that will be used till DKG is completed.
64+
e. Each member initialize the DKG protocol locally. The `/dkg-state` directory is created,
65+
containing private keys that will be used till DKG is completed.
6566

6667
```bash
6768
cargo run --bin dkg-cli init --my-address $ADDRESS_0 --committee-id $COMMITTEE_ID --network $NETWORK
@@ -72,8 +73,8 @@ cargo run --bin dkg-cli init --my-address $ADDRESS_0 --committee-id $COMMITTEE_I
7273

7374
### Key Rotation Steps
7475

75-
1. The coordinator proposes a list of new members and new threshold for the new committee, and pass
76-
in the old committee object ID. Share the new committee ID in output with all members.
76+
1. The coordinator creates a new Committee with a list of new members and new threshold, specifying
77+
the old committee object ID. Share the new committee ID in output with all members.
7778

7879
```bash
7980
ADDRESS_3=0x2aaadc85d1013bde04e7bff32aceaa03201627e43e3e3dd0b30521486b5c34cb
@@ -84,12 +85,14 @@ sui client call --package $COMMITTEE_PKG --module seal_committee \
8485
--function init_rotation \
8586
--args $OLD_COMMITTEE_ID 3 "[\"$ADDRESS_1\", \"$ADDRESS_0\", \"$ADDRESS_3\", \"$ADDRESS_4\"]"
8687

87-
# share this with all members.
88+
# share this new committee ID with all members.
8889
COMMITTEE_ID=0x15c4b9560ffd4922b3de98ea48cca427a376236fea86828944b3eb7e8719f856
8990
```
9091

91-
b. Members generate their ECIES and signing keypairs using CLI and set the environment variables.
92-
Same as before.
92+
b. Same as fresh DKG: Members verify that the Committee object is initialized with the expected
93+
parameters (e.g., using Sui explorer). Then, they generate encryption and signing keypairs using
94+
CLI. A `.dkg.key` with sensitive DKG private keys is generated locally. Export the public keys into
95+
environment variables for next step.
9396

9497
```bash
9598
cargo run --bin dkg-cli generate-keys
@@ -99,31 +102,35 @@ export DKG_ENC_PK=$(jq -r '.enc_pk' .dkg.key)
99102
export DKG_SIGNING_PK=$(jq -r '.signing_pk' .dkg.key)
100103
```
101104

102-
c. Members register the ECIES public key, signing public key and URL onchain. Same as before.
105+
c. Same as fresh DKG: Members register the encryption and signing public keys, and the URL of their
106+
key server.
103107

104108
```bash
105-
sui client switch --address $ADDRESS_0 # your address
109+
# replace with your address.
110+
sui client switch --address $ADDRESS_0
106111
SERVER_URL=<your_server_url>
107112

108113
sui client call --package $COMMITTEE_PKG --module seal_committee \
109114
--function register \
110115
--args $COMMITTEE_ID x"$DKG_ENC_PK" x"$DKG_SIGNING_PK" "$SERVER_URL"
111116
```
112117

113-
d. Admin notifies all members once registration is done.
118+
d. The coordinator notifies all members once registration is done.
114119

115-
e. Each member initialize the DKG protocol locally with new committee ID. The `./dkg-state`
116-
directory created is sensitive and contains the private keys that will be used till DKG is completed.
120+
e. Each member initialize the DKG protocol locally with the new committee ID. The `/dkg-state`
121+
directory is created, containing private keys that will be used till DKG is completed.
117122

118-
- For continuing member, provide the old share arg.
123+
- For continuing member, also provide `--old-share` arg.
119124

120125
```bash
126+
# replace with your address.
121127
cargo run --bin dkg-cli init --my-address $ADDRESS_0 --old-share $DKG_OLD_SHARE --committee-id $COMMITTEE_ID --network $NETWORK
122128
```
123129

124130
- For new member.
125131

126132
```bash
133+
# replace with your address.
127134
cargo run --bin dkg-cli init --my-address $ADDRESS_3 --committee-id $COMMITTEE_ID --network $NETWORK
128135
```
129136

0 commit comments

Comments
 (0)