cardano-testnet: adapt to NetworkTopology type changes

NetworkTopology was moved to ouroboros-netowork and refactored, which causes the
following changes in cardano-testnet:
- `createTestnetEnv` now creates a concrete topology, instead of an abstract one
- `createTestnetEnv` now allocates random ports to nodes and writes them
  both to the concrete topology file and the to the nodes config directories
- `cardanoTestnet` now does not generate the ports and instead reads the ones
assigned by `createTestnetEnv` from disk

Author: geo2a

cardano-testnet/cardano-testnet.cabal

@@ -84,7 +84,7 @@ library
                       , network
                       , network-mux
                       , optparse-applicative-fork
-                      , ouroboros-network:{api, ouroboros-network} ^>= 1.0
+                      , ouroboros-network:{api, framework, ouroboros-network} ^>= 1.0
                       , cardano-diffusion:{api, cardano-diffusion} ^>= 1.0
                       , prettyprinter
                       , process
@@ -276,6 +276,7 @@ test-suite cardano-testnet-test
                       , microlens
                       , monad-control
                       , mtl
+                      , ouroboros-network:api
                       , process
                       , resourcet
                       , regex-compat

cardano-testnet/src/Parsers/Run.hs

@@ -62,7 +62,7 @@ createEnvOptions CardanoTestnetCreateEnvOptions
   , createEnvCreateEnvOptions=ceOptions
   } = do
       conf <- mkConfigAbs outputDir
-      createTestnetEnv
+      void $ createTestnetEnv
         testnetOptions genesisOptions ceOptions
         -- Do not add hashes to the main config file, so that genesis files
         -- can be modified without having to recompute hashes every time.

cardano-testnet/src/Testnet/Defaults.hs

@@ -65,17 +65,17 @@ import qualified Cardano.Ledger.Shelley as Ledger
 import           Cardano.Ledger.Shelley.Genesis
 import           Cardano.Network.PeerSelection.Bootstrap (UseBootstrapPeers (..))
 import           Cardano.Network.PeerSelection.PeerTrustable (PeerTrustable (..))
-import           Cardano.Node.Configuration.TopologyP2P (LocalRootPeersGroup (..),
-                   LocalRootPeersGroups (..), NetworkTopology (..), PublicRootPeers (..),
-                   RootConfig (..))
-import qualified Cardano.Node.Configuration.TopologyP2P as P2P
-import qualified Cardano.Node.Configuration.TopologyP2P as Topology
 import           Cardano.Tracing.Config
 import           Cardano.Network.NodeToNode (DiffusionMode (..))
 import           Ouroboros.Network.PeerSelection (AfterSlot (..), PeerAdvertise (..),
                    RelayAccessPoint (..), UseLedgerPeers (..))
 import           Ouroboros.Network.PeerSelection.State.LocalRootPeers (HotValency (..),
                    WarmValency (..))
+import           Ouroboros.Network.Diffusion.Topology (LocalRootPeersGroup (..),
+                   LocalRootPeersGroups (..), NetworkTopology (..), PublicRootPeers (..),
+                   RootConfig (..), LocalRoots (..))
+import           Cardano.Network.Diffusion.Topology (CardanoNetworkTopology)
+import           Ouroboros.Network.ConnectionManager.Types (Provenance (..))
 
 import           Prelude
 
@@ -466,27 +466,30 @@ mkProtVer (majorProtVer, minorProtVer) =
 ppProtocolVersionL' ::  Lens' (PParams Ledger.ShelleyEra) ProtVer
 ppProtocolVersionL' = Ledger.ppLensHKD . Ledger.hkdProtocolVersionL @Ledger.ShelleyEra @Identity
 
-defaultMainnetTopology :: Topology.NetworkTopology RelayAccessPoint
+defaultMainnetTopology :: CardanoNetworkTopology
 defaultMainnetTopology =
