Merge pull request #6289 from IntersectMBO/nb/custom_onchain_params

Create sandbox for `cardano-testnet` with custom on-chain parameters

Author: nbacquey

cardano-testnet/CHANGELOG.md

@@ -6,6 +6,7 @@
 * [Add an option to dump/load configuration sandbox](https://github.com/IntersectMBO/cardano-node/pull/6239)
 * [Add flag to support P2P topology](https://github.com/IntersectMBO/cardano-node/pull/6263)
 * [Add flag to update time stamps in custom environment](https://github.com/IntersectMBO/cardano-node/pull/6275)
+* [Add option to create configuration sandbox with parameters from mainnet](https://github.com/IntersectMBO/cardano-node/pull/6289)
 
 ## 10.0.0
 

cardano-testnet/cardano-testnet.cabal

@@ -49,6 +49,7 @@ library
                       , cardano-ledger-binary
                       , cardano-ledger-byron
                       , cardano-ledger-conway
+                      , cardano-ledger-core
                       , cardano-ledger-api
                       , cardano-ledger-conway
                       , cardano-ledger-core:{cardano-ledger-core, testlib}
@@ -70,6 +71,7 @@ library
                       , filepath
                       , hedgehog
                       , hedgehog-extras ^>= 0.8
+                      , http-conduit
                       , lens-aeson
                       , microlens
                       , monad-control
@@ -102,6 +104,7 @@ library
   hs-source-dirs:       src
   exposed-modules:      Cardano.Testnet
                         Parsers.Run
+                        Testnet.Blockfrost
                         Testnet.Components.Configuration
                         Testnet.Components.Query
                         Testnet.Defaults
@@ -222,6 +225,7 @@ test-suite cardano-testnet-test
                         Cardano.Testnet.Test.Gov.TreasuryWithdrawal
                         Cardano.Testnet.Test.Misc
                         Cardano.Testnet.Test.Node.Shutdown
+                        Cardano.Testnet.Test.MainnetParams
                         Cardano.Testnet.Test.P2PTopology
                         Cardano.Testnet.Test.SanityCheck
                         Cardano.Testnet.Test.RunTestnet

cardano-testnet/src/Parsers/Cardano.hs

@@ -16,6 +16,7 @@ import           Control.Applicative
 import           Data.Default.Class
 import           Data.Functor
 import qualified Data.List as L
+import           Data.Maybe (fromMaybe)
 import           Data.Word (Word64)
 import           Options.Applicative (CommandFields, Mod, Parser)
 import qualified Options.Applicative as OA
@@ -29,16 +30,21 @@ optsTestnet envCli = CardanoTestnetCliOptions
   <$> pCardanoTestnetCliOptions envCli
   <*> pGenesisOptions
   <*> pNodeEnvironment
+  <*> pUpdateTimestamps
 
 optsCreateTestnet :: EnvCli -> Parser CardanoTestnetCreateEnvOptions
 optsCreateTestnet envCli = CardanoTestnetCreateEnvOptions
   <$> pCardanoTestnetCliOptions envCli
   <*> pGenesisOptions
   <*> pEnvOutputDir
-  <*> ( CreateEnvOptions
-      <$> pTopologyType
-      <*> pCreateEnvUpdateTime
-      )
+  <*> pCreateEnvOptions
+
+-- We can't fill in the optional Genesis files at parse time, because we want to be in a monad
+-- to properly parse JSON. We delegate this task to the caller.
+pCreateEnvOptions :: Parser CreateEnvOptions
+pCreateEnvOptions = CreateEnvOptions
+  <$> pOnChainParams
+  <*> pTopologyType
 
 pCardanoTestnetCliOptions :: EnvCli -> Parser CardanoTestnetOptions
 pCardanoTestnetCliOptions envCli = CardanoTestnetOptions
@@ -95,17 +101,34 @@ pNodeEnvironment = fmap (maybe NoUserProvidedEnv UserProvidedEnv) <$>
     <> OA.help "Path to the node's environment (which is generated otherwise). You can generate a default environment with the 'create-env' command, then modify it and pass it with this argument."
     )
 
+pOnChainParams :: Parser TestnetOnChainParams
+pOnChainParams = fmap (fromMaybe DefaultParams) <$> optional $
+  pCustomParamsFile <|> pMainnetParams
+
+pCustomParamsFile :: Parser TestnetOnChainParams
+pCustomParamsFile = OnChainParamsFile <$> OA.strOption
+  (  OA.long "params-file"
+  <> OA.help "File containing custom on-chain parameters in Blockfrost format:\nhttps://docs.blockfrost.io/#tag/cardano--epochs/GET/epochs/latest/parameters"
+  <> OA.metavar "FILEPATH"
+  )
+
+pMainnetParams :: Parser TestnetOnChainParams
+pMainnetParams = OA.flag' OnChainParamsMainnet
+  (  OA.long "mainnet"
+  <> OA.help "Use mainnet on-chain parameters"
+  )
+
 pTopologyType :: Parser TopologyType
 pTopologyType = OA.flag DirectTopology P2PTopology
   (  OA.long "p2p-topology"
   <> OA.help "Use P2P topology files instead of \"direct\" topology files"
   <> OA.showDefault
   )
 
-pCreateEnvUpdateTime :: Parser CreateEnvUpdateTime
-pCreateEnvUpdateTime = OA.flag CreateEnv UpdateTimeAndExit
+pUpdateTimestamps :: Parser UpdateTimestamps
+pUpdateTimestamps = OA.flag DontUpdateTimestamps UpdateTimestamps
   (  OA.long "update-time"
-  <> OA.help "Don't create anything, just update the time stamps in existing files"
+  <> OA.help "Update the time stamps in genesis files to current date"
   <> OA.showDefault
   )
 

cardano-testnet/src/Parsers/Run.hs

@@ -64,13 +64,9 @@ createEnvOptions CardanoTestnetCreateEnvOptions
   , createEnvOutputDir=outputDir
   , createEnvCreateEnvOptions=ceOptions
   } =
-    testnetRoutine (UserProvidedEnv outputDir) $ \conf ->
+    testnetRoutine (UserProvidedEnv outputDir) $ \conf -> do
       createTestnetEnv
         testnetOptions genesisOptions ceOptions
-        -- The CLI does not provide a way to provide custom genesis data by design:
-        -- If the user wants to have custom genesis data, they should manually
-        -- modify the files created by this command before running the testnet.
-        NoUserProvidedData NoUserProvidedData NoUserProvidedData
         -- Do not add hashes to the main config file, so that genesis files
         -- can be modified without having to recompute hashes every time.
         conf{genesisHashesPolicy = WithoutHashes}
@@ -80,17 +76,23 @@ runCardanoOptions CardanoTestnetCliOptions
   { cliTestnetOptions=testnetOptions@CardanoTestnetOptions{cardanoOutputDir}
   , cliGenesisOptions=genesisOptions
   , cliNodeEnvironment=env
+  , cliUpdateTimestamps=updateTimestamps
   } =
     case env of
       NoUserProvidedEnv ->
-        -- Create the sandbox, then run cardano-testnet
+        -- Create the sandbox, then run cardano-testnet.
+        -- It is not necessary to honor `cliUpdateTimestamps` here, because
+        -- the genesis files will be created with up-to-date stamps already.
         runTestnet cardanoOutputDir $ \conf -> do
           createTestnetEnv
             testnetOptions genesisOptions def
-            NoUserProvidedData NoUserProvidedData NoUserProvidedData
             conf
           cardanoTestnet testnetOptions genesisOptions conf
       UserProvidedEnv nodeEnvPath ->
         -- Run cardano-testnet in the sandbox provided by the user
         -- In that case, 'cardanoOutputDir' is not used
-        runTestnet (UserProvidedEnv nodeEnvPath) $ cardanoTestnet testnetOptions genesisOptions
+        runTestnet (UserProvidedEnv nodeEnvPath) $ \conf ->
+          cardanoTestnet
+            testnetOptions
+            genesisOptions
+            conf{updateTimestamps=updateTimestamps}