Change TransactionEnvelope to Transaction and only use Transaction type.

Remove ToJSON/FromJSON AlonzoTx instances

Author: locallycompact

CHANGELOG.md

@@ -42,6 +42,8 @@ changes.
 
 - Adapt cardano client and the chain-sync client to survive after the fork to Conway era.
 
+- **BREAKING** Transaction serialization on hydra-node api and persisted data changed.
+
 ## [0.14.0] - 2023-12-04
 
 - **BREAKING** Multiple changes to the Hydra Head protocol on-chain:

hydra-cluster/src/Hydra/Cluster/Scenarios.hs

@@ -48,7 +48,6 @@ import Hydra.Cardano.Api (
   mkVkAddress,
   selectLovelace,
   signTx,
-  toLedgerTx,
   toScriptData,
   writeFileTextEnvelope,
   pattern ReferenceScriptNone,
@@ -523,12 +522,12 @@ canSubmitTransactionThroughAPI tracer workDir node hydraScriptsTxId =
         Left e -> failure $ show e
         Right body -> do
           let unsignedTx = makeSignedTransaction [] body
-          let unsignedRequest = toJSON $ toLedgerTx unsignedTx
+          let unsignedRequest = toJSON unsignedTx
           sendRequest hydraNodeId unsignedRequest
             `shouldThrow` expectErrorStatus 400 (Just "MissingVKeyWitnessesUTXOW")
 
           let signedTx = signTx cardanoBobSk unsignedTx
-          let signedRequest = toJSON $ toLedgerTx signedTx
+          let signedRequest = toJSON signedTx
           (sendRequest hydraNodeId signedRequest <&> responseBody)
             `shouldReturn` TransactionSubmitted
  where

hydra-node/golden/Tx BabbageEra.json

@@ -161,8 +161,7 @@ channels:
           Cardano transaction to be submitted to the L1 network.
           Accepts transactions encoded as Base16 CBOR string, TextEnvelope type or JSON.
         payload:
-          oneOf:
-              - $ref: "api.yaml#/components/schemas/Transaction"
+          $ref: "api.yaml#/components/schemas/Transaction"
       bindings:
         http:
           type: response
@@ -239,8 +238,7 @@ components:
             type: string
             enum: ["NewTx"]
           transaction:
-            oneOf:
-              - $ref: "api.yaml#/components/schemas/Transaction"
+            $ref: "api.yaml#/components/schemas/Transaction"
 
     Close:
       title: Close

hydra-node/json-schemas/api.yaml

@@ -12,6 +12,8 @@ import Hydra.Prelude
 import Hydra.Cardano.Api hiding (initialLedgerState)
 import Hydra.Ledger.Cardano.Builder
 
+import Data.Aeson (object, (.:), (.=))
+import Data.Aeson qualified as Aeson
 import Cardano.Api.UTxO (fromPairs, pairs)
 import Cardano.Api.UTxO qualified as UTxO
 import Cardano.Crypto.DSIGN qualified as CC
@@ -50,6 +52,9 @@ import Test.QuickCheck (
   suchThat,
   vectorOf,
  )
+import qualified Data.ByteString.Base16 as Base16
+import Data.Aeson.Types (withObject)
+import Data.Aeson ((.:?))
 
 -- * Ledger
 
@@ -125,10 +130,20 @@ instance FromCBOR Tx where
         (pure . fromLedgerTx)
 
 instance ToJSON Tx where
-  toJSON = toJSON . toLedgerTx
+  toJSON tx = object [ "cborHex" .= (Aeson.String $ decodeUtf8 $ Base16.encode $ serialiseToCBOR tx) ]
 
 instance FromJSON Tx where
-  parseJSON = fmap fromLedgerTx . parseJSON
+    parseJSON =
+      withObject "Tx" $ \o -> do
+        let TextEnvelopeType envelopeType = textEnvelopeType (proxyToAsType (Proxy @Tx    ))
+        hexText <- o .: "cborHex"
+        (o .:? "type") >>= \case
+          Nothing -> pure ()
+          Just x -> guard (envelopeType == x)
+        bytes <- decodeBase16 hexText
+        case deserialiseFromCBOR (proxyToAsType (Proxy @Tx)) bytes of
+          Left e -> fail $ show e
+          Right x -> pure x
 
 instance Arbitrary Tx where
   -- TODO: shrinker!

hydra-node/src/Hydra/Ledger/Cardano.hs

@@ -11,35 +11,17 @@ module Hydra.Ledger.Cardano.Json where
 import Hydra.Cardano.Api
 import Hydra.Prelude
 
-import Cardano.Binary (serialize)
 import Cardano.Ledger.Api (Babbage)
-import Cardano.Ledger.Api qualified as Ledger
 import Cardano.Ledger.Api.Era (eraProtVerLow)
 import Cardano.Ledger.Babbage.PParams (BabbagePParams (..))
 import Cardano.Ledger.Babbage.PParams qualified as Ledger
-import Cardano.Ledger.Babbage.Tx qualified as Ledger
-import Cardano.Ledger.Binary (
-  DecCBOR,
-  EncCBOR,
-  decCBOR,
-  decodeFullAnnotator,
-  decodeFullDecoder,
- )
-import Cardano.Ledger.Binary.Decoding (Annotator)
 import Cardano.Ledger.Shelley.API qualified as Ledger
 import Data.Aeson (
-  Value (String),
-  withObject,
-  withText,
   (.!=),
   (.:),
   (.:?),
  )
 import Data.Aeson qualified as Aeson
-import Data.Aeson.Types (
-  Parser,
- )
-import Data.ByteString.Base16 qualified as Base16
 
 -- XXX: Maybe use babbagePParamsHKDPairs?
 instance FromJSON (Ledger.BabbagePParams Identity era) where
@@ -92,80 +74,3 @@ instance FromJSON (Ledger.BabbagePParams Identity era) where
           .: "collateralPercentage"
         <*> obj
           .: "maxCollateralInputs"
-
---
--- AlonzoTx
---
-
-instance
-  ( EncCBOR (Ledger.TxBody era)
-  , EncCBOR (Ledger.TxWits era)
-  , EncCBOR (Ledger.TxAuxData era)
-  , Ledger.EraTxBody era
-  , Ledger.Era era
-  ) =>
-  ToJSON (Ledger.AlonzoTx era)
-  where
-  toJSON = Aeson.String . decodeUtf8 . Base16.encode . toStrict . serialize
-
-instance
-  ( DecCBOR (Annotator (Ledger.TxBody era))
-  , DecCBOR (Annotator (Ledger.TxWits era))
-  , DecCBOR (Annotator (Ledger.TxAuxData era))
-  , Ledger.Era era
-  ) =>
-  FromJSON (Ledger.AlonzoTx era)
-  where
-  parseJSON value =
-    -- We accept transactions in three forms:
-    --
-    -- (1) As a JSON 'text-envelope', which is a format defined and produced by
-    -- the cardano-cli, wrapping base16-encoded strings as JSON objects with
-    -- tags.
-    parseAsEnvelopedBase16CBOR value
-      -- (2) As base16 string representing a CBOR-serialized transaction, since
-      -- this is the most common medium of exchange used for transactions.
-      <|> parseHexEncodedCborAnnotated @era "Tx" value
-   where
-    parseAsEnvelopedBase16CBOR =
-      withObject "Tx" $ \o -> do
-        let TextEnvelopeType envelopeType = textEnvelopeType (proxyToAsType (Proxy @Tx))
-        str <- o .: "cborHex"
-        guard . (== envelopeType) =<< (o .: "type")
-        parseHexEncodedCborAnnotated @era "Tx" (String str)
-
--- | Parse a hex-encoded CBOR value in given 'era'.
-parseHexEncodedCbor ::
-  forall era a.
-  (Ledger.Era era, DecCBOR a) =>
-  Text ->
-  Aeson.Value ->
-  Parser a
-parseHexEncodedCbor lbl =
-  withText (toString lbl) $ \t ->
-    case Base16.decode $ encodeUtf8 t of
-      Left e -> fail $ "failed to decode from base16: " <> show e
-      Right bs ->
-        case decodeFullDecoder version lbl decCBOR (fromStrict bs) of
-          Left err -> fail $ show err
-          Right v -> pure v
- where
-  version = Ledger.eraProtVerLow @era
-
--- | Parse a hex-encoded, annotated CBOR value in given 'era'.
-parseHexEncodedCborAnnotated ::
-  forall era a.
-  (Ledger.Era era, DecCBOR (Annotator a)) =>
-  Text ->
-  Aeson.Value ->
-  Parser a
-parseHexEncodedCborAnnotated lbl =
-  withText (toString lbl) $ \t ->
-    case Base16.decode $ encodeUtf8 t of
-      Left e -> fail $ "failed to decode from base16: " <> show e
-      Right bs ->
-        case decodeFullAnnotator version lbl decCBOR (fromStrict bs) of
-          Left err -> fail $ show err
-          Right v -> pure v
- where
-  version = Ledger.eraProtVerLow @era

hydra-node/src/Hydra/Ledger/Cardano/Json.hs

@@ -64,7 +64,7 @@ spec = do
                 Error e -> counterexample (toString $ toText e) $ property False
       prop "accepts json encoded transaction" $
         forAll (arbitrary @Tx) $ \tx ->
-          let json = toJSON (toLedgerTx tx)
+          let json = toJSON tx
            in case fromJSON @(SubmitTxRequest Tx) json of
                 Success{} -> property True
                 Error e -> counterexample (toString $ toText e) $ property False