Merge tag 'v0.37'

.travis.yml

@@ -8,7 +8,7 @@ sudo: required
 cache:
   directories:
   - $HOME/.opam
-#  - tezos
+  - tezos
 
 before_install:
 - sh travis-scripts/prepare-trusty.sh
@@ -18,7 +18,6 @@ install:
 
 script:
 - export OPAMYES=1
-- opam sw 4.06.1
 - eval `opam config env`
 - make
 - make tests-mini

CHANGES

@@ -1,3 +1,26 @@
+0.37  2018-10-05
+    NEW FEATURES
+    * Compatibility with Tezos's Mainnet/Zeronet/Alphanet
+    * Support bytes constants for key, key_hash, address, contract and signature
+    * Attribute [@@inlining] to force inlining when not dangerous
+    * Command --init-storage (Pierre Michard)
+    * Command --inject to inject signed operation
+
+    IMPROVEMENTS
+    * Client: Show failing calls and deployments
+    * Inline bodies of lambdas
+    * Sphinx documentation
+    * Easier build with make build-deps
+    * More optimizations on Michelson code
+
+    BUG FIXES
+    * Fix issue with printing of signatures
+    * Missing decompilation for LSL, LSR
+    * Fix inlining bug in decompilation
+    * Code elimination after FAILWITH in code generation
+    * Fix erroneous pretty-printing of tez values
+    * Forbid source, sender in initializer
+
 0.32  2018-07-11
     NEW FEATURES
     * Compatibility with Tezos's Betanet

Makefile

@@ -8,7 +8,7 @@ build: _obuild
 	ocp-build build
 
 install: _obuild
-	ocp-build install
+	ocp-build install liquidity
 
 _obuild: Makefile
 	ocp-build init
@@ -22,9 +22,16 @@ clean-sources:
 clean: _obuild clean-tests clean-sources
 	ocp-build clean
 
+build-deps:
+	opam install ocp-build ocplib-endian zarith calendar digestif hex ocurl lwt \
+	       lwt_log uri sodium bigstring ezjsonm
+
 distclean: clean
 	rm -rf _obuild
 
+doc:
+	$(MAKE) -C docs/sphynx/
+
 # All of these tests must be run with with_tezos=true
 
 NTESTS=41

docs/liquidity.md

@@ -147,9 +147,9 @@ Liquidity functions:
        transfered when the contract was called.
 * `STEPS_TO_QUOTA` : `Current.gas ()`. Returns the current gas available
        to execute the end of the contract.
-* `SOURCE` : `Contract.source`.
+* `SOURCE` : `Current.source ()`.
        Returns the address of the contract that initiated the current transaction.
-* `SENDER` : `Contract.sender`.
+* `SENDER` : `Current.sender ()`.
        Returns the address of the last contract that called the current contract.
 * `CONS` : `x :: y`
 * `NIL ele_type` : `( [] : ele_type list )`

docs/sphynx/.gitignore

@@ -0,0 +1,4 @@
+/_site
+/_*
+/Liquidity.epub
+/Liquidity.pdf

docs/sphynx/Makefile

@@ -0,0 +1,30 @@
+SPHINXBUILD   = sphinx-build
+SPHINXOPTS    = -aE -n
+SOURCEDIR     = src
+
+sources := $(shell find $(SOURCEDIR) -type f) Makefile ../../.git/logs/HEAD
+
+all: html pdf epub
+
+html: _site
+pdf: Liquidity.pdf
+epub: Liquidity.epub
+
+_site: $(sources)
+	$(SPHINXBUILD) -b html "$(SOURCEDIR)" _site $(SPHINXOPTS)
+
+Liquidity.epub: $(sources)
+	$(SPHINXBUILD) -b epub "$(SOURCEDIR)" _epub $(SPHINXOPTS)
+	mv _epub/Liquidity.epub Liquidity.epub
+
+Liquidity.pdf: $(sources)
+	$(SPHINXBUILD) -b latex "$(SOURCEDIR)" _pdf $(SPHINXOPTS)
+	cd _pdf && xelatex Liquidity && xelatex Liquidity
+	mv _pdf/Liquidity.pdf Liquidity.pdf
+
+clean:
+	rm -rf _site _epub _pdf *~ Liquidity.pdf Liquidity.epub
+	find . -name '*~' -exec rm -f {} \;
+
+web: _site
+	cd _site && php -S localhost:10000

