Merge pull request #133 from WebFuzzing/erc20-rest-service-starter

erc20-rest-service starter

Author: arcuri82

jdk_8_gradle/cs/rest/erc20-rest-service/README.md

@@ -0,0 +1,96 @@
+# ERC-20 RESTful service
+
+This application provides a RESTful service for creating and managing 
+[ERC-20 tokens](https://github.com/ethereum/EIPs/issues/20). 
+It has been built using [Spring Boot](https://projects.spring.io/spring-boot/), and 
+[web3j](https://web3j.io).
+
+It works with both [Geth](https://github.com/ethereum/go-ethereum), 
+[Parity](https://github.com/paritytech/parity), and 
+[Quorum](https://github.com/jpmorganchase/quorum).
+
+For Quorum, the RESTful semantics are identical, with the exception that if you wish to create 
+a private transaction, you populate a HTTP header name *privateFor* with a comma-separated
+list of public keys
+
+
+## Build
+
+To build a runnable jar file:
+
+```bash
+./gradlew clean build
+```
+
+## Run
+
+Using Java 1.8+:
+
+```bash
+java -jar build/libs/azure-demo-0.1.jar 
+```
+
+By default the application will log to a file named erc20-web3j.log. 
+
+
+## Configuration
+
+The following default properties are used in the application:
+
+```properties
+# Port for service to bind to
+port=8080
+# Log file path and name
+logging.file=logs/erc20-rest-service.log
+
+# Endpoint of an Ethereum or Quorum node we wish to use. 
+# To use IPC simply provide a file path to the socket, such as /path/to/geth.ipc
+nodeEndpoint=http://localhost:22000
+# The Ethereum or Quorum address we wish to use when transacting.
+# Note - this address must be already unlocked in the client
+fromAddress=0xed9d02e382b34818e88b88a309c7fe71e65f419d
+```
+
+You can override any of these properties by creating a file name 
+*application.properties* in the root directory of your application, or in 
+*config/application.properties* relative to your root. If you'd rather use yaml, 
+simply change the filename to *application.yml*.
+
+
+## Usage
+
+All available application endpoints are documented using [Swagger](http://swagger.io/).
+
+You can view the Swagger UI at http://localhost:8080/swagger-ui.html. From here you
+can perform all POST and GET requests easily to facilitate deployment of, transacting 
+with, and querying state of ERC-20 tokens.
+
+![alt text](https://github.com/blk-io/erc20-rest-service/raw/master/images/full-swagger-ui.png "Swagger UI screen capture")
+
+
+## Docker
+
+We can use [Docker](https://www.docker.com/) to easily spin up a arbritrary instance 
+of our service connecting to an already running Ethereum or Quorum network.
+
+All you need to do is build the Dockerfile:
+
+```docker
+docker build -f docker/Dockerfile -t blk-io/erc20-service .
+```
+
+Then either run it with default configuration:
+```docker
+docker run -p 8080:8080 -v "$PWD/logs":/logs blk-io/erc20-service
+```
+ 
+Or with a custom configuration:
+
+```docker
+export PORT=8081
+docker run -p ${PORT}:${PORT} -v "$PWD/logs":/logs \
+    -e ENDPOINT="http://localhost:22001" \
+    -e FROMADDR="0xca843569e3427144cead5e4d5999a3d0ccf92b8e" \
+    -e PORT="$PORT" \
+    blk-io/erc20-service
+```

jdk_8_gradle/cs/rest/erc20-rest-service/build.gradle

@@ -0,0 +1,48 @@
+plugins {
+    id 'java'
+    id 'idea'
+    id 'eclipse'
+    id 'application'
+    id 'org.springframework.boot' version '2.1.7.RELEASE'
+}
+
+mainClassName = 'io.blk.erc20.Application'
+
+group 'io.blk'
+version '0.1.0'
+
+sourceCompatibility = 1.8
+
+repositories {
+    mavenCentral()
+}
+
+dependencies {
+    compile 'org.springframework.boot:spring-boot-starter-web:2.1.7.RELEASE',
+            'io.springfox:springfox-swagger2:2.7.0',
+            'io.springfox:springfox-swagger-ui:2.7.0',
+            'org.projectlombok:lombok:1.16.16',
+            'org.web3j:quorum:4.+',
+            'org.web3j:core:4.+',
+            'io.reactivex.rxjava2:rxjava:2.2.0',
+            'com.fasterxml.jackson:jackson-bom:2.9.4',
+            'org.apache.httpcomponents:httpclient:4.5.3'
+
+    testCompile 'junit:junit:4.12',
+            'org.springframework.boot:spring-boot-starter-test:2.1.7.RELEASE',
+
+
+            implementation("org.web3j:contracts:4.2.0") { exclude group: 'org.web3j' }
+}
+
+run {
+    /* Can pass all the properties: */
+    systemProperties System.getProperties()
+
+    /* Or just each by name: */
+    systemProperty "nodeEndpoint", System.getProperty("nodeEndpoint")
+    systemProperty "fromAddress", System.getProperty("fromAddress")
+
+    /* Need to split the space-delimited value in the exec.args */
+    args System.getProperty("exec.args", "").split()
+}

jdk_8_gradle/cs/rest/erc20-rest-service/docker/Dockerfile

@@ -0,0 +1,22 @@
+FROM frolvlad/alpine-java
+
+RUN apk update && apk upgrade && \
+    apk add --no-cache bash git openssh
+
+RUN mkdir -p /app/erc20-rest-service
+RUN git clone https://github.com/blk-io/erc20-rest-service.git
+
+# We exclude running tests as we need a Ethereum/Quorum network to be running
+RUN cd erc20-rest-service \
+  && ./gradlew build -x test \
+  && cp build/libs/erc20-rest-service-0.1.0.jar /app/erc20-rest-service
+
+ENV PORT=8080
+ENV ENDPOINT="http://localhost:22000"
+ENV FROMADDR="0xed9d02e382b34818e88b88a309c7fe71e65f419d"
+
+ENTRYPOINT ["/usr/bin/java"]
+# We can define an environment variable to interpolate these values, as Docker does not support
+# this functionality, hence we have to do it in the command.
+CMD ["-jar", "/app/erc20-rest-service/erc20-rest-service-0.1.0.jar", \
+  "--spring.application.json={\"nodeEndpoint\":\"${ENDPOINT}\",\"fromAddress\":\"${FROMADDR}\"}"]

jdk_8_gradle/cs/rest/erc20-rest-service/generate.sh

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+
+cd src/main/resources/solidity/contract/ && \
+    solc --bin --abi --optimize --overwrite HumanStandardToken.sol -o build/ && \
+    web3j solidity generate \
+        --binFile build/HumanStandardToken.bin \
+        --abiFile build/HumanStandardToken.abi \
+        -p io.blk.erc20.generated \
+        -o ../../../java/

jdk_8_gradle/cs/rest/erc20-rest-service/gradle/wrapper/gradle-wrapper.jar

@@ -0,0 +1,6 @@
+#Mon Nov 18 15:02:41 GMT 2019
+distributionUrl=https\://services.gradle.org/distributions/gradle-5.1.1-all.zip
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+zipStorePath=wrapper/dists
+zipStoreBase=GRADLE_USER_HOME