Merge pull request #16 from EspeoBlockchain/feature/documentation

added documentation with getting started written in sphinx

.env.tpl

@@ -3,8 +3,8 @@ PRIVATE_KEY=0xb0057716d5917badaf911b193b12b910811c1497b5bada8d7711f758981c3773
 ORACLE_ADDRESS=0xcfeb869f69431e42cdb54a4f4f105c19c080a601
 DATABASE_URL=mongo:27017
 DATABASE_NAME=oracle-server
-NODE_URL=http://127.0.0.1:8545
+NODE_URL=http://test-blockchain:8545
 API_PORT=3001
-SAFE_BLOCK_DELAY=2
+SAFE_BLOCK_DELAY=0
 START_BLOCK=0
 PERSISTENCE=INMEMORY

.gitignore

@@ -5,4 +5,5 @@ node_modules
 
 /.env
 logs/*
-!logs/.gitkeep
+!logs/.gitkeep
+/docs/_build/

Makefile

@@ -12,3 +12,6 @@ local: copy-env
 
 clean-local:
 	docker-compose -f docker-compose.yml -f docker-compose.local.yml down
+
+ganache:
+	docker-compose -f docker-compose.yml -f docker-compose.local.yml up -d --build ganache-cli

README.md

@@ -6,6 +6,8 @@
 This repository is a part of open source oracle project. Initially developed by Espeo Software. 
 Contains off-chain server for processing requests from the `Oracle` contract.
 
+Detailed documentation here: https://gardener.readthedocs.io
+
 Table of contents:
 - [Oracle theory](#oracle-theory)
 - [Architecture](#architecture)

docs/Makefile

@@ -0,0 +1,19 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/conf.py

@@ -0,0 +1,181 @@
+# -*- coding: utf-8 -*-
+#
+# Configuration file for the Sphinx documentation builder.
+#
+# This file does only contain a selection of the most common options. For a
+# full list see the documentation:
+# http://www.sphinx-doc.org/en/master/config
+
+# -- Path setup --------------------------------------------------------------
+
+# 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.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+import datetime
+
+
+# -- Project information -----------------------------------------------------
+
+now = datetime.datetime.now()
+
+project = 'Gardener'
+copyright = str(now.year) + ', Espeo Blockchain'
+author = 'Espeo Blockchain'
+
+# The short X.Y version
+version = ''
+# The full version, including alpha/beta/rc tags
+release = '0.1.0'
+
+
+# -- 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.autodoc',
+]
+
+# 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'
+
+# 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 pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = None
+
+
+# -- 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 = 'alabaster'
+
+# 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 = {}
+
+# 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.
+#
+# The default sidebars (for documents that don't match any pattern) are
+# defined by theme itself.  Builtin themes are using these templates by
+# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
+# 'searchbox.html']``.
+#
+# html_sidebars = {}
+
+
+# -- Options for HTMLHelp output ---------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'Gardenerdoc'
+
+
+# -- Options for LaTeX output ------------------------------------------------
+
+latex_elements = {
+    # 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, 'Gardener.tex', 'Gardener Documentation',
+     'Espeo Blockchain', '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, 'gardener', 'Gardener 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, 'Gardener', 'Gardener Documentation',
+     author, 'Gardener', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+# -- Options for Epub output -------------------------------------------------
+
+# Bibliographic Dublin Core info.
+epub_title = project
+
+# 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']
+
+
+# -- Extension configuration -------------------------------------------------

docs/getting-started.rst

@@ -0,0 +1,91 @@
+Getting started
+---------------
+
+Requirements:
+
+- ``docker`` installed and running
+- ``Node.js`` >= 7.6 - ``async/await`` support
+
+1. Download repositories: gardener-server, gardener-smart-contracts
+::
+
+   git clone https://github.com/EspeoBlockchain/gardener-server.git
+   git clone https://github.com/EspeoBlockchain/gardener-smart-contracts.git
+
+
+2. Copy smart contracts variables from template
+::
+
+   cd gardener-smart-contracts
+   make copy-env
+
+3. Copy server variables from template
+::
+
+   cd ../gardener-server
+   make copy-env
+
+4. Run test blockchain
+::
+
+   make ganache
+   docker ps
+
+5. Install smart contracts dependencies
+::
+
+   cd ../gardener-smart-contracts
+   npm install
+
+6. Migrate contracts to test blockchain
+::
+
+   npx truffle migrate --network ganache --reset
+
+7. Run server
+::
+
+   cd ../gardener-server
+   make local
+
+8. Make example oracle request
+::
+
+   cd ../gardener-smart-contracts
+   npx truffle console --network ganache
+
+   truffle(ganache)> UsingOracle.deployed().then(instance => instance.request("json(https://api.coindesk.com/v1/bpi/currentprice.json).chartName"))
+
+If you did everything correctly you should see something simmilar to
+::
+
+   { tx: '0x57a34e45e1f187ddeb4cbd1be3597561855563e5735a483a5b1edeb73a511278',
+     receipt:
+      { transactionHash: '0x57a34e45e1f187ddeb4cbd1be3597561855563e5735a483a5b1edeb73a511278',
+        transactionIndex: 0,
+        blockHash: '0x212e264c92bef193e4531cc151d5b3b36818bc4bf82e154e84af6a7c6a153b43',
+        blockNumber: 18,
+        from: '0x90f8bf6a479f320ead074411a4b0e7944ea8c9c1',
+        to: '0x9561c133dd8580860b6b7e504bc5aa500f0f06a7',
+        gasUsed: 97604,
+        cumulativeGasUsed: 97604,
+        contractAddress: null,
+        logs: [ [Object], [Object] ],
+        status: '0x1',
+        logsBloom: '0x00040000000000000010000000000000000000000000000000000000000000000000000000000002000000000000010000000000000000000000000000000000000000000000040000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000004000000000000000000200000000000000000000000000000000000000000000000000000020400000005000000000000000000000000000000000000000000000000000000000000000000000',
+        v: '0x1b',
+        r: '0x21052fa282f9723d221ef288cec6e947cb2ba0ef3f1d470f5dc8845806f66977',
+        s: '0x1723cb7b4288f6ae32f3495d666522859150fe3d0c8e4debd3a80d452f940f50' },
+     logs:
+      [ { logIndex: 1,
+          transactionIndex: 0,
+          transactionHash: '0x57a34e45e1f187ddeb4cbd1be3597561855563e5735a483a5b1edeb73a511278',
+          blockHash: '0x212e264c92bef193e4531cc151d5b3b36818bc4bf82e154e84af6a7c6a153b43',
+          blockNumber: 18,
+          address: '0x9561c133dd8580860b6b7e504bc5aa500f0f06a7',
+          type: 'mined',
+          event: 'DataRequestedFromOracle',
+          args: [Object] } ] }
+
+
+9. Go to server container logs to check if response was sent.

docs/index.rst

@@ -0,0 +1,22 @@
+.. Gardener documentation master file, created by
+   sphinx-quickstart on Tue Jan 15 09:49:25 2019.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Gardener
+====================================
+This open source project solves the problem of getting knowledge from outside of the blockchain into smart contracts.
+
+Contents
+========
+
+:ref:`Keyword Index <genindex>`, :ref:`Search Page <search>`
+
+.. toctree::
+   :maxdepth: 2
+
+   getting-started
+
+Oracle theory
+-------------
+Oracle is a concept of getting information from outside of the blockchain to the smart contracts. Out of the box smart contracts cannot access anything outside of the blockchain network. That's where the oracle idea fits. The information exchange begins with the smart contract emitting an event describing the necessary information. A trusted off-chain server listening for such events parses it, gets data from a data source and passes it back to the smart contract.

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd