Merge pull request #12 from Remmeauth/r-v0.3.0-alpha

R v0.3.0 alpha

Author: eugene-babichenko

.circleci/config.yml

@@ -39,9 +39,7 @@ jobs:
           command: |
             docker login --username $DOCKER_USERNAME --password $DOCKER_PASSWORD && \
             docker tag remme/remme-core:latest remme/remme-core:$CIRCLE_TAG && \
-            docker tag remme/remme-core-dev:latest remme/remme-core-dev:$CIRCLE_TAG && \
-            docker push remme/remme-core && \
-            docker push remme/remme-core-dev
+            docker push remme/remme-core
 
 workflows:
   version: 2

.env

@@ -0,0 +1,19 @@
+# Total amount of tokens to be issued on a new REMME network.
+REMME_TOKEN_SUPPLY=10000000000000
+# Port for running Sphinx autobild
+REMME_DOCS_SERVER_PORT=8000
+# The port the REST API server will listen to.
+REMME_REST_API_PORT=8080
+# The port for communications between validators (blockchain protocol).
+REMME_VALIDATOR_PORT=8800
+# The real IP of the validator (required for validator discovery).
+REMME_VALIDATOR_IP=127.0.0.1
+# Peering mode: in `dynamic` mode validator connects to validators listed in
+# `REMME_SEEDS_LIST` and then starts to connect to other validators dynamically
+# building the network. In `static` mode validator connects only to validators
+# listed in `REMME_PEERS_LIST`.
+REMME_PEERING_MODE=dynamic
+# REMME_PEERS_LIST=tcp://hostname:port,tcp://hostname:port
+REMME_PEERS_LIST=
+# REMME_SEEDS_LIST=tcp://hostname:port,tcp://hostname:port
+REMME_SEEDS_LIST=

ISSUE_TEMPLATE.md renamed to .github/ISSUE_TEMPLATE.md

@@ -1,7 +1,11 @@
 **/__pycache__
-.idea/
+.idea/*
+!.idea/runConfigurations/
+!.idea/runConfigurations/*
 keys/
 *.pyc
 *.DS_Store
 remme/genesis/data
 remme/genesis/batch/token-proposal.batch
+docs/generated
+docs/README.rst

.gitignore

@@ -4,6 +4,22 @@ 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.3.0-alpha] - 2018-04-16
+### Added
+- REST API implementation based on OpenAPI specification and [Connexion](https://github.com/zalando/connexion).
+**NOTE**: this API is not suitable for public usage (use it only for clients on a local machine) for now and is a demo
+version. New version of API suitable for public use will be rolled out in the next release.
+  - Certificate handling: registration, revocation and status checks.
+  - Token handling: transfers and balance view.
+  - Key pairs management.
+- Sphinx-based documentation for source code and overall architecture.
+- Capable of running a network of masternodes with DevMode consensus. The next release will contain setup for running it
+ with [PoET (Proof of elapsed time)](https://sawtooth.hyperledger.org/docs/core/releases/1.0.1/architecture/poet.html).
+### Changed
+- Updated file hierarchy for Docker Compose.
+- All configuration was moved out to `.env` file.
+- No directories generated from Docker mounts. Now all mounts are done to named volumes.
+
 ## [0.2.1-alpha] - 2018-03-09
 ### Added
 - Enter parameters for certificate from CLI.
@@ -15,12 +31,16 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - A fixed amount of token is burnt on a certificate issuance.
 ### Changed
 - Transactions: unified data structures and transaction processors.
-- Faster startup in Docker containers for end users and separate Docker container for development purposes (instant source code updates).
+- Faster startup in Docker containers for end users and separate Docker container for development purposes (instant
+source code updates).
 ### Security
 - Reviewed and fixed security issues on token operations.
 
 ## [0.1.0-alpha] – 2018-02-22
 ### Added
-- The architecture and high-level logic of working with SSL / TLS certificates have been developed: issuing and revoked certificates on the REMME blockchain (REMchain) level;
-- The basic elements of the economy of the REM token have been integrated in the form of a mechanism for the token emission and the possibility of their transfer between users at the REMchain level;
-- A command-line interface (CLI) for convenient access to the core functionality (issuing and revoking certificates, transferring REM tokens between users) has been incorporated.
+- The architecture and high-level logic of working with SSL / TLS certificates have been developed: issuing and revoked
+certificates on the REMME blockchain (REMchain) level;
+- The basic elements of the economy of the REM token have been integrated in the form of a mechanism for the token
+emission and the possibility of their transfer between users at the REMchain level;
+- A command-line interface (CLI) for convenient access to the core functionality (issuing and revoking certificates,
+transferring REM tokens between users) has been incorporated.

.idea/runConfigurations/rest_api.xml

@@ -13,19 +13,16 @@
 # limitations under the License.
 # ------------------------------------------------------------------------
 
-FROM ubuntu:xenial AS development
+FROM ubuntu:xenial
 RUN apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys 8AA7AF1F1091A5FD && \
     echo "deb http://repo.sawtooth.me/ubuntu/1.0/stable xenial universe" >> /etc/apt/sources.list && \
     apt-get update && \
     apt-get install -y sawtooth && \
-    apt-get install -y python3-pip
+    apt-get install -y python3-pip && \
+    apt-get install -y libssl-dev
 WORKDIR /root
-COPY ./requirements.txt .
-RUN pip3 install -r ./requirements.txt
-
-FROM remme/remme-core-dev:latest AS production
-WORKDIR /root
-RUN mkdir remme
 COPY ./bash/.bashrc /root/.bashrc
+RUN mkdir remme
 COPY . ./remme
+RUN pip3 install -r ./remme/requirements.txt
 RUN pip3 install ./remme

.idea/runConfigurations/transaction_processor.xml

@@ -15,34 +15,35 @@
 
 PROTO_SRC_DIR = ./protos
 PROTO_DST_DIR = ./remme/protos
+RELEASE_NUMBER ?= $(shell git describe --abbrev=0 --tags)
 
-TOTAL_SUPPLY ?= 10000000000000
+include .env
 
-run:
-	docker-compose up
+.PHONY: release
 
-run_dev:
-	docker-compose -f docker-compose.dev.yml up
+run_dev_no_genesis:
+	docker-compose -f docker-compose.dev.yml -f docker-compose.run.yml up
 
-shell:
-	docker exec -it $(shell docker-compose ps -q shell) bash
+run_dev:
+	docker-compose -f docker-compose.dev.yml -f docker-compose.genesis.yml -f docker-compose.run.yml up
 
 test:
-	docker-compose -f docker-compose.test.yml up --abort-on-container-exit
-
-genesis:
-	docker-compose -f docker-compose.genesis.yml run -e REM_TOKEN_SUPPLY=$(TOTAL_SUPPLY) genesis
-
-reload_module:
-	pip3 install --upgrade /remme
+	docker-compose -f docker-compose.test.yml -f docker-compose.run-test.yml up --abort-on-container-exit
 
 build_protobuf:
 	protoc -I=$(PROTO_SRC_DIR) --python_out=$(PROTO_DST_DIR) $(PROTO_SRC_DIR)/*.proto
 
 build_docker:
-	docker build --target development --tag remme/remme-core-dev:latest .
-	docker build --target production --tag remme/remme-core:latest .
+	docker-compose -f docker-compose.dev.yml build
 
 rebuild_docker:
-	docker build --target development --tag remme/remme-core-dev:latest --no-cache .
-	docker build --target production --tag remme/remme-core:latest --no-cache .
+	docker-compose -f docker-compose.dev.yml build --no-cache
+
+release:
+	mkdir $(RELEASE_NUMBER)-release
+	cp {run,genesis}.sh ./$(RELEASE_NUMBER)-release
+	cp docker-compose.{dev,run,genesis}.yml ./$(RELEASE_NUMBER)-release
+	cp .env ./$(RELEASE_NUMBER)-release
+	find ./$(RELEASE_NUMBER)-release -type f -name "docker-compose.{dev,run,genesis}.yml" | xargs sed -i "/.*build: \..*/d"
+	zip -r $(RELEASE_NUMBER)-release.zip $(RELEASE_NUMBER)-release
+	rm -rf $(RELEASE_NUMBER)-release

