Add Test.Cardano.Ledger.Core.Binary.Golden.goldenExampleEraTxCborSpec in cardano-ledger-core:testlib and generate the golden example transactions for each era.

`goldenExampleEraTxCborSpec` allows us to generate a `Spec` for
generating a `golden/tx.cbor` golden file out of some `Tx` provided as a
parameter.

Then, for each era's test-suite, we call this function to generate the
golden file using the example transaction we have defined for each era.

We also extended `EraTest` so that we don't need to manually call
`getDataFileName` in order to get the fullpath for each era's cabal
project.

We also create new `Binary.Golden` modules for Mary and Babbage (previously
they reused Allegra's and Alonzo's respectively, which used the wrong era's
example transactions).

Additionally, fix `exampleDijkstraBasedTopTx` to not add PlutusV4 scripts
to `scriptTxWitsL`: PlutusV4 is not included in Dijkstra's
`transaction_witness_set` CDDL, so those scripts were
silently dropped during serialization, causing a roundtrip failure.

Author: koslambrou

eras/allegra/impl/CHANGELOG.md

@@ -17,7 +17,7 @@
 * Make `Test.Cardano.Ledger.Allegra.Imp.spec` accept `Proxy era`
 * In `Test.Cardano.Ledger.Allegra.Examples`:
   - Remove `mkAllegraBasedExampleTx`, `exampleAllegraBasedTxBody`, `exampleAllegraBasedShelleyTxBody`
-  - Add `exampleAllegraBasedTx`
+  - Add `exampleAllegraBasedTx`, `exampleAllegraTx`
 
 ## 1.9.0.0
 

eras/allegra/impl/cardano-ledger-allegra.cabal

@@ -11,7 +11,10 @@ description:
 
 category: Network
 build-type: Simple
