Expose types BlockType, Protocol and ProtocolInfoArgs via Cardano.Api

Jimbo4350 · Jimbo4350 · commit a3a9bf035c63 · 2022-10-20T17:47:08.000+02:00
rather than their resident module
diff --git a/cardano-api/cardano-api.cabal b/cardano-api/cardano-api.cabal
@@ -40,8 +40,6 @@ library
                         Cardano.Api.ChainSync.Client
                         Cardano.Api.ChainSync.ClientPipelined
                         Cardano.Api.Crypto.Ed25519Bip32
-                        Cardano.Api.EraCast
-                        Cardano.Api.Protocol.Types
                         Cardano.Api.Shelley
                         -- TODO: Eliminate in the future when
                         -- we create wrapper types for the ledger types
@@ -58,6 +56,7 @@ library
                         Cardano.Api.Convenience.Construction
                         Cardano.Api.Convenience.Query
                         Cardano.Api.Environment
+                        Cardano.Api.EraCast
                         Cardano.Api.Eras
                         Cardano.Api.Error
                         Cardano.Api.Fees
@@ -77,7 +76,9 @@ library
                         Cardano.Api.Modes
                         Cardano.Api.NetworkId
                         Cardano.Api.OperationalCertificate
+                        Cardano.Api.Protocol.Types
                         Cardano.Api.ProtocolParameters
+                        Cardano.Api.Protocol.Types
                         Cardano.Api.Query
                         Cardano.Api.Script
                         Cardano.Api.ScriptData
diff --git a/cardano-api/src/Cardano/Api.hs b/cardano-api/src/Cardano/Api.hs
@@ -562,6 +562,12 @@ module Cardano.Api (
     CardanoMode,
     --  connectToRemoteNode,
 
+    -- ** Protocol related types
+    BlockType(..),
+    Protocol(..),
+    ProtocolInfoArgs(..),
+
+
     -- *** Chain sync protocol
     -- | To construct a @ChainSyncClient@ see @Cardano.Api.Client@ or
     -- @Cardano.Api.ClientPipelined@.
@@ -728,6 +734,7 @@ import           Cardano.Api.LedgerState
 import           Cardano.Api.Modes
 import           Cardano.Api.NetworkId
 import           Cardano.Api.OperationalCertificate
+import           Cardano.Api.Protocol.Types
 import           Cardano.Api.ProtocolParameters
 import           Cardano.Api.Query hiding (LedgerState (..))
 import           Cardano.Api.Script
diff --git a/cardano-node-chairman/app/Cardano/Chairman/Commands/Run.hs b/cardano-node-chairman/app/Cardano/Chairman/Commands/Run.hs
@@ -29,7 +29,6 @@ import           Ouroboros.Consensus.Node.ProtocolInfo
 
 
 import           Cardano.Api
-import qualified Cardano.Api.Protocol.Types as Protocol
 import           Cardano.Chairman (chairmanTest)
 
 data RunOpts = RunOpts
diff --git a/cardano-node/src/Cardano/Node/Configuration/Logging.hs b/cardano-node/src/Cardano/Node/Configuration/Logging.hs
@@ -23,6 +23,7 @@ module Cardano.Node.Configuration.Logging
   , LOContent (..)
   ) where
 
+import qualified Cardano.Api as Api
 import           Cardano.Prelude hiding (trace)
 
 import qualified Control.Concurrent as Conc
@@ -76,8 +77,6 @@ import           Ouroboros.Consensus.HardFork.Combinator.Degenerate
 import           Ouroboros.Consensus.Node.ProtocolInfo
 import           Ouroboros.Consensus.Shelley.Ledger.Ledger
 
-import           Cardano.Api.Protocol.Types (BlockType (..), protocolInfo)
-
 import           Cardano.Git.Rev (gitRev)
 import           Cardano.Node.Configuration.POM (NodeConfiguration (..), ncProtocol)
 import           Cardano.Node.Protocol.Types (SomeConsensusProtocol (..))
