Move types/functions to cardano-testnet

Author: nbacquey

cardano-node/src/Cardano/Node/Configuration/Topology.hs

@@ -11,7 +11,6 @@ module Cardano.Node.Configuration.Topology
   , NodeHostIPv4Address(..)
   , NodeHostIPv6Address(..)
   , NodeSetup(..)
-  , NodeId(..)
   , RemoteAddress(..)
   , nodeAddressToSockAddr
   , readTopologyFile
@@ -28,7 +27,6 @@ import           Ouroboros.Consensus.Util.Condense (Condense (..))
 import           Control.Exception (Exception (..), IOException)
 import qualified Control.Exception as Exception
 import           Data.Aeson
-import           Data.Aeson.Types (parseFail)
 import           Data.Bifunctor (Bifunctor (..))
 import qualified Data.ByteString as BS
 import qualified Data.ByteString.Lazy.Char8 as LBS
@@ -59,19 +57,6 @@ data RemoteAddress = RemoteAddress
   -- a Boolean value, @0@ means to ignore the address;
   } deriving (Eq, Ord, Show)
 
-newtype NodeId = NodeId Int
-  deriving (Eq, Ord, Show)
-
-instance ToJSON NodeId where
-  toJSON (NodeId i) = String $ Text.pack $ "node_" ++ show i
-
-instance FromJSON NodeId where
-  parseJSON = withText "NodeId" $ \t -> case Text.breakOn "_" t of
-    ("node", textId) -> case eitherDecodeStrictText textId of
-      Right i -> pure $ NodeId i
-      Left _ -> parseFail $ "Incorrect format for NodeId: " ++ show t
-    _ -> parseFail $ "Incorrect format for NodeId: " ++ show t
-
 -- | Parse 'raAddress' field as an IP address; if it parses and the valency is
 -- non zero return corresponding NodeAddress.
 --

cardano-node/src/Cardano/Node/Configuration/TopologyP2P.hs

@@ -19,7 +19,6 @@ module Cardano.Node.Configuration.TopologyP2P
   , NodeHostIPv6Address(..)
   , NodeSetup(..)
   , PeerAdvertise(..)
-  , defaultTopology
   , nodeAddressToSockAddr
   , readTopologyFile
   , readPeerSnapshotFile
@@ -297,34 +296,6 @@ readPeerSnapshotFile  (PeerSnapshotFile peerSnapshotFile) =
   where
     handleException = handleAny $ \e -> error $ "Cardano.Node.Configuration.TopologyP2P.readPeerSnapshotFile: " <> displayException e
 
-defaultTopology :: [adr] -> NetworkTopology adr
-defaultTopology addresses = RealNodeTopology
-  { ntLocalRootPeersGroups = LocalRootPeersGroups
-    { groups = [
-        LocalRootPeersGroup
-          { localRoots = RootConfig
-            { rootAccessPoints = addresses
-            , rootAdvertise = DoNotAdvertisePeer
-            }
-          , hotValency = HotValency 1
-          , warmValency = WarmValency 1
-          , trustable = IsTrustable
-          , rootDiffusionMode = InitiatorAndResponderDiffusionMode
-          }
-      ]
-    }
-  , ntPublicRootPeers =
-    [ PublicRootPeers
-        RootConfig
-        { rootAccessPoints = []
-        , rootAdvertise = DoNotAdvertisePeer
-        }
-    ]
-  , ntUseLedgerPeers = DontUseLedgerPeers
-  , ntUseBootstrapPeers = DontUseBootstrapPeers
-  , ntPeerSnapshotPath = Nothing
-  }
-
 --
 -- Checking for chance of progress in bootstrap phase
 --

cardano-testnet/src/Testnet/Defaults.hs

@@ -23,6 +23,7 @@ module Testnet.Defaults
   , defaultDelegatorStakeKeyPair
   , defaultNodeName
   , defaultNodeDataDir
+  , defaultP2PTopology
   , defaultSpoColdKeyPair
   , defaultSpoColdVKeyFp
   , defaultSpoColdSKeyFp
@@ -56,8 +57,19 @@ import qualified Cardano.Ledger.Core as Ledger
 import qualified Cardano.Ledger.Plutus as Ledger
 import qualified Cardano.Ledger.Shelley as Ledger
 import           Cardano.Ledger.Shelley.Genesis
