pluton's Introduction

P L U T O N O M I C O N

Introduction

The Plutonomicon is a developer-driven guide to the Plutus smart contract language in practice.

Since this ecosystem is moving at a breakneck speed, we ask that ANY information posted that is not confirmed to work on chain be labelled as 🔧 work in progress.

Available resources

We currently provide the following resources, broadly organized by topic.

Fundamentals and explanations

The Fundamentals of Plutus, which gives a brief introduction to the Plutus language.
Plutus from a Transaction Perspective, which gives another perspective to the environment Plutus runs in.
Plutus Numeric Hierarchy, which gives an overview of the Plutus numerical type class stack, as well as the extensions to it provided by plutus-numeric.
User guide to plutus-numeric, which gives a more 'example-driven' explanation for how to do certain common tasks using plutus-numeric.
How Stake Validators Actually Work, which gives an explanation of 'Stake Validators'.

Design patterns

Forward Minting Policy. Also described in another writeup. Some caution is required, as you may not wish to directly reference a script to obtain a hash used to identify the two scripts, as this method details.
Come and Go Proof Tokens
State Thread Token Pattern
DistributedMap, describing an on-chain implementation of key-value mappings. This is naive, and mostly designed for conceptual illustration.
Consistency of a Distributed Map, which explains some ways of operating on a distributed map.
Stick Breaking Set, describing an on-chain method of proving presence or absence in a set.
On-Chain Association List With Constant Time Insert-Removal, describing a pattern that can be used to replicate account-style maps without breaking transaction size limits. This is the optimized version of the naive version of that data structure.
Transaction Tokens provide an method of deferring validation to minting policies for the purpose of validating entire transactions rather than the unlocking of individual UTxOs.
- The Transaction Token Pattern document introduces the pattern.
- The Transaction Token Protocol Architecture document introduces a conceptual and practical framework leveraging the pattern for specifying and implementing protocols.
- The Protocol Category Sketch document sketches a formalism to establish a formalism that places protocols described according the the Architecture into the language of symmetric monoidal categories, and works through some examples of how wiring diagrams and aid specification and implementation.

Testing and optimization

Staying In Bounds, which describes the testing interface for Plutus on-chain size provided by plutus-size-check.

Script Optimization Techniques:

Reducing Plutus Script Sizes
Optimizations to reduce CPU and Mem consumption
Shrinker (shrinker is currently unmaintained)

Plutus Vulnerabilities:

Common Plutus Vulnerabilities

Discussion

To discuss the projects and the content under the Plutonomicon umbrella, join our Discord: https://discord.gg/722KnTC8jF

Running the website

If you'd like to run a live version of the website locally:

nix run

As you edit¹ and save the Markdown files, the browser view should update instantly without requiring a manual refresh. Run nix build to build the statically generated website. See Emanote guide for further information.

Please note the Markdown writing conventions:

There must be zero or one level 1 heading (# A heading) as the first line.
- If a level 1 heading is not specified, title will be derived from the filename.
All other headings must be level 2 or greater.

Try Obsidian or VSCode with vscode-memo for editing. ↩

pluton's People

Contributors

Stargazers

Watchers

pluton's Issues

Calculate ExBudget on applied validator

ScriptSize.validatorSize should take 3 arguments, including ScriptContext (see Plutonomicon/plutarch-plutus#24) so that the ExBudget reflects actual running of the script.

Alternatively, consider benchmarking via Emulator: https://marlowe-playground-staging.plutus.aws.iohkdev.io/doc/plutus/howtos/analysing-scripts.html#resource-use-of-plutus-scripts i.e. https://github.com/input-output-hk/plutus-apps/blob/fd9e2f0ede0b476dcfac1f7c71f2377b4002e6b6/plutus-contract/src/Plutus/Trace/Emulator/Extract.hs#L90-L97

Fix CI

CI is taking too long to build.

Add some non-validator examples

To demonstrate the eDSL, let's add non-contract examples: hello, fibonnaci, numeric operations, etc. Under https://github.com/Plutonomicon/pluton/tree/main/examples/Example

Any time we add an example, they should be added to benchmarks (unless #26 is still open).

Add examples and benchmarks

For each example, benchmark the script size and cpu/mem cost as returned by Plutus evaluator.

Should eventually benchmark the individual DSL functions as well.

Add examples/ and explain them in the README
Have cabal run or something spit out benchmarks #16
Include benchmarks in CI
Triage individual function benchmark, and CI comparison (example)

Criterion benchmarks for Plutus scripts

Can we inject ExBudget and size into criterion?

cf. https://github.com/input-output-hk/plutus/blob/1f31e640e8a258185db01fa899da63f9018c0e85/plutus-core/cost-model/budgeting-bench/Common.hs#L163-L183

Use this in the Gift contract; but it wouldn't be accurate until #27 ... however, we could benchmark on #28.

Benchmarks for contract validator scripts (no criterion) (#30)
Benchmarks for arbitrary scripts (and review using criterion here for all benchmarks)

Gift contract: test is not failing when validator is incorrect

Tests always succeed despite incorrect validator behaviour. At the moment, one needs to peruse the wallet emulator's output to manually verify the validator (if there are funds locked in a script address, the validator is not working as intended).