@tetherto/mdk-core 0.0.0 → 0.12.1

package/lib/templates/stats.js

@@ -0,0 +1,476 @@
+'use strict'
+
+const { groupBy } = require('../stats/utils')
+const { hasErrorAndPositiveHashrate } = require('../utils')
+const { STATUS, POWER_MODE, MAINTENANCE } = require('../things/constants')
+
+// Base stat spec data per device family. Workers compose their own
+// { conf, specs } template object from these — the exported objects are
+// never mutated (see alerts.js for why).
+
+const CONF = {
+  skipTagPrefixes: ['id-', 'code-']
+}
+
+const MINER_CONF = {
+  skipTagPrefixes: ['pos-', 'id-', 'code-', 'site-']
+}
+
+const DEFAULT_OPS = {
+  alerts_cnt: {
+    op: 'alerts_group_cnt',
+    src: 'last.alerts'
+  }
+}
+
+const MINER_DEFAULT_OPS = {
+  ...DEFAULT_OPS,
+  hashrate_mhs_1m_sum: {
+    op: 'sum',
+    src: 'last.snap.stats.hashrate_mhs.t_5m'
+  },
+  hashrate_mhs_1m_group_sum: {
+    op: 'group_sum',
+    src: 'last.snap.stats.hashrate_mhs.t_5m',
+    group: groupBy('info.container')
+  },
+  hashrate_mhs_1m_avg: {
+    op: 'avg',
+    src: 'last.snap.stats.hashrate_mhs.t_5m'
+  },
+  hashrate_mhs_1m_cnt: {
+    op: 'cnt',
+    src: 'last.snap.stats.hashrate_mhs.t_5m',
+    filter: function (entry) {
+      return (
+        entry?.info?.container !== MAINTENANCE &&
+        entry?.last?.snap?.stats?.hashrate_mhs?.t_5m != null
+      )
+    }
+  },
+  hashrate_mhs_1m_cnt_active: {
+    op: 'cnt',
+    src: 'last.snap.stats.hashrate_mhs.t_5m',
+    filter: function (entry) {
+      return entry?.last?.snap?.stats?.status === STATUS.MINING
+    }
+  },
+  offline_or_sleeping_miners_cnt: {
+    op: 'cnt',
+    filter: function (entry) {
+      return (
+        entry?.info?.container !== MAINTENANCE &&
+        [STATUS.OFFLINE, STATUS.SLEEPING].includes(entry?.last?.snap?.stats?.status)
+      )
+    }
+  },
+  online_or_minor_error_miners_cnt: {
+    op: 'cnt',
+    filter: function (entry) {
+      return (
+        entry?.info?.container !== MAINTENANCE &&
+        entry?.last?.snap?.stats?.status === STATUS.MINING
+      )
+    }
+  },
+  error_miners_cnt: {
+    op: 'cnt',
+    filter: function (entry) {
+      return (
+        entry?.info?.container !== MAINTENANCE &&
+        entry?.last?.snap?.stats?.status === STATUS.ERROR
+      )
+    }
+  },
+  not_mining_miners_cnt: {
+    op: 'cnt',
+    filter: function (entry) {
+      return (
+        entry?.info?.container !== MAINTENANCE &&
+        entry?.last?.snap?.stats?.status === STATUS.NOT_MINING
+      )
+    }
+  },
+  power_w_sum: {
+    op: 'sum',
+    src: 'last.snap.stats.power_w'
+  },
+  power_w_avg: {
+    op: 'avg',
+    src: 'last.snap.stats.power_w'
+  },
+  power_w_type_group_sum: {
+    op: 'group_sum',
+    src: 'last.snap.stats.power_w',
+    group: groupBy('type'),
+    filter: (entry) => {
+      return entry?.info?.container !== MAINTENANCE
+    }
+  },
+  power_w_type_group_avg: {
+    op: 'group_avg',
+    src: 'last.snap.stats.power_w',
+    group: groupBy('type'),
+    filter: (entry) => {
+      return entry?.info?.container !== MAINTENANCE
+    }
+  },
+  power_w_container_group_sum: {
+    op: 'group_sum',
+    src: 'last.snap.stats.power_w',
+    group: groupBy('info.container')
+  },
+  power_w_container_group_avg: {
+    op: 'group_avg',
+    src: 'last.snap.stats.power_w',
+    group: groupBy('info.container')
+  },
+  uptime_ms_avg: {
+    op: 'avg',
+    src: 'last.snap.stats.uptime_ms'
+  },
+  frequency_mhz_avg: {
+    op: 'avg',
+    src: 'last.snap.stats.frequency_mhz.avg'
+  },
+  efficiency_w_ths_avg: {
+    op: 'avg',
+    src: 'last.snap.stats.efficiency_w_ths'
+  },
+  temperature_c_avg: {
+    op: 'avg',
+    src: 'last.snap.stats.temperature_c.avg'
+  },
+  temperature_c_group_avg: {
+    op: 'group_avg',
+    src: 'last.snap.stats.temperature_c.avg',
+    group: groupBy('info.container')
+  },
+  temperature_c_group_max: {
+    op: 'group_max',
+    src: 'last.snap.stats.temperature_c.max',
+    group: groupBy('info.container')
+  },
+  offline_cnt: {
+    op: 'group_cnt',
+    group: groupBy('info.container'),
+    filter: (entry) => {
+      return (
+        entry?.info?.container !== MAINTENANCE &&
+        entry?.last?.snap?.stats?.status === STATUS.OFFLINE
+      )
+    }
+  },
+  error_cnt: {
+    op: 'group_cnt',
+    group: groupBy('info.container'),
+    filter: (entry) => {
+      return (
+        entry?.info?.container !== MAINTENANCE &&
+        entry?.last?.snap?.stats?.status === STATUS.ERROR
+      )
+    }
+  },
+  not_mining_cnt: {
+    op: 'group_cnt',
+    group: groupBy('info.container'),
+    filter: (entry) => {
+      return (
+        entry?.info?.container !== MAINTENANCE &&
+        entry?.last?.snap?.stats?.status === STATUS.NOT_MINING
+      )
+    }
+  },
+  power_mode_sleep_cnt: {
+    op: 'group_cnt',
+    group: groupBy('info.container'),
+    filter: (entry) => {
+      return entry?.last?.snap?.stats?.status === STATUS.SLEEPING
+    }
+  },
+  power_mode_low_cnt: {
+    op: 'group_cnt',
+    group: groupBy('info.container'),
+    filter: (entry) => {
+      return entry?.last?.snap?.stats?.status === STATUS.MINING && entry?.last?.snap?.config?.power_mode === POWER_MODE.LOW
+    }
+  },
+  power_mode_normal_cnt: {
+    op: 'group_cnt',
+    group: groupBy('info.container'),
+    filter: (entry) => {
+      return entry?.last?.snap?.stats?.status === STATUS.MINING && entry?.last?.snap?.config?.power_mode === POWER_MODE.NORMAL
+    }
+  },
+  power_mode_high_cnt: {
+    op: 'group_cnt',
+    group: groupBy('info.container'),
+    filter: (entry) => {
+      return entry?.last?.snap?.stats?.status === STATUS.MINING && entry?.last?.snap?.config?.power_mode === POWER_MODE.HIGH
+    }
+  },
+  power_mode_low_include_error_cnt: {
+    op: 'group_cnt',
+    group: groupBy('info.container'),
+    filter: (entry) => {
+      return hasErrorAndPositiveHashrate(entry) && entry?.last?.snap?.config?.power_mode === POWER_MODE.LOW
+    }
+  },
+  power_mode_normal_include_error_cnt: {
+    op: 'group_cnt',
+    group: groupBy('info.container'),
+    filter: (entry) => {
+      return hasErrorAndPositiveHashrate(entry) && entry?.last?.snap?.config?.power_mode === POWER_MODE.NORMAL
+    }
+  },
+  power_mode_high_include_error_cnt: {
+    op: 'group_cnt',
+    group: groupBy('info.container'),
+    filter: (entry) => {
+      return hasErrorAndPositiveHashrate(entry) && entry?.last?.snap?.config?.power_mode === POWER_MODE.HIGH
+    }
+  },
+  type_cnt: {
+    op: 'group_cnt',
+    group: groupBy('type'),
+    filter: (entry) => {
+      return entry?.info?.container !== MAINTENANCE && entry?.last?.snap
+    }
+  },
+  offline_type_cnt: {
+    op: 'group_cnt',
+    group: groupBy('type'),
+    filter: (entry) => {
+      return (
+        entry?.info?.container !== MAINTENANCE &&
+        entry?.last?.snap?.stats?.status === STATUS.OFFLINE
+      )
+    }
+  },
+  maintenance_type_cnt: {
+    op: 'group_cnt',
+    group: groupBy('type'),
+    filter: (entry) => {
+      return entry?.info?.container === MAINTENANCE
+    }
+  },
+  online_positive_hashrate_type_cnt: {
+    op: 'group_cnt',
+    group: groupBy('type'),
+    filter: (entry) => {
+      const { status, hashrate_mhs: hashrateMHS } = entry?.last?.snap?.stats || {}
+      return (
+        entry?.info?.container !== MAINTENANCE &&
+        status !== STATUS.OFFLINE &&
+        hashrateMHS?.t_5m > 0
+      )
+    }
+  },
+  online_without_hashrate_type_cnt: {
+    op: 'group_cnt',
+    group: groupBy('type'),
+    filter: (entry) => {
+      const { status, hashrate_mhs: hashrateMHS } = entry?.last?.snap?.stats || {}
+      return (
+        entry?.info?.container !== MAINTENANCE &&
+        status !== STATUS.OFFLINE &&
+        (!hashrateMHS?.t_5m || hashrateMHS?.t_5m === 0)
+      )
+    }
+  },
+  error_type_cnt: {
+    op: 'group_cnt',
+    group: groupBy('type'),
+    filter: (entry) => {
+      return (
+        entry?.info?.container !== MAINTENANCE &&
+        entry?.last?.snap?.stats?.status === STATUS.ERROR
+      )
+    }
+  },
+  not_mining_type_cnt: {
+    op: 'group_cnt',
+    group: groupBy('type'),
+    filter: (entry) => {
+      return (
+        entry?.info?.container !== MAINTENANCE &&
+        entry?.last?.snap?.stats?.status === STATUS.NOT_MINING
+      )
+    }
+  },
+  power_mode_sleep_type_cnt: {
+    op: 'group_cnt',
+    group: groupBy('type'),
+    filter: (entry) => {
+      return entry?.last?.snap?.stats?.status === STATUS.SLEEPING
+    }
+  },
+  power_mode_low_type_cnt: {
+    op: 'group_cnt',
+    group: groupBy('type'),
+    filter: (entry) => {
+      return entry?.last?.snap?.stats?.status === STATUS.MINING && entry?.last?.snap?.config?.power_mode === POWER_MODE.LOW
+    }
+  },
+  power_mode_normal_type_cnt: {
+    op: 'group_cnt',
+    group: groupBy('type'),
+    filter: (entry) => {
+      return entry?.last?.snap?.stats?.status === STATUS.MINING && entry?.last?.snap?.config?.power_mode === POWER_MODE.NORMAL
+    }
+  },
+  power_mode_high_type_cnt: {
+    op: 'group_cnt',
+    group: groupBy('type'),
+    filter: (entry) => {
+      return entry?.last?.snap?.stats?.status === STATUS.MINING && entry?.last?.snap?.config?.power_mode === POWER_MODE.HIGH
+    }
+  },
+  hashrate_mhs_1m_type_group_sum: {
+    op: 'group_sum',
+    src: 'last.snap.stats.hashrate_mhs.t_5m',
+    group: groupBy('type'),
+    filter: (entry) => {
+      return entry?.info?.container !== MAINTENANCE
+    }
+  },
+  hashrate_mhs_1m_type_group_avg: {
+    op: 'group_avg',
+    src: 'last.snap.stats.hashrate_mhs.t_5m',
+    group: groupBy('type')
+  },
+  efficiency_w_ths_type_group_avg: {
+    op: 'group_avg',
+    src: 'last.snap.stats.efficiency_w_ths',
+    group: groupBy('type')
+  },
+  hashrate_mhs_1m_container_group_sum: {
+    op: 'group_sum',
+    src: 'last.snap.stats.hashrate_mhs.t_5m',
+    group: groupBy('info.container')
+  },
+  hashrate_mhs_1m_container_group_avg: {
+    op: 'group_avg',
+    src: 'last.snap.stats.hashrate_mhs.t_5m',
+    group: groupBy('info.container')
+  },
+  efficiency_w_ths_container_group_avg: {
+    op: 'group_avg',
+    src: 'last.snap.stats.efficiency_w_ths',
+    group: groupBy('info.container')
+  },
+  hashrate_mhs_5m_active_container_group_cnt: {
+    op: 'group_cnt',
+    group: groupBy('info.container'),
+    filter: (entry) => entry?.last?.snap?.stats?.hashrate_mhs?.t_5m
+  },
+  nominal_hashrate_mhs_avg: {
+    op: 'avg',
+    src: 'info.nominalHashrateMhs'
+  },
+  nominal_efficiency_w_ths_avg: {
+    op: 'avg',
+    src: 'last.snap.stats.nominal_efficiency_w_ths'
+  },
+  nominal_hashrate_mhs_sum: {
+    op: 'sum',
+    src: 'info.nominalHashrateMhs'
+  },
+  nominal_efficiency_w_ths_sum: {
+    op: 'sum',
+    src: 'last.snap.stats.nominal_efficiency_w_ths'
+  },
+  hashrate_mhs_5m_sum: {
+    op: 'sum',
+    src: 'last.snap.stats.hashrate_mhs.t_5m'
+  },
+  hashrate_mhs_5m_avg: {
+    op: 'avg',
+    src: 'last.snap.stats.hashrate_mhs.t_5m'
+  },
+  hashrate_mhs_5m_cnt: {
+    op: 'cnt',
+    src: 'last.snap.stats.hashrate_mhs.t_5m'
+  },
+  hashrate_mhs_5m_cnt_active: {
+    op: 'cnt',
+    src: 'last.snap.stats.hashrate_mhs.t_5m',
+    filter: function (entry) {
+      return entry?.last?.snap?.stats?.status === STATUS.MINING
+    }
+  },
+  hashrate_mhs_5m_type_group_sum: {
+    op: 'group_sum',
+    src: 'last.snap.stats.hashrate_mhs.t_5m',
+    group: groupBy('type')
+  },
+  hashrate_mhs_5m_type_group_avg: {
+    op: 'group_avg',
+    src: 'last.snap.stats.hashrate_mhs.t_5m',
+    group: groupBy('type')
+  },
+  hashrate_mhs_5m_container_group_sum: {
+    op: 'group_sum',
+    src: 'last.snap.stats.hashrate_mhs.t_5m',
+    group: groupBy('info.container')
+  },
+  hashrate_mhs_5m_container_group_avg: {
+    op: 'group_avg',
+    src: 'last.snap.stats.hashrate_mhs.t_5m',
+    group: groupBy('info.container')
+  },
+  miner_inventory_status_group_cnt: {
+    op: 'group_cnt',
+    group: groupBy('info.status')
+  },
+  miner_inventory_location_group_cnt: {
+    op: 'group_cnt',
+    group: groupBy('info.location')
+  }
+}
+
+const CONTAINER_DEFAULT_OPS = {
+  ...DEFAULT_OPS,
+  container_status: {
+    op: 'group',
+    src: 'last.snap.stats.status',
+    group: groupBy('info.container')
+  },
+  container_power_w_sum: {
+    op: 'sum',
+    src: 'last.snap.stats.power_w'
+  },
+  container_power_w: {
+    op: 'group',
+    src: 'last.snap.stats.power_w',
+    group: groupBy('info.container')
+  },
+  container_nominal_hashrate_mhs_sum: {
+    op: 'sum',
+    src: 'info.nominalHashrateMhs'
+  },
+  container_nominal_hashrate_mhs_avg: {
+    op: 'avg',
+    src: 'info.nominalHashrateMhs'
+  },
+  container_nominal_efficiency_w_ths_avg: {
+    op: 'avg',
+    src: 'info.nominalEfficiencyWThs'
+  },
+  container_nominal_miner_capacity_sum: {
+    op: 'sum',
+    src: 'info.nominalMinerCapacity'
+  }
+}
+
+module.exports = {
+  conf: CONF,
+  minerConf: MINER_CONF,
+  specs: {
+    default: { ops: DEFAULT_OPS },
+    miner_default: { ops: MINER_DEFAULT_OPS },
+    container_default: { ops: CONTAINER_DEFAULT_OPS },
+    powermeter_default: { ops: DEFAULT_OPS },
+    sensor_default: { ops: DEFAULT_OPS }
+  }
+}

