Filling in more Alonzo API extensions for the Tx and TxBody #2738

dcoutts · 2021-05-24T13:14:26Z

No description provided.

dcoutts · 2021-05-24T13:15:06Z

For the moment this extends #2642. It will need to be rebased once that is merged.

This is a further step along the path to Alonzo support in the API. The TxBody's ShelleyTxBody constructor holds all the info that goes with the tx body. This includes scripts and aux data. For Alonzo it now also has to include the script data, which the ledger calls the redeemers. This is a big mapping of each use of a script to the script redeemer data and execution units. This patch adds it to the TxBody but does not yet do the main conversion step of constructing the redeemer pointer mapping.

Based on the script witnesses used within the tx body. Co-authored-by: Jordan Millar <jordan.millar@iohk.io>

The getTransactionBodyContent function and the functions it was calling were doing unnecessary checks that made them partial. We do not need to validate when converting from a ledger transaction, only when building one. By eliminating unnecessary checks and making this pure we can now introduce a TxBody pattern that lets one get at the TxBodyContent. This makes for a nicer API. Also eliminate a couple deprecated functions that will be awkward to update for new features, and are no longer used.

It will be needed for the Alonzo tx construction. Co-authored-by: Duncan Coutts <duncan@well-typed.com>

Needed to construct the hash of the script-relevant protocol params and the redeemers. It is only supplied when building the transaction and is not available when viewing it.

For now always fill it in with Nothing. This is a rarely used feature that we can complete at the end. It is a bit annoying however: it needs a Shelley network identifier, which is not the same as the API NetworkId type, since that also contains the NetworkMagic. That means we cannot use that type since we would not be able to round-trip it to/from a ledger transaction. So this will need some extension and/or refactoring of the NetworkId type and utils. Co-authored-by: Duncan Coutts <duncan@well-typed.com>

These specify that extra key witnesses are required, and this fact is visible to Plutus scripts. It thereby provides a mechaism for Plutus scripts to check that the transaction has been signed by a particular key. Co-authored-by: Duncan Coutts <duncan@well-typed.com>

cardano-api/src/Cardano/Api/ProtocolParameters.hs

Jimbo4350 · 2021-05-27T06:36:09Z

cardano-api/src/Cardano/Api/TxBody.hs

@@ -1173,6 +1186,7 @@ deserialiseShelleyBasedTxBody mkTxBody bs =
          (CBOR.runAnnotator txbody fbs)
          (map (`CBOR.runAnnotator` fbs) txscripts)
          (CBOR.runAnnotator <$> txmetadata <*> pure fbs)
+          (error "deserialiseShelleyBasedTxBody: Redeemer pointer map")


Yep, I wasn't sure how we wanted to handle serialisation.

This bit is causing test failures currently.

