This project implements the on-chain component of the Cardano implementation of Marlowe as a Plutus smart contract. The main outputs are the marlowe semantics validator, which checks the spending of Marlowe script outputs, and the marlowe role payout validator, which checks the spending of role payouts.
This repository uses nix to provide the development and build environment.
For instructions on how to install and configure nix (including how to enable access to our binary caches), refer to this document.
If you already have nix installed and configured, you may enter the development shell by running nix develop.
If you have direnv installed, you can have the shell automatically load and refresh for you by running these commands:
mkdir .direnv
direnv allowNow, whenever you enter the repo the shell will be automatically loaded for you and will be refreshed when the environment changes.
Once in the dev shell, type info to see the available commands and environment.
From the dev shell, you can compile the project with cabal build all.
Alternatively, you can compile with nix using nix build .#marlowe-validators
You can compile the validators using the following command:
nix build .#marlowe-validatorsThis will build the project and run the marlowe-validators executable and
output the compiled plutus scripts into local directory called result. This
directory will contain two files:
marlowe-rolepayout.plutusThe compiled role payout validator as a JSON-encoded CBOR text-envelope.marlowe-semantics.plutusThe compiled marlowe validator as a JSON-encoded CBOR text-envelope.