@talismn/balances 0.0.0-pr672-20230404063840 → 0.0.0-pr677-20230413171850

package/CHANGELOG.md

@@ -1,6 +1,21 @@
 # @talismn/balances
 
-## 0.0.0-pr672-20230404063840
+## 0.0.0-pr677-20230413171850
+
+### Patch Changes
+
+- fb8ee962: feat: proxy dapp websocket requests to talisman wallet backend when available
+- 306e7160: feat: crowdloan and nom pool balances
+- Updated dependencies [fb8ee962]
+- Updated dependencies [c898da98]
+- Updated dependencies [306e7160]
+  - @talismn/chain-connector@0.0.0-pr677-20230413171850
+  - @talismn/chain-connector-evm@0.0.0-pr677-20230413171850
+  - @talismn/util@0.0.0-pr677-20230413171850
+  - @talismn/chaindata-provider@0.0.0-pr677-20230413171850
+  - @talismn/token-rates@0.0.0-pr677-20230413171850
+
+## 0.4.0
 
 ### Patch Changes
 
@@ -11,11 +26,11 @@
 - Updated dependencies [6643a4e4]
 - Updated dependencies [79f6ccf6]
 - Updated dependencies [c24dc1fb]
-  - @talismn/chain-connector@0.0.0-pr672-20230404063840
-  - @talismn/util@0.0.0-pr672-20230404063840
-  - @talismn/token-rates@0.0.0-pr672-20230404063840
-  - @talismn/chaindata-provider@0.0.0-pr672-20230404063840
-  - @talismn/chain-connector-evm@0.0.0-pr672-20230404063840
+  - @talismn/chain-connector@0.4.3
+  - @talismn/util@0.1.8
+  - @talismn/token-rates@0.1.15
+  - @talismn/chaindata-provider@0.4.3
+  - @talismn/chain-connector-evm@0.4.3
 
 ## 0.3.3
 

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

@@ -1,17 +1,26 @@
 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, Balances, SubscriptionCallback, UnsubscribeFn } from "./types";
+import { AddressesByToken, Balance, BalanceJson, Balances, SubscriptionCallback, UnsubscribeFn } from "./types";
 /**
  * Wraps a BalanceModule's fetch/subscribe methods with a single `balances` method.
  * This `balances` method will subscribe if a callback parameter is provided, or otherwise fetch.
  */
 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>;
+export declare const createSubscriptionId: () => string;
+export declare const deleteSubscriptionId: () => void;
+/**
+ * Sets all balance statuses from `live-${string}` to either `live` or `cached`
+ */
+export declare const deriveStatuses: (validSubscriptionIds: string[], balances: BalanceJson[]) => BalanceJson[];
 /**
  * Used by a variety of balance modules to help encode and decode substrate state calls.
  */
@@ -26,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

@@ -134,8 +134,20 @@ 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;
+    get locks(): {
+        amount: BalanceFormatter;
+        label: string;
+        meta?: unknown;
+        includeInTransferable?: boolean | undefined;
+        excludeFromFeePayable?: boolean | undefined;
+    }[];
     /** @depreacted - use balance.locked */
     get frozen(): BalanceFormatter;
     /** The transferable balance of this token. Is generally the free amount - the miscFrozen amount. */

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

@@ -23,11 +23,18 @@ export type BalanceTypes = {
 export type BalanceJson = BalanceTypes[keyof BalanceTypes] extends never ? IBalance : BalanceTypes[keyof BalanceTypes];
 /** A collection of `BalanceJson` objects */
 export type BalanceJsonList = Record<string, BalanceJson>;
-export type BalanceStatus = "live" | "cache" | "stale";
+export type BalanceStatusLive = `live-${string}`;
+export declare const BalanceStatusLive: (subscriptionId: string) => BalanceStatusLive;
+export type BalanceStatus = BalanceStatusLive | "live" | "cache" | "stale";
 /** `IBalance` is a common interface which all balance types must implement. */
 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 */
@@ -57,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-pr672-20230404063840",
+	version: "0.0.0-pr677-20230413171850",
 	author: "Talisman",
 	homepage: "https://talisman.xyz",
 	license: "UNLICENSED",
@@ -100,20 +102,22 @@ var packageJson = {
 		"@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",
+		"@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
+        }));
+      }
     }
     typeRegistryCache.set(chainId, typeRegistry);
     return typeRegistry;
