feat(settings): set targetValueUsd to false to use current portfolio value as target; use rebalanceD

Author: benmarten

README.md

@@ -38,7 +38,10 @@ The tool expects your settings in settings.json. Take a look at settings.example
 - *otherHoldings*: A place to manually add some of your holdings. Notation is key: Symbol, value is amount of native currency.
 - *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.
-  - rebalanceDeltaPct: Treshold in percent, that will show a Y in the rebalance column, once rebalancing is recommended.
+    - Default [false]: Use current portfolio value as target value.
+    - Number [1 - 999999999999]: Use fixed number as target value.
+  - rebalanceDeltaTotalPct: Treshold in percent, that will show a Y in the rebalance column, once rebalancing of total portfolio is recommended.
+  - rebalanceDeltaPct: Treshold in percent, that will show a Y in the rebalance column, once rebalancing of individual position is recommended.
   - minValueBtc: Ignore coins that only have a holdingsvalue under a certain bitcoin value.
   - hideMissingCoins: By default CryptoETF will add all missing coins up to your last coin holding by rank of the coin (global market cap). This option disables that behaviour.
 - *outputFile*: Path to a file to forward the output to as json.

settings.example.json

@@ -50,8 +50,9 @@
     "BTG": 1.0
   }],
   "options": {
-    "targetValueUsd": 50000,
+    "targetValueUsd": false,
     "rebalanceDeltaPct": 1.0,
+    "rebalanceDeltaTotalPct": 10.0,
     "minValueBtc": 0.0001,
     "hideMissingCoins": false
   },

src/Utils.js

@@ -1,3 +1,5 @@
+const settings = require('../settings.json')
+
 export default class Utils {
   static pad(width, string, padding) {
     return (width <= string.length) ? string : this.pad(width, padding + string, padding)
@@ -36,4 +38,14 @@ export default class Utils {
   static capitalize(string) {
     return string.charAt(0).toUpperCase() + string.slice(1).toLowerCase()
   }
+
+  /**
+   * Determines if drift is above treshold defined in settings.
+   * @param drift The current drift.
+   * @return {string} 'Y', if drifted, '' if not.
+   */
+  static hasDriftedAboveTreshold(drift) {
+    return (Math.abs(drift) * 100 > (settings.options.rebalanceDeltaTotalPct ||
+        settings.options.rebalanceDeltaPct)) ? 'Y' : ''
+  }
 }

src/model/Portfolio.js

@@ -109,6 +109,18 @@ export default class Portfolio {
     }
   }
 
+  /**
+   * Returns the target value of the portfolio in USD.
+   * @return {*} The target value in USD.
+   */
+  static getTargetValueUsd() {
+    if (!settings.options.targetValueUsd) {
+      return Portfolio.getSumUsd()
+    } else {
+      return settings.options.targetValueUsd
+    }
+  }
+
   /**
    * Formats the output for the command line.
    * @return {string} A string with the result.
@@ -121,7 +133,8 @@ export default class Portfolio {
     ]
     let sortedKeys = Utils.getSortedKeys(portfolio, 'rank')
     let targetSum = []
-    let targetValueBtc = settings.options.targetValueUsd / Coinmarket.getBtcUsd()
+    let targetValueUsd = this.getTargetValueUsd()
+    let targetValueBtc = this.getTargetValueUsd() / Coinmarket.getBtcUsd()
     targetSum['allocationActualPct'] = 0
     targetSum['allocationTargetPct'] = 0
     targetSum['targetBtc'] = 0
@@ -134,8 +147,8 @@ export default class Portfolio {
       let allocationActualPct = coin.getRelativeMarketCap()
       let allocationTargetPct = coin.getRelativeMarketCapRecommended() / stretchFactor
       let targetBtc = coin.getRelativeMarketCapRecommended() / stretchFactor * targetValueBtc
-      let targetUsd = coin.getRelativeMarketCapRecommended() / stretchFactor * settings.options.targetValueUsd
-      let drift = Math.abs((coin.getUsdValue() - targetUsd) / settings.options.targetValueUsd)
+      let targetUsd = coin.getRelativeMarketCapRecommended() / stretchFactor * targetValueUsd
+      let drift = Math.abs((coin.getUsdValue() - targetUsd) / targetValueUsd)
       data.push([
         coin.getRank(),
         coin.getSymbol(),
@@ -150,7 +163,7 @@ export default class Portfolio {
         Format.bitcoin((targetBtc - coin.getBtcValue()) / Coinmarket.getBtcEth(), 8),
         Format.money(targetUsd - coin.getUsdValue()),
         Format.percent(drift),
-        (drift * 100 > settings.options.rebalanceDeltaPct) ? 'Y' : '',
+        Utils.hasDriftedAboveTreshold(drift),
         coin.getExchangesString()
       ])
       targetSum['allocationActualPct'] += allocationActualPct || 0
@@ -174,7 +187,7 @@ export default class Portfolio {
       '',
       Format.money(targetSum['targetUsd'] - this.getSumUsd()),
       Format.percent(drift),
-      (Math.abs(drift) * 100 > settings.options.rebalanceDeltaPct) ? 'Y' : '',
+      Utils.hasDriftedAboveTreshold(drift),
       ''])
 
     // noinspection JSUnusedGlobalSymbols