Implement SocketPath

cardano-config/src/Cardano/Config/CommonCLI.hs

@@ -146,9 +146,9 @@ parseSigningKey =
         <> help "Path to the signing key."
     )
 
-parseSocketDir :: Parser FilePath
+parseSocketDir :: Parser SocketPath
 parseSocketDir =
-  strOption
+  SocketDir <$> strOption
     ( long "socket-dir"
         <> metavar "FILEPATH"
         <> help "Directory with local sockets:\
@@ -164,9 +164,9 @@ parseSocketDirLast =
                 \  ${dir}/node-{core,relay}-${node-id}.socket"
     )
 
-parseSocketPath :: Parser FilePath
+parseSocketPath :: Parser SocketPath
 parseSocketPath =
-  strOption
+  SocketFile <$> strOption
     ( long "socket-path"
         <> help "Path to a cardano-node socket"
         <> completer (bashCompleter "file")

cardano-config/src/Cardano/Config/Types.hs

@@ -17,7 +17,7 @@ module Cardano.Config.Types
     , NodeRealCLI (..)
     , NodeProtocolMode (..)
     , SigningKeyFile (..)
-    , SocketFile (..)
+    , SocketPath (..)
     , TopologyFile( ..)
     -- * specific for @Core@
     , NodeProtocol (..)
@@ -157,7 +157,7 @@ data MiscellaneousFilepaths = MiscellaneousFilepaths
   , genesisFile :: !GenesisFile
   , delegCertFile :: !(Maybe DelegationCertFile)
   , signKeyFile :: !(Maybe SigningKeyFile)
-  , socketFile :: !SocketFile
+  , socketFile :: !SocketPath
   } deriving Show
 
 newtype TopologyFile = TopologyFile
@@ -176,9 +176,9 @@ newtype DelegationCertFile = DelegationCertFile
   { unDelegationCert :: FilePath }
   deriving Show
 
-newtype SocketFile = SocketFile
-  { unSocket :: FilePath }
-  deriving Show
+data SocketPath = SocketFile FilePath
+                | SocketDir FilePath
+                deriving Show
 
 newtype SigningKeyFile = SigningKeyFile
   { unSigningKey ::  FilePath }

cardano-node/app/chairman.hs

@@ -20,7 +20,7 @@ import           Cardano.Config.CommonCLI
 import           Cardano.Config.Protocol (SomeProtocol(..), fromProtocol)
 import           Cardano.Config.Types (ConfigYamlFilePath(..), DelegationCertFile(..),
                                        GenesisFile (..), NodeConfiguration(..),
-                                       SigningKeyFile(..), SocketFile(..), parseNodeConfiguration)
+                                       SigningKeyFile(..), SocketPath(..), parseNodeConfiguration)
 import           Cardano.Common.Parsers
 import           Cardano.Chairman (runChairman)
 
@@ -54,7 +54,7 @@ main = do
     let run = runChairman p caCoreNodeIds
                           caSecurityParam
                           caMaxBlockNo
-                          (unSocket caSocketDir)
+                          caSocketDir
                           stdoutTracer
 
     case caTimeout of
@@ -89,7 +89,7 @@ data ChairmanArgs = ChairmanArgs {
     , caTimeout         :: !(Maybe Int)
     , caTimeoutType :: !TimeoutType
     , caGenesisFile :: !GenesisFile
-    , caSocketDir :: !SocketFile
+    , caSocketDir :: !SocketPath
     , caConfigYaml :: !ConfigYamlFilePath
     , caSigningKeyFp :: !(Maybe SigningKeyFile)
     , caDelegationCertFp :: !(Maybe DelegationCertFile)
@@ -132,7 +132,7 @@ parseChairmanArgs =
       <*> parseFlag' FailureTimeout SuccessTimeout
           "timeout-is-success" "Exit successfully on timeout."
       <*> (GenesisFile <$> parseGenesisPath)
-      <*> (SocketFile <$> parseSocketDir)
+      <*> parseSocketDir
       <*> (ConfigYamlFilePath <$> parseConfigFile)
       <*> (optional $ SigningKeyFile <$> parseSigningKey)
       <*> (optional $ DelegationCertFile <$> parseDelegationCert)

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

@@ -71,7 +71,7 @@ import           Cardano.Common.Orphans ()
 import           Cardano.Config.Protocol
 import           Cardano.Config.Types (CardanoConfiguration(..), Core(..),
                                        DelegationCertFile(..), GenesisFile(..),
-                                       SigningKeyFile(..), SocketFile(..))
+                                       SigningKeyFile(..), SocketPath(..))
 import           Cardano.Config.Logging (LoggingLayer (..))
 import           Cardano.Config.Topology (NodeAddress(..), TopologyInfo(..))
 

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

