Skip to content

Commit d52a11a

Browse files
committed
erc20-rest-service starter
1 parent 509a885 commit d52a11a

30 files changed

Lines changed: 2149 additions & 0 deletions
Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
# ERC-20 RESTful service
2+
3+
This application provides a RESTful service for creating and managing
4+
[ERC-20 tokens](https://github.com/ethereum/EIPs/issues/20).
5+
It has been built using [Spring Boot](https://projects.spring.io/spring-boot/), and
6+
[web3j](https://web3j.io).
7+
8+
It works with both [Geth](https://github.com/ethereum/go-ethereum),
9+
[Parity](https://github.com/paritytech/parity), and
10+
[Quorum](https://github.com/jpmorganchase/quorum).
11+
12+
For Quorum, the RESTful semantics are identical, with the exception that if you wish to create
13+
a private transaction, you populate a HTTP header name *privateFor* with a comma-separated
14+
list of public keys
15+
16+
17+
## Build
18+
19+
To build a runnable jar file:
20+
21+
```bash
22+
./gradlew clean build
23+
```
24+
25+
## Run
26+
27+
Using Java 1.8+:
28+
29+
```bash
30+
java -jar build/libs/azure-demo-0.1.jar
31+
```
32+
33+
By default the application will log to a file named erc20-web3j.log.
34+
35+
36+
## Configuration
37+
38+
The following default properties are used in the application:
39+
40+
```properties
41+
# Port for service to bind to
42+
port=8080
43+
# Log file path and name
44+
logging.file=logs/erc20-rest-service.log
45+
46+
# Endpoint of an Ethereum or Quorum node we wish to use.
47+
# To use IPC simply provide a file path to the socket, such as /path/to/geth.ipc
48+
nodeEndpoint=http://localhost:22000
49+
# The Ethereum or Quorum address we wish to use when transacting.
50+
# Note - this address must be already unlocked in the client
51+
fromAddress=0xed9d02e382b34818e88b88a309c7fe71e65f419d
52+
```
53+
54+
You can override any of these properties by creating a file name
55+
*application.properties* in the root directory of your application, or in
56+
*config/application.properties* relative to your root. If you'd rather use yaml,
57+
simply change the filename to *application.yml*.
58+
59+
60+
## Usage
61+
62+
All available application endpoints are documented using [Swagger](http://swagger.io/).
63+
64+
You can view the Swagger UI at http://localhost:8080/swagger-ui.html. From here you
65+
can perform all POST and GET requests easily to facilitate deployment of, transacting
66+
with, and querying state of ERC-20 tokens.
67+
68+
![alt text](https://github.com/blk-io/erc20-rest-service/raw/master/images/full-swagger-ui.png "Swagger UI screen capture")
69+
70+
71+
## Docker
72+
73+
We can use [Docker](https://www.docker.com/) to easily spin up a arbritrary instance
74+
of our service connecting to an already running Ethereum or Quorum network.
75+
76+
All you need to do is build the Dockerfile:
77+
78+
```docker
79+
docker build -f docker/Dockerfile -t blk-io/erc20-service .
80+
```
81+
82+
Then either run it with default configuration:
83+
```docker
84+
docker run -p 8080:8080 -v "$PWD/logs":/logs blk-io/erc20-service
85+
```
86+
87+
Or with a custom configuration:
88+
89+
```docker
90+
export PORT=8081
91+
docker run -p ${PORT}:${PORT} -v "$PWD/logs":/logs \
92+
-e ENDPOINT="http://localhost:22001" \
93+
-e FROMADDR="0xca843569e3427144cead5e4d5999a3d0ccf92b8e" \
94+
-e PORT="$PORT" \
95+
blk-io/erc20-service
96+
```
Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
plugins {
2+
id 'java'
3+
id 'idea'
4+
id 'eclipse'
5+
id 'application'
6+
id 'org.springframework.boot' version '2.1.7.RELEASE'
7+
}
8+
9+
mainClassName = 'io.blk.erc20.Application'
10+
11+
group 'io.blk'
12+
version '0.1.0'
13+
14+
sourceCompatibility = 1.8
15+
16+
repositories {
17+
mavenCentral()
18+
}
19+
20+
dependencies {
21+
compile 'org.springframework.boot:spring-boot-starter-web:2.1.7.RELEASE',
22+
'io.springfox:springfox-swagger2:2.7.0',
23+
'io.springfox:springfox-swagger-ui:2.7.0',
24+
'org.projectlombok:lombok:1.16.16',
25+
'org.web3j:quorum:4.+',
26+
'org.web3j:core:4.+',
27+
'io.reactivex.rxjava2:rxjava:2.2.0',
28+
'com.fasterxml.jackson:jackson-bom:2.9.4',
29+
'org.apache.httpcomponents:httpclient:4.5.3'
30+
31+
testCompile 'junit:junit:4.12',
32+
'org.springframework.boot:spring-boot-starter-test:2.1.7.RELEASE',
33+
34+
35+
implementation("org.web3j:contracts:4.2.0") { exclude group: 'org.web3j' }
36+
}
37+
38+
run {
39+
/* Can pass all the properties: */
40+
systemProperties System.getProperties()
41+
42+
/* Or just each by name: */
43+
systemProperty "nodeEndpoint", System.getProperty("nodeEndpoint")
44+
systemProperty "fromAddress", System.getProperty("fromAddress")
45+
46+
/* Need to split the space-delimited value in the exec.args */
47+
args System.getProperty("exec.args", "").split()
48+
}
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
FROM frolvlad/alpine-java
2+
3+
RUN apk update && apk upgrade && \
4+
apk add --no-cache bash git openssh
5+
6+
RUN mkdir -p /app/erc20-rest-service
7+
RUN git clone https://github.com/blk-io/erc20-rest-service.git
8+
9+
# We exclude running tests as we need a Ethereum/Quorum network to be running
10+
RUN cd erc20-rest-service \
11+
&& ./gradlew build -x test \
12+
&& cp build/libs/erc20-rest-service-0.1.0.jar /app/erc20-rest-service
13+
14+
ENV PORT=8080
15+
ENV ENDPOINT="http://localhost:22000"
16+
ENV FROMADDR="0xed9d02e382b34818e88b88a309c7fe71e65f419d"
17+
18+
ENTRYPOINT ["/usr/bin/java"]
19+
# We can define an environment variable to interpolate these values, as Docker does not support
20+
# this functionality, hence we have to do it in the command.
21+
CMD ["-jar", "/app/erc20-rest-service/erc20-rest-service-0.1.0.jar", \
22+
"--spring.application.json={\"nodeEndpoint\":\"${ENDPOINT}\",\"fromAddress\":\"${FROMADDR}\"}"]
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
#!/usr/bin/env bash
2+
3+
cd src/main/resources/solidity/contract/ && \
4+
solc --bin --abi --optimize --overwrite HumanStandardToken.sol -o build/ && \
5+
web3j solidity generate \
6+
--binFile build/HumanStandardToken.bin \
7+
--abiFile build/HumanStandardToken.abi \
8+
-p io.blk.erc20.generated \
9+
-o ../../../java/
Binary file not shown.
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
#Mon Nov 18 15:02:41 GMT 2019
2+
distributionUrl=https\://services.gradle.org/distributions/gradle-5.1.1-all.zip
3+
distributionBase=GRADLE_USER_HOME
4+
distributionPath=wrapper/dists
5+
zipStorePath=wrapper/dists
6+
zipStoreBase=GRADLE_USER_HOME

jdk_8_gradle/cs/rest/erc20-rest-service/gradlew

Lines changed: 188 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)