Merge pull request #6132 from IntersectMBO/smelc/do-not-use-create-testnet-data-genesis-when-user-provided-one

cardano-testnet: Use user-specified genesis files (if any) instead of the one generated by create-testnet-data

Author: smelc

cardano-testnet/src/Cardano/Testnet.hs

@@ -13,7 +13,7 @@ module Cardano.Testnet (
   TestnetNodeOptions(..),
   cardanoDefaultTestnetNodeOptions,
   getDefaultAlonzoGenesis,
-  getDefaultShelleyGenesis,
+  getDefaultGenesisBatch,
 
   -- * Configuration
   Conf(..),

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

@@ -17,14 +17,11 @@ module Testnet.Components.Configuration
   , eraToString
   ) where
 
-import           Cardano.Api.Ledger (StandardCrypto)
 import           Cardano.Api.Shelley hiding (Value, cardanoEra)
 
 import           Cardano.Chain.Genesis (GenesisHash (unGenesisHash), readGenesisData)
 import qualified Cardano.Crypto.Hash.Blake2b as Crypto
 import qualified Cardano.Crypto.Hash.Class as Crypto
-import           Cardano.Ledger.Alonzo.Genesis (AlonzoGenesis)
-import           Cardano.Ledger.Conway.Genesis (ConwayGenesis)
 import qualified Cardano.Node.Configuration.Topology as NonP2P
 import qualified Cardano.Node.Configuration.TopologyP2P as P2P
 import           Ouroboros.Network.NodeToNode (DiffusionMode (..))
@@ -57,8 +54,8 @@ import           System.FilePath.Posix (takeDirectory, (</>))
 import           Testnet.Defaults
 import           Testnet.Filepath
 import           Testnet.Process.Run (execCli_)
-import           Testnet.Start.Types (NumDReps (..), NumPools (..), anyEraToString,
-                   anyShelleyBasedEraToString, eraToString)
+import           Testnet.Start.Types (GenesisBatch (..), GenesisOrigin (..), NumDReps (..),
+                   NumPools (..), anyEraToString, anyShelleyBasedEraToString, eraToString)
 
 import           Hedgehog
 import qualified Hedgehog as H
@@ -121,13 +118,13 @@ createSPOGenesisAndFiles
   -> NumDReps -- ^ The number of pools to make
   -> Word64 -- ^ The maximum supply
   -> AnyShelleyBasedEra -- ^ The era to use
-  -> ShelleyGenesis StandardCrypto -- ^ The shelley genesis to use.
-  -> AlonzoGenesis -- ^ The alonzo genesis to use, for example 'getDefaultAlonzoGenesis' from this module.
-  -> ConwayGenesis StandardCrypto -- ^ The conway genesis to use, for example 'Defaults.defaultConwayGenesis'.
+  -> GenesisBatch -- ^ The genesis to use, with their origin (whether they ar provided by the user or defaulted by 'cardano-testnet')
   -> TmpAbsolutePath
   -> m FilePath -- ^ Shelley genesis directory
-createSPOGenesisAndFiles nPoolNodes nDelReps maxSupply asbe@(AnyShelleyBasedEra sbe) shelleyGenesis
-                         alonzoGenesis conwayGenesis (TmpAbsolutePath tempAbsPath) = GHC.withFrozenCallStack $ do
+createSPOGenesisAndFiles
+  nPoolNodes nDelReps maxSupply asbe@(AnyShelleyBasedEra sbe)
+  (GenesisBatch (shelleyGenesis, alonzoGenesis, conwayGenesis, genesisOrigin))
+  (TmpAbsolutePath tempAbsPath) = GHC.withFrozenCallStack $ do
   let inputGenesisShelleyFp = tempAbsPath </> genesisInputFilepath ShelleyEra
       inputGenesisAlonzoFp  = tempAbsPath </> genesisInputFilepath AlonzoEra
       inputGenesisConwayFp  = tempAbsPath </> genesisInputFilepath ConwayEra
@@ -179,6 +176,15 @@ createSPOGenesisAndFiles nPoolNodes nDelReps maxSupply asbe@(AnyShelleyBasedEra
     , "--out-dir", tempAbsPath
     ]
 
+  -- Overwrite the genesis files created by create-testnet-data with the files
+  -- specified by the user (if any)
+  case genesisOrigin of
+    DefaultedOrigin -> pure ()
+    UserProvidedOrigin -> do
+      overwriteCreateTestnetDataGenesis inputGenesisShelleyFp ShelleyEra
+      overwriteCreateTestnetDataGenesis inputGenesisAlonzoFp AlonzoEra
+      overwriteCreateTestnetDataGenesis inputGenesisConwayFp ConwayEra
+
   -- Remove the input files. We don't need them anymore, since create-testnet-data wrote new versions.
   forM_ [inputGenesisShelleyFp, inputGenesisAlonzoFp, inputGenesisConwayFp] (liftIO . System.removeFile)
 