-  Topology.RealNodeTopology {
-    ntLocalRootPeersGroups = LocalRootPeersGroups [
+  NetworkTopology {
+    localRootPeersGroups = LocalRootPeersGroups [
       LocalRootPeersGroup {
-        localRoots = RootConfig {
-          rootAccessPoints =
-            [ RelayAccessDomain  "relays-new.cardano-mainnet.iohk.io" 3_001
-            ],
-          rootAdvertise = DoAdvertisePeer
+        localRoots = LocalRoots {
+            rootConfig = RootConfig {
+              rootAccessPoints =
+                [ RelayAccessDomain  "relays-new.cardano-mainnet.iohk.io" 3_001
+                ],
+              rootAdvertise = DoAdvertisePeer
+            },
+            provenance = Outbound
         },
         hotValency = 2,
         warmValency = 2,
-        trustable = IsTrustable,
-        rootDiffusionMode = InitiatorAndResponderDiffusionMode
+        rootDiffusionMode = InitiatorAndResponderDiffusionMode,
+        extraFlags = IsTrustable
       }
     ],
-    ntPublicRootPeers = [],
-    ntUseLedgerPeers = UseLedgerPeers Always,
-    ntUseBootstrapPeers = DontUseBootstrapPeers,
-    ntPeerSnapshotPath = Nothing
+    extraConfig = DontUseBootstrapPeers,
+    publicRootPeers = [],
+    useLedgerPeers = UseLedgerPeers Always,
+    peerSnapshotPath = Nothing
   }
 
 defaultGenesisFilepath :: CardanoEra a -> FilePath
@@ -596,9 +599,9 @@ defaultUtxoKeys n =
 
 
 simpleScript :: Text -> Text
-simpleScript signerRequired = 
+simpleScript signerRequired =
   "{ \"scripts\": [ { \"keyHash\": \"" <> signerRequired <> "\", \"type\": \"sig\" } ], \"type\": \"all\" }"
-  
+
 
 plutusV2Script :: Text
 plutusV2Script =
@@ -620,30 +623,33 @@ plutusV2StakeScript :: Text
 plutusV2StakeScript =
     "{ \"type\": \"PlutusScriptV2\", \"description\": \"\", \"cborHex\": \"5907655907620100003232323232323232323232323232332232323232322232325335320193333573466e1cd55cea80124000466442466002006004646464646464646464646464646666ae68cdc39aab9d500c480008cccccccccccc88888888888848cccccccccccc00403403002c02802402001c01801401000c008cd4050054d5d0a80619a80a00a9aba1500b33501401635742a014666aa030eb9405cd5d0a804999aa80c3ae501735742a01066a02803e6ae85401cccd54060081d69aba150063232323333573466e1cd55cea801240004664424660020060046464646666ae68cdc39aab9d5002480008cc8848cc00400c008cd40a9d69aba15002302b357426ae8940088c98c80b4cd5ce01701681589aab9e5001137540026ae854008c8c8c8cccd5cd19b8735573aa004900011991091980080180119a8153ad35742a00460566ae84d5d1280111931901699ab9c02e02d02b135573ca00226ea8004d5d09aba2500223263202933573805405204e26aae7940044dd50009aba1500533501475c6ae854010ccd540600708004d5d0a801999aa80c3ae200135742a004603c6ae84d5d1280111931901299ab9c026025023135744a00226ae8940044d5d1280089aba25001135744a00226ae8940044d5d1280089aba25001135744a00226ae8940044d55cf280089baa00135742a004601c6ae84d5d1280111931900b99ab9c018017015101613263201633573892010350543500016135573ca00226ea800448c88c008dd6000990009aa80a911999aab9f0012500a233500930043574200460066ae880080508c8c8cccd5cd19b8735573aa004900011991091980080180118061aba150023005357426ae8940088c98c8050cd5ce00a80a00909aab9e5001137540024646464646666ae68cdc39aab9d5004480008cccc888848cccc00401401000c008c8c8c8cccd5cd19b8735573aa0049000119910919800801801180a9aba1500233500f014357426ae8940088c98c8064cd5ce00d00c80b89aab9e5001137540026ae854010ccd54021d728039aba150033232323333573466e1d4005200423212223002004357426aae79400c8cccd5cd19b875002480088c84888c004010dd71aba135573ca00846666ae68cdc3a801a400042444006464c6403666ae7007006c06406005c4d55cea80089baa00135742a00466a016eb8d5d09aba2500223263201533573802c02a02626ae8940044d5d1280089aab9e500113754002266aa002eb9d6889119118011bab00132001355012223233335573e0044a010466a00e66442466002006004600c6aae754008c014d55cf280118021aba200301213574200222440042442446600200800624464646666ae68cdc3a800a40004642446004006600a6ae84d55cf280191999ab9a3370ea0049001109100091931900819ab9c01101000e00d135573aa00226ea80048c8c8cccd5cd19b875001480188c848888c010014c01cd5d09aab9e500323333573466e1d400920042321222230020053009357426aae7940108cccd5cd19b875003480088c848888c004014c01cd5d09aab9e500523333573466e1d40112000232122223003005375c6ae84d55cf280311931900819ab9c01101000e00d00c00b135573aa00226ea80048c8c8cccd5cd19b8735573aa004900011991091980080180118029aba15002375a6ae84d5d1280111931900619ab9c00d00c00a135573ca00226ea80048c8cccd5cd19b8735573aa002900011bae357426aae7940088c98c8028cd5ce00580500409baa001232323232323333573466e1d4005200c21222222200323333573466e1d4009200a21222222200423333573466e1d400d2008233221222222233001009008375c6ae854014dd69aba135744a00a46666ae68cdc3a8022400c4664424444444660040120106eb8d5d0a8039bae357426ae89401c8cccd5cd19b875005480108cc8848888888cc018024020c030d5d0a8049bae357426ae8940248cccd5cd19b875006480088c848888888c01c020c034d5d09aab9e500b23333573466e1d401d2000232122222223005008300e357426aae7940308c98c804ccd5ce00a00980880800780700680600589aab9d5004135573ca00626aae7940084d55cf280089baa0012323232323333573466e1d400520022333222122333001005004003375a6ae854010dd69aba15003375a6ae84d5d1280191999ab9a3370ea0049000119091180100198041aba135573ca00c464c6401866ae700340300280244d55cea80189aba25001135573ca00226ea80048c8c8cccd5cd19b875001480088c8488c00400cdd71aba135573ca00646666ae68cdc3a8012400046424460040066eb8d5d09aab9e500423263200933573801401200e00c26aae7540044dd500089119191999ab9a3370ea00290021091100091999ab9a3370ea00490011190911180180218031aba135573ca00846666ae68cdc3a801a400042444004464c6401466ae7002c02802001c0184d55cea80089baa0012323333573466e1d40052002200723333573466e1d40092000212200123263200633573800e00c00800626aae74dd5000a4c2400292010350543100122002112323001001223300330020020011\" }"
 
-defaultP2PTopology :: [adr] -> P2P.NetworkTopology adr
-defaultP2PTopology addresses = P2P.RealNodeTopology
-  { ntLocalRootPeersGroups = LocalRootPeersGroups
+defaultP2PTopology :: [RelayAccessPoint] -> CardanoNetworkTopology
+defaultP2PTopology addresses = NetworkTopology
+  { localRootPeersGroups = LocalRootPeersGroups
     { groups = [
         LocalRootPeersGroup
-          { localRoots = RootConfig
-            { rootAccessPoints = addresses
-            , rootAdvertise = DoNotAdvertisePeer
+          { localRoots = LocalRoots
+            { rootConfig = RootConfig
+              { rootAccessPoints = addresses
+              , rootAdvertise = DoNotAdvertisePeer
+              }
+            , provenance = Outbound
             }
           , hotValency = HotValency $ length addresses
           , warmValency = WarmValency $ length addresses
-          , trustable = IsTrustable
           , rootDiffusionMode = InitiatorAndResponderDiffusionMode
+          , extraFlags = IsTrustable
           }
       ]
     }
-  , ntPublicRootPeers =
+  , extraConfig = DontUseBootstrapPeers
+  , publicRootPeers =
     [ PublicRootPeers
         RootConfig
         { rootAccessPoints = []
         , rootAdvertise = DoNotAdvertisePeer
         }
     ]
-  , ntUseLedgerPeers = DontUseLedgerPeers
-  , ntUseBootstrapPeers = DontUseBootstrapPeers
-  , ntPeerSnapshotPath = Nothing
+  , useLedgerPeers = DontUseLedgerPeers
+  , peerSnapshotPath = Nothing
   }

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

@@ -35,11 +35,11 @@ import qualified Cardano.Api.Byron as Byron
 
 import           Cardano.CLI.Type.Common (SigningKeyFile)
 import           Cardano.Node.Configuration.NodeAddress (NodeAddress' (..),
-                   NodeHostIPv4Address (..))
-import qualified Cardano.Node.Configuration.TopologyP2P as P2P
+                   NodeHostIPv4Address (..), PortNumber)
 import           Cardano.Prelude (NonEmpty ((:|)), canonicalEncodePretty)
 import           Cardano.TxGenerator.Setup.NixService (NixServiceOptions (..), NodeDescription (..))
 import           Ouroboros.Network.PeerSelection.RelayAccessPoint (RelayAccessPoint (..))
+import           Cardano.Network.Diffusion.Topology (CardanoNetworkTopology)
 
 import           Prelude hiding (lines)
 
@@ -107,6 +107,7 @@ createTestnetEnv :: ()
   => HasCallStack
   => MonadIO m
   => MonadThrow m
+  => MonadFail m
   => CardanoTestnetOptions
   -> GenesisOptions
   -> CreateEnvOptions
@@ -142,14 +143,24 @@ createTestnetEnv
 
   liftIOAnnotated . LBS.writeFile configurationFile $ A.encodePretty $ Object config
 
-  -- Create network topology, with abstract IDs in lieu of addresses
+  portNumbers <- forM (NEL.zip (1 :| [2..]) cardanoNodes)
+    (\(i, _nodeOption) -> (i,) <$> H.randomPort testnetDefaultIpv4Address)
+
+  let portNumbersMap = Map.fromList (NEL.toList portNumbers)
+
+  -- Create network topology and write port files
   let nodeIds = fst <$> NEL.zip (1 :| [2..]) cardanoNodes
   forM_ nodeIds $ \i -> do
     let nodeDataDir = tmpAbsPath </> Defaults.defaultNodeDataDir i
     liftIOAnnotated $ IO.createDirectoryIfMissing True nodeDataDir
 
-    let producers = NodeId <$> NEL.filter (/= i) nodeIds
-        topology = Defaults.defaultP2PTopology producers
+    -- Write port file
+    case Map.lookup i portNumbersMap of
+      Just port -> liftIOAnnotated $ writeFile (nodeDataDir </> "port") (show port)
+      Nothing -> error $ "Port not found for node " <> show i
+
+    producers <- mapM (idToRemoteAddressP2P portNumbersMap) $ NodeId <$> NEL.filter (/= i) nodeIds
+    let topology = Defaults.defaultP2PTopology producers
     liftIOAnnotated . LBS.writeFile (nodeDataDir </> "topology.json") $ A.encodePretty topology
 
 -- | Starts a number of nodes, as configured by the value of the 'cardanoNodes'
@@ -268,38 +279,23 @@ cardanoTestnet
       , paymentKeyInfoAddr = Text.pack paymentAddr
       }
 
-  portNumbersWithNodeOptions <- forM cardanoNodes
-    (\nodeOption -> (nodeOption,) <$> H.randomPort testnetDefaultIpv4Address)
-
-  let portNumbers = NEL.zip (1 :| [2..]) $ snd <$> portNumbersWithNodeOptions
-      portNumbersMap = Map.fromList (NEL.toList portNumbers)
-
-      idToRemoteAddressP2P :: ()
-        => MonadIO m
-        => HasCallStack
-        => NodeId -> m RelayAccessPoint
-      idToRemoteAddressP2P (NodeId i) = case Map.lookup i portNumbersMap of
-        Just port -> pure $ RelayAccessAddress
-            (showIpv4Address testnetDefaultIpv4Address)
-            port
-        Nothing -> do
-          throwString $ "Found node id that was unaccounted for: " ++ show i
-
-  forM_ portNumbers $ \(i, portNumber) -> do
+  -- Read port numbers from disk (written by createTestnetEnv)
+  portNumbers <- forM (NEL.zip (1 :| [2..]) cardanoNodes) $ \(i, _nodeOption) -> do
     let nodeDataDir = tmpAbsPath </> Defaults.defaultNodeDataDir i
-    liftIOAnnotated $ IO.createDirectoryIfMissing True nodeDataDir
-    liftIOAnnotated $ writeFile (nodeDataDir </> "port") (show portNumber)
-    let topologyPath = tmpAbsPath </> Defaults.defaultNodeDataDir i </> "topology.json"
+        portPath = nodeDataDir </> "port"
+    portStr <- liftIOAnnotated $ readFile portPath
+    let port = read portStr :: PortNumber
+    let topologyPath = nodeDataDir </> "topology.json"
     tBytes <- liftIOAnnotated $ LBS.readFile topologyPath
     case eitherDecode tBytes of
-      Right (abstractTopology :: P2P.NetworkTopology NodeId) -> do
-        topology <- mapM idToRemoteAddressP2P abstractTopology
-        liftIOAnnotated $ LBS.writeFile topologyPath $ encode topology
+      Right (abstractTopology :: CardanoNetworkTopology) -> do
+        liftIOAnnotated $ LBS.writeFile topologyPath $ encode abstractTopology
       Left e -> do
         -- There can be multiple reasons for why both decodings have failed.
         -- Here we assume, very optimistically, that the user has already
         -- instantiated it with a concrete topology file.
         liftIOAnnotated . putStrLn $ "Could not decode topology file: " <> topologyPath <> ". This may be okay. Reason for decoding failure is:\n" ++ e
+    pure (i, port)
 
   -- If necessary, update the time stamps in Byron and Shelley Genesis files.
   -- This is a QoL feature so that users who edit their configuration files don't
@@ -321,7 +317,12 @@ cardanoTestnet
     let shelleyGenesis' = shelleyGenesis{sgSystemStart = startTime}
     liftIOAnnotated . LBS.writeFile shelleyGenesisFile $ A.encodePretty shelleyGenesis'
 
-  eTestnetNodes <- forConcurrently (NEL.zip (1 :| [2..]) portNumbersWithNodeOptions) $ \(i, (nodeOptions, port)) -> do
+  let portNumbersMap = Map.fromList (NEL.toList portNumbers)
+
+  eTestnetNodes <- forConcurrently (NEL.zip (1 :| [2..]) cardanoNodes) $ \(i, nodeOptions) -> do
+    port <- case Map.lookup i portNumbersMap of
+      Just p -> pure p
+      Nothing -> throwString $ "Port not found for node " <> show i
     let nodeName = Defaults.defaultNodeName i
         nodeDataDir = tmpAbsPath </> Defaults.defaultNodeDataDir i
         nodePoolKeysDir = tmpAbsPath </> Defaults.defaultSpoKeysDir i
@@ -490,6 +491,17 @@ cardanoTestnet
           throwString $ nodeName <> " was unable to produce any blocks for " <> show timeoutSeconds <> "s"
 
 
+idToRemoteAddressP2P :: ()
+  => MonadIO m
+  => HasCallStack
+  => Map.Map Int PortNumber -> NodeId -> m RelayAccessPoint
+idToRemoteAddressP2P portNumbersMap (NodeId i) = case Map.lookup i portNumbersMap of
+  Just port -> pure $ RelayAccessAddress
+      (showIpv4Address testnetDefaultIpv4Address)
+      port
+  Nothing -> do
+    throwString $ "Found node id that was unaccounted for: " ++ show i
+
 -- | A convenience wrapper around `createTestnetEnv` and `cardanoTestnet`
 createAndRunTestnet :: ()
   => HasCallStack

cardano-testnet/test/cardano-testnet-test/Cardano/Testnet/Test/Cli/KesPeriodInfo.hs

@@ -14,9 +14,9 @@ module Cardano.Testnet.Test.Cli.KesPeriodInfo
 import           Cardano.Api as Api
 
 import           Cardano.CLI.Type.Output
-import           Cardano.Node.Configuration.TopologyP2P
 import           Cardano.Testnet
 import           Cardano.Testnet.Test.Misc
+import           Ouroboros.Network.PeerSelection.RelayAccessPoint (RelayAccessPoint (..))
 
 import           Prelude
 

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

@@ -16,8 +16,8 @@ module Cardano.Testnet.Test.Cli.LeadershipSchedule
 import           Cardano.Api
 import qualified Cardano.Api as Api
 
-import           Cardano.Node.Configuration.TopologyP2P
 import           Cardano.Testnet
+import           Ouroboros.Network.PeerSelection.RelayAccessPoint (RelayAccessPoint (..))
 
 import           Prelude