Skip to content

Commit 66c8c3a

Browse files
committed
Update ADR 5 with outputs of yesterday weekly meeting
1 parent d63ec19 commit 66c8c3a

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

docs/ADR-5-cardano-testnet-node-configuration-file.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,25 +13,27 @@ Programmatic users proceed as follows instead:
1313

1414
# Decision
1515

16-
Introduce a new `conway genesis create-node-config file` command in `cardano-cli`. It will have the following options:
16+
## Add a new command in the CLI
17+
18+
Introduce a new `conway genesis check-node-config file` command in `cardano-cli`. It will have the following options:
1719

1820
```
1921
[--byron-genesis FILEPATH]
2022
[--shelley-genesis FILEPATH]
2123
[--alonzo-genesis FILEPATH]
2224
[--conway-genesis FILEPATH]
23-
[--node-config-template FILEPATH]
24-
--out-file FILEPATH
25+
[--node-config FILEPATH]
2526
```
27+
For every `--era-genesis` file, the command will read the file specified at the given `FILEPATH`, hash its content and check that the file specified at `--node-config` contains the correct path and the correct hash for this genesis file.
2628

27-
If specified, the `--byron-genesis`, `--shelley-genesis`, etc. files will be read and their content be hashed, and
28-
the output node configuration file will have the corresponding fields set. The `--node-config-template` allows to pass an existing file, which is useful if you want to augment it with the hashes. Finally the `--out-file` option is a mandatory option to specify where to write the generated node configuration file. If `--node-config-template` is omitted, the generated file will use defaults values.
29+
## Have `create-testnet-data` create the node configuration file
2930

30-
An open question is whether to add flags to tune the configuration's file content on an individual field basis. It could be nice to show what possible tuning the node's configuration file allows.
31+
1. Have `create-testnet-data` create a default node configuration file (populating it with the paths and hashes of the genesis files).
32+
2. Add a `--node-config-template` optional option to `create-testnet-data which will be used to generate the node configuration file, instead of using a default one.
3133

3234
# Consequences
3335

34-
* This will allow users that spin testnets to generate their node configuration file using `cardano-cli`
36+
* This will allow users that spin testnets to generate their node configuration file using `create-testnet-data`
3537
* As a consequence, this will avoid having to keep track of external templates
3638
* This will allow to remove some code in [cardano-testnet](https://github.com/IntersectMBO/cardano-node/blob/51a034a51c5cefdd6ab4b9ff1e71710cf0c96643/cardano-testnet/src/Testnet/Defaults.hs#L340)
3739
* It will make possible to generalize `cardano-testnet` so that it allows to pass custom node configuration files (this is [cardano-node/issues/3719](https://github.com/IntersectMBO/cardano-node/issues/3719), and to have a handy way to generate those files.

0 commit comments

Comments
 (0)