@talismn/balances 0.0.0-pr710-20230418132646 → 0.0.0-pr716-20230419110638

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-pr710-20230418132646",
+	version: "0.0.0-pr716-20230419110638",
 	author: "Talisman",
 	homepage: "https://talisman.xyz",
 	license: "UNLICENSED",
@@ -82,30 +83,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: [
@@ -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
+        }), cause);
+      }
     }
     typeRegistryCache.set(chainId, typeRegistry);
     return typeRegistry;
@@ -206,7 +215,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;
@@ -240,6 +253,8 @@ class StorageHelper {
   get parameters() {
     return this.#parameters;
   }
+
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   tag(tags) {
     this.tags = tags;
     return this;
@@ -278,11 +293,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(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(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];
-  return locks.filter(lock => lock.includeInTransferable !== true).map(lock => BigInt(lock.amount)).reduce((max, lock) => BigMath.max(max, lock), BigInt("0"));
+  return locks.filter(lock => lock.includeInTransferable !== true).map(lock => BigInt(lock.amount)).reduce((max, lock) => BigMath.max(max, lock), 0n);
 }
 function excludeFromFeePayableLocks(locks) {
   if (typeof locks === "string") return [];
@@ -293,9 +374,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` */
@@ -406,6 +487,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.
@@ -528,13 +630,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;
@@ -583,17 +686,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) => 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) => 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;
   }
@@ -606,7 +735,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(BigMath.max(this.free.planck - excludeAmount, BigInt("0")));
+    return this.#format(BigMath.max(this.free.planck - excludeAmount, 0n));
   }
   /** The feePayable balance of this token. Is generally the free amount - the feeFrozen amount. */
   get feePayable() {
@@ -614,10 +743,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) => BigMath.max(max, lock), BigInt("0"));
+    const excludeAmount = excludeFromFeePayableLocks(this.#storage.locks).map(lock => BigInt(lock.amount)).reduce((max, lock) => BigMath.max(max, lock), 0n);
 
     // subtract the lock from the free amount (but don't go below 0)
-    return this.#format(BigMath.max(this.free.planck - excludeAmount, BigInt("0")));
+    return this.#format(BigMath.max(this.free.planck - excludeAmount, 0n));
   }
 }
 class BalanceFormatter {
@@ -643,6 +772,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;
@@ -652,15 +827,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);
   };
@@ -683,7 +853,7 @@ class FiatSumBalancesFormatter {
   get locked() {
     return this.#sum("locked");
   }
-  /** @deprecated - use balances.locked */
+  /** @deprecated Use balances.locked */
   get frozen() {
     return this.locked;
   }
@@ -701,9 +871,12 @@ class SumBalancesFormatter {
   constructor(balances) {
     this.#balances = balances;
   }
+  get planck() {
+    return new PlanckSumBalancesFormatter(this.#balances);
+  }
   fiat(currency) {
     return new FiatSumBalancesFormatter(this.#balances, currency);
   }
 }
 
-export { Balance, BalanceFormatter, BalanceStatusLive, Balances, DefaultBalanceModule, FiatSumBalancesFormatter, StorageHelper, SumBalancesFormatter, TalismanBalancesDatabase, balances, createSubscriptionId, createTypeRegistryCache, db, deleteSubscriptionId, deriveStatuses, excludeFromFeePayableLocks, excludeFromTransferableAmount, filterMirrorTokens, getValidSubscriptionIds, includeInTotalExtraAmount };
+export { Balance, BalanceFormatter, BalanceStatusLive, Balances, DefaultBalanceModule, FiatSumBalancesFormatter, PlanckSumBalancesFormatter, 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-pr710-20230418132646",
+  "version": "0.0.0-pr716-20230419110638",
   "author": "Talisman",
   "homepage": "https://talisman.xyz",
   "license": "UNLICENSED",
@@ -23,30 +23,32 @@
   },
   "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": "^0.0.0-pr710-20230418132646",
-    "@talismn/chain-connector-evm": "^0.0.0-pr710-20230418132646",
-    "@talismn/chaindata-provider": "^0.0.0-pr710-20230418132646",
-    "@talismn/token-rates": "^0.0.0-pr710-20230418132646",
-    "@talismn/util": "^0.1.8",
+    "@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",
     "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": "^0.0.1",
-    "@talismn/tsconfig": "^0.0.2",
+    "@polkadot/types": "^10.1.4",
+    "@talismn/eslint-config": "0.0.0-pr716-20230419110638",
+    "@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": [