docs/sphynx/src/_static/css/fixes.css

@@ -0,0 +1,19 @@
+@media screen and (min-width: 1400px) {
+    .wy-nav-content-wrap {
+        background: #fcfcfc;
+    }
+    .wy-nav-content {
+        margin: auto;
+        background: #fcfcfc;
+    }
+}
+
+@media screen and (min-width: 1100px) {
+    .wy-nav-content-wrap {
+        background: #fcfcfc;
+    }
+    .wy-nav-content {
+        margin: auto;
+        background: #fcfcfc;
+    }
+}

docs/sphynx/src/conf.py

@@ -0,0 +1,218 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# Liquidity documentation build configuration file, created by
+# sphinx-quickstart.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# sys.path.insert(0, os.path.abspath('.'))
+
+import os
+import sys
+import datetime
+import subprocess
+from os import environ
+sys.path.insert(0, os.path.abspath('.') + '/_extensions')
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = ['sphinx.ext.extlinks']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = 'Liquidity'
+copyright = '2018, OCamlPro SAS. <contact@ocamlpro.com>'
+author = 'OCamlPro SAS. <contact@ocamlpro.com>'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+
+version = subprocess.check_output("git describe --tags", shell=True).decode("utf-8")
+# version = os.environ.get('CI_COMMIT_REF_NAME', 'v1.0')
+# The full version, including alpha/beta/rc tags.
+release = version + datetime.datetime.now().strftime(" (%Y/%m/%d %H:%M)")
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'doc_gen']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# Deactivate syntax highlighting
+# - http://www.sphinx-doc.org/en/stable/markup/code.html#code-examples
+# - http://www.sphinx-doc.org/en/stable/config.html#confval-highlight_language
+highlight_language = 'ocaml'
+# TODO write a Pygments lexer for Michelson
+# cf. http://pygments.org/docs/lexerdevelopment/ and http://pygments.org/docs/lexers/
+
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = "sphinx_rtd_theme"
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+html_theme_options = {'logo_only': True}
+html_logo = "logo.svg"
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# This is required for the alabaster theme
+# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
+# html_sidebars = {
+#     '**': [
+#         'relations.html',  # needs 'show_related': True theme option to display
+#         'searchbox.html',
+#     ]
+# }
+
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'Liqdoc'
+
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+    'inputenc':'',
+    'utf8extra': '',
+    'preamble': '''
+
+\usepackage{fontspec}
+\setsansfont{Arial}
+    \setromanfont{Times New Roman}
+\setmonofont{Courier 10 Pitch}
+''',
+
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'Liquidity.tex', 'Liquidity Documentation',
+     'OCamlPro SAS', 'manual'),
+]
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'liquidity', 'Liquidity Documentation',
+     [author], 1)
+]
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'Liquidity', 'Liquidity Documentation',
+     author, 'Liquidity', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+# -- Ignore fragments in linkcheck
+
+linkcheck_anchors = False
+
+
+# -- Options for Epub output -------------------------------------------------
+
+# Bibliographic Dublin Core info.
+epub_title = project
+epub_author = author
+epub_publisher = author
+epub_copyright = copyright
+
+# The unique identifier of the text. This can be a ISBN number
+# or the project homepage.
+#
+# epub_identifier = ''
+
+# A unique identification for the text.
+#
+# epub_uid = ''
+
+# A list of files that should not be packed into the epub file.
+epub_exclude_files = ['search.html']
+
+# entry point for setup
+def setup(app):
+    app.add_stylesheet('css/fixes.css')