CLI Alonzo script support #2774

dcoutts · 2021-06-01T21:37:35Z

No description provided.

Instead of using a Map PolicyId (Witness WitCtxMint era) we instead use Map PolicyId (ScriptWitness WitCtxMint era) Whereas other uses of witnesses in the tx body allow either key or script witnesses, the minting only uses script witnesses, not key witnesses. Using the more specific type is logically the right thing to do, and will also make the job for the cli slightly easier.

Make it simpler and clearer. Check both for too few as well as too many witnesses being provided for minting. Alsoange it to use the existing createScriptWitness utility. This will mean we can extend it for Plutus scripts more easily, since we will only have to change that utility function, and not validateTxMintValue.

To be able to support plutus scripts for witnesses, we need to deal with script witnesses rather than just scripts. In the CLI this means dealing with the files needed to make a script witness, rather than just the single file needed to make a simple script witness. So we add a new ScriptWitnessFiles GADT that covers both the simple and the plutus witness case, that contains the various files: not just the script file but also files for the datum and redeemer, and also the exection units. This patch does not actually add in the cases to actually support the plutus case, it just switches the types over in preparation. Both the parser and the createScriptWitness helper will need to be extended for that.

The remaining TODO here relies on the ScriptData JSON support.

This also relies on the JSON instance for ScriptData, which is not included yet.

And also as concrete data files in the repo. These scripts always succeed, or always fail, so are only useful for quick sanity tests.

It'll be getting larger once we add JSON serialisation.

Following the style of the TxMetadata

Relying on the new JSON support.

Supporting the simple schema-less JSON representation of script data.

Collateral inouts are needed for every tx that uses Plutus scripts.

It was inverted. Oops. Now we correctly reject txs that do not specify protocol params. Unfortunately, the cli for providing them is not wired up yet, so not yet possible to make a proper Alonzo tx.

Transaction that use Plutus scripts have to provide collateral inputs.

dcoutts · 2021-06-03T15:59:28Z

The current state here is that we cannot yet construct valid Alonzo era txs. The next bit to make that work is to be able to provide the current protocol parameters to the cardano-cli transaction build-raw command.

In the CLI code we have these TODOs:

      TxBodyContent
        <$> validateTxIns  era inputsAndScripts
        <*> validateTxInsCollateral
                           era inputsCollateral
        <*> validateTxOuts era txouts
        <*> validateTxFee  era mFee
        <*> ((,) <$> validateTxValidityLowerBound era mLowerBound
                 <*> validateTxValidityUpperBound era mUpperBound)
        <*> validateTxMetadataInEra  era metadataSchema metadataFiles
        <*> validateTxAuxScripts     era scriptFiles
        <*> pure TxAuxScriptDataNone     --TODO alonzo: support this
        <*> pure TxExtraKeyWitnessesNone --TODO alonzo: support this
        <*> pure (BuildTxWith Nothing) --TODO alonzo: support this
        <*> validateTxWithdrawals    era withdrawals
        <*> validateTxCertificates   era certFiles
        <*> validateTxUpdateProposal era mUpdatePropFile
        <*> validateTxMintValue      era mValue

It's the 3rd one there that's critical. That's the protocol params. The others are non-critical features.

One of the necessary pieces for making valid Alonzo era txs. Not yet tested.

dcoutts · 2021-06-03T16:19:53Z

Ok, with any luck that'll now work. Needs to be tested.

Jimbo4350

I haven't tested this as yet but it LGTM

Jimbo4350 · 2021-06-04T08:00:44Z

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

@@ -1028,7 +1028,8 @@ data TxMintValue build era where

     TxMintValue :: MultiAssetSupportedInEra era
                 -> Value
-                 -> BuildTxWith build (Map PolicyId (Witness WitCtxMint era))
+                 -> BuildTxWith build


Jimbo4350 · 2021-06-04T08:28:55Z

cardano-cli/src/Cardano/CLI/Types.hs

+--
+-- It is era-independent, but witness context-dependent.
+--
+data ScriptWitnessFiles witctx where


Thoughts on having this in the API in some kind of IO module?

Jimbo4350 · 2021-06-04T08:32:07Z

cardano-cli/src/Cardano/CLI/Shelley/Run/Transaction.hs

+                      -> ExceptT ShelleyTxCmdError IO (ScriptDatum witctx)
+readScriptDatumOrFile (ScriptDatumOrFileForTxIn df) = ScriptDatumForTxIn <$>
+                                                        readScriptDataOrFile df
+readScriptDatumOrFile NoScriptDatumOrFileForMint    = pure NoScriptDatumForMint


Technically, nothing is stopping us from supplying a Datum with a plutus script involved in minting or withdrawals right?

The consistent use of the witctx type argument should ensure that we're using only the right one in the right context. So it should be impossible to supply a datum for minting or stake contexts. For starters, there's no cli flag for it: we only have the datum cli flag for the txin context.

I meant from the perspective of the ledger. The ledger doesn't care if we supply a datum when using a minting or stake script. IIRC Lars was utilizing tx datums in minting scrips in the plutus pioneers course.

