Merge #330

330: Transaction generator: specify target nodes without topology. r=CodiePP a=denisshevchenko

#329

Since #318 is going to eliminate `TopologyInfo` type, tx generator has to avoid such a dependency. Currently tx generator uses `--target-node-id`s only for extracting corresponding IPs/ports from topology file, so now it should receive `--target-node` CLI parameter with not `NodeId`, but with explicit IP/port, for example: `--target-node ("127.0.0.1",3002)`.

Co-authored-by: Denis Shevchenko <denis.shevchenko@iohk.io>

Author: iohk-bors[bot]

cardano-node/app/cardano-cli.hs

@@ -1,3 +1,5 @@
+{-# LANGUAGE OverloadedStrings #-}
+
 import           Cardano.Prelude hiding (option)
 import           Prelude (String, error, id)
 
@@ -7,12 +9,14 @@ import qualified Data.List.NonEmpty as NE
 import           Data.Text
 import           Data.Time (UTCTime)
 import           Data.Time.Clock.POSIX (posixSecondsToUTCTime)
+import           Network.Socket (PortNumber)
 import qualified Options.Applicative as Opt
 import           Options.Applicative (Parser, ParserInfo, ParserPrefs, auto,
                                       commandGroup, flag, flag', help, long,
                                       metavar, option, showHelpOnEmpty,
                                       strOption, subparser, value)
 import           System.Exit (exitFailure)
+import           Text.Read (readMaybe)
 
 import           Cardano.Binary (Annotated (..))
 import           Cardano.Chain.Common
@@ -30,6 +34,7 @@ import           Cardano.Config.Partial (PartialCardanoConfiguration (..),
                                          mkCardanoConfiguration)
 import           Cardano.Config.Presets (mainnetConfiguration)
 import           Cardano.Config.Protocol (Protocol)
+import           Cardano.Config.Topology (NodeAddress (..), NodeHostAddress (..))
 import           Cardano.Config.Types (CardanoEnvironment (..), GenesisFile(..),
                                        RequireNetworkMagic)
 import           Cardano.Crypto ( AProtocolMagic(..)
@@ -334,9 +339,12 @@ parseTxRelatedValues =
         "generate-txs"
         "Launch transactions generator."
         $ GenerateTxs
-            <$> parseTargetNodeIds
-                  "target-node-id"
-                  "Identifiers of nodes transactions will be sent to."
+            <$> (NE.fromList <$> some (
+                  parseTargetNodeAddress
+                    "target-node"
+                    "host and port of the node transactions will be sent to."
+                  )
+                )
             <*> parseNumberOfTxs
                   "num-of-txs"
                   "Number of transactions generator will create."
@@ -461,6 +469,19 @@ parseFlag def active optname desc =
   flag def active $ long optname <> help desc
 
 
+parseTargetNodeAddress :: String -> String -> Parser NodeAddress
+parseTargetNodeAddress optname desc =
+  option
+    ( uncurry NodeAddress
+      . Control.Arrow.first cliParseHostAddress
+      . Control.Arrow.second cliParsePort
+      <$> auto
+    )
+    $ long optname
+      <> metavar "(HOST,PORT)"
+      <> help desc
+
+
 -- | Here, we hope to get away with the usage of 'error' in a pure expression,
 --   because the CLI-originated values are either used, in which case the error is
 --   unavoidable rather early in the CLI tooling scenario (and especially so, if
@@ -485,6 +506,13 @@ cliParseTxId =
   either (error . ("Bad Lovelace value: " <>) . show) id
   . decodeHash . pack
 
+cliParseHostAddress :: String -> NodeHostAddress
+cliParseHostAddress = NodeHostAddress . Just .
+  maybe (error "Bad host of target node") id . readMaybe
+
+cliParsePort :: Word16 -> PortNumber
+cliParsePort = fromIntegral
+
 parseAddress :: String -> String -> Parser Address
 parseAddress opt desc =
   option (cliParseBase58Address <$> auto)
@@ -557,9 +585,6 @@ parseNewTxFile opt =
   NewTxFile
     <$> parseFilePath opt "Non-existent file to write the signed transaction to."
 
-parseTargetNodeIds :: String -> String -> Parser [TargetNodeId]
-parseTargetNodeIds opt desc = many $ TargetNodeId <$> parseIntegral opt desc
-
 parseNumberOfTxs :: String -> String -> Parser NumberOfTxs
 parseNumberOfTxs opt desc = NumberOfTxs <$> parseIntegral opt desc
 
@@ -579,4 +604,4 @@ parseTxAdditionalSize :: String -> String -> Parser TxAdditionalSize
 parseTxAdditionalSize opt desc = TxAdditionalSize <$> parseIntegral opt desc
 
 parseSigningKeysFiles :: String -> String -> Parser [SigningKeyFile]
-parseSigningKeysFiles opt desc = many $ SigningKeyFile <$> parseFilePath opt desc
+parseSigningKeysFiles opt desc = some $ SigningKeyFile <$> parseFilePath opt desc

cardano-node/cardano-node.cabal

@@ -243,6 +243,8 @@ executable cardano-cli
                      , cardano-ledger
                      , cardano-prelude
                      , cardano-node
+                     , iproute
+                     , network
                      , optparse-applicative
                      , ouroboros-consensus
                      , safe-exceptions

cardano-node/src/Cardano/CLI/Run.hs

@@ -30,7 +30,6 @@ module Cardano.CLI.Run (
   , NewCertificateFile(..)
   , TxFile(..)
   , NewTxFile(..)
-  , TargetNodeId(..)
   , NumberOfTxs(..)
   , NumberOfInputsPerTx(..)
   , NumberOfOutputsPerTx(..)
@@ -71,8 +70,7 @@ import           Cardano.CLI.Genesis
 import           Cardano.CLI.Key
 import           Cardano.CLI.Ops
 import           Cardano.CLI.Tx
-import           Cardano.CLI.Tx.Generation (TargetNodeId (..),
-                                            NumberOfTxs (..),
+import           Cardano.CLI.Tx.Generation (NumberOfTxs (..),
                                             NumberOfInputsPerTx (..),
                                             NumberOfOutputsPerTx (..),
                                             FeePerTx (..), TPSRate (..),
@@ -86,7 +84,7 @@ import           Cardano.Config.Types (CardanoConfiguration(..), ConfigYamlFileP
                                        SigningKeyFile(..), TopologyFile(..),
                                        parseNodeConfiguration)
 import           Cardano.Config.Logging (LoggingLayer (..))
-import           Cardano.Config.Topology (TopologyInfo(..))
+import           Cardano.Config.Topology (NodeAddress(..), TopologyInfo(..))
 
 -- | Sub-commands of 'cardano-cli'.
 data ClientCommand
@@ -162,7 +160,7 @@ data ClientCommand
     --- Tx Generator Command ----------
 
   | GenerateTxs
-    [TargetNodeId]
+    (NonEmpty NodeAddress)
     NumberOfTxs
     NumberOfInputsPerTx
     NumberOfOutputsPerTx
@@ -247,7 +245,7 @@ runCommand _ _ (SpendUTxO (NewTxFile ctTx) ctKey ins outs nCli) = do
   liftIO . ensureNewFileLBS ctTx $ serialise gTx
 
 runCommand _ loggingLayer
-           (GenerateTxs targetNodeIds
+           (GenerateTxs targetNodeAddresses
                         numOfTxs
                         numOfInsPerTx
                         numOfOutsPerTx
@@ -260,13 +258,11 @@ runCommand _ loggingLayer
 
   liftIO $ withRealPBFT nc nCli $
     \protocol@(Consensus.ProtocolRealPBFT _ _ _ _ _) -> do
-      let topologyFp = unTopology . topFile $ mscFp nCli
       res <- runExceptT $ genesisBenchmarkRunner
                             loggingLayer
                             nCli
                             protocol
-                            (TopologyInfo (ncNodeId nc) topologyFp)
-                            targetNodeIds
+                            targetNodeAddresses
                             numOfTxs
                             numOfInsPerTx
                             numOfOutsPerTx

cardano-node/src/Cardano/CLI/Tx/Generation.hs

@@ -10,8 +10,7 @@
 {-# OPTIONS_GHC -Wno-missed-specialisations #-}
 
 module Cardano.CLI.Tx.Generation
-  ( TargetNodeId(..)
-  , NumberOfTxs(..)
+  ( NumberOfTxs(..)
   , NumberOfInputsPerTx(..)
   , NumberOfOutputsPerTx(..)
   , FeePerTx(..)
@@ -31,10 +30,7 @@ import qualified Control.Exception as Exception
 import           Control.Monad (forM, forM_, mapM, when)
 import qualified Control.Monad.Class.MonadSTM as MSTM
 import           Control.Monad.Trans.Except (ExceptT)
-import           Control.Monad.Trans.Except.Extra (firstExceptT,
-                                                   hoistEither,
-                                                   left, newExceptT,
-                                                   right)
+import           Control.Monad.Trans.Except.Extra (left, right)
 import           Data.Bifunctor (bimap)
 import qualified Data.ByteString.Lazy as LB
 import           Data.Either (isLeft)
@@ -69,11 +65,7 @@ import           Cardano.Config.Logging (LoggingLayer (..), Trace)
 import           Cardano.Config.Types (NodeCLI(..))
 import qualified Cardano.Crypto as Crypto
 import           Cardano.Config.Topology (NodeAddress (..),
-                                          NodeHostAddress(..),
-                                          TopologyError(..),
-                                          TopologyInfo (..),
-                                          createNodeAddress,
-                                          readTopologyFile)
+                                          NodeHostAddress(..)) 
 import           Cardano.CLI.Tx (txSpendGenesisUTxOByronPBFT)
 import           Cardano.CLI.Tx.BenchmarkingTxSubmission (ROEnv (..),
                                                           TraceBenchTxSubmit (..),
@@ -91,19 +83,15 @@ import Ouroboros.Consensus.Block(BlockProtocol)
 import           Ouroboros.Consensus.Ledger.Byron.Config (pbftProtocolMagic)
 import           Ouroboros.Consensus.Node.ProtocolInfo (ProtocolInfo (..),
                                                         protocolInfo)
-import           Ouroboros.Consensus.NodeId (NodeId (..))
 import qualified Ouroboros.Consensus.Protocol as Consensus
 import           Ouroboros.Consensus.Ledger.Byron (ByronBlock (..),
                                                    GenTx (..),
                                                    ByronConsensusProtocol)
 import qualified Ouroboros.Consensus.Ledger.Byron as Byron
+import           Ouroboros.Consensus.NodeId (NodeId (..))
 import           Ouroboros.Consensus.Protocol.Abstract (NodeConfig)
 import           Ouroboros.Consensus.Protocol.PBFT (pbftExtConfig)
 
-newtype TargetNodeId =
-  TargetNodeId Int
-  deriving (Eq, Ord, Show)
-
 newtype NumberOfTxs =
   NumberOfTxs Word64
   deriving (Eq, Ord, Show)
@@ -140,11 +128,7 @@ newtype TxAdditionalSize =
 data TxGenError = CurrentlyCannotSendTxToRelayNode FilePath
                 -- ^ Relay nodes cannot currently be transaction recipients.
                 | InsufficientFundsForRecipientTx
-                | TargetNodeAddressError TopologyError
                 -- ^ Error occurred while creating the target node address.
-                | TopologyFileReadError String
-                | NeedMinimumOneTargetNodeId [TargetNodeId]
-                -- ^ Need at least 1 target node id.
                 | NeedMinimumThreeSigningKeyFiles [FilePath]
                 -- ^ Need at least 3 signing key files.
                 | SecretKeyDeserialiseError String
@@ -160,8 +144,7 @@ genesisBenchmarkRunner
   :: LoggingLayer
   -> NodeCLI
   -> Consensus.Protocol ByronBlock
-  -> TopologyInfo
-  -> [TargetNodeId]
+  -> NonEmpty NodeAddress
   -> NumberOfTxs
   -> NumberOfInputsPerTx
   -> NumberOfOutputsPerTx
@@ -173,8 +156,7 @@ genesisBenchmarkRunner
 genesisBenchmarkRunner loggingLayer
                        nCli
                        protocol@(Consensus.ProtocolRealPBFT genesisConfig _ _ _ _)
-                       topologyInfo
-                       targetNodeIds
+                       targetNodeAddresses
                        numOfTxs@(NumberOfTxs rawNumOfTxs)
                        numOfInsPerTx
                        numOfOutsPerTx
@@ -185,29 +167,11 @@ genesisBenchmarkRunner loggingLayer
   when (length signingKeyFiles < 3) $
     left $ NeedMinimumThreeSigningKeyFiles signingKeyFiles
 
-  when (null targetNodeIds) $
-    left $ NeedMinimumOneTargetNodeId targetNodeIds
-
   let (benchTracer, connectTracer, submitTracer, lowLevelSubmitTracer) = createTracers loggingLayer
 
   liftIO . traceWith benchTracer . TraceBenchTxSubDebug
     $ "******* Tx generator, tracers are ready *******"
 
-  liftIO . traceWith benchTracer . TraceBenchTxSubDebug
-    $ "******* Tx generator, protocol info and topology are ready *******"
-
-  -- We have to extract host and port of the nodes we want to talk with
-  -- (based on values of `--target-node-id` CLI argument) from the topology file.
-  topology <- firstExceptT TopologyFileReadError . newExceptT $
-    readTopologyFile (topologyFile topologyInfo)
-  targetNodeAddresses <- forM targetNodeIds $ \(TargetNodeId targetNodeId) -> do
-    let eitherNodeAddress = createNodeAddress (CoreId targetNodeId) topology (topologyFile topologyInfo)
-    targetNodeAddress <- firstExceptT TargetNodeAddressError . hoistEither $ eitherNodeAddress
-    return targetNodeAddress
-
-  liftIO . traceWith benchTracer . TraceBenchTxSubDebug
-    $ "******* Tx generator, target node's address is ready *******"
-
   -- 'genesisKey' is for genesis address with initial amount of money (1.4 billion ADA for now).
   -- 'sourceKey' is for source address that we'll use as a source of money for next transactions.
   -- 'recepientKey' is for recipient address that we'll use as an output for next transactions.
@@ -236,7 +200,6 @@ genesisBenchmarkRunner loggingLayer
              nCli
              genesisConfig
              pInfoConfig
-             topologyInfo
              genesisUtxo
              genesisAddress
              sourceAddress
@@ -255,7 +218,6 @@ genesisBenchmarkRunner loggingLayer
                  pInfoConfig
                  sourceKey
                  recipientAddress
-                 topologyInfo
                  targetNodeAddresses
                  numOfTxs
                  numOfInsPerTx
@@ -430,7 +392,6 @@ prepareInitialFunds
   -> NodeCLI
   -> CC.Genesis.Config
   -> NodeConfig ByronConsensusProtocol
-  -> TopologyInfo
   -> Map Int ((CC.UTxO.TxIn, CC.UTxO.TxOut), Crypto.SigningKey)
   -> CC.Common.Address
   -> CC.Common.Address
@@ -440,7 +401,6 @@ prepareInitialFunds llTracer
                     nCli
                     genesisConfig
                     pInfoConfig
-                    topologyInfo
                     genesisUtxo
                     genesisAddress
                     targetAddress
@@ -459,7 +419,7 @@ prepareInitialFunds llTracer
                                               genesisAddress
                                               (NE.fromList [outForBig])
 
-  submitTx nCli pInfoConfig (node topologyInfo) genesisTx llTracer
+  submitTx nCli pInfoConfig (CoreId 0) genesisTx llTracer
   -- Done, the first transaction 'initGenTx' is submitted, now 'sourceAddress' has a lot of money.
 
   let txIn  = CC.UTxO.TxInUtxo (getTxIdFromGenTx genesisTx) 0
@@ -686,8 +646,7 @@ runBenchmark
   -> NodeConfig ByronConsensusProtocol
   -> Crypto.SigningKey
   -> CC.Common.Address
-  -> TopologyInfo
-  -> [NodeAddress]
+  -> NonEmpty NodeAddress
   -> NumberOfTxs
   -> NumberOfInputsPerTx
   -> NumberOfOutputsPerTx
@@ -703,7 +662,6 @@ runBenchmark benchTracer
              pInfoConfig
              sourceKey
              recipientAddress
-             topologyInfo
              targetNodeAddresses
              numOfTxs
              numOfInsPerTx
@@ -719,7 +677,6 @@ runBenchmark benchTracer
     pInfoConfig
     sourceKey
     txFee
-    topologyInfo
     numOfTxs
     numOfInsPerTx
 
@@ -769,7 +726,7 @@ runBenchmark benchTracer
               recipientAddress
               sourceKey
               txFee
-              (length targetNodeAddresses)
+              (NE.length targetNodeAddresses)
               numOfTxs
               numOfInsPerTx
               numOfOutsPerTx
@@ -780,7 +737,7 @@ runBenchmark benchTracer
 
   liftIO $ do
     txsLists <- STM.atomically $ STM.takeTMVar txsListsForTargetNodes
-    let targetNodesAddrsAndTxsLists = zip remoteAddresses txsLists
+    let targetNodesAddrsAndTxsLists = zip (NE.toList remoteAddresses) txsLists
     allAsyncs <- forM targetNodesAddrsAndTxsLists $ \(remoteAddr, txsList) -> do
       -- Launch connection and submission threads for a peer
       -- (corresponding to one target node).
@@ -807,7 +764,6 @@ createMoreFundCoins
   -> NodeConfig ByronConsensusProtocol
   -> Crypto.SigningKey
   -> FeePerTx
-  -> TopologyInfo
   -> NumberOfTxs
   -> NumberOfInputsPerTx
   -> ExceptT TxGenError IO ()
@@ -816,7 +772,6 @@ createMoreFundCoins llTracer
                     pInfoConfig
                     sourceKey
                     (FeePerTx txFee)
-                    topologyInfo
                     (NumberOfTxs numOfTxs)
                     (NumberOfInputsPerTx numOfInsPerTx) = do
   let feePerTx              = assumeBound . CC.Common.mkLovelace $ txFee
@@ -854,7 +809,7 @@ createMoreFundCoins llTracer
                                              txOut
                                              []
   liftIO $ forM_ splittingTxs $ \(tx, txDetailsList) -> do
-    submitTx nCli pInfoConfig (node topologyInfo) tx llTracer
+    submitTx nCli pInfoConfig (CoreId 0) tx llTracer
     -- Update available fundValueStatus to reuse the numSplittingTxOuts TxOuts.
     forM_ txDetailsList addToAvailableFunds
  where