@@ -188,6 +194,12 @@ createSPOGenesisAndFiles nPoolNodes nDelReps maxSupply asbe@(AnyShelleyBasedEra
   return genesisShelleyDir
   where
     genesisInputFilepath e = "genesis-input." <> eraToString e <> ".json"
+    -- Overwrites the genesis file created by create-testnet-data with the one provided by the user
+    overwriteCreateTestnetDataGenesis ::
+      Pretty (eon era) => MonadTest m => MonadIO m =>
+      FilePath -> eon era -> m ()
+    overwriteCreateTestnetDataGenesis genesisFp e =
+        H.copyFile genesisFp (tempAbsPath </> eraToString e <> "-genesis.json")
 
 ifaceAddress :: String
 ifaceAddress = "127.0.0.1"

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

@@ -19,8 +19,8 @@ module Testnet.Start.Cardano
 
   , cardanoTestnet
   , cardanoTestnetDefault
-  , getDefaultAlonzoGenesis
-  , getDefaultShelleyGenesis
+  , getDefaultAlonzoGenesis -- TODO, stop exporting me when Shutdown.hs is refactored to use cardanoTestnet
+  , getDefaultGenesisBatch
   , retryOnAddressInUseError
   ) where
 
@@ -29,7 +29,6 @@ import           Cardano.Api
 import           Cardano.Api.Ledger (StandardCrypto)
 
 import           Cardano.Ledger.Alonzo.Genesis (AlonzoGenesis)
-import           Cardano.Ledger.Conway.Genesis (ConwayGenesis)
 import           Cardano.Node.Configuration.Topology
 
 import           Prelude hiding (lines)
@@ -88,6 +87,7 @@ startTimeOffsetSeconds = if OS.isWin32 then 90 else 15
 -- | Like 'cardanoTestnet', but using 'GenesisOptions' to obtain
 -- the genesis files, instead of passing them directly.
 -- See 'cardanoTestnet' for additional documentation.
+-- TODO delete me? @cardano-testnet@ plus @getDefaultGenesisBatch@ suffice now.
 cardanoTestnetDefault
   :: ()
   => HasCallStack
@@ -96,12 +96,8 @@ cardanoTestnetDefault
   -> Conf
   -> H.Integration TestnetRuntime
 cardanoTestnetDefault testnetOptions shelleyOptions conf = do
-  AnyShelleyBasedEra sbe <- pure cardanoNodeEra
-  alonzoGenesis <- getDefaultAlonzoGenesis sbe
-  shelleyGenesis <- getDefaultShelleyGenesis cardanoNodeEra cardanoMaxSupply shelleyOptions
-  cardanoTestnet testnetOptions conf UserNodeConfigNotSubmitted shelleyGenesis alonzoGenesis Defaults.defaultConwayGenesis
-  where
-    CardanoTestnetOptions{cardanoNodeEra, cardanoMaxSupply} = testnetOptions
+  batch <- getDefaultGenesisBatch testnetOptions shelleyOptions
+  cardanoTestnet testnetOptions conf UserNodeConfigNotSubmitted batch
 
 -- | An 'AlonzoGenesis' value that is fit to pass to 'cardanoTestnet'
 getDefaultAlonzoGenesis :: ()
@@ -125,6 +121,23 @@ getDefaultShelleyGenesis asbe maxSupply opts = do
   startTime <- H.noteShow $ DTC.addUTCTime startTimeOffsetSeconds currentTime
   return $ Defaults.defaultShelleyGenesis asbe startTime maxSupply opts
 
+-- | Get a 'GenesisBatch' that is fit to pass to 'cardanoTestnet'
+getDefaultGenesisBatch
+  :: ()
+  => HasCallStack
+  => MonadIO m
+  => MonadTest m
+  => CardanoTestnetOptions
+  -> GenesisOptions
+  -> m GenesisBatch
+getDefaultGenesisBatch testnetOptions shelleyOptions = do
+  AnyShelleyBasedEra sbe <- pure cardanoNodeEra
+  alonzoGenesis <- getDefaultAlonzoGenesis sbe
+  shelleyGenesis <- getDefaultShelleyGenesis cardanoNodeEra cardanoMaxSupply shelleyOptions
+  return (GenesisBatch (shelleyGenesis, alonzoGenesis, Defaults.defaultConwayGenesis, DefaultedOrigin))
+  where
+    CardanoTestnetOptions{cardanoNodeEra, cardanoMaxSupply} = testnetOptions
+
 -- | Setup a number of credentials and nodes (SPOs and relays), like this:
 --
 -- > ├── byron-gen-command
@@ -194,14 +207,15 @@ cardanoTestnet :: ()
   => CardanoTestnetOptions -- ^ The options to use
   -> Conf
   -> UserNodeConfig -- ^ The node configuration file to use. If omitted it's generated.
