@exodus/market-history 3.1.2 → 4.0.1

package/CHANGELOG.md

@@ -3,6 +3,22 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [4.0.1](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/market-history@4.0.0...@exodus/market-history@4.0.1) (2023-07-05)
+
+### Bug Fixes
+
+- **market-history:** publish atoms dir ([#2287](https://github.com/ExodusMovement/exodus-hydra/issues/2287)) ([17349b1](https://github.com/ExodusMovement/exodus-hydra/commit/17349b1a1183598d5ee6033c0bbe7e7b9e56ceaa))
+
+## [4.0.0](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/market-history@3.1.2...@exodus/market-history@4.0.0) (2023-07-05)
+
+### ⚠ BREAKING CHANGES
+
+- market-history atom (#2160)
+
+### Features
+
+- market-history atom ([#2160](https://github.com/ExodusMovement/exodus-hydra/issues/2160)) ([b74364a](https://github.com/ExodusMovement/exodus-hydra/commit/b74364a47e8a51b3eea6b8cc870c731def65726b))
+
 ## [3.1.2](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/market-history@3.1.1...@exodus/market-history@3.1.2) (2023-06-21)
 
 **Note:** Version bump only for package @exodus/market-history

package/README.md

@@ -1,7 +1,11 @@
 # @exodus/market-history
 
-module fetches daily and hourly historical prices for assets by interval
-returns prices on interval `close`.
+module fetches daily and hourly historical prices for assets by interval.
+Return prices on interval `close`.
+
+Public methods:
+`start` - starts monitor
+`update` update prices by granularity (day|hour) manually
 
 ## Install
 
@@ -16,44 +20,40 @@ import createMarketHistoryMonitor from '@exodus/market-history/module'
 
 const marketHistoryMonitor = createMarketHistoryMonitor.factory({
   assetsModule,
-  currencyAtom,
   storage: marketHistoryStorage,
+  currencyAtom,
   pricingClient,
   getCacheKey: ({ currency, assetName, granularity }) =>
     `prices-${currency}-${assetName}-${granularity}`, // optional
-  remoteConfigRefreshIntervalAtom, // optional
+  remoteConfigRefreshIntervalAtom, // optional. stores interval in ms. if defined we compare distance in ms from previous fetch and if it's larger than defined in this atom we ignore cache.
   clearCacheAtom, // optional. set value if you want to clear cache.
   remoteConfigClearCacheAtom, // optional. If you want to clear cache set any value in this atom.
+  enabledAssetsAtom, // we fetch prices only for enabled assets
+  marketHistoryAtom, // data stored here
 })
 
-// returns market history for all enabled assets
-marketHistoryMonitor.on('market-history', ({ currency, granularity, prices }) => {
-  // `currency` USD
-  // `granularity` daily|hourly
-  // prices
-  // {
-  //   bitcoin: {
-  //     1663668000000: 90000,
-  //     1663671600000: 120000,
-  //     1663675200000: 100000000,
-  //   }
-  // }
-})
-
-// returns prices when list of enabled changes, only for these assets
-marketHistoryMonitor.on('market-history-new-assets', ({ currency, granularity, prices }) => {
-  // `currency` USD
-  // `granularity` daily|hourly
-  // prices
-  // {
-  //   bitcoin: {
-  //     1663668000000: 90000,
-  //     1663671600000: 120000,
-  //     1663675200000: 100000000,
-  //   }
-  // }
-})
+// stores market history in marketHistoryAtom in following format
+// marketHistoryAtom.get()
+// {
+//     data: {
+//         USD: {
+//             daily: {
+//                 bitcoin: {
+//                     1663668000000: 90000,
+//                 }
+//             }
+//         }
+//     },
+//     changes: {
+//         USD: {
+//             daily: {
+//                 bitcoin: {
+//                     1663671600000: 9000,
+//                 }
+//             }
+//         }
+//     }
+// }
 
 marketHistoryMonitor.start()
-marketHistoryMonitor.sync() // force to emit prices
 ```

package/atoms/index.js

@@ -0,0 +1,8 @@
+import { createInMemoryAtom } from '@exodus/atoms'
+
+export const marketHistoryAtomDefinition = {
+  id: 'marketHistoryAtom',
+  type: 'atom',
+  factory: () => createInMemoryAtom({}),
+  dependencies: [],
+}

package/module/index.js

@@ -19,6 +19,19 @@ const transformPriceEntries = (entries = []) => {
 const transformPricesByAssetName = (pricesByAssetName) =>
   mapValues(pricesByAssetName, (entries) => transformPriceEntries(entries))
 
+const mergePricesInAtom = ({ prices, atomData, parsedGranularity, currency }) => {
+  return {
+    ...atomData,
+    [currency]: {
+      ...atomData[currency],
+      [parsedGranularity]: {
+        ...atomData[currency]?.[parsedGranularity],
+        ...prices,
+      },
+    },
+  }
+}
+
 // when provided cache version from local or remote config is different from stored on device we clear the cache and fetch new prices
 const _invalidateStorageCache = async ({
   storage,
@@ -64,7 +77,9 @@ class MarketHistoryMonitor extends ExodusModule {
   #clearCacheAtom = null
   #remoteConfigClearCacheAtom = null
   #runtimeCache = new Map()
+  #marketHistoryAtom = null
   #enabledAssetsAtom = null
+  #logger = null
 
   constructor({
     assetsModule,
@@ -76,6 +91,8 @@ class MarketHistoryMonitor extends ExodusModule {
     clearCacheAtom = createInMemoryAtom({ defaultValue: null }),
     remoteConfigClearCacheAtom = createInMemoryAtom({ defaultValue: null }),
     enabledAssetsAtom,
+    marketHistoryAtom,
+    logger,
   }) {
     super({ name: 'MarketHistoryMonitor' })
 
@@ -88,6 +105,8 @@ class MarketHistoryMonitor extends ExodusModule {
     this.#remoteConfigClearCacheAtom = remoteConfigClearCacheAtom
     this.#currencyAtom = currencyAtom
     this.#enabledAssetsAtom = enabledAssetsAtom
+    this.#marketHistoryAtom = marketHistoryAtom
+    this.#logger = logger
   }
 
   #started = false
@@ -201,9 +220,17 @@ class MarketHistoryMonitor extends ExodusModule {
         granularity,
         assetNames,
       })
-      this.emit('market-history', { currency, granularity: parsedGranularity, prices })
+
+      await this.#marketHistoryAtom.set(async (current) => ({
+        data: mergePricesInAtom({
+          prices,
+          atomData: current?.data ?? {},
+          currency,
+          parsedGranularity,
+        }),
+      }))
     } catch (error) {
-      console.error(
+      this.#logger.error(
         'MarketHistoryMonitor: Failed to fetch rates',
         assetNames,
         currency,
@@ -222,14 +249,13 @@ class MarketHistoryMonitor extends ExodusModule {
     const currency = this.#currency
 
     try {
-      const prices = await this.#fetch({
+      return await this.#fetch({
         currency,
         granularity,
         assetNames,
       })
-      this.emit('market-history-new-assets', { currency, granularity: parsedGranularity, prices })
     } catch (error) {
-      console.error(
+      this.#logger.error(
         'MarketHistoryMonitor: Failed to fetch rates for assets',
         assetNames,
         currency,
@@ -238,34 +264,56 @@ class MarketHistoryMonitor extends ExodusModule {
       )
     }
   }
-  #updateNewAssets = (assetNames) => {
-    return Promise.all([
-      this.#updateAssets('hour', assetNames),
-      this.#updateAssets('day', assetNames),
-    ])
-  }
-  #syncGranularity = async (granularity) => {
-    const parsedGranularity = parseGranularity(granularity)
+  #updateNewAssets = async (assetNames) => {
     const currency = this.#currency
-    const enabledAssets = await this.#enabledAssetsAtom.get()
 
-    const cachedPricesByAssetName = Object.fromEntries(
-      Object.keys(enabledAssets).map((assetName) => {
-        const key = this.#getCacheKey({ currency, assetName, granularity })
-        return [assetName, this.#runtimeCache.get(key)]
-      })
-    )
+    const granularities = ['hour', 'day']
 
-    const prices = transformPricesByAssetName(cachedPricesByAssetName)
-    this.emit('market-history', { currency, granularity: parsedGranularity, prices })
-  }
+    const promises = granularities.map((granularity) => this.#updateAssets(granularity, assetNames))
+
+    const results = await Promise.all(promises)
+    let changes = {}
+    const updateChanges = ({ prices, granularity }) => {
+      changes = {
+        ...changes,
+        [currency]: {
+          ...changes[currency],
+          [granularity]: prices,
+        },
+      }
+    }
 
-  sync = async () => {
-    this.#syncGranularity('day')
-    this.#syncGranularity('hour')
+    granularities.forEach((granularity, index) => {
+      const result = results[index]
+      if (result) {
+        updateChanges({ prices: result, granularity: parseGranularity(granularity) })
+      }
+    })
+
+    if (Object.keys(changes).length > 0) {
+      await this.#marketHistoryAtom.set((current) => {
+        let data = current?.data ?? {}
+        granularities.forEach((granularity, index) => {
+          const result = results[index]
+          if (result) {
+            data = mergePricesInAtom({
+              prices: result,
+              atomData: data,
+              currency,
+              parsedGranularity: parseGranularity(granularity),
+            })
+          }
+        })
+
+        return {
+          data,
+          changes,
+        }
+      })
+    }
   }
 
-  invalidateStorage = async ({ remoteConfigClearCacheVersion }) => {
+  #invalidateStorage = async ({ remoteConfigClearCacheVersion }) => {
     const clearCacheVersion = await this.#clearCacheAtom.get() // don't think we need to observe it considering this runs only on startup and set manually in config
     return _invalidateStorageCache({
       storage: this.storage,
@@ -280,7 +328,7 @@ class MarketHistoryMonitor extends ExodusModule {
   #listenRemoteConfigClearCacheVersionChanges = () => {
     difference(this.#remoteConfigClearCacheAtom).observe(async ({ current, previous }) => {
       if (previous !== undefined && current !== previous) {
-        await this.invalidateStorage({ remoteConfigClearCacheVersion: current })
+        await this.#invalidateStorage({ remoteConfigClearCacheVersion: current })
         await this.#updateAll()
       }
     })
@@ -309,14 +357,13 @@ class MarketHistoryMonitor extends ExodusModule {
 
   start = async () => {
     if (this.#started) {
-      await this.sync()
       return
     }
 
     this.#started = true
 
     const remoteConfigClearCacheVersion = await this.#remoteConfigClearCacheAtom.get()
-    await this.invalidateStorage({ remoteConfigClearCacheVersion })
+    await this.#invalidateStorage({ remoteConfigClearCacheVersion })
     this.#listenRemoteConfigClearCacheVersionChanges()
 
     const combinedAtom = combine({
@@ -364,5 +411,6 @@ export default {
     'remoteConfigClearCacheAtom',
     'remoteConfigRefreshIntervalAtom',
     'enabledAssetsAtom',
+    'marketHistoryAtom',
   ],
 }

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@exodus/market-history",
-  "version": "3.1.2",
-  "description": "module to fetch historical prices for assets",
-  "author": "Exodus Movement Inc",
+  "version": "4.0.1",
+  "description": "Fetches historical prices for assets",
+  "author": "Exodus Movement Inc.",
   "license": "UNLICENSED",
   "scripts": {
     "lint": "eslint . --ignore-path ../../.gitignore",
@@ -11,10 +11,11 @@
   },
   "files": [
     "module",
+    "atoms",
     "utils.js",
     "CHANGELOG.md",
     "README.md",
-    "!**/__tests__"
+    "!**/__tests__/**"
   ],
   "dependencies": {
     "@exodus/basic-utils": "^2.0.0",
@@ -25,7 +26,7 @@
   "devDependencies": {
     "@exodus/assets": "^8.0.88",
     "@exodus/assets-base": "^8.1.6",
-    "@exodus/atoms": "^5.0.0",
+    "@exodus/atoms": "^5.2.1",
     "@exodus/storage-memory": "^2.1.0",
     "eslint": "^8.33.0",
     "events": "^3.3.0",
@@ -34,5 +35,13 @@
   "peerDependencies": {
     "debug": ">= 3.0.0"
   },
-  "gitHead": "f0a3d249bf994a6d5c106a106b5e4b2b6c61a6e8"
+  "homepage": "https://github.com/ExodusMovement/exodus-hydra/tree/master/modules/crypto-news-monitor",
+  "bugs": {
+    "url": "https://github.com/ExodusMovement/exodus-hydra/issues?q=is%3Aissue+is%3Aopen+label%3Crypto-news-monitor"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ExodusMovement/exodus-hydra.git"
+  },
+  "gitHead": "07ccaeaebac57e34e8162bae3ecfa2e98c216469"
 }