Dockerizing

.gitignore

@@ -5,3 +5,5 @@ node_modules/
 data/
 data/*
 package-lock.json
+
+!docker/config.js

config.default.js

@@ -5,9 +5,6 @@ module.exports = {
   //The Author
   author: "Anonymous",
 
-  //Include block.one distribution in snapshot
-  include_b1: true,
-
   //Minimum balance required for snapshot inclusion.
   //Note: 1 EOS is recommended, as there will be a minimum balance required to have the bandwidth required for a functional account. Additionally, this prevents dust from appearing as an initial accounts, and cleans up the chain.
   snapshot_minimum_balance: 1,

docker/Dockerfile

@@ -0,0 +1,52 @@
+FROM node:8
+
+WORKDIR /build
+
+# install tools and dependencies
+RUN apt-get update && \
+        apt-get install -y \
+        g++ \
+        build-essential \
+        curl \
+        git \
+        file \
+        binutils \
+        libssl-dev \
+        pkg-config \
+        libudev-dev \
+        mysql-client
+
+# install rustup
+#RUN curl https://sh.rustup.rs -sSf | sh -s -- -y
+
+# rustup directory
+#ENV PATH /root/.cargo/bin:$PATH
+
+# show backtraces
+#ENV RUST_BACKTRACE 1
+
+# show tools
+#RUN rustc -vV && \
+#cargo -V && \
+#gcc -v &&\
+#g++ -v
+
+# build parity
+#RUN git clone https://github.com/paritytech/parity.git
+#RUN cd parity && \
+#        cargo build --release --verbose && \
+#        ls /build/parity/target/release/parity && \
+#        strip /build/parity/target/release/parity
+
+#ENV PATH /build/parity/target/release:$PATH
+
+# build genesis
+RUN mkdir genesis
+WORKDIR /build/genesis
+ADD . /build/genesis
+RUN npm install -g lerna
+RUN npm install
+RUN cp docker/config.js .
+
+EXPOSE 8080 8545 8180
+#ENTRYPOINT ["node snapshot.js --load_config"]

docker/config.js

@@ -0,0 +1,49 @@
+module.exports = {
+  //Take snapshot up to which period? If left undefined, it will default to the last closed period.
+  period: 0,
+
+  //The Author
+  author: "Anonymous",
+
+  //Include block.one distribution in snapshot
+  include_b1: true,
+
+  //Minimum balance required for snapshot inclusion.
+  //Note: 1 EOS is recommended, as there will be a minimum balance required to have the bandwidth required for a functional account. Additionally, this prevents dust from appearing as an initial accounts, and cleans up the chain.
+  snapshot_minimum_balance: 1,
+
+  //Overwrite the snapshot.json in root directory.
+  overwrite_snapshot: true,
+
+  //ETH node Connection Details
+  eth_node_type: 'ipc',
+  eth_node_path: '/root/ipc/jsonrpc.ipc',
+
+  //Redis Connection Details
+  redis_host: null,
+  redis_port: null,
+
+  //Mysql Connection Details
+  mysql_db: "eos_snapshot_refactor",
+  mysql_user: "root",
+  mysql_pass: null,
+  mysql_host: "db",
+  mysql_port: 3306,
+
+  //
+  // Advanced/Developer settings
+  // Probably do not need to change this.
+  //
+
+  //Recalculate wallets table based on already synced
+  recalculate_wallets: false,
+
+  //For if parity is syncing but you're testing for a period that you know is already synced.
+  skip_web3_sync: false
+
+  //Enable fallback 1.0? (deprecated)
+  //registration_fallback: false,
+
+  //Cache Signatures from/for fallback (deprecated)
+  //cache_signatures: true,
+}

docker/createdb.sh

@@ -0,0 +1,3 @@
+#!/bin/sh
+echo "create database eos_snapshot_refactor;" | mysql -h db
+mysql -h db eos_snapshot_refactor < bin/schema.sql

docker/docker-compose.yml

@@ -0,0 +1,31 @@
+version: '3.1'
+
+services:
+  db:
+    image: mariadb:5
+    restart: always
+    environment:
+      - MYSQL_ALLOW_EMPTY_PASSWORD=1
+    volumes:
+      - ./data:/var/lib/mysql
+  parity:
+    image: parity/parity:v1.11.3
+    command: --mode active --min-peers 150 --tracing off --pruning fast --db-compaction ssd --jsonrpc-apis all --chain mainnet --no-warp --cache-size 16384 --ipc-path /root/ipc/jsonrpc.ipc
+    volumes:
+      - ./io.parity.ethereum:/root/.local/share/io.parity.ethereum
+      - ipc:/root/ipc
+  genesis:
+    build:
+      context: ..
+      dockerfile: docker/Dockerfile
+    command: node snapshot.js --load_config --poll --resume --period=350 --verbose_mt --recalculate_wallets --auto-update=none
+    volumes:
+      - ipc:/root/ipc
+    depends_on:
+      - db
+      - parity
+
+volumes:
+  ipc:
+    external: true
+

docker/start.sh

@@ -0,0 +1,3 @@
+#!/bin/sh
+parity --mode active --tracing off --pruning fast --db-compaction hdd --jsonrpc-apis all --chain mainnet --no-warp --cache-size 2048 &
+node snapshot.js --load_config

tools/snapshot/classes/Wallet.Final.js

@@ -1,13 +1,22 @@
 const async  = require('async'),
       bn     = require('bignumber.js'),
       Wallet = require('./Wallet'),
-      util = require('../utilities')
+      util = require('../utilities'),
+      address_key = require('../helpers/web3-address').key
 
 class WalletFinal extends Wallet {
 
   process_key( complete ){
-    this.maybe_fix_key()
-    complete()
+    address_key( this.address )
+      .then( key => {
+        //encode because some of register function exploits ... fixes a different problem from the web3 fork problem
+        this.eos_key = util.misc.sanitize_user_input(key)
+        this.maybe_fix_key()
+        complete()
+      })
+      .catch( e => {
+        throw new Error(e)
+      })
   }
 
   process_balance_wallet( complete ){
@@ -53,7 +62,7 @@ class WalletFinal extends Wallet {
 
   process_exclude(complete){
     const exclude = [CS_ADDRESS_CROWDSALE, CS_ADDRESS_TOKEN]
-    if(!this.config.include_b1) exclude.push(CS_ADDRESS_B1)
+    // if(!this.config.include_b1) exclude.push(CS_ADDRESS_B1)
     if(exclude.indexOf(this.address) > -1)
       this.accepted           = false,
       this.register_error     = 'exclude'

tools/snapshot/classes/Wallet.Ongoing.js

@@ -60,7 +60,7 @@ class WalletOngoing extends Wallet {
 
   process_exclude(complete){
     const exclude = [CS_ADDRESS_CROWDSALE, CS_ADDRESS_TOKEN]
-    if(!this.config.include_b1) exclude.push(CS_ADDRESS_B1)
+    // if(!this.config.include_b1) exclude.push(CS_ADDRESS_B1)
     if(exclude.indexOf(this.address) > -1)
       this.accepted           = false,
       this.register_error     = 'exclude'

tools/snapshot/classes/Wallet.js

@@ -133,6 +133,11 @@ class Wallet {
       error = 'not_registered'
     }
 
+    //credit: rohan/roshan from eosauthority.com
+    else if(BURNED_EOS_KEYS.indexOf(this.eos_key) > -1) {
+      error = 'key_is_burned'
+    }
+
     else {
       error = this.validate_key()
     }

tools/snapshot/helpers/web3-address.js

@@ -30,4 +30,4 @@ address.key = address => {
     .keys( address ).call()
 }
 
-module.exports = user
+module.exports = address

tools/snapshot/index.js

@@ -46,7 +46,8 @@ module.exports = (COMPLETE) => {
       require('./tasks/sync/public_keys'),
       //Sync: events from the crowdsale contract
       require('./tasks/sync/contract'),
-
+      //Misc: Sanitize Registrations
+      require('./tasks/misc/sanitize-registrations'),
       (state, next) => {
         if(config.only_produce_final_snapshot && !state.frozen) {
           console.log("only_produce_final_snapshot is set to true, skipping wallet calculations and snapshot export.")
@@ -80,8 +81,15 @@ module.exports = (COMPLETE) => {
       throw new Error(error)
     }
     else {
-      console.log(art("complete","2"))
-      console.log(`Snapshot for Period #${config.period} Completed.`)
+      if(state.mode == "final") {
+        console.log(art("final snapshot complete","2"))
+        process.exit()
+        return
+      }
+      else {
+        console.log(art("complete","2"))
+        console.log(`Snapshot for Period #${config.period} Completed.`)
+      }
     }
 
     // const sync_progress_destroy = require('./queries').sync_progress_destroy
@@ -109,8 +117,8 @@ module.exports = (COMPLETE) => {
     //In polling, the config.period is autoincremented before check_for_poll() is called,
     //so if it's greater than the highest period index (350) and the last closed period eq highest period index
     //Check if the token is frozen before attempting to generate final snapshot (tasks/block_range.js will force run the final snapshot.)
-    else if(period.last_closed == CS_MAX_PERIOD_INDEX && config.period > CS_MAX_PERIOD_INDEX) {
-      contract = require('../../helpers/web3-contract.js')
+    else if(period.last_closed() == CS_MAX_PERIOD_INDEX) {
+      contract = require('./helpers/web3-contract.js')
       contract.$token.methods.stopped().call()
         .then( stopped => {
           if(stopped) {
@@ -130,7 +138,7 @@ module.exports = (COMPLETE) => {
 
   const configure = (callback) => {
 
-    console.log(art("level 1","2"))
+    console.log(art("configuration","2"))
 
     //Show prompt?
     const show_prompt = next => {
@@ -178,12 +186,11 @@ module.exports = (COMPLETE) => {
       else if(config.period > period.last_closed()) {
         let cache_period = config.period
         config.period = period.last_closed()
-        console.log(colors.italic.red(`It appears you've set your period to ${cache_period}, has not completed yet. Period has been reset to ${config.period}`))
-      }
-      else if(config.period > CS_MAX_PERIOD_INDEX) {
-        let cache_period = config.period
-        config.period = CS_MAX_PERIOD_INDEX
-        console.log(colors.italic.red(`It appears you've set your period to ${cache_period}, which doesn't exist. Period has been reset to ${config.period}`))
+        if(config.period < 0)
+          console.log(colors.bold.red(`Period 0 hasn't even finished yet, exiting. try again later`)),
+          process.exit()
+        else
+          console.log(colors.italic.red(`It appears you've set your period to ${cache_period}, has not completed yet. Period has been reset to ${config.period}`))
       }
 
       next(null, config)

tools/snapshot/lib/globals.js

@@ -1,6 +1,6 @@
 const bn = require('bignumber.js')
 
-global.VERSION                            = "0.4.0-beta.10"
+global.VERSION                            = "0.4.2-stable"
 
 //Crowdsale Globals
 global.CS_ADDRESS_CROWDSALE               = "0xd0a6e6c54dbc68db5db3a091b171a77407ff7ccf"
@@ -32,9 +32,15 @@ global.SS_ACCEPTABLE_SUPPLY_DEVIATION     = 5 //total number of EOS deviation al
 global.CS_END_TIME                        = CS_START_TIME + ((CS_MAX_PERIOD_INDEX) * CS_PERIOD_LENGTH_SECONDS)
 // global.CS_END_TIME                        = 1527893999
 
+//EOS Keys to disallow from inclusion in snapshot becuase their private key is publicly available.
+global.BURNED_EOS_KEYS                    = ["EOS6MRyAjQq8ud7hVNYcfnVPJqcVpscN5So8BhtHuGYqET5GDW5CV"]
+
+
 //For screen output
 global.art = require('ascii-text-generator')
 
+
+
 //Services are global to help avoid extraneous connection bottlenecks.
 global.web3
 global.mysql