0.6.1-merge

CHANGELOG.md

@@ -1,3 +1,11 @@
+## 0.6.1
+-   Curator-less implementation
+-   Set initial nominees
+-   Set testnet genesis time
+
+## 0.6.0
+-   Finality Update integration. For more info see the [specifications](https://github.com/HelixNetwork/helix-specs/blob/master/specs/1.0/finality.md).
+
 ## 0.5.9
 
 -   Added security levels according to specifications

DOCKER.md

@@ -15,7 +15,7 @@ The provided dockerfile only contains the bare minimum of configuration paramete
 2.  build: installs Maven on top of the java stage and compiles Helix
 3.  final container: copies the helix jar file using the java stage as base
 
-The built container assumes the WORKDIR inside the container is /helix-1.0/data: this means that the database directory will be written inside that directory by default. If a system administrator wants to retain the database across restarts, it is his/her job to mount a docker volume in the right folder
+The built container assumes the WORKDIR inside the container is /helix/data: this means that the database directory will be written inside that directory by default. If a system administrator wants to retain the database across restarts, it is his/her job to mount a docker volume in the right folder
 
 ## Getting Started
 
@@ -32,7 +32,7 @@ In order to run this container you'll need docker installed.
 ### Example
 
 ```shell
-sudo docker run helixnetwork/helix-1.0:latest -p 8085
+sudo docker run helixnetwork/helix:latest -p 8085
 ```
 
 This will run the helix with its API listening on port 8085, with no peers and a fresh database.
@@ -44,7 +44,7 @@ You can also pass more command line options to the docker run command and those
 If you want to use a `<conf_name>`.ini file with the docker container, supposing it's stored under /path/to/conf/`<conf_name>`.ini on your docker host, then pass -v /path/to/conf:/helix/conf and add -c /helix/conf/`<conf_name>`.ini as docker run arguments. So for example the docker run command above would become:
 
 ```shell
-docker run -v /path/to/conf:/helix/conf -v /path/to/data:/helix/data helixnetwork/helix-1.0:latest -p 8085 -c /helix/conf/<conf_name>.ini
+docker run -v /path/to/conf:/helix/conf -v /path/to/data:/helix/data helixnetwork/helix:latest -p 8085 -c /helix/conf/<conf_name>.ini
 ```
 
 ## Security

Dockerfile

@@ -1,8 +1,8 @@
 FROM helixnetwork/base16.04:latest as builder
 LABEL maintainer="dt@hlx.ai"
 
-WORKDIR /helix-1.0
-COPY . /helix-1.0
+WORKDIR /helix
+COPY . /helix
 RUN mvn clean package
 
 FROM openjdk:jre-slim
@@ -11,7 +11,7 @@ RUN apt-get update && apt-get install -y --no-install-recommends \
         socat \
     && rm -rf /var/lib/apt/lists/*
 
-COPY --from=builder /helix-1.0/target/helix*.jar /helix-1.0/target/
+COPY --from=builder /helix/target/helix*.jar /helix/target/
 COPY docker/entrypoint.sh /
 
 # Default environment variables configuration. See DOCKER.md for details.
@@ -40,7 +40,7 @@ COPY docker/entrypoint.sh /
 ENV JAVA_OPTIONS="-XX:+UnlockExperimentalVMOptions -XX:+DisableAttachMechanism -XX:InitiatingHeapOccupancyPercent=60 -XX:G1MaxNewSizePercent=75 -XX:MaxGCPauseMillis=10000 -XX:+UseG1GC" \
     JAVA_MIN_MEMORY=2G \
     JAVA_MAX_MEMORY=4G \
-    DOCKER_HLX_JAR_PATH="/helix-1.0/target" \
+    DOCKER_HLX_JAR_PATH="/helix/target" \
     DOCKER_HLX_JAR_FILE="helix*.jar" \
     DOCKER_HLX_REMOTE_LIMIT_API="interruptAttachToTangle, attachToTangle, addNeighbors, removeNeighbors, getNeighbors" \
     DOCKER_HLX_MONITORING_API_PORT_ENABLE=0 \
@@ -49,5 +49,5 @@ ENV JAVA_OPTIONS="-XX:+UnlockExperimentalVMOptions -XX:+DisableAttachMechanism -
     DOCKER_HLX_LOGGING_LEVEL="info" \
     DOCKER_JAVA_NET_PREFER_IPV4_STACK=true
 
-WORKDIR /helix-1.0/data
+WORKDIR /helix/data
 ENTRYPOINT [ "/entrypoint.sh" ]

README.md

@@ -2,11 +2,10 @@
 
 [![license][4]][5] [![build][6]][7] [![grade][8]][9] [![coverage][10]][11] [![discord][14]][15]
 
-# Helix-1.0
+# Helix
 
 A Quorum based Tangle implementation forked from [**IRI**](https://github.com/iotaledger/iri/).
-
--   **Latest release:** 0.5.9 pre-release
+-   **Latest release:** 0.6.1 pre-release
 -   **License:** GPLv3
 
 Special thanks to all of the [IOTA Contributors](https://github.com/iotaledger/iri/graphs/contributors)!
@@ -22,19 +21,24 @@ Make sure you have [**Maven**](https://maven.apache.org/) and [**Java 8**](https
 
 ### Download
 
-    $ git clone https://github.com/HelixNetwork/helix-1.0.git
+    $ git clone https://github.com/HelixNetwork/helix.git
 
 ### Build
 
 Build an executable jar at the `target` directory using maven.
 
-    $ cd helix-1.0
+    $ cd helix
     $ mvn clean package
 
-### Launch
+### Launch Full node
 
     java -jar target/helix-<VERSION>.jar -p 8085
 
+### Launch Nominee node
+Launching a node as a nominee first requires to generate a 64 character hex string, that is used as a seed for key generation. You will find the public key in the last line of the `nominee.key` file contained in the resources directory. If you wish to act as a nominee, please send a request to dt@hlx.ai containing your public key.
+
+    java -jar target/helix-<VERSION>.jar -p 8085 --nominee <pathToNomineeSeed>
+
 ## Configuration
 
 | Option                   | Short | Description                                                                                                                                 | Example Input                                                       |
@@ -65,8 +69,6 @@ PORT = 8085
 UDP_RECEIVER_PORT = 4100
 NEIGHBORS = udp://my.favorite.com:5100
 HXI_DIR = XI
-HEADLESS = true
-DEBUG = true
 DB_PATH = db
 ZMQ_ENABLED = true
 ```

pom.xml

@@ -5,10 +5,11 @@
 
     <groupId>net.helix</groupId>
     <artifactId>helix</artifactId>
-    <version>0.5.9</version>
+
+    <version>0.6.1</version>
 
     <name>Helix</name>
-    <description>Helix-1.0</description>
+    <description>Helix Protocol</description>
 
     <scm>
         <url>https://github.com/helixnetwork/helix-1.0/</url>

src/main/java/net/helix/hlx/BundleValidator.java

@@ -8,6 +8,7 @@
 import net.helix.hlx.model.Hash;
 import net.helix.hlx.service.snapshot.Snapshot;
 import net.helix.hlx.storage.Tangle;
+import org.bouncycastle.util.encoders.Hex;
 
 import java.util.*;
 
@@ -61,11 +62,13 @@ public static List<List<TransactionViewModel>> validate(Tangle tangle, Snapshot
 
         TransactionViewModel tail = TransactionViewModel.fromHash(tangle, tailHash);
         if (tail.getCurrentIndex() != 0 || tail.getValidity() == -1) {
+            //System.out.println("Empty List");
             return Collections.EMPTY_LIST;
         }
 
         List<List<TransactionViewModel>> transactions = new LinkedList<>();
         final Map<Hash, TransactionViewModel> bundleTransactions = loadTransactionsFromTangle(tangle, tail);
+        // System.out.println("bundle size: " + bundleTransactions.size());
 
         //we don't really iterate, we just pick the tail tx. See the if on the next line
         for (TransactionViewModel transactionViewModel : bundleTransactions.values()) {
@@ -99,13 +102,9 @@ public static List<List<TransactionViewModel>> validate(Tangle tangle, Snapshot
                                     || bundleValue > TransactionViewModel.SUPPLY)
                     ) {
                         instanceTransactionViewModels.get(0).setValidity(tangle, initialSnapshot, -1);
+                        //System.out.println("Semantics Error!");
                         break;
                     }
-                    // todo address validation
-                    /* if (transactionViewModel.value() != 0 && transactionViewModel.getAddressHash().bytes()[Sha3.HASH_LENGTH - 1] != 0) {
-                        instanceTransactionViewModels.get(0).setValidity(tangle, initialSnapshot, -1);
-                        break;
-                    }*/
 
                     // It's supposed to become -3812798742493 after 3812798742493 and to go "down" to -1 but
                     // we hope that no one will create such long bundles
@@ -120,6 +119,8 @@ public static List<List<TransactionViewModel>> validate(Tangle tangle, Snapshot
                                 }
                                 sha3Instance.squeeze(bundleHashBytes, 0, bundleHashBytes.length);
                                 //verify bundle hash is correct
+                                //System.out.println("Bundle Hash: "  + instanceTransactionViewModels.get(0).getBundleHash());
+                                //System.out.println("recalculated Bundle Hash: " + Hex.toHexString(bundleHashBytes));
                                 if (Arrays.equals(instanceTransactionViewModels.get(0).getBundleHash().bytes(), bundleHashBytes))  {
                                     //normalizing the bundle in preparation for signature verification
                                     normalizedBundle = Winternitz.normalizedBundle(bundleHashBytes);
@@ -146,6 +147,7 @@ public static List<List<TransactionViewModel>> validate(Tangle tangle, Snapshot
                                             //signature verification
                                             if (! Arrays.equals(transactionViewModel.getAddressHash().bytes(), addressBytes)) {
                                                 instanceTransactionViewModels.get(0).setValidity(tangle, initialSnapshot, -1);
+                                                //System.out.println("Signature Error!");
                                                 break MAIN_LOOP;
                                             }
                                         } else {
@@ -159,6 +161,7 @@ public static List<List<TransactionViewModel>> validate(Tangle tangle, Snapshot
                                 //bundle hash verification failed
                                 else {
                                     instanceTransactionViewModels.get(0).setValidity(tangle, initialSnapshot, -1);
+                                    //System.out.println("Bundle Hash Error!");
                                 }
                             }
                             //bundle validity status is known
@@ -169,6 +172,7 @@ public static List<List<TransactionViewModel>> validate(Tangle tangle, Snapshot
                         //total bundle value does not sum to 0
                         else {
                             instanceTransactionViewModels.get(0).setValidity(tangle, initialSnapshot, -1);
+                            //System.out.println("Bundle Sum Error!");
                         }
                         //break from main loop
                         break;

src/main/java/net/helix/hlx/HLX.java

@@ -9,7 +9,8 @@
 import net.helix.hlx.service.API;
 import net.helix.hlx.service.ApiArgs;
 import net.helix.hlx.service.Spammer;
-import net.helix.hlx.service.milestone.MSS;
+import net.helix.hlx.service.milestone.impl.MilestonePublisher;
+import net.helix.hlx.service.curator.impl.NomineePublisher;
 import net.helix.hlx.service.restserver.resteasy.RestEasy;
 import net.helix.hlx.utils.HelixIOUtils;
 import org.apache.commons.lang3.ArrayUtils;
@@ -39,13 +40,13 @@
  *     </ul>
  * </p>
  *
- * @see <a href="https://docs.hlx.ai/sbx">Online documentation on hlx</a>
+ * @see <a href="https://docs.hlx.ai/protocol">Online documentation on hlx</a>
  */
 public class HLX {
 
     public static final String MAINNET_NAME = "HLX";
     public static final String TESTNET_NAME = "HLX Testnet";
-    public static final String VERSION = "0.5.9";
+    public static final String VERSION = "0.6.1";
 
     /**
      * The entry point of the helix sandbox.
@@ -96,7 +97,8 @@ private static class HLXLauncher {
         public static Helix helix;
         public static API api;
         public static XI XI;
-        public static MSS mss;
+        public static MilestonePublisher milestonePublisher;
+        //public static NomineePublisher nomineePublisher;
         public static Spammer spammer;
 
         /**
@@ -121,8 +123,6 @@ public static void main(String [] args) throws Exception {
             XI = new XI(helix);
             ApiArgs apiArgs = new ApiArgs(helix, XI);
             api = new API(apiArgs);
-            mss = new MSS(config, api);
-            spammer = new Spammer(config, api);
             shutdownHook();
 
             try {
@@ -135,12 +135,19 @@ public static void main(String [] args) throws Exception {
                 log.error("Exception during Helix node initialisation: ", e);
                 throw e;
             }
-            if(config.getMsDelay() > 0) {
-                mss.startScheduledExecutorService();
+            if (config.getNominee() != null) {
+                milestonePublisher = new MilestonePublisher(config, api, helix.candidateTracker);
+                milestonePublisher.startScheduledExecutorService();
             }
-            if(config.getSpamDelay() > 0) {
+            /*if (config.getCuratorEnabled()) {
+                nomineePublisher = new NomineePublisher(config, api);
+                nomineePublisher.startScheduledExecutorService();
+            }*/
+            /* todo: disable spammer temporarily
+            if (config.getSpamDelay() > 0) {
+                spammer = new Spammer(config, api);
                 spammer.startScheduledExecutorService();
-            }
+            }*/
         }
 
         /**
@@ -151,7 +158,12 @@ private static void shutdownHook() {
             Runtime.getRuntime().addShutdownHook(new Thread(() -> {
                 log.info("Shutting down Helix node, please hold tight...");
                 try {
-                    mss.shutdown();
+                    if (helix.configuration.getNominee() != null) {
+                        milestonePublisher.shutdown();
+                    }
+                    /*if (helix.configuration.getCuratorEnabled()) {
+                        nomineePublisher.shutdown();
+                    }*/
                     XI.shutdown();
                     api.shutDown();
                     helix.shutdown();

src/main/java/net/helix/hlx/Helix.java

@@ -13,6 +13,8 @@
 import net.helix.hlx.service.TipsSolidifier;
 import net.helix.hlx.service.ledger.impl.LedgerServiceImpl;
 import net.helix.hlx.service.milestone.impl.*;
+import net.helix.hlx.service.nominee.impl.*;
+import net.helix.hlx.service.curator.impl.*;
 import net.helix.hlx.service.snapshot.SnapshotException;
 import net.helix.hlx.service.snapshot.impl.LocalSnapshotManagerImpl;
 import net.helix.hlx.service.snapshot.impl.SnapshotProviderImpl;
@@ -79,12 +81,18 @@ public class Helix {
     public final SnapshotServiceImpl snapshotService;
     public final LocalSnapshotManagerImpl localSnapshotManager;
     public final MilestoneServiceImpl milestoneService;
-    public final LatestMilestoneTrackerImpl latestMilestoneTracker;
+    //public final NomineeServiceImpl nomineeService;
+    public final CuratorServiceImpl curatorService;
+    public final MilestoneTrackerImpl latestMilestoneTracker;
+    //public final NomineeTrackerImpl nomineeTracker;
+    public final CandidateTrackerImpl candidateTracker;
     public final LatestSolidMilestoneTrackerImpl latestSolidMilestoneTracker;
     public final SeenMilestonesRetrieverImpl seenMilestonesRetriever;
     public final LedgerServiceImpl ledgerService = new LedgerServiceImpl();
     public final AsyncTransactionPruner transactionPruner;
     public final MilestoneSolidifierImpl milestoneSolidifier;
+    //public final NomineeSolidifierImpl nomineeSolidifier;
+    public final CandidateSolidifierImpl candidateSolidifier;
     public final TransactionRequesterWorkerImpl transactionRequesterWorker;
 
     public final Tangle tangle;
@@ -124,10 +132,16 @@ public Helix(HelixConfig configuration) throws TransactionPruningException, Snap
                 ? new LocalSnapshotManagerImpl()
                 : null;
         milestoneService = new MilestoneServiceImpl();
-        latestMilestoneTracker = new LatestMilestoneTrackerImpl();
+        //nomineeService = new NomineeServiceImpl();
+        curatorService = new CuratorServiceImpl();
+        latestMilestoneTracker = new MilestoneTrackerImpl();
+        //nomineeTracker = new NomineeTrackerImpl();
+        candidateTracker = new CandidateTrackerImpl();
         latestSolidMilestoneTracker = new LatestSolidMilestoneTrackerImpl();
         seenMilestonesRetriever = new SeenMilestonesRetrieverImpl();
         milestoneSolidifier = new MilestoneSolidifierImpl();
+        //nomineeSolidifier = new NomineeSolidifierImpl();
+        candidateSolidifier = new CandidateSolidifierImpl();
         transactionPruner = configuration.getLocalSnapshotsEnabled() && configuration.getLocalSnapshotsPruningEnabled()
                 ? new AsyncTransactionPruner()
                 : null;
@@ -167,7 +181,7 @@ public void init() throws Exception {
         }
 
         if (configuration.isRevalidate()) {
-            tangle.clearColumn(net.helix.hlx.model.persistables.Milestone.class);
+            tangle.clearColumn(net.helix.hlx.model.persistables.Round.class);
             tangle.clearColumn(net.helix.hlx.model.StateDiff.class);
             tangle.clearMetadata(net.helix.hlx.model.persistables.Transaction.class);
         }
@@ -181,6 +195,8 @@ public void init() throws Exception {
 
         latestMilestoneTracker.start();
         latestSolidMilestoneTracker.start();
+        //nomineeTracker.start();
+        candidateTracker.start();
         seenMilestonesRetriever.start();
         milestoneSolidifier.start();
         transactionRequesterWorker.start();
@@ -209,13 +225,19 @@ private void injectDependencies() throws SnapshotException, TransactionPruningEx
         if (localSnapshotManager != null) {
             localSnapshotManager.init(snapshotProvider, snapshotService, transactionPruner, configuration);
         }
-        milestoneService.init(tangle, snapshotProvider, snapshotService, configuration);
-        latestMilestoneTracker.init(tangle, snapshotProvider, milestoneService, milestoneSolidifier, configuration);
+        milestoneService.init(tangle, snapshotProvider, snapshotService, transactionValidator, configuration);
+        //nomineeService.init(tangle, snapshotProvider, snapshotService, configuration);
+        curatorService.init(tangle, snapshotProvider, snapshotService, configuration);
+        //nomineeTracker.init(tangle, snapshotProvider, nomineeService, nomineeSolidifier, configuration);
+        candidateTracker.init(tangle, snapshotProvider, curatorService, candidateSolidifier, configuration);
+        latestMilestoneTracker.init(tangle, snapshotProvider, milestoneService, milestoneSolidifier, candidateTracker, configuration);
         latestSolidMilestoneTracker.init(tangle, snapshotProvider, milestoneService, ledgerService,
                 latestMilestoneTracker);
         seenMilestonesRetriever.init(tangle, snapshotProvider, transactionRequester);
         milestoneSolidifier.init(snapshotProvider, transactionValidator);
-        ledgerService.init(tangle, snapshotProvider, snapshotService, milestoneService, graph);
+        //nomineeSolidifier.init(snapshotProvider, transactionValidator);
+        candidateSolidifier.init(snapshotProvider, transactionValidator);
+        ledgerService.init(tangle, snapshotProvider, snapshotService, milestoneService, configuration, graph);
         if (transactionPruner != null) {
             transactionPruner.init(tangle, snapshotProvider, spentAddressesService, tipsViewModel, configuration)
                     .restoreState();
@@ -230,7 +252,7 @@ private void rescanDb() throws Exception {
         tangle.clearColumn(net.helix.hlx.model.persistables.Approvee.class);
         tangle.clearColumn(net.helix.hlx.model.persistables.BundleNonce.class);
         tangle.clearColumn(net.helix.hlx.model.persistables.Tag.class);
-        tangle.clearColumn(net.helix.hlx.model.persistables.Milestone.class);
+        tangle.clearColumn(net.helix.hlx.model.persistables.Round.class);
         tangle.clearColumn(net.helix.hlx.model.StateDiff.class);
         tangle.clearMetadata(net.helix.hlx.model.persistables.Transaction.class);
 
@@ -305,4 +327,4 @@ private TipSelector createTipSelector(TipSelConfig config) {
         return new TipSelectorImpl(tangle, snapshotProvider, ledgerService, entryPointSelector, ratingCalculator,
                 walker, config);
     }
-}
+}