@exodus/balances 1.1.1 → 1.2.0

package/README.md

@@ -0,0 +1,57 @@
+# @exodus/balances
+
+This module tracks balances across assets and portfolios. It delegates to assets for any asset-specifics.
+
+## WARNING: no asset specifics!
+
+If you introduce any asset specifics like `if (assetName === 'dogicorn') balance = balance.mul(2)`, you will be fired immediately. This is a safety measure to save you from @feri42's wrath. All asset-specifics belong in `asset.api.getBalances` or other APIs inside the asset libraries.
+
+## Install
+
+```sh
+yarn add @exodus/balances
+```
+
+## Usage
+
+```js
+import createBalances from '@exodus/balances'
+
+const balances = createBalances({
+  // see #/assets-module in exodus-browser or tests for the API
+  assetsModule,
+  // pushes data of the form `{ [walletAccount]: WalletAccount }`
+  walletAccountsAtom,
+  // @exodus/blockchain-metadata instance
+  blockchainMetadata,
+  // the types of balances supported may change. For now it's just the total balance
+  balanceFields: ['balance'],
+  // see ../modules/module/src/logger.js for API
+  logger,
+})
+
+balances.on('balances', ({ balances, oldBalances, changes }) => {
+  // `balances`, `oldBalances`
+  // {
+  //   [walletAccount]: {
+  //     [assetName]: {
+  //       [balanceField]: NumberUnit
+  //     }
+  //   }
+  // }
+  //
+  // `changes`
+  // {
+  //   [walletAccount]: {
+  //     [assetName]: {
+  //       [balanceField]: {
+  //         from: NumberUnit,
+  //         to: NumberUnit,
+  //       }
+  //     }
+  //   }
+  // }
+})
+
+balances.sync() // forces 'balances' event emission
+```

package/index.js

@@ -41,27 +41,44 @@ class Balances extends ExodusModule {
 
     // these share a queue
     this.#updateAssetSource = shareQueue(this.#updateAssetSource)
+    this.#handleTxLogUpdate = shareQueue(this.#handleTxLogUpdate)
     this.#recompute = shareQueue(this.#recompute)
 
-    blockchainMetadata.on('account-state', async (opts) => {
-      return this.#updateAssetSource(opts)
-    })
-
-    blockchainMetadata.on('tx-log', async (opts) => {
-      if (this.#isHistoryBasedBalanceAsset(opts.assetName)) return this.#updateAssetSource(opts)
-    })
-
-    walletAccountsAtom.observe((payload) =>
-      this.#setWalletAccounts(
-        Object.keys(payload).filter((walletAccount) => payload[walletAccount].enabled)
+    blockchainMetadata.on('loaded', () => {
+      walletAccountsAtom.observe((payload) =>
+        this.#setWalletAccounts(
+          Object.keys(payload).filter((walletAccount) => payload[walletAccount].enabled)
+        )
       )
-    )
+      blockchainMetadata.on('account-state', this.#handleAccountStateUpdate)
+      blockchainMetadata.on('tx-log', this.#handleTxLogUpdate)
+    })
 
     assetsModule.on('assets-add', this.#onAssetsChanged)
   }
 
   #getAsset = (assetName) => this.#assetsModule.getAsset(assetName)
 
+  #handleAccountStateUpdate = async (opts) => {
+    if (!this.#ready) {
+      this._logger.log(`ignore update from account-state event.`, {
+        isReady: this.#ready,
+      })
+      return
+    }
+    return this.#updateAssetSource(opts)
+  }
+
+  #handleTxLogUpdate = (opts) => {
+    if (!this.#ready) {
+      this._logger.log(`ignore update from tx-log event.`, {
+        isReady: this.#ready,
+      })
+      return
+    }
+    if (this.#isHistoryBasedBalanceAsset(opts.assetName)) return this.#updateAssetSource(opts)
+  }
+
   #pushIntoSharedQueue = makeConcurrent((fn) => fn(), { concurrency: 1 })
 
   #reset = ({ walletAccounts = this.#walletAccounts } = {}) => {
@@ -216,10 +233,12 @@ class Balances extends ExodusModule {
   }
 
   sync = ({ changes } = {}) => {
-    this._logger.log('balances updated')
-
     const oldBalances = this.#oldBalances
     const balances = cloneBalances(this.#balances)
+
+    if (Object.keys(balances).length === 0) return // wait till `load` finished
+
+    this._logger.log('balances updated')
     this.emit('balances', {
       balances,
       oldBalances,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/balances",
-  "version": "1.1.1",
+  "version": "1.2.0",
   "description": "balances",
   "author": "Exodus Movement Inc",
   "license": "UNLICENSED",
@@ -31,5 +31,5 @@
     "@exodus/basic-utils": "^1.0.0",
     "@exodus/models": "^8.9.0"
   },
-  "gitHead": "cbca7f075af27af557d498dc6dc74f61909434ad"
+  "gitHead": "e99b34358ce40fe70ce2a9cb09c622582d0503c9"
 }