@@ -52,7 +52,7 @@ import           Cardano.CLI.Ops
 import           Cardano.CLI.Tx.Submission
 import           Cardano.Config.Protocol
 import           Cardano.Config.Types (DelegationCertFile, GenesisFile,
-                                       SigningKeyFile, SocketFile, Update)
+                                       SigningKeyFile, SocketPath, Update)
 import           Cardano.Config.Topology
 import           Cardano.Common.Orphans ()
 
@@ -299,7 +299,7 @@ nodeSubmitTx
   -> Maybe Double
   -> Maybe DelegationCertFile
   -> Maybe SigningKeyFile
-  -> SocketFile
+  -> SocketPath
   -> Update
   -> Protocol
   -> GenTx ByronBlock

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

@@ -62,7 +62,7 @@ import qualified Cardano.Chain.Genesis as CC.Genesis
 import qualified Cardano.Chain.MempoolPayload as CC.Mempool
 import qualified Cardano.Chain.UTxO as CC.UTxO
 import           Cardano.Config.Logging (LoggingLayer (..), Trace)
-import           Cardano.Config.Types (SocketFile)
+import           Cardano.Config.Types (SocketPath)
 import qualified Cardano.Crypto as Crypto
 import           Cardano.Config.Topology (NodeAddress (..),
                                           NodeHostAddress(..))
@@ -142,7 +142,7 @@ data TxGenError = CurrentlyCannotSendTxToRelayNode FilePath
 -----------------------------------------------------------------------------------------
 genesisBenchmarkRunner
   :: LoggingLayer
-  -> SocketFile
+  -> SocketPath
   -> Consensus.Protocol ByronBlock
   -> NonEmpty NodeAddress
   -> NumberOfTxs
@@ -389,7 +389,7 @@ extractGenesisFunds genesisConfig signingKeys =
 -- (latter corresponds to 'targetAddress' here) and "remember" it in 'availableFunds'.
 prepareInitialFunds
   :: Tracer IO String
-  -> SocketFile
+  -> SocketPath
   -> CC.Genesis.Config
   -> NodeConfig ByronConsensusProtocol
   -> Map Int ((CC.UTxO.TxIn, CC.UTxO.TxOut), Crypto.SigningKey)
@@ -642,7 +642,7 @@ runBenchmark
   -> Tracer IO SendRecvConnect
   -> Tracer IO (SendRecvTxSubmission ByronBlock)
   -> Tracer IO String
-  -> SocketFile
+  -> SocketPath
   -> NodeConfig ByronConsensusProtocol
   -> Crypto.SigningKey
   -> CC.Common.Address
@@ -760,7 +760,7 @@ runBenchmark benchTracer
 --   Technically all splitting transactions will send money back to 'sourceAddress'.
 createMoreFundCoins
   :: Tracer IO String
-  -> SocketFile
+  -> SocketPath
   -> NodeConfig ByronConsensusProtocol
   -> Crypto.SigningKey
   -> FeePerTx

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

@@ -50,7 +50,7 @@ import qualified Ouroboros.Network.NodeToClient as NodeToClient
 
 import           Cardano.Config.Topology
 import           Cardano.Common.LocalSocket
-import           Cardano.Config.Types (SocketFile(..))
+import           Cardano.Config.Types (SocketPath(..))
 
 
 
@@ -65,7 +65,7 @@ handleTxSubmission :: forall blk.
                       ( RunNode blk
                       , Show (ApplyTxErr blk)
                       )
-                   => SocketFile
+                   => SocketPath
                    -> Consensus.Protocol blk
                    -> TopologyInfo
                    -> GenTx blk
@@ -80,14 +80,14 @@ handleTxSubmission socketFp ptcl tinfo tx tracer = do
 submitTx :: ( RunNode blk
             , Show (ApplyTxErr blk)
             )
-         => SocketFile
+         => SocketPath
          -> NodeConfig (BlockProtocol blk)
          -> NodeId
          -> GenTx blk
          -> Tracer IO String
          -> IO ()
 submitTx socketFp protoInfoConfig nId tx tracer = do
