@exodus/balances

@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

yarn add @exodus/balances

Usage

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