Clarity.ml

Clarity.ml parses Clarity smart contracts into an abstract syntax tree.

Installation

opam pin add -y clarity-lang https://github.com/weavery/clarity.ml -k git

Development

This section documents how to get set up with a development environment for building Clarity.ml from source code. It is only of interest to people who wish to contribute to Clarity.ml.

Prerequisites

The following baseline tooling is required in order to build Clarity.ml from source code:

• Git

• OCaml 4.11+

• OPAM

• Dune

Dependencies

The following OCaml tools and libraries are required in order to build Clarity.ml from source code:

• Alcotest for unit tests

• Cppo for code preprocessing

• Menhir for parsing

• Num for 128-bit integers

These aforementioned dependencies are all best installed via OPAM:

opam install -y alcotest cppo menhir num

Installing from source code

git clone https://github.com/weavery/clarity.ml.git

cd clarity.ml

dune build

dune install

Acknowledgments

We thank Arweave and the Stacks Foundation for sponsoring the development of this project as part of the development of Sworn and Clarc, respectively.