-    socketPath <- localSocketAddrInfo (Just nId) (unSocket $ socketFp) NoMkdirIfMissing
+    socketPath <- localSocketAddrInfo (Just nId) socketFp NoMkdirIfMissing
     NodeToClient.connectTo
       NetworkConnectTracers {
           nctMuxTracer       = nullTracer,

cardano-node/src/Cardano/Chairman.hs

@@ -62,6 +62,7 @@ import           Ouroboros.Network.Protocol.Handshake.Version
 import           Ouroboros.Network.NodeToClient
 
 import           Cardano.Common.LocalSocket
+import           Cardano.Config.Types (SocketPath)
 import           Cardano.Tracing.Tracers (TraceConstraints)
 
 -- | Run chairman: connect with all the core nodes.  Chairman will store the
@@ -81,7 +82,7 @@ runChairman :: forall blk.
             -- will throw an exception.
             -> Maybe BlockNo
             -- ^ finish after that many blocks, if 'Nothing' run continuously.
-            -> FilePath
+            -> SocketPath
             -- ^ local socket dir
             -> Tracer IO String
             -> IO ()
@@ -127,7 +128,7 @@ createConnection
   -> Maybe BlockNo
   -> Tracer IO String
   -> NodeConfig (BlockProtocol blk)
-  -> FilePath
+  -> SocketPath
   -> IO ()
 createConnection
   coreNodeId

cardano-node/src/Cardano/Common/LocalSocket.hs

@@ -13,6 +13,8 @@ import           System.FilePath ((</>))
 import           System.IO.Error (isDoesNotExistError)
 import           Network.Socket as Socket
 
+import           Cardano.Config.Types (SocketPath(..))
+
 import           Ouroboros.Consensus.NodeId (NodeId(..))
 
 data MkdirIfMissing
@@ -26,18 +28,22 @@ localSocketFilePath (RelayId n) = "node-relay-" ++ show n ++ ".socket"
 
 -- | Provide an AF_UNIX address for a socket situated in 'socketDir', with its name
 --   derived from the node ID.  When 'mkdir' is 'MkdirIfMissing', the directory is created.
-localSocketAddrInfo :: Maybe NodeId -> FilePath -> MkdirIfMissing -> IO Socket.AddrInfo
-localSocketAddrInfo Nothing socketPath _ = do
+localSocketAddrInfo :: Maybe NodeId -> SocketPath -> MkdirIfMissing -> IO Socket.AddrInfo
+localSocketAddrInfo (Just _) (SocketFile _) _ =
+  panic $ "Cardano.Common.LocalSocket.localSocketAddrInfo: "
+        <> "You specified a socket filepath and a NodeId. "
+        <> "NodeIds should be used with a specified socket directory."
+localSocketAddrInfo Nothing (SocketFile fp) _ = do
   pure $
     Socket.AddrInfo
       []
       Socket.AF_UNIX
       Socket.Stream
       Socket.defaultProtocol
-      (Socket.SockAddrUnix socketPath)
+      (Socket.SockAddrUnix fp)
       Nothing
-localSocketAddrInfo (Just nodeId) socketDir mkdir = do
-  dir <- canonicalizePath =<< makeAbsolute socketDir
+localSocketAddrInfo (Just nodeId) (SocketDir sDir) mkdir = do
+  dir <- canonicalizePath =<< makeAbsolute sDir
   when (mkdir == MkdirIfMissing)
     $ createDirectoryIfMissing True dir
   pure $
@@ -48,19 +54,30 @@ localSocketAddrInfo (Just nodeId) socketDir mkdir = do
       Socket.defaultProtocol
       (Socket.SockAddrUnix $ dir </> localSocketFilePath nodeId)
       Nothing
+localSocketAddrInfo Nothing (SocketDir _) _ =
+  panic $ "Cardano.Common.LocalSocket.localSocketAddrInfo: "
+        <> "You specified a socket directory without specifying a NodeId "
 
+-- TODO: Convert to ExceptT
 -- | Remove the socket established with 'localSocketAddrInfo'.
-removeStaleLocalSocket :: Maybe NodeId -> FilePath -> IO ()
-removeStaleLocalSocket Nothing socketFp = do
+removeStaleLocalSocket :: Maybe NodeId -> SocketPath -> IO ()
+removeStaleLocalSocket Nothing (SocketFile socketFp) = do
   removeFile socketFp
     `catch` \e ->
       if isDoesNotExistError e
         then return ()
         else throwIO e
-removeStaleLocalSocket (Just nodeId) socketDir = do
+removeStaleLocalSocket (Just nodeId) (SocketDir socketDir) = do
   dir <- canonicalizePath =<< makeAbsolute socketDir
   removeFile (dir </> localSocketFilePath nodeId)
     `catch` \e ->
       if isDoesNotExistError e
         then return ()
         else throwIO e
+removeStaleLocalSocket Nothing (SocketDir _) =
+  panic $ "Cardano.Common.LocalSocket.removeStaleLocalSocket: "
+        <> "You specified a socket directory without specifying a NodeId "
+removeStaleLocalSocket (Just _) (SocketFile _) =
+  panic $ "Cardano.Common.LocalSocket.removeStaleLocalSocket: "
+        <> "You specified a socket filepath and a NodeId. "
+        <> "NodeIds should be used with a specified socket directory."

cardano-node/src/Cardano/Common/Parsers.hs

@@ -114,7 +114,7 @@ nodeMockParser = do
               (GenesisFile genFp)
               (DelegationCertFile <$> delCertFp)
               (SigningKeyFile <$> sKeyFp)
-              (SocketFile socketFp)
+              socketFp
             )
            nAddress
            (ConfigYamlFilePath nodeConfigFp)
