@talismn/balances 0.0.0-pr660-20230327112704 → 0.0.0-pr660-20230328111733

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # @talismn/balances
 
-## 0.0.0-pr660-20230327112704
+## 0.0.0-pr660-20230328111733
 
 ### Patch Changes
 
@@ -12,11 +12,11 @@
 - Updated dependencies [fa4d115f]
 - Updated dependencies [79f6ccf6]
 - Updated dependencies [c24dc1fb]
-  - @talismn/chain-connector@0.0.0-pr660-20230327112704
-  - @talismn/util@0.0.0-pr660-20230327112704
-  - @talismn/token-rates@0.0.0-pr660-20230327112704
-  - @talismn/chaindata-provider@0.0.0-pr660-20230327112704
-  - @talismn/chain-connector-evm@0.0.0-pr660-20230327112704
+  - @talismn/chain-connector@0.0.0-pr660-20230328111733
+  - @talismn/util@0.0.0-pr660-20230328111733
+  - @talismn/token-rates@0.0.0-pr660-20230328111733
+  - @talismn/chaindata-provider@0.0.0-pr660-20230328111733
+  - @talismn/chain-connector-evm@0.0.0-pr660-20230328111733
 
 ## 0.3.3
 

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

@@ -1,7 +1,13 @@
 import { Dexie } from "dexie";
 import { BalanceJson } from "./types";
+type BalancesDbMeta = {
+    id: string;
+    value: string;
+};
 export declare class TalismanBalancesDatabase extends Dexie {
     balances: Dexie.Table<BalanceJson, string>;
+    meta: Dexie.Table<BalancesDbMeta, string>;
     constructor();
 }
 export declare const db: TalismanBalancesDatabase;
+export {};

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,10 @@ export declare const createTypeRegistryCache: () => {
     getOrCreateTypeRegistry: (chainId: ChainId, metadataRpc?: `0x${string}`) => Registry;
 };
 export declare const filterMirrorTokens: (balance: Balance, i: number, balances: Balance[]) => boolean;
