Rename TestEnableDevelopmentNetworkProtocols

TestEnableDevelopmentNetworkProtocols has been renamed to
ExperimentalProtocols. An error is thrown if
TestEnableDevelopmentNetworkProtocols is used to avoid it silently being set
to False.

Author: newhoggy

Diff for: cardano-api/ChangeLog.md

@@ -4,7 +4,9 @@
 
 ### Features
 
-- Rename TestEnableDevelopmentHardForkEras to ExperimentalHardForksEnabled ([PR 4341](https://github.com/input-output-hk/cardano-node/pull/4341))
+- Rename `TestEnableDevelopmentHardForkEras` to `ExperimentalHardForksEnabled` and
+  `TestEnableDevelopmentNetworkProtocols` to `ExperimentalProtocolsEnabled`
+  ([PR 4341](https://github.com/input-output-hk/cardano-node/pull/4341))
 
 - Append, not prepend change output when balancing a transaction ([PR 4343](https://github.com/input-output-hk/cardano-node/pull/4343))
 

Diff for: cardano-node/src/Cardano/Node/Configuration/POM.hs

@@ -116,7 +116,7 @@ data NodeConfiguration
          --
          -- This flag should be set to 'True' when testing the new protocol
          -- versions.
-       , ncTestEnableDevelopmentNetworkProtocols :: !Bool
+       , ncExperimentalProtocolsEnabled :: !Bool
 
          -- BlockFetch configuration
        , ncMaxConcurrencyBulkSync :: !(Maybe MaxConcurrencyBulkSync)
@@ -172,7 +172,7 @@ data PartialNodeConfiguration
          -- Node parameters, not protocol-specific:
        , pncDiffusionMode    :: !(Last DiffusionMode)
        , pncSnapshotInterval :: !(Last SnapshotInterval)
-       , pncTestEnableDevelopmentNetworkProtocols :: !(Last Bool)
+       , pncExperimentalProtocolsEnabled :: !(Last Bool)
 
          -- BlockFetch configuration
        , pncMaxConcurrencyBulkSync :: !(Last MaxConcurrencyBulkSync)
@@ -223,8 +223,11 @@ instance FromJSON PartialNodeConfiguration where
         <- Last . fmap getDiffusionMode <$> v .:? "DiffusionMode"
       pncSnapshotInterval
         <- Last . fmap RequestedSnapshotInterval <$> v .:? "SnapshotInterval"
-      pncTestEnableDevelopmentNetworkProtocols
-        <- Last <$> v .:? "TestEnableDevelopmentNetworkProtocols"
+      pncExperimentalProtocolsEnabled <- fmap Last $ do
+        failOnRemovedField v "TestEnableDevelopmentNetworkProtocols"
+          "TestEnableDevelopmentNetworkProtocols has been renamed to ExperimentalProtocolsEnabled"
+
+        v .:? "ExperimentalProtocolsEnabled"
 
       -- Blockfetch parameters
       pncMaxConcurrencyBulkSync <- Last <$> v .:? "MaxConcurrencyBulkSync"
@@ -288,7 +291,7 @@ instance FromJSON PartialNodeConfiguration where
            , pncSocketConfig = Last . Just $ SocketConfig mempty mempty mempty pncSocketPath
            , pncDiffusionMode
            , pncSnapshotInterval
-           , pncTestEnableDevelopmentNetworkProtocols
+           , pncExperimentalProtocolsEnabled
            , pncMaxConcurrencyBulkSync
            , pncMaxConcurrencyDeadline
            , pncLoggingSwitch = Last $ Just pncLoggingSwitch'
@@ -452,7 +455,7 @@ defaultPartialNodeConfiguration =
     , pncSocketConfig = Last . Just $ SocketConfig mempty mempty mempty mempty
     , pncDiffusionMode = Last $ Just InitiatorAndResponderDiffusionMode
     , pncSnapshotInterval = Last $ Just DefaultSnapshotInterval
-    , pncTestEnableDevelopmentNetworkProtocols = Last $ Just False
+    , pncExperimentalProtocolsEnabled = Last $ Just False
     , pncTopologyFile = Last . Just $ TopologyFile "configuration/cardano/mainnet-topology.json"
     , pncProtocolFiles = mempty
     , pncValidateDB = mempty
@@ -525,9 +528,9 @@ makeNodeConfiguration pnc = do
     $ pncEnableP2P pnc
 
   -- TODO: This is not mandatory
-  testEnableDevelopmentNetworkProtocols <-
-    lastToEither "Missing TestEnableDevelopmentNetworkProtocols" $
-      pncTestEnableDevelopmentNetworkProtocols pnc
+  experimentalProtocols <-
+    lastToEither "Missing ExperimentalProtocolsEnabled" $
+      pncExperimentalProtocolsEnabled pnc
   return $ NodeConfiguration
              { ncConfigFile = configFile
              , ncTopologyFile = topologyFile
@@ -545,7 +548,7 @@ makeNodeConfiguration pnc = do
              , ncSocketConfig = socketConfig
              , ncDiffusionMode = diffusionMode
              , ncSnapshotInterval = snapshotInterval
-             , ncTestEnableDevelopmentNetworkProtocols = testEnableDevelopmentNetworkProtocols
+             , ncExperimentalProtocolsEnabled = experimentalProtocols
              , ncMaxConcurrencyBulkSync = getLast $ pncMaxConcurrencyBulkSync pnc
              , ncMaxConcurrencyDeadline = getLast $ pncMaxConcurrencyDeadline pnc
              , ncLoggingSwitch = loggingSwitch

Diff for: cardano-node/src/Cardano/Node/Parsers.hs

@@ -88,7 +88,7 @@ nodeRunParser = do
            , pncDatabaseFile = DbFile <$> dbFp
            , pncDiffusionMode = mempty
            , pncSnapshotInterval = snapshotInterval
-           , pncTestEnableDevelopmentNetworkProtocols = mempty
+           , pncExperimentalProtocols = mempty
            , pncProtocolFiles = Last $ Just ProtocolFilepaths
              { byronCertFile
              , byronKeyFile

Diff for: cardano-node/src/Cardano/Node/Run.hs

@@ -443,7 +443,7 @@ handleSimpleNode runP p2pMode tracers nc onKernel = do
               (readTVar useLedgerVar)
               , srnDiffusionTracers            = diffusionTracers tracers
               , srnDiffusionTracersExtra       = diffusionTracersExtra tracers
-              , srnEnableInDevelopmentVersions = ncTestEnableDevelopmentNetworkProtocols nc
+              , srnEnableInDevelopmentVersions = ncExperimentalProtocols nc
               , srnTraceChainDB                = chainDBTracer tracers
               , srnMaybeMempoolCapacityOverride = ncMaybeMempoolCapacityOverride nc
               }
@@ -483,7 +483,7 @@ handleSimpleNode runP p2pMode tracers nc onKernel = do
               , srnDiffusionArgumentsExtra     = mkNonP2PArguments ipProducers dnsProducers
               , srnDiffusionTracers            = diffusionTracers tracers
               , srnDiffusionTracersExtra       = diffusionTracersExtra tracers
-              , srnEnableInDevelopmentVersions = ncTestEnableDevelopmentNetworkProtocols nc
+              , srnEnableInDevelopmentVersions = ncExperimentalProtocols nc
               , srnTraceChainDB                = chainDBTracer tracers
               , srnMaybeMempoolCapacityOverride = ncMaybeMempoolCapacityOverride nc
               }
@@ -509,13 +509,13 @@ handleSimpleNode runP p2pMode tracers nc onKernel = do
                                   $ supportedNodeToClientVersions (Proxy @blk)
             (_, Nothing)         -> Map.keys
                                   $ supportedNodeToClientVersions (Proxy @blk)
-    when (  ncTestEnableDevelopmentNetworkProtocols nc
+    when (  ncExperimentalProtocols nc
          && not (null developmentNtnVersions))
        $ traceWith (startupTracer tracers)
                    (WarningDevelopmentNodeToNodeVersions
                      developmentNtnVersions)
 
-    when (  ncTestEnableDevelopmentNetworkProtocols nc
+    when (  ncExperimentalProtocols nc
          && not (null developmentNtcVersions))
        $ traceWith (startupTracer tracers)
                    (WarningDevelopmentNodeToClientVersions
@@ -552,7 +552,7 @@ handleSimpleNode runP p2pMode tracers nc onKernel = do
     -> Map k v
     -> Map k v
   limitToLatestReleasedVersion prj =
-      if ncTestEnableDevelopmentNetworkProtocols nc then id
+      if ncExperimentalProtocols nc then id
       else
       case prj $ latestReleasedNodeVersion (Proxy @blk) of
         Nothing       -> id

Diff for: cardano-node/src/Cardano/Node/Startup.hs

@@ -103,12 +103,12 @@ data StartupTrace blk =
   -- | Warn when 'EnableP2P' is set.
   | P2PWarning
 
-  -- | Warn when 'TestEnableDevelopmentNetworkProtocols' is set and affects
+  -- | Warn when 'ExperimentalProtocolsEnabled' is set and affects
   -- node-to-node protocol.
   --
   | WarningDevelopmentNodeToNodeVersions [NodeToNodeVersion]
 
-  -- | Warn when 'TestEnableDevelopmentNetworkProtocols' is set and affects
+  -- | Warn when 'ExperimentalProtocolsEnabled' is set and affects
   -- node-to-client protocol.
   --
   | WarningDevelopmentNodeToClientVersions [NodeToClientVersion]

Diff for: cardano-node/test/Test/Cardano/Node/POM.hs

@@ -56,7 +56,7 @@ testPartialYamlConfig =
     , pncShutdownConfig = Last Nothing
     , pncDiffusionMode = Last Nothing
     , pncSnapshotInterval = mempty
-    , pncTestEnableDevelopmentNetworkProtocols = Last Nothing
+    , pncExperimentalProtocols = Last Nothing
     , pncMaxConcurrencyBulkSync = Last Nothing
     , pncMaxConcurrencyDeadline = Last Nothing
     , pncLoggingSwitch = Last $ Just True
@@ -91,7 +91,7 @@ testPartialCliConfig =
     , pncDatabaseFile = mempty
     , pncDiffusionMode = mempty
     , pncSnapshotInterval = Last . Just . RequestedSnapshotInterval $ secondsToDiffTime 100
-    , pncTestEnableDevelopmentNetworkProtocols = Last $ Just True
+    , pncExperimentalProtocols = Last $ Just True
     , pncProtocolFiles = Last . Just $ ProtocolFilepaths Nothing Nothing Nothing Nothing Nothing Nothing
     , pncValidateDB = Last $ Just True
     , pncProtocolConfig = mempty
@@ -130,7 +130,7 @@ eExpectedConfig = do
                              (GenesisFile "dummmy-genesis-file") Nothing
     , ncDiffusionMode = InitiatorAndResponderDiffusionMode
     , ncSnapshotInterval = RequestedSnapshotInterval $ secondsToDiffTime 100
-    , ncTestEnableDevelopmentNetworkProtocols = True
+    , ncExperimentalProtocols = True
     , ncMaxConcurrencyBulkSync = Nothing
     , ncMaxConcurrencyDeadline = Nothing
     , ncLoggingSwitch = True

Diff for: configuration/chairman/byron-shelley/configuration.yaml

@@ -52,7 +52,7 @@ ApplicationVersion: 1
 
 ##### Enable P2P Mode #####
 EnableP2P: False
-TestEnableDevelopmentNetworkProtocols: True
+ExperimentalProtocolsEnabled: True
 
 ##### Logging configuration #####
 

Diff for: nix/nixos/cardano-node-service.nix

@@ -24,7 +24,7 @@ let
               TargetNumberOfKnownPeers = cfg.targetNumberOfKnownPeers;
               TargetNumberOfEstablishedPeers = cfg.targetNumberOfEstablishedPeers;
               TargetNumberOfActivePeers = cfg.targetNumberOfActivePeers;
-              TestEnableDevelopmentNetworkProtocols = true;
+              ExperimentalProtocolsEnabled = true;
               MaxConcurrencyBulkSync = 2;
             })) cfg.extraNodeConfig;
         baseInstanceConfig =

Diff for: nix/workbench/backend/nixops.nix

@@ -69,7 +69,7 @@ let
                TurnOnLogMetrics = true;
 
                ExperimentalHardForksEnabled = true;
-               TestEnableDevelopmentNetworkProtocols = true;
+               ExperimentalProtocolsEnabled = true;
 
                inherit TraceBlockFetchProtocol;
 

Diff for: nix/workbench/backend/nixops/role-explorer.nix

@@ -88,7 +88,7 @@ in {
   #         "LastKnownBlockVersion-Minor"
   #         "LastKnownBlockVersion-Alt"
   #         "ExperimentalHardForksEnabled"
-  #         "TestEnableDevelopmentNetworkProtocols"
+  #         "ExperimentalProtocolsEnabled"
   #         "TestShelleyHardForkAtEpoch"
   #         "TestAllegraHardForkAtEpoch"
   #         "TestMaryHardForkAtEpoch"
@@ -148,7 +148,7 @@ in {
   #            TracingVerbosity = "NormalVerbosity";
 
   #            ExperimentalHardForksEnabled = true;
-  #            TestEnableDevelopmentNetworkProtocols = true;
+  #            ExperimentalProtocolsEnabled = true;
 
   #            TraceAcceptPolicy                 = false;
   #            TraceBlockFetchClient             = true;

Diff for: nix/workbench/service/nodes.nix

@@ -166,10 +166,10 @@ let
           ]
         //
         {
-          ExperimentalHardForksEnabled          = true;
-          TestEnableDevelopmentNetworkProtocols = true;
-          TurnOnLogMetrics                      = true;
-          SnapshotFrequency                     = 1100;
+          ExperimentalHardForksEnabled = true;
+          ExperimentalProtocolsEnabled = true;
+          TurnOnLogMetrics             = true;
+          SnapshotFrequency            = 1100;
         };
       tracing-transform = {
         trace-dispatcher = cfg:

Diff for: scripts/babbage/mkfiles.sh

@@ -106,7 +106,7 @@ $SED -i "${ROOT}/configuration.yaml" \
   echo "TestAlonzoHardForkAtEpoch: 0" >> "${ROOT}/configuration.yaml"
   echo "TestBabbageHardForkAtEpoch: 0" >> "${ROOT}/configuration.yaml"
   echo "TestConwayHardForkAtEpoch: 0" >> "${ROOT}/configuration.yaml"
-  echo "TestEnableDevelopmentNetworkProtocols: True" >> "${ROOT}/configuration.yaml"
+  echo "ExperimentalProtocolsEnabled: True" >> "${ROOT}/configuration.yaml"
 
 # Copy the cost mode
 

Diff for: scripts/byron-to-alonzo/mkfiles.sh

@@ -664,7 +664,7 @@ if [ "$1" = "alonzo" ]; then
   echo "TestMaryHardForkAtEpoch: 0" >> ${ROOT}/configuration.yaml
   echo "TestAlonzoHardForkAtEpoch: 0" >> ${ROOT}/configuration.yaml
   echo "ExperimentalHardForksEnabled: True" >> ${ROOT}/configuration.yaml
-  echo "TestEnableDevelopmentNetworkProtocols: True" >> ${ROOT}/configuration.yaml
+  echo "ExperimentalProtocolsEnabled: True" >> ${ROOT}/configuration.yaml
 
   $SED -i ${ROOT}/configuration.yaml \
       -e 's/LastKnownBlockVersion-Major: 1/LastKnownBlockVersion-Major: 5/'