Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Minting script witness refactor #971

Open
wants to merge 9 commits into
base: master
Choose a base branch
from
Open

Minting script witness refactor #971

wants to merge 9 commits into from
+427 −111

Conversation

Jimbo4350
Copy link
Contributor

Changelog

- description: |
    Minting script witness refactor
# uncomment types applicable to the change:
  type:
  # - feature        # introduces a new feature
  - breaking       # the API has changed in a breaking way
  # - compatible     # the API has changed but is non-breaking
  # - optimisation   # measurable performance improvements
  - refactoring    # QoL changes
  # - bugfix         # fixes a defect
  # - test           # fixes/modifies tests
  # - maintenance    # not directly related to the code
  # - release        # related to a new release preparation
  # - documentation  # change in code docs, haddocks...

Context

Additional context for the PR goes here. If the PR fixes a particular issue please provide a link to the issue.

How to trust this PR

Highlight important bits of the PR that will make the review faster. If there are commands the reviewer can run to observe the new behavior, describe them.

Checklist

  • Commit sequence broadly makes sense and commits have useful messages
  • New tests are added if needed and existing tests are updated. See Running tests for more details
  • Self-reviewed the diff

@Jimbo4350
Add Cardano.CLI.Plutus.Minting module
d6dbaf5 
Define the data definition CliMintScriptRequirements
This type makes it clearer that we require the policy id for transaction
construction when using a minting script
@Jimbo4350
Refine plutusP to return AnyPlutusScriptVersion instead of
5433168 
AnyScriptLanguage
Replace ScriptWitnessFiles WitCtxMint with CliMintScriptRequirements
@Jimbo4350
Modify PlutusReferenceScriptWitnessFiles to accept
14b1122 
AnyPlutusScriptVersion instead of AnyScriptLanguage
@Jimbo4350
Implement readFileSimpleScript and readFilePlutusScript
237217a 
Refactor readScriptWitness and eliminate invalid states

Factor out fromSomeTypeSimpleScript and fromSomeTypePlutusScripts

fromSomeTypePlutusScripts should automatically be updated as soon as the
Enum AnyPlutusScriptVersion instance is updated in cardano-api
@Jimbo4350
Replace ScriptWitnessFiles WitCtxMint with CliMintScriptRequirements
6414b31
@Jimbo4350
Propagate MintScriptWitWithPolId era
44a12f0
@Jimbo4350
Remove gatherMintingWitnesses because by default we require a PolicyId
f2b3a39
@Jimbo4350
Add TxCmdCliScriptWitnessError to TxCmdError
47df20b 
Add ScriptDecodeUnknownPlutusScriptVersion to ScriptDecodeError
@Jimbo4350
Remove me cabal project mod
708410b
@Jimbo4350 Jimbo4350 marked this pull request as ready for review November 18, 2024 19:52
@carbolymer carbolymer mentioned this pull request Nov 19, 2024
Open
3 tasks
carbolymer
carbolymer reviewed Nov 19, 2024
View reviewed changes
Copy link
Contributor

@carbolymer carbolymer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM after first pass 👍🏻 Nice work.

cardano-cli/src/Cardano/CLI/Plutus/Minting.hs
Comment on lines +9 to +11
, createOnDiskSimpleOfPlutusScriptCliArgs
, createOnDiskSimpleReferenceScriptCliArgs
, createOnDiskPlutusReferenceScriptCliArgs
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should switch to either using OnDiskXXXXThing or FileXXXXThing names convention for the consistency, eventually. It would make navigating codebase easier.

cardano-cli/src/Cardano/CLI/Plutus/Minting.hs
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this module is in the right place. Can we split it into two:

  • cardano-cli/src/Cardano/CLI/Types/Plutus.hs with MintScriptWitWithPolId, CliMintScriptRequirements and createOnDiskXXX functions
  • cardano-cli/src/Cardano/CLI/Read/Plutus.hs with readMintScriptWitness and CliScriptWitnessError

?

I'm not a fan of the current module structure, but it never felt like a good moment to turn everything upside down.

For the moment I think we should follow it rather than introducing different changes.

I propose the following change:
https://gist.github.com/carbolymer/63b23d0df940c61d1501a6763d86134c

I'm not insisting on keeping EraBased if we have a better alternative here.

