Skip to content

Commit 9f1f880

Browse files
committed
Update aggregator docs
1 parent ab53275 commit 9f1f880

File tree

1 file changed

+25
-13
lines changed

1 file changed

+25
-13
lines changed

docs/root/manual/developer-docs/nodes/mithril-aggregator.md

+25-13
Original file line numberDiff line numberDiff line change
@@ -190,6 +190,8 @@ SUBCOMMANDS:
190190
import Import payload signed with genesis secret key and create & import a genesis certificate
191191
```
192192

193+
### bootstrap sub-command (test-only)
194+
193195
Run 'genesis bootstrap' command in release with default configuration, **only in test mode**.
194196
This allows the Mithril Aggregator node to bootstrap a `Genesis Certificate`. After this operation, the Mithril Aggregator will be able to produce new snapshots and certificates.
195197

@@ -203,27 +205,28 @@ Or with a specific `Genesis Secret Key`, **only in test mode**.
203205
./mithril-aggregator genesis bootstrap --genesis-secret-key **YOUR_SECRET_KEY*
204206
```
205207

206-
Run 'genesis export' command in release with default configuration.
207-
This allows the Mithril Aggregator node to export the `Genesis Payload` that needs to be signed (and later reimported) of the `Genesis Certificate`. The signature of the `Genesis Payload` must be done manually with the owner of the `Genesis Secret Key`.
208-
209-
```bash
210-
./mithril-aggregator genesis export
211-
```
208+
### export sub-command
212209

213-
Or with a custom export path (to override the default value `./mithril-genesis-payload.txt`)
210+
Run 'genesis export' command in release.
211+
This allows the Mithril Aggregator node to export the `Genesis Payload` that needs to be signed (and later reimported) of the `Genesis Certificate`. The signature of the `Genesis Payload` must be done manually with the owner of the `Genesis Secret Key`.
214212

215213
```bash
216214
./mithril-aggregator genesis export --target-path **YOUR_TARGET_PATH**
217215
```
218216

219-
Run 'genesis import' command in release with default configuration.
220-
This allows the Mithril Aggregator node to import the signed payload of the `Genesis Certificate` and create it in the store. After this operation, the Mithril Aggregator will be able to produce new snapshots and certificates.
217+
### sign sub-command
218+
219+
Run 'genesis sign' command in release.
220+
This allows the Mithril Aggregator node to sign the `Genesis Payload` that needs to be reimported. The signature of the `Genesis Payload` must be done manually by the owner of the `Genesis Secret Key`.
221221

222222
```bash
223-
./mithril-aggregator genesis import
223+
./mithril-aggregator genesis sign --to-sign-payload-path **TO_SIGN_PAYLOAD_PATH** --target-signed-payload-path **TARGET_SIGNED_PAYLOAD_PATH** --genesis-secret-key-path **GENESIS_SECRET_KEY_PATH**
224224
```
225225

226-
Or with a custom export path (to override the default value `./mithril-genesis-signed-payload.txt`)
226+
### import sub-command
227+
228+
Run 'genesis import' command in release.
229+
This allows the Mithril Aggregator node to import the signed payload of the `Genesis Certificate` and create it in the store. After this operation, the Mithril Aggregator will be able to produce new snapshots and certificates.
227230

228231
```bash
229232
./mithril-aggregator genesis import --signed-payload-path **YOUR_SIGNED_PAYLOAD_PATH**
@@ -397,6 +400,7 @@ Here are the subcommands available:
397400
| **serve** | Aggregator runs its HTTP server in nominal mode and orchestrates multi signatures production |
398401
| **help** | Print this message or the help of the given subcommand(s) |
399402
| **genesis export** | Export genesis payload to sign with genesis secret key |
403+
| **genesis sign** | Sign genesis payload with genesis secret key |
400404
| **genesis import** | Import genesis signature (payload signed with genesis secret key) and create & import a genesis certificate in the store |
401405
| **genesis bootstrap** | Bootstrap a genesis certificate (test only usage) |
402406
| **era list** | List the supported eras |
@@ -450,17 +454,25 @@ General parameters:
450454
|-----------|---------------------|:---------------------:|----------------------|-------------|---------------|---------|:---------:|
451455
| `genesis_secret_key` | - | - | `GENESIS_SECRET_KEY` | Genesis secret key, :warning: for test only | - | - | - |
452456

457+
`genesis export` command:
458+
459+
| Parameter | Command Line (long) | Command Line (short) | Environment Variable | Description | Default Value | Example | Mandatory |
460+
|-----------|---------------------|:---------------------:|----------------------|-------------|---------------|---------|:---------:|
461+
| `target_path` | `--target-path` | - | - | Path of the file to export the payload to. | - | - | - | - |
462+
453463
`genesis import` command:
454464

455465
| Parameter | Command Line (long) | Command Line (short) | Environment Variable | Description | Default Value | Example | Mandatory |
456466
|-----------|---------------------|:---------------------:|----------------------|-------------|---------------|---------|:---------:|
457467
| `signed_payload_path` | `--signed-payload-path` | - | - | Path of the payload to import. | - | - | - | - |
458468

459-
`genesis export` command:
469+
`genesis sign` command:
460470

461471
| Parameter | Command Line (long) | Command Line (short) | Environment Variable | Description | Default Value | Example | Mandatory |
462472
|-----------|---------------------|:---------------------:|----------------------|-------------|---------------|---------|:---------:|
463-
| `target_path` | `--target-path` | - | - | Path of the file to export the payload to. | - | - | - | - |
473+
| `to_sign_payload_path` | `--to-sign-payload-path` | - | - | Path of the payload to sign. | - | - | - | - |
474+
| `target_signed_payload_path` | `--target-signed-payload-path` | - | - | Path of the signed payload to export. | - | - | - | - |
475+
| `genesis_secret_key_path` | `--genesis-secret-key-path` | - | - | Path of the Genesis secret key. | - | - | - |
464476

465477
`era list` command:
466478

0 commit comments

Comments
 (0)