Remove legacy HardForkSpecificNodeToClientVersions

Author: amesgen

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

@@ -291,11 +291,11 @@ instance CardanoHardForkConstraints c
 --
 -- PRECONDITION: 'supportedNodeToClientVersions' must include a version that
 -- satisfies this condition.
-genWithHardForkSpecificNodeToClientVersion ::
+_genWithHardForkSpecificNodeToClientVersion ::
      forall c. CardanoHardForkConstraints c
   => (HardForkSpecificNodeToClientVersion -> Bool)
   -> Gen (HardForkNodeToClientVersion (CardanoEras c))
-genWithHardForkSpecificNodeToClientVersion p =
+_genWithHardForkSpecificNodeToClientVersion p =
       elements
     . filter p'
     . Map.elems
@@ -488,8 +488,7 @@ instance CardanoHardForkConstraints c
   arbitrary = frequency
       [ (1, do version <- getHardForkEnabledNodeToClientVersion <$> arbitrary
                return $ WithVersion version (Some GetInterpreter))
-      , (1, do version <- genWithHardForkSpecificNodeToClientVersion
-                            (>= HardForkSpecificNodeToClientVersion2)
+      , (1, do version <- getHardForkEnabledNodeToClientVersion <$> arbitrary
                return $ WithVersion version (Some GetCurrentEra))
       ]
 
@@ -700,8 +699,7 @@ instance c ~ MockCryptoCompatByron
                             (SomeResult (CardanoBlock c)))
       genQueryHardForkResult = oneof
           [ WithVersion
-              <$> genWithHardForkSpecificNodeToClientVersion
-                    (>= HardForkSpecificNodeToClientVersion3)
+              <$> (getHardForkEnabledNodeToClientVersion <$> arbitrary)
               <*> (SomeResult (QueryHardFork GetInterpreter) <$> arbitrary)
           , WithVersion
               <$> (getHardForkEnabledNodeToClientVersion <$> arbitrary)

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

@@ -100,12 +100,17 @@ pattern ShelleyBasedHardForkNodeToNodeVersionMax ::
      BlockNodeToNodeVersion (ShelleyBasedHardForkBlock proto1 era1 proto2 era2)
 pattern ShelleyBasedHardForkNodeToNodeVersionMax =
     HardForkNodeToNodeEnabled
-      HardForkSpecificNodeToNodeVersion1
+      HardForkSpecificNodeToNodeVersionMax
       (  WrapNodeToNodeVersion ShelleyNodeToNodeVersionMax
       :* WrapNodeToNodeVersion ShelleyNodeToNodeVersionMax
       :* Nil
       )
 
+pattern HardForkSpecificNodeToNodeVersionMax :: HardForkSpecificNodeToNodeVersion
+pattern HardForkSpecificNodeToNodeVersionMax <- ((== maxBound) -> True)
+  where
+    HardForkSpecificNodeToNodeVersionMax = maxBound
+
 pattern ShelleyNodeToNodeVersionMax :: ShelleyNodeToNodeVersion
 pattern ShelleyNodeToNodeVersionMax <- ((== maxBound) -> True)
   where
@@ -115,12 +120,17 @@ pattern ShelleyBasedHardForkNodeToClientVersionMax ::
      BlockNodeToClientVersion (ShelleyBasedHardForkBlock proto1 era1 proto2 era2)
 pattern ShelleyBasedHardForkNodeToClientVersionMax =
     HardForkNodeToClientEnabled
-      HardForkSpecificNodeToClientVersion2
+      HardForkSpecificNodeToClientVersionMax
       (  EraNodeToClientEnabled ShelleyNodeToClientVersionMax
       :* EraNodeToClientEnabled ShelleyNodeToClientVersionMax
       :* Nil
       )
 
+pattern HardForkSpecificNodeToClientVersionMax :: HardForkSpecificNodeToClientVersion
+pattern HardForkSpecificNodeToClientVersionMax <- ((== maxBound) -> True)
+  where
+    HardForkSpecificNodeToClientVersionMax = maxBound
+
 pattern ShelleyNodeToClientVersionMax :: ShelleyNodeToClientVersion
 pattern ShelleyNodeToClientVersionMax <- ((== maxBound) -> True)
   where

ouroboros-consensus/changelog.d/20250109_162820_alexander.esgen_remove_legacy_serialization.md

@@ -0,0 +1,3 @@
+### Breaking
+
+- Removed legacy `HardForkSpecificNodeToClientVersion`s and related code.

ouroboros-consensus/ouroboros-consensus.cabal

@@ -301,7 +301,6 @@ library
     psqueues ^>=0.2.3,
     quiet ^>=0.2,
     rawlock ^>=0.1,
-    reflection,
     resource-registry ^>=0.1,
     semialign >=1.1,
     serialise ^>=0.2,

ouroboros-consensus/src/ouroboros-consensus/Ouroboros/Consensus/HardFork/Combinator/Ledger/Query.hs

@@ -41,7 +41,6 @@ import           Data.Bifunctor
 import           Data.Functor.Product
 import           Data.Kind (Type)
 import           Data.Proxy
-import           Data.Reflection (give)
 import           Data.SOP.BasicFunctors
 import           Data.SOP.Constraint
 import           Data.SOP.Counting (getExactly)
@@ -65,8 +64,6 @@ import qualified Ouroboros.Consensus.HardFork.Combinator.State as State
 import           Ouroboros.Consensus.HardFork.History (Bound (..), EraParams,
                      Shape (..))
 import qualified Ouroboros.Consensus.HardFork.History as History
-import           Ouroboros.Consensus.HardFork.History.EraParams
-                     (EraParamsFormat (..))
 import           Ouroboros.Consensus.HeaderValidation
 import           Ouroboros.Consensus.Ledger.Extended
 import           Ouroboros.Consensus.Ledger.Query
@@ -366,18 +363,16 @@ decodeQueryAnytimeResult GetEraStart = decode
 
 encodeQueryHardForkResult ::
      SListI xs
-  => EraParamsFormat
-  -> QueryHardFork xs result -> result -> Encoding
-encodeQueryHardForkResult epf = \case
-    GetInterpreter -> give epf encode
+  => QueryHardFork xs result -> result -> Encoding
+encodeQueryHardForkResult = \case
+    GetInterpreter -> encode
     GetCurrentEra  -> encode
 
 decodeQueryHardForkResult ::
      SListI xs
-  => EraParamsFormat
-  -> QueryHardFork xs result -> forall s. Decoder s result
-decodeQueryHardForkResult epf = \case
-    GetInterpreter -> give epf decode
+  => QueryHardFork xs result -> forall s. Decoder s result
+decodeQueryHardForkResult = \case
+    GetInterpreter -> decode
     GetCurrentEra  -> decode
 
 {-------------------------------------------------------------------------------

ouroboros-consensus/src/ouroboros-consensus/Ouroboros/Consensus/HardFork/Combinator/Serialisation/Common.hs

@@ -140,13 +140,8 @@ data HardForkSpecificNodeToNodeVersion =
 -- | Versioning of the specific additions made by the HFC to the @NodeToClient@
 -- protocols, e.g., the era tag or the hard-fork specific queries.
 data HardForkSpecificNodeToClientVersion =
-    HardForkSpecificNodeToClientVersion1
-
-    -- | Enable the 'GetCurrentEra' query in 'QueryHardFork'.
-  | HardForkSpecificNodeToClientVersion2
-
     -- | Include the Genesis window in 'EraParams'.
-  | HardForkSpecificNodeToClientVersion3
+    HardForkSpecificNodeToClientVersion3
   deriving (Eq, Ord, Show, Enum, Bounded)
 
 data HardForkNodeToNodeVersion xs where

ouroboros-consensus/src/ouroboros-consensus/Ouroboros/Consensus/HardFork/Combinator/Serialisation/SerialiseNodeToClient.hs

@@ -37,7 +37,6 @@ import           Ouroboros.Consensus.HardFork.Combinator.Ledger.Query
 import           Ouroboros.Consensus.HardFork.Combinator.Mempool
 import           Ouroboros.Consensus.HardFork.Combinator.Serialisation.Common
 import           Ouroboros.Consensus.HardFork.Combinator.Serialisation.SerialiseDisk ()
-import           Ouroboros.Consensus.HardFork.History (EraParamsFormat (..))
 import           Ouroboros.Consensus.Ledger.SupportsMempool (GenTxId)
 import           Ouroboros.Consensus.Node.NetworkProtocolVersion
 import           Ouroboros.Consensus.Node.Run
@@ -185,15 +184,12 @@ encodeQueryHardFork ::
      HardForkSpecificNodeToClientVersion
   -> Some (QueryHardFork xs)
   -> Encoding
-encodeQueryHardFork vHfc = \case
+encodeQueryHardFork _vHfc = \case
     Some GetInterpreter -> mconcat [
         Enc.encodeListLen 1
       , Enc.encodeWord8 0
       ]
-    Some GetCurrentEra
-      | vHfc < HardForkSpecificNodeToClientVersion2 ->
-        throw HardForkEncoderQueryWrongVersion
-      | otherwise -> mconcat [
+    Some GetCurrentEra -> mconcat [
         Enc.encodeListLen 1
       , Enc.encodeWord8 1
       ]
@@ -296,10 +292,8 @@ instance SerialiseHFC xs
     where
       ccfgs = getPerEraCodecConfig $ hardForkCodecConfigPerEra ccfg
 
-  encodeResult _ _       (QueryAnytime qry _) = encodeQueryAnytimeResult      qry
-  encodeResult _ version (QueryHardFork qry)  = encodeQueryHardForkResult epf qry
-    where
-      epf = eraParamsFormatFromVersion version
+  encodeResult _ _ (QueryAnytime qry _) = encodeQueryAnytimeResult  qry
+  encodeResult _ _ (QueryHardFork qry)  = encodeQueryHardForkResult qry
 
   decodeResult ccfg version (QueryIfCurrent qry) =
       case isNonEmpty (Proxy @xs) of
@@ -315,17 +309,8 @@ instance SerialiseHFC xs
     where
       ccfgs = getPerEraCodecConfig $ hardForkCodecConfigPerEra ccfg
 
-  decodeResult _ _       (QueryAnytime qry _) = decodeQueryAnytimeResult      qry
-  decodeResult _ version (QueryHardFork qry)  = decodeQueryHardForkResult epf qry
-    where
-      epf = eraParamsFormatFromVersion version
-
-eraParamsFormatFromVersion :: HardForkNodeToClientVersion xs -> EraParamsFormat
-eraParamsFormatFromVersion = \case
-    HardForkNodeToClientDisabled _ -> throw HardForkEncoderQueryHfcDisabled
-    HardForkNodeToClientEnabled v _
-      | v >= HardForkSpecificNodeToClientVersion3 -> EraParamsWithGenesisWindow
-      | otherwise                                 -> EraParamsWithoutGenesisWindow
+  decodeResult _ _ (QueryAnytime qry _) = decodeQueryAnytimeResult  qry
+  decodeResult _ _ (QueryHardFork qry)  = decodeQueryHardForkResult qry
 
 encodeQueryIfCurrentResult ::
      All SerialiseConstraintsHFC xs

ouroboros-consensus/src/ouroboros-consensus/Ouroboros/Consensus/HardFork/History/EraParams.hs

@@ -2,7 +2,6 @@
 {-# LANGUAGE DeriveGeneric #-}
 {-# LANGUAGE DerivingStrategies #-}
 {-# LANGUAGE FlexibleContexts #-}
-{-# LANGUAGE InstanceSigs #-}
 {-# LANGUAGE LambdaCase #-}
 {-# LANGUAGE OverloadedStrings #-}
 {-# LANGUAGE RecordWildCards #-}
@@ -15,16 +14,13 @@ module Ouroboros.Consensus.HardFork.History.EraParams (
   , SafeZone (..)
     -- * Defaults
   , defaultEraParams
-    -- * Serialisation
-  , EraParamsFormat (..)
   ) where
 
 import           Cardano.Binary (enforceSize)
 import           Codec.CBOR.Decoding (Decoder, decodeListLen, decodeWord8)
 import           Codec.CBOR.Encoding (Encoding, encodeListLen, encodeWord8)
 import           Codec.Serialise (Serialise (..))
 import           Control.Monad (void)
-import           Data.Reflection (Given (..))
 import           Data.Word
 import           GHC.Generics (Generic)
 import           NoThunks.Class (NoThunks)
@@ -233,44 +229,19 @@ decodeSafeBeforeEpoch = do
       (2, 1) -> void $ decode @EpochNo
       _      -> fail $ "SafeBeforeEpoch: invalid size and tag " <> show (size, tag)
 
--- | Older versions are not aware of the Genesis window as part of 'EraParams',
--- so we need to stay backwards-compatible for now. This type can be removed
--- once mainnet is in Conway (as we can then always use the behavior of
--- 'EraParamsWithGenesisWindow').
-data EraParamsFormat =
-    EraParamsWithoutGenesisWindow
-  | EraParamsWithGenesisWindow
-  deriving stock (Show, Eq)
-
-instance Given EraParamsFormat => Serialise EraParams where
+instance Serialise EraParams where
   encode EraParams{..} = mconcat $ [
-        encodeListLen $ case epf of
-          EraParamsWithoutGenesisWindow -> 3
-          EraParamsWithGenesisWindow    -> 4
+        encodeListLen 4
       , encode (unEpochSize eraEpochSize)
       , encode eraSlotLength
       , encode eraSafeZone
-      ] <> case epf of
-        EraParamsWithoutGenesisWindow -> []
-        EraParamsWithGenesisWindow    ->
-          [encode (unGenesisWindow eraGenesisWin)]
-    where
-      epf :: EraParamsFormat
-      epf = given
+      , encode (unGenesisWindow eraGenesisWin)
+      ]
 
   decode = do
-      enforceSize "EraParams" $ case epf of
-        EraParamsWithoutGenesisWindow -> 3
-        EraParamsWithGenesisWindow    -> 4
+      enforceSize "EraParams" 4
       eraEpochSize  <- EpochSize <$> decode
       eraSlotLength <- decode
       eraSafeZone   <- decode
-      eraGenesisWin <- GenesisWindow <$> case epf of
-        -- Note that only the client will ever decode 'EraParams', as part of the
-        -- 'GetInterpreter' query.
-        EraParamsWithoutGenesisWindow -> pure 0
-        EraParamsWithGenesisWindow    -> decode
+      eraGenesisWin <- GenesisWindow <$> decode
       return EraParams{..}
-    where
-      epf :: EraParamsFormat
-      epf = given

ouroboros-consensus/src/ouroboros-consensus/Ouroboros/Consensus/HardFork/History/Qry.hs

@@ -49,7 +49,6 @@ import           Data.Fixed (divMod')
 import           Data.Foldable (toList)
 import           Data.Functor.Identity
 import           Data.Kind (Type)
-import           Data.Reflection (Given)
 import           Data.SOP.NonEmpty (NonEmpty (..))
 import           Data.SOP.Sing (SListI)
 import           Data.Time hiding (UTCTime)
@@ -423,7 +422,7 @@ runQueryPure q = either throw id . runQuery q
 newtype Interpreter xs = Interpreter (Summary xs)
   deriving (Eq)
 
-deriving instance (SListI xs, Given EraParamsFormat) => Serialise (Interpreter xs)
+deriving instance SListI xs => Serialise (Interpreter xs)
 
 instance Show (Interpreter xs) where
   show _ = "<Interpreter>"

ouroboros-consensus/src/ouroboros-consensus/Ouroboros/Consensus/HardFork/History/Summary.hs

@@ -53,7 +53,6 @@ import           Data.Bifunctor
 import           Data.Foldable (toList)
 import           Data.Kind (Type)
 import           Data.Proxy
-import           Data.Reflection (Given)
 import           Data.SOP.Counting
 import           Data.SOP.NonEmpty
 import           Data.SOP.Sing (SListI, lengthSList)
@@ -474,7 +473,7 @@ instance Serialise EraEnd where
         return EraUnbounded
       _ -> EraEnd <$> decode
 
-instance Given EraParamsFormat => Serialise EraSummary where
+instance Serialise EraSummary where
   encode EraSummary{..} = mconcat [
         encodeListLen 3
       , encode eraStart
@@ -489,7 +488,7 @@ instance Given EraParamsFormat => Serialise EraSummary where
       eraParams <- decode
       return EraSummary{..}
 
-instance (SListI xs, Given EraParamsFormat) => Serialise (Summary xs) where
+instance SListI xs => Serialise (Summary xs) where
   encode (Summary eraSummaries) = encode (toList eraSummaries)
 
   -- @xs@ is the list of eras that is statically known to us; the server has a