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

Introduce new witness api #763

Draft
wants to merge 7 commits into
base: master
Choose a base branch
from
Draft

Introduce new witness api #763

wants to merge 7 commits into from

Conversation

Jimbo4350
Copy link
Contributor

@Jimbo4350 Jimbo4350 commented Feb 25, 2025 •
edited
Loading

Changelog

- description: |
    New witness api
# uncomment types applicable to the change:
  type:
  - feature        # introduces a new feature
  - compatible     # the API has changed but is non-breaking
  - refactoring    # QoL changes

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

github-advanced-security[bot]
github-advanced-security bot found potential problems Feb 25, 2025
View reviewed changes
@Jimbo4350 Jimbo4350 force-pushed the jordan/new-scripts-api branch from 41613bf to ee59574 Compare February 25, 2025 19:35
@Jimbo4350 Jimbo4350 force-pushed the jordan/new-scripts-api branch 2 times, most recently from 53e997c to 8b9e4cd Compare February 27, 2025 19:22
@Jimbo4350 Jimbo4350 force-pushed the jordan/new-scripts-api branch 3 times, most recently from 5e14d8f to e00ddf0 Compare February 27, 2025 20:16
github-advanced-security[bot]
github-advanced-security bot found potential problems Feb 27, 2025
View reviewed changes
cardano-api/src/Cardano/Api/Internal/Experimental/Plutus/IndexedPlutusScriptWitness.hs

constructRedeeemerPointerMap
:: AlonzoEraOnwards era
-> [AnyIndexedPlutusScriptWitness ((ShelleyLedgerEra era))]

Check notice

Code scanning / HLint

Redundant bracket Note

cardano-api/src/Cardano/Api/Internal/Experimental/Plutus/IndexedPlutusScriptWitness.hs:169:38-59: Suggestion: Redundant bracket
  
Found:
  ((ShelleyLedgerEra era))
  
Perhaps:
  (ShelleyLedgerEra era)
@Jimbo4350
Add AnyCertificate, AnyProposal and AnyVoter types
e82fddb 
This allows us to use the new plutus script api with the legacy api and
our new api without modifying other existing types
@Jimbo4350
Move BuildTxWith and associated types to a new module to avoid cyclical
3011197 
dependencies
@Jimbo4350 Jimbo4350 force-pushed the jordan/new-scripts-api branch from e00ddf0 to ad6e828 Compare February 28, 2025 15:54
github-advanced-security[bot]
github-advanced-security bot found potential problems Feb 28, 2025
View reviewed changes
cardano-api/src/Cardano/Api/Internal/Tx/Body.hs
:: TxScriptWitnessRequirements (ShelleyLedgerEra era) <-
caseShelleyToMaryOrAlonzoEraOnwards
(const $ error "Impossible to construct TxScriptWitnessRequirements in pre-Alonzo era")
(\eon -> collectTxBodyScriptWitnessRequirements eon bc)

Check notice

Code scanning / HLint

Avoid lambda using `infix` Note

cardano-api/src/Cardano/Api/Internal/Tx/Body.hs:2107:9-63: Suggestion: Avoid lambda using infix
  
Found:
  (\ eon -> collectTxBodyScriptWitnessRequirements eon bc)
  
Perhaps:
  (collectTxBodyScriptWitnessRequirements bc)
@Jimbo4350 Jimbo4350 force-pushed the jordan/new-scripts-api branch 2 times, most recently from 7954288 to 2882c59 Compare February 28, 2025 19:08
@Jimbo4350
Introduce the AnyWitness era type.
72a4893 
This is intended to replace the type `Witness witctx era` but if you
look closely they are similar.

The main difference is we do away with `witctx` type parameter because this only really pertains
to plutus script witnesses. The witness context is now relfected in the purpose type
parameter of the `PlutusScriptWitness` type of the `AnyPlutusScriptWitness`
constructor.
@Jimbo4350
Introduce the SimpleScript era type. This wraps cardano-ledger's as…
d37a2c4 
…sociated

type synonym NativeScript era.
@Jimbo4350
Introduce PlutusScriptInEra lang era. Previously we had `PlutusScri…
05d886f 
…pt lang` which

wrapped a `ShortByteString` which essentially means if our script it
malformed we will be informed of this upon deserialization in the ledger i.e at
transaction submission or when using transaction build.

`PlutusScriptInEra lan era` wraps cardano-ledger's `PlutusRunnable
lang`. This allows us to fail early as the deserialization to `PlutusRunnable`
will error for malformed scripts.

NB: Before the introduction of the new api we did implement a
`PlutusScriptInEra era lang` in the old api but this simply wrapped
`PlutusScript lang` and utilized the serialization instances of
`PlutusRunnable lang`.
@Jimbo4350 Jimbo4350 force-pushed the jordan/new-scripts-api branch 2 times, most recently from feeb2f9 to c1d7f9b Compare February 28, 2025 20:16
@Jimbo4350
The main type introduces here is: PlutusScriptWitness lang era
433590a 
`PlutusScriptWitness lang era` is almost identical to the old api's
notion of plutus script witnesses except:
- It's treated as a separate type to simple script witnesses vs as a constructor of a sum type
- A type family is used to represent the presense of a script datum
  depending on the plutus script language and purpose

The `PlutusScriptDatumF` type family has been introduced to capture what
script type can have a datum and if that datum can be optional.
@Jimbo4350
Do witnessable next. Point out it must be paired with an AnyWitness
3520bd4
@Jimbo4350 Jimbo4350 force-pushed the jordan/new-scripts-api branch from c1d7f9b to 3520bd4 Compare February 28, 2025 20:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dcoutts dcoutts Awaiting requested review from dcoutts dcoutts will be requested when the pull request is marked ready for review dcoutts is a code owner

@erikd erikd Awaiting requested review from erikd erikd will be requested when the pull request is marked ready for review erikd is a code owner

@newhoggy newhoggy Awaiting requested review from newhoggy newhoggy will be requested when the pull request is marked ready for review newhoggy is a code owner

@carbolymer carbolymer Awaiting requested review from carbolymer carbolymer will be requested when the pull request is marked ready for review carbolymer is a code owner

@smelc smelc Awaiting requested review from smelc smelc will be requested when the pull request is marked ready for review smelc is a code owner

@palas palas Awaiting requested review from palas palas will be requested when the pull request is marked ready for review palas is a code owner

@kevinhammond kevinhammond Awaiting requested review from kevinhammond kevinhammond will be requested when the pull request is marked ready for review kevinhammond is a code owner

@CarlosLopezDeLara CarlosLopezDeLara Awaiting requested review from CarlosLopezDeLara CarlosLopezDeLara will be requested when the pull request is marked ready for review CarlosLopezDeLara is a code owner

@disassembler disassembler Awaiting requested review from disassembler disassembler will be requested when the pull request is marked ready for review 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.
1 participant
@Jimbo4350