Update the YAML version of the mainnet config to match the JSON versi…

…on and add tests to ensure consistency between the two.
IntersectMBO · Oct 12, 2021 · ae0d335 · ae0d335
1 parent d3bb731
commit ae0d335
Show file tree

Hide file tree

Showing 3 changed files with 78 additions and 52 deletions.
diff --git a/cardano-cli/cardano-cli.cabal b/cardano-cli/cardano-cli.cabal
@@ -165,7 +165,8 @@ test-suite cardano-cli-test
   main-is:              cardano-cli-test.hs
   type:                 exitcode-stdio-1.0
 
-  build-depends:        bech32            >= 1.1.0
+  build-depends:        aeson
+                      , bech32            >= 1.1.0
                       , bytestring
                       , base16-bytestring
                       , cardano-api
@@ -182,6 +183,7 @@ test-suite cardano-cli-test
                       , parsec
                       , text
                       , transformers
+                      , yaml
 
   other-modules:        Test.Config.Mainnet
                         Test.Cli.FilePermissions

diff --git a/cardano-cli/test/Test/Config/Mainnet.hs b/cardano-cli/test/Test/Config/Mainnet.hs
@@ -1,5 +1,6 @@
 {-# LANGUAGE DisambiguateRecordFields #-}
 {-# LANGUAGE OverloadedStrings #-}
+{-# LANGUAGE ScopedTypeVariables #-}
 
 module Test.Config.Mainnet
   ( tests
@@ -12,28 +13,45 @@ import           Data.Bool (Bool(..))
 import           Data.Either (Either(..))
 import           Data.Function
 import           Data.Maybe
-import           Hedgehog (Property)
+import           Hedgehog (Property, (===))
 import           System.FilePath ((</>))
 import           System.IO (IO)
+import           Text.Show
 
+import qualified Data.Aeson as J
 import qualified Data.Text as T
+import qualified Data.Yaml as Y
 import qualified GHC.Stack as GHC
 import qualified Hedgehog as H
 import qualified Hedgehog.Extras.Test.Base as H
 import qualified Hedgehog.Extras.Test.Process as H
 import qualified System.Directory as IO
 
-hprop_configMainnet :: Property
-hprop_configMainnet = H.propertyOnce $ do
+hprop_configMainnetHash :: Property
+hprop_configMainnetHash = H.propertyOnce $ do
   projectBase <- H.note =<< H.evalIO . IO.canonicalizePath =<< H.getProjectBase
   result <- H.evalIO $ runExceptT $ initialLedgerState $ projectBase </> "configuration/cardano/mainnet-config.json"
   case result of
     Right (_, _) -> return ()
     Left e -> H.failWithCustom GHC.callStack Nothing (T.unpack (renderInitialLedgerStateError e))
 
+hprop_configMainnetYaml :: Property
+hprop_configMainnetYaml = H.propertyOnce $ do
+  projectBase <- H.note =<< H.evalIO . IO.canonicalizePath =<< H.getProjectBase
+  yamlResult <- H.evalIO . Y.decodeFileEither $ projectBase </> "configuration/cardano/mainnet-config.yaml"
+  yaml :: J.Value <- case yamlResult of
+    Right v -> return v
+    Left e -> H.failWithCustom GHC.callStack Nothing (Y.prettyPrintParseException e)
+  jsonResult <- H.evalIO . J.eitherDecodeFileStrict $ projectBase </> "configuration/cardano/mainnet-config.json"
+  json  :: J.Value <- case jsonResult of
+    Right v -> return v
+    Left e -> H.failWithCustom GHC.callStack Nothing (show e)
+  yaml === json
+
 tests :: IO Bool
 tests =
   H.checkSequential
     $ H.Group "Test.Config.Mainnet"
-        [ ("hprop_configMainnet", hprop_configMainnet)
+        [ ("hprop_configMainnetHash", hprop_configMainnetHash)
+        , ("hprop_configMainnetYaml", hprop_configMainnetYaml)
         ]
diff --git a/configuration/cardano/mainnet-config.yaml b/configuration/cardano/mainnet-config.yaml
@@ -1,51 +1,38 @@
-##########################################################
-###############          Mainnet                 #########
-############### Cardano Byron Node Configuration #########
-##########################################################
-
+################################################################################
+# Mainnet Cardano Node Configuration
 
 ##### Locations #####
 
-GenesisFile: genesis.json
-SocketPath: db/node.socket
-
-##### Blockfetch Protocol
-
-# The maximum number of used peers during bulk sync.
-MaxConcurrencyBulkSync: 1
-# The maximum number of used peers when fetching newly forged blocks.
-MaxConcurrencyDeadline: 2
-
-#TODO: These parameters cannot yet be used in the config file, only on the CLI:
-#DatabasePath: db/
-#Topology: configuration/mainnet-topology.json
-#Port 7776
+AlonzoGenesisFile: mainnet-alonzo-genesis.json
+AlonzoGenesisHash: 7e94a15f55d1e82d10f09203fa1d40f8eede58fd8066542cf6566008068ed874
+ByronGenesisFile: mainnet-byron-genesis.json
+ByronGenesisHash: 5f20df933584822601f9e3f8c024eb5eb252fe8cefb24d1317dc3d432e940ebb
+ShelleyGenesisFile: mainnet-shelley-genesis.json
+ShelleyGenesisHash: 1a3be38bcbb7911969283716ad7aa550250226b76a61fc51cc9a9a35d9276d81
 
 ##### Core protocol parameters #####
 
-# This is the instance of the Ouroboros family that we are running.
-# "RealPBFT" is the real (permissive) OBFT protocol, which is what we use on
-# mainnet in Byron era.
-Protocol: RealPBFT
+Protocol: Cardano
 
 # The mainnet does not include the network magic into addresses. Testnets do.
 RequiresNetworkMagic: RequiresNoMagic
 
-
 ##### Update system parameters #####
 
 # This protocol version number gets used by block producing nodes as part
 # of the system for agreeing on and synchronising protocol updates.
-LastKnownBlockVersion-Major: 0
-LastKnownBlockVersion-Minor: 2
+#
+# See https://github.com/input-output-hk/cardano-node/blob/master/cardano-node/src/Cardano/Node/Protocol/Cardano.hs#L199
+LastKnownBlockVersion-Major: 3
+LastKnownBlockVersion-Minor: 0
 LastKnownBlockVersion-Alt: 0
+MaxKnownMajorProtocolVersion: 2
 
 # In the Byron era some software versions are also published on the chain.
 # We do this only for Byron compatibility now.
 ApplicationName: cardano-sl
 ApplicationVersion: 1
 
-
 ##### Logging configuration #####
 
 # Enable or disable logging overall
@@ -78,7 +65,7 @@ defaultBackends:
 # EKG is a simple metrics monitoring system. Uncomment the following to enable
 # this backend and listen on the given local port and point your web browser to
 # http://localhost:12788/
-# hasEKG: 12788
+hasEKG: 12788
 
 # The Prometheus monitoring system exports EKG metrics. Uncomment the following
 # to listen on the given port. Output is provided on
@@ -116,27 +103,22 @@ defaultBackends:
 # The scribe output format can be ScText or ScJson. Log rotation settings can
 # be specified in the defaults below or overidden on a per-scribe basis here.
 setupScribes:
-  - scKind: FileSK
-    scName: "logs/mainnet.log"
-    scFormat: ScText
-
   - scKind: StdoutSK
     scName: stdout
     scFormat: ScText
+    scRotation: null
 
 # For the Katip logging backend this specifies the default scribes that trace
 # output is sent to if it is not configured to be sent to other scribes.
 defaultScribes:
-  - - FileSK
-    - "logs/mainnet.log"
   - - StdoutSK
     - stdout
 
 # The default file rotation settings for katip scribes, unless overridden
 # in the setupScribes above for specific scribes.
 rotation:
   rpLogLimitBytes: 5000000
-  rpKeepFilesNum:  3
+  rpKeepFilesNum:  10
   rpMaxAgeHours:   24
 
 
@@ -146,6 +128,8 @@ rotation:
 # settings. This provides fairly coarse grained control, but it is relatively
 # efficient at filtering out unwanted trace output.
 
+TraceAcceptPolicy: True
+
 # Trace BlockFetch client.
 TraceBlockFetchClient: False
 
@@ -162,7 +146,7 @@ TraceBlockFetchProtocolSerialised: False
 TraceBlockFetchServer: False
 
 # Trace BlockchainTime.
-TraceBlockchainTime: False
+# TraceBlockchainTime: False
 
 # Verbose tracer of ChainDB
 TraceChainDb: True
@@ -179,12 +163,16 @@ TraceChainSyncHeaderServer: False
 # Trace ChainSync protocol messages.
 TraceChainSyncProtocol: False
 
+TraceConnectionManager: True
+
 # Trace DNS Resolver messages.
 TraceDNSResolver: True
 
 # Trace DNS Subscription messages.
 TraceDNSSubscription: True
 
+TraceDiffusionInitialization: True
+
 # Trace error policy resolution.
 TraceErrorPolicy: True
 
@@ -200,6 +188,21 @@ TraceHandshake: False
 # Trace IP Subscription messages.
 TraceIpSubscription: True
 
+TraceLedgerPeers: True
+
+TraceLocalRootPeers: True
+
+TraceInboundGovernor: True
+
+TracePeerSelection: True
+
+TracePeerSelectionActions: True
+
+TracePublicRootPeers: True
+
+TraceServer: True
+
+
 # Trace local ChainSync protocol messages.
 TraceLocalChainSyncProtocol: False
 
@@ -245,15 +248,18 @@ options:
     cardano.node.metrics:
       - EKGViewBK
 
-  # redirects traced values to a specific scribe which is identified by its
-  # type and its name, separated by "::":
-  mapScribes:
+    cardano.node.resources:
+      - EKGViewBK
+
+  # # redirects traced values to a specific scribe which is identified by its
+  # # type and its name, separated by "::":
+  # mapScribes:
+  #   cardano.node.metrics:
+  #     - "FileSK::logs/mainnet.log"
+  mapSubtrace:
     cardano.node.metrics:
-      - "FileSK::logs/mainnet.log"
-
-  # apply a filter on message severity on messages in a specific named context.
-  # this filter is applied additionally to the global 'minSeverity' and thus
-  # needs to be at least as high.
-  mapSeverity:
-    cardano.node.ChainDB: Notice
-    cardano.node.DnsSubscription: Debug
+      subtrace: Neutral
+
+hasPrometheus:
+  - 127.0.0.1
+  - 12798