Jimbo4350 · 2021-06-04T08:39:39Z

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

+{-# LANGUAGE ScopedTypeVariables #-}
+{-# LANGUAGE TypeFamilies #-}
+
+module Cardano.Api.ScriptData (


The API's TxBody binary format is not an externally defined format. It does not appear on the chain. It is an intermediate format used by the cli and is not guaranteed to be stable or interoperable. External tools should not rely on this format. Nevertheless, for now since it's easy, we'll adjust the output to be the same as pre-Alonzo eras when not using any Alonzo-era features.

dcoutts · 2021-06-07T10:24:55Z

bors merge

iohk-bors · 2021-06-07T10:56:05Z

Build succeeded:

dcoutts added 4 commits June 1, 2021 21:42

Trivial refactoring: drop unnecessary IsCardanoEra constraints

3445447

dcoutts force-pushed the dcoutts/cli-alonzo-script-support branch from ca82881 to 7d6e8a6 Compare June 2, 2021 23:09

dcoutts added 8 commits June 3, 2021 13:29

Extend createScriptWitness in the cli for Plutus script witnesses

4e714a3

The remaining TODO here relies on the ScriptData JSON support.

Extend the CLI tx parser for Plutus script witnesses

32e6187

This also relies on the JSON instance for ScriptData, which is not included yet.

Add trivial example Plutus scripts to the API

8c403db

And also as concrete data files in the repo. These scripts always succeed, or always fail, so are only useful for quick sanity tests.

Split ScriptData out of the Script module

2eebaa3

It'll be getting larger once we add JSON serialisation.

Add JSON serialisation for ScriptData

2501924

Following the style of the TxMetadata

Complete readScriptDataOrFile for reading script data JSON files

5b64a7a

Relying on the new JSON support.

Fill in the cli parser for --datum-value / --redeemer-value flags

823aa4b

Supporting the simple schema-less JSON representation of script data.

Extend the cli file format support for the Alonzo era

738f311

dcoutts force-pushed the dcoutts/cli-alonzo-script-support branch from 6797995 to 738f311 Compare June 3, 2021 12:36

dcoutts marked this pull request as ready for review June 3, 2021 15:26

dcoutts requested review from DavidEichmann, erikd, Jimbo4350 and newhoggy as code owners June 3, 2021 15:26

dcoutts added 3 commits June 3, 2021 16:38

Add cli plumbing for tx inputs for collateral

8f9fe7e

Collateral inouts are needed for every tx that uses Plutus scripts.

Correct the check for TxBodyMissingProtocolParams

2f66529

It was inverted. Oops. Now we correctly reject txs that do not specify protocol params. Unfortunately, the cli for providing them is not wired up yet, so not yet possible to make a proper Alonzo tx.

Add cli tx body validation for txins for collateral

acf4e2e

Transaction that use Plutus scripts have to provide collateral inputs.

Add support for --protocol-params-file for cli tx construction

95d3b1c

One of the necessary pieces for making valid Alonzo era txs. Not yet tested.

dcoutts mentioned this pull request Jun 3, 2021

Aeson instances for ScriptData #2778

Closed

Jimbo4350 reviewed Jun 4, 2021

View reviewed changes

Jimbo4350 self-requested a review June 7, 2021 09:16

Jimbo4350 approved these changes Jun 7, 2021

View reviewed changes

iohk-bors bot merged commit b3cabae into master Jun 7, 2021

iohk-bors bot deleted the dcoutts/cli-alonzo-script-support branch June 7, 2021 10:56

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

CLI Alonzo script support #2774

CLI Alonzo script support #2774

dcoutts commented Jun 1, 2021

dcoutts commented Jun 3, 2021

dcoutts commented Jun 3, 2021

Jimbo4350 left a comment

Jimbo4350 Jun 4, 2021

Jimbo4350 Jun 4, 2021

Jimbo4350 Jun 4, 2021

dcoutts Jun 4, 2021

Jimbo4350 Jun 4, 2021 •

edited

Loading

Jimbo4350 Jun 4, 2021

dcoutts commented Jun 7, 2021

iohk-bors bot commented Jun 7, 2021

CLI Alonzo script support #2774

CLI Alonzo script support #2774

Conversation

dcoutts commented Jun 1, 2021

dcoutts commented Jun 3, 2021

dcoutts commented Jun 3, 2021

Jimbo4350 left a comment

Choose a reason for hiding this comment

Jimbo4350 Jun 4, 2021

Choose a reason for hiding this comment

Jimbo4350 Jun 4, 2021

Choose a reason for hiding this comment

Jimbo4350 Jun 4, 2021

Choose a reason for hiding this comment

dcoutts Jun 4, 2021

Choose a reason for hiding this comment

Jimbo4350 Jun 4, 2021 • edited Loading

Choose a reason for hiding this comment

Jimbo4350 Jun 4, 2021

Choose a reason for hiding this comment

dcoutts commented Jun 7, 2021

iohk-bors bot commented Jun 7, 2021

Jimbo4350 Jun 4, 2021 •

edited

Loading