@@ -161,6 +171,49 @@ const filterMirrorTokens = (balance, i, balances) => {
   const mirrorOf = balance.token?.mirrorOf;
   return !mirrorOf || !balances.find(b => b.tokenId === mirrorOf);
 };
+const getValidSubscriptionIds = () => {
+  return new Set(localStorage.getItem("TalismanBalancesSubscriptionIds")?.split(",") ?? []);
+};
+const createSubscriptionId = () => {
+  // delete current id (if exists)
+  deleteSubscriptionId();
+
+  // create new id
+  const subscriptionId = Date.now().toString();
+  sessionStorage.setItem("TalismanBalancesSubscriptionId", subscriptionId);
+
+  // add to list of current ids
+  const subscriptionIds = getValidSubscriptionIds();
+  subscriptionIds.add(subscriptionId);
+  localStorage.setItem("TalismanBalancesSubscriptionIds", [...subscriptionIds].filter(Boolean).join(","));
+  return subscriptionId;
+};
+const deleteSubscriptionId = () => {
+  const subscriptionId = sessionStorage.getItem("TalismanBalancesSubscriptionId");
+  if (!subscriptionId) return;
+  const subscriptionIds = getValidSubscriptionIds();
+  subscriptionIds.delete(subscriptionId);
+  localStorage.setItem("TalismanBalancesSubscriptionIds", [...subscriptionIds].filter(Boolean).join(","));
+};
+
+/**
+ * Sets all balance statuses from `live-${string}` to either `live` or `cached`
+ */
+const deriveStatuses = (validSubscriptionIds, balances) => balances.map(balance => {
+  if (balance.status === "live" || balance.status === "cache" || balance.status === "stale") return balance;
+  if (validSubscriptionIds.length < 1) return {
+    ...balance,
+    status: "cache"
+  };
+  if (!validSubscriptionIds.includes(balance.status.slice("live-".length))) return {
+    ...balance,
+    status: "cache"
+  };
+  return {
+    ...balance,
+    status: "live"
+  };
+});
 
 /**
  * Used by a variety of balance modules to help encode and decode substrate state calls.
@@ -243,6 +296,76 @@ 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 unsubscribe = this.#chainConnector.subscribe(chainId, subscribeMethod, responseMethod, params, (error, result) => {
+        error ? callback(error) : callback(null, this.#distributeChangesToQueryDecoders.call(this, chainId, result));
+      }, timeout);
+      return () => unsubscribe(unsubscribeMethod);
+    }).map(subscription => subscription.catch(error => {
+      log.warn(`Failed to create subscription: ${error.message}`);
+      return () => {};
+    }));
+    return () => subscriptions.forEach(subscription => subscription.then(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];
@@ -492,13 +615,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;
@@ -553,10 +677,36 @@ class Balance {
   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"));
   }
+  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: "other",
+        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"));
   }
+  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 */
   get frozen() {
     return this.locked;
@@ -672,16 +822,22 @@ class SumBalancesFormatter {
 
 exports.Balance = Balance;
 exports.BalanceFormatter = BalanceFormatter;
+exports.BalanceStatusLive = BalanceStatusLive;
 exports.Balances = Balances;
 exports.DefaultBalanceModule = DefaultBalanceModule;
 exports.FiatSumBalancesFormatter = FiatSumBalancesFormatter;
+exports.RpcStateQueryHelper = RpcStateQueryHelper;
 exports.StorageHelper = StorageHelper;
 exports.SumBalancesFormatter = SumBalancesFormatter;
 exports.TalismanBalancesDatabase = TalismanBalancesDatabase;
 exports.balances = balances;
+exports.createSubscriptionId = createSubscriptionId;
 exports.createTypeRegistryCache = createTypeRegistryCache;
 exports.db = db;
+exports.deleteSubscriptionId = deleteSubscriptionId;
+exports.deriveStatuses = deriveStatuses;
 exports.excludeFromFeePayableLocks = excludeFromFeePayableLocks;
 exports.excludeFromTransferableAmount = excludeFromTransferableAmount;
 exports.filterMirrorTokens = filterMirrorTokens;
+exports.getValidSubscriptionIds = getValidSubscriptionIds;
 exports.includeInTotalExtraAmount = includeInTotalExtraAmount;

package/dist/talismn-balances.cjs.prod.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-pr672-20230404063840",
+	version: "0.0.0-pr677-20230413171850",
 	author: "Talisman",
 	homepage: "https://talisman.xyz",
 	license: "UNLICENSED",
@@ -100,20 +102,22 @@ var packageJson = {
 		"@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",
+		"@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
+        }));
+      }
     }
     typeRegistryCache.set(chainId, typeRegistry);
     return typeRegistry;