package/lib/things/constants.js

@@ -0,0 +1,65 @@
+'use strict'
+
+const STAT_RTD = 'stat-rtd'
+const MAIN_DB = 'main'
+
+const TIME_PERIODS_MS = {
+  H: 60 * 60 * 1000,
+  D: 24 * 60 * 60 * 1000,
+  W: 7 * 24 * 60 * 60 * 1000,
+  M: 30 * 24 * 60 * 60 * 1000
+}
+
+const OPTIONAL_CONFIGS = []
+const RPC_METHODS = {}
+
+const MAINTENANCE = 'maintenance'
+
+const STATUS = {
+  OFFLINE: 'offline',
+  SLEEPING: 'sleeping',
+  MINING: 'mining',
+  ERROR: 'error',
+  NOT_MINING: 'not_mining'
+}
+
+const POWER_MODE = {
+  LOW: 'low',
+  NORMAL: 'normal',
+  HIGH: 'high',
+  SLEEP: 'sleep'
+}
+
+const DEFAULT_THRESHOLD_HASHRATE = 50000000
+
+const STAT_SHARES_1M = 'stat-shares-1m'
+const STAT_SHARES_30M = 'stat-shares-30m'
+const STAT_30M = 'stat-30m'
+const MINER_TAG = 't-miner'
+const STAT_STARTUP_STATUS = 'stat-startup'
+const STAT_5M = 'stat-5m'
+
+const RUNNING_STATUS = {
+  RUNNING: 'running',
+  STOPPED: 'stopped',
+  ERROR: 'error'
+}
+
+module.exports = {
+  STAT_RTD,
+  OPTIONAL_CONFIGS,
+  RPC_METHODS,
+  MAIN_DB,
+  TIME_PERIODS_MS,
+  MAINTENANCE,
+  POWER_MODE,
+  STATUS,
+  DEFAULT_THRESHOLD_HASHRATE,
+  STAT_SHARES_1M,
+  STAT_SHARES_30M,
+  STAT_30M,
+  MINER_TAG,
+  STAT_STARTUP_STATUS,
+  STAT_5M,
+  RUNNING_STATUS
+}

