Skip to content

Commit 0d68e17

Browse files
committed
Add aggregator 'genesis' command doc
1 parent f8dbd4e commit 0d68e17

File tree

1 file changed

+75
-0
lines changed

1 file changed

+75
-0
lines changed

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

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -161,6 +161,81 @@ Run 'serve' command in release with a custom configuration via env vars
161161
GENESIS_VERIFICATION_KEY=$(wget -q -O - **YOUR_GENESIS_VERIFICATION_KEY**) RUN_INTERVAL=60000 NETWORK=**YOUR_CARDANO_NETWORK** ./mithril-aggregator serve
162162
```
163163

164+
## Release build and run binary 'genesis' command
165+
166+
Build in release with default configuration
167+
168+
```bash
169+
make build
170+
```
171+
172+
Display the help menu
173+
174+
```bash
175+
./mithril-aggregator genesis --help
176+
```
177+
178+
You should see
179+
180+
```bash
181+
mithril-aggregator-genesis
182+
Aggregator runs in Genesis tools mode
183+
USAGE:
184+
mithril-aggregator genesis <SUBCOMMAND>
185+
OPTIONS:
186+
-h, --help Print help information
187+
SUBCOMMANDS:
188+
bootstrap Bootstrap a genesis certificate Test only usage
189+
export Export payload to sign with genesis secret key
190+
help Print this message or the help of the given subcommand(s)
191+
import Import payload signed with genesis secret key and create & import a genesis certificate
192+
```
193+
194+
Run 'genesis bootstrap' command in release with default configuration, **only in test mode**.
195+
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.
196+
197+
```bash
198+
./mithril-aggregator genesis bootstrap
199+
```
200+
201+
Or with a specific `Genesis Secret Key`, **only in test mode**.
202+
203+
```bash
204+
./mithril-aggregator genesis bootstrap --genesis-secret-key **YOUR_SECRET_KEY*
205+
```
206+
207+
Run 'genesis export' command in release with default configuration.
208+
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`.
209+
210+
```bash
211+
./mithril-aggregator genesis export
212+
```
213+
214+
Or with a custom export path (to override the default value `./mithril-genesis-payload.txt`)
215+
216+
```bash
217+
./mithril-aggregator genesis export --target-path **YOUR_TARGET_PATH**
218+
```
219+
220+
Run 'genesis import' command in release with default configuration.
221+
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.
222+
223+
```bash
224+
./mithril-aggregator genesis import
225+
```
226+
227+
Or with a custom export path (to override the default value `./mithril-genesis-signed-payload.txt`)
228+
229+
```bash
230+
./mithril-aggregator genesis import --signed-payload-path **YOUR_SIGNED_PAYLOAD_PATH**
231+
```
232+
233+
Run 'genesis import' command in release with a custom configuration via env vars
234+
235+
```bash
236+
GENESIS_VERIFICATION_KEY=$(wget -q -O - **YOUR_GENESIS_VERIFICATION_KEY**) RUN_INTERVAL=60000 NETWORK=**YOUR_CARDANO_NETWORK** ./mithril-aggregator genesis import
237+
```
238+
164239
## Release build and run binary 'era' command
165240

166241
Build in release with default configuration

0 commit comments

Comments
 (0)