-import           Cardano.Node.Configuration.Topology
+import           Cardano.Network.PeerSelection.Bootstrap (UseBootstrapPeers (..))
+import           Cardano.Network.PeerSelection.PeerTrustable (PeerTrustable (..))
+import qualified Cardano.Node.Configuration.Topology as Topology
+import           Cardano.Node.Configuration.Topology (RemoteAddress(..))
+import qualified Cardano.Node.Configuration.TopologyP2P as P2P
+import           Cardano.Node.Configuration.TopologyP2P (LocalRootPeersGroups (..),
+                   LocalRootPeersGroup (..), NetworkTopology(..), PublicRootPeers (..),
+                   RootConfig (..))
 import           Cardano.Tracing.Config
+import           Ouroboros.Network.NodeToNode (DiffusionMode (..), PeerAdvertise (..))
+import           Ouroboros.Network.PeerSelection.LedgerPeers.Type (UseLedgerPeers (..))
+import           Ouroboros.Network.PeerSelection.State.LocalRootPeers (HotValency (..),
+                   WarmValency (..))
 
 import           Prelude
 
@@ -428,14 +440,14 @@ mkProtVer (majorProtVer, minorProtVer) =
 ppProtocolVersionL' ::  Lens' (PParams Ledger.ShelleyEra) ProtVer
 ppProtocolVersionL' = Ledger.ppLens . Ledger.hkdProtocolVersionL @Ledger.ShelleyEra @Identity
 
-defaultMainnetTopology :: NetworkTopology RemoteAddress
+defaultMainnetTopology :: Topology.NetworkTopology RemoteAddress
 defaultMainnetTopology =
   let single = RemoteAddress
          { raAddress  = "relays-new.cardano-mainnet.iohk.io"
          , raPort     = 3_001
          , raValency  = 2
          }
-  in RealNodeTopology [single]
+  in Topology.RealNodeTopology [single]
 
 defaultGenesisFilepath :: CardanoEra a -> FilePath
 defaultGenesisFilepath era =