@@ -323,16 +322,16 @@ nodeBasicInfo :: NodeConfiguration
               -> IO [LogObject Text]
 nodeBasicInfo nc (SomeConsensusProtocol whichP pForInfo) nodeStartTime' = do
   meta <- mkLOMeta Notice Public
-  let cfg = pInfoConfig $ protocolInfo pForInfo
+  let cfg = pInfoConfig $ Api.protocolInfo pForInfo
       protocolDependentItems =
         case whichP of
-          ByronBlockType ->
+          Api.ByronBlockType ->
             let DegenLedgerConfig cfgByron = Consensus.configLedger cfg
             in getGenesisValuesByron cfg cfgByron
-          ShelleyBlockType ->
+          Api.ShelleyBlockType ->
             let DegenLedgerConfig cfgShelley = Consensus.configLedger cfg
             in getGenesisValues "Shelley" cfgShelley
-          CardanoBlockType ->
+          Api.CardanoBlockType ->
             let CardanoLedgerConfig cfgByron cfgShelley cfgAllegra
                                     cfgMary cfgAlonzo cfgBabbage = Consensus.configLedger cfg
             in getGenesisValuesByron cfg cfgByron
diff --git a/cardano-node/src/Cardano/Node/Protocol/Byron.hs b/cardano-node/src/Cardano/Node/Protocol/Byron.hs
@@ -20,15 +20,14 @@ import qualified Data.ByteString.Lazy as LB
 import qualified Data.Text as Text
 
 import           Cardano.Api.Byron
-import qualified Cardano.Api.Protocol.Types as Protocol
 
 import qualified Cardano.Crypto.Hash as Crypto
 
 import qualified Cardano.Crypto.Hashing as Byron.Crypto
 
 import qualified Cardano.Chain.Genesis as Genesis
-import qualified Cardano.Chain.UTxO as UTxO
 import qualified Cardano.Chain.Update as Update
+import qualified Cardano.Chain.UTxO as UTxO
 import           Cardano.Crypto.ProtocolMagic (RequiresNetworkMagic)
 
 import           Cardano.Node.Types
