Consolidate protocol parameters across eras

ouroboros-consensus-cardano/changelog.d/20230815_110046_joris_275_consolidate_protocolparams_across_eras.md

@@ -0,0 +1,33 @@
+<!--
+A new scriv changelog fragment.
+
+Uncomment the section that is right (remove the HTML comment wrapper).
+-->
+
+<!--
+### Patch
+
+- A bullet item for the Patch category.
+
+-->
+
+### Non-Breaking
+
+- Add a `ProtocolTransitionParams` data family, and provide instances for
+  transitions from Byron to Shelley and Shelley-based eras to Shelley-based
+  eras.
+- Add a data instance of `ProtocolParams` for the Cardano block.
+- Provide a `CardanoProtocolParams` type synonym and associated pattern synonym
+  (with record syntax).
+- Export all `ProtocolParams` and `ProtocolTransitionParams` instances from
+  `Ouroboros.Consensus.Cardano` and `Ouroboros.Consensus.Cardano.Node`.
+
+### Breaking
+
+- Refactor `ProtocolParamsByron` to a data instance of `ProtocolParams`.
+- Refactor protocol parameters for Shelley eras (e.g, `ProtocolParamsAlonzo` and `ProtocolParamsBabbage`) to data instances of `ProtocolParams`.
+- Export all Shelley `ProtocolParams` data instances from `Ouroboros.Consensus.Shelley.Node`.
+- Remove the `ProtocolTransitionParamsShelleyBased` datatype in favour of
+  `ProtocolTransitionParams`.
+- Make `protocolInfoCardano` require a `CardanoProtocolParams` type as its only
+  argument, instead of a long list of arguments.

ouroboros-consensus-cardano/src/byron-testlib/Test/ThreadNet/Infra/Byron/ProtocolInfo.hs

@@ -59,7 +59,7 @@ mkProtocolByron params coreNodeId genesisConfig genesisSecrets =
     blockForging :: [BlockForging m ByronBlock]
     blockForging = blockForgingByron protocolParams
 
