well-typed / plutonomy

An optimizer for untyped plutus core

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

plutonomy

plutonomy is an optimizer for untyped plutus core.

It can be plugged into any Plutus compilation pipeline, by adding an extra pass. The optimiser is configurable to an extent. At the default optimisation level, the optimiser should exactly preserve the semantics of the original code. At a particularly aggressive optimisation level, the optimiser can perform certain transformations that may not preserve the semantics.

Any use of the library as well as feedback is welcome, but due to time constraints, we cannot guarantee any level of unpaid support. Please contact Well-Typed via email to info@well-typed.com if you are interested in commercial support or funding development of the library.

Usage

The main optimiser entry point is Plutonomy.UPLC.optimizeUPLC or Plutonomy.UPLC.optimizeUPLCWith if you want to deviate from the default configuration options.

The library additionally provides its own variants of validator scripts and minting policy scripts (via Plutonomy.Scripts.mkValidatorScript and Plutonomy.Scripts.mkMintingPolicyScript) that can be turned back into their Plutus counterparts via Plutonomy.Scripts.validatorToPlutus and Plutonomy.Scripts.mintingPolicyToPlutus. The Plutonomy representation is intended for debugging / inspection as it uses names for binders instead of de Bruijn indices.

Flags

plutonomy currently supports two plutus versions, identified via their git commit hashes. There is also partial support for CHaP versions of plutus-core. You need to toggle one of the flags:

  • CHaP
  • plutus-1efbb276e
  • plutus-4710dff2e
  • plutus-f680ac697 (cardano-node-1.35.1)

For example, add to your cabal.project:

flags: +plutus-1efbb276e

None of the two flags are on by default, so you need to enable the flag corresponding to the version you want to use, but never turn off any version flags.

About

An optimizer for untyped plutus core

License:BSD 3-Clause "New" or "Revised" License


Languages

Language:Haskell 99.5%Language:Shell 0.5%