Exclude byron version from roundtrip testing. Update changelog.

IntersectMBO · Dec 20, 2022 · 7236776 · 7236776
1 parent 4296509
commit 7236776
Show file tree

Hide file tree

Showing 6 changed files with 23 additions and 17 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -230,6 +230,8 @@ in the naming of release branches.
 
 ### Removed
 
+- Deprecated `Cardano.Ledger.CompactAddress` module in favor of `Cardano.Ledger.Address`: #3218
+- Removed deprecated `Cardano.Ledger.Shelley.CompactAddr`: #3218
 - Removed depracted type synonyms: `ValidatedTx`, `TxOut`, `TxBody`, `TxSeq`, `Script`,
   `Value`, `PParamDelta`. #3205
 - Removed unused `deserialiseAddrStakeRef` function from `Address` module:  #3174

diff --git a/eras/babbage/test-suite/test/Test/Cardano/Ledger/Babbage/Serialisation/Tripping.hs b/eras/babbage/test-suite/test/Test/Cardano/Ledger/Babbage/Serialisation/Tripping.hs
@@ -10,7 +10,6 @@ import Cardano.Ledger.Babbage (Babbage)
 import Cardano.Ledger.Babbage.Rules (BabbageUtxoPredFailure)
 import Cardano.Ledger.Block (Block)
 import Cardano.Ledger.Core
-import Cardano.Ledger.Shelley.TxAuxData (ShelleyTxAuxData)
 import Cardano.Protocol.TPraos.BHeader (BHeader)
 import Test.Cardano.Ledger.Babbage.Serialisation.Generators ()
 import Test.Cardano.Ledger.Binary.RoundTrip
@@ -26,7 +25,7 @@ tests =
     [ testProperty "babbage/Script" $
         roundTripAnnExpectation @(Script Babbage),
       testProperty "babbage/Metadata" $
-        roundTripAnnExpectation @(ShelleyTxAuxData Babbage),
+        roundTripAnnExpectation @(TxAuxData Babbage),
       testProperty "babbage/TxOut" $
         roundTripCborExpectation @(TxOut Babbage),
       testProperty "babbage/TxBody" $

diff --git a/eras/shelley-ma/test-suite/test/Test/Cardano/Ledger/ShelleyMA/Serialisation/Timelocks.hs b/eras/shelley-ma/test-suite/test/Test/Cardano/Ledger/ShelleyMA/Serialisation/Timelocks.hs
@@ -45,11 +45,10 @@ timelockTests :: TestTree
 timelockTests =
   testGroup
     "Timelock tests"
-    [ testCase "s1" $ roundTripAnnExpectation (eraProtVerHigh @Allegra) s1,
-      testCase "s2" $ roundTripAnnExpectation (eraProtVerHigh @Allegra) s2,
-      testCase "s3" $ roundTripAnnExpectation (eraProtVerHigh @Allegra) s3,
-      testProperty "roundtripTimelock" $
-        roundTripAnnExpectation @(Timelock Shelley) (eraProtVerHigh @Allegra),
+    [ testCase "s1" $ roundTripAnnExpectation s1,
+      testCase "s2" $ roundTripAnnExpectation s2,
+      testCase "s3" $ roundTripAnnExpectation s3,
+      testProperty "roundtripTimelock" $ roundTripAnnExpectation @(Timelock Shelley),
       testProperty "MultiSig deserialises as Timelock" $
         embedTripAnnExpectation @(MultiSig Shelley)
           @(Timelock Allegra)

diff --git a/libs/cardano-ledger-binary/testlib/Test/Cardano/Ledger/Binary/RoundTrip.hs b/libs/cardano-ledger-binary/testlib/Test/Cardano/Ledger/Binary/RoundTrip.hs
@@ -1,4 +1,5 @@
 {-# LANGUAGE AllowAmbiguousTypes #-}
+{-# LANGUAGE DataKinds #-}
 {-# LANGUAGE FlexibleContexts #-}
 {-# LANGUAGE GADTs #-}
 {-# LANGUAGE LambdaCase #-}
@@ -49,7 +50,8 @@ import Test.QuickCheck hiding (label)
 
 -- =====================================================================
 
--- | Tests the roundtrip property using QuickCheck generators fro all possible versions
+-- | Tests the roundtrip property using QuickCheck generators for all possible versions
+-- starting with `shelleyProtVer`.
 roundTripSpec ::
   forall t.
   (Show t, Eq t, Typeable t, Arbitrary t) =>
@@ -82,7 +84,8 @@ roundTripFailureExpectation version x =
       expectationFailure $
         "Should not have deserialized: " ++ showExpr (CBORBytes (serialize' version x))
 
--- | Verify that round triping through the binary form holds fro all possible versions
+-- | Verify that round triping through the binary form holds for all versions starting
+-- with `shelleyProtVer`.
 --
 -- In other words check that:
 --
@@ -94,7 +97,7 @@ roundTripExpectation ::
   t ->
   Expectation
 roundTripExpectation trip t =
-  forM_ [minBound .. maxBound] $ \version ->
+  forM_ [natVersion @2 .. maxBound] $ \version ->
     case roundTrip version trip t of
       Left err -> expectationFailure $ "Failed to deserialize encoded: " ++ show err
       Right tDecoded -> tDecoded `shouldBe` t
@@ -108,13 +111,13 @@ roundTripCborExpectation = roundTripExpectation (cborTrip @t)
 
 roundTripAnnExpectation ::
   (Show t, Eq t, ToCBOR t, FromCBOR (Annotator t), HasCallStack) =>
-  Version ->
   t ->
   Expectation
-roundTripAnnExpectation version t =
-  case roundTripAnn version t of
-    Left err -> expectationFailure $ "Failed to deserialize encoded: " ++ show err
-    Right tDecoded -> tDecoded `shouldBe` t
+roundTripAnnExpectation t =
+  forM_ [natVersion @2 .. maxBound] $ \version ->
+    case roundTripAnn version t of
+      Left err -> expectationFailure $ "Failed to deserialize encoded: " ++ show err
+      Right tDecoded -> tDecoded `shouldBe` t
 
 roundTripTwiddledProperty ::
   (Show t, Eq t, Twiddle t, FromCBOR t) => Version -> t -> Property

diff --git a/libs/cardano-ledger-core/src/Cardano/Ledger/Address.hs b/libs/cardano-ledger-core/src/Cardano/Ledger/Address.hs
@@ -206,9 +206,9 @@ instance Crypto c => FromJSON (RewardAcnt c) where
     Aeson.withObject "RewardAcnt" $ \obj ->
       RewardAcnt
         <$> obj
-        .: "network"
+          .: "network"
         <*> obj
-        .: "credential"
+          .: "credential"
 
 instance NoThunks (RewardAcnt c)
 

diff --git a/libs/cardano-ledger-core/testlib/Test/Cardano/Ledger/Core/Address.hs b/libs/cardano-ledger-core/testlib/Test/Cardano/Ledger/Core/Address.hs
@@ -5,6 +5,9 @@
 {-# LANGUAGE ScopedTypeVariables #-}
 {-# LANGUAGE TypeApplications #-}
 
+-- | This module contains previous implementations for Addr and CoompactAddr
+-- deserialization. This is used as an alternative implementation for testing and as a
+-- perforance reference for benchmarking.
 module Test.Cardano.Ledger.Core.Address
   ( deserialiseAddrOld,
     deserialiseRewardAcntOld,