@talismn/balances 0.0.0-pr669-20230403053044 → 0.0.0-pr678-20230412083934

package/CHANGELOG.md

@@ -1,6 +1,16 @@
 # @talismn/balances
 
-## 0.0.0-pr669-20230403053044
+## 0.0.0-pr678-20230412083934
+
+### Patch Changes
+
+- Updated dependencies [c898da98]
+  - @talismn/chain-connector@0.0.0-pr678-20230412083934
+  - @talismn/chain-connector-evm@0.0.0-pr678-20230412083934
+  - @talismn/chaindata-provider@0.0.0-pr678-20230412083934
+  - @talismn/token-rates@0.0.0-pr678-20230412083934
+
+## 0.4.0
 
 ### Patch Changes
 
@@ -11,11 +21,11 @@
 - Updated dependencies [6643a4e4]
 - Updated dependencies [79f6ccf6]
 - Updated dependencies [c24dc1fb]
-  - @talismn/chain-connector@0.0.0-pr669-20230403053044
-  - @talismn/util@0.0.0-pr669-20230403053044
-  - @talismn/token-rates@0.0.0-pr669-20230403053044
-  - @talismn/chaindata-provider@0.0.0-pr669-20230403053044
-  - @talismn/chain-connector-evm@0.0.0-pr669-20230403053044
+  - @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,7 +1,7 @@
 import type { Registry } from "@polkadot/types-codec/types";
 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.
@@ -12,6 +12,13 @@ export declare const createTypeRegistryCache: () => {
     getOrCreateTypeRegistry: (chainId: ChainId, metadataRpc?: `0x${string}`) => Registry;
 };
 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.
  */

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

@@ -23,7 +23,9 @@ 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 */

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

@@ -67,7 +67,7 @@ const db = new TalismanBalancesDatabase();
 
 var packageJson = {
 	name: "@talismn/balances",
-	version: "0.0.0-pr669-20230403053044",
+	version: "0.0.0-pr678-20230412083934",
 	author: "Talisman",
 	homepage: "https://talisman.xyz",
 	license: "UNLICENSED",
@@ -161,6 +161,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 +286,7 @@ class StorageHelper {
   }
 }
 
+const BalanceStatusLive = subscriptionId => `live-${subscriptionId}`;
 function excludeFromTransferableAmount(locks) {
   if (typeof locks === "string") return BigInt(locks);
   if (!Array.isArray(locks)) locks = [locks];
@@ -672,6 +716,7 @@ class SumBalancesFormatter {
 
 exports.Balance = Balance;
 exports.BalanceFormatter = BalanceFormatter;
+exports.BalanceStatusLive = BalanceStatusLive;
 exports.Balances = Balances;
 exports.DefaultBalanceModule = DefaultBalanceModule;
 exports.FiatSumBalancesFormatter = FiatSumBalancesFormatter;
@@ -679,9 +724,13 @@ 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

@@ -67,7 +67,7 @@ const db = new TalismanBalancesDatabase();
 
 var packageJson = {
 	name: "@talismn/balances",
-	version: "0.0.0-pr669-20230403053044",
+	version: "0.0.0-pr678-20230412083934",
 	author: "Talisman",
 	homepage: "https://talisman.xyz",
 	license: "UNLICENSED",
@@ -161,6 +161,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 +286,7 @@ class StorageHelper {
   }
 }
 
+const BalanceStatusLive = subscriptionId => `live-${subscriptionId}`;
 function excludeFromTransferableAmount(locks) {
   if (typeof locks === "string") return BigInt(locks);
   if (!Array.isArray(locks)) locks = [locks];
@@ -672,6 +716,7 @@ class SumBalancesFormatter {
 
 exports.Balance = Balance;
 exports.BalanceFormatter = BalanceFormatter;
+exports.BalanceStatusLive = BalanceStatusLive;
 exports.Balances = Balances;
 exports.DefaultBalanceModule = DefaultBalanceModule;
 exports.FiatSumBalancesFormatter = FiatSumBalancesFormatter;
@@ -679,9 +724,13 @@ 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

@@ -59,7 +59,7 @@ const db = new TalismanBalancesDatabase();
 
 var packageJson = {
 	name: "@talismn/balances",
-	version: "0.0.0-pr669-20230403053044",
+	version: "0.0.0-pr678-20230412083934",
 	author: "Talisman",
 	homepage: "https://talisman.xyz",
 	license: "UNLICENSED",
@@ -153,6 +153,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 +278,7 @@ class StorageHelper {
   }
 }
 
+const BalanceStatusLive = subscriptionId => `live-${subscriptionId}`;
 function excludeFromTransferableAmount(locks) {
   if (typeof locks === "string") return BigInt(locks);
   if (!Array.isArray(locks)) locks = [locks];
@@ -662,4 +706,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, 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-pr669-20230403053044",
+  "version": "0.0.0-pr678-20230412083934",
   "author": "Talisman",
   "homepage": "https://talisman.xyz",
   "license": "UNLICENSED",
@@ -27,11 +27,11 @@
     "clean": "rm -rf dist && rm -rf .turbo rm -rf node_modules"
   },
   "dependencies": {
-    "@talismn/chain-connector": "^0.0.0-pr669-20230403053044",
-    "@talismn/chain-connector-evm": "^0.0.0-pr669-20230403053044",
-    "@talismn/chaindata-provider": "^0.0.0-pr669-20230403053044",
-    "@talismn/token-rates": "^0.0.0-pr669-20230403053044",
-    "@talismn/util": "^0.0.0-pr669-20230403053044",
+    "@talismn/chain-connector": "^0.0.0-pr678-20230412083934",
+    "@talismn/chain-connector-evm": "^0.0.0-pr678-20230412083934",
+    "@talismn/chaindata-provider": "^0.0.0-pr678-20230412083934",
+    "@talismn/token-rates": "^0.0.0-pr678-20230412083934",
+    "@talismn/util": "^0.1.8",
     "anylogger": "^1.0.11",
     "dexie": "^3.2.3"
   },