prop_roundtrip_txbody_shelley_CBOR: FAIL ✗ prop_roundtrip_txbody_shelley_CBOR failed at test/Test/Cardano/Api/Typed/CBOR.hs:156:3 after 1 test. ┏━━ test/Test/Cardano/Api/Typed/CBOR.hs ━━━ 152 ┃ roundtrip_CBOR 153 ┃ :: (SerialiseAsCBOR a, Eq a, Show a) 154 ┃ => AsType a -> Gen a -> Property 155 ┃ roundtrip_CBOR typeProxy gen = 156 ┃ H.property $ do 157 ┃ val <- H.forAll gen 158 ┃ H.tripping val serialiseToCBOR (deserialiseFromCBOR typeProxy) ┃ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ┃ │ ━━━ Exception (ErrorCall) ━━━ ┃ │ deserialiseShelleyBasedTxBody: Redeemer pointer map ┃ │ CallStack (from HasCallStack): ┃ │ error, called at src/Cardano/Api/TxBody.hs:1219:12 in cardano-api-1.27.0-inplace:Cardano.Api.TxBody This failure can be reproduced by running: > recheck (Size 0) (Seed 16246837987535537937 6040485580684346801) prop_roundtrip_txbody_shelley_CBOR Use '--hedgehog-replay "Size 0 Seed 16246837987535537937 6040485580684346801"' to reproduce. prop_roundtrip_txbody_allegra_CBOR: FAIL ✗ prop_roundtrip_txbody_allegra_CBOR failed at test/Test/Cardano/Api/Typed/CBOR.hs:156:3 after 1 test. ┏━━ test/Test/Cardano/Api/Typed/CBOR.hs ━━━ 152 ┃ roundtrip_CBOR 153 ┃ :: (SerialiseAsCBOR a, Eq a, Show a) 154 ┃ => AsType a -> Gen a -> Property 155 ┃ roundtrip_CBOR typeProxy gen = 156 ┃ H.property $ do 157 ┃ val <- H.forAll gen 158 ┃ H.tripping val serialiseToCBOR (deserialiseFromCBOR typeProxy) ┃ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ┃ │ ━━━ Exception (ErrorCall) ━━━ ┃ │ deserialiseShelleyBasedTxBody: Redeemer pointer map ┃ │ CallStack (from HasCallStack): ┃ │ error, called at src/Cardano/Api/TxBody.hs:1219:12 in cardano-api-1.27.0-inplace:Cardano.Api.TxBody This failure can be reproduced by running: > recheck (Size 0) (Seed 5526808619565871689 17014309501333539577) prop_roundtrip_txbody_allegra_CBOR Use '--hedgehog-replay "Size 0 Seed 5526808619565871689 17014309501333539577"' to reproduce. prop_roundtrip_txbody_mary_CBOR: FAIL ✗ prop_roundtrip_txbody_mary_CBOR failed at test/Test/Cardano/Api/Typed/CBOR.hs:156:3 after 1 test. ┏━━ test/Test/Cardano/Api/Typed/CBOR.hs ━━━ 152 ┃ roundtrip_CBOR 153 ┃ :: (SerialiseAsCBOR a, Eq a, Show a) 154 ┃ => AsType a -> Gen a -> Property 155 ┃ roundtrip_CBOR typeProxy gen = 156 ┃ H.property $ do 157 ┃ val <- H.forAll gen 158 ┃ H.tripping val serialiseToCBOR (deserialiseFromCBOR typeProxy) ┃ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ┃ │ ━━━ Exception (ErrorCall) ━━━ ┃ │ deserialiseShelleyBasedTxBody: Redeemer pointer map ┃ │ CallStack (from HasCallStack): ┃ │ error, called at src/Cardano/Api/TxBody.hs:1219:12 in cardano-api-1.27.0-inplace:Cardano.Api.TxBody This failure can be reproduced by running: > recheck (Size 0) (Seed 2450485195492175484 8218421726347182459) prop_roundtrip_txbody_mary_CBOR Use '--hedgehog-replay "Size 0 Seed 2450485195492175484 8218421726347182459"' to reproduce.

I'll push a fix

Jimbo4350

LGTM!

Jimbo4350 · 2021-05-27T06:37:17Z

cardano-api/src/Cardano/Api/TxBody.hs

+
+
+
+-- TODO: Better name?


Leftover TODO here.

Jimbo4350 · 2021-05-27T06:37:43Z

cardano-api/src/Cardano/Api/TxBody.hs

+--correct thing in the final tx. Also wrap in an Either
+mintingRedeemerPtr
+  :: TxMintValue BuildTx era
+  -- BuildTxWith build (Map PolicyId (Witness WitCtxMint era))


Leftover comment (from me 😄 )

Jimbo4350

LGTM!

dcoutts · 2021-05-28T08:47:24Z

bors merge

iohk-bors · 2021-05-28T09:07:17Z

Build succeeded:

dcoutts requested review from DavidEichmann, erikd, Jimbo4350 and newhoggy as code owners May 24, 2021 13:14

dcoutts marked this pull request as draft May 24, 2021 13:14

dcoutts added hydra-dont-build WIP Work In Progress (cannot be merged yet) labels May 24, 2021

Jimbo4350 force-pushed the dcoutts/alonzo-api-tx-body branch 2 times, most recently from b07ba16 to 6043b00 Compare May 24, 2021 14:38