-data-files: cddl/data/allegra.cddl
+data-files:
+  cddl/data/allegra.cddl
+  golden/*.cbor
+
 extra-source-files: CHANGELOG.md
 
 source-repository head

eras/allegra/impl/golden/tx.cbor

@@ -1,4 +1,5 @@
 {-# LANGUAGE TypeApplications #-}
+{-# OPTIONS_GHC -Wno-orphans #-}
 
 module Main where
 
@@ -8,7 +9,6 @@ import qualified Test.Cardano.Ledger.Allegra.Binary.Golden as Golden
 import qualified Test.Cardano.Ledger.Allegra.BinarySpec as BinarySpec
 import qualified Test.Cardano.Ledger.Allegra.Imp as Imp
 import Test.Cardano.Ledger.Allegra.ImpTest ()
-import Test.Cardano.Ledger.Common
 import Test.Cardano.Ledger.Core.JSON (roundTripJsonEraSpec)
 import Test.Cardano.Ledger.Era
 import qualified Test.Cardano.Ledger.Shelley.Imp as Imp (shelleyEraSpecificSpec)
@@ -21,12 +21,9 @@ instance EraSpec AllegraEra where
 
 main :: IO ()
 main =
-  ledgerTestMain $
-    describe "Allegra" $ do
-      BinarySpec.spec
-      CddlSpec.spec
-      describe "Imp" $ do
-        Imp.spec @AllegraEra
-      roundTripJsonEraSpec @AllegraEra
-      roundTripJsonShelleyEraSpec @AllegraEra
-      Golden.spec @AllegraEra
+  ledgerEraTestMain @AllegraEra $ do
+    BinarySpec.spec
+    CddlSpec.spec
+    roundTripJsonEraSpec @AllegraEra
+    roundTripJsonShelleyEraSpec @AllegraEra
+    Golden.spec @AllegraEra

eras/allegra/impl/test/Main.hs

@@ -12,8 +12,10 @@ import Cardano.Ledger.Allegra.Core
 import Cardano.Ledger.Allegra.Scripts
 import Cardano.Ledger.MemoBytes (EqRaw)
 import Cardano.Ledger.Plutus (emptyCostModels)
+import Paths_cardano_ledger_allegra (getDataFileName)
 import Test.Cardano.Ledger.Allegra.Arbitrary ()
 import Test.Cardano.Ledger.Allegra.Binary.Annotator ()
+import Test.Cardano.Ledger.Allegra.Examples (exampleAllegraTx)
 import Test.Cardano.Ledger.Allegra.TreeDiff ()
 import Test.Cardano.Ledger.Common
 import Test.Cardano.Ledger.Shelley.Era
@@ -37,6 +39,10 @@ instance EraTest AllegraEra where
 
   accountsFromAccountsMap = shelleyAccountsFromAccountsMap
 
+  mkEraFullPath = getDataFileName
+
+  exampleTx = exampleAllegraTx
+
 instance ShelleyEraTest AllegraEra
 
 instance AllegraEraTest AllegraEra

eras/allegra/impl/testlib/Test/Cardano/Ledger/Allegra/Era.hs

@@ -8,6 +8,7 @@
 -- don't care, we are only interested in serialisation, not validation.
 module Test.Cardano.Ledger.Allegra.Examples (
   ledgerExamples,
+  exampleAllegraTx,
   exampleAllegraBasedTx,
 ) where
 
@@ -49,14 +50,14 @@ ledgerExamples =
     exampleCoin
     exampleAllegraTx
     NoGenesis
-  where
-    exampleAllegraTx :: Tx TopTx AllegraEra
-    exampleAllegraTx =
-      exampleAllegraBasedTx
-        & addShelleyBasedTopTxExampleFee
-        & addShelleyToBabbageExampleProposedPUpdates
-        & addShelleyToBabbageTxCerts
-        & addShelleyToConwayTxCerts
+
+exampleAllegraTx :: Tx TopTx AllegraEra
+exampleAllegraTx =
+  exampleAllegraBasedTx
+    & addShelleyBasedTopTxExampleFee
+    & addShelleyToBabbageExampleProposedPUpdates
+    & addShelleyToBabbageTxCerts
+    & addShelleyToConwayTxCerts
 
 -- Complete transaction which is compatible with any era starting with Allegra.
 -- This transaction forms the basis on which future era transactions will be

eras/allegra/impl/testlib/Test/Cardano/Ledger/Allegra/Examples.hs

@@ -16,10 +16,11 @@ import Test.Cardano.Ledger.Imp.Common
 import qualified Test.Cardano.Ledger.Shelley.Imp as Shelley
 
 spec ::
-  forall era.
+  forall proxy era.
   ( ShelleyEraImp era
   , Event (EraRule "RUPD" era) ~ RupdEvent
   ) =>
+  proxy era ->
   Spec
 spec era = do
   Shelley.spec era

eras/allegra/impl/testlib/Test/Cardano/Ledger/Allegra/Imp.hs

@@ -49,7 +49,7 @@
 * `TranslationInstance` has a new field `tiPlutusPurpose`
 * In `Test.Cardano.Ledger.Alonzo.Examples`:
   - Remove `mkAlonzoBasedExampleTx`, `exampleAlonzoBasedShelleyTxBody`, `exampleAlonzoBasedTxBody`, `exampleRedeemer`
-  - Add `exampleAlonzoBasedTopTx`, `exampleAlonzoBasedTopTx`, `addAlonzoToConwayExampleReqSigners`
+  - Add `exampleAlonzoTx`, `exampleAlonzoBasedTopTx`, `exampleAlonzoBasedTopTx`, `addAlonzoToConwayExampleReqSigners`
 
 ## 1.15.0.0
 

eras/alonzo/impl/CHANGELOG.md

@@ -1,4 +1,5 @@
 {-# LANGUAGE TypeApplications #-}
+{-# OPTIONS_GHC -Wno-orphans #-}
 
 module Main where
 
@@ -8,7 +9,7 @@ import qualified Test.Cardano.Ledger.Alonzo.Binary.CddlSpec as CddlSpec
 import qualified Test.Cardano.Ledger.Alonzo.Binary.CostModelsSpec as CostModelsSpec
 import qualified Test.Cardano.Ledger.Alonzo.Binary.TxWitsSpec as TxWitsSpec
 import qualified Test.Cardano.Ledger.Alonzo.BinarySpec as BinarySpec
-import qualified Test.Cardano.Ledger.Alonzo.GoldenSpec as Golden
+import qualified Test.Cardano.Ledger.Alonzo.GoldenSpec as GoldenSpec
 import qualified Test.Cardano.Ledger.Alonzo.GoldenTranslation as GoldenTranslation
 import qualified Test.Cardano.Ledger.Alonzo.Imp as Imp
 import qualified Test.Cardano.Ledger.Alonzo.Imp.TxInfoSpec as TxInfoImp
@@ -27,19 +28,16 @@ instance EraSpec AlonzoEra where
 
 main :: IO ()
 main =
-  ledgerTestMain $
-    describe "Alonzo" $ do
-      BinarySpec.spec
-      Canonical.spec
-      CddlSpec.spec
-      roundTripJsonEraSpec @AlonzoEra
-      roundTripJsonShelleyEraSpec @AlonzoEra
-      GoldenTranslation.tests
-      Golden.spec
-      describe "Imp" $ do
-        Imp.spec @AlonzoEra
-      describe "CostModels" $ do
-        CostModelsSpec.spec @AlonzoEra
-      describe "TxWits" $ do
-        TxWitsSpec.spec @AlonzoEra
-      TxInfoImp.spec
+  ledgerEraTestMain @AlonzoEra $ do
+    BinarySpec.spec
+    Canonical.spec
+    CddlSpec.spec
+    roundTripJsonEraSpec @AlonzoEra
+    roundTripJsonShelleyEraSpec @AlonzoEra
+    GoldenTranslation.tests
+    GoldenSpec.spec
+    describe "CostModels" $ do
+      CostModelsSpec.spec @AlonzoEra
+    describe "TxWits" $ do
+      TxWitsSpec.spec @AlonzoEra
+    TxInfoImp.spec