Merge branch 'release-v1.5.5'

iotaledger · Oct 11, 2018 · 2990518 · 2990518
2 parents dd8178a + 7ba1e33
commit 2990518
Show file tree

Hide file tree

Showing 91 changed files with 3,277 additions and 1,218 deletions.
diff --git a/.github/issue_template.md b/.github/issue_template.md
@@ -1,8 +1,8 @@
 <!--- Remove text and sections that do not apply -->
 
-The issue tracker is only for reporting bugs or asking for feature requests and bugs.
-If you need technical assistance for running a node please consult the #fullnode channel on discord (https://discord.gg/jrxApWC) or https://forum.helloiota.com/Technology/Help.
-If you have general questions on IOTA you can go to https://iota.stackexchange.com/, or https://helloiota.com/, or browse discord channels (https://discord.gg/C88Wexg).
+The issue tracker is only for reporting bugs or submitting feature requests.
+If you need technical assistance for running a node please consult the #fullnode channel on Discord (https://discord.gg/jrxApWC) or https://forum.helloiota.com/Technology/Help.
+If you have general questions on IOTA you can go to https://iota.stackexchange.com/, https://helloiota.com/, or browse Discord channels (https://discord.gg/C88Wexg).
 
 
 <!----Format For Reporting Bugs------->
@@ -20,7 +20,7 @@ On what hardware is the node running on?
 ### Expected behaviour
 What should happen.
 
-### Actual behavior
+### Actual behaviour
 What really happened.
 
 ### Errors

diff --git a/.gitignore b/.gitignore
@@ -4,6 +4,9 @@
 /.settings
 /tomcat.*
 /.idea