+/**
+ * Sets all balance statuses from `live-${string}` to either `live` or `cached`
+ */
+export declare const deriveStatuses: (latestSubscriptionId: string | undefined, 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

@@ -49,14 +49,15 @@ class TalismanBalancesDatabase extends dexie.Dexie {
     super("TalismanBalances");
 
     // https://dexie.org/docs/Tutorial/Design#database-versioning
-    this.version(1).stores({
+    this.version(2).stores({
       // You only need to specify properties that you wish to index.
       // The object store will allow any properties on your stored objects but you can only query them by indexed properties
       // https://dexie.org/docs/API-Reference#declare-database
       //
       // Never index properties containing images, movies or large (huge) strings. Store them in IndexedDB, yes! but just don’t index them!
       // https://dexie.org/docs/Version/Version.stores()#warning
-      balances: "id, source, status, address, tokenId"
+      balances: "id, source, status, address, tokenId",
+      meta: "id"
     });
 
     // this.on("ready", async () => {})
@@ -67,7 +68,7 @@ const db = new TalismanBalancesDatabase();
 
 var packageJson = {
 	name: "@talismn/balances",
-	version: "0.0.0-pr660-20230327112704",
+	version: "0.0.0-pr660-20230328111733",
 	author: "Talisman",
 	homepage: "https://talisman.xyz",
 	license: "UNLICENSED",
@@ -162,6 +163,25 @@ const filterMirrorTokens = (balance, i, balances) => {
   return !mirrorOf || !balances.find(b => b.tokenId === mirrorOf);
 };
 
+/**
+ * Sets all balance statuses from `live-${string}` to either `live` or `cached`
+ */
+const deriveStatuses = (latestSubscriptionId, balances) => balances.map(balance => {
+  if (balance.status === "live" || balance.status === "cache" || balance.status === "stale") return balance;
+  if (!latestSubscriptionId) return {
+    ...balance,
+    status: "cache"
+  };
+  if (balance.status.slice("live-".length) !== latestSubscriptionId) 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 +263,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 +693,7 @@ class SumBalancesFormatter {
 
 exports.Balance = Balance;
 exports.BalanceFormatter = BalanceFormatter;
+exports.BalanceStatusLive = BalanceStatusLive;
 exports.Balances = Balances;
 exports.DefaultBalanceModule = DefaultBalanceModule;
 exports.FiatSumBalancesFormatter = FiatSumBalancesFormatter;
@@ -681,6 +703,7 @@ exports.TalismanBalancesDatabase = TalismanBalancesDatabase;
 exports.balances = balances;
 exports.createTypeRegistryCache = createTypeRegistryCache;
 exports.db = db;
+exports.deriveStatuses = deriveStatuses;
 exports.excludeFromFeePayableLocks = excludeFromFeePayableLocks;
 exports.excludeFromTransferableAmount = excludeFromTransferableAmount;
 exports.filterMirrorTokens = filterMirrorTokens;

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

@@ -49,14 +49,15 @@ class TalismanBalancesDatabase extends dexie.Dexie {
     super("TalismanBalances");
 
     // https://dexie.org/docs/Tutorial/Design#database-versioning
-    this.version(1).stores({
+    this.version(2).stores({
       // You only need to specify properties that you wish to index.
       // The object store will allow any properties on your stored objects but you can only query them by indexed properties
       // https://dexie.org/docs/API-Reference#declare-database
       //
       // Never index properties containing images, movies or large (huge) strings. Store them in IndexedDB, yes! but just don’t index them!
       // https://dexie.org/docs/Version/Version.stores()#warning
-      balances: "id, source, status, address, tokenId"
+      balances: "id, source, status, address, tokenId",
+      meta: "id"
     });
 
     // this.on("ready", async () => {})
@@ -67,7 +68,7 @@ const db = new TalismanBalancesDatabase();
 
 var packageJson = {
 	name: "@talismn/balances",
-	version: "0.0.0-pr660-20230327112704",
+	version: "0.0.0-pr660-20230328111733",
 	author: "Talisman",
 	homepage: "https://talisman.xyz",
 	license: "UNLICENSED",
@@ -162,6 +163,25 @@ const filterMirrorTokens = (balance, i, balances) => {
   return !mirrorOf || !balances.find(b => b.tokenId === mirrorOf);
 };
 
+/**
+ * Sets all balance statuses from `live-${string}` to either `live` or `cached`
+ */
+const deriveStatuses = (latestSubscriptionId, balances) => balances.map(balance => {
+  if (balance.status === "live" || balance.status === "cache" || balance.status === "stale") return balance;
+  if (!latestSubscriptionId) return {
+    ...balance,
+    status: "cache"
+  };
+  if (balance.status.slice("live-".length) !== latestSubscriptionId) 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 +263,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 +693,7 @@ class SumBalancesFormatter {
 
 exports.Balance = Balance;
 exports.BalanceFormatter = BalanceFormatter;
+exports.BalanceStatusLive = BalanceStatusLive;
 exports.Balances = Balances;
 exports.DefaultBalanceModule = DefaultBalanceModule;
 exports.FiatSumBalancesFormatter = FiatSumBalancesFormatter;
@@ -681,6 +703,7 @@ exports.TalismanBalancesDatabase = TalismanBalancesDatabase;
 exports.balances = balances;
 exports.createTypeRegistryCache = createTypeRegistryCache;
 exports.db = db;
+exports.deriveStatuses = deriveStatuses;
 exports.excludeFromFeePayableLocks = excludeFromFeePayableLocks;
 exports.excludeFromTransferableAmount = excludeFromTransferableAmount;
 exports.filterMirrorTokens = filterMirrorTokens;

package/dist/talismn-balances.esm.js

@@ -41,14 +41,15 @@ class TalismanBalancesDatabase extends Dexie {
     super("TalismanBalances");
 
     // https://dexie.org/docs/Tutorial/Design#database-versioning
-    this.version(1).stores({
+    this.version(2).stores({
       // You only need to specify properties that you wish to index.
       // The object store will allow any properties on your stored objects but you can only query them by indexed properties
       // https://dexie.org/docs/API-Reference#declare-database
       //
       // Never index properties containing images, movies or large (huge) strings. Store them in IndexedDB, yes! but just don’t index them!
       // https://dexie.org/docs/Version/Version.stores()#warning
-      balances: "id, source, status, address, tokenId"
+      balances: "id, source, status, address, tokenId",
+      meta: "id"
     });
 
     // this.on("ready", async () => {})
@@ -59,7 +60,7 @@ const db = new TalismanBalancesDatabase();
 
 var packageJson = {
 	name: "@talismn/balances",
-	version: "0.0.0-pr660-20230327112704",
+	version: "0.0.0-pr660-20230328111733",
 	author: "Talisman",
 	homepage: "https://talisman.xyz",
 	license: "UNLICENSED",
@@ -154,6 +155,25 @@ const filterMirrorTokens = (balance, i, balances) => {
   return !mirrorOf || !balances.find(b => b.tokenId === mirrorOf);
 };
 
+/**
+ * Sets all balance statuses from `live-${string}` to either `live` or `cached`
+ */
+const deriveStatuses = (latestSubscriptionId, balances) => balances.map(balance => {
+  if (balance.status === "live" || balance.status === "cache" || balance.status === "stale") return balance;
+  if (!latestSubscriptionId) return {
+    ...balance,
+    status: "cache"
+  };
+  if (balance.status.slice("live-".length) !== latestSubscriptionId) 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 +255,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 +683,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, createTypeRegistryCache, db, deriveStatuses, excludeFromFeePayableLocks, excludeFromTransferableAmount, filterMirrorTokens, includeInTotalExtraAmount };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@talismn/balances",
-  "version": "0.0.0-pr660-20230327112704",
+  "version": "0.0.0-pr660-20230328111733",
   "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-pr660-20230327112704",
-    "@talismn/chain-connector-evm": "^0.0.0-pr660-20230327112704",
-    "@talismn/chaindata-provider": "^0.0.0-pr660-20230327112704",
-    "@talismn/token-rates": "^0.0.0-pr660-20230327112704",
-    "@talismn/util": "^0.0.0-pr660-20230327112704",
+    "@talismn/chain-connector": "^0.0.0-pr660-20230328111733",
+    "@talismn/chain-connector-evm": "^0.0.0-pr660-20230328111733",
+    "@talismn/chaindata-provider": "^0.0.0-pr660-20230328111733",
+    "@talismn/token-rates": "^0.0.0-pr660-20230328111733",
+    "@talismn/util": "^0.0.0-pr660-20230328111733",
     "anylogger": "^1.0.11",
     "dexie": "^3.2.3"
   },