@@ -557,3 +569,30 @@ plutusV2StakeScript :: Text
 plutusV2StakeScript =
     "{ \"type\": \"PlutusScriptV2\", \"description\": \"\", \"cborHex\": \"5907655907620100003232323232323232323232323232332232323232322232325335320193333573466e1cd55cea80124000466442466002006004646464646464646464646464646666ae68cdc39aab9d500c480008cccccccccccc88888888888848cccccccccccc00403403002c02802402001c01801401000c008cd4050054d5d0a80619a80a00a9aba1500b33501401635742a014666aa030eb9405cd5d0a804999aa80c3ae501735742a01066a02803e6ae85401cccd54060081d69aba150063232323333573466e1cd55cea801240004664424660020060046464646666ae68cdc39aab9d5002480008cc8848cc00400c008cd40a9d69aba15002302b357426ae8940088c98c80b4cd5ce01701681589aab9e5001137540026ae854008c8c8c8cccd5cd19b8735573aa004900011991091980080180119a8153ad35742a00460566ae84d5d1280111931901699ab9c02e02d02b135573ca00226ea8004d5d09aba2500223263202933573805405204e26aae7940044dd50009aba1500533501475c6ae854010ccd540600708004d5d0a801999aa80c3ae200135742a004603c6ae84d5d1280111931901299ab9c026025023135744a00226ae8940044d5d1280089aba25001135744a00226ae8940044d5d1280089aba25001135744a00226ae8940044d55cf280089baa00135742a004601c6ae84d5d1280111931900b99ab9c018017015101613263201633573892010350543500016135573ca00226ea800448c88c008dd6000990009aa80a911999aab9f0012500a233500930043574200460066ae880080508c8c8cccd5cd19b8735573aa004900011991091980080180118061aba150023005357426ae8940088c98c8050cd5ce00a80a00909aab9e5001137540024646464646666ae68cdc39aab9d5004480008cccc888848cccc00401401000c008c8c8c8cccd5cd19b8735573aa0049000119910919800801801180a9aba1500233500f014357426ae8940088c98c8064cd5ce00d00c80b89aab9e5001137540026ae854010ccd54021d728039aba150033232323333573466e1d4005200423212223002004357426aae79400c8cccd5cd19b875002480088c84888c004010dd71aba135573ca00846666ae68cdc3a801a400042444006464c6403666ae7007006c06406005c4d55cea80089baa00135742a00466a016eb8d5d09aba2500223263201533573802c02a02626ae8940044d5d1280089aab9e500113754002266aa002eb9d6889119118011bab00132001355012223233335573e0044a010466a00e66442466002006004600c6aae754008c014d55cf280118021aba200301213574200222440042442446600200800624464646666ae68cdc3a800a40004642446004006600a6ae84d55cf280191999ab9a3370ea0049001109100091931900819ab9c01101000e00d135573aa00226ea80048c8c8cccd5cd19b875001480188c848888c010014c01cd5d09aab9e500323333573466e1d400920042321222230020053009357426aae7940108cccd5cd19b875003480088c848888c004014c01cd5d09aab9e500523333573466e1d40112000232122223003005375c6ae84d55cf280311931900819ab9c01101000e00d00c00b135573aa00226ea80048c8c8cccd5cd19b8735573aa004900011991091980080180118029aba15002375a6ae84d5d1280111931900619ab9c00d00c00a135573ca00226ea80048c8cccd5cd19b8735573aa002900011bae357426aae7940088c98c8028cd5ce00580500409baa001232323232323333573466e1d4005200c21222222200323333573466e1d4009200a21222222200423333573466e1d400d2008233221222222233001009008375c6ae854014dd69aba135744a00a46666ae68cdc3a8022400c4664424444444660040120106eb8d5d0a8039bae357426ae89401c8cccd5cd19b875005480108cc8848888888cc018024020c030d5d0a8049bae357426ae8940248cccd5cd19b875006480088c848888888c01c020c034d5d09aab9e500b23333573466e1d401d2000232122222223005008300e357426aae7940308c98c804ccd5ce00a00980880800780700680600589aab9d5004135573ca00626aae7940084d55cf280089baa0012323232323333573466e1d400520022333222122333001005004003375a6ae854010dd69aba15003375a6ae84d5d1280191999ab9a3370ea0049000119091180100198041aba135573ca00c464c6401866ae700340300280244d55cea80189aba25001135573ca00226ea80048c8c8cccd5cd19b875001480088c8488c00400cdd71aba135573ca00646666ae68cdc3a8012400046424460040066eb8d5d09aab9e500423263200933573801401200e00c26aae7540044dd500089119191999ab9a3370ea00290021091100091999ab9a3370ea00490011190911180180218031aba135573ca00846666ae68cdc3a801a400042444004464c6401466ae7002c02802001c0184d55cea80089baa0012323333573466e1d40052002200723333573466e1d40092000212200123263200633573800e00c00800626aae74dd5000a4c2400292010350543100122002112323001001223300330020020011\" }"
 
+defaultP2PTopology :: [adr] -> P2P.NetworkTopology adr
+defaultP2PTopology addresses = P2P.RealNodeTopology
+  { ntLocalRootPeersGroups = LocalRootPeersGroups
+    { groups = [
+        LocalRootPeersGroup
+          { localRoots = RootConfig
+            { rootAccessPoints = addresses
+            , rootAdvertise = DoNotAdvertisePeer
+            }
+          , hotValency = HotValency 1
+          , warmValency = WarmValency 1
+          , trustable = IsTrustable
+          , rootDiffusionMode = InitiatorAndResponderDiffusionMode
+          }
+      ]
+    }
+  , ntPublicRootPeers =
+    [ PublicRootPeers
+        RootConfig
+        { rootAccessPoints = []
+        , rootAdvertise = DoNotAdvertisePeer
+        }
+    ]
+  , ntUseLedgerPeers = DontUseLedgerPeers
+  , ntUseBootstrapPeers = DontUseBootstrapPeers
+  , ntPeerSnapshotPath = Nothing
+  }

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

@@ -30,7 +30,7 @@ import           Cardano.Api
 
 import           Cardano.Ledger.Alonzo.Genesis (AlonzoGenesis)
 import           Cardano.Ledger.Conway.Genesis (ConwayGenesis)
