cardano-testnet: add some comments

IntersectMBO · Oct 14, 2024 · 37fcfaa · 37fcfaa
1 parent 7671267
commit 37fcfaa
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 5 deletions.
diff --git a/cardano-testnet/src/Parsers/Cardano.hs b/cardano-testnet/src/Parsers/Cardano.hs
@@ -64,6 +64,8 @@ pCardanoTestnetCliOptions envCli = CardanoTestnetOptions
 
 pNumSpoNodes :: Parser [TestnetNodeOptions]
 pNumSpoNodes =
+  -- We don't support passing custom node configurations files on the CLI.
+  -- So we use a default node configuration for all nodes.
   (`L.replicate` defaultSpoOptions) <$>
     OA.option auto
     (   OA.long "num-pool-nodes"

diff --git a/cardano-testnet/src/Testnet/Runtime.hs b/cardano-testnet/src/Testnet/Runtime.hs
@@ -114,7 +114,8 @@ startNode
   -> Int
   -- ^ Testnet magic
   -> [String]
-  -- ^ The command --socket-path will be added automatically.
+  -- ^ The command to execute to start the node.
+  -- @--socket-path@, @--port@, and @--host-addr@ gets added automatically.
   -> ExceptT NodeStartFailure m NodeRuntime
 startNode tp node ipv4 port testnetMagic nodeCmd = GHC.withFrozenCallStack $ do
   let tempBaseAbsPath = makeTmpBaseAbsPath tp

diff --git a/cardano-testnet/src/Testnet/Start/Cardano.hs b/cardano-testnet/src/Testnet/Start/Cardano.hs
@@ -144,7 +144,7 @@ getDefaultShelleyGenesis asbe maxSupply opts = do
 -- > │   └── README.md
 -- > ├── drep-keys
 -- > │   ├── drep{1,2,3}
--- > │   │   └── drep.{skey,drep.vkey}
+-- > │   │   └── drep.{skey,vkey}
 -- > │   └── README.md
 -- > ├── genesis-keys
 -- > │   ├── genesis{1,2,3}
@@ -233,9 +233,6 @@ cardanoTestnet
   H.lbsWriteFile (tmpAbsPath </> "byron.genesis.spec.json")
     . encode $ Defaults.defaultByronProtocolParamsJsonValue
 
-  -- Because in Conway the overlay schedule and decentralization parameter
-  -- are deprecated, we must use the "create-staked" cli command to create
-  -- SPOs in the ShelleyGenesis
   Byron.createByronGenesis
     testnetMagic
     startTime