Merge pull request #6577 from IntersectMBO/mgalazyn/test/rewrite-rpc-test-exp

cardano-testnet | Rewrite rpc tests using experimental api

Author: carbolymer

.github/workflows/haskell.yml

@@ -99,13 +99,13 @@ jobs:
       with:
         use-sodium-vrf: true # default is true
 
-    - name: Install gRPC dependencies
-      uses: intersectmbo/cardano-api/.github/actions/grpc-deps@a7bd74dfa6ccb1eb04f69791f978a3b9e0cc63ca
+    - name: Install gRPC system dependencies
+      uses: input-output-hk/cardano-dev/actions/grpc-deps@grpc-deps-0.0.1.0
 
     - uses: actions/checkout@v4
 
     - name: Cache and install Cabal dependencies
-      uses: intersectmbo/cardano-api/.github/actions/cabal-cache@a7bd74dfa6ccb1eb04f69791f978a3b9e0cc63ca
+      uses: input-output-hk/cardano-dev/actions/cabal-cache@cabal-cache-0.0.1.0
       with:
         cabal-store: ${{ steps.setup-haskell.outputs.cabal-store }}
         cache-version: ${{ env.CABAL_CACHE_VERSION }}

cardano-testnet/changelog.d/20260522_120000_mgalazyn_migrate_rpc_tests_to_experimental_api.md

@@ -0,0 +1,3 @@
+### Changed
+
+- Migrated RPC transaction and query tests from the old `Cardano.Api` transaction-building API to `Cardano.Api.Experimental`, using `Exp.ConwayEra` as the single era definition point, experimental tx body construction with direct ledger types, and `makeUnsignedTx`/`signTx` for transaction creation.

cardano-testnet/test/cardano-testnet-test/Cardano/Testnet/Test/Rpc/Query.hs

@@ -11,6 +11,7 @@ module Cardano.Testnet.Test.Rpc.Query
 where
 
 import           Cardano.Api
+import qualified Cardano.Api.Experimental as Exp
 import qualified Cardano.Api.Ledger as L
 
 import           Cardano.CLI.Type.Output (QueryTipLocalStateOutput (..))
@@ -50,8 +51,8 @@ hprop_rpc_query_pparams = integrationRetryWorkspace 2 "rpc-query-pparams" $ \tem
   conf@Conf{tempAbsPath} <- mkConf tempAbsBasePath'
   let tempAbsPath' = unTmpAbsPath tempAbsPath
 
-  let ceo = ConwayEraOnwardsConway
-      sbe = convert ceo
+  let era = Exp.ConwayEra
+      sbe = convert era
       eraName = eraToString sbe
       creationOptions = def{creationEra = AnyShelleyBasedEra sbe}
       runtimeOptions = def{runtimeEnableRpc = RpcEnabled}
@@ -65,7 +66,7 @@ hprop_rpc_query_pparams = integrationRetryWorkspace 2 "rpc-query-pparams" $ \tem
 
   execConfig <- mkExecConfig tempAbsPath' nodeSprocket testnetMagic
   epochStateView <- getEpochStateView configurationFile (nodeSocketPath node0)
-  pparams <- unLedgerProtocolParameters <$> getProtocolParams epochStateView ceo
+  pparams <- unLedgerProtocolParameters <$> getProtocolParams epochStateView (convert era)
   utxos <- findAllUtxos epochStateView sbe
   H.noteShowPretty_ utxos
   rpcSocket <- H.note . unFile $ nodeRpcSocketPath node0
@@ -103,7 +104,7 @@ hprop_rpc_query_pparams = integrationRetryWorkspace 2 "rpc-query-pparams" $ \tem
 
   -- https://docs.cardano.org/about-cardano/explore-more/parameter-guide
   let chainParams = pparamsResponse ^. U5c.values . U5c.cardano