-    protocolParams :: ProtocolParamsByron
+    protocolParams :: ProtocolParams ByronBlock
     protocolParams = ProtocolParamsByron {
             byronGenesis                = genesisConfig
           , byronPbftSignatureThreshold = Just $ pbftSignatureThreshold

ouroboros-consensus-cardano/src/byron/Ouroboros/Consensus/Byron/Node.hs

@@ -8,18 +8,19 @@
 
 module Ouroboros.Consensus.Byron.Node (
     PBftSignatureThreshold (..)
-  , ProtocolParamsByron (..)
   , blockForgingByron
   , byronBlockForging
-  , defaultPBftSignatureThreshold
-  , mkByronConfig
-  , protocolClientInfoByron
-  , protocolInfoByron
     -- * Secrets
   , ByronLeaderCredentials (..)
   , ByronLeaderCredentialsError
   , mkByronLeaderCredentials
   , mkPBftCanBeLeader
+    -- * ProtocolInfo
+  , ProtocolParams (..)
+  , defaultPBftSignatureThreshold
+  , mkByronConfig
+  , protocolClientInfoByron
+  , protocolInfoByron
   ) where
 
 import qualified Cardano.Chain.Delegation as Delegation
@@ -151,7 +152,7 @@ mkPBftCanBeLeader (ByronLeaderCredentials sk cert nid _) = PBftCanBeLeader {
     }
 
 blockForgingByron :: Monad m
-                  => ProtocolParamsByron
+                  => ProtocolParams ByronBlock
                   -> [BlockForging m ByronBlock]
 blockForgingByron ProtocolParamsByron { byronLeaderCredentials      = mLeaderCreds
                                       , byronMaxTxCapacityOverrides = maxTxCapacityOverrides
@@ -169,7 +170,7 @@ defaultPBftSignatureThreshold :: PBftSignatureThreshold
 defaultPBftSignatureThreshold = PBftSignatureThreshold 0.22
 
 -- | Parameters needed to run Byron
-data ProtocolParamsByron = ProtocolParamsByron {
+data instance ProtocolParams ByronBlock = ProtocolParamsByron {
       byronGenesis                :: Genesis.Config
     , byronPbftSignatureThreshold :: Maybe PBftSignatureThreshold
     , byronProtocolVersion        :: Update.ProtocolVersion
@@ -178,7 +179,7 @@ data ProtocolParamsByron = ProtocolParamsByron {
     , byronMaxTxCapacityOverrides :: Mempool.TxOverrides ByronBlock
     }
 
-protocolInfoByron :: ProtocolParamsByron
+protocolInfoByron :: ProtocolParams ByronBlock
                   -> ProtocolInfo ByronBlock
 protocolInfoByron ProtocolParamsByron {
                       byronGenesis                = genesisConfig

ouroboros-consensus-cardano/src/cardano-testlib/Test/Consensus/Cardano/ProtocolInfo.hs

@@ -34,34 +34,24 @@ import           Data.Word (Word64)
 import           Ouroboros.Consensus.Block.Forging (BlockForging)
 import           Ouroboros.Consensus.BlockchainTime (SlotLength)
 import           Ouroboros.Consensus.Byron.Node (ByronLeaderCredentials,
-                     ProtocolParamsByron (..), byronGenesis,
+                     ProtocolParams (..), byronGenesis,
                      byronMaxTxCapacityOverrides, byronPbftSignatureThreshold,
                      byronSoftwareVersion)
 import           Ouroboros.Consensus.Cardano.Block (CardanoBlock)
 import           Ouroboros.Consensus.Cardano.Node (CardanoHardForkConstraints,
-                     ProtocolTransitionParamsShelleyBased (..),
+                     ProtocolParams (..), ProtocolTransitionParams (..),
                      TriggerHardFork (TriggerHardForkAtEpoch, TriggerHardForkNever),
-                     protocolInfoCardano, transitionTranslationContext,
-                     transitionTrigger)
+                     protocolInfoCardano)
 import           Ouroboros.Consensus.Config.SecurityParam (SecurityParam (..))
 import qualified Ouroboros.Consensus.Mempool as Mempool
 import           Ouroboros.Consensus.Node.ProtocolInfo (NumCoreNodes (..),
                      ProtocolInfo)
 import           Ouroboros.Consensus.NodeId (CoreNodeId (..))
 import           Ouroboros.Consensus.Protocol.PBFT (PBftParams,
                      PBftSignatureThreshold (..))
-import           Ouroboros.Consensus.Shelley.Node (ProtocolParamsAllegra (..),
-                     ProtocolParamsAlonzo (..), ProtocolParamsMary (..),
-                     ProtocolParamsShelley (..),
-                     ProtocolParamsShelleyBased (..), ShelleyGenesis,
-                     ShelleyLeaderCredentials, allegraMaxTxCapacityOverrides,
-                     allegraProtVer, alonzoMaxTxCapacityOverrides,
-                     alonzoProtVer, maryMaxTxCapacityOverrides, maryProtVer,
-                     sgGenDelegs, shelleyBasedGenesis, shelleyBasedInitialNonce,
-                     shelleyBasedLeaderCredentials,
-                     shelleyMaxTxCapacityOverrides, shelleyProtVer)
-import           Ouroboros.Consensus.Shelley.Node.Praos
-                     (ProtocolParamsBabbage (..), ProtocolParamsConway (..))
+import           Ouroboros.Consensus.Shelley.Node
+                     (ProtocolParamsShelleyBased (..), ShelleyGenesis,
+                     ShelleyLeaderCredentials, sgGenDelegs)
 import           Ouroboros.Consensus.Util.IOLike (IOLike)
 import qualified Test.ThreadNet.Infra.Alonzo as Alonzo
 import qualified Test.ThreadNet.Infra.Byron as Byron
@@ -280,70 +270,72 @@ mkTestProtocolInfo
     hardForkSpec
   =
     protocolInfoCardano
-        ProtocolParamsByron {
-            byronGenesis                = genesisByron
-          , byronPbftSignatureThreshold = aByronPbftSignatureThreshold
-          , byronProtocolVersion        = aByronProtocolVersion
-          , byronSoftwareVersion        = softVerByron
-          , byronLeaderCredentials      = Just leaderCredentialsByron
-          , byronMaxTxCapacityOverrides = Mempool.mkOverrides Mempool.noOverridesMeasure
-          }
-        ProtocolParamsShelleyBased {
-            shelleyBasedGenesis           = shelleyGenesis
-          , shelleyBasedInitialNonce      = initialNonce
-          , shelleyBasedLeaderCredentials = [leaderCredentialsShelley]
-          }
-        ProtocolParamsShelley {
-            shelleyProtVer                = hfSpecProtVer Shelley hardForkSpec
-          , shelleyMaxTxCapacityOverrides = Mempool.mkOverrides Mempool.noOverridesMeasure
-          }
-        ProtocolParamsAllegra {
-            allegraProtVer                = hfSpecProtVer Allegra hardForkSpec
-          , allegraMaxTxCapacityOverrides = Mempool.mkOverrides Mempool.noOverridesMeasure
-          }
-        ProtocolParamsMary {
-            maryProtVer                   = hfSpecProtVer Mary hardForkSpec
-          , maryMaxTxCapacityOverrides    = Mempool.mkOverrides Mempool.noOverridesMeasure
-          }
-        ProtocolParamsAlonzo {
-            alonzoProtVer                 = hfSpecProtVer Alonzo hardForkSpec
-          , alonzoMaxTxCapacityOverrides  = Mempool.mkOverrides Mempool.noOverridesMeasure
-          }
-        ProtocolParamsBabbage {
-            babbageProtVer                = hfSpecProtVer Babbage hardForkSpec
-          , babbageMaxTxCapacityOverrides = Mempool.mkOverrides Mempool.noOverridesMeasure
-          }
-        ProtocolParamsConway {
-            conwayProtVer                 = hfSpecProtVer Conway hardForkSpec
-          , conwayMaxTxCapacityOverrides  = Mempool.mkOverrides Mempool.noOverridesMeasure
-          }
-        ProtocolTransitionParamsShelleyBased {
-          transitionTranslationContext = SL.toFromByronTranslationContext shelleyGenesis
-        , transitionTrigger            = hfSpecTransitionTrigger Shelley hardForkSpec
-        }
-        ProtocolTransitionParamsShelleyBased {
-            transitionTranslationContext = ()
-          , transitionTrigger            = hfSpecTransitionTrigger Allegra hardForkSpec
-          }
-        ProtocolTransitionParamsShelleyBased {
-            transitionTranslationContext = ()
-          , transitionTrigger            = hfSpecTransitionTrigger Mary hardForkSpec
-          }
-        ProtocolTransitionParamsShelleyBased {
-            transitionTranslationContext = Alonzo.degenerateAlonzoGenesis
-          , transitionTrigger            = hfSpecTransitionTrigger Alonzo hardForkSpec
-          }
-        ProtocolTransitionParamsShelleyBased {
-            transitionTranslationContext = ()
-          , transitionTrigger            = hfSpecTransitionTrigger Babbage hardForkSpec
-          }
-        ProtocolTransitionParamsShelleyBased {
-            transitionTranslationContext =
-              -- Note that this is effectively a no-op, which is fine for
-              -- testing, at least for now.
-              SL.ConwayGenesis $ SL.GenDelegs $ sgGenDelegs shelleyGenesis
-          , transitionTrigger            = hfSpecTransitionTrigger Conway hardForkSpec
+        (CardanoProtocolParams
+          ProtocolParamsByron {
+              byronGenesis                = genesisByron
+            , byronPbftSignatureThreshold = aByronPbftSignatureThreshold
+            , byronProtocolVersion        = aByronProtocolVersion
+            , byronSoftwareVersion        = softVerByron
+            , byronLeaderCredentials      = Just leaderCredentialsByron
+            , byronMaxTxCapacityOverrides = Mempool.mkOverrides Mempool.noOverridesMeasure
+            }
+          ProtocolParamsShelleyBased {
+              shelleyBasedGenesis           = shelleyGenesis
+            , shelleyBasedInitialNonce      = initialNonce
+            , shelleyBasedLeaderCredentials = [leaderCredentialsShelley]
+            }
+          ProtocolParamsShelley {
+              shelleyProtVer                = hfSpecProtVer Shelley hardForkSpec
+            , shelleyMaxTxCapacityOverrides = Mempool.mkOverrides Mempool.noOverridesMeasure
+            }
+          ProtocolParamsAllegra {
+              allegraProtVer                = hfSpecProtVer Allegra hardForkSpec
+            , allegraMaxTxCapacityOverrides = Mempool.mkOverrides Mempool.noOverridesMeasure
+            }
+          ProtocolParamsMary {
+              maryProtVer                   = hfSpecProtVer Mary hardForkSpec
+            , maryMaxTxCapacityOverrides    = Mempool.mkOverrides Mempool.noOverridesMeasure
+            }
+          ProtocolParamsAlonzo {
+              alonzoProtVer                 = hfSpecProtVer Alonzo hardForkSpec
+            , alonzoMaxTxCapacityOverrides  = Mempool.mkOverrides Mempool.noOverridesMeasure
+            }
+          ProtocolParamsBabbage {
+              babbageProtVer                = hfSpecProtVer Babbage hardForkSpec
+            , babbageMaxTxCapacityOverrides = Mempool.mkOverrides Mempool.noOverridesMeasure
+            }
+          ProtocolParamsConway {
+              conwayProtVer                 = hfSpecProtVer Conway hardForkSpec
+            , conwayMaxTxCapacityOverrides  = Mempool.mkOverrides Mempool.noOverridesMeasure
+            }
+          ProtocolTransitionParamsByronToShelley {
+            transitionByronToShelleyTranslationContext = SL.toFromByronTranslationContext shelleyGenesis
+          , transitionByronToShelleyTrigger            = hfSpecTransitionTrigger Shelley hardForkSpec
           }
+          ProtocolTransitionParamsIntraShelley {
+              transitionIntraShelleyTranslationContext = ()
+            , transitionIntraShelleyTrigger            = hfSpecTransitionTrigger Allegra hardForkSpec
+            }
+          ProtocolTransitionParamsIntraShelley {
+              transitionIntraShelleyTranslationContext = ()
+            , transitionIntraShelleyTrigger            = hfSpecTransitionTrigger Mary hardForkSpec
+            }
+          ProtocolTransitionParamsIntraShelley {
+              transitionIntraShelleyTranslationContext = Alonzo.degenerateAlonzoGenesis
+            , transitionIntraShelleyTrigger            = hfSpecTransitionTrigger Alonzo hardForkSpec
+            }
+          ProtocolTransitionParamsIntraShelley {
+              transitionIntraShelleyTranslationContext = ()
+            , transitionIntraShelleyTrigger            = hfSpecTransitionTrigger Babbage hardForkSpec
+            }
+          ProtocolTransitionParamsIntraShelley {
+              transitionIntraShelleyTranslationContext =
+                -- Note that this is effectively a no-op, which is fine for
+                -- testing, at least for now.
+                SL.ConwayGenesis $ SL.GenDelegs $ sgGenDelegs shelleyGenesis
+            , transitionIntraShelleyTrigger            = hfSpecTransitionTrigger Conway hardForkSpec
+            }
+        )
 
   where
     leaderCredentialsByron :: ByronLeaderCredentials

ouroboros-consensus-cardano/src/cardano-testlib/Test/ThreadNet/Infra/ShelleyBasedHardFork.hs

@@ -38,8 +38,7 @@ import           Ouroboros.Consensus.Cardano.CanHardFork
                      (ShelleyPartialLedgerConfig (..), forecastAcrossShelley,
                      translateChainDepStateAcrossShelley)
 import           Ouroboros.Consensus.Cardano.Node
-                     (ProtocolTransitionParamsShelleyBased (..),
-                     TriggerHardFork (..))
+                     (ProtocolTransitionParams (..), TriggerHardFork (..))
 import           Ouroboros.Consensus.HardFork.Combinator
 import           Ouroboros.Consensus.HardFork.Combinator.Embed.Binary
 import           Ouroboros.Consensus.HardFork.Combinator.Serialisation
@@ -228,7 +227,7 @@ protocolInfoShelleyBasedHardFork ::
   -> SL.ProtVer
   -> SL.ProtVer
   -> SL.TranslationContext era1
-  -> ProtocolTransitionParamsShelleyBased era2
+  -> ProtocolTransitionParams (ShelleyBlock proto1 era1) (ShelleyBlock proto2 era2)
   -> ( ProtocolInfo      (ShelleyBasedHardForkBlock proto1 era1 proto2 era2)
      , m [BlockForging m (ShelleyBasedHardForkBlock proto1 era1 proto2 era2)]
      )
@@ -274,17 +273,17 @@ protocolInfoShelleyBasedHardFork protocolParamsShelleyBased
     eraParams1 :: History.EraParams
     eraParams1 = shelleyEraParams genesis
 
-    ProtocolTransitionParamsShelleyBased {
-        transitionTranslationContext = transCtxt2
-      , transitionTrigger
+    ProtocolTransitionParamsIntraShelley {
+        transitionIntraShelleyTranslationContext = transCtxt2
+      , transitionIntraShelleyTrigger
       } = protocolTransitionParams
 
     toPartialLedgerConfig1 ::
          LedgerConfig (ShelleyBlock proto1 era1)
       -> PartialLedgerConfig (ShelleyBlock proto1 era1)
     toPartialLedgerConfig1 cfg = ShelleyPartialLedgerConfig {
           shelleyLedgerConfig    = cfg
-        , shelleyTriggerHardFork = transitionTrigger
+        , shelleyTriggerHardFork = transitionIntraShelleyTrigger
         }
 
     -- Era 2

ouroboros-consensus-cardano/src/ouroboros-consensus-cardano/Ouroboros/Consensus/Cardano.hs

@@ -8,12 +8,8 @@ module Ouroboros.Consensus.Cardano (
   , ProtocolCardano
   , ProtocolShelley
     -- * Abstract over the various protocols
-  , ProtocolParamsAllegra (..)
-  , ProtocolParamsAlonzo (..)
-  , ProtocolParamsByron (..)
-  , ProtocolParamsMary (..)
-  , ProtocolParamsShelley (..)
-  , ProtocolTransitionParamsShelleyBased (..)
+  , ProtocolParams (..)
+  , ProtocolTransitionParams (..)
   , module X
   ) where