@@ -80,7 +79,7 @@ mkSomeConsensusProtocolByron NodeByronProtocolConfiguration {
 
     optionalLeaderCredentials <- readLeaderCredentials genesisConfig files
 
-    return $ SomeConsensusProtocol Protocol.ByronBlockType $ Protocol.ProtocolInfoArgsByron $ Consensus.ProtocolParamsByron {
+    return $ SomeConsensusProtocol ByronBlockType $ ProtocolInfoArgsByron $ Consensus.ProtocolParamsByron {
         byronGenesis = genesisConfig,
         byronPbftSignatureThreshold =
           PBftSignatureThreshold <$> npcByronPbftSignatureThresh,
diff --git a/cardano-node/src/Cardano/Node/Protocol/Cardano.hs b/cardano-node/src/Cardano/Node/Protocol/Cardano.hs
@@ -31,7 +31,6 @@ import qualified Ouroboros.Consensus.Mempool.TxLimits as TxLimits
 
 import           Cardano.Api
 import           Cardano.Api.Orphans ()
-import           Cardano.Api.Protocol.Types
 import           Cardano.Node.Types
 
 import           Cardano.Tracing.OrphanInstances.Byron ()
diff --git a/cardano-node/src/Cardano/Node/Protocol/Shelley.hs b/cardano-node/src/Cardano/Node/Protocol/Shelley.hs
@@ -20,6 +20,7 @@ module Cardano.Node.Protocol.Shelley
   , validateGenesis
   ) where
 
+import qualified Cardano.Api as Api
 import           Cardano.Prelude
 import           Prelude (String, id)
 
@@ -44,9 +45,7 @@ import           Ouroboros.Consensus.Shelley.Node (Nonce (..), ProtocolParamsShe
 import           Cardano.Ledger.BaseTypes (ProtVer (..))
 import qualified Cardano.Ledger.Shelley.Genesis as Shelley
 
-import qualified Cardano.Api as Api (FileError (..))
 import           Cardano.Api.Orphans ()
-import qualified Cardano.Api.Protocol.Types as Protocol
 import           Cardano.Api.Shelley hiding (FileError)
 
 import           Cardano.Node.Types
@@ -87,7 +86,7 @@ mkSomeConsensusProtocolShelley NodeShelleyProtocolConfiguration {
     leaderCredentials <- firstExceptT PraosLeaderCredentialsError $
                          readLeaderCredentials files
 
-    return $ SomeConsensusProtocol Protocol.ShelleyBlockType $ Protocol.ProtocolInfoArgsShelley
+    return $ SomeConsensusProtocol Api.ShelleyBlockType $ Api.ProtocolInfoArgsShelley
       Consensus.ProtocolParamsShelleyBased {
         shelleyBasedGenesis = genesis,
         shelleyBasedInitialNonce = genesisHashToPraosNonce genesisHash,
diff --git a/cardano-node/src/Cardano/Node/Protocol/Types.hs b/cardano-node/src/Cardano/Node/Protocol/Types.hs
@@ -11,14 +11,13 @@ module Cardano.Node.Protocol.Types
   , SomeConsensusProtocol(..)
   ) where
 
-import           Prelude
+import qualified Cardano.Api as Api
 import           Cardano.Prelude (Generic, NFData)
+import           Prelude
 
 import           Data.Aeson
 import           NoThunks.Class (NoThunks)
 
-import qualified Cardano.Api.Protocol.Types as Cardano
-
 import           Cardano.Node.Orphans ()
 import           Cardano.Node.Queries (HasKESInfo, HasKESMetricsData)
 import           Cardano.Node.TraceConstraints (TraceConstraints)
@@ -55,11 +54,11 @@ instance FromJSON Protocol where
 
 data SomeConsensusProtocol where
 
-     SomeConsensusProtocol :: forall blk. ( Cardano.Protocol IO blk
+     SomeConsensusProtocol :: forall blk. ( Api.Protocol IO blk
                                           , HasKESMetricsData blk
                                           , HasKESInfo blk
                                           , TraceConstraints blk
                                           )
-                           => Cardano.BlockType blk
-                           -> Cardano.ProtocolInfoArgs IO blk
+                           => Api.BlockType blk
+                           -> Api.ProtocolInfoArgs IO blk
                            -> SomeConsensusProtocol
diff --git a/cardano-node/src/Cardano/Node/Run.hs b/cardano-node/src/Cardano/Node/Run.hs
@@ -18,6 +18,7 @@ module Cardano.Node.Run
   , checkVRFFilePermissions
   ) where
 
+import qualified Cardano.Api as Api
 import           Cardano.Prelude hiding (ByteString, STM, atomically, show, take, trace)
 import           Data.IP (toSockAddr)
 import           Prelude (String, id, show)
@@ -62,7 +63,7 @@ import           Cardano.Node.Configuration.POM (NodeConfiguration (..),
                    defaultPartialNodeConfiguration, makeNodeConfiguration, parseNodeConfigurationFP)
 import           Cardano.Node.Startup
 import           Cardano.Node.Tracing.API
-import           Cardano.Node.Tracing.StateRep (NodeState(NodeKernelOnline))
+import           Cardano.Node.Tracing.StateRep (NodeState (NodeKernelOnline))
 import           Cardano.Node.Tracing.Tracers.Startup (getStartupInfo)
 import           Cardano.Node.Types
 import           Cardano.Tracing.Config (TraceOptions (..), TraceSelection (..))
@@ -86,9 +87,6 @@ import           Ouroboros.Network.PeerSelection.RelayAccessPoint (RelayAccessPo
 import           Ouroboros.Network.Subscription (DnsSubscriptionTarget (..),
                    IPSubscriptionTarget (..))
 
-import           Cardano.Api
-import qualified Cardano.Api.Protocol.Types as Protocol
-
 import           Cardano.Node.Configuration.Socket (SocketOrSocketInfo (..),
                    gatherConfiguredSockets, getSocketOrSocketInfoAddr)
 import qualified Cardano.Node.Configuration.Topology as TopologyNonP2P
@@ -137,13 +135,13 @@ runNode cmdPc = do
 
     p :: SomeConsensusProtocol <-
       case eitherSomeProtocol of
-        Left err -> putStrLn (displayError err) >> exitFailure
+        Left err -> putStrLn (Api.displayError err) >> exitFailure
         Right p  -> pure p
 
-    let networkMagic :: NetworkMagic =
+    let networkMagic :: Api.NetworkMagic =
           case p of
             SomeConsensusProtocol _ runP ->
-              let ProtocolInfo { pInfoConfig } = Protocol.protocolInfo runP
+              let ProtocolInfo { pInfoConfig } = Api.protocolInfo runP
               in getNetworkMagic $ Consensus.configBlock pInfoConfig
 
     case p of
@@ -172,19 +170,19 @@ installSigTermHandler = do
 
 handleNodeWithTracers
   :: ( TraceConstraints blk
-     , Protocol.Protocol IO blk
+     , Api.Protocol IO blk
      )
   => PartialNodeConfiguration
   -> NodeConfiguration
   -> SomeConsensusProtocol
-  -> NetworkMagic
-  -> Protocol.ProtocolInfoArgs IO blk
+  -> Api.NetworkMagic
+  -> Api.ProtocolInfoArgs IO blk
   -> IO ()
 handleNodeWithTracers cmdPc nc p networkMagic runP = do
   -- This IORef contains node kernel structure which holds node kernel.
   -- Used for ledger queries and peer connection status.
   nodeKernelData <- mkNodeKernelData
-  let ProtocolInfo { pInfoConfig = cfg } = Protocol.protocolInfo runP
+  let ProtocolInfo { pInfoConfig = cfg } = Api.protocolInfo runP
   case ncEnableP2P nc of
     SomeNetworkP2PMode p2pMode -> do
       let fp = maybe  "No file path found!"
@@ -311,9 +309,9 @@ handlePeersListSimple tr nodeKern = forever $ do
 handleSimpleNode
   :: forall blk p2p
   . ( RunNode blk
-    , Protocol.Protocol IO blk
+    , Api.Protocol IO blk
     )
-  => Protocol.ProtocolInfoArgs IO blk
+  => Api.ProtocolInfoArgs IO blk
   -> NetworkP2PMode p2p
   -> Tracers RemoteConnectionId LocalConnectionId blk p2p
   -> NodeConfiguration
@@ -332,7 +330,7 @@ handleSimpleNode runP p2pMode tracers nc onKernel = do
     traceWith (startupTracer tracers)
       StartupDBValidation
 
-  let pInfo = Protocol.protocolInfo runP
+  let pInfo = Api.protocolInfo runP
 
   (publicIPv4SocketOrAddr, publicIPv6SocketOrAddr, localSocketOrPath) <- do
     result <- runExceptT (gatherConfiguredSockets $ ncSocketConfig nc)
diff --git a/cardano-node/src/Cardano/Node/Startup.hs b/cardano-node/src/Cardano/Node/Startup.hs
@@ -7,6 +7,7 @@
 
 module Cardano.Node.Startup where
 
+import qualified Cardano.Api as Api
 import           Prelude
 
 import           Data.Aeson (FromJSON, ToJSON)
@@ -44,7 +45,6 @@ import           Ouroboros.Network.PeerSelection.Types (PeerAdvertise)
 import           Ouroboros.Network.Subscription.Dns (DnsSubscriptionTarget (..))
 import           Ouroboros.Network.Subscription.Ip (IPSubscriptionTarget (..))
 
-import           Cardano.Api.Protocol.Types (BlockType (..), protocolInfo)
 import           Cardano.Logging
 import           Cardano.Node.Configuration.POM (NodeConfiguration (..), ncProtocol)
 import           Cardano.Node.Configuration.Socket
@@ -184,17 +184,17 @@ prepareNodeInfo nc (SomeConsensusProtocol whichP pForInfo) tc nodeStartTime = do
     , niSystemStartTime = systemStartTime
     }
  where
-  cfg = pInfoConfig $ protocolInfo pForInfo
+  cfg = pInfoConfig $ Api.protocolInfo pForInfo
 
   systemStartTime :: UTCTime
   systemStartTime =
     case whichP of
-      ByronBlockType ->
+      Api.ByronBlockType ->
         getSystemStartByron
-      ShelleyBlockType ->
+      Api.ShelleyBlockType ->
         let DegenLedgerConfig cfgShelley = configLedger cfg
         in getSystemStartShelley cfgShelley
-      CardanoBlockType ->
+      Api.CardanoBlockType ->
         let CardanoLedgerConfig _ cfgShelley cfgAllegra cfgMary cfgAlonzo cfgBabbage = configLedger cfg
         in minimum [ getSystemStartByron
                    , getSystemStartShelley cfgShelley
diff --git a/cardano-node/src/Cardano/Node/Tracing/Tracers/Startup.hs b/cardano-node/src/Cardano/Node/Tracing/Tracers/Startup.hs
@@ -13,6 +13,8 @@ module Cardano.Node.Tracing.Tracers.Startup
   , ppStartupInfoTrace
   ) where
 
+import           Cardano.Api (NetworkMagic (..), SlotNo (..))
+import qualified Cardano.Api as Api
 import           Prelude
 
 import           Data.Aeson (ToJSON (..), Value (..), (.=))
@@ -49,9 +51,6 @@ import           Ouroboros.Consensus.Shelley.Ledger.Ledger (shelleyLedgerGenesis
 
 import           Cardano.Logging
 
-import           Cardano.Api (NetworkMagic (..), SlotNo (..))
-import           Cardano.Api.Protocol.Types (BlockType (..), protocolInfo)
-
 import           Cardano.Git.Rev (gitRev)
 
 import           Cardano.Node.Configuration.POM (NodeConfiguration, ncProtocol)
@@ -68,7 +67,7 @@ getStartupInfo
   -> IO [StartupTrace blk]
 getStartupInfo nc (SomeConsensusProtocol whichP pForInfo) fp = do
   nodeStartTime <- getCurrentTime
-  let cfg = pInfoConfig $ protocolInfo pForInfo
+  let cfg = pInfoConfig $ Api.protocolInfo pForInfo
       basicInfoCommon = BICommon $ BasicInfoCommon {
                 biProtocol = pack . show $ ncProtocol nc
               , biVersion  = pack . showVersion $ version
@@ -79,13 +78,13 @@ getStartupInfo nc (SomeConsensusProtocol whichP pForInfo) fp = do
               }
       protocolDependentItems =
         case whichP of
-          ByronBlockType ->
+          Api.ByronBlockType ->
             let DegenLedgerConfig cfgByron = Consensus.configLedger cfg
             in [getGenesisValuesByron cfg cfgByron]
-          ShelleyBlockType ->
+          Api.ShelleyBlockType ->
             let DegenLedgerConfig cfgShelley = Consensus.configLedger cfg
             in [getGenesisValues "Shelley" cfgShelley]
-          CardanoBlockType ->
+          Api.CardanoBlockType ->
             let CardanoLedgerConfig cfgByron cfgShelley cfgAllegra
                                     cfgMary cfgAlonzo cfgBabbage = Consensus.configLedger cfg
             in getGenesisValuesByron cfg cfgByron