@@ -148,7 +148,7 @@ nodeRealParser = do
               (GenesisFile genFp)
               (DelegationCertFile <$> delCertFp)
               (SigningKeyFile <$> sKeyFp)
-              (SocketFile socketFp)
+              socketFp
             )
            nAddress
            (ConfigYamlFilePath nodeConfigFp)

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

@@ -72,8 +72,7 @@ import           Cardano.Common.LocalSocket
 import           Cardano.Config.Protocol (SomeProtocol(..), fromProtocol)
 import           Cardano.Config.Topology
 import           Cardano.Config.Types (ConfigYamlFilePath(..), DbFile(..), NodeMockCLI(..),
-                                       NodeProtocolMode (..), NodeRealCLI(..),
-                                       SocketFile(..), TopologyFile(..),
+                                       NodeProtocolMode (..), NodeRealCLI(..), TopologyFile(..),
                                        parseNodeConfiguration)
 import           Cardano.Tracing.Tracers
 #ifdef UNIX
@@ -167,16 +166,15 @@ handleSimpleNode p trace nodeTracers npm = do
       let tracer = contramap pack $ toLogObject trace
       traceWith tracer $ unlines
         [ "**************************************"
-        , "Hostname: " <> hn
+        , "Node IP: " <> naHostAddress rNodeAddr
         , "My producers are " --TODO: Should depend on the jq version of top file
         , "**************************************"
         ]
 
-
       -- Socket directory
       myLocalAddr <- localSocketAddrInfo
                        Nothing
-                       (unSocket $ socketFile rMscFp)
+                       (socketFile rMscFp)
                        MkdirIfMissing
 
       addrs <- nodeAddressInfo rNodeAddr
@@ -221,7 +219,7 @@ handleSimpleNode p trace nodeTracers npm = do
             }
 
 
-      removeStaleLocalSocket Nothing (unSocket $ socketFile rMscFp )
+      removeStaleLocalSocket Nothing (socketFile rMscFp)
       dbPath <- canonicalizePath =<< makeAbsolute (unDB $ dBFile rMscFp)
       varTip <- atomically $ newTVar GenesisPoint
 
@@ -274,7 +272,7 @@ handleSimpleNode p trace nodeTracers npm = do
                     -- Socket directory
                     myLocalAddr <- localSocketAddrInfo
                                       (ncNodeId nc)
-                                      (unSocket $ socketFile mMscFp)
+                                      (socketFile mMscFp)
                                       MkdirIfMissing
 
                     addrs <- nodeAddressInfo mockNodeAddr
@@ -312,7 +310,7 @@ handleSimpleNode p trace nodeTracers npm = do
                           , dstValency = raValency ra
                           }
 
-                    removeStaleLocalSocket (ncNodeId nc) (unSocket $ socketFile mMscFp)
+                    removeStaleLocalSocket (ncNodeId nc) (socketFile mMscFp)
                     dbPath <- canonicalizePath =<< makeAbsolute (unDB $ dBFile mMscFp)
 
                     varTip <- atomically $ newTVar GenesisPoint

cardano-node/src/Cardano/Wallet/Client.hs

@@ -49,14 +49,15 @@ import           Ouroboros.Network.Protocol.Handshake.Version
 import           Ouroboros.Network.NodeToClient
 
 import           Cardano.Common.LocalSocket
+import           Cardano.Config.Types (SocketPath)
 import           Cardano.Tracing.Tracers (TraceConstraints)
 
 runWalletClient :: forall blk.
                    ( RunNode blk
                    , TraceConstraints blk
                    )
                 => Protocol blk
-                -> FilePath
+                -> SocketPath
                 -> CoreNodeId
                 -> Tracer IO String
                 -> IO ()