Preserve original CBOR bytes of ScriptData which has now been wrapped with

the `HashableScriptData` type. Prior to this commit we were constructing
transactions with `toAlonzoData` which created a ledger `Data`
value without using the original bytes. Although the content is the same
this can result in the re-encoded value differing slightly and therefore
resulting in differing script data hashes. See:
IntersectMBO/cardano-ledger#2943 for more
details.

Author: Jimbo4350

Diff for: cardano-api/ChangeLog.md

@@ -16,6 +16,9 @@
 
 - **Breaking change** - `deserialiseFromRawBytes` method of the `SerialiseAsRawBytes` type class to return `Either` instead of `Maybe`.  Deprecate `eitherDeserialiseFromRawBytes`.  Use `deserialiseFromRawBytes` instead.
 
+- **Breaking change** - Preserve ScriptData bytes with HashableScriptData ([PR4886](https://github.com/input-output-hk/cardano-node/pull/4886))
+
+
 ### Bugs
 
 - Allow reading text envelopes from pipes ([PR 4384](https://github.com/input-output-hk/cardano-node/pull/4384))

Diff for: cardano-api/cardano-api.cabal

@@ -196,9 +196,9 @@ library gen
                       , cardano-ledger-alonzo-test
                       , cardano-ledger-byron-test ^>= 1.4
                       , cardano-ledger-core ^>= 0.1
+                      , cardano-ledger-shelley ^>= 0.1
                       , containers
                       , hedgehog
-                      , cardano-ledger-shelley ^>= 0.1
                       , text
 
 test-suite cardano-api-test
@@ -216,11 +216,13 @@ test-suite cardano-api-test
                       , cardano-crypto-class ^>= 2.0
                       , cardano-crypto-test ^>= 1.4
                       , cardano-crypto-tests ^>= 2.0
+                      , cardano-ledger-alonzo ^>= 0.1
                       , cardano-ledger-core ^>= 0.1
                       , cardano-slotting ^>= 0.1
                       , containers
                       , hedgehog
                       , hedgehog-extras
+                      , mtl
                       , ouroboros-consensus
                       , ouroboros-consensus-shelley
                       , QuickCheck

Diff for: cardano-api/gen/Test/Gen/Cardano/Api/Typed.hs

@@ -27,6 +27,7 @@ module Test.Gen.Cardano.Api.Typed
   , genUTxO
 
     -- * Scripts
+  , genHashableScriptData
   , genReferenceScript
   , genScript
   , genSimpleScript
@@ -35,6 +36,7 @@ module Test.Gen.Cardano.Api.Typed
   , genScriptInEra
   , genScriptHash
   , genScriptData
+  , genScriptDataSchema
   , genScriptValidity
 
   , genAssetName
@@ -109,13 +111,14 @@ import           Cardano.Api hiding (txIns)
 import qualified Cardano.Api as Api
 import           Cardano.Api.Byron (KeyWitness (ByronKeyWitness),
                    WitnessNetworkIdOrByronAddress (..))
-import           Cardano.Api.Shelley (Hash (ScriptDataHash), KESPeriod (KESPeriod),
+import           Cardano.Api.Shelley (Hash (..), KESPeriod (KESPeriod),
                    OperationalCertificateIssueCounter (OperationalCertificateIssueCounter),
                    PlutusScript (PlutusScriptSerialised), ProtocolParameters (ProtocolParameters),
                    ReferenceScript (..), ReferenceTxInsScriptsInlineDatumsSupportedInEra (..),
                    StakeCredential (StakeCredentialByKey), StakePoolKey,
                    refInsScriptsAndInlineDatsSupportedInEra)
 
+
 import           Data.ByteString (ByteString)
 import qualified Data.ByteString as BS
 import qualified Data.ByteString.Short as SBS
@@ -220,6 +223,18 @@ genPlutusScript _ =
     -- We make no attempt to create a valid script
     PlutusScriptSerialised . SBS.toShort <$> Gen.bytes (Range.linear 0 32)
 
+genScriptDataSchema :: Gen ScriptDataJsonSchema
+genScriptDataSchema = Gen.element [ScriptDataJsonNoSchema, ScriptDataJsonDetailedSchema]
+
+genHashableScriptData :: Gen HashableScriptData
+genHashableScriptData = do
+  sd <- genScriptData
+  case deserialiseFromCBOR AsHashableScriptData $ serialiseToCBOR sd of
+    Left e -> error $ "genHashableScriptData: " <> show e
+    Right r -> return r
+
+
+{-# DEPRECATED genScriptData "Use genHashableScriptData" #-}
 genScriptData :: Gen ScriptData
 genScriptData =
     Gen.recursive
@@ -891,13 +906,13 @@ genTxOutDatumHashTxContext era = case era of
     AlonzoEra  -> Gen.choice
                     [ pure TxOutDatumNone
                     , TxOutDatumHash ScriptDataInAlonzoEra <$> genHashScriptData
-                    , TxOutDatumInTx ScriptDataInAlonzoEra <$> genScriptData
+                    , TxOutDatumInTx ScriptDataInAlonzoEra <$> genHashableScriptData
                     ]
     BabbageEra -> Gen.choice
                     [ pure TxOutDatumNone
                     , TxOutDatumHash ScriptDataInBabbageEra <$> genHashScriptData
-                    , TxOutDatumInTx ScriptDataInBabbageEra <$> genScriptData
-                    , TxOutDatumInline ReferenceTxInsScriptsInlineDatumsInBabbageEra <$> genScriptData
+                    , TxOutDatumInTx ScriptDataInBabbageEra <$> genHashableScriptData
+                    , TxOutDatumInline ReferenceTxInsScriptsInlineDatumsInBabbageEra <$> genHashableScriptData
                     ]
 
 genTxOutDatumHashUTxOContext :: CardanoEra era -> Gen (TxOutDatum CtxUTxO era)
@@ -913,7 +928,7 @@ genTxOutDatumHashUTxOContext era = case era of
     BabbageEra -> Gen.choice
                     [ pure TxOutDatumNone
                     , TxOutDatumHash ScriptDataInBabbageEra <$> genHashScriptData
-                    , TxOutDatumInline ReferenceTxInsScriptsInlineDatumsInBabbageEra <$> genScriptData
+                    , TxOutDatumInline ReferenceTxInsScriptsInlineDatumsInBabbageEra <$> genHashableScriptData
                     ]
 
 mkDummyHash :: forall h a. CRYPTO.HashAlgorithm h => Int -> CRYPTO.Hash h a

Diff for: cardano-api/src/Cardano/Api.hs

@@ -399,6 +399,10 @@ module Cardano.Api (
     examplePlutusScriptAlwaysFails,
 
     -- ** Script data
+    HashableScriptData,
+    hashScriptDataBytes,
+    getOriginalScriptDataBytes,
+    getScriptData,
     ScriptData(..),
     hashScriptData,
 
@@ -412,6 +416,8 @@ module Cardano.Api (
     scriptDataToJson,
     ScriptDataJsonError (..),
     ScriptDataJsonSchemaError (..),
+    ScriptDataJsonBytesError,
+    scriptDataJsonToHashable,
 
     -- ** Script execution units
     ExecutionUnits(..),

Diff for: cardano-api/src/Cardano/Api/Script.hs

@@ -792,13 +792,13 @@ instance Eq (ScriptWitness witctx era) where
 
     (==)  _ _ = False
 
-type ScriptRedeemer = ScriptData
+type ScriptRedeemer = HashableScriptData
 
 data ScriptDatum witctx where
-     ScriptDatumForTxIn    :: ScriptData -> ScriptDatum WitCtxTxIn
-     InlineScriptDatum     ::               ScriptDatum WitCtxTxIn
-     NoScriptDatumForMint  ::               ScriptDatum WitCtxMint
-     NoScriptDatumForStake ::               ScriptDatum WitCtxStake
+     ScriptDatumForTxIn    :: HashableScriptData -> ScriptDatum WitCtxTxIn
+     InlineScriptDatum     :: ScriptDatum WitCtxTxIn
+     NoScriptDatumForMint  :: ScriptDatum WitCtxMint
+     NoScriptDatumForStake :: ScriptDatum WitCtxStake
 
 deriving instance Eq   (ScriptDatum witctx)
 deriving instance Show (ScriptDatum witctx)