Thoughts?

cardano-cli/src/Cardano/CLI/Plutus/Minting.hs
Comment on lines +26 to +28
data MintScriptWitWithPolId era
= MintScriptWitWithPolId
{ mswPolId :: PolicyId
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
data MintScriptWitWithPolId era
= MintScriptWitWithPolId
{ mswPolId :: PolicyId
data MintScriptWitWithPolicyId era
= MintScriptWitWithPolicyId
{ mswPolicyId :: PolicyId

I don't think we're gaining much here by shortening the names here

cardano-cli/src/Cardano/CLI/Plutus/Minting.hs
Comment on lines +195 to +200
sbeToSimpleScriptLangInEra ShelleyBasedEraShelley = SimpleScriptInShelley
sbeToSimpleScriptLangInEra ShelleyBasedEraAllegra = SimpleScriptInAllegra
sbeToSimpleScriptLangInEra ShelleyBasedEraMary = SimpleScriptInMary
sbeToSimpleScriptLangInEra ShelleyBasedEraAlonzo = SimpleScriptInAlonzo
sbeToSimpleScriptLangInEra ShelleyBasedEraBabbage = SimpleScriptInBabbage
sbeToSimpleScriptLangInEra ShelleyBasedEraConway = SimpleScriptInConway
Copy link
Contributor

@carbolymer carbolymer Nov 19, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • I'll upstream this to Cardano.Api.Script.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done in IntersectMBO/cardano-api#663

cardano-cli/src/Cardano/CLI/Read.hs
Comment on lines +656 to +658
case deserialiseFromTextEnvelopeAnyOf [teTypes (AnyPlutusScriptVersion PlutusScriptV1)] te of
Left err -> Left (PlutusScriptDecodeTextEnvelopeError err)
Right script -> Right script
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this can be simplified too

cardano-cli/src/Cardano/CLI/Read.hs
Comment on lines +651 to +653
case deserialiseFromJSON AsTextEnvelope bs of
Left err -> Left $ PlutusScriptJsonDecodeError err
Right te ->
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
case deserialiseFromJSON AsTextEnvelope bs of
Left err -> Left $ PlutusScriptJsonDecodeError err
Right te ->
te <- first PlutusScriptJsonDecodeError $ deserialiseFromJSON AsTextEnvelope bs of

cardano-cli/src/Cardano/CLI/Plutus/Minting.hs
Comment on lines +64 to +81
data PlutusRefScriptCliArgs
= PlutusRefScriptCliArgs
TxIn
AnyPlutusScriptVersion
ScriptDataOrFile
ExecutionUnits
PolicyId
deriving Show

createOnDiskPlutusReferenceScriptCliArgs
:: TxIn
-> AnyPlutusScriptVersion
-> ScriptDataOrFile
-> ExecutionUnits
-> PolicyId
-> CliMintScriptRequirements
createOnDiskPlutusReferenceScriptCliArgs txin scriptVersion scriptData execUnits polid =
OnDiskPlutusRefScript $ PlutusRefScriptCliArgs txin scriptVersion scriptData execUnits polid
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you put those definitions below the type CliMintScriptRequirements? It makes hard to read when you have to jump up and down from definition to definiton to follow the call/type hierarchy.

cardano-cli/src/Cardano/CLI/Plutus/Minting.hs
Comment on lines +83 to +88
data CliMintScriptRequirements
= OnDiskSimpleOrPlutusScript OnDiskSimpleOrPlutusScriptCliArgs
| OnDiskSimpleRefScript SimpleRefScriptCliArgs
| OnDiskPlutusRefScript PlutusRefScriptCliArgs
deriving Show

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same like my previous comment, can you put this definition near the top of the module, before any of its "dependencies"?

(also applies to other types here, I don't want to highlight the whole file for that purpose)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@carbolymer carbolymer carbolymer left review comments

@newhoggy newhoggy Awaiting requested review from newhoggy newhoggy is a code owner

@smelc smelc Awaiting requested review from smelc smelc is a code owner

@palas palas Awaiting requested review from palas palas is a code owner

@kevinhammond kevinhammond Awaiting requested review from kevinhammond kevinhammond is a code owner

@disassembler disassembler Awaiting requested review from disassembler disassembler is a code owner

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@Jimbo4350 @carbolymer