Add check-node-configuration command

[smelc]

Note

Needs IntersectMBO/cardano-api#652

Changelog

- description: |
    Add the `debug check--node-configuration --node-configuration-file node-config.json` command
    that reads `node-config.json` and checks that the hashes of genesis files are correct.

    It accepts the `--fix` flag to correct (or fill in) the hashes in place if they are wrong (or missing).
# uncomment types applicable to the change:
  type:
  - feature        # introduces a new feature
  # - breaking       # the API has changed in a breaking way
  # - compatible     # the API has changed but is non-breaking
  # - optimisation   # measurable performance improvements
  # - refactoring    # QoL changes
  # - bugfix         # fixes a defect
  # - test           # fixes/modifies tests
  # - maintenance    # not directly related to the code
  # - release        # related to a new release preparation
  # - documentation  # change in code docs, haddocks...

Context

• Fixes Add check-node-configuration command #922
• Decision to write this command taken in Add ADR for generating node configuration files with cardano-cli input-output-hk/cardano-node-wiki#52

How to trust this PR

Try it yourself:

TBD

Checklist

• Commit sequence broadly makes sense and commits have useful messages
• New tests are added if needed and existing tests are updated. See Running tests for more details
• Self-reviewed the diff

[carbolymer]

LGTM. I think I'll leave the approval to @Jimbo4350

[smelc]

Putting back to draft while I change the code to use NodeConfig.

[smelc]

@Jimbo4350, @carbolymer> done that: #923 (comment)

However, the code still needs to use the vanilla Aeson.Value version of the node configuration, to write it back (when --fix is passed). We need that, because, as NodeConfig only covers a subset of the node's configuration file, we would only write back this subset when fixing the file.

Nevertheless, this version using NodeConfig for deserialization is way better than the initial one, because indeed we don't have to check the shape of what we read from disk.

[Jimbo4350]

We're doing a validation of the node configuration file. Why not use https://hackage.haskell.org/package/validation?

[smelc]

We don't depend on validation yet and I believe this simple use case does not justify adding an external dependency.

[Jimbo4350]

Use the experimental api interface here. We don't care about previous eras.

[smelc]

This parameter isn't about the era we support, it's about the era whose hash we want to validate. I updated the haddock to make this explicit, as this indeed is an usual use case for us.

[Jimbo4350]

We only care about mainnet and the upcoming era and therefore the configuration files associated with those eras which include Byron, Shelley, Alonzo and Conway genesis files/hashes. I.e we check all for the presence of all of theses things in the Conway era. If another genesis file is added in an upcoming era then we would add that additional check for the upcoming era. Currently there are a bunch of irrelevant cases that return Nothing which we can totally exclude by not parameterizing on AnyCardanoEra.

[Jimbo4350]

Create standalone functions that retrieve the genesis files and hashes from the node configuration. Pattern matching on the eras exposed by the experimental and calling the relevant functions will simplify this code.

[smelc]

As I wrote in #923 (comment), this code doesn't depend on the era, so using the experimental API here doesn't help.

[Jimbo4350]

#923 (comment)

Also we need to come up with a better name than Analysis.

[smelc]

Also we need to come up with a better name than Analysis.

Renamed to CheckGenesisAnalysis, but please note that this name is not exported, so using a short name was fine IMO 🙂