-import           Cardano.Node.Configuration.Topology (NodeId(..), RemoteAddress(..))
+import           Cardano.Node.Configuration.Topology (RemoteAddress(..))
 import qualified Cardano.Node.Configuration.Topology as Direct
 import qualified Cardano.Node.Configuration.TopologyP2P as P2P
 import           Ouroboros.Network.PeerSelection.RelayAccessPoint (RelayAccessPoint(..))
@@ -137,7 +137,7 @@ createTestnetEnv
         let topology = Direct.RealNodeTopology producers
         in H.lbsWriteFile (nodeDataDir </> "topology.json") $ A.encodePretty topology
       P2PTopology ->
-        let topology = P2P.defaultTopology producers
+        let topology = Defaults.defaultP2PTopology producers
         in H.lbsWriteFile (nodeDataDir </> "topology.json") $ A.encodePretty topology
 
 -- | Starts a number of nodes, as configured by the value of the 'cardanoNodes'

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

@@ -2,13 +2,15 @@
 {-# LANGUAGE DerivingVia #-}
 {-# LANGUAGE NamedFieldPuns #-}
 {-# LANGUAGE NumericUnderscores #-}
+{-# LANGUAGE OverloadedStrings #-}
 {-# LANGUAGE ScopedTypeVariables #-}
 
 module Testnet.Start.Types
   ( CardanoTestnetCliOptions(..)
   , CardanoTestnetCreateEnvOptions (..)
   , CardanoTestnetOptions(..)
   , InputNodeConfigFile(..)
+  , NodeId(..)
   , NumDReps(..)
   , NumPools(..)
   , NumRelays(..)
@@ -39,8 +41,11 @@ import           Cardano.Api hiding (cardanoEra)
 
 import           Prelude
 
+import qualified Data.Aeson as Aeson
+import           Data.Aeson.Types (parseFail)
 import           Data.Char (toLower)
 import           Data.Default.Class
+import qualified Data.Text as Text
 import           Data.Word
 import           GHC.Stack
 import           System.FilePath (addTrailingPathSeparator)
@@ -83,6 +88,21 @@ data TopologyType
 instance Default TopologyType where
   def = DirectTopology
 
+-- | An abstract node id, used as placeholder in topology files
+-- when the actual ports/addresses aren't known yet (i.e. before runtime)
+newtype NodeId = NodeId Int
+  deriving (Eq, Ord, Show)
+
+instance ToJSON NodeId where
+  toJSON (NodeId i) = Aeson.String $ Text.pack $ "node_" ++ show i
+
+instance FromJSON NodeId where
+  parseJSON = Aeson.withText "NodeId" $ \t -> case Text.breakOn "_" t of
+    ("node", textId) -> case Aeson.eitherDecodeStrictText (Text.drop 1 textId) of
+      Right i -> pure $ NodeId i
+      Left _ -> parseFail $ "Incorrect format for NodeId: " ++ show t
+    _ -> parseFail $ "Incorrect format for NodeId: " ++ show t
+
 data CardanoTestnetCreateEnvOptions = CardanoTestnetCreateEnvOptions
   { createEnvTestnetOptions :: CardanoTestnetOptions
   , createEnvGenesisOptions :: GenesisOptions

cardano-testnet/test/cardano-testnet-test/Cardano/Testnet/Test/P2PTopology.hs

@@ -9,7 +9,6 @@ module Cardano.Testnet.Test.P2PTopology
 
 import           Cardano.Api (BlockNo (..), ChainTip (..))
 import           Cardano.CLI.Type.Output (QueryTipLocalStateOutput (..))
-import           Cardano.Node.Configuration.Topology (NodeId)
 import qualified Cardano.Node.Configuration.TopologyP2P as P2P
 import           Cardano.Testnet hiding (shelleyGenesisFile)
 
@@ -24,7 +23,7 @@ import qualified System.Process as IO
 
 import           Testnet.Process.Run (execCli', mkExecConfig)
 import           Testnet.Property.Util (integrationRetryWorkspace)
-import           Testnet.Start.Types (GenesisOptions (..),
+import           Testnet.Start.Types (GenesisOptions (..), NodeId,
                    UserProvidedData (..), UserProvidedEnv (..), TopologyType (..))
 
 import           Hedgehog ((===))