Version 8.0.0 available

[mmontin]

cooked-validators version 8.0.0 is now available. The most notable changes are:

• Dependencies are pinned to the latest version before Dijsktra era.
• More governance features have been implemented, related to certificates, withdrawals and proposals.
• The usage of optics throughout the library has been homonenized and extended. All of the elements of a skeleton have been attached relevant optics, all of which is explained in file OPTICS.md.
• The wallet have been relegated from first class citizens to mere testing artifacts. Notably, signatories have been improved, allowing for transactions to be built first, and signed later on.
• Running a mockchain is now more flexible, with a new type of parameters depicting the initial distribution of funds to apply, the initial state from which the run should occur, and how to process the output of the run.
• Some type-level guarantees have been introduced to ensure type-safety of skeleton elements. From these, the notion of User has been created, encompassing either a script or a pubkey, alongside the intent of the usage.
• The datum hijacking attack has been revamped and parameterized with the partial function for the new owner, the filter on the index of the output, and whether each output should be treated in the same transaction, or independently in different branches.
• A new primitive allow to force the creation of a given list of outputs on-chain. This is useful for testing purpose to force reaching a state that is not yet reachable through regular transaction processing.
• New Ltl combinators have been introduced, alongside a new idiom to pinpoint transactions in a trace based on their labels.

Full changelog below:

Added

• viewByRef and previewByRef which call txSkelOutByRef and apply a getter
  and an affine fold on it, respectively.
• Optics working on values in Cooked.Skeleton.Output
• Missing instance of IsTxSkelOutAllowedOwner for Versioned Script
• A new documentation file around optics, in doc/OPTICS.md
• New forceOutputs primitives to force the creation of new utxos from a list
  of TxSkel. Initial distributions are now handled using this primitive.
• Added somewhere', everywhere' and there' which accept arbitrary Ltl
  expressions.
