Merge pull request #102 from Remmeauth/r-0.5.1-alpha

R 0.5.1 alpha

Author: eugene-babichenko

.github/PULL_REQUEST_TEMPLATE.md

@@ -6,3 +6,18 @@ Changes introduced in this pull request:
 -
 -
 -
+
+Linked repositories checklist:
+- remme-protobuf. Protocol buffer definitions used throughout the project.
+- remme-client-js. JS integration library.
+- remme-client-dotnet. .NET integration library.
+
+If this pull request contains changes that affect ANY of those repositories, e.g.:
+
+- Contains changes to Protocol Buffers files that should be merged;
+- Contains changes into transaction structure and/or inputs and outputs of
+  transactions
+
+this should be reported to the maintainers of corresponding repositories and this PR
+SHOULD NOT be merged until the maintainers confirm they can comply with those changes.
+

CHANGELOG.md

@@ -4,6 +4,15 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [0.5.1-alpha] - 2018-09-13
+### Changes
+- Batches submitted from REST API are now signed by the key of the validator (the same as the key for
+  block signing). This is required for compatibility with the upcoming update of Sawtooth which will
+  remove performance limitations for batches submitted with the validator key.
+- Versions of critical non-Python dependencies are now fixed.
+### Fixed
+- A couple of minor bugs in BlockInfo component.
+
 ## [0.5.0-alpha] - 2018-08-24
 ### Added
 - Access to additional blocks metadata (e.g. time) via REST API (with the help of Sawtooth BlockInfo transaction

Dockerfile

@@ -13,13 +13,15 @@
 # limitations under the License.
 # ------------------------------------------------------------------------
 
-# TODO check if it works with a newer version of Debian
-FROM alpine:edge as build
-WORKDIR /root
-RUN apk --update --no-cache add rsync pkgconf build-base autoconf automake python3 protobuf libtool libffi-dev python3-dev zeromq-dev openssl-dev
-RUN pip3 install --upgrade pip
+FROM alpine:3.8 as base
+RUN apk --update --no-cache add --force python3=3.6.6-r0 libffi=3.2.1-r4 openssl=1.0.2o-r2 libzmq=4.2.3-r0
 RUN mkdir /install
 ENV PYTHONUSERBASE=/install
+WORKDIR /root
+
+FROM base as build
+RUN apk --update --no-cache add rsync pkgconf build-base autoconf automake protobuf=3.5.2-r0 libtool=2.4.6-r5 libffi-dev=3.2.1-r4 python3-dev=3.6.6-r0 zeromq-dev=4.2.3-r0 openssl-dev=1.0.2o-r2
+RUN pip3 install --upgrade pip
 COPY ./requirements.txt .
 RUN pip3 install --user -r ./requirements.txt
 COPY ./remme/rest_api/swagger-index.patch .
@@ -33,13 +35,10 @@ RUN protoc -I=./remme/protos --python_out=./remme/remme/protos ./remme/protos/*.
 COPY ./setup.py ./remme
 RUN pip3 install --user ./remme
 COPY ./tests ./tests
-COPY ./bash /scripts
+COPY ./bash /install/scripts/
 
-FROM alpine:edge as release
-RUN apk --update --no-cache add --force python3 libffi openssl libzmq
+FROM base as release
 COPY --from=build /install /install
-ENV PYTHONUSERBASE=/install
-COPY ./bash /scripts
 
 FROM hyperledger/sawtooth-validator:1.0.5 as validator
 COPY ./bash /scripts

Makefile

@@ -34,7 +34,7 @@ run_dev: build
 	docker-compose -f docker-compose/base.yml -f docker-compose/genesis.yml --project-name remme up
 
 run_docs:
-	docker-compose -f docker-compose/docs.yml up --build
+	sphinx-build -b html docs html
 
 test:
 	docker build --target build -t remme/remme-core-dev:latest .

bash/genesis.sh

@@ -1,9 +1,6 @@
 if [ "$REMME_START_MODE" = "genesis" ]; then
-    if [ ! -f /root/.sawtooth/keys/key.priv ]; then
-        sawtooth keygen key
-    fi
     if [ ! -e /genesis/batch ]; then
         mkdir /genesis/batch
     fi
     python3 -m remme.genesis
-fi
+fi

docker-compose/base.yml

@@ -20,7 +20,7 @@ services:
     container_name: remme_validator
     image: remme/sawtooth-validator:1.0.5
     volumes:
-      - validator_keys:/etc/sawtooth/keys
+      - user_keys:/etc/sawtooth/keys
       - chain_data:/var/lib/sawtooth/
       - ../config/remme-genesis-config.toml:/config/remme-genesis-config.toml
       - ../config/sawtooth-validator-config.toml:/etc/sawtooth/validator.toml
@@ -74,13 +74,12 @@ services:
     image: remme/remme-core:latest
     network_mode: "service:validator"
     volumes:
-      - user_keys:/root/.sawtooth/keys
+      - user_keys:/etc/sawtooth/keys
       - ${REMME_CONTAINER_EXPORTS_FOLDER:-./default_export}:/root/usr/share
       - ../config/remme-client-config.toml:/config/remme-client-config.toml
       - ../config/remme-rest-api.toml:/config/remme-rest-api.toml
     entrypoint: python3 -m remme.rest_api
 
 volumes:
   user_keys:
-  validator_keys:
   chain_data:

docker-compose/docs.yml

@@ -21,21 +21,20 @@ services:
       - remme-genesis
     volumes:
       - genesis_data:/genesis/batch
-      - user_keys:/root/.sawtooth/keys
     environment:
       - REMME_START_MODE=genesis
 
   remme-genesis:
     container_name: remme_genesis
     image: remme/remme-core:latest
     volumes:
-      - user_keys:/root/.sawtooth/keys
+      - user_keys:/etc/sawtooth/keys
       - genesis_data:/genesis/batch
       - ../config/remme-client-config.toml:/config/remme-client-config.toml
       - ../config/remme-genesis-config.toml:/config/remme-genesis-config.toml
     environment:
       - REMME_START_MODE=genesis
-    command: sh /scripts/genesis.sh
+    command: sh /install/scripts/genesis.sh
 
 volumes:
   genesis_data:

docker-compose/genesis.yml

@@ -8,7 +8,14 @@ Welcome to REMME's documentation!
 .. toctree::
    :maxdepth: 2
 
-   README
+   remme-launch
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Use cases:
+
+   use-case-web-auth
+
 
 .. toctree::
    :maxdepth: 2
@@ -19,6 +26,7 @@ Welcome to REMME's documentation!
    remme-framework
    remme-client
    remme-ws
+   remme-ws-events
    generated/modules
 
 .. toctree::

docs/img/web-auth/remme-blockchain-explorer-recent.png

@@ -0,0 +1,44 @@
+************
+Introduction
+************
+
+Overview
+========
+
+REMchain - a multi-purpose blockchain service allowing one to store certificate's hash and other important data for verification purposes.
+
+REMME uses python framework Sawtooth by Hyperledger to develop business logic on top of it. A custom consensus is planned to be implemented using Rust language.
+The node at its services are wrapped in **Docker containers** and may be run in "one-click".
+
+In order to interact with the node, JS client is provided that uses ES6 standard.
+
+How to run Production version
+=============================
+
+1. Download the latest release from Releases section (<version_number>-release.zip). Unpack it.
+
+2. Start node: Open a terminal inside the unpacked folder and run ./run.sh.
+
+3. You can now use our REST API. By default, it is started on http://localhost:8080. Fancy Swagger UI with documentation is available on http://localhost:8080/api/v1/ui. The API port can be changed in config/network-config.env file.
+
+How to run Development version
+==============================
+
+1. Clone this repository to your machine: git clone https://github.com/Remmeauth/remme-core.git
+
+2. This project uses git submodules. To initialize them run `git submodule init` and then `git submodule update --init`. Also, git submodule update is required after every pull from the repository.
+
+3. Run `make run_dev`.
+
+Technical Requirement
+=====================
+
+* Docker (>= 18.0.0)
+
+* Unix system (MacOS, Linux etc.)
+
+* At least 2GB hard drive storage available
+
+* At least 1GB RAM
+
+* Machine's time settings are up to date