cardano-testnet: allow to pass genesis files #5645

smelc · 2024-01-19T16:50:29Z

Description

We want to be able to tweak genesis files in cardano-testnet. This PR makes it possible to pass custom alonzo, conway, and shelley genesis files to createTestnet. A new function createTestnetDefault is introduced, that uses default genesis files for all 3.

Context

This PR replaces #5643, whose design was deemed unsatisfying.

Checklist

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

cardano-testnet/src/Testnet/Components/Configuration.hs

Jimbo4350 · 2024-01-24T14:36:30Z

cardano-testnet/src/Testnet/Defaults.hs

  let testnetMagic = cardanoTestnetMagic testnetOptions
      slotLength = cardanoSlotLength testnetOptions
      epochLength = cardanoEpochLength testnetOptions
      maxLovelaceLovelaceSupply = cardanoMaxSupply testnetOptions
-  in Api.shelleyGenesisDefaults
+  in (fromMaybe Api.shelleyGenesisDefaults mBase)


So the problem here is if a user did provide a shelley genesis we would be overriding several fields.

Yes, but this is mitigated by the additional documentation I have added in all the call chain about this.

Also, discussing a similar API with @andreabedini, this overriding is the default expectation of callers (not doing it would be the surprise!).

So I'd keep it like this.

cardano-testnet/src/Testnet/Start/Cardano.hs

cardano-testnet/test/cardano-testnet-test/Cardano/Testnet/Test/Cli/Alonzo/LeadershipSchedule.hs

Jimbo4350 · 2024-01-24T14:47:37Z

A viable option is exposing a cardanoTestnetDefault function that uses all of our defaults.

smelc · 2024-01-25T14:02:25Z

cardano-testnet/src/Testnet/Components/Configuration.hs

+  => NumPools
+  -> AnyCardanoEra -- ^ The era to use
+  -> ShelleyGenesis StandardCrypto -- ^ The shelley genesis to use.


I did this change to avoid mixing CardanoTestnetOptions and genesis files in the same signature. We should avoid having them together in a signature, because they contain duplicate data, e,g, the network magic is both in CardanoTestnetOptions and the genesis files.

So if we have them together, we are imposing on the caller to be careful to pass coherent data. This change avoids that, by using smaller types instead.

What about the ConwayGenesis and AlonzoGenesis parameters?

We should not expose the data constructor for NumPools and expose smart constructors instead: e.g numPools :: CardanoTestnetOptions -> NumPoolNodes

What about the ConwayGenesis and AlonzoGenesis parameters?

@Jimbo4350> since create-testnet-data doesn't yet take alonzo and conway genesis as CLI parameters, they do not make sense here yet. Adding them is tracked by IntersectMBO/cardano-cli#548

We should not expose the data constructor for NumPools and expose smart constructors instead: e.g numPools :: CardanoTestnetOptions -> NumPoolNodes

Done 👍

smelc · 2024-01-25T14:03:27Z

cardano-testnet/src/Testnet/Start/Cardano.hs

+cardanoTestnetDefault :: ()
+  => CardanoTestnetOptions
+  -> Conf
+  -> H.Integration TestnetRuntime


Here, we're not mixing CardanoTestnetOptions and genesis files, which is good (as I explained elsewhere). This is nice for the vast majority of callers, that don't need to be exposed to a complex API.

smelc · 2024-01-25T14:05:04Z

cardano-testnet/src/Testnet/Start/Cardano.hs

+  => CardanoTestnetOptions -- ^ The options to use. Must be consistent with the genesis files.
+  -> Conf
+  -> UTCTime -- ^ The starting time. Must be the same as the one in the shelley genesis.
+  -> ShelleyGenesis StandardCrypto -- ^ The shelley genesis to use, for example 'Defaults.defaultShelleyGenesis'.
+                                   --   Some fields are overridden by the accompanying 'CardanoTestnetOptions'.
+  -> AlonzoGenesis -- ^ The alonzo genesis to use, for example 'Defaults.defaultAlonzoGenesis'.
+  -> ConwayGenesis StandardCrypto -- ^ The conway genesis to use, for example 'Defaults.defaultConwayGenesis'.


Here we mix CardanoTestnetOptions and genesis files. So callers must be careful to provide coherent data. If they don't, they will get caught by the new checks below. Ideally, in the future, we'll want to remove fields from CardanoTestnetOptions, so that the intersection with the data of genesis files becomes empty. This a bigger change though, so I chose this version, which is an improvement already, and minimizes disturbing users.