dcoutts force-pushed the dcoutts/alonzo-api-tx-body branch 2 times, most recently from 4d9a3ec to 6043b00 Compare May 24, 2021 18:04

dcoutts and others added 7 commits May 27, 2021 01:18

Build the Alonzo redeemer pointer mapping

6ba64b9

Based on the script witnesses used within the tx body. Co-authored-by: Jordan Millar <jordan.millar@iohk.io>

Add toLedgerPParams conversion function

3e92a37

It will be needed for the Alonzo tx construction. Co-authored-by: Duncan Coutts <duncan@well-typed.com>

Add optional ProtocolParameters to the TxBodyContent

a4222e7

Needed to construct the hash of the script-relevant protocol params and the redeemers. It is only supplied when building the transaction and is not available when viewing it.

dcoutts force-pushed the dcoutts/alonzo-api-tx-body branch from 6043b00 to ecfaa63 Compare May 27, 2021 01:35

dcoutts removed WIP Work In Progress (cannot be merged yet) hydra-dont-build labels May 27, 2021

dcoutts marked this pull request as ready for review May 27, 2021 01:40

newhoggy reviewed May 27, 2021

View reviewed changes

cardano-api/src/Cardano/Api/ProtocolParameters.hs Outdated Show resolved Hide resolved

newhoggy reviewed May 27, 2021

View reviewed changes

cardano-api/src/Cardano/Api/ProtocolParameters.hs Outdated Show resolved Hide resolved

newhoggy approved these changes May 27, 2021

View reviewed changes

newhoggy force-pushed the dcoutts/alonzo-api-tx-body branch 2 times, most recently from 909e496 to 06906ac Compare May 27, 2021 06:35

Jimbo4350 reviewed May 27, 2021

View reviewed changes

Jimbo4350 approved these changes May 27, 2021

View reviewed changes

dcoutts force-pushed the dcoutts/alonzo-api-tx-body branch 2 times, most recently from 69f8eb6 to 72a0567 Compare May 27, 2021 14:44

Address review feedback: layout and hlint

6544ca8

dcoutts force-pushed the dcoutts/alonzo-api-tx-body branch from 72a0567 to 6544ca8 Compare May 27, 2021 15:18

Jimbo4350 approved these changes May 27, 2021

View reviewed changes

iohk-bors bot merged commit 5430355 into master May 28, 2021

iohk-bors bot deleted the dcoutts/alonzo-api-tx-body branch May 28, 2021 09:07

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Filling in more Alonzo API extensions for the Tx and TxBody #2738

Filling in more Alonzo API extensions for the Tx and TxBody #2738

dcoutts commented May 24, 2021

dcoutts commented May 24, 2021

Jimbo4350 May 27, 2021

newhoggy May 27, 2021

newhoggy May 27, 2021

Jimbo4350 May 27, 2021

Jimbo4350 left a comment

Jimbo4350 May 27, 2021

Jimbo4350 May 27, 2021

Jimbo4350 left a comment

dcoutts commented May 28, 2021

iohk-bors bot commented May 28, 2021

Filling in more Alonzo API extensions for the Tx and TxBody #2738

Filling in more Alonzo API extensions for the Tx and TxBody #2738

Conversation

dcoutts commented May 24, 2021

dcoutts commented May 24, 2021

Jimbo4350 May 27, 2021

Choose a reason for hiding this comment

newhoggy May 27, 2021

Choose a reason for hiding this comment

newhoggy May 27, 2021

Choose a reason for hiding this comment

Jimbo4350 May 27, 2021

Choose a reason for hiding this comment

Jimbo4350 left a comment

Choose a reason for hiding this comment

Jimbo4350 May 27, 2021

Choose a reason for hiding this comment

Jimbo4350 May 27, 2021

Choose a reason for hiding this comment

Jimbo4350 left a comment

Choose a reason for hiding this comment

dcoutts commented May 28, 2021

iohk-bors bot commented May 28, 2021