morley: Developer tools for the Michelson Language

[ agpl, language, library, mit, program ] [ Propose Tags ]

A library to make writing smart contracts in Michelson — the smart contract language of the Tezos blockchain — pleasant and effective.


[Skip to Readme]
Versions [faq] 0.1.0.0, 0.1.0.1, 0.1.0.2, 0.1.0.3, 0.1.0.4, 0.1.0.5, 0.2.0, 0.2.0.1, 0.3.0, 0.3.0.1, 0.4.0, 0.5.0, 0.6.0, 0.7.0, 1.0.0, 1.1.0, 1.2.0, 1.3.0, 1.4.0, 1.5.0, 1.6.0, 1.7.0, 1.7.1, 1.8.0, 1.8.1
Change log CHANGES.md
Dependencies aeson, aeson-casing, aeson-pretty, base (>=4.7 && <5), base58-bytestring, binary, bytestring, constraints (>=0.11), containers, cryptonite, data-default, first-class-families (>=0.5.0.0), fmt, generic-deriving, gitrev, haskeline, hex-text, interpolate, lens, megaparsec (>=7.0.0), memory, morley, morley-prelude (>=0.3.0), mtl, named, optparse-applicative, parser-combinators (>=1.0.0), pretty-simple, semigroups (>=0.19.1), show-type, singletons, syb, template-haskell, text, th-lift, th-lift-instances, time, timerep, transformers-compat (==0.6.5), unordered-containers, vector, vinyl, with-utf8, wl-pprint-text [details]
License MIT
Copyright 2018 camlCase, 2019-2020 Tocqueville Group
Author camlCase, Serokell, Tocqueville Group
Maintainer Serokell <hi@serokell.io>
Category Language
Home page https://gitlab.com/morley-framework/morley
Bug tracker https://gitlab.com/morley-framework/morley/-/issues
Source repo head: git clone git@gitlab.com:morley-framework/morley.git
Uploaded by gromak at 2020-10-27T11:37:26Z
Distributions NixOS:1.7.1
Executables morley
Downloads 6248 total (568 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Hackage Matrix CI
Docs uploaded by user
Build status unknown [no reports yet]

Modules

[Index] [Quick Jump]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees


Readme for morley-1.8.1

[back to package description]

Morley: Developer tools for the Michelson Language

Hackage

Morley aims to make writing smart contracts in Michelson pleasant and effective. It contains 3 major things:

  1. An executable that lets you perform various operations on Michelson smart contracts.
  2. A library with core Tezos and Michelson data types, and functions such as Michelson typechecker and interpreter.
  3. A superset of the Michelson language that we call the Morley language. It relaxes Michelson parser rules, adds some syntax sugar and simple features.

Morley executable

How to install

There are three ways to get Morley executable:

  • Docker based (preferable).
    • Get script (e. g. using curl https://gitlab.com/morley-framework/morley/raw/master/scripts/morley.sh > morley.sh) and run it ./morley.sh <args>. This script will pull a docker image that contains the latest version of Morley executable from the production branch and run it with the given arguments. You'll need coreutils to be installed in order to use morley.sh.
    • Usage example:
      • ./morley.sh to see help message
      • ./morley.sh run --contract add1.tz --storage 1 --parameter 1 --amount 1
  • Stack based.
    • Clone this git repository and run stack build command, after that you can do stack exec -- morley <args> to run morley executable built from the source code.
    • Usage example:
      • stack exec -- morley --help to see help message
      • stack exec -- morley originate --contract contracts/tezos_examples/attic/add1.tz --storage 1 --verbose
  • Cabal based.
    • Clone this git repository, go to this directory and run cabal new-update && cabal new-build command, after that you can do cabal new-run -- morley <args> to run morley executable built from the source code.
    • Usage example:
      • cabal new-run -- morley --help to see help message
      • cabal new-run -- morley originate --contract contracts/tezos_examples/attic/add1.tz --storage 1 --verbose

Usage

Morley executable does not interact with Tezos node and Tezos network. It works in emulated environment which is stored in a simple JSON file on disk. The following commands depend on environment and may modify it:

  • originate a contract.
  • transfer tokens to a given address (and call a smart contract if it's the destination).
  • run a contract. A given contract is being originated first, and then the transaction is being sent to it.

The following commands don't depend on environment:

  • optimize a contract by replacing certain sequences of instructions with equivalent but more efficient ones.
  • typecheck a contract.
  • repl starts a REPL where you can type Michelson instructions and interpret them.
  • analyze a contract and print some statistics about it.
  • print a contract in vanilla Michelson format. It can be useful in some cases:
    • You have a smart contract that uses Morley extensions and want to convert it to vanilla Michelson format that can be handled by Tezos reference implementation.
    • You have a contract with inconsistent/ugly formatting and want to format it in uniform style.
    • You want to print a contract on a single line.
  • parse a contract and return its representation in Haskell types.

You can get more info about these commands by running morley <command> --help. Run morley --help to get the list of all commands.

Morley library

Morley-the library is available on Hackage. It consists of the following parts:

  • Tezos.* hierarchy is designed to implement cryptographic primitives, string and byte formats, and any other functionality specific to the Tezos protocol which is required for testing/execution of Michelson contracts but is used not only by Michelson.
  • Michelson.Untyped and Michelson.Typed hierarchies define Haskell data types that assemble a Michelson contract. See michelsonTypes.md.
  • Michelson.TypeCheck: A typechecker that validates Michelson contracts according to the Michelson's typing rules. Essentially, it performs conversion from untyped representation to the typed one. See morleyTypechecker.md.
  • Michelson.Interpret: An interpreter for Michelson contracts which doesn't perform any side effects. See morleyInterpreter.md.
  • Michelson.Macro Types for macros, syntactic sugar, and other extensions that are described in the next chapter.
  • Michelson.Parser A parser to turn a .tz or .mtz file (.mtz is a Michelson contract with Morley extensions) into a Haskell ADT.
  • Michelson.Runtime: A high-level interface to Morley functionality, see morleyRuntime.md.

Morley language

Morley-the-language is a superset of the Michelson language, which means that each Michelson contract is also a valid Morley contract but not vice versa. There are several extensions which make it more convenient to write Michelson contracts and test them. For example, one can write inline assertions in their contracts for testing. All the details can be found in the document about these extensions. A smart contract written in the Morley language can be transpiled to Michelson using the aforementioned morley print command.