-  babbageEraOnwardsConstraints (convert ceo) $ do
+  Exp.obtainCommonConstraints era $ do
     pparams ^. L.ppCoinsPerUTxOByteL . to L.unCoinPerByte . to L.fromCompact . to L.unCoin
       ===^ chainParams ^. U5c.coinsPerUtxoByte . to utxoRpcBigIntToInteger
     pparams ^. L.ppMaxTxSizeL === chainParams ^. U5c.maxTxSize . to fromIntegral
@@ -142,7 +143,7 @@ hprop_rpc_query_pparams = integrationRetryWorkspace 2 "rpc-query-pparams" $ \tem
     pparams ^. L.ppMinFeeRefScriptCostPerByteL . to L.unboundRational
       === chainParams ^. U5c.minFeeScriptRefCostPerByte . to inject
     let poolVotingThresholds :: L.PoolVotingThresholds =
-          conwayEraOnwardsConstraints ceo $
+          conwayEraOnwardsConstraints (convert era) $
             pparams ^. L.ppPoolVotingThresholdsL
     ( L.unboundRational
         <$> [ poolVotingThresholds ^. L.pvtMotionNoConfidenceL
@@ -154,7 +155,7 @@ hprop_rpc_query_pparams = integrationRetryWorkspace 2 "rpc-query-pparams" $ \tem
       )
       === chainParams ^. U5c.poolVotingThresholds . U5c.thresholds . to (map inject)
     let drepVotingThresholds :: L.DRepVotingThresholds =
-          conwayEraOnwardsConstraints ceo $
+          conwayEraOnwardsConstraints (convert era) $
             pparams ^. L.ppDRepVotingThresholdsL
     ( L.unboundRational
         <$> [ drepVotingThresholds ^. L.dvtMotionNoConfidenceL
@@ -183,7 +184,7 @@ hprop_rpc_query_pparams = integrationRetryWorkspace 2 "rpc-query-pparams" $ \tem
   -- Test readUtxos response
   --------------------------
 
-  utxoFromUtxoRpc <- H.leftFail $ utxosResponse ^. U5c.items . to (anyUtxoDataUtxoRpcToUtxo $ convert ceo)
+  utxoFromUtxoRpc <- H.leftFail $ utxosResponse ^. U5c.items . to (anyUtxoDataUtxoRpcToUtxo era)
   utxos === utxoFromUtxoRpc
 
 (===^) :: (Eq a, Show a, H.MonadTest m) => a -> Either SomeException a -> m ()

cardano-testnet/test/cardano-testnet-test/Cardano/Testnet/Test/Rpc/Transaction.hs

@@ -5,14 +5,15 @@
 {-# LANGUAGE OverloadedStrings #-}
 {-# LANGUAGE ScopedTypeVariables #-}
 {-# LANGUAGE TypeApplications #-}
-{-# LANGUAGE TypeOperators #-}
 
 module Cardano.Testnet.Test.Rpc.Transaction
   ( hprop_rpc_transaction
   )
 where
 
 import           Cardano.Api
+import qualified Cardano.Api.Experimental as Exp
+import qualified Cardano.Api.Experimental.Tx as Exp
 import qualified Cardano.Api.Ledger as L
 
 import           Cardano.Rpc.Client (Proto)
@@ -49,29 +50,28 @@ import           RIO (ByteString)
 hprop_rpc_transaction :: Property
 hprop_rpc_transaction = integrationRetryWorkspace 2 "rpc-tx" $ \tempAbsBasePath' -> H.runWithDefaultWatchdog_ $ do
   conf <- mkConf tempAbsBasePath'
-  let (ceo, eraProxy) =
-        (conwayBasedEra, asType) :: era ~ ConwayEra => (ConwayEraOnwards era, AsType era)
-      sbe = convert ceo
+  let era = Exp.ConwayEra
+      sbe = convert era
       creationOptions = def{creationEra = AnyShelleyBasedEra sbe}
       runtimeOptions = def{runtimeEnableRpc = RpcEnabled}
-      addrInEra = AsAddressInEra eraProxy
+      addressInEra = asAddressInEra sbe
 
   TestnetRuntime
     { configurationFile
     , testnetNodes = node0 : _
-    , wallets = wallet0@(PaymentKeyInfo _ addrTxt0) : (PaymentKeyInfo _ addrTxt1) : _
+    , wallets = wallet0@(PaymentKeyInfo _ addressText0) : (PaymentKeyInfo _ addressText1) : _
     } <-
     createAndRunTestnet creationOptions runtimeOptions conf
 
   epochStateView <- getEpochStateView configurationFile $ nodeSocketPath node0
   rpcSocket <- H.note . unFile $ nodeRpcSocketPath node0
 
   -- prepare tx inputs and output address
-  H.noteShow_ addrTxt0
-  addr0 <- H.nothingFail $ deserialiseAddress addrInEra addrTxt0
+  H.noteShow_ addressText0
+  address0 <- H.nothingFail $ deserialiseAddress addressInEra addressText0
 
-  H.noteShow_ addrTxt1
-  addr1 <- H.nothingFail $ deserialiseAddress addrInEra addrTxt1
+  H.noteShow_ addressText1
+  address1 <- H.nothingFail $ deserialiseAddress addressInEra addressText1
 
   -- read key witnesses
   wit0 :: ShelleyWitnessSigningKey <-
@@ -90,66 +90,69 @@ hprop_rpc_transaction = integrationRetryWorkspace 2 "rpc-tx" $ \tempAbsBasePath'
       Rpc.nonStreaming conn (Rpc.rpc @(Rpc.Protobuf UtxoRpc.QueryService "readParams")) req
 
     utxos' <- do
-      let req = def -- & # U5c.keys .~ [T.encodeUtf8 addrTxt0]
+      let req = def -- & # U5c.keys .~ [T.encodeUtf8 addressText0]
       Rpc.nonStreaming conn (Rpc.rpc @(Rpc.Protobuf UtxoRpc.QueryService "readUtxos")) req
     pure (pparams', utxos')
 
-  pparams <- H.leftFail $ utxoRpcPParamsToProtocolParams (convert ceo) $ pparamsResponse ^. U5c.values . U5c.cardano
+  pparams <- H.leftFail $ utxoRpcPParamsToProtocolParams era $ pparamsResponse ^. U5c.values . U5c.cardano
 
   txOut0 : _ <- H.noteShowM . flip filterM (utxosResponse ^. U5c.items) $ \utxo -> do
-    utxoAddress <- deserialiseAddressBs addrInEra $ utxo ^. U5c.cardano . U5c.address
-    pure $ addr0 == utxoAddress
+    utxoAddress <- deserialiseAddressBs addressInEra $ utxo ^. U5c.cardano . U5c.address
+    pure $ address0 == utxoAddress
   txIn0 <- txoRefToTxIn $ txOut0 ^. U5c.txoRef
 
   outputCoin <- H.leftFail $ txOut0 ^. U5c.cardano . U5c.coin . to utxoRpcBigIntToInteger
   let amount = 200_000_000
       fee = 500
       change = outputCoin - amount - fee
-      txOut = TxOut addr1 (lovelaceToTxOutValue sbe $ L.Coin amount) TxOutDatumNone ReferenceScriptNone
-      changeTxOut = TxOut addr0 (lovelaceToTxOutValue sbe $ L.Coin change) TxOutDatumNone ReferenceScriptNone
+      mkOut ledgerAddress coin = Exp.obtainCommonConstraints era $
+        Exp.TxOut $ L.mkBasicTxOut ledgerAddress $ L.inject $ L.Coin coin
       content =
-        defaultTxBodyContent sbe
-          & setTxIns [(txIn0, pure $ KeyWitness KeyWitnessForSpending)]
-          & setTxFee (TxFeeExplicit sbe (L.Coin fee))
-          & setTxOuts [txOut, changeTxOut]
-          & setTxProtocolParams (pure . pure $ LedgerProtocolParameters pparams)
+        Exp.defaultTxBodyContent
+          & Exp.setTxIns [(txIn0, Exp.AnyKeyWitnessPlaceholder)]
+          & Exp.setTxFee (L.Coin fee)
+          & Exp.setTxOuts [mkOut (toShelleyAddr address1) amount, mkOut (toShelleyAddr address0) change]
+          & Exp.setTxProtocolParams pparams
 
-  txBody <- H.leftFail $ createTransactionBody sbe content
-
-  let signedTx = signShelleyTransaction sbe txBody [wit0]
-  txId' <- H.noteShow . getTxId $ getTxBody signedTx
+  unsignedTx <- H.leftFail $ Exp.makeUnsignedTx era content
+  let keyWit = Exp.makeKeyWitness era unsignedTx wit0
+      Exp.SignedTx signedLedgerTx = Exp.signTx era [] [keyWit] unsignedTx
+  txId' <- H.noteShow . Exp.obtainCommonConstraints era . TxId $ Exp.hashTxBody (signedLedgerTx ^. L.bodyTxL)
 
   H.noteShowPretty_ utxosResponse
 
   liftBaseOp (Rpc.withConnection def rpcServer) $ \conn -> do
     submitResponse <- H.noteShowM . H.evalIO $
       Rpc.nonStreaming conn (Rpc.rpc @(Rpc.Protobuf UtxoRpc.SubmitService "submitTx")) $
-        def & U5c.tx .~ (def & U5c.raw .~ serialiseToCBOR signedTx)
+        def & U5c.tx .~ (def & U5c.raw .~ serialiseToRawBytes (Exp.SignedTx signedLedgerTx))
 
     submittedTxId <- H.leftFail . deserialiseFromRawBytes AsTxId $ submitResponse ^. U5c.ref
 
     H.note_ "Ensure that submitTx returns the same transaction ID as the locally computed signed transaction ID"
     txId' === submittedTxId
 
     -- TODO use searchUtxos when available
-    H.note_ $ "Ensure that there are 2 UTXOs in the address " <> show addrTxt1
+    H.note_ $ "Ensure that there are 2 UTXOs in the address " <> show addressText1
     utxosForAddress <- retryUntilM epochStateView (WaitForBlocks 10)
       (do utxos <- H.evalIO $
             Rpc.nonStreaming conn (Rpc.rpc @(Rpc.Protobuf UtxoRpc.QueryService "readUtxos")) def
           flip filterM (utxos ^. U5c.items) $ \utxo -> do
-            utxoAddress <- deserialiseAddressBs addrInEra $ utxo ^. U5c.cardano . U5c.address
-            pure $ addr1 == utxoAddress
+            utxoAddress <- deserialiseAddressBs addressInEra $ utxo ^. U5c.cardano . U5c.address
+            pure $ address1 == utxoAddress
       )
       (\xs -> length xs == 2)
 
     let outputsAmounts = map (^. U5c.cardano . U5c.coin) utxosForAddress
-    H.note_ $ "Ensure that the output sent is one of the utxos for the address " <> show addrTxt1
+    H.note_ $ "Ensure that the output sent is one of the utxos for the address " <> show addressText1
     H.assertWith outputsAmounts $ elem (inject amount)
 
+asAddressInEra :: ShelleyBasedEra era -> AsType (AddressInEra era)
+asAddressInEra s = shelleyBasedEraConstraints s $ AsAddressInEra asType
+
 txoRefToTxIn :: (HasCallStack, MonadTest m) => Proto UtxoRpc.TxoRef -> m TxIn
 txoRefToTxIn r = withFrozenCallStack $ do
   txId' <- H.leftFail $ deserialiseFromRawBytes AsTxId $ r ^. U5c.hash
   pure $ TxIn txId' (TxIx . fromIntegral $ r ^. U5c.index)
 
 deserialiseAddressBs :: (MonadTest m, SerialiseAddress c) => AsType c -> ByteString -> m c
-deserialiseAddressBs addrInEra = H.nothingFail . deserialiseAddress addrInEra <=< H.leftFail . T.decodeUtf8'
+deserialiseAddressBs addressInEra = H.nothingFail . deserialiseAddress addressInEra <=< H.leftFail . T.decodeUtf8'