Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
96 changes: 96 additions & 0 deletions jdk_8_gradle/cs/rest/erc20-rest-service/README.md
Original file line number Diff line number Diff line change
@@ -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
```
48 changes: 48 additions & 0 deletions jdk_8_gradle/cs/rest/erc20-rest-service/build.gradle
Original file line number Diff line number Diff line change
@@ -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()
}
22 changes: 22 additions & 0 deletions jdk_8_gradle/cs/rest/erc20-rest-service/docker/Dockerfile
Original file line number Diff line number Diff line change
@@ -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}\"}"]
9 changes: 9 additions & 0 deletions jdk_8_gradle/cs/rest/erc20-rest-service/generate.sh
Original file line number Diff line number Diff line change
@@ -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/
Binary file not shown.
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
#Mon Nov 18 15:02:41 GMT 2019
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

gradle is quite messy for multi-module projects.
see how done in other gradle modules for 11 and 17.
we put a single wrapper outside cs

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
188 changes: 188 additions & 0 deletions jdk_8_gradle/cs/rest/erc20-rest-service/gradlew
Original file line number Diff line number Diff line change
@@ -0,0 +1,188 @@
#!/usr/bin/env sh

#
# Copyright 2015 the original author or authors.
#
# 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
#
# https://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.
#

##############################################################################
##
## Gradle start up script for UN*X
##
##############################################################################

# Attempt to set APP_HOME
# Resolve links: $0 may be a link
PRG="$0"
# Need this for relative symlinks.
while [ -h "$PRG" ] ; do
ls=`ls -ld "$PRG"`
link=`expr "$ls" : '.*-> \(.*\)$'`
if expr "$link" : '/.*' > /dev/null; then
PRG="$link"
else
PRG=`dirname "$PRG"`"/$link"
fi
done
SAVED="`pwd`"
cd "`dirname \"$PRG\"`/" >/dev/null
APP_HOME="`pwd -P`"
cd "$SAVED" >/dev/null

APP_NAME="Gradle"
APP_BASE_NAME=`basename "$0"`

# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'

# Use the maximum available, or set MAX_FD != -1 to use that value.
MAX_FD="maximum"

warn () {
echo "$*"
}

die () {
echo
echo "$*"
echo
exit 1
}

# OS specific support (must be 'true' or 'false').
cygwin=false
msys=false
darwin=false
nonstop=false
case "`uname`" in
CYGWIN* )
cygwin=true
;;
Darwin* )
darwin=true
;;
MINGW* )
msys=true
;;
NONSTOP* )
nonstop=true
;;
esac

CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar

# Determine the Java command to use to start the JVM.
if [ -n "$JAVA_HOME" ] ; then
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
# IBM's JDK on AIX uses strange locations for the executables
JAVACMD="$JAVA_HOME/jre/sh/java"
else
JAVACMD="$JAVA_HOME/bin/java"
fi
if [ ! -x "$JAVACMD" ] ; then
die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME

Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
fi
else
JAVACMD="java"
which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.

Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
fi

# Increase the maximum file descriptors if we can.
if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
MAX_FD_LIMIT=`ulimit -H -n`
if [ $? -eq 0 ] ; then
if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
MAX_FD="$MAX_FD_LIMIT"
fi
ulimit -n $MAX_FD
if [ $? -ne 0 ] ; then
warn "Could not set maximum file descriptor limit: $MAX_FD"
fi
else
warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
fi
fi

# For Darwin, add options to specify how the application appears in the dock
if $darwin; then
GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
fi

# For Cygwin or MSYS, switch paths to Windows format before running java
if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then
APP_HOME=`cygpath --path --mixed "$APP_HOME"`
CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
JAVACMD=`cygpath --unix "$JAVACMD"`

# We build the pattern for arguments to be converted via cygpath
ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
SEP=""
for dir in $ROOTDIRSRAW ; do
ROOTDIRS="$ROOTDIRS$SEP$dir"
SEP="|"
done
OURCYGPATTERN="(^($ROOTDIRS))"
# Add a user-defined pattern to the cygpath arguments
if [ "$GRADLE_CYGPATTERN" != "" ] ; then
OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
fi
# Now convert the arguments - kludge to limit ourselves to /bin/sh
i=0
for arg in "$@" ; do
CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option

if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
else
eval `echo args$i`="\"$arg\""
fi
i=$((i+1))
done
case $i in
(0) set -- ;;
(1) set -- "$args0" ;;
(2) set -- "$args0" "$args1" ;;
(3) set -- "$args0" "$args1" "$args2" ;;
(4) set -- "$args0" "$args1" "$args2" "$args3" ;;
(5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
(6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
(7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
(8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
(9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
esac
fi

# Escape application args
save () {
for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
echo " "
}
APP_ARGS=$(save "$@")

# Collect all arguments for the java command, following the shell quoting and substitution rules
eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"

# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong
if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then
cd "$(dirname "$0")"
fi

exec "$JAVACMD" "$@"
Loading