@talismn/balances 0.0.0-pr709-20230418130154 → 0.0.0-pr716-20230419110638

package/CHANGELOG.md

@@ -1,16 +1,23 @@
 # @talismn/balances
 
-## 0.0.0-pr709-20230418130154
+## 0.0.0-pr716-20230419110638
 
 ### Patch Changes
 
 - fb8ee962: feat: proxy dapp websocket requests to talisman wallet backend when available
+- f7aca48b: eslint rules
+- 01bf239b: feat: crowdloan and nom pool balances
+- 01bf239b: fix: packages publishing with incorrect interdependency versions
 - Updated dependencies [fb8ee962]
 - Updated dependencies [c898da98]
-  - @talismn/chain-connector@0.0.0-pr709-20230418130154
-  - @talismn/chain-connector-evm@0.0.0-pr709-20230418130154
-  - @talismn/chaindata-provider@0.0.0-pr709-20230418130154
-  - @talismn/token-rates@0.0.0-pr709-20230418130154
+- Updated dependencies [f7aca48b]
+- Updated dependencies [01bf239b]
+- Updated dependencies [01bf239b]
+  - @talismn/chain-connector@0.0.0-pr716-20230419110638
+  - @talismn/chain-connector-evm@0.0.0-pr716-20230419110638
+  - @talismn/chaindata-provider@0.0.0-pr716-20230419110638
+  - @talismn/token-rates@0.0.0-pr716-20230419110638
+  - @talismn/util@0.0.0-pr716-20230419110638
 
 ## 0.4.0
 

package/dist/declarations/src/helpers.d.ts

@@ -1,4 +1,5 @@
 import type { Registry } from "@polkadot/types-codec/types";
+import { ChainConnector } from "@talismn/chain-connector";
 import { ChainId } from "@talismn/chaindata-provider";
 import { BalanceModule, DefaultChainMeta, DefaultModuleConfig, DefaultTransferParams, ExtendableChainMeta, ExtendableModuleConfig, ExtendableTokenType, ExtendableTransferParams } from "./BalanceModule";
 import { AddressesByToken, Balance, BalanceJson, Balances, SubscriptionCallback, UnsubscribeFn } from "./types";