@@ -161,6 +171,49 @@ const filterMirrorTokens = (balance, i, balances) => {
   const mirrorOf = balance.token?.mirrorOf;
   return !mirrorOf || !balances.find(b => b.tokenId === mirrorOf);
 };
+const getValidSubscriptionIds = () => {
+  return new Set(localStorage.getItem("TalismanBalancesSubscriptionIds")?.split(",") ?? []);
+};
+const createSubscriptionId = () => {
+  // delete current id (if exists)
+  deleteSubscriptionId();
+
+  // create new id
+  const subscriptionId = Date.now().toString();
+  sessionStorage.setItem("TalismanBalancesSubscriptionId", subscriptionId);
+
+  // add to list of current ids
+  const subscriptionIds = getValidSubscriptionIds();
+  subscriptionIds.add(subscriptionId);
+  localStorage.setItem("TalismanBalancesSubscriptionIds", [...subscriptionIds].filter(Boolean).join(","));
+  return subscriptionId;
+};
+const deleteSubscriptionId = () => {
+  const subscriptionId = sessionStorage.getItem("TalismanBalancesSubscriptionId");
+  if (!subscriptionId) return;
+  const subscriptionIds = getValidSubscriptionIds();
+  subscriptionIds.delete(subscriptionId);
+  localStorage.setItem("TalismanBalancesSubscriptionIds", [...subscriptionIds].filter(Boolean).join(","));
+};
+
+/**
+ * Sets all balance statuses from `live-${string}` to either `live` or `cached`
+ */
+const deriveStatuses = (validSubscriptionIds, balances) => balances.map(balance => {
+  if (balance.status === "live" || balance.status === "cache" || balance.status === "stale") return balance;
+  if (validSubscriptionIds.length < 1) return {
+    ...balance,
+    status: "cache"
+  };
+  if (!validSubscriptionIds.includes(balance.status.slice("live-".length))) return {
+    ...balance,
+    status: "cache"
+  };
+  return {
+    ...balance,
+    status: "live"
+  };
+});
 
 /**
  * Used by a variety of balance modules to help encode and decode substrate state calls.
@@ -243,6 +296,76 @@ 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 unsubscribe = this.#chainConnector.subscribe(chainId, subscribeMethod, responseMethod, params, (error, result) => {
+        error ? callback(error) : callback(null, this.#distributeChangesToQueryDecoders.call(this, chainId, result));
+      }, timeout);
+      return () => unsubscribe(unsubscribeMethod);
+    }).map(subscription => subscription.catch(error => {
+      log.warn(`Failed to create subscription: ${error.message}`);
+      return () => {};
+    }));
+    return () => subscriptions.forEach(subscription => subscription.then(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];
@@ -492,13 +615,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;
@@ -553,10 +677,36 @@ class Balance {
   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"));
   }
+  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: "other",
+        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"));
   }
+  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 */
   get frozen() {
     return this.locked;
@@ -672,16 +822,22 @@ class SumBalancesFormatter {
 
 exports.Balance = Balance;
 exports.BalanceFormatter = BalanceFormatter;
+exports.BalanceStatusLive = BalanceStatusLive;
 exports.Balances = Balances;
 exports.DefaultBalanceModule = DefaultBalanceModule;
 exports.FiatSumBalancesFormatter = FiatSumBalancesFormatter;
+exports.RpcStateQueryHelper = RpcStateQueryHelper;
 exports.StorageHelper = StorageHelper;
 exports.SumBalancesFormatter = SumBalancesFormatter;
 exports.TalismanBalancesDatabase = TalismanBalancesDatabase;
 exports.balances = balances;
+exports.createSubscriptionId = createSubscriptionId;
 exports.createTypeRegistryCache = createTypeRegistryCache;
 exports.db = db;
+exports.deleteSubscriptionId = deleteSubscriptionId;
+exports.deriveStatuses = deriveStatuses;
 exports.excludeFromFeePayableLocks = excludeFromFeePayableLocks;
 exports.excludeFromTransferableAmount = excludeFromTransferableAmount;
 exports.filterMirrorTokens = filterMirrorTokens;
+exports.getValidSubscriptionIds = getValidSubscriptionIds;
 exports.includeInTotalExtraAmount = includeInTotalExtraAmount;

package/dist/talismn-balances.esm.js

@@ -1,7 +1,8 @@
 import { Dexie } from 'dexie';
 import { decorateStorage, StorageKey, TypeRegistry, Metadata } from '@polkadot/types';
+import { hasOwnProperty, BigMath, isArrayOf, planckToTokens } from '@talismn/util';
+import groupBy from 'lodash/groupBy';
 import anylogger from 'anylogger';
-import { BigMath, isArrayOf, planckToTokens } from '@talismn/util';
 
 // TODO: Document default balances module purpose/usage
 const DefaultBalanceModule = type => ({
@@ -59,7 +60,7 @@ const db = new TalismanBalancesDatabase();
 
 var packageJson = {
 	name: "@talismn/balances",
-	version: "0.0.0-pr672-20230404063840",
+	version: "0.0.0-pr677-20230413171850",
 	author: "Talisman",
 	homepage: "https://talisman.xyz",
 	license: "UNLICENSED",
@@ -92,20 +93,22 @@ var packageJson = {
 		"@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",
+		"@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: [
@@ -138,8 +141,14 @@ const createTypeRegistryCache = () => {
     if (cached) return cached;
     const typeRegistry = new TypeRegistry();
     if (typeof metadataRpc === "string") {
-      const metadata = new Metadata(typeRegistry, metadataRpc);
-      metadata.registry.setMetadata(metadata);
+      try {
+        const metadata = new Metadata(typeRegistry, metadataRpc);
+        metadata.registry.setMetadata(metadata);
+      } catch (cause) {
+        log.warn(new Error(`Failed to set metadata for chain ${chainId}`, {
+          cause
+        }));
+      }
     }
     typeRegistryCache.set(chainId, typeRegistry);
     return typeRegistry;
@@ -153,6 +162,49 @@ const filterMirrorTokens = (balance, i, balances) => {
   const mirrorOf = balance.token?.mirrorOf;
   return !mirrorOf || !balances.find(b => b.tokenId === mirrorOf);
 };
+const getValidSubscriptionIds = () => {
+  return new Set(localStorage.getItem("TalismanBalancesSubscriptionIds")?.split(",") ?? []);
+};
+const createSubscriptionId = () => {
+  // delete current id (if exists)
+  deleteSubscriptionId();
+
+  // create new id
+  const subscriptionId = Date.now().toString();
+  sessionStorage.setItem("TalismanBalancesSubscriptionId", subscriptionId);
+
+  // add to list of current ids
+  const subscriptionIds = getValidSubscriptionIds();
+  subscriptionIds.add(subscriptionId);
+  localStorage.setItem("TalismanBalancesSubscriptionIds", [...subscriptionIds].filter(Boolean).join(","));
+  return subscriptionId;
+};
+const deleteSubscriptionId = () => {
+  const subscriptionId = sessionStorage.getItem("TalismanBalancesSubscriptionId");
+  if (!subscriptionId) return;
+  const subscriptionIds = getValidSubscriptionIds();
+  subscriptionIds.delete(subscriptionId);
+  localStorage.setItem("TalismanBalancesSubscriptionIds", [...subscriptionIds].filter(Boolean).join(","));
+};
+
+/**
+ * Sets all balance statuses from `live-${string}` to either `live` or `cached`
+ */
+const deriveStatuses = (validSubscriptionIds, balances) => balances.map(balance => {
+  if (balance.status === "live" || balance.status === "cache" || balance.status === "stale") return balance;
+  if (validSubscriptionIds.length < 1) return {
+    ...balance,
+    status: "cache"
+  };
+  if (!validSubscriptionIds.includes(balance.status.slice("live-".length))) return {
+    ...balance,
+    status: "cache"
+  };
+  return {
+    ...balance,
+    status: "live"
+  };
+});
 
 /**
  * Used by a variety of balance modules to help encode and decode substrate state calls.
@@ -235,6 +287,76 @@ 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(this.#queries, "chainId");
+    const subscriptions = Object.entries(queriesByChain).map(([chainId, queries]) => {
+      const params = [queries.map(({
+        stateKey
+      }) => stateKey)];
+      const unsubscribe = this.#chainConnector.subscribe(chainId, subscribeMethod, responseMethod, params, (error, result) => {
+        error ? callback(error) : callback(null, this.#distributeChangesToQueryDecoders.call(this, chainId, result));
+      }, timeout);
+      return () => unsubscribe(unsubscribeMethod);
+    }).map(subscription => subscription.catch(error => {
+      log.warn(`Failed to create subscription: ${error.message}`);
+      return () => {};
+    }));
+    return () => subscriptions.forEach(subscription => subscription.then(unsubscribe => unsubscribe()));
+  }
+  async fetch(method = "state_queryStorageAt") {
+    const queriesByChain = groupBy(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 (!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];
@@ -484,13 +606,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;
@@ -545,10 +668,36 @@ class Balance {
   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"));
   }
+  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: "other",
+        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) => BigMath.max(a, b), BigInt("0")) : 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 */
   get frozen() {
     return this.locked;
@@ -662,4 +811,4 @@ class SumBalancesFormatter {
   }
 }
 
-export { Balance, BalanceFormatter, Balances, DefaultBalanceModule, FiatSumBalancesFormatter, StorageHelper, SumBalancesFormatter, TalismanBalancesDatabase, balances, createTypeRegistryCache, db, excludeFromFeePayableLocks, excludeFromTransferableAmount, filterMirrorTokens, includeInTotalExtraAmount };
+export { Balance, BalanceFormatter, BalanceStatusLive, Balances, DefaultBalanceModule, FiatSumBalancesFormatter, RpcStateQueryHelper, StorageHelper, SumBalancesFormatter, TalismanBalancesDatabase, balances, createSubscriptionId, createTypeRegistryCache, db, deleteSubscriptionId, deriveStatuses, excludeFromFeePayableLocks, excludeFromTransferableAmount, filterMirrorTokens, getValidSubscriptionIds, includeInTotalExtraAmount };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@talismn/balances",
-  "version": "0.0.0-pr672-20230404063840",
+  "version": "0.0.0-pr677-20230413171850",
   "author": "Talisman",
   "homepage": "https://talisman.xyz",
   "license": "UNLICENSED",
@@ -27,26 +27,28 @@
     "clean": "rm -rf dist && rm -rf .turbo rm -rf node_modules"
   },
   "dependencies": {
-    "@talismn/chain-connector": "^0.0.0-pr672-20230404063840",
-    "@talismn/chain-connector-evm": "^0.0.0-pr672-20230404063840",
-    "@talismn/chaindata-provider": "^0.0.0-pr672-20230404063840",
-    "@talismn/token-rates": "^0.0.0-pr672-20230404063840",
-    "@talismn/util": "^0.0.0-pr672-20230404063840",
+    "@talismn/chain-connector": "^0.0.0-pr677-20230413171850",
+    "@talismn/chain-connector-evm": "^0.0.0-pr677-20230413171850",
+    "@talismn/chaindata-provider": "^0.0.0-pr677-20230413171850",
+    "@talismn/token-rates": "^0.0.0-pr677-20230413171850",
+    "@talismn/util": "^0.0.0-pr677-20230413171850",
     "anylogger": "^1.0.11",
-    "dexie": "^3.2.3"
+    "dexie": "^3.2.3",
+    "lodash": "4.17.21"
   },
   "devDependencies": {
-    "@polkadot/types": "^9.10.5",
+    "@polkadot/types": "^10.1.4",
     "@talismn/eslint-config": "^0.0.1",
     "@talismn/tsconfig": "^0.0.2",
     "@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": [