+/bin
+/mainnetdb
+/mainnet.log
 /*.iml
 .classpath
 .project
@@ -14,6 +17,7 @@ target/*
 src/main/ixi/
 dependency-reduced-pom.xml
 
+
 # Created by https://www.gitignore.io/api/osx,linux,windows
 
 ### Linux ###

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,35 @@
+## How to contribute to IRI
+
+#### **Did you find a bug?**
+
+* **Do not open a GitHub issue if the bug is a security vulnerability
+  in IRI**, and instead, please contact us via [[email protected]](mailto:[email protected]).
+
+* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/iotaledger/iri/issues). You can also look up related issues by a label. For example, if your issue is database-related, filter based on the `C-DB` label and look for related issues. If it's API related, use `C-API` and so on. `C` stands for component. Make sure you skim through the labels to find your category. 
+
+* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/iotaledger/iri/issues/new). Be sure to include a **title and clear description**, and as much relevant information as possible. Make sure you follow our new issue template. The first part of the issue template is dedicated to reporting bugs, delete the second part. Steps to reproduce are particularly important. Add any relevant log output and screenshots. The easier it will be to reproduce your issue, the more likely it's getting fixed. 
+
+#### **Did you write a patch that fixes a bug?**
+
+* [New issues](https://github.com/iotaledger/iri/issues/new) should be used for reporting issues. If you already wrote a patch for an issue that you or someone else reported, make sure you link it to the open issue. You can do this by mentioning the issue number in the comment or description on the PR, for example `#123` to link issue "123". 
+
+* Ensure the PR description clearly describes the problem and solution. Very large PRs are difficult to review and test. This makes them less likely to be merged. If possible, split the PR into multiple PRs, each addressing a specific concern or scenario. Only make the code changes necessary to address the actual issue.
+
+#### **Do you intend to add a new feature or change an existing one?**
+
+* Suggest your change as a [new issues](https://github.com/iotaledger/iri/issues/new). Use the second part of the issue template, dedicated to new feature requests and delete the first part. If you plan on implementing the change yourself, start writing the code and submit a PR. Note that the fact that the feature is "code ready" doesn't mean it will get merged. It is advisable to gather feedback for the change first. You are encouraged to start and drive a discussion on [Discord](https://discordapp.com/invite/fNGZXvh). The IRI team also monitors the repo and will provide feedback where relevant. 
+
+
+#### **Do you have questions about the functioning of IRI nodes, the network or anything IOTA related?**
+
+* Use our [Discord](https://discordapp.com/invite/fNGZXvh) to join the discussion and ask questions.
+
+#### **Do you want to contribute to the IRI documentation?**
+
+The IOTA documentation is based in the [docs](https://github.com/iotaledger/docs) repo. You are welcome to contribute. Make sure you follow the instructions on adding new docs. 
+
+Thanks! :heart: :heart: :heart:
+
+The contribution guidelines are inspired by the Ruby on Rails contribution guidelines. 
+
+IRI Team
diff --git a/DOCKER.md b/DOCKER.md
@@ -2,13 +2,13 @@
 
 Run the official iotaledger/iri container, passing the mandatory -p option:
 
-```docker run iotaledger/iri:v1.5.4 -p 14265```
+```docker run iotaledger/iri:v1.5.5 -p 14265```
 
 This will get your a running IRI with its API listening on port 14265, no neighbours and an empty database. The IRI Docker container by default expects data at /iri/data. Use the `-v` option of the `docker run` command to mount volumes so to have persistent data. You can also pass more command line options to the docker run command and those will be passed to IRI.
 
 If you want to use a iri.ini file with the docker container, supposing it's stored under /path/to/conf/iri.ini on your docker host, then pass `-v /path/to/conf:/iri/conf` and add -c /iri/conf/iri.ini as docker run arguments. So for example the `docker run` command above would become:
 
-```docker run -v /path/to/conf:/iri/conf -v /path/to/data:/iri/data iotaledger/iri:v1.5.4 -p 14265 -c /iri/conf/iri.ini```
+```docker run -v /path/to/conf:/iri/conf -v /path/to/data:/iri/data iotaledger/iri:v1.5.5 -p 14265 -c /iri/conf/iri.ini```
 
 Please refer to the IRI documentation for further command line options and iri.ini options.
 
@@ -61,7 +61,7 @@ ExecStart=/usr/bin/docker run \
 -p 14265:14265 \
 -p 15600:15600 \
 -p 14600:14600/udp  \
-iotaledger/iri:v1.5.4 \
+iotaledger/iri:v1.5.5 \
 -p 14265 \
 --zmq-enabled \
 --testnet

diff --git a/Dockerfile b/Dockerfile
@@ -1,59 +1,13 @@
-FROM ubuntu:18.04 as local_stage_java
+FROM iotacafe/maven:3.5.4.oracle8u181.1.webupd8.1.1-1 as local_stage_build
 MAINTAINER [email protected]
 
-# Install Java
-ARG JAVA_VERSION=8u181-1
-RUN \
-  apt-get update && \
-  apt-get install -y software-properties-common --no-install-recommends && \
-  echo oracle-java8-installer shared/accepted-oracle-license-v1-1 select true | debconf-set-selections && \
-  add-apt-repository -y ppa:webupd8team/java && \
-  apt-get update && \
-  apt-get install -y oracle-java8-installer=${JAVA_VERSION}~webupd8~1 --no-install-recommends && \
-  rm -rf /var/lib/apt/lists/* && \
-  rm -rf /var/cache/oracle-jdk8-installer
-
-# Define commonly used JAVA_HOME variable
-ENV JAVA_HOME /usr/lib/jvm/java-8-oracle
-
-# install maven on top of java stage
-FROM local_stage_java as local_stage_build
-ARG MAVEN_VERSION=3.5.3
-ARG USER_HOME_DIR="/root"
-ARG SHA=b52956373fab1dd4277926507ab189fb797b3bc51a2a267a193c931fffad8408
-ARG BASE_URL=https://apache.osuosl.org/maven/maven-3/${MAVEN_VERSION}/binaries
-
-RUN apt-get update && apt-get install -y --no-install-recommends \
-        curl \
-    && rm -rf /var/lib/apt/lists/*
-
-RUN mkdir -p /usr/share/maven /usr/share/maven/ref \
-  && curl -fsSL -o /tmp/apache-maven.tar.gz ${BASE_URL}/apache-maven-${MAVEN_VERSION}-bin.tar.gz \
-  && echo "${SHA}  /tmp/apache-maven.tar.gz" | sha256sum -c - \
-  && tar -xzf /tmp/apache-maven.tar.gz -C /usr/share/maven --strip-components=1 \
-  && rm -f /tmp/apache-maven.tar.gz \
-  && ln -s /usr/share/maven/bin/mvn /usr/bin/mvn
-
-ENV MAVEN_HOME /usr/share/maven
-ENV MAVEN_CONFIG "$USER_HOME_DIR/.m2"
-
-COPY docker/mvn-entrypoint.sh /usr/local/bin/mvn-entrypoint.sh
-COPY docker/settings-docker.xml /usr/share/maven/ref/
-
-VOLUME "$USER_HOME_DIR/.m2"
-
-# install build dependencies
-RUN apt-get update && apt-get install -y --no-install-recommends \
-        git \
-    && rm -rf /var/lib/apt/lists/*
-
 WORKDIR /iri
 
 COPY . /iri
 RUN mvn clean package
 
 # execution image
-FROM local_stage_java
+FROM iotacafe/java:oracle8u181.1.webupd8.1-1
 
 RUN apt-get update && apt-get install -y --no-install-recommends \
         jq curl socat \

diff --git a/README.md b/README.md
@@ -34,8 +34,12 @@ If you want to get tokens for your testcase, please just ask in one of the commu
 
 ## Reporting Issues
 
-If you notice any bugs, problems or other irregularities with this release,
-please submit an issue on github [[submit new issue]](https://github.com/iotaledger/iri/issues/new).
+If you'd like to contribute to IRI, report bugs, problems or irregularities with this release,
+please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
+
+# Documentation
+
+This page contains basic instructions for setting up an IRI node. You can find the full documentation on our [documentation website](https://docs.iota.org/iri). Also see the [IRI API refernece](https://iota.readme.io/reference). 
 
 # Installing
 

diff --git a/changelog.txt b/changelog.txt
@@ -1,3 +1,20 @@
+1.5.5
+    - Javadoc on API command methods (#943)
+    - Parse case insensitive boolean text (#966)
+    - re-enable `--remote` flag - opens API interface to all hosts (#953)
+    - fix generics in RocksDbPersistenceProvider (#956)
+    - Fix milestone start index default value (#941)
+    - Enable batch deletion in rocksDB (#939)
+    - Refactor Configuration (#910)
+    - Some TransactionValidator fixes regarding solidity (#913)
+    - Remove checkSolidity mocks (#908)
+    - Fix: TransactionValidator instance based / TransactionRequester fixed (#914)
+    - Changed Dockerfile to source java and maven from precompiled docker containers. (#929)
+    - Fix grammar in API responses (#884)
+    - Fix error in log statement (#829)
+    - Move sleep inside spawnSolidTransactionsPropagation loop (#911)
+    - Fix solidity propagation from bottom to top (#907)
+
 1.5.4
    - Update snapshot to 2018-09-17 17:00 UTC (#989)
 

diff --git a/docker/mvn-entrypoint.sh b/docker/mvn-entrypoint.sh
diff --git a/docker/settings-docker.xml b/docker/settings-docker.xml
diff --git a/pom.xml b/pom.xml
@@ -5,7 +5,7 @@
 
     <groupId>com.iota</groupId>
     <artifactId>iri</artifactId>
-    <version>1.5.4</version>
+    <version>1.5.5</version>
 
     <name>IRI</name>
     <description>IOTA Reference Implementation</description>
@@ -93,6 +93,13 @@
             <version>2.8.1</version>
         </dependency>
 
+        <!-- https://mvnrepository.com/artifact/com.fasterxml.jackson.core/jackson-databind -->
+        <dependency>
+            <groupId>com.fasterxml.jackson.core</groupId>
+            <artifactId>jackson-databind</artifactId>
+            <version>2.9.6</version>
+        </dependency>
+
         <!-- undertow server -->
         <dependency>
             <groupId>io.undertow</groupId>
@@ -112,13 +119,6 @@
             <version>${undertow.version}</version>
         </dependency>
 
-        <!-- CLI -->
-        <dependency>
-            <groupId>com.sanityinc</groupId>
-            <artifactId>jargs</artifactId>
-            <version>2.0-SNAPSHOT</version>
-        </dependency>
-
         <!-- test dependencies -->
 
         <!-- https://mvnrepository.com/artifact/com.jayway.restassured/rest-assured -->
@@ -171,6 +171,12 @@
             <version>0.4.3</version>
         </dependency>
 
+        <dependency>
+            <groupId>com.beust</groupId>
+            <artifactId>jcommander</artifactId>
+            <version>1.72</version>
+        </dependency>
+
     </dependencies>
 
     <build>
@@ -186,6 +192,25 @@
                     <testTarget>${java-version}</testTarget>
                 </configuration>
             </plugin>
+            <plugin>
+			    <groupId>org.apache.maven.plugins</groupId>
+			    <artifactId>maven-javadoc-plugin</artifactId>
+			    <version>3.0.0</version>
+			    <configuration>
+			        <doclet>com.iota.mdxdoclet.MDXDoclet</doclet>
+			        <sourcepath>src/main/java</sourcepath>
+			        <useStandardDocletOptions>false</useStandardDocletOptions>
+			        <additionalOptions>
+			            <additionalOption>-version "${project.version}"</additionalOption>
+			        </additionalOptions>
+			        <quiet>true</quiet>
+			        <docletArtifact>
+			            <groupId>com.iota</groupId>
+			            <artifactId>mdxdoclet</artifactId>
+			            <version>0.1</version>
+			        </docletArtifact>
+			    </configuration>
+			</plugin>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-shade-plugin</artifactId>
@@ -295,7 +320,6 @@
                                         <!--
                                         not used anymore
                                         <urn>org.reflections:reflections:0.9.10:jar:null:compile:3812159b1b4b7c296fa80f53eed6362961eb85da</urn>
-                                        TODO <urn>com.sanityinc:jargs:2.0-SNAPSHOT:jar:null:compile:</urn>
                                         -->
                                         <urn>
                                             com.jayway.restassured:rest-assured:2.9.0:jar:null:test:d0d5b6720a58472ab99287c931a8205373d6e7b2
@@ -311,6 +335,12 @@
                                         <urn>
                                             org.bouncycastle:bcprov-jdk15on:1.58:jar:null:compile:2c9aa1c4e3372b447ba5daabade4adf2a2264b12
                                         </urn>
+                                        <urn>
+                                            com.fasterxml.jackson.core:jackson-databind:2.9.6:jar:null:compile:cfa4f316351a91bfd95cb0644c6a2c95f52db1fc
+                                        </urn>
+                                        <urn>
+                                            com.beust:jcommander:1.72:jar:null:compile:6375e521c1e11d6563d4f25a07ce124ccf8cd171
+                                        </urn>
 
                                         <!-- A check for the rules themselves -->
                                         <urn>
@@ -534,5 +564,4 @@
             </plugin>
         </plugins>
     </reporting>
-
-</project>
+</project>