morley: Developer tools for the Michelson Language

[ agpl, language, library, 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
Change log CHANGES.md
Dependencies aeson, aeson-options, aeson-pretty, base-noprelude (>=4.7 && <5), base16-bytestring, base58-bytestring, binary, bytestring, constraints (>=0.11), containers, cryptonite, data-default, first-class-families (>=0.5.0.0), fmt, formatting, ghc-prim, gitrev, hex-text, hspec, HUnit, interpolate, lens, megaparsec (>=7.0.0), memory, morley, morley-prelude (>=0.3.0), mtl, named, optparse-applicative, parser-combinators (>=1.0.0), pretty-simple, QuickCheck, quickcheck-arbitrary-adt, quickcheck-instances, show-type, singletons, syb, tasty, tasty-ant-xml, tasty-hunit-compat, tasty-quickcheck, template-haskell, text, th-lift, th-lift-instances, time, timerep, transformers-compat (==0.6.5), unordered-containers, vector, vinyl, wl-pprint-text [details]
License AGPL-3.0-or-later
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 Sun Feb 16 11:07:21 UTC 2020
Distributions NixOS:0.6.0
Executables morley
Downloads 2606 total (599 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Hackage Matrix CI
Docs available [build log]
Last success reported on 2020-02-16 [all 1 reports]

Modules

[Index] [Quick Jump]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees


Readme for morley-1.0.0

[back to package description]

Morley: Developer tools for the Michelson Language

Hackage

Morley is a library to make writing smart contracts in Michelson pleasant and effective.

I: A reimplementation of the Michelson Language in Haskell

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.

II: Morley extensions

One way to test Michelson contracts is to use the Morley language. It 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. Also, there is a transpiler from Morley to Michelson.

III: Morley-to-Michelson transpiler

Morley-to-Michelson transpiler can be used to produce a Michelson contract from a Morley contract. You should use it if you want to develop contracts in Morley and submit them to the Tezos network. Workflow is the following:

  1. If your contract is called foo.mtz, use morley print --contract foo.mtz --output foo.tz. Note that normally you should not use morley directly, you should use morley.sh or stack exec -- morley. See usage instructions below.
  2. After that, you can use existing Tezos tools to deploy your contract. You can also typecheck or interpret it using a reference implementation. If you are not familiar with the Tezos tooling, please read Tezos documentation or Michelson tutorial.

IV: Testing EDSL

Another way to test Michelson contracts is to write tests in Haskell using the testing EDSL provided by Morley. It supports both integrational and unit tests. Tests of both types can use static data or arbitrary data. There is a document with a detailed description of the EDSL and a tutorial about its usage.

Running and building

Morley executable provides the following functionality:

  • parse contract and return its representation in Haskell types.
  • typecheck contract.
  • run contract. A given contract is being originated first, and then the transaction is being sent to it
  • originate contract.
  • transfer tokens to a given address.
  • print produce .tz contract that can be parsed by the OCaml referenced client from .mtz or .tz contract.

You can get more info about this command by running morley <command> --help

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 master branch and run it with the given arguments.
    • 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 and run cabal new-update && cabal new-build command, after that you can do cabal run -- morley <args> to run morley executable built from the source code.
    • Usage example:
      • cabal run -- morley --help to see help message
      • cabal run -- morley originate --contract contracts/tezos_examples/attic/add1.tz --storage 1 --verbose

For more information about Morley commands, check out the following docs:

Michelson version

master and production branches are maintained to be compatible with version of Michelson running on mainnet. We use separate branches to support other versions. More information about our branching strategy can be found here.

Issue Tracker

We used to use YouTrack as our primary issue tracker. You may see that commit messages up to some date are prefixed with [TM-X]. This prefix refers to an issue in our YouTrack. YouTrack issues are public, so you can open any of them.

Nowadays we are using built-in issue tracker on GitLab.

For Contributors

Please see CONTRIBUTING.md for more information.