Releases: tweag/cooked-validators
Releases · tweag/cooked-validators
Version 6.0.0
This is the release that updates cardano-api and cardano-node-emulator to the latest standards. Full change log below.
Added
- Module
Cooked.Pretty.Hashablehas been brought back from
Cooked.Conversion.ToHashsince it has no purpose being in
plutus-script-utils. - It is now possible to use
TxSkelOutNoDatumwhen paying to scripts, as
PlutusV3 allows for it. As a consequence, providing no datum in aPayablewill
result in the generation ofTxSkelOutDatum ()for scripts of version 1 or 2,
and in the generation ofTxSkelOutNoDatumfor scripts of version 3. - New
defineprimitive inMonadBlockChainBalancingwhich allows to bind an
alias while defining a variable. This is used by the pretty printer to render
names that are dynamic, i.e. depend on on-chain data, like utxos. - The list of
MockChainLogEntryhas been integrated into aMockChainBook
which also stores the aliases exported usingdefine. - The testing framewok now allows to predicate over the number of resulting
traces using new Test fieldtestSizePropand new helperwithExactSize. - Support for multi-purpose scripts post CIP69 and Chang hard fork.
- A test over multi-purpose scripts with Minting + Spending purposes.
- Constructor
Mintwith smart constructorsmintandburnto populate the
TxSkelMintsfield of our skeleton. - New helper
addHashNamesto add alias in the pretty cooked options without
overriding the existing default names. OwnerConstraintsandReferenceScriptConstraintsfor output to clarify some
types and allow to reuse those constraints in other parts of the code, such as
attacks or tweaks.- New helper
txSkelOutReferenceScriptto retrieve the optional reference script
from an output. - New testing helpers
isInWalletsandisInWalletto ensure wallets have the
right amount of certain tokens at the end of a mockchain run. New testing
helpershappenedanddidNotHappento test for the occurrence of a specific
log event.
Removed
- Modules
Validators.hsandCurrencies.hs. Their content has been moved to
plutus-script-utilsdirectly with some improvements and adaptations. - Modules
Cooked.Conversion.***which have been integrated to
plutus-script-utils. - Two helpers from
Skeleton.hsthat were only used once inMockChain.Direct:
txSkelValidatorsInOutputs,txSkelReferenceScripts walletCredential,walletAddressreplaced bytoCredentialand
toAddressfrom the classesToCredentialandToAddress.txOptAutoReferenceScriptsreplaced by local optiontxSkelRedeemerAutoFill
which can be turned on and off in eachTxSkelRedeemer.
Changed
- Update cardano-api to version 10.10, post Chang hard fork.
- Datum hijacking attack now branches on each modified outputs.
- Datum hijacking attack has a simpler interface, no longer relying on optics.
- Datum hijacking can now redirect output to any suitable party, the type of can
be different from the original owner of the utxo. - The link to explicit typed validators, validators and minting policies has
been reduced, relying on conversion type classes whenever possible. TxSkelMintsis now built from a list of dedicatedMintconstructs instead
of tuples. This allows to use any kind of scripts that can be seen as
versioned minting policies, such as multipurpose scripts.- The default way of building
TxSkelMintsnow does not pushes for specifying
multiple redeemers for the same minting policy. validatorFromHashchanged toscriptFromHash- Token names can now be seen as hashables by the pretty printer and thus giving
a dynamic alias during mockchain runs usingdefine. - Default hash names map in the pretty printer option have been updated.
- The
removeLabelTweaknow fails if the label is absent from the skeleton. TxSkelRedeemerhas been improved: it directly contains a redeemer content
(no longer needed typeRedeemer) and it now contains locally an option to
either automatically assign a reference input or not.- The CI now ensures the documentation is filled up properly.
- Modules under
Pretty.Cookedhave been revamped. All pretty functions are now
instances of eitherPrettyCooked,PrettyCookedListorPrettyCookedMaybe
and are adequately placed in thePretty.Cooked.XXXsubmodules. This offers
both more consistency and flexibility to definePrettyinstances for cooked. - The testing framework has been slightly improved and homogenized.
Fixed
- A bug where reference inputs given in the withdrawal redeemer would not be put
in the set of reference inputs of the generated transaction. - A bug where hashes were not properly displayed by pretty cooked when involving
leading zeros in the hexadecimal conversion of their digits. - Size of reference scripts is now taken into account when computing the maximal
possible fee for a transaction. As a consequence, our dychotomic balancing
mechanism now iterates within the proper fee bounds for Conway. - A bug where
awaitDurationFromUpperBoundwould actually wait from the lower
bound of the slot, similarly toawaitDurationFromLowerBound.
Version 5.0.0
Added
quickCurrencyPolicyV3andpermanentCurrencyPolicyV3which should be the
most commonly used.- All kinds of scripts can now be used as reference scripts.
validateTxSkel_which validates a skeleton and ignores the output.txSkelMintsFromList'which only allows one redeemer per minting policy.validatorToTypedValidatorV2walletPKHashToWalletthat retrives a wallet from a pkh. It used to be
present but somehow disapeared.- It is now possible to reference an output which has a hashed datum.
txSkelHashedDatathe gives all the datum hashes in inputs and reference inputs.- Partial support for withdrawals in txSkels. The rewarding scripts will be run
and assets will be transferred. However, these withdrawals are not properly
constrained yet. - PrettyCooked option
pcOptPrintLog, which is a boolean, to turn on or off the log
display in the pretty printer. The default value isTrue. - Reference inputs with the right reference scripts are now automatically
attached to redeemers when such input exists. This can be turned on using
txOptAutoReferenceScripts. If disabled, the helperwithReferenceInputcan
be used on a redeemer to manually attach a reference input (which does not
necessarily have to contain the right reference script). - Capability to test the result of a mockchain run based on the log entries.
txOutRefToTxSkelOuthelper to query the mock chain for recreating a
TxSkelOutfrom aTxOutRef. This is very useful when usingTweaksthat
need to pay back an existing output with a slight modification.- A new tweak
modifySpendRedeemersOfTypeTweakto apply an optional
modification of all redeemers of a certain type within the skeleton inputs. - New setters for the various outputs fields.
- The
Payablestructure to properly define, compose, and later pay, payable
elements withreceive. - The
receivesmart constructor for payments that allows to compose payable
elements (datums, values, staking credential and reference scripts) and
associate them to a recipient. TxSkelOutValuewhich encompasses both a value and whether it can be tampered
with through min ada adjustment. It comes with the constructors
ValueandFixedValuefrom thePayabletype.
Removed
positivePartandnegativePartinValueUtils.hs. Replaced byApi.split.- Redundant logging of errors in mockchain runs.
- Useless minting of non-ADA value in the dummy initial transaction.
- Payment helpers (such as
PaysPK,withDatum...). Replaced byreceives. txOptEnsureMinAda, replaced by a field ofTxSkelOutValue
Changed
- GHC bumped to 9.6.6
- Internal representation of redeemers have changed, and are similar for any
supported script purpose (minting, spending or proposing). - Redeemers should now be built using one of the two following smart
constructors:someTxSkelRedeemer,emptyTxSkelRedeemer mkProposingScriptchanged tomkScriptwithDatumHashedchanged towithUnresolvedDatumHashpaysScriptDatumHashedchanged topaysScriptUnresolvedDatumHashtxSkelInputDatachanged totxSkelInputDataAsHashes- Pretty printing of hashed datum now includes the hash (and not only the
resolved datum). - Logging has been reworked:
- it is no longer limited to
StagedMockChainruns - it is now a component of
MonadBlockChainBalancing - it can be turned on/off in pretty-printing options
- it now displays the discarding of utxos during balancing.
- it now displays when the user specifies useless collateral utxos.
- it is not visible from outside of
cooked-validators
- it is no longer limited to
- Dependency to cardano-api bumped to 8.46.
- The whole testing API has been revamped
- File
AddInputsAndOutputs.hshas been split intoInputs.hs,Outputs.hs
andMint.hs. FileTamperDatum.hshas been updated and integrated into
Output.hs. - File
Skeleton.hshas been split into sub-files in theSkeletonfolder. - Default language extensions and compilation options have been updated.
- Transaction generation now directly lives in
MonadMockChainBalancing. - Initial distributions are now handled as a first action in the
MockChain.
Fixed
- A bug where the script hashes would not be computed properly for early plutus
version (V1 and V2). - A bug where balancing would fail with excessive inputs and not enough min ada
in the excess. - Transactions that do not involve script are now properly generated without any
- All kinds of scripts can now be used as reference scripts.
- A bug where scripts being paid to in the initial distribution would not be
stored in the MockChain.
Version 4.0.0
Added
- File IMPORTS to specify how modules should be imported and prefixed
- Instaured a standard for naming imports, homogenized all modules accordingly
- Default language extensions in package.yaml
- A new set of tests
Cooked.BasicUsageSpecto cover basic use cases - A new validate function
validateTxSkel'that directly returns a list of utxos - An actual content to
hie.yaml(automatically generated bygen-hie) - Support for collaterals in skeleton options, with three options: auto from
first signer, auto from given wallet, or given set of utxos. - Top-level comments to all modules
currencySymbolFromLanguageAndMPto get the right Currency symbol based on a
plutus version and a minting policysetParamsinMonadBlockChainWithoutValidationto account for future
changes of parameters following votes.txOptCollateralUtxosto control which utxos should be used as collaterals- Missing
Eqinstance forMockChainError - Full support in
ShowBSfor printing into bytestring the whole transaction
context within on-chain code validatorToTypedValidatorwhich does what its name indicates- Adding support for
PrettyCookedforTxLbl - A set of modules (in
Conversion) that each defines a typeclass of elements
that can be converted to a certain type. For exampleToPubKeyHashor
ToAddress. - New utxos searches
vanillaOutputsAtSearch,scriptOutputsSearch,
onlyValueOutputsAtSearchandreferenceScriptOutputsSearch - A test file
Cooked/BalancingSpec.hsthat covers the new balancing mechanism
extensively. - A new module
Cooked/MockChain/MinAda.hsto separate min ada computation from
the balancing mechanism. - A new documentation file
doc/BALANCING.mdthat extensively describes the new
balancing mechanism and the available options. - A new skeleton option to manage fees called
FeePolicy. It makes it possible
to successfully validate transactions that have not been automatically
balanced. - Auto computation of total and return collaterals based on fees and protocol
parameters now fully handled during balancing and transaction generation. - Two filters in
Output.hs,isScriptOutputandisPKOutput - A new helper function to get the full output value of a skeleton,
txSkelOutputsValue - Proposal procedures can now be issued and described in transaction
skeletons. If they contain parameter changes or treasury withdrawals, a
witness script can be attached and will be run. TxSkelRedeemeris now used for all kinds of scripts.- File CONWAY to document which Conway features are currently
supported. - A new option
txOptAnchorResolutionto decide whether to resolve urls
locally or on the web (unsafe). The default is to resolve them locally with a
given map from urls to page content as bytestring.
Removed
- Extraneous dependencies in package.yaml
- File
Cooked.TestUtils, its content has been added toCooked.MockChain.Testing - Support for importing scripts from bytestring in module Cooked.RawUPLC, to be
added back later on - Deprecated skeleton option:
txOptAwaitTxConfirmed - Deprecated use of
*instead ofType - Many unused pragmas
- Orphan default instance for
Ledger.Slot MintsRedeemer(replaced byTxSkelRedeemer)
Changed
- Default era from Babbage to Conway
- No longer rely on deprecated plutus-apps, but instead
cardano-node-emulator - From GHC 8.10.4 to 9.6.5 and associated versions of HLS
- Rely mostly on
CHaP
instead of direct git sources - Update the cheatsheet to account for various small changes + collaterals
ImportQualifiedPostby defaultMockChainEnvis gone, replaced by the new mcstParams field inMockChainSt- The structure of the various steps around transaction validation (fee
generation, ensuring min ada...) - Regrouped all important validation steps, including modifications requested in
skeleton options in the direct implementation ofvalidateTxSkel. - Homogenized and simplified the functions to generate transaction parts from a
TxSkelby using a reader monad over various parameters. - Fully reworked the balancing process and associated balancing options.
See in the dedicated documentation. - Reworked
MockChainerrors related to balancing.
Fixed
- A bug where the ledger state would not be updated by consumed collaterals
- A curious choice where parameter changes for single transactions would be
applied several times instead of one - Various warnings around incomplete pattern matches when selecting utxos for
balancing, with more suitable algorithms
Version 3.0.0
Added
- Modifiers to ease specification of payments in transaction skeletons:
withDatum,withInlineDatum, andwithDatumHashto add or override datums in payments, regardless of whether the type matches the validator type in case of scriptspaysScriptNoDatumto be used withwithDatum,withInlineDatumandwithDatumHash.withReferenceScriptandwithStakingCredentialto add a reference script or staking credential to a payment
- Export
Cooked.UtxoState - A module
Cooked.ShowBSto provide a Plutus-level analogue ofShowwithBuiltinStringas its codomain. This is very inefficient due to limitations ofBuiltinString, but potentially useful for "printf-debugging" of scripts. - An option
txOptEmulatorParamsModificationto temporarily change protocol parameters for balancing and validation of a transaction - A function
combineModsTweakto construct branching tweaks depending on the different combinations of foci of an optic onTxSkel - New
PrettyCookedinstances for common Plutus types - Tweaks on signers in the non-lens tweak API
- A function
resolveTypedDatumto recover typed data on UTxOs inMonadBlockChainBalancing. - A
UtxoSearchthat starts from a list ofTxOutRefs - A transaction option to choose which UTxOs can be spent for balancing
- Lenses for the fields of
TxOpts - Cheatsheet
- API now exposes:
Cooked.Tweak.ValidityRange,interpretAndRun,interpretAndRunWith,runTweak,runTweakFromanddatumHijackingTarget theremodifier to apply a tweak at a precise place in a trace- New tweaks to change the start or end of the transaction validity range:
setValidityStartTweakandsetValidityEndTweak - UTxo searches with predicates over values, including only ada, or not only ada:
filterWithValuePred,filterWithOnlyAdaandfilterWithNotOnlyAda - New pretty-printing options related to hashes in
pcOptHashesincluding the possibility to assign human readable names to hashes (pubkeys, scripts, minting policies) - Initial distributions of funds can now include arbitrat payments instead of only consisting of values belonging to wallets. In particular, we can now initially pay to scripts and have utxos with datums and reference scripts. We can still create an initial distribution in the old fashion way with
distributionFromListor directly provide a list of payments withInitialDistribution. - Dummy pre-existing validators in
Cooked.Validatorsto be used for testing purposes mainly but also as targets for attacks and tweaks. - Small QOL helpers (
ada,lovelaceandadaAssetClass) to create values inCooked.ValueUtils.
Removed
paysPKWithReferenceScript(superseded by thewithReferenceScriptmodifier)- Do not export
Cooked.UtxoPayloadSet
Changed
-
Cooked.holdingInStateis relpaced byCooked.holdsInStatewhich takes an address instead of a wallet as argument. -
Failure testing is slightly modified so that every test has to check that the right error is thrown
Cooked.testFailsFrom'is renamed toCooked.testFailsFromCooked.testFailsis (the new)Cooked.testFailsFromwith the default distribution.
To update their code, users must
- Adapt invokations of
Cooked.testFailsandCooked.testFailsFromadding a predicate that must hold on the error returned by running the transaction, - Rename
Cooked.testFailsFrom'intoCooked.testFailsFrom. - (Bonus) simplify, knowing that
Cooked.testFailsFrom o x def == Cooked.testFails o x
-
Quick and permanent value minting policies have been migrated to PlutusV2.
-
Default initial distribution only provides 5 UTxOs per wallet instead of 10.
Fixes
- Add forgotten export of
permanentValue - In
MockChainT: don't delete data on transaction inputs if there are still UTxOs with that datum around. - Prettyprint unresolved transaction inputs
Version 2.0.0
This major update overhauls the entire library to: handle Plutus V2 features, improve transaction generation, the API, and the internal module structure and code quality.
New features
- Reference inputs can be declared in transaction skeletons.
- Reference scripts can be declared in outputs of transaction skeletons and one can spend inputs from a script that a transaction references.
- Datums in outputs of transaction skeletons can be declared as
- inlined,
- hashed, with the resolved datum included on the transaction (i.e. as in Plutus V1), or
- hashed, without the resolved datum on the transaction.
- New framework to search for UTxOs in the state using chainable filters that bring more type information.
- Parameterizable and revamped pretty-printing relying on
prettyprinter
Changes
- Transaction skeletons are now defined declaratively, no longer using lists of constraints.
- Balancing and transaction generation no longer rely on
plutus-apps, they are performed entirely by cooked. - Transaction skeletons need an explicit signer (no longer signed by a default wallet).
- Modules have been reorganized in a flatter tree and cleaned up.