Merge branch 'release/1.8.0'

CHANGELOG.md

@@ -1,3 +1,13 @@
+<a name="1.8.0"></a>
+# [1.8.0](https://github.com/benmarten/CryptoETF/compare/1.7.0...1.8.0) (2018-01-22)
+
+
+### Features
+
+* **strategy:** allow for manual allocation recommendation ([#41](https://github.com/benmarten/CryptoETF/issues/41)) ([f47a63f](https://github.com/benmarten/CryptoETF/commit/f47a63f))
+
+
+
 <a name="1.7.0"></a>
 # [1.7.0](https://github.com/benmarten/CryptoETF/compare/1.6.2...1.7.0) (2018-01-22)
 

README.md

@@ -36,6 +36,7 @@ The tool expects your settings in settings.json. Take a look at settings.example
 - *accounts*: Under accounts, fill in your api credentials for the exchange that you want to use. Delete the exchanges that you do not need.
 - *symbolMapping*: Some exchanges use different symbols that coinmarketcap.com. Hence here you can map the symbols, e.g.: map MIOTA to IOTA.
 - *otherHoldings*: A place to manually add some of your holdings. Notation is key: Symbol, value is amount of native currency.
+- *allocations*: Here you can manually define allocations of coins. The allocations is calculated from the amount of points it gets relative to the total amount of points. Filling in `66.67` and `33.33` for two currencies will yield the same result as `6` and `3` for example. If allocations is not mentioned in settings.json the allocations will reflect the coin's market cap relative to the other coins in the portfolio.
 - *options*: These are specific options for the tool:
   - targetValueUsd: The target value for your ETF; A general rule of thumb is to keep your crypto at a certain percentage of your overall investment portfolio. This could be 5, 10, 20 or more percent, depending on your risk tolerance.
     - Default [false]: Use current portfolio value as target value.

package.json

@@ -32,5 +32,5 @@
     "testLocal": "./node_modules/.bin/nyc mocha --require babel-core/register test/**/*.js test/**/**/*.js",
     "test": "NODE_ENV=test npm run testLocal"
   },
-  "version": "1.7.0"
+  "version": "1.8.0"
 }

settings.example.json

@@ -49,19 +49,26 @@
     }]
   },
   "symbolNameMapping": {
-    "Bitgem": "BITG"
+    "Remicoin": "REMI",
+    "KingN Coin": "KINGN",
+    "ENTCash": "ENTCASH"
   },
   "symbolMapping": {
     "USD": "USDT",
     "STR": "XLM",
     "IOTA": "MIOTA",
-    "XBT": "BTC"
+    "XBT": "BTC",
+    "XDG": "DOGE"
   },
   "otherHoldings": [{
     "BCH": 1.0
   }, {
     "BTG": 1.0
   }],
+  "allocations": {
+    "BTC": 66,
+    "ETH": 33
+  },
   "options": {
     "targetValueUsd": false,
     "rebalanceDeltaPct": 1.0,

src/model/Coin.js

@@ -60,7 +60,15 @@ export default class Coin {
   }
 
   getRelativeMarketCapRecommended() {
-    return Coinmarket.getRelativeMarketCapForX(this.symbol)
+    if (Settings.hasOwnProperty('allocations')) {
+      if (Settings.allocations.hasOwnProperty(this.symbol)) {
+        return Settings.allocations[this.symbol]
+      } else {
+        return 0
+      }
+    } else {
+      return Coinmarket.getRelativeMarketCapForX(this.symbol)
+    }
   }
 
   getAllocationDeltaPct() {
@@ -114,4 +122,4 @@ export default class Coin {
 
     return (result.charAt(result.length - 1) === ',') ? result.slice(0, -1) : result
   }
-}
+}