Export upgrade functions from individual api modules

Author: teodanciu

libs/cardano-ledger-api/CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## 1.12.0.0
 
+* Expose `binaryUpgradeTx`, `binaryUpgradeTxBody`, `binaryUpgradeTxWits`, `binaryUpgradeTxAuxData`, `upgradeTx`, `upgradeTxBody`, `upgradeTxWits`, `upgradeTxAuxData`
 * Add `EraApi` class
 * Export `VotingProcedure`, `ProposalProcedure`, `currentTreasuryValueTxBodyL` and
   `treasuryDonationTxBodyL` from `Cardano.Ledger.Api.Tx.Body`

libs/cardano-ledger-api/src/Cardano/Ledger/Api/Tx.hs

@@ -64,10 +64,14 @@ module Cardano.Ledger.Api.Tx (
   evalTxExUnitsWithLogs,
   RedeemerReportWithLogs,
   TransactionScriptFailure (..),
+
+  -- * Upgrade
+  binaryUpgradeTx,
+  upgradeTx,
 ) where
 
 import Cardano.Ledger.Alonzo.Tx (AlonzoEraTx (..), IsValid (..))
-import Cardano.Ledger.Api.Era ()
+import Cardano.Ledger.Api.Era (EraApi (..))
 import Cardano.Ledger.Api.Scripts.ExUnits (
   RedeemerReport,
   RedeemerReportWithLogs,
@@ -79,5 +83,5 @@ import Cardano.Ledger.Api.Tx.AuxData
 import Cardano.Ledger.Api.Tx.Body
 import Cardano.Ledger.Api.Tx.Cert
 import Cardano.Ledger.Api.Tx.Wits
-import Cardano.Ledger.Core (EraTx (..), txIdTx)
+import Cardano.Ledger.Core (EraTx (..), binaryUpgradeTx, txIdTx)
 import Cardano.Ledger.Tools (calcMinFeeTx, estimateMinFeeTx, setMinFeeTx, setMinFeeTxUtxo)

libs/cardano-ledger-api/src/Cardano/Ledger/Api/Tx/AuxData.hs

@@ -20,6 +20,10 @@ module Cardano.Ledger.Api.Tx.AuxData (
   AlonzoTxAuxData (..),
   mkAlonzoTxAuxData,
   getAlonzoTxAuxDataScripts,
+
+  -- * Upgrade
+  binaryUpgradeTxAuxData,
+  upgradeTxAuxData,
 ) where
 
 import Cardano.Ledger.Allegra.TxAuxData (AllegraEraTxAuxData (..), AllegraTxAuxData (..))
@@ -29,6 +33,6 @@ import Cardano.Ledger.Alonzo.TxAuxData (
   getAlonzoTxAuxDataScripts,
   mkAlonzoTxAuxData,
  )
-import Cardano.Ledger.Api.Era ()
-import Cardano.Ledger.Core (EraTxAuxData (..), hashTxAuxData)
+import Cardano.Ledger.Api.Era (EraApi (..))
+import Cardano.Ledger.Core (EraTxAuxData (..), binaryUpgradeTxAuxData, hashTxAuxData)
 import Cardano.Ledger.Shelley.TxAuxData (Metadatum (..), ShelleyTxAuxData (..))

libs/cardano-ledger-api/src/Cardano/Ledger/Api/Tx/Body.hs

@@ -69,12 +69,16 @@ module Cardano.Ledger.Api.Tx.Body (
   ProposalProcedure (..),
   currentTreasuryValueTxBodyL,
   treasuryDonationTxBodyL,
+
+  -- * Upgrade
+  binaryUpgradeTxBody,
+  upgradeTxBody,
 ) where
 
 import Cardano.Ledger.Address (Withdrawals (..))
 import Cardano.Ledger.Allegra.Core (AllegraEraTxBody (..))
 import Cardano.Ledger.Alonzo.TxBody (AlonzoEraTxBody (..))
-import Cardano.Ledger.Api.Era ()
+import Cardano.Ledger.Api.Era (EraApi (..))
 import Cardano.Ledger.Api.Scripts
 import Cardano.Ledger.Api.Tx.Out
 import Cardano.Ledger.AuxiliaryData (AuxiliaryDataHash)
@@ -86,7 +90,14 @@ import Cardano.Ledger.Conway.Governance (
   VotingProcedure (..),
  )
 import Cardano.Ledger.Conway.TxBody (ConwayEraTxBody (..))
-import Cardano.Ledger.Core (EraTxBody (..), PParams, TxAuxDataHash (..), Value, txIdTxBody)
+import Cardano.Ledger.Core (
+  EraTxBody (..),
+  PParams,
+  TxAuxDataHash (..),
+  Value,
+  binaryUpgradeTxBody,
+  txIdTxBody,
+ )
 import Cardano.Ledger.Credential (Credential)
 import Cardano.Ledger.Keys (KeyHash (..), KeyRole (..))
 import Cardano.Ledger.Mary.Core (MaryEraTxBody (..))

libs/cardano-ledger-api/src/Cardano/Ledger/Api/Tx/Wits.hs

@@ -37,6 +37,10 @@ module Cardano.Ledger.Api.Tx.Wits (
 
   -- ** Conway
   ConwayPlutusPurpose (..),
+
+  -- * Upgrade
+  binaryUpgradeTxWits,
+  upgradeTxWits,
 ) where
 
 import Cardano.Ledger.Alonzo.Scripts (
@@ -57,9 +61,9 @@ import Cardano.Ledger.Alonzo.TxWits (
   unTxDats,
   unTxDatsL,
  )
-import Cardano.Ledger.Api.Era ()
+import Cardano.Ledger.Api.Era (EraApi (..))
 import Cardano.Ledger.Conway.Scripts (ConwayPlutusPurpose (..))
-import Cardano.Ledger.Core (EraTxWits (..), hashScriptTxWitsL)
+import Cardano.Ledger.Core (EraTxWits (..), binaryUpgradeTxWits, hashScriptTxWitsL)
 import Cardano.Ledger.Keys (KeyRole (Witness))
 import Cardano.Ledger.Keys.Bootstrap (BootstrapWitness)
 import Cardano.Ledger.Keys.WitVKey (WitVKey (WitVKey), witVKeyHash)

libs/cardano-ledger-core/CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## 1.18.0.0
 
+* Added `binaryUpgradeTx`, `binaryUpgradeTxBody`, `binaryUpgradeTxWits`, `binaryUpgradeTxAuxData`
 * Remove `upgradeTx` and `TxUpgradeError` from `EraTx`
 * Remove `upgradeTxBody` and `TxBodyUpgradeError` from `EraTxBody`
 * Remove `upgradeTxAuxData` from `EraTxAuxData`

libs/cardano-ledger-core/src/Cardano/Ledger/Core.hs

@@ -4,6 +4,7 @@
 {-# LANGUAGE FlexibleContexts #-}
 {-# LANGUAGE FlexibleInstances #-}
 {-# LANGUAGE MultiParamTypeClasses #-}
+{-# LANGUAGE OverloadedStrings #-}
 {-# LANGUAGE PolyKinds #-}
 {-# LANGUAGE ScopedTypeVariables #-}
 {-# LANGUAGE TypeApplications #-}
@@ -43,6 +44,10 @@ module Cardano.Ledger.Core (
   EraPParams (..),
   mkCoinTxOut,
   wireSizeTxF,
+  binaryUpgradeTx,
+  binaryUpgradeTxBody,
+  binaryUpgradeTxWits,
+  binaryUpgradeTxAuxData,
 
   -- * Era
   module Cardano.Ledger.Core.Era,
@@ -76,6 +81,7 @@ import Cardano.Ledger.Binary (
   Annotator,
   DecCBOR,
   DecShareCBOR (Share),
+  DecoderError,
   EncCBOR (..),
   EncCBORGroup,
   Interns,
@@ -85,6 +91,7 @@ import Cardano.Ledger.Binary (
   mkSized,
   serialize,
   serialize',
+  translateViaCBORAnnotator,
  )
 import Cardano.Ledger.Coin (Coin)
 import Cardano.Ledger.Compactible (Compactible (..))
@@ -102,6 +109,7 @@ import Cardano.Ledger.Rewards (Reward (..), RewardType (..))
 import Cardano.Ledger.TxIn (TxId (..), TxIn (..))
 import Cardano.Ledger.Val (Val (..), inject)
 import Control.DeepSeq (NFData)
+import Control.Monad.Except (Except)
 import Data.Aeson (ToJSON)
 import qualified Data.ByteString as BS
 import qualified Data.ByteString.Lazy as LBS
@@ -114,6 +122,8 @@ import Data.MemPack
 import Data.Sequence.Strict (StrictSeq)
 import Data.Set (Set)
 import qualified Data.Set as Set
+import Data.Text (Text)
+import qualified Data.Text as T
 import Data.Word (Word32, Word64)
 import GHC.Stack (HasCallStack)
 import Lens.Micro
@@ -611,3 +621,38 @@ wireSizeTxF =
         then fromIntegral n
         else error $ "Impossible: Size of the transaction is too big: " ++ show n
 {-# INLINEABLE wireSizeTxF #-}
+
+-- | Translate a transaction through its binary representation from previous to current era.
+binaryUpgradeTx ::
+  forall era.
+  (Era era, ToCBOR (Tx (PreviousEra era)), DecCBOR (Annotator (Tx era))) =>
+  Tx (PreviousEra era) ->
+  Except DecoderError (Tx era)
+binaryUpgradeTx = translateViaCBORAnnotator (eraProtVerLow @era) (withEraName @era "Tx")
+
+-- | Translate a tx body through its binary representation from previous to current era.
+binaryUpgradeTxBody ::
+  forall era.
+  (Era era, ToCBOR (TxBody (PreviousEra era)), DecCBOR (Annotator (TxBody era))) =>
+  TxBody (PreviousEra era) ->
+  Except DecoderError (TxBody era)
+binaryUpgradeTxBody = translateViaCBORAnnotator (eraProtVerLow @era) (withEraName @era "TxBody")
+
+-- | Translate tx witnesses through its binary representation from previous to current era.
+binaryUpgradeTxWits ::
+  forall era.
+  (Era era, ToCBOR (TxWits (PreviousEra era)), DecCBOR (Annotator (TxWits era))) =>
+  TxWits (PreviousEra era) ->
+  Except DecoderError (TxWits era)
+binaryUpgradeTxWits = translateViaCBORAnnotator (eraProtVerLow @era) (withEraName @era "TxWits")
+
+-- | Translate tx auxData through its binary representation from previous to current era.
+binaryUpgradeTxAuxData ::
+  forall era.
+  (Era era, ToCBOR (TxAuxData (PreviousEra era)), DecCBOR (Annotator (TxAuxData era))) =>
+  TxAuxData (PreviousEra era) ->
+  Except DecoderError (TxAuxData era)
+binaryUpgradeTxAuxData = translateViaCBORAnnotator (eraProtVerLow @era) (withEraName @era "TxAuxData")
+
+withEraName :: forall era. Era era => Text -> Text
+withEraName t = t <> " " <> T.pack (eraName @era) <> "Era"