Jimbo4350

LGTM! However you need to make the change regarding my comments about the smart constructors.

Jimbo4350 · 2024-02-01T16:07:05Z

cardano-testnet/src/Testnet/Components/Configuration.hs

+  => NumPools
+  -> AnyCardanoEra -- ^ The era to use
+  -> ShelleyGenesis StandardCrypto -- ^ The shelley genesis to use.


What about the ConwayGenesis and AlonzoGenesis parameters?

Jimbo4350 · 2024-02-01T16:07:33Z

cardano-testnet/src/Testnet/Components/Configuration.hs

  -> TmpAbsolutePath
  -> m FilePath -- ^ Shelley genesis directory
-createSPOGenesisAndFiles testnetOptions startTime (TmpAbsolutePath tempAbsPath') = do
+createSPOGenesisAndFiles NumPools {unNumPools = numPoolNodes} era shelleyGenesis (TmpAbsolutePath tempAbsPath') = do


(NumPools numPoolNodes) should be sufficient

Jimbo4350 · 2024-02-01T16:11:28Z

cardano-testnet/src/Testnet/Components/Configuration.hs

+  => NumPools
+  -> AnyCardanoEra -- ^ The era to use
+  -> ShelleyGenesis StandardCrypto -- ^ The shelley genesis to use.


We should not expose the data constructor for NumPools and expose smart constructors instead: e.g numPools :: CardanoTestnetOptions -> NumPoolNodes

smelc force-pushed the smelc/testnet-allow-passing-config-files branch 2 times, most recently from 2a2abde to f75e77d Compare January 23, 2024 11:04

smelc mentioned this pull request Jan 23, 2024

cardano-testnet-test: allow to rewrite Conway configuration #5643

Closed

3 tasks

smelc force-pushed the smelc/testnet-allow-passing-config-files branch from f75e77d to d3f8830 Compare January 23, 2024 11:07

smelc marked this pull request as ready for review January 24, 2024 10:58

Jimbo4350 requested changes Jan 24, 2024

View reviewed changes

smelc force-pushed the smelc/testnet-allow-passing-config-files branch 7 times, most recently from 731e6d9 to 84f047e Compare January 25, 2024 13:34

smelc commented Jan 25, 2024

View reviewed changes

smelc force-pushed the smelc/testnet-allow-passing-config-files branch 2 times, most recently from 18a2054 to 38c52b8 Compare February 1, 2024 13:36

Jimbo4350 approved these changes Feb 1, 2024

View reviewed changes

carbolymer approved these changes Feb 1, 2024

View reviewed changes

smelc force-pushed the smelc/testnet-allow-passing-config-files branch from 38c52b8 to e49b5c6 Compare February 1, 2024 19:55

cardano-testnet: allow to pass genesis files

73c883d

smelc force-pushed the smelc/testnet-allow-passing-config-files branch from e49b5c6 to 73c883d Compare February 1, 2024 20:00

smelc enabled auto-merge February 1, 2024 20:01

smelc added this pull request to the merge queue Feb 1, 2024

Merged via the queue into master with commit f6edc1e Feb 1, 2024
17 of 19 checks passed

smelc deleted the smelc/testnet-allow-passing-config-files branch February 1, 2024 23:25

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

cardano-testnet: allow to pass genesis files #5645

cardano-testnet: allow to pass genesis files #5645

smelc commented Jan 19, 2024 •

edited

Loading

Jimbo4350 Jan 24, 2024

smelc Jan 25, 2024

Jimbo4350 commented Jan 24, 2024 •

edited

Loading

smelc Jan 25, 2024

Jimbo4350 Feb 1, 2024

Jimbo4350 Feb 1, 2024

smelc Feb 1, 2024

smelc Feb 1, 2024

smelc Jan 25, 2024 •

edited

Loading

smelc Jan 25, 2024

Jimbo4350 left a comment

Jimbo4350 Feb 1, 2024

Jimbo4350 Feb 1, 2024

smelc Feb 1, 2024

Jimbo4350 Feb 1, 2024

cardano-testnet: allow to pass genesis files #5645

cardano-testnet: allow to pass genesis files #5645

Conversation

smelc commented Jan 19, 2024 • edited Loading

Description

Context

Checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Jimbo4350 commented Jan 24, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

smelc Jan 25, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Jimbo4350 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

smelc commented Jan 19, 2024 •

edited

Loading

Jimbo4350 commented Jan 24, 2024 •

edited

Loading

smelc Jan 25, 2024 •

edited

Loading