Reference script integration #3953

Jimbo4350 · 2022-05-31T16:15:34Z

Implements a shell script that uses a spending plutus v2 reference script. Currently only build-raw is working with reference scripts.
Updates the api and cli to enable the usage of reference scripts
Adds documentation outlining how to use reference scripts

doc/reference/plutus/reference-script-example.md

olgahryniuk · 2022-06-06T06:25:09Z

doc/reference/plutus/reference-script-example.md

+```
+
+To start your babbage cluster you need to run the `example/run/all.sh` shell script.
+The remainder of this guide briefly talks about the [shell script example](scripts/plutus/example-reference-script-usage.sh) that automatically does everything for you.


'Further, we briefly discuss the shell script example, which automates your following actions'.
@Jimbo4350 Please see if this makes sense^. If not, I'd suggest changing 'automatically does everything for you' into a clearer statement. Like what exactly does it automate?

I've made a change let me know what you think

…are witnessing a spending input

and runTxBuildRaw functions Update the utxo query in the runTxBuild function to also inlclude reference scripts. This is necessary otherwise the transaction will be constructed without reference scripts (if they are specified at the cli level).

inputs (PlutusReferenceScriptWitnessFiles)

for spending a tx input

catch-21 · 2022-06-06T16:44:07Z

Consider renaming --reference-script-file to follow convention of other tx-out flags. For example, it could be changed to --tx-out-reference-script-file

doc/reference/plutus/reference-script-example.md

catch-21 · 2022-06-06T17:32:33Z

If we're going to leave --plutus-script-v1 flag in then perhaps add to its help text Specify a plutus script v1 reference script. Note: Ledger rules prevent referenced V1 scripts from being executed

catch-21 · 2022-06-06T17:41:14Z

--simple-script-v1       Specify a simple script v1 reference script.
--simple-script-v2       Specify a simple script v2 reference script.

@Jimbo4350 Do these refer to the Shelley(v1) and Allegra(v2) native scripts? If so it may be worth clarifying that in the help text because it wasn't obvious to me.

JaredCorduan · 2022-06-06T18:03:44Z

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

@@ -953,7 +966,7 @@ fromShelleyScriptHash = ScriptHash


 -- ----------------------------------------------------------------------------
-- The simple native script language
+-- The simple simple script language


Suggested change

-- The simple simple script language

-- The simple script language

It's super simple ("simple simple") . Thanks for catching this.

catch-21 · 2022-06-06T18:09:02Z

cardano-cli/src/Cardano/CLI/Shelley/Parsers.hs

+    Opt.flag' (AnyScriptLanguage $ SimpleScriptLanguage SimpleScriptV1)
+      (  Opt.long "simple-script-v1"
+      <> Opt.help "Specify a simple script v1 reference script. \
+                  \See documentation at doc/reference/simple-scripts.md"


This document doesn't refer to v1 and v2. How can we make that distinction clear?

Specify a simple script v1 (Shelley) reference script
Specify a simple script v2 (Allegra) reference script.
?

Also, you could prepend TODO: until they are supported (because that's what you see when you try to use them)

JaredCorduan

I made a few minor comments, but overall this is awesome! This was a huge undertaking, thanks @Jimbo4350 !!

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

JaredCorduan · 2022-06-06T18:13:44Z

doc/reference/plutus/reference-script-example.md

+
+In this example we will use the [Required Redeemer](scripts/plutus/scripts/v2/required-redeemer.plutus) Plutus spending script. In order to execute a reference Plutus spending script, we require the following:
+
+- Collateral tx input(s) - these are provided and are forfeited in the event the Plutus script fails to execute.


Should we ease folks mind by telling them about the fact that a local node will not forward on a failing tx to the relay node unless it is explicitly told to? As you know, I'm sure, the collateral exists to prevent abusive behavior, and under normal circumstances will not be taken.

"... in the event this transaction is submitted with a failing Plutus script. Local validation protects against this by default."
?

JaredCorduan · 2022-06-06T18:14:27Z

scripts/babbage/mkfiles.sh

@@ -151,7 +151,7 @@ $SED -i "${ROOT}/genesis/shelley/genesis.json" \
    -e 's/"minFeeB": 0/"minFeeB": 155381/' \
    -e 's/"minUTxOValue": 0/"minUTxOValue": 1000000/' \
    -e 's/"decentralisationParam": 1.0/"decentralisationParam": 0.7/' \
-    -e 's/"major": 0/"major": 2/' \
+    -e 's/"major": 0/"major": 7/' \


Jimbo4350 · 2022-06-06T18:36:04Z

bors r+

Jimbo4350 · 2022-06-06T19:13:13Z

bors r-

iohk-bors · 2022-06-06T19:13:16Z

Canceled.

Jimbo4350 · 2022-06-06T20:03:37Z

bors r+

iohk-bors · 2022-06-06T21:09:18Z

Build succeeded:

Jimbo4350 · 2022-06-06T21:44:30Z

bors r+

iohk-bors · 2022-06-06T21:44:31Z

Already running a review

Jimbo4350 force-pushed the jordan/reference-script-integration-cli-api-final branch 6 times, most recently from c17663d to 6be0eae Compare June 2, 2022 17:00

Jimbo4350 marked this pull request as ready for review June 3, 2022 16:24

Jimbo4350 requested review from DavidEichmann, dcoutts, erikd, newhoggy, nc6 and JaredCorduan as code owners June 3, 2022 16:24

Jimbo4350 requested review from deepfire, denisshevchenko, jutaro, MarcFontaine, mgmeier and cleverca22 as code owners June 3, 2022 17:26

Jimbo4350 force-pushed the jordan/reference-script-integration-cli-api-final branch from 2868852 to 19b83d2 Compare June 3, 2022 18:12

catch-21 reviewed Jun 5, 2022

View reviewed changes

doc/reference/plutus/reference-script-example.md Outdated Show resolved Hide resolved

catch-21 reviewed Jun 5, 2022

View reviewed changes

doc/reference/plutus/reference-script-example.md Outdated Show resolved Hide resolved

catch-21 reviewed Jun 5, 2022

View reviewed changes

doc/reference/plutus/reference-script-example.md Outdated Show resolved Hide resolved

catch-21 reviewed Jun 5, 2022

View reviewed changes

doc/reference/plutus/reference-script-example.md Outdated Show resolved Hide resolved

catch-21 reviewed Jun 5, 2022

View reviewed changes

doc/reference/plutus/reference-script-example.md Outdated Show resolved Hide resolved

olgahryniuk reviewed Jun 6, 2022

View reviewed changes

doc/reference/plutus/reference-script-example.md Outdated Show resolved Hide resolved

olgahryniuk reviewed Jun 6, 2022

View reviewed changes

doc/reference/plutus/reference-script-example.md Outdated Show resolved Hide resolved

olgahryniuk reviewed Jun 6, 2022

View reviewed changes

doc/reference/plutus/reference-script-example.md Outdated Show resolved Hide resolved

olgahryniuk reviewed Jun 6, 2022

View reviewed changes

doc/reference/plutus/reference-script-example.md Outdated Show resolved Hide resolved

olgahryniuk reviewed Jun 6, 2022

View reviewed changes

Jimbo4350 added 6 commits June 6, 2022 11:38

Remove separate specification on the cli of reference tx inputs that …

9a2fb03

…are witnessing a spending input

Update ScriptWitnessFiles type to allow for specification of reference

357a106

inputs (PlutusReferenceScriptWitnessFiles)

Add shell script show casing how to create and use a reference script

e0a8620

for spending a tx input

Add documentation for reference script usage

f7f9970

Propagate api changes to tx-generator

85e3556

Jimbo4350 force-pushed the jordan/reference-script-integration-cli-api-final branch 2 times, most recently from 7747587 to ac5bdae Compare June 6, 2022 17:03

catch-21 reviewed Jun 6, 2022

View reviewed changes

doc/reference/plutus/reference-script-example.md Outdated Show resolved Hide resolved

catch-21 reviewed Jun 6, 2022

View reviewed changes

doc/reference/plutus/reference-script-example.md Outdated Show resolved Hide resolved

Jimbo4350 force-pushed the jordan/reference-script-integration-cli-api-final branch from ac5bdae to fc2973b Compare June 6, 2022 17:51

Jimbo4350 mentioned this pull request Jun 6, 2022

Vasil CLI/API integration #3739

Closed

38 tasks

JaredCorduan reviewed Jun 6, 2022

View reviewed changes

catch-21 approved these changes Jun 6, 2022

View reviewed changes

Review fixes + documentation fixes

8aa99d2

Jimbo4350 force-pushed the jordan/reference-script-integration-cli-api-final branch from fc2973b to 8aa99d2 Compare June 6, 2022 18:08

catch-21 reviewed Jun 6, 2022

View reviewed changes

JaredCorduan approved these changes Jun 6, 2022

View reviewed changes

iohk-bors bot merged commit 95c3692 into master Jun 6, 2022

iohk-bors bot deleted the jordan/reference-script-integration-cli-api-final branch June 6, 2022 21:09

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Reference script integration #3953

Reference script integration #3953

Jimbo4350 commented May 31, 2022 •

edited

olgahryniuk Jun 6, 2022

Jimbo4350 Jun 6, 2022

catch-21 commented Jun 6, 2022

catch-21 commented Jun 6, 2022

catch-21 commented Jun 6, 2022

JaredCorduan Jun 6, 2022

Jimbo4350 Jun 6, 2022

catch-21 Jun 6, 2022

catch-21 Jun 6, 2022

catch-21 Jun 6, 2022 •

edited

JaredCorduan left a comment

JaredCorduan Jun 6, 2022

catch-21 Jun 6, 2022

JaredCorduan Jun 6, 2022

Jimbo4350 commented Jun 6, 2022

Jimbo4350 commented Jun 6, 2022

iohk-bors bot commented Jun 6, 2022

Jimbo4350 commented Jun 6, 2022

iohk-bors bot commented Jun 6, 2022

Jimbo4350 commented Jun 6, 2022

iohk-bors bot commented Jun 6, 2022

	-- The simple simple script language
	-- The simple script language


		In this example we will use the [Required Redeemer](scripts/plutus/scripts/v2/required-redeemer.plutus) Plutus spending script. In order to execute a reference Plutus spending script, we require the following:

		- Collateral tx input(s) - these are provided and are forfeited in the event the Plutus script fails to execute.

Reference script integration #3953

Reference script integration #3953

Conversation

Jimbo4350 commented May 31, 2022 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

catch-21 commented Jun 6, 2022

catch-21 commented Jun 6, 2022

catch-21 commented Jun 6, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

catch-21 Jun 6, 2022 • edited

Choose a reason for hiding this comment

JaredCorduan left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Jimbo4350 commented Jun 6, 2022

Jimbo4350 commented Jun 6, 2022

iohk-bors bot commented Jun 6, 2022

Jimbo4350 commented Jun 6, 2022

iohk-bors bot commented Jun 6, 2022

Jimbo4350 commented Jun 6, 2022

iohk-bors bot commented Jun 6, 2022

Jimbo4350 commented May 31, 2022 •

edited

catch-21 Jun 6, 2022 •

edited