cardano-api: 8.46 -> 9.0 (#1497)

Notable changes:

- cardano-api deprecated `ProtocolParameters` and upstreamed JSON
encoding to `PParams` type from ledger. We follow suit and use that type
everywhere now.

- mkTermToEvaluate moved into PlutusLanguage type class in ledger
IntersectMBO/cardano-ledger#4480. Temporarily
requires a source-repository-package until released upstream.

- evaluateTransactionExecutionUnits returns a log now, which we do NOT
use right now.

cabal.project

@@ -15,6 +15,19 @@ index-state:
   , hackage.haskell.org 2024-07-09T19:07:04Z
   , cardano-haskell-packages 2024-07-09T19:04:02Z
 
+source-repository-package
+  type: git
+  location: https://github.com/IntersectMBO/cardano-ledger
+  tag: 516b4555c8c7b2faa821f05fdca9c9bb11a74d66
+  --sha256: sha256-4cPWwRAL815smViecuKZ2LAj/PSCI4ohdddFuJCiPxc=
+  subdir:
+    libs/cardano-ledger-core
+    eras/alonzo/impl
+    eras/conway/impl
+    eras/shelley/test-suite
+
+allow-newer: cardano-ledger-core
+
 packages:
   cardano-api-classy
   hydra-prelude

cardano-api-classy/cardano-api-classy.cabal

@@ -54,7 +54,7 @@ library
   -- dependencies on cardano-ledger* follow.
   build-depends:
     , base                   >=4.16
-    , cardano-api            ^>=8.46
+    , cardano-api            ^>=9.0
     , cardano-ledger-alonzo
     , cardano-ledger-conway
     , cardano-ledger-core

hydra-cardano-api/hydra-cardano-api.cabal

@@ -82,7 +82,7 @@ library
     , base                    >=4.16
     , base16-bytestring
     , bytestring
-    , cardano-api             ^>=8.46
+    , cardano-api             ^>=9.0
     , cardano-api-classy
     , cardano-binary
     , cardano-crypto-class

hydra-cardano-api/src/Hydra/Cardano/Api.hs

@@ -403,6 +403,8 @@ pattern TxBodyContent ::
   TxScriptValidity ->
   Maybe (Featured ConwayEraOnwards Era (TxProposalProcedures buidl Era)) ->
   Maybe (Featured ConwayEraOnwards Era (TxVotingProcedures buidl Era)) ->
+  Maybe (Featured ConwayEraOnwards Era Coin) ->
+  Maybe (Featured ConwayEraOnwards Era Coin) ->
   TxBodyContent buidl
 pattern TxBodyContent
   { txIns
@@ -425,6 +427,8 @@ pattern TxBodyContent
   , txScriptValidity
   , txProposalProcedures
   , txVotingProcedures
+  , txCurrentTreasuryValue
+  , txTreasuryDonation
   } <-
   Cardano.Api.TxBodyContent
     txIns
@@ -447,6 +451,8 @@ pattern TxBodyContent
     txScriptValidity
     txProposalProcedures
     txVotingProcedures
+    txCurrentTreasuryValue
+    txTreasuryDonation
   where
     TxBodyContent = Cardano.Api.TxBodyContent
 

hydra-cluster/hydra-cluster.cabal

@@ -87,6 +87,7 @@ library
     , async
     , base                  >=4.7 && <5
     , bytestring
+    , cardano-api
     , cardano-slotting
     , containers
     , contra-tracer

hydra-cluster/src/Hydra/Generator.hs

@@ -3,6 +3,7 @@ module Hydra.Generator where
 import Hydra.Cardano.Api
 import Hydra.Prelude hiding (size)
 
+import Cardano.Api.Ledger (PParams)
 import Cardano.Api.UTxO qualified as UTxO
 import CardanoClient (mkGenesisTx)
 import Control.Monad (foldM)
@@ -72,8 +73,8 @@ data ClientDataset = ClientDataset
   deriving stock (Show, Generic)
   deriving anyclass (ToJSON, FromJSON)
 
-defaultProtocolParameters :: ProtocolParameters
-defaultProtocolParameters = fromLedgerPParams ShelleyBasedEraShelley def
+defaultProtocolParameters :: PParams LedgerEra
+defaultProtocolParameters = def
 
 -- | Generate 'Dataset' which does not grow the per-client UTXO set over time.
 -- The sequence of transactions generated consist only of simple payments from

hydra-node/hydra-node.cabal

@@ -151,9 +151,9 @@ library
     , optparse-applicative
     , ouroboros-consensus
     , ouroboros-consensus-cardano
-    , ouroboros-network-api                                     ^>=0.7.1
+    , ouroboros-network-api                                     >=0.7.1
     , ouroboros-network-framework
-    , ouroboros-network-protocols                               ^>=0.8
+    , ouroboros-network-protocols                               >=0.8
     , plutus-core                                               >=1.21
     , plutus-ledger-api                                         >=1.21
     , prometheus

hydra-node/src/Hydra/API/HTTPServer.hs

@@ -14,8 +14,6 @@ import Hydra.API.APIServerLog (APIServerLog (..), Method (..), PathInfo (..))
 import Hydra.Cardano.Api (
   LedgerEra,
   Tx,
-  fromLedgerPParams,
-  shelleyBasedEra,
  )
 import Hydra.Chain (Chain (..), CommitBlueprintTx (..), IsChainState, PostTxError (..), draftCommitTx)
 import Hydra.Chain.Direct.State ()
@@ -148,8 +146,7 @@ httpApp tracer directChain pparams getInitializingHeadId getConfirmedUTxO reques
         >>= handleDraftCommitUtxo directChain getInitializingHeadId
         >>= respond
     ("GET", ["protocol-parameters"]) ->
-      respond . responseLBS status200 [] . Aeson.encode $
-        fromLedgerPParams shelleyBasedEra pparams
+      respond . responseLBS status200 [] . Aeson.encode $ pparams
     ("POST", ["cardano-transaction"]) ->
       consumeRequestBodyStrict request
         >>= handleSubmitUserTx directChain

hydra-node/src/Hydra/Chain/CardanoClient.hs

@@ -141,6 +141,8 @@ buildTransaction networkId socket changeAddress utxoToSpend collateral outs = do
       TxScriptValidityNone
       Nothing
       Nothing
+      Nothing
+      Nothing
 
 -- | Submit a (signed) transaction to the node.
 --
@@ -416,7 +418,7 @@ queryInShelleyBasedEraExpr sbe query =
 -- | Throws at least 'QueryException' if query fails.
 runQuery :: NetworkId -> SocketPath -> QueryPoint -> QueryInMode a -> IO a
 runQuery networkId socket point query =
-  queryNodeLocalState (localNodeConnectInfo networkId socket) queryTarget query >>= \case
+  runExceptT (queryNodeLocalState (localNodeConnectInfo networkId socket) queryTarget query) >>= \case
     Left err -> throwIO $ QueryAcquireException err
     Right result -> pure result
  where

hydra-node/src/Hydra/Chain/Direct/Wallet.hs

@@ -26,6 +26,7 @@ import Cardano.Ledger.Alonzo.TxWits (
   txscripts,
  )
 import Cardano.Ledger.Api (
+  BabbageEra,
   TransactionScriptFailure,
   bodyTxL,
   collateralInputsTxBodyL,
@@ -420,12 +421,12 @@ estimateScriptsCost ::
   Babbage.AlonzoTx LedgerEra ->
   Either ErrCoverFee (Map (PlutusPurpose AsIx LedgerEra) ExUnits)
 estimateScriptsCost pparams systemStart epochInfo utxo tx = do
-  case result of
-    Left translationError ->
-      Left $ ErrTranslationError translationError
-    Right units ->
-      Map.traverseWithKey (\ptr -> left $ ErrScriptExecutionFailed . (ptr,)) units
+  Map.traverseWithKey (\ptr -> left $ ErrScriptExecutionFailed . (ptr,)) result
  where
+  result ::
+    Map
+      (AlonzoPlutusPurpose AsIx LedgerEra)
+      (Either (TransactionScriptFailure (BabbageEra StandardCrypto)) ExUnits)
   result =
     evalTxExUnits
       pparams

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

@@ -74,6 +74,8 @@ emptyTxBody =
     TxScriptValidityNone
     Nothing
     Nothing
+    Nothing
+    Nothing
 
 -- | Add new inputs to an ongoing builder.
 addInputs :: TxIns BuildTx -> TxBodyContent BuildTx -> TxBodyContent BuildTx

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

@@ -1,3 +1,7 @@
+{-# OPTIONS_GHC -Wno-unrecognised-pragmas #-}
+
+{-# HLINT ignore "Use <$>" #-}
+
 -- | Simplified interface to phase-2 validation of transactions, eg. evaluation
 -- of Plutus scripts.
 --
@@ -17,10 +21,9 @@ import Cardano.Ledger.Alonzo.Plutus.Evaluate (collectPlutusScriptsWithContext)
 import Cardano.Ledger.Alonzo.Scripts (CostModel, Prices (..), mkCostModel, mkCostModels, txscriptfee)
 import Cardano.Ledger.Api (CoinPerByte (..), ppCoinsPerUTxOByteL, ppCostModelsL, ppMaxBlockExUnitsL, ppMaxTxExUnitsL, ppMaxValSizeL, ppMinFeeAL, ppMinFeeBL, ppPricesL, ppProtocolVersionL)
 import Cardano.Ledger.BaseTypes (BoundedRational (boundRational), ProtVer (..), natVersion)
-import Cardano.Ledger.Binary (getVersion)
 import Cardano.Ledger.Coin (Coin (Coin))
 import Cardano.Ledger.Core (PParams, ppMaxTxSizeL)
-import Cardano.Ledger.Plutus (PlutusDatums (unPlutusDatums), PlutusLanguage (decodePlutusRunnable), PlutusRunnable (..), PlutusWithContext (..))
+import Cardano.Ledger.Plutus (PlutusLanguage (decodePlutusRunnable, mkTermToEvaluate), PlutusWithContext (..))
 import Cardano.Ledger.Plutus.Language (Language (PlutusV2))
 import Cardano.Ledger.Val (Val ((<+>)), (<×>))
 import Cardano.Slotting.EpochInfo (EpochInfo, fixedEpochInfo)
@@ -75,8 +78,6 @@ import Ouroboros.Consensus.HardFork.History (
   mkInterpreter,
  )
 import PlutusCore qualified as PLC
-import PlutusLedgerApi.Common (mkTermToEvaluate)
-import PlutusLedgerApi.Common qualified as Plutus
 import Test.QuickCheck (Property, choose, counterexample, property)
 import Test.QuickCheck.Gen (chooseWord64)
 import UntypedPlutusCore (UnrestrictedProgram (..))
@@ -112,14 +113,26 @@ evaluateTx' maxUnits tx utxo = do
       | all isRight report -> checkBudget maxUnits report
       | otherwise -> Right report
  where
+  result ::
+    LedgerProtocolParameters UTxO.Era ->
+    Either
+      (TransactionValidityError UTxO.Era)
+      ( Map
+          ScriptWitnessIndex
+          ( Either
+              ScriptExecutionError
+              ExecutionUnits
+          )
+      )
   result pparams' =
-    evaluateTransactionExecutionUnits
-      cardanoEra
-      systemStart
-      (LedgerEpochInfo epochInfo)
-      pparams'
-      (UTxO.toApi utxo)
-      (getTxBody tx)
+    (fmap . fmap . fmap) snd $
+      evaluateTransactionExecutionUnits
+        cardanoEra
+        systemStart
+        (LedgerEpochInfo epochInfo)
+        pparams'
+        (UTxO.toApi utxo)
+        (getTxBody tx)
 
 -- | Check the budget used by provided 'EvaluationReport' does not exceed given
 -- maximum 'ExecutionUnits'.
@@ -220,12 +233,11 @@ prepareTxScripts tx utxo = do
 
   -- Fully applied UPLC programs which we could run using the cekMachine
   programs <- forM results $ \(PlutusWithContext protocolVersion script _ arguments _exUnits _costModel) -> do
-    (PlutusRunnable x) <-
+    x <-
       case script of
         Right runnable -> pure runnable
         Left serialised -> left show $ decodePlutusRunnable protocolVersion serialised
-    let majorProtocolVersion = Plutus.MajorProtocolVersion $ getVersion protocolVersion
-    appliedTerm <- left show $ mkTermToEvaluate Plutus.PlutusV2 majorProtocolVersion x (unPlutusDatums arguments)
+    appliedTerm <- left show $ mkTermToEvaluate protocolVersion x arguments
     pure $ UPLC.Program () PLC.latestVersion appliedTerm
 
   pure $ flat . UnrestrictedProgram <$> programs

hydra-node/test/Hydra/API/HTTPServerSpec.hs

@@ -9,9 +9,7 @@ import Data.Aeson.Lens (key, nth)
 import Hydra.API.HTTPServer (DraftCommitTxRequest (..), DraftCommitTxResponse (..), SubmitTxRequest (..), TransactionSubmitted, httpApp)
 import Hydra.API.ServerSpec (dummyChainHandle)
 import Hydra.Cardano.Api (
-  fromLedgerPParams,
   serialiseToTextEnvelope,
-  shelleyBasedEra,
  )
 import Hydra.Chain (Chain (draftCommitTx), PostTxError (..))
 import Hydra.Chain.Direct.Fixture (defaultPParams)
@@ -103,7 +101,7 @@ apiServerSpec = do
         it "responds given parameters" $
           get "/protocol-parameters"
             `shouldRespondWith` 200
-              { matchBody = matchJSON $ fromLedgerPParams shelleyBasedEra defaultPParams
+              { matchBody = matchJSON defaultPParams
               }
 
     describe "GET /snapshot/utxo" $ do

hydra-node/test/Hydra/Ledger/CardanoSpec.hs

@@ -59,8 +59,8 @@ spec =
 
       prop "Roundtrip to and from Api" roundtripFromAndToApi
 
-    describe "ProtocolParameters" $
-      prop "Roundtrip JSON encoding" roundtripProtocolParameters
+    describe "PParamss" $
+      prop "Roundtrip JSON encoding" roundtripPParams
 
     describe "Tx" $ do
       roundtripAndGoldenSpecs (Proxy @(ReasonablySized Tx))
@@ -114,19 +114,14 @@ roundtripFromAndToApi :: UTxO -> Property
 roundtripFromAndToApi utxo =
   fromApi (toApi utxo) === utxo
 
--- | Test that the 'ProtocolParameters' To/FromJSON instances to roundtrip. Note
--- that we use the ledger 'PParams' type to generate values, but the cardano-api
--- type 'ProtocolParameters' is used for the serialization.
-roundtripProtocolParameters :: PParams LedgerEra -> Property
-roundtripProtocolParameters pparams = do
-  case Aeson.decode (Aeson.encode expected) of
+-- | Test that the 'PParams' To/FromJSON instances to roundtrip.
+roundtripPParams :: PParams LedgerEra -> Property
+roundtripPParams pparams = do
+  case Aeson.decode (Aeson.encode pparams) of
     Nothing ->
       property False
     Just actual ->
-      (expected === actual)
-        & counterexample ("ledger: " <> show pparams)
- where
-  expected = fromLedgerPParams shelleyBasedEra pparams
+      pparams === actual
 
 roundtripTxId :: Tx -> Property
 roundtripTxId tx@(Tx body _) =

hydra-plutus-extras/src/Hydra/Plutus/Extras.hs

@@ -19,12 +19,12 @@ import Cardano.Api.Shelley (PlutusScript (PlutusScriptSerialised))
 import PlutusLedgerApi.Common (SerialisedScript)
 import PlutusLedgerApi.V2 (ScriptHash (..))
 import PlutusTx (BuiltinData, UnsafeFromData (..))
-import PlutusTx.Prelude (check, toBuiltin)
+import PlutusTx.Prelude (BuiltinUnit, check, toBuiltin)
 
 -- * Vendored from plutus-ledger
 
 -- | Signature of an untyped validator script.
-type ValidatorType = BuiltinData -> BuiltinData -> BuiltinData -> ()
+type ValidatorType = BuiltinData -> BuiltinData -> BuiltinData -> BuiltinUnit
 
 -- | Wrap a typed validator to get the basic `ValidatorType` signature which can
 -- be passed to `PlutusTx.compile`.
@@ -42,7 +42,7 @@ wrapValidator f d r c =
 {-# INLINEABLE wrapValidator #-}
 
 -- | Signature of an untyped minting policy script.
-type MintingPolicyType = BuiltinData -> BuiltinData -> ()
+type MintingPolicyType = BuiltinData -> BuiltinData -> BuiltinUnit
 
 -- | Wrap a typed minting policy to get the basic `MintingPolicyType` signature
 -- which can be passed to `PlutusTx.compile`.