package/lib/things/container.js

@@ -0,0 +1,84 @@
+'use strict'
+
+const Thing = require('./thing')
+
+class Container extends Thing {
+  constructor (opts = {}) {
+    super('container', opts)
+  }
+
+  // Container write action validator
+  validateWriteAction (...params) {
+    const [action, ...args] = params
+
+    if (action === 'switchContainer') {
+      const [enabled] = args
+      if (typeof enabled !== 'boolean') {
+        throw new Error('ERR_SWITCH_CONTAINER_ENABLED_INVALID')
+      }
+    }
+
+    if (action === 'switchSocket') {
+      if (Array.isArray(args[0])) {
+        args[0].forEach((arg) => {
+          const [pduIndex, socketIndex, enabled] = arg
+
+          if (typeof pduIndex !== 'string') {
+            throw new Error('ERR_SWITCH_SOCKET_PDU_INDEX_INVALID')
+          }
+          if (typeof socketIndex !== 'string') {
+            throw new Error('ERR_SWITCH_SOCKET_SOCKET_INDEX_INVALID')
+          }
+          if (typeof enabled !== 'boolean') {
+            throw new Error('ERR_SWITCH_SOCKET_ENABLED_INVALID')
+          }
+        })
+      } else {
+        throw new Error('ERR_SWITCH_SOCKET_ARGS_INVALID')
+      }
+    }
+
+    if (action === 'switchCoolingSystem') {
+      const [enabled] = args
+      if (typeof enabled !== 'boolean') {
+        throw new Error('ERR_SWITCH_COOLING_SYSTEM_ENABLED_INVALID')
+      }
+    }
+
+    return 1
+  }
+
+  async turnOnContainer (cooling, devices) {
+    throw new Error('ERR_NO_IMPL')
+  }
+
+  async turnOffContainer () {
+    throw new Error('ERR_NO_IMPL')
+  }
+
+  async switchContainer (enabled) {
+    throw new Error('ERR_NO_IMPL')
+  }
+
+  async switchCoolingSystem (enabled) {
+    throw new Error('ERR_NO_IMPL')
+  }
+
+  async switchSocket (args) {
+    throw new Error('ERR_NO_IMPL')
+  }
+
+  async turnOnCoolingSystem () {
+    throw new Error('ERR_NO_IMPL')
+  }
+
+  async turnOffCoolingSystem () {
+    throw new Error('ERR_NO_IMPL')
+  }
+
+  async resetAlarm () {
+    throw new Error('ERR_NO_IMPL')
+  }
+}
+
+module.exports = Container