@@ -8,8 +9,9 @@ import { AddressesByToken, Balance, BalanceJson, Balances, SubscriptionCallback,
  */
 export declare function balances<TModuleType extends string, TTokenType extends ExtendableTokenType, TChainMeta extends ExtendableChainMeta = DefaultChainMeta, TModuleConfig extends ExtendableModuleConfig = DefaultModuleConfig, TTransferParams extends ExtendableTransferParams = DefaultTransferParams>(balanceModule: BalanceModule<TModuleType, TTokenType, TChainMeta, TModuleConfig, TTransferParams>, addressesByToken: AddressesByToken<TTokenType>): Promise<Balances>;
 export declare function balances<TModuleType extends string, TTokenType extends ExtendableTokenType, TChainMeta extends ExtendableChainMeta = DefaultChainMeta, TModuleConfig extends ExtendableModuleConfig = DefaultModuleConfig, TTransferParams extends ExtendableTransferParams = DefaultTransferParams>(balanceModule: BalanceModule<TModuleType, TTokenType, TChainMeta, TModuleConfig, TTransferParams>, addressesByToken: AddressesByToken<TTokenType>, callback: SubscriptionCallback<Balances>): Promise<UnsubscribeFn>;
+export type GetOrCreateTypeRegistry = (chainId: ChainId, metadataRpc?: `0x${string}`) => Registry;
 export declare const createTypeRegistryCache: () => {
-    getOrCreateTypeRegistry: (chainId: ChainId, metadataRpc?: `0x${string}`) => Registry;
+    getOrCreateTypeRegistry: GetOrCreateTypeRegistry;
 };
 export declare const filterMirrorTokens: (balance: Balance, i: number, balances: Balance[]) => boolean;
 export declare const getValidSubscriptionIds: () => Set<string>;
@@ -33,3 +35,20 @@ export declare class StorageHelper {
     tag(tags: any): this;
     decode(input?: string | null): import("@polkadot/types-codec/types").Codec | undefined;
 }
+/**
+ * Pass some these into an `RpcStateQueryHelper` in order to easily batch multiple state queries into the one rpc call.
+ */
+export type RpcStateQuery<T> = {
+    chainId: string;
+    stateKey: string;
+    decodeResult: (change: string | null) => T;
+};
+/**
+ * Used by a variety of balance modules to help batch multiple state queries into the one rpc call.
+ */
+export declare class RpcStateQueryHelper<T> {
+    #private;
+    constructor(chainConnector: ChainConnector, queries: Array<RpcStateQuery<T>>);
+    subscribe(callback: SubscriptionCallback<T[]>, timeout?: number | false, subscribeMethod?: string, responseMethod?: string, unsubscribeMethod?: string): Promise<UnsubscribeFn>;
+    fetch(method?: string): Promise<T[]>;
+}

package/dist/declarations/src/types/balances.d.ts

@@ -61,6 +61,19 @@ export declare class Balances {
      * @returns All balances which match the query.
      */
     find: (query: BalanceSearchQuery | BalanceSearchQuery[]) => Balances;
+    /**
+     * Filters this collection to exclude token balances where the token has a `mirrorOf` field
+     * and another balance exists in this collection for the token specified by the `mirrorOf` field.
+     */
+    filterMirrorTokens: () => Balances;
+    /**
+     * Filters this collection to only include balances which are not zero.
+     */
+    filterNonZero: (type: "total" | "free" | "reserved" | "locked" | "frozen" | "transferable" | "feePayable") => Balances;
+    /**
+     * Filters this collection to only include balances which are not zero AND have a fiat conversion rate.
+     */
+    filterNonZeroFiat: (type: "total" | "free" | "reserved" | "locked" | "frozen" | "transferable" | "feePayable", currency: TokenRateCurrency) => Balances;
     /**
      * Add some balances to this collection.
      * Added balances take priority over existing balances.
@@ -134,9 +147,21 @@ export declare class Balance {
     get free(): BalanceFormatter;
     /** The reserved balance of this token. Is included in the total. */
     get reserved(): BalanceFormatter;
+    get reserves(): {
+        amount: BalanceFormatter;
+        label: string;
+        meta?: unknown;
+    }[];
     /** The frozen balance of this token. Is included in the free amount. */
     get locked(): BalanceFormatter;
-    /** @depreacted - use balance.locked */
+    get locks(): {
+        amount: BalanceFormatter;
+        label: string;
+        meta?: unknown;
+        includeInTransferable?: boolean | undefined;
+        excludeFromFeePayable?: boolean | undefined;
+    }[];
+    /** @deprecated Use balance.locked */
     get frozen(): BalanceFormatter;
     /** The transferable balance of this token. Is generally the free amount - the miscFrozen amount. */
     get transferable(): BalanceFormatter;
@@ -151,6 +176,26 @@ export declare class BalanceFormatter {
     get tokens(): string;
     fiat(currency: TokenRateCurrency): number | null;
 }
+export declare class PlanckSumBalancesFormatter {
+    #private;
+    constructor(balances: Balances);
+    /**
+     * The total balance of these tokens. Includes the free and the reserved amount.
+     */
+    get total(): bigint;
+    /** The non-reserved balance of these tokens. Includes the frozen amount. Is included in the total. */
+    get free(): bigint;
+    /** The reserved balance of these tokens. Is included in the total. */
+    get reserved(): bigint;
+    /** The frozen balance of these tokens. Is included in the free amount. */
+    get locked(): bigint;
+    /** @deprecated Use balances.locked */
+    get frozen(): bigint;
+    /** The transferable balance of these tokens. Is generally the free amount - the miscFrozen amount. */
+    get transferable(): bigint;
+    /** The feePayable balance of these tokens. Is generally the free amount - the feeFrozen amount. */
+    get feePayable(): bigint;
+}
 export declare class FiatSumBalancesFormatter {
     #private;
     constructor(balances: Balances, currency: TokenRateCurrency);
@@ -164,7 +209,7 @@ export declare class FiatSumBalancesFormatter {
     get reserved(): number;
     /** The frozen balance of these tokens. Is included in the free amount. */
     get locked(): number;
-    /** @deprecated - use balances.locked */
+    /** @deprecated Use balances.locked */
     get frozen(): number;
     /** The transferable balance of these tokens. Is generally the free amount - the miscFrozen amount. */
     get transferable(): number;
@@ -174,5 +219,6 @@ export declare class FiatSumBalancesFormatter {
 export declare class SumBalancesFormatter {
     #private;
     constructor(balances: Balances);
+    get planck(): PlanckSumBalancesFormatter;
     fiat(currency: TokenRateCurrency): FiatSumBalancesFormatter;
 }

package/dist/declarations/src/types/balancetypes.d.ts

@@ -30,6 +30,11 @@ export type BalanceStatus = BalanceStatusLive | "live" | "cache" | "stale";
 export type IBalance = {
     /** The module that this balance was retrieved by */
     source: string;
+    /**
+     * For modules which fetch balances via module sources, this is the sub-source
+     * e.g. `staking` or `crowdloans`
+     **/
+    subSource?: string;
     /** Has this balance never been fetched, or is it from a cache, or is it up to date? */
     status: BalanceStatus;
     /** The address of the account which owns this balance */
@@ -59,6 +64,7 @@ export type Amount = string;
 export type AmountWithLabel<TLabel extends string> = {
     label: TLabel;
     amount: Amount;
+    meta?: unknown;
 };
 /** A labelled locked amount of a balance */
 export type LockedAmount<TLabel extends string> = AmountWithLabel<TLabel> & {

package/dist/talismn-balances.cjs.dev.js

@@ -4,11 +4,13 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var dexie = require('dexie');
 var types = require('@polkadot/types');
-var anylogger = require('anylogger');
 var util = require('@talismn/util');
+var groupBy = require('lodash/groupBy');
+var anylogger = require('anylogger');
 
 function _interopDefault (e) { return e && e.__esModule ? e : { 'default': e }; }
 
+var groupBy__default = /*#__PURE__*/_interopDefault(groupBy);
 var anylogger__default = /*#__PURE__*/_interopDefault(anylogger);
 
 // TODO: Document default balances module purpose/usage
@@ -67,7 +69,7 @@ const db = new TalismanBalancesDatabase();
 
 var packageJson = {
 	name: "@talismn/balances",
-	version: "0.0.0-pr709-20230418130154",
+	version: "0.0.0-pr716-20230419110638",
 	author: "Talisman",
 	homepage: "https://talisman.xyz",
 	license: "UNLICENSED",
@@ -90,30 +92,32 @@ var packageJson = {
 	},
 	scripts: {
 		test: "jest",
-		lint: "eslint . --max-warnings 0",
+		lint: "eslint src --max-warnings 0",
 		clean: "rm -rf dist && rm -rf .turbo rm -rf node_modules"
 	},
 	dependencies: {
-		"@talismn/chain-connector": "workspace:^",
-		"@talismn/chain-connector-evm": "workspace:^",
-		"@talismn/chaindata-provider": "workspace:^",
-		"@talismn/token-rates": "workspace:^",
-		"@talismn/util": "workspace:^",
+		"@talismn/chain-connector": "workspace:*",
+		"@talismn/chain-connector-evm": "workspace:*",
+		"@talismn/chaindata-provider": "workspace:*",
+		"@talismn/token-rates": "workspace:*",
+		"@talismn/util": "workspace:*",
 		anylogger: "^1.0.11",
-		dexie: "^3.2.3"
+		dexie: "^3.2.3",
+		lodash: "4.17.21"
 	},
 	devDependencies: {
-		"@polkadot/types": "^9.10.5",
-		"@talismn/eslint-config": "workspace:^",
-		"@talismn/tsconfig": "workspace:^",
+		"@polkadot/types": "^10.1.4",
+		"@talismn/eslint-config": "workspace:*",
+		"@talismn/tsconfig": "workspace:*",
 		"@types/jest": "^27.5.1",
+		"@types/lodash": "^4.14.180",
 		eslint: "^8.4.0",
 		jest: "^28.1.0",
 		"ts-jest": "^28.0.2",
 		typescript: "^4.6.4"
 	},
 	peerDependencies: {
-		"@polkadot/types": "9.x"
+		"@polkadot/types": "10.x"
 	},
 	preconstruct: {
 		entrypoints: [
@@ -146,8 +150,14 @@ const createTypeRegistryCache = () => {
     if (cached) return cached;
     const typeRegistry = new types.TypeRegistry();
     if (typeof metadataRpc === "string") {
-      const metadata = new types.Metadata(typeRegistry, metadataRpc);
-      metadata.registry.setMetadata(metadata);
+      try {
+        const metadata = new types.Metadata(typeRegistry, metadataRpc);
+        metadata.registry.setMetadata(metadata);
+      } catch (cause) {
+        log.warn(new Error(`Failed to set metadata for chain ${chainId}`, {
+          cause
+        }), cause);
+      }
     }
     typeRegistryCache.set(chainId, typeRegistry);
     return typeRegistry;
@@ -214,7 +224,11 @@ class StorageHelper {
   #module;
   #method;
   #parameters;
+
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   tags = null;
+
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   constructor(registry, module, method, ...parameters) {
     this.#registry = registry;
     this.#module = module;
@@ -248,6 +262,8 @@ class StorageHelper {
   get parameters() {
     return this.#parameters;
   }
+
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   tag(tags) {
     this.tags = tags;
     return this;
@@ -286,11 +302,77 @@ class StorageHelper {
   }
 }
 
+/**
+ * Pass some these into an `RpcStateQueryHelper` in order to easily batch multiple state queries into the one rpc call.
+ */
+
+/**
+ * Used by a variety of balance modules to help batch multiple state queries into the one rpc call.
+ */
+class RpcStateQueryHelper {
+  #chainConnector;
+  #queries;
+  constructor(chainConnector, queries) {
+    this.#chainConnector = chainConnector;
+    this.#queries = queries;
+  }
+  async subscribe(callback, timeout = false, subscribeMethod = "state_subscribeStorage", responseMethod = "state_storage", unsubscribeMethod = "state_unsubscribeStorage") {
+    const queriesByChain = groupBy__default["default"](this.#queries, "chainId");
+    const subscriptions = Object.entries(queriesByChain).map(([chainId, queries]) => {
+      const params = [queries.map(({
+        stateKey
+      }) => stateKey)];
+      const unsub = this.#chainConnector.subscribe(chainId, subscribeMethod, responseMethod, params, (error, result) => {
+        error ? callback(error) : callback(null, this.#distributeChangesToQueryDecoders.call(this, chainId, result));
+      }, timeout);
+      return () => unsub.then(unsubscribe => unsubscribe(unsubscribeMethod));
+    });
+    return () => subscriptions.forEach(unsubscribe => unsubscribe());
+  }
+  async fetch(method = "state_queryStorageAt") {
+    const queriesByChain = groupBy__default["default"](this.#queries, "chainId");
+    const resultsByChain = await Promise.all(Object.entries(queriesByChain).map(async ([chainId, queries]) => {
+      const params = [queries.map(({
+        stateKey
+      }) => stateKey)];
+      const result = (await this.#chainConnector.send(chainId, method, params))[0];
+      return this.#distributeChangesToQueryDecoders.call(this, chainId, result);
+    }));
+    return resultsByChain.flatMap(result => result);
+  }
+  #distributeChangesToQueryDecoders(chainId, result) {
+    if (typeof result !== "object" || result === null) return [];
+    if (!util.hasOwnProperty(result, "changes") || typeof result.changes !== "object") return [];
+    if (!Array.isArray(result.changes)) return [];
+    return result.changes.flatMap(([reference, change]) => {
+      if (typeof reference !== "string") {
+        log.warn(`Received non-string reference in RPC result: ${reference}`);
+        return [];
+      }
+      if (typeof change !== "string" && change !== null) {
+        log.warn(`Received non-string and non-null change in RPC result: ${reference} | ${change}`);
+        return [];
+      }
+      const query = this.#queries.find(({
+        chainId: cId,
+        stateKey
+      }) => cId === chainId && stateKey === reference);
+      if (!query) {
+        log.warn(`Failed to find query:\n${reference} in\n${this.#queries.map(({
+          stateKey
+        }) => stateKey)}`);
+        return [];
+      }
+      return [query.decodeResult(change)];
+    });
+  }
+}
+
 const BalanceStatusLive = subscriptionId => `live-${subscriptionId}`;
 function excludeFromTransferableAmount(locks) {
   if (typeof locks === "string") return BigInt(locks);
   if (!Array.isArray(locks)) locks = [locks];
-  return locks.filter(lock => lock.includeInTransferable !== true).map(lock => BigInt(lock.amount)).reduce((max, lock) => util.BigMath.max(max, lock), BigInt("0"));
+  return locks.filter(lock => lock.includeInTransferable !== true).map(lock => BigInt(lock.amount)).reduce((max, lock) => util.BigMath.max(max, lock), 0n);
 }
 function excludeFromFeePayableLocks(locks) {
   if (typeof locks === "string") return [];
@@ -301,9 +383,9 @@ function excludeFromFeePayableLocks(locks) {
 /** A labelled extra amount of a balance */
 
 function includeInTotalExtraAmount(extra) {
-  if (!extra) return BigInt("0");
+  if (!extra) return 0n;
   if (!Array.isArray(extra)) extra = [extra];
-  return extra.filter(extra => extra.includeInTotal).map(extra => BigInt(extra.amount)).reduce((a, b) => a + b, BigInt("0"));
+  return extra.filter(extra => extra.includeInTotal).map(extra => BigInt(extra.amount)).reduce((a, b) => a + b, 0n);
 }
 
 /** Used by plugins to help define their custom `BalanceType` */
@@ -414,6 +496,27 @@ class Balances {
     return new Balances([...this].filter(filter));
   };
 
+  /**
+   * Filters this collection to exclude token balances where the token has a `mirrorOf` field
+   * and another balance exists in this collection for the token specified by the `mirrorOf` field.
+   */
+  filterMirrorTokens = () => new Balances([...this].filter(filterMirrorTokens));
+
+  /**
+   * Filters this collection to only include balances which are not zero.
+   */
+  filterNonZero = type => {
+    const filter = balance => balance[type].planck > 0n;
+    return this.find(filter);
+  };
+  /**
+   * Filters this collection to only include balances which are not zero AND have a fiat conversion rate.
+   */
+  filterNonZeroFiat = (type, currency) => {
+    const filter = balance => (balance[type].fiat(currency) ?? 0) > 0;
+    return this.find(filter);
+  };
+
   /**
    * Add some balances to this collection.
    * Added balances take priority over existing balances.
@@ -536,13 +639,14 @@ class Balance {
   get id() {
     const {
       source,
+      subSource,
       address,
       chainId,
       evmNetworkId,
       tokenId
     } = this.#storage;
     const locationId = chainId !== undefined ? chainId : evmNetworkId;
-    return `${source}-${address}-${locationId}-${tokenId}`;
+    return [source, address, locationId, tokenId, subSource].filter(Boolean).join("-");
   }
   get source() {
     return this.#storage.source;
@@ -591,17 +695,43 @@ class Balance {
   }
   /** The non-reserved balance of this token. Includes the frozen amount. Is included in the total. */
   get free() {
-    return this.#format(typeof this.#storage.free === "string" ? BigInt(this.#storage.free) : Array.isArray(this.#storage.free) ? this.#storage.free.map(reserve => BigInt(reserve.amount)).reduce((a, b) => a + b, BigInt("0")) : BigInt(this.#storage.free?.amount || "0"));
+    return this.#format(typeof this.#storage.free === "string" ? BigInt(this.#storage.free) : Array.isArray(this.#storage.free) ? this.#storage.free.map(reserve => BigInt(reserve.amount)).reduce((a, b) => a + b, 0n) : BigInt(this.#storage.free?.amount || "0"));
   }
   /** The reserved balance of this token. Is included in the total. */
   get reserved() {
-    return this.#format(typeof this.#storage.reserves === "string" ? BigInt(this.#storage.reserves) : Array.isArray(this.#storage.reserves) ? this.#storage.reserves.map(reserve => BigInt(reserve.amount)).reduce((a, b) => a + b, BigInt("0")) : BigInt(this.#storage.reserves?.amount || "0"));
+    return this.#format(typeof this.#storage.reserves === "string" ? BigInt(this.#storage.reserves) : Array.isArray(this.#storage.reserves) ? this.#storage.reserves.map(reserve => BigInt(reserve.amount)).reduce((a, b) => a + b, 0n) : BigInt(this.#storage.reserves?.amount || "0"));
+  }
+  get reserves() {
+    return (Array.isArray(this.#storage.reserves) ? this.#storage.reserves : [this.#storage.reserves]).flatMap(reserve => {
+      if (reserve === undefined) return [];
+      if (typeof reserve === "string") return {
+        label: "reserved",
+        amount: this.#format(reserve)
+      };
+      return {
+        ...reserve,
+        amount: this.#format(reserve.amount)
+      };
+    });
   }
   /** The frozen balance of this token. Is included in the free amount. */
   get locked() {
-    return this.#format(typeof this.#storage.locks === "string" ? BigInt(this.#storage.locks) : Array.isArray(this.#storage.locks) ? this.#storage.locks.map(lock => BigInt(lock.amount)).reduce((a, b) => util.BigMath.max(a, b), BigInt("0")) : BigInt(this.#storage.locks?.amount || "0"));
+    return this.#format(typeof this.#storage.locks === "string" ? BigInt(this.#storage.locks) : Array.isArray(this.#storage.locks) ? this.#storage.locks.map(lock => BigInt(lock.amount)).reduce((a, b) => util.BigMath.max(a, b), 0n) : BigInt(this.#storage.locks?.amount || "0"));
+  }
+  get locks() {
+    return (Array.isArray(this.#storage.locks) ? this.#storage.locks : [this.#storage.locks]).flatMap(lock => {
+      if (lock === undefined) return [];
+      if (typeof lock === "string") return {
+        label: "other",
+        amount: this.#format(lock)
+      };
+      return {
+        ...lock,
+        amount: this.#format(lock.amount)
+      };
+    });
   }
-  /** @depreacted - use balance.locked */
+  /** @deprecated Use balance.locked */
   get frozen() {
     return this.locked;
   }
@@ -614,7 +744,7 @@ class Balance {
     const excludeAmount = excludeFromTransferableAmount(this.#storage.locks);
 
     // subtract the lock from the free amount (but don't go below 0)
-    return this.#format(util.BigMath.max(this.free.planck - excludeAmount, BigInt("0")));
+    return this.#format(util.BigMath.max(this.free.planck - excludeAmount, 0n));
   }
   /** The feePayable balance of this token. Is generally the free amount - the feeFrozen amount. */
   get feePayable() {
@@ -622,10 +752,10 @@ class Balance {
     if (!this.#storage.locks) return this.free;
 
     // find the largest lock which can't be used to pay tx fees
-    const excludeAmount = excludeFromFeePayableLocks(this.#storage.locks).map(lock => BigInt(lock.amount)).reduce((max, lock) => util.BigMath.max(max, lock), BigInt("0"));
+    const excludeAmount = excludeFromFeePayableLocks(this.#storage.locks).map(lock => BigInt(lock.amount)).reduce((max, lock) => util.BigMath.max(max, lock), 0n);
 
     // subtract the lock from the free amount (but don't go below 0)
-    return this.#format(util.BigMath.max(this.free.planck - excludeAmount, BigInt("0")));
+    return this.#format(util.BigMath.max(this.free.planck - excludeAmount, 0n));
   }
 }
 class BalanceFormatter {
@@ -651,6 +781,52 @@ class BalanceFormatter {
     return parseFloat(this.tokens) * ratio;
   }
 }
+class PlanckSumBalancesFormatter {
+  #balances;
+  constructor(balances) {
+    this.#balances = balances;
+  }
+  #sum = balanceField => {
+    // a function to get a planck amount from a balance
+    const planck = balance => balance[balanceField].planck ?? 0n;
+    return this.#balances.filterMirrorTokens().each.reduce(
+    // add the total amount to the planck amount of each balance
+    (total, balance) => total + planck(balance),
+    // start with a total of 0
+    0n);
+  };
+
+  /**
+   * The total balance of these tokens. Includes the free and the reserved amount.
+   */
+  get total() {
+    return this.#sum("total");
+  }
+  /** The non-reserved balance of these tokens. Includes the frozen amount. Is included in the total. */
+  get free() {
+    return this.#sum("free");
+  }
+  /** The reserved balance of these tokens. Is included in the total. */
+  get reserved() {
+    return this.#sum("reserved");
+  }
+  /** The frozen balance of these tokens. Is included in the free amount. */
+  get locked() {
+    return this.#sum("locked");
+  }
+  /** @deprecated Use balances.locked */
+  get frozen() {
+    return this.locked;
+  }
+  /** The transferable balance of these tokens. Is generally the free amount - the miscFrozen amount. */
+  get transferable() {
+    return this.#sum("transferable");
+  }
+  /** The feePayable balance of these tokens. Is generally the free amount - the feeFrozen amount. */
+  get feePayable() {
+    return this.#sum("feePayable");
+  }
+}
 class FiatSumBalancesFormatter {
   #balances;
   #currency;
@@ -660,15 +836,10 @@ class FiatSumBalancesFormatter {
   }
   #sum = balanceField => {
     // a function to get a fiat amount from a balance
-    const fiat = balance => balance[balanceField].fiat(this.#currency) || 0;
-
-    // a function to add two amounts
-    const sum = (a, b) => a + b;
-    return [...this.#balances].filter(filterMirrorTokens).reduce((total, balance) => sum(
-    // add the total amount...
-    total,
-    // ...to the fiat amount of each balance
-    fiat(balance)),
+    const fiat = balance => balance[balanceField].fiat(this.#currency) ?? 0;
+    return this.#balances.filterMirrorTokens().each.reduce(
+    // add the total amount to the fiat amount of each balance
+    (total, balance) => total + fiat(balance),
     // start with a total of 0
     0);
   };
@@ -691,7 +862,7 @@ class FiatSumBalancesFormatter {
   get locked() {
     return this.#sum("locked");
   }
-  /** @deprecated - use balances.locked */
+  /** @deprecated Use balances.locked */
   get frozen() {
     return this.locked;
   }
@@ -709,6 +880,9 @@ class SumBalancesFormatter {
   constructor(balances) {
     this.#balances = balances;
   }
+  get planck() {
+    return new PlanckSumBalancesFormatter(this.#balances);
+  }
   fiat(currency) {
     return new FiatSumBalancesFormatter(this.#balances, currency);
   }
@@ -720,6 +894,8 @@ exports.BalanceStatusLive = BalanceStatusLive;
 exports.Balances = Balances;
 exports.DefaultBalanceModule = DefaultBalanceModule;
 exports.FiatSumBalancesFormatter = FiatSumBalancesFormatter;
+exports.PlanckSumBalancesFormatter = PlanckSumBalancesFormatter;
+exports.RpcStateQueryHelper = RpcStateQueryHelper;
 exports.StorageHelper = StorageHelper;
 exports.SumBalancesFormatter = SumBalancesFormatter;
 exports.TalismanBalancesDatabase = TalismanBalancesDatabase;