.idea/runConfigurations/unittests.xml

@@ -0,0 +1,49 @@
+REMME Core
+==========
+
+|CircleCI| |Docker Stars|
+
+**This is an alpha version! It is not suitable for any use in production
+and is intended to demonstrate capabilities of Hyperledger Sawtooth in
+the scope of REMME.**
+
+How to run
+----------
+
+You will need Docker and Docker Compose installed on your machine.
+
+For an end-user
+~~~~~~~~~~~~~~~
+
+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/ui. The API port can be changed in `.env`
+file.
+
+On the first run you will need to initialize the genesis block. To make
+that just run ``./genesis.sh``. This will generate a new key pair and
+genesis block.
+
+For developers & contributors
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Clone this repository to your machine:
+``git clone https://github.com/Remmeauth/remme-core.git``
+
+When you have this repository cloned go the project directory run the
+following commands:
+
+-  ``make build_docker``
+-  ``make run_dev``
+
+You can run ``make test`` to run automated tests.
+
+.. _Releases: https://github.com/Remmeauth/remme-core/releases
+
+.. |CircleCI| image:: https://img.shields.io/circleci/project/github/Remmeauth/remme-core.svg
+   :target: https://circleci.com/gh/Remmeauth/remme-core
+.. |Docker Stars| image:: https://img.shields.io/docker/stars/remme/remme-core.svg
+   :target: https://hub.docker.com/r/remme/remme-core/

CHANGELOG.md

@@ -0,0 +1,25 @@
+# Copyright 2018 REMME
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# ------------------------------------------------------------------------
+
+version: '2.1'
+
+services:
+  remme-tp:
+    entrypoint: python3 -m remme tcp://validator:4004
+
+  remme-rest-api:
+    depends_on:
+      - rest-api
+      - remme-tp

Dockerfile

@@ -0,0 +1,24 @@
+# Copyright 2018 REMME
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# ------------------------------------------------------------------------
+
+version: '2.1'
+
+services:
+  remme-tp:
+    depends_on:
+      - remme-rest-api
+
+  remme-rest-api:
+    entrypoint: python3 -m remme.rest_api