-  -> ShelleyGenesis StandardCrypto -- ^ The shelley genesis to use, for example 'getDefaultShelleyGenesis' from this module.
-                                   --   Some fields are overridden by the accompanying 'CardanoTestnetOptions'.
-  -> AlonzoGenesis -- ^ The alonzo genesis to use, for example 'getDefaultAlonzoGenesis' from this module.
-  -> ConwayGenesis StandardCrypto -- ^ The conway genesis to use, for example 'Defaults.defaultConwayGenesis'.
+  -> GenesisBatch
+     -- ^ The shelley genesis to use, for example 'getDefaultShelleyGenesis' from this module,
+     --   and whether they ar provided by the user or defaulted by 'cardano-testnet'.
+     --   Some fields are overridden by the accompanying 'CardanoTestnetOptions' (TODO: don't override
+     --   anything when the user provided the files)
   -> H.Integration TestnetRuntime
 cardanoTestnet
   testnetOptions Conf{tempAbsPath=TmpAbsolutePath tmpAbsPath} mNodeConfigFile
-  shelleyGenesis alonzoGenesis conwayGenesis = do
+  genesisBatch@(GenesisBatch (shelleyGenesis, alonzoGenesis, conwayGenesis, _)) = do
   let CardanoTestnetOptions
         { cardanoNodeEra=asbe
         , cardanoMaxSupply=maxSupply
@@ -225,7 +239,7 @@ cardanoTestnet
   writeGenesisSpecFile "alonzo" alonzoGenesis
   writeGenesisSpecFile "conway" conwayGenesis
 
-  _ <- createSPOGenesisAndFiles nPools nDReps maxSupply asbe shelleyGenesis alonzoGenesis conwayGenesis (TmpAbsolutePath tmpAbsPath)
+  _ <- createSPOGenesisAndFiles nPools nDReps maxSupply asbe genesisBatch (TmpAbsolutePath tmpAbsPath)
 
   -- TODO: This should come from the configuration!
   let makePathsAbsolute :: (Element a ~ FilePath, MonoFunctor a) => a -> a

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

@@ -23,7 +23,9 @@ module Testnet.Start.Types
   , isSpoNodeOptions
   , isRelayNodeOptions
   , cardanoDefaultTestnetNodeOptions
+  , GenesisBatch(..)
   , GenesisOptions(..)
+  , GenesisOrigin(..)
 
   , NodeLoggingFormat(..)
   , Conf(..)
@@ -33,6 +35,11 @@ module Testnet.Start.Types
   ) where
 
 import           Cardano.Api hiding (cardanoEra)
+import           Cardano.Api.Ledger (StandardCrypto)
+
+import           Cardano.Ledger.Alonzo.Genesis
+import           Cardano.Ledger.Conway.Genesis
+import           Cardano.Ledger.Shelley.Genesis
 
 import           Prelude
 
@@ -139,6 +146,14 @@ data UserNodeConfig =
   UserNodeConfigNotSubmitted
   | UserNodeConfig FilePath
 
+-- | Type to track if a genesis file was provided by the user or defaulted by @cardano-testnet@.
+data GenesisOrigin =
+  UserProvidedOrigin -- ^ Caller of @cardano-tesnet@ provided the genesis files
+  | DefaultedOrigin -- ^ Genesis file provided by @cardano-testnet@ itself
+
+-- | Type to bundle all genesis files, whether provided by the user or defaulted by @cardano-testnet@.
+newtype GenesisBatch = GenesisBatch (ShelleyGenesis StandardCrypto, AlonzoGenesis, ConwayGenesis StandardCrypto, GenesisOrigin)
+
 -- | Get extra CLI arguments passed to the node executable
 testnetNodeExtraCliArgs :: TestnetNodeOptions -> [String]
 testnetNodeExtraCliArgs (SpoNodeOptions args) = args

cardano-testnet/test/cardano-testnet-test/Cardano/Testnet/Test/Gov/NoConfidence.hs

@@ -104,14 +104,8 @@ hprop_gov_no_confidence = integrationWorkspace "no-confidence" $ \tempAbsBasePat
       committeeThreshold = unsafeBoundedRational 0.5
       committee = L.Committee (Map.fromList [(comKeyCred1, EpochNo 100)]) committeeThreshold
 
-  alonzoGenesis <- getDefaultAlonzoGenesis sbe
-  shelleyGenesis' <-
-    getDefaultShelleyGenesis
-      asbe
-      (cardanoMaxSupply fastTestnetOptions)
-      shelleyOptions
-  let conwayGenesisWithCommittee =
-        defaultConwayGenesis { L.cgCommittee = committee }
+  GenesisBatch(shelleyGenesis', alonzoGenesis, conwayGenesis, _) <- getDefaultGenesisBatch fastTestnetOptions shelleyOptions
+  let conwayGenesisWithCommittee = conwayGenesis { L.cgCommittee = committee }
 
   TestnetRuntime
     { testnetMagic
@@ -120,8 +114,8 @@ hprop_gov_no_confidence = integrationWorkspace "no-confidence" $ \tempAbsBasePat
     , configurationFile
     } <- cardanoTestnet
            fastTestnetOptions
-           conf UserNodeConfigNotSubmitted shelleyGenesis'
-           alonzoGenesis conwayGenesisWithCommittee
+           conf UserNodeConfigNotSubmitted
+           (GenesisBatch (shelleyGenesis', alonzoGenesis, conwayGenesisWithCommittee, UserProvidedOrigin))
 
   poolNode1 <- H.headM testnetNodes
   poolSprocket1 <- H.noteShow $ nodeSprocket poolNode1