• Added labelled[T]['] tweaks, to apply a tweak to transactions with a
  specific label.
• Added label and as IsString instance for TxSkelLabel to make adding
  labels easier.
• Added Cooked.Ltl.Combinators with anyOf['] and allOf['] helpers to
  make combining multiple Ltl expressions together simpler.
• delay['] delays an Ltl formula by n timestamps.
• there, everywhere and somewhere is now implemented
  in terms of Cooked.Ltl.Combinators.
• Module Cooked.MockChain.AutoFilling to gather all automated filling of
  skeleton parts performed during pre-validation phase. This include the new
  automated assignment of withdrawn amounts, and automated assignment of
  constitution script.
• Log events MCLogAutoFilledConstitution and MCLogAutoFilledWithdrawalAmount
  to log the respective auto filling occurrences.
• Handling certificates
• A notion of User, now used widely in the library, in module
  Cooked.Skeleton.User, alongside relevant type families around the type, in
  module Cooked.Skeleton.Families.
• Aliases for fees (Fee), collaterals (CollateralIns, Collaterals) and
  list of utxos (Utxos).
• TxSkelSignatory in module Cooked.Skeleton.Signatory. Signatories are no
  longer forced to expose a private key, in which case they will be in required
  signer, but will not sign the transaction. This opens up the possibility to
  delay signatures.
• Primitive getCurrentReward to retrieve the current rewards of a staking
  credential, which will always be 0 at this point.
• Functions to fetch, from the protocol parameters, the current deposits values
  (dRepDeposit, stakeAddressDeposit and stakePoolDeposit).
• Function txSkelDepositedValueInCertificates to fetch the total value
  deposited in certificates (which can be negative in case of deregistration).
• Anchors have their own builtin depiction and generation function.
• txSkelMintsPolicyTokensL to focus on the submap of a specific currency
  symbol within a TxSkelMints.
• Module Cooked.Skeleton.Value which exposes useful optics around values.
• New function txSkelCertifyingScripts collecting all certifying script from a
  skeleton.
• Balancing will now automatically attach an input utxo when there are not and
  the balancing is in favour of the output, to avoid sending transaction with no
  inputs.

Removed

• Module Cooked.Skeleton.Value. TxSkelOutValue no longer exists and has been
  replaced by two fields for TxSkelOut, txSkelOutValue and
  txSkelOutValueAutoAdjust.
• unsafeTxOutByRef which is now the default behavior for txOutByRef
• Dedicated lookup functions for part of TxSkelOut such as
  typedDatumFromTxOutRef as they have been replaced by viewByRef or
  previewByRef.
• DatumContent. In a TxSkelOutDatum the datum is now stored as is, and a new
  type, UtxoPayloadDatum is used to store datum in utxo payloads.
• Module Cooked.Attack.DupToken, now regrouped with Cooked.Attack.AddToken
• Module Cooked.MockChain.GenerateTx, whose content can now be found in
  Cooked.MockChain.GenerateTx.Body
• Modules Cooked.MockChain.MinAda, Cooked.MockChain.AutoReferenceScript,
  regrouped in module Cooked.MockChain.AutoFilling
• Primitive registerStakingCred from the MonadBlockChain class, no longer
  needed thanks to the handling of certificates.
• Module Cooked.Skeleton.Payable, spread across Cooked.Skeleton.Output and
  Cooked.Skeleton.Families.
• Module Cooked.Skeleton.ReferenceScript, now directly handled in
  Cooked.Skeleton.Output.

Changed

• TxOpts replaced by TxSkelOpts and field names changed likewise.
• TxLabel replaced by TxSkelLabel
• txOutByRef replaced by txSkelOutByRef. It now throws an error if the
  output is not found and thus it returns m TxSkelOut instead of m (Maybe TxSkelOut)
• Complete overhaul of the optics within skeleton. Their names has been made
  consistent, the missing ones have been added and they are used more
  consistently throughout the codebase.
• TxSkelMints has been improved and clarified.
• Transaction modifications in options are now called txSkelModTx and is now a
  simple unwrapped function.
• Parameters modifications in options are now called txSkelModParams and is
  now a simple unwrapped function.
• ToCredential is no longer a requirement for an owner of a TxSkelOut,
  instead it is derived from IsTxSkelOutAllowedOwner
• Some helpers, like txSkelOutValue are gone, as part of the optics overhaul,
  and are replaced by their optics counterpart, such as view txSkelOuValueL.
• addMintTweak replaced by addMintsTweak which can add multiple mint
  constraints in one go.
• Improved, and regrouped, token duplication and token addition attacks.
• Fully reworked datum hijacking attacks, with a new DatumHijackingParams type
  to pilot how the datum hijacking should be performed.
• Wallets are no longer integral to cooked. They are still present but only for
  testing purposes. They have been replaced by relevant replacements, in
  particular User where applicable.
• txSkelSigners has been replaced by txSkelSignatories, which is a list of
  TxSkelSignatory. It can still be built by lists of wallets using
  txSkelSignatoriesFromList. All occurrences of 'signer' in the codebase have
  been replaced by 'signatory'.
• txSkelInputsValidators renamed to txSkelInputScripts
• txSkelProposalsDeposit renamed to txSkelDepositedValueInProposals
• Functions to run a MockChainT have been revisited to be more flexible. A
  type MockChainConf has been added to pilot the run. It contains an initial
  state, an initial distribution of funds, and a function to apply on the raw
  result of the run.
• Testing functions isInWallets and isInWallet have been changed and renamed
  to isAtAddress and possesses.
• Full upgrade and reworking of the withdrawals.
• Module Cooked now exposes much more of the library. The idea is to hide as
  few definitions as possible, only those that are really not meant to be used,
  such as unsafe constructors.
• Versions of our nix dependencies, hackage and chap index states, and Cardano
  library have been updated. In particular, the current version of cardano-api
  is now 10.18.1.0, the last one before Dijsktra.