Cl/testnetdata

[CarlosLopezDeLara]

Changelog

- description: | 
    This PR improves `create-testnet-data` cmd so that it takes testnet magic either from template file or from the  CLI flag `--testnet-magic`, when used.   
# 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
  - improvement    # QoL changes e.g. refactoring
  # - 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

Resolves #591

How to trust this PR

Passing a network magic via the flag overrides the value on the template file

carlos@focus:~/GitHub/cardano-cli$ cabal run cardano-cli -- conway genesis create-testnet-data --spec-shelley configuration/cardano/mainnet-shelley-genesis.json --out-dir out128 --testnet-magic 128
Resolving dependencies...
carlos@focus:~/GitHub/cardano-cli$ cat out128/genesis.json | jq .networkMagic
128

Using template file without using the --testnet-magic flag takes the value from the template

carlos@focus:~/GitHub/cardano-cli$ cabal run cardano-cli -- conway genesis create-testnet-data --spec-shelley configuration/cardano/mainnet-shelley-genesis.json --out-dir outnoflag
Resolving dependencies...
carlos@focus:~/GitHub/cardano-cli$ cat outnoflag/genesis.json | jq .networkMagic
764824073

If no template is used the default template is used instead.

cabal run cardano-cli -- conway genesis create-testnet-data --out-dir outdefault
Resolving dependencies...
carlos@focus:~/GitHub/cardano-cli$ cat outdefault/genesis.json | jq .networkMagic42

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. Nice!

[Jimbo4350]

You should update the parser's help text so the user knows this value will override the genesis file's value.

[smelc]

@CarlosLopezDeLara> when you do so, you will need to regenerate the golden files as follows:

RECREATE_GOLDEN_FILES=1 cabal test all

[smelc]

@CarlosLopezDeLara> when you do so, you will need to regenerate the golden files as follows:

RECREATE_GOLDEN_FILES=1 cabal test all

[CarlosLopezDeLara]

Addressing @Jimbo4350 comments about updating the parser.

We were using pNetworkId :: EnvCli -> Parser NetworkId which is used by al commands that talk to the node. So instead now we introduce

pGenesisCreateTestNetData :: Parser (GenesisCmds era)
pGenesisCreateTestNetData =
  fmap GenesisCreateTestNetData $ GenesisCreateTestNetDataCmdArgs
    <$> (optional $ pSpecFile "shelley")
...
    <*> optional pNetworkIdForTestnetData
...
  where
    pNetworkIdForTestnetData :: Parser NetworkId 
    pNetworkIdForTestnetData = Testnet . NetworkMagic <$> testnetMagicParser
      where
        testnetMagicParser = Opt.option (bounded "TESTNET_MAGIC")
          (  Opt.long "testnet-magic"
          <> Opt.metavar "NATURAL"
          <> Opt.help "Specify a testnet magic id for the cluster. Overrides the network id supplied in the spec file."
          )

This allows for better options, i.e.:

• Not giving --mainnet as an option for create-testnet-data (we want to create testnets, not mainnets),
• Avoid the hanging pure <$> maybeToList (envCliNetworkId envCli) from pNetworkId which does not make sense here,
• Showing a better help. In the genesis commands the networkId has an entirely different use (setting the magic for the cluster, not for node-to-client)

[CarlosLopezDeLara]

With that last changes now we have:

$ cabal run cardano-cli -- conway genesis create-testnet-data --spec-shelley configuration/cardano/mainnet-shelley-genesis.json --out-dir outFromSpecFile
Resolving dependencies...
$ cat outFromSpecFile/genesis.json | jq  .networkMagic
764824073
$ cabal run cardano-cli -- conway genesis create-testnet-data --spec-shelley configuration/cardano/mainnet-shelley-genesis.json --out-dir outFromFlag --testnet-magic 13579
Resolving dependencies...
$ cat outFromFlag/genesis.json | jq  .networkMagic
13579
$ export CARDANO_NODE_NETWORK_ID=24680
$ cabal run cardano-cli -- conway genesis create-testnet-data --spec-shelley configuration/cardano/mainnet-shelley-genesis.json --out-dir outFromEnv 
Resolving dependencies...
$ cat outFromEnv/genesis.json | jq  .networkMagic
24680
$ cabal run cardano-cli -- conway genesis create-testnet-data --spec-shelley configuration/cardano/mainnet-shelley-genesis.json --out-dir outFromFlagOverridesEnv --testnet-magic 9999999 
Resolving dependencies...
$ cat outFromFlagOverridesEnv/genesis.json | jq  .networkMagic
9999999

And help menu looks like this:

Usage: cardano-cli conway genesis create-testnet-data [--spec-shelley FILE]
                                                        [--genesis-keys INT]
                                                        [--pools INT]
                                                        [ --stake-delegators INT
                                                        | --transient-stake-delegators INT
                                                        ]
                                                        [--drep-keys INT]
                                                        [--stuffed-utxo INT]
                                                        [--utxo-keys INT]
                                                        [--total-supply LOVELACE]
                                                        [--delegated-supply LOVELACE]
                                                        [--testnet-magic NATURAL]
                                                        [--start-time UTC-TIME]
                                                        --out-dir DIR

  Create data to use for starting a testnet.

Available options:
  ...
  --testnet-magic NATURAL  Specify a testnet magic id for the cluster. This
                           overrides both the network magic from the spec file
                           and CARDANO_NODE_NETWORK_ID environment variable.
...

[Jimbo4350]

LGTM!