diff --git a/CHANGES.md b/CHANGES.md --- a/CHANGES.md +++ b/CHANGES.md @@ -1,3 +1,8 @@ +0.2.0.1 +====== + +* Update documentation and metadata. + 0.2.0 ===== diff --git a/README.md b/README.md --- a/README.md +++ b/README.md @@ -7,62 +7,69 @@ 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. +- `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](/docs/michelsonTypes.md). -- `Michelson.TypeCheck`: A typechecker that validates Michelson contracts according to Michelson's typing rules. Essentially it performs conversion from untyped representation to the typed one. See [morleyTypechecker.md](/docs/morleyTypechecker.md). -- `Michelson.Intepreter`: An intepreter for Michelson contracts which doesn't perform any side effects. See [morleyInterpreter.md](/docs/morleyInterpreter.md). -- `Morley.Types`: Types for macros, syntactic sugar and other extensions described in the next chapter. +- `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](/docs/morleyTypechecker.md). +- `Michelson.Interpret`: An interpreter for Michelson contracts which doesn't perform any side effects. See [morleyInterpreter.md](/docs/morleyInterpreter.md). +- `Morley.Types`: Types for macros, syntactic sugar, and other extensions that are described in the next chapter. - `Morley.Parser` A parser to turn a `.tz` or `.mtz` file (`.mtz` is a Michelson contract with Morley extensions) into a Haskell ADT. - `Morley.Runtime`: A high-level interface to Morley functionality, see [morleyRuntime.md](/docs/morleyRuntime.md). ## II: Morley extensions -The Morley Language is a superset of the Michelson language, which means that each Michelson contract is also a valid Morley contract but not vice versa. +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. -See [the document](/docs/morleyLanguage.md) about these extensions. -Also there is a transpiler from Morley to Michelson. +For example, one can write inline assertions in their contracts for testing. +All the details can be found in [the document](/docs/morleyLanguage.md) 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 Morley contract. -You should use it if you want to develop contracts in Morley and submit them to Tezos network. +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 > 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 interpreter it using reference implementation. If you are not familiar with Tezos tooling, please read [Tezos documentation](http://tezos.gitlab.io/zeronet/index.html) or [Michelson tutoriral](https://gitlab.com/camlcase-dev/michelson-tutorial). +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](http://tezos.gitlab.io/zeronet/index.html) or [Michelson tutorial](https://gitlab.com/tezos-standards/michelson-tutorial). ## IV: Testing EDSL -Coming soon, see TM-77. +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](/docs/testingEDSL.md) with a detailed description of the EDSL and a tutorial about its usage. ## Running and building -Morley executable provides following functionality: -- `parse` contract and return its representation in haskell types. +Morley executable provides the following functionality: +- `parse` contract and return its representation in Haskell types. - `typecheck` contract. -- `run` contract. Given contract is being originated first and then transaction is being sent to it +- `run` contract. A given contract is being originated first, and then the transaction is being sent to it - `originate` contract. -- `transfer` tokens to given address. +- `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 --help` -There are two ways to get morley executable: -- [Docker](https://docs.docker.com/) based (preferable). Get [script](/scripts/morley.sh) - (e. g. using `curl https://gitlab.com/camlcase-dev/morley/raw/master/scripts/morley.sh > morley.sh`) - and run it `./morley.sh `. This script will pull docker image that contains latest version of morley executable from master branch and run it with given arguments. - Usage example: - `./morley.sh` to see help message - `./morley.sh run --contract add1.tz --storage 1 --parameter 1 --amount 1` -- [Stack](https://docs.haskellstack.org/en/stable/README/) based. Clone this git repository and run `stack build` command, - after that you can do `stack exec -- morley ` to run morley executable built from source code. - Usage example: - `stack exec -- morley --help` to see help message - `stack exec -- morley originate --contract contracts/add1.tz --storage 1 --verbose` +There are two ways to get Morley executable: +- [Docker](https://docs.docker.com/) based (preferable). + * Get [script](/scripts/morley.sh) + (e. g. using `curl https://gitlab.com/tezos-standards/morley/raw/master/scripts/morley.sh > morley.sh`) + and run it `./morley.sh `. 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](https://docs.haskellstack.org/en/stable/README/) based. + * Clone this git repository and run `stack build` command, + after that you can do `stack exec -- morley ` 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/add1.tz --storage 1 --verbose` -For more information about morley commands check out following docs: -- [interpreter doc](/docs/morleyInterpreter.md) -- [typechecker doc](/docs/morleyTypechecker.md) +For more information about Morley commands, check out the following docs: +- [Interpreter doc](/docs/morleyInterpreter.md) +- [Typechecker doc](/docs/morleyTypechecker.md) ## Issue Tracker diff --git a/app/Main.hs b/app/Main.hs --- a/app/Main.hs +++ b/app/Main.hs @@ -7,11 +7,11 @@ import Fmt (pretty) import Named ((!)) import Options.Applicative - (auto, command, eitherReader, execParser, footerDoc, fullDesc, header, help, helper, info, infoOption, - long, maybeReader, metavar, option, progDesc, readerError, short, showDefault, showDefaultWith, - strOption, subparser, switch, value) -import Options.Applicative.Help.Pretty (Doc, linebreak) + (auto, command, eitherReader, execParser, footerDoc, fullDesc, header, help, helper, info, + infoOption, long, maybeReader, metavar, option, progDesc, readerError, short, showDefault, + showDefaultWith, strOption, subparser, switch, value) import qualified Options.Applicative as Opt +import Options.Applicative.Help.Pretty (Doc, linebreak) import Paths_morley (version) import Text.Pretty.Simple (pPrint) @@ -346,11 +346,11 @@ , " morley run --help", linebreak , linebreak , "Documentation for morley tools can be found at the following links:", linebreak - , " https://gitlab.com/camlcase-dev/morley/blob/master/README.md", linebreak - , " https://gitlab.com/camlcase-dev/morley/tree/master/docs", linebreak + , " https://gitlab.com/tezos-standards/morley/blob/master/README.md", linebreak + , " https://gitlab.com/tezos-standards/morley/tree/master/docs", linebreak , linebreak , "Sample contracts for running can be found at the following link:", linebreak - , " https://gitlab.com/camlcase-dev/morley/tree/master/contracts", linebreak + , " https://gitlab.com/tezos-standards/morley/tree/master/contracts", linebreak , linebreak , "USAGE EXAMPLE:", linebreak , " morley parse --contract add1.tz", linebreak diff --git a/morley.cabal b/morley.cabal --- a/morley.cabal +++ b/morley.cabal @@ -1,15 +1,15 @@ cabal-version: 2.4 name: morley -version: 0.2.0 +version: 0.2.0.1 synopsis: Developer tools for the Michelson Language description: A library to make writing smart contracts in Michelson — the smart contract language of the Tezos blockchain — pleasant and effective. -homepage: https://gitlab.com/camlcase-dev/morley +homepage: https://gitlab.com/tezos-standards/morley license: AGPL-3.0-or-later license-file: LICENSE -author: camlCase, Serokell -maintainer: john@camlcase.io +author: camlCase, Serokell, Tocqueville Group +maintainer: john.c.burnham@gmail.com copyright: 2018 camlCase, 2019 Tocqueville Group category: Language build-type: Simple @@ -20,7 +20,7 @@ source-repository head type: git - location: git@gitlab.com:camlcase-dev/morley.git + location: git@gitlab.com:tezos-standards/morley.git library hs-source-dirs: src