Update golden files to reflect new serialization

Seems like cardano-api's serialiseToTextEnvelope is encoding a different 'type'. We are not using it for decoding anymore, but our golden files need updating because of this. Both formats are according to our api schema.
cardano-scaling · Sep 9, 2024 · db37458 · db37458
1 parent bb22f4b
commit db37458
Show file tree

Hide file tree

Showing 15 changed files with 208 additions and 199 deletions.
diff --git a/hydra-node/golden/ReasonablySized (ClientInput (Tx ConwayEra)).json b/hydra-node/golden/ReasonablySized (ClientInput (Tx ConwayEra)).json
diff --git a/hydra-node/golden/ReasonablySized (DraftCommitTxRequest (Tx ConwayEra)).json b/hydra-node/golden/ReasonablySized (DraftCommitTxRequest (Tx ConwayEra)).json
diff --git a/hydra-node/golden/ReasonablySized (DraftCommitTxResponse (Tx ConwayEra)).json b/hydra-node/golden/ReasonablySized (DraftCommitTxResponse (Tx ConwayEra)).json
diff --git a/hydra-node/golden/ReasonablySized (ServerOutput (Tx ConwayEra)).json b/hydra-node/golden/ReasonablySized (ServerOutput (Tx ConwayEra)).json
diff --git a/hydra-node/golden/ReasonablySized (SubmitTxRequest (Tx ConwayEra)).json b/hydra-node/golden/ReasonablySized (SubmitTxRequest (Tx ConwayEra)).json
diff --git a/hydra-node/golden/ReasonablySized (TimedServerOutput (Tx ConwayEra)).json b/hydra-node/golden/ReasonablySized (TimedServerOutput (Tx ConwayEra)).json
diff --git a/hydra-node/golden/StateChanged/DecommitRecorded.json b/hydra-node/golden/StateChanged/DecommitRecorded.json
diff --git a/hydra-node/golden/StateChanged/SnapshotRequested.json b/hydra-node/golden/StateChanged/SnapshotRequested.json
diff --git a/hydra-node/golden/StateChanged/TransactionAppliedToLocalUTxO.json b/hydra-node/golden/StateChanged/TransactionAppliedToLocalUTxO.json
diff --git a/hydra-node/golden/StateChanged/TransactionReceived.json b/hydra-node/golden/StateChanged/TransactionReceived.json
diff --git a/hydra-node/golden/StateEvent (Tx ConwayEra).json b/hydra-node/golden/StateEvent (Tx ConwayEra).json
diff --git a/hydra-node/json-schemas/api.yaml b/hydra-node/json-schemas/api.yaml
@@ -1982,10 +1982,20 @@ components:
         - cborHex
         - description
         - type
+      description: |
+        A Cardano transaction in the text envelope format . That is, a JSON
+        object wrapper with some 'type' around a 'cborHex' encoded transaction.
+        The hydra-node uses this format as follows:
+
+          - When encoding, an additonal 'txId' is included.
+          - On decoding, when 'txId' is included it is checked to be consistent.
+          - The 'type' is not used to determine content and any transaction is
+            tried to decode as a 'ConwayEra' transaction, which mostly is
+            backward compatible to previous eras.
       properties:
         type:
           type: string
-          enum: ["Tx ConwayEra", "Unwitnessed Tx ConwayEra", "Witnessed Tx ConwayEra"]
+          enum: ["Tx ConwayEra"]
         description:
           type: string
         cborHex:

diff --git a/hydra-tx/golden/ReasonablySized (Tx ConwayEra).json b/hydra-tx/golden/ReasonablySized (Tx ConwayEra).json
diff --git a/hydra-tx/hydra-tx.cabal b/hydra-tx/hydra-tx.cabal
@@ -95,7 +95,6 @@ library
     , hydra-plutus-extras
     , hydra-prelude
     , lens
-    , lens-aeson
     , ouroboros-consensus
     , ouroboros-consensus-cardano
     , plutus-core

diff --git a/hydra-tx/src/Hydra/Tx/IsTx.hs b/hydra-tx/src/Hydra/Tx/IsTx.hs
@@ -108,7 +108,7 @@ type ArbitraryIsTx tx =
 
 instance IsShelleyBasedEra era => ToJSON (Api.Tx era) where
   toJSON tx =
-    case toJSON $ serialiseToTextEnvelope (Just "Hydra-encoded cardano-api Tx") tx of
+    case toJSON $ serialiseToTextEnvelope Nothing tx of
       Aeson.Object km ->
         Aeson.Object $ KeyMap.insert "txId" (toJSON $ getTxId $ getTxBody tx) km
       v -> v