@talismn/balances-react 0.0.0-pr642-20230322025617 → 0.0.0-pr644-20230322035559

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # @talismn/balances-react
 
-## 0.0.0-pr642-20230322025617
+## 0.0.0-pr644-20230322035559
 
 ### Minor Changes
 
@@ -8,18 +8,21 @@
 
 ### Patch Changes
 
+- 3068bd6: feat: stale balances and exponential rpc backoff
 - 6643a4e: fix: tokenRates in @talismn/balances-react
 - 6643a4e: fix: ported useDbCache related perf fixes to @talismn/balances-react
+- Updated dependencies [3068bd6]
 - Updated dependencies [6643a4e]
 - Updated dependencies [79f6ccf]
 - Updated dependencies [6643a4e]
 - Updated dependencies [c24dc1f]
-  - @talismn/token-rates@0.0.0-pr642-20230322025617
-  - @talismn/balances@0.0.0-pr642-20230322025617
-  - @talismn/chaindata-provider-extension@0.0.0-pr642-20230322025617
-  - @talismn/chaindata-provider@0.0.0-pr642-20230322025617
-  - @talismn/chain-connector@0.0.0-pr642-20230322025617
-  - @talismn/chain-connector-evm@0.0.0-pr642-20230322025617
+  - @talismn/chain-connector@0.0.0-pr644-20230322035559
+  - @talismn/connection-meta@0.0.0-pr644-20230322035559
+  - @talismn/balances@0.0.0-pr644-20230322035559
+  - @talismn/token-rates@0.0.0-pr644-20230322035559
+  - @talismn/chaindata-provider-extension@0.0.0-pr644-20230322035559
+  - @talismn/chaindata-provider@0.0.0-pr644-20230322035559
+  - @talismn/chain-connector-evm@0.0.0-pr644-20230322035559
 
 ## 0.3.3
 

package/dist/declarations/src/hooks/index.d.ts

@@ -2,6 +2,7 @@ export * from "./useAllAddresses";
 export * from "./useBalanceModules";
 export * from "./useBalances";
 export * from "./useBalancesHydrate";
+export * from "./useBalancesStatus";
 export * from "./useChainConnectors";
 export * from "./useChaindata";
 export * from "./useChains";

package/dist/declarations/src/hooks/useBalancesStatus.d.ts

@@ -0,0 +1,19 @@
+import { Balances } from "@talismn/balances";
+export type BalancesStatus = {
+    status: "live";
+} | {
+    status: "fetching";
+} | {
+    status: "stale";
+    staleChains: string[];
+};
+/**
+ * Given a collection of `Balances`, this hook returns a `BalancesStatus` summary for the collection.
+ *
+ * @param balances The collection of balances to get the status from.
+ * @param isLoadingLocks Because the wallet currently fetches locks outside of the balances api, this param can be used to indicate that the locks are still loading, even if the `Balances` collection is not.
+ * @returns An instance of `BalancesStatus` which represents the status of the balances collection.
+
+ */
+export declare const useBalancesStatus: (balances: Balances, isLoadingLocks?: boolean) => BalancesStatus;
+export declare const getStaleChains: (balances: Balances) => string[];

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

@@ -6,6 +6,7 @@ var react = require('react');
 var jsxRuntime = require('react/jsx-runtime');
 var chainConnector = require('@talismn/chain-connector');
 var chainConnectorEvm = require('@talismn/chain-connector-evm');
+var connectionMeta = require('@talismn/connection-meta');
 var chaindataProviderExtension = require('@talismn/chaindata-provider-extension');
 var balances = require('@talismn/balances');
 var tokenRates = require('@talismn/token-rates');
@@ -73,7 +74,7 @@ function useChainConnectorsProvider(options) {
   const chaindata = useChaindata();
 
   // substrate connector
-  const substrate = react.useMemo(() => new chainConnector.ChainConnector(chaindata), [chaindata]);
+  const substrate = react.useMemo(() => new chainConnector.ChainConnector(chaindata, connectionMeta.connectionMetaDb), [chaindata]);
 
   // evm connector
   const evm = react.useMemo(() => new chainConnectorEvm.ChainConnectorEvm(chaindata, {
@@ -199,7 +200,7 @@ const [DbCacheProvider, useDbCache] = provideContext(useDbCacheProvider);
 
 var packageJson = {
 	name: "@talismn/balances-react",
-	version: "0.0.0-pr642-20230322025617",
+	version: "0.0.0-pr644-20230322035559",
 	author: "Talisman",
 	homepage: "https://talisman.xyz",
 	license: "UNLICENSED",
@@ -230,6 +231,7 @@ var packageJson = {
 		"@talismn/chain-connector-evm": "workspace:^",
 		"@talismn/chaindata-provider": "workspace:^",
 		"@talismn/chaindata-provider-extension": "workspace:^",
+		"@talismn/connection-meta": "workspace:^",
 		"@talismn/token-rates": "workspace:^",
 		anylogger: "^1.0.11",
 		"blueimp-md5": "2.19.0",
@@ -313,20 +315,6 @@ const useSharedSubscription = (key, subscribe) => {
   }, [key, subscribe]);
 };
 
-function useTokens(withTestnets) {
-  // keep db data up to date
-  useDbCacheSubscription("tokens");
-  const {
-    tokensWithTestnetsMap,
-    tokensWithoutTestnetsMap
-  } = useDbCache();
-  return withTestnets ? tokensWithTestnetsMap : tokensWithoutTestnetsMap;
-}
-function useToken(tokenId, withTestnets) {
-  const tokens = useTokens(withTestnets);
-  return tokenId ? tokens[tokenId] : undefined;
-}
-
 /**
  * Creates a subscription function that can be used to subscribe to a multicast observable created from an upstream source.
  *
@@ -404,7 +392,7 @@ function useDbCacheTokenRatesSubscription() {
   const {
     withTestnets
   } = useWithTestnets();
-  const tokens = useTokens(withTestnets);
+  const tokens = useTokens$1(withTestnets);
   const subscriptionKey = react.useMemo(
   // not super sexy but we need key to change based on this stuff
   () => {
@@ -431,7 +419,7 @@ function useDbCacheBalancesSubscription() {
   const chaindataProvider = useChaindata();
   const chainConnectors = useChainConnectors();
   const [allAddresses] = useAllAddresses();
-  const tokens = useTokens(withTestnets);
+  const tokens = useTokens$1(withTestnets);
   const subscriptionKey = react.useMemo(
   // not super sexy but we need key to change based on this stuff
   () => {
@@ -442,10 +430,19 @@ function useDbCacheBalancesSubscription() {
   }, [allAddresses, balanceModules, chainConnectors, chaindataProvider, tokens]);
   const subscription = react.useCallback(() => {
     if (!Object.values(tokens ?? {}).length || !allAddresses.length) return () => {};
-    return subscribeBalances(tokens ?? {}, allAddresses, chainConnectors, chaindataProvider, balanceModules);
-  }, [allAddresses, balanceModules, chainConnectors, chaindataProvider, tokens]);
+    return subscribeBalances(tokens ?? {}, allAddresses, balanceModules);
+  }, [allAddresses, balanceModules, tokens]);
   useSharedSubscription(subscriptionKey, subscription);
 }
+
+// subscriptionless version of useTokens, prevents circular dependency
+const useTokens$1 = withTestnets => {
+  const {
+    tokensWithTestnetsMap,
+    tokensWithoutTestnetsMap
+  } = useDbCache();
+  return withTestnets ? tokensWithTestnetsMap : tokensWithoutTestnetsMap;
+};
 const subscribeChainDataHydrate = (provider, type) => {
   const chaindata = provider;
   const delay = 300_000; // 300_000ms = 300s = 5 minutes
@@ -501,7 +498,7 @@ const subscribeTokenRates = tokens => {
     if (timeout) clearTimeout(timeout);
   };
 };
-const subscribeBalances = (tokens, addresses, chainConnectors, provider, balanceModules) => {
+const subscribeBalances = (tokens, addresses, balanceModules) => {
   const tokenIds = Object.values(tokens).map(({
     id
   }) => id);
@@ -525,28 +522,41 @@ const subscribeBalances = (tokens, addresses, chainConnectors, provider, balance
       id
     }) => id);
     const addressesByModuleToken = Object.fromEntries(Object.entries(addressesByToken).filter(([tokenId]) => moduleTokenIds.includes(tokenId)));
-    const unsub = balances.balances(balanceModule, addressesByModuleToken, (error, balances) => {
+    const unsub = balances.balances(balanceModule, addressesByModuleToken, (error, balances$1) => {
       // log errors
-      if (error) return log.error(`Failed to fetch ${balanceModule.type} balances`, error);
+      if (error) {
+        if (error?.type === "STALE_RPC_ERROR") return balances.db.balances.where({
+          source: balanceModule.type,
+          chainId: error.chainId
+        }).filter(balance => {
+          if (!Object.keys(addressesByModuleToken).includes(balance.tokenId)) return false;
+          if (!addressesByModuleToken[balance.tokenId].includes(balance.address)) return false;
+          return true;
+        }).modify({
+          status: "stale"
+        });
+        return log.error(`Failed to fetch ${balanceModule.type} balances`, error);
+      }
       // ignore empty balance responses
-      if (!balances) return;
+      if (!balances$1) return;
       // ignore balances from old subscriptions which are still in the process of unsubscribing
       if (unsubscribed) return;
-      updateDb(balances);
+      updateDb(balances$1);
     });
     return () => {
       // wait 2 seconds before actually unsubscribing, allowing for websocket to be reused
       unsub.then(unsubscribe => {
         setTimeout(unsubscribe, 2_000);
       });
-      balances.db.transaction("rw", balances.db.balances, async () => await balances.db.balances.filter(balance => {
-        if (balance.source !== balanceModule.type) return false;
+      balances.db.balances.where({
+        source: balanceModule.type
+      }).filter(balance => {
         if (!Object.keys(addressesByModuleToken).includes(balance.tokenId)) return false;
         if (!addressesByModuleToken[balance.tokenId].includes(balance.address)) return false;
         return true;
       }).modify({
         status: "cache"
-      }));
+      });
     };
   });
   const unsubscribeAll = () => {
@@ -597,6 +607,20 @@ function useTokenRate(tokenId) {
   return tokenId ? tokenRates[tokenId] : undefined;
 }
 
+function useTokens(withTestnets) {
+  // keep db data up to date
+  useDbCacheSubscription("tokens");
+  const {
+    tokensWithTestnetsMap,
+    tokensWithoutTestnetsMap
+  } = useDbCache();
+  return withTestnets ? tokensWithTestnetsMap : tokensWithoutTestnetsMap;
+}
+function useToken(tokenId, withTestnets) {
+  const tokens = useTokens(withTestnets);
+  return tokenId ? tokens[tokenId] : undefined;
+}
+
 const useBalancesHydrate = () => {
   const {
     withTestnets
@@ -643,6 +667,35 @@ function useBalances(addressesByToken) {
   hydrate), [balances$1, hydrate, balanceModules, addressesByToken]);
 }
 
+/**
+ * Given a collection of `Balances`, this hook returns a `BalancesStatus` summary for the collection.
+ *
+ * @param balances The collection of balances to get the status from.
+ * @param isLoadingLocks Because the wallet currently fetches locks outside of the balances api, this param can be used to indicate that the locks are still loading, even if the `Balances` collection is not.
+ * @returns An instance of `BalancesStatus` which represents the status of the balances collection.
+
+ */
+const useBalancesStatus = (balances, isLoadingLocks) => react.useMemo(() => {
+  // stale
+  const staleChains = getStaleChains(balances);
+  if (staleChains.length > 0) return {
+    status: "stale",
+    staleChains
+  };
+
+  // fetching
+  const hasCachedBalances = balances.each.some(b => b.status === "cache");
+  if (hasCachedBalances || isLoadingLocks) return {
+    status: "fetching"
+  };
+
+  // live
+  return {
+    status: "live"
+  };
+}, [balances, isLoadingLocks]);
+const getStaleChains = balances => [...new Set(balances.sorted.filter(b => b.status === "stale").map(b => b.chain?.name ?? b.chainId ?? "Unknown"))];
+
 const BalancesProvider = ({
   balanceModules,
   onfinalityApiKey,
@@ -674,11 +727,13 @@ exports.ChaindataProvider = ChaindataProvider;
 exports.DbCacheProvider = DbCacheProvider;
 exports.WithTestnetsProvider = WithTestnetsProvider;
 exports.createMulticastSubscription = createMulticastSubscription;
+exports.getStaleChains = getStaleChains;
 exports.provideContext = provideContext;
 exports.useAllAddresses = useAllAddresses;
 exports.useBalanceModules = useBalanceModules;
 exports.useBalances = useBalances;
 exports.useBalancesHydrate = useBalancesHydrate;
+exports.useBalancesStatus = useBalancesStatus;
 exports.useChain = useChain;
 exports.useChainConnectors = useChainConnectors;
 exports.useChaindata = useChaindata;

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

@@ -6,6 +6,7 @@ var react = require('react');
 var jsxRuntime = require('react/jsx-runtime');
 var chainConnector = require('@talismn/chain-connector');
 var chainConnectorEvm = require('@talismn/chain-connector-evm');
+var connectionMeta = require('@talismn/connection-meta');
 var chaindataProviderExtension = require('@talismn/chaindata-provider-extension');
 var balances = require('@talismn/balances');
 var tokenRates = require('@talismn/token-rates');
@@ -73,7 +74,7 @@ function useChainConnectorsProvider(options) {
   const chaindata = useChaindata();
 
   // substrate connector
-  const substrate = react.useMemo(() => new chainConnector.ChainConnector(chaindata), [chaindata]);
+  const substrate = react.useMemo(() => new chainConnector.ChainConnector(chaindata, connectionMeta.connectionMetaDb), [chaindata]);
 
   // evm connector
   const evm = react.useMemo(() => new chainConnectorEvm.ChainConnectorEvm(chaindata, {
@@ -199,7 +200,7 @@ const [DbCacheProvider, useDbCache] = provideContext(useDbCacheProvider);
 
 var packageJson = {
 	name: "@talismn/balances-react",
-	version: "0.0.0-pr642-20230322025617",
+	version: "0.0.0-pr644-20230322035559",
 	author: "Talisman",
 	homepage: "https://talisman.xyz",
 	license: "UNLICENSED",
@@ -230,6 +231,7 @@ var packageJson = {
 		"@talismn/chain-connector-evm": "workspace:^",
 		"@talismn/chaindata-provider": "workspace:^",
 		"@talismn/chaindata-provider-extension": "workspace:^",
+		"@talismn/connection-meta": "workspace:^",
 		"@talismn/token-rates": "workspace:^",
 		anylogger: "^1.0.11",
 		"blueimp-md5": "2.19.0",
@@ -313,20 +315,6 @@ const useSharedSubscription = (key, subscribe) => {
   }, [key, subscribe]);
 };
 
-function useTokens(withTestnets) {
-  // keep db data up to date
-  useDbCacheSubscription("tokens");
-  const {
-    tokensWithTestnetsMap,
-    tokensWithoutTestnetsMap
-  } = useDbCache();
-  return withTestnets ? tokensWithTestnetsMap : tokensWithoutTestnetsMap;
-}
-function useToken(tokenId, withTestnets) {
-  const tokens = useTokens(withTestnets);
-  return tokenId ? tokens[tokenId] : undefined;
-}
-
 /**
  * Creates a subscription function that can be used to subscribe to a multicast observable created from an upstream source.
  *
@@ -404,7 +392,7 @@ function useDbCacheTokenRatesSubscription() {
   const {
     withTestnets
   } = useWithTestnets();
-  const tokens = useTokens(withTestnets);
+  const tokens = useTokens$1(withTestnets);
   const subscriptionKey = react.useMemo(
   // not super sexy but we need key to change based on this stuff
   () => {
@@ -431,7 +419,7 @@ function useDbCacheBalancesSubscription() {
   const chaindataProvider = useChaindata();
   const chainConnectors = useChainConnectors();
   const [allAddresses] = useAllAddresses();
-  const tokens = useTokens(withTestnets);
+  const tokens = useTokens$1(withTestnets);
   const subscriptionKey = react.useMemo(
   // not super sexy but we need key to change based on this stuff
   () => {
@@ -442,10 +430,19 @@ function useDbCacheBalancesSubscription() {
   }, [allAddresses, balanceModules, chainConnectors, chaindataProvider, tokens]);
   const subscription = react.useCallback(() => {
     if (!Object.values(tokens ?? {}).length || !allAddresses.length) return () => {};
-    return subscribeBalances(tokens ?? {}, allAddresses, chainConnectors, chaindataProvider, balanceModules);
-  }, [allAddresses, balanceModules, chainConnectors, chaindataProvider, tokens]);
+    return subscribeBalances(tokens ?? {}, allAddresses, balanceModules);
+  }, [allAddresses, balanceModules, tokens]);
   useSharedSubscription(subscriptionKey, subscription);
 }
+
+// subscriptionless version of useTokens, prevents circular dependency
+const useTokens$1 = withTestnets => {
+  const {
+    tokensWithTestnetsMap,
+    tokensWithoutTestnetsMap
+  } = useDbCache();
+  return withTestnets ? tokensWithTestnetsMap : tokensWithoutTestnetsMap;
+};
 const subscribeChainDataHydrate = (provider, type) => {
   const chaindata = provider;
   const delay = 300_000; // 300_000ms = 300s = 5 minutes
@@ -501,7 +498,7 @@ const subscribeTokenRates = tokens => {
     if (timeout) clearTimeout(timeout);
   };
 };
-const subscribeBalances = (tokens, addresses, chainConnectors, provider, balanceModules) => {
+const subscribeBalances = (tokens, addresses, balanceModules) => {
   const tokenIds = Object.values(tokens).map(({
     id
   }) => id);
@@ -525,28 +522,41 @@ const subscribeBalances = (tokens, addresses, chainConnectors, provider, balance
       id
     }) => id);
     const addressesByModuleToken = Object.fromEntries(Object.entries(addressesByToken).filter(([tokenId]) => moduleTokenIds.includes(tokenId)));
-    const unsub = balances.balances(balanceModule, addressesByModuleToken, (error, balances) => {
+    const unsub = balances.balances(balanceModule, addressesByModuleToken, (error, balances$1) => {
       // log errors
-      if (error) return log.error(`Failed to fetch ${balanceModule.type} balances`, error);
+      if (error) {
+        if (error?.type === "STALE_RPC_ERROR") return balances.db.balances.where({
+          source: balanceModule.type,
+          chainId: error.chainId
+        }).filter(balance => {
+          if (!Object.keys(addressesByModuleToken).includes(balance.tokenId)) return false;
+          if (!addressesByModuleToken[balance.tokenId].includes(balance.address)) return false;
+          return true;
+        }).modify({
+          status: "stale"
+        });
+        return log.error(`Failed to fetch ${balanceModule.type} balances`, error);
+      }
       // ignore empty balance responses
-      if (!balances) return;
+      if (!balances$1) return;
       // ignore balances from old subscriptions which are still in the process of unsubscribing
       if (unsubscribed) return;
-      updateDb(balances);
+      updateDb(balances$1);
     });
     return () => {
       // wait 2 seconds before actually unsubscribing, allowing for websocket to be reused
       unsub.then(unsubscribe => {
         setTimeout(unsubscribe, 2_000);
       });
-      balances.db.transaction("rw", balances.db.balances, async () => await balances.db.balances.filter(balance => {
-        if (balance.source !== balanceModule.type) return false;
+      balances.db.balances.where({
+        source: balanceModule.type
+      }).filter(balance => {
         if (!Object.keys(addressesByModuleToken).includes(balance.tokenId)) return false;
         if (!addressesByModuleToken[balance.tokenId].includes(balance.address)) return false;
         return true;
       }).modify({
         status: "cache"
-      }));
+      });
     };
   });
   const unsubscribeAll = () => {
@@ -597,6 +607,20 @@ function useTokenRate(tokenId) {
   return tokenId ? tokenRates[tokenId] : undefined;
 }
 
+function useTokens(withTestnets) {
+  // keep db data up to date
+  useDbCacheSubscription("tokens");
+  const {
+    tokensWithTestnetsMap,
+    tokensWithoutTestnetsMap
+  } = useDbCache();
+  return withTestnets ? tokensWithTestnetsMap : tokensWithoutTestnetsMap;
+}
+function useToken(tokenId, withTestnets) {
+  const tokens = useTokens(withTestnets);
+  return tokenId ? tokens[tokenId] : undefined;
+}
+
 const useBalancesHydrate = () => {
   const {
     withTestnets
@@ -643,6 +667,35 @@ function useBalances(addressesByToken) {
   hydrate), [balances$1, hydrate, balanceModules, addressesByToken]);
 }
 
+/**
+ * Given a collection of `Balances`, this hook returns a `BalancesStatus` summary for the collection.
+ *
+ * @param balances The collection of balances to get the status from.
+ * @param isLoadingLocks Because the wallet currently fetches locks outside of the balances api, this param can be used to indicate that the locks are still loading, even if the `Balances` collection is not.
+ * @returns An instance of `BalancesStatus` which represents the status of the balances collection.
+
+ */
+const useBalancesStatus = (balances, isLoadingLocks) => react.useMemo(() => {
+  // stale
+  const staleChains = getStaleChains(balances);
+  if (staleChains.length > 0) return {
+    status: "stale",
+    staleChains
+  };
+
+  // fetching
+  const hasCachedBalances = balances.each.some(b => b.status === "cache");
+  if (hasCachedBalances || isLoadingLocks) return {
+    status: "fetching"
+  };
+
+  // live
+  return {
+    status: "live"
+  };
+}, [balances, isLoadingLocks]);
+const getStaleChains = balances => [...new Set(balances.sorted.filter(b => b.status === "stale").map(b => b.chain?.name ?? b.chainId ?? "Unknown"))];
+
 const BalancesProvider = ({
   balanceModules,
   onfinalityApiKey,
@@ -674,11 +727,13 @@ exports.ChaindataProvider = ChaindataProvider;
 exports.DbCacheProvider = DbCacheProvider;
 exports.WithTestnetsProvider = WithTestnetsProvider;
 exports.createMulticastSubscription = createMulticastSubscription;
+exports.getStaleChains = getStaleChains;
 exports.provideContext = provideContext;
 exports.useAllAddresses = useAllAddresses;
 exports.useBalanceModules = useBalanceModules;
 exports.useBalances = useBalances;
 exports.useBalancesHydrate = useBalancesHydrate;
+exports.useBalancesStatus = useBalancesStatus;
 exports.useChain = useChain;
 exports.useChainConnectors = useChainConnectors;
 exports.useChaindata = useChaindata;

package/dist/talismn-balances-react.esm.js

@@ -2,6 +2,7 @@ import { useContext, createContext, useState, useEffect, useMemo, useRef, useCal
 import { jsx } from 'react/jsx-runtime';
 import { ChainConnector } from '@talismn/chain-connector';
 import { ChainConnectorEvm } from '@talismn/chain-connector-evm';
+import { connectionMetaDb } from '@talismn/connection-meta';
 import { ChaindataProviderExtension } from '@talismn/chaindata-provider-extension';
 import { db as db$1, balances, Balances } from '@talismn/balances';
 import { db, fetchTokenRates } from '@talismn/token-rates';
@@ -64,7 +65,7 @@ function useChainConnectorsProvider(options) {
   const chaindata = useChaindata();
 
   // substrate connector
-  const substrate = useMemo(() => new ChainConnector(chaindata), [chaindata]);
+  const substrate = useMemo(() => new ChainConnector(chaindata, connectionMetaDb), [chaindata]);
 
   // evm connector
   const evm = useMemo(() => new ChainConnectorEvm(chaindata, {
@@ -190,7 +191,7 @@ const [DbCacheProvider, useDbCache] = provideContext(useDbCacheProvider);
 
 var packageJson = {
 	name: "@talismn/balances-react",
-	version: "0.0.0-pr642-20230322025617",
+	version: "0.0.0-pr644-20230322035559",
 	author: "Talisman",
 	homepage: "https://talisman.xyz",
 	license: "UNLICENSED",
@@ -221,6 +222,7 @@ var packageJson = {
 		"@talismn/chain-connector-evm": "workspace:^",
 		"@talismn/chaindata-provider": "workspace:^",
 		"@talismn/chaindata-provider-extension": "workspace:^",
+		"@talismn/connection-meta": "workspace:^",
 		"@talismn/token-rates": "workspace:^",
 		anylogger: "^1.0.11",
 		"blueimp-md5": "2.19.0",
@@ -304,20 +306,6 @@ const useSharedSubscription = (key, subscribe) => {
   }, [key, subscribe]);
 };
 
-function useTokens(withTestnets) {
-  // keep db data up to date
-  useDbCacheSubscription("tokens");
-  const {
-    tokensWithTestnetsMap,
-    tokensWithoutTestnetsMap
-  } = useDbCache();
-  return withTestnets ? tokensWithTestnetsMap : tokensWithoutTestnetsMap;
-}
-function useToken(tokenId, withTestnets) {
-  const tokens = useTokens(withTestnets);
-  return tokenId ? tokens[tokenId] : undefined;
-}
-
 /**
  * Creates a subscription function that can be used to subscribe to a multicast observable created from an upstream source.
  *
@@ -395,7 +383,7 @@ function useDbCacheTokenRatesSubscription() {
   const {
     withTestnets
   } = useWithTestnets();
-  const tokens = useTokens(withTestnets);
+  const tokens = useTokens$1(withTestnets);
   const subscriptionKey = useMemo(
   // not super sexy but we need key to change based on this stuff
   () => {
@@ -422,7 +410,7 @@ function useDbCacheBalancesSubscription() {
   const chaindataProvider = useChaindata();
   const chainConnectors = useChainConnectors();
   const [allAddresses] = useAllAddresses();
-  const tokens = useTokens(withTestnets);
+  const tokens = useTokens$1(withTestnets);
   const subscriptionKey = useMemo(
   // not super sexy but we need key to change based on this stuff
   () => {
@@ -433,10 +421,19 @@ function useDbCacheBalancesSubscription() {
   }, [allAddresses, balanceModules, chainConnectors, chaindataProvider, tokens]);
   const subscription = useCallback(() => {
     if (!Object.values(tokens ?? {}).length || !allAddresses.length) return () => {};
-    return subscribeBalances(tokens ?? {}, allAddresses, chainConnectors, chaindataProvider, balanceModules);
-  }, [allAddresses, balanceModules, chainConnectors, chaindataProvider, tokens]);
+    return subscribeBalances(tokens ?? {}, allAddresses, balanceModules);
+  }, [allAddresses, balanceModules, tokens]);
   useSharedSubscription(subscriptionKey, subscription);
 }
+
+// subscriptionless version of useTokens, prevents circular dependency
+const useTokens$1 = withTestnets => {
+  const {
+    tokensWithTestnetsMap,
+    tokensWithoutTestnetsMap
+  } = useDbCache();
+  return withTestnets ? tokensWithTestnetsMap : tokensWithoutTestnetsMap;
+};
 const subscribeChainDataHydrate = (provider, type) => {
   const chaindata = provider;
   const delay = 300_000; // 300_000ms = 300s = 5 minutes
@@ -492,7 +489,7 @@ const subscribeTokenRates = tokens => {
     if (timeout) clearTimeout(timeout);
   };
 };
-const subscribeBalances = (tokens, addresses, chainConnectors, provider, balanceModules) => {
+const subscribeBalances = (tokens, addresses, balanceModules) => {
   const tokenIds = Object.values(tokens).map(({
     id
   }) => id);
@@ -518,7 +515,19 @@ const subscribeBalances = (tokens, addresses, chainConnectors, provider, balance
     const addressesByModuleToken = Object.fromEntries(Object.entries(addressesByToken).filter(([tokenId]) => moduleTokenIds.includes(tokenId)));
     const unsub = balances(balanceModule, addressesByModuleToken, (error, balances) => {
       // log errors
-      if (error) return log.error(`Failed to fetch ${balanceModule.type} balances`, error);
+      if (error) {
+        if (error?.type === "STALE_RPC_ERROR") return db$1.balances.where({
+          source: balanceModule.type,
+          chainId: error.chainId
+        }).filter(balance => {
+          if (!Object.keys(addressesByModuleToken).includes(balance.tokenId)) return false;
+          if (!addressesByModuleToken[balance.tokenId].includes(balance.address)) return false;
+          return true;
+        }).modify({
+          status: "stale"
+        });
+        return log.error(`Failed to fetch ${balanceModule.type} balances`, error);
+      }
       // ignore empty balance responses
       if (!balances) return;
       // ignore balances from old subscriptions which are still in the process of unsubscribing
@@ -530,14 +539,15 @@ const subscribeBalances = (tokens, addresses, chainConnectors, provider, balance
       unsub.then(unsubscribe => {
         setTimeout(unsubscribe, 2_000);
       });
-      db$1.transaction("rw", db$1.balances, async () => await db$1.balances.filter(balance => {
-        if (balance.source !== balanceModule.type) return false;
+      db$1.balances.where({
+        source: balanceModule.type
+      }).filter(balance => {
         if (!Object.keys(addressesByModuleToken).includes(balance.tokenId)) return false;
         if (!addressesByModuleToken[balance.tokenId].includes(balance.address)) return false;
         return true;
       }).modify({
         status: "cache"
-      }));
+      });
     };
   });
   const unsubscribeAll = () => {
@@ -588,6 +598,20 @@ function useTokenRate(tokenId) {
   return tokenId ? tokenRates[tokenId] : undefined;
 }
 
+function useTokens(withTestnets) {
+  // keep db data up to date
+  useDbCacheSubscription("tokens");
+  const {
+    tokensWithTestnetsMap,
+    tokensWithoutTestnetsMap
+  } = useDbCache();
+  return withTestnets ? tokensWithTestnetsMap : tokensWithoutTestnetsMap;
+}
+function useToken(tokenId, withTestnets) {
+  const tokens = useTokens(withTestnets);
+  return tokenId ? tokens[tokenId] : undefined;
+}
+
 const useBalancesHydrate = () => {
   const {
     withTestnets
@@ -634,6 +658,35 @@ function useBalances(addressesByToken) {
   hydrate), [balances, hydrate, balanceModules, addressesByToken]);
 }
 
+/**
+ * Given a collection of `Balances`, this hook returns a `BalancesStatus` summary for the collection.
+ *
+ * @param balances The collection of balances to get the status from.
+ * @param isLoadingLocks Because the wallet currently fetches locks outside of the balances api, this param can be used to indicate that the locks are still loading, even if the `Balances` collection is not.
+ * @returns An instance of `BalancesStatus` which represents the status of the balances collection.
+
+ */
+const useBalancesStatus = (balances, isLoadingLocks) => useMemo(() => {
+  // stale
+  const staleChains = getStaleChains(balances);
+  if (staleChains.length > 0) return {
+    status: "stale",
+    staleChains
+  };
+
+  // fetching
+  const hasCachedBalances = balances.each.some(b => b.status === "cache");
+  if (hasCachedBalances || isLoadingLocks) return {
+    status: "fetching"
+  };
+
+  // live
+  return {
+    status: "live"
+  };
+}, [balances, isLoadingLocks]);
+const getStaleChains = balances => [...new Set(balances.sorted.filter(b => b.status === "stale").map(b => b.chain?.name ?? b.chainId ?? "Unknown"))];
+
 const BalancesProvider = ({
   balanceModules,
   onfinalityApiKey,
@@ -657,4 +710,4 @@ const BalancesProvider = ({
   })
 });
 
-export { AllAddressesProvider, BalanceModulesProvider, BalancesProvider, ChainConnectorsProvider, ChaindataProvider, DbCacheProvider, WithTestnetsProvider, createMulticastSubscription, provideContext, useAllAddresses, useBalanceModules, useBalances, useBalancesHydrate, useChain, useChainConnectors, useChaindata, useChains, useDbCache, useDbCacheBalancesSubscription, useDbCacheSubscription, useDbCacheTokenRatesSubscription, useEvmNetwork, useEvmNetworks, useMulticastSubscription, useToken, useTokenRate, useTokenRates, useTokens, useWithTestnets };
+export { AllAddressesProvider, BalanceModulesProvider, BalancesProvider, ChainConnectorsProvider, ChaindataProvider, DbCacheProvider, WithTestnetsProvider, createMulticastSubscription, getStaleChains, provideContext, useAllAddresses, useBalanceModules, useBalances, useBalancesHydrate, useBalancesStatus, useChain, useChainConnectors, useChaindata, useChains, useDbCache, useDbCacheBalancesSubscription, useDbCacheSubscription, useDbCacheTokenRatesSubscription, useEvmNetwork, useEvmNetworks, useMulticastSubscription, useToken, useTokenRate, useTokenRates, useTokens, useWithTestnets };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@talismn/balances-react",
-  "version": "0.0.0-pr642-20230322025617",
+  "version": "0.0.0-pr644-20230322035559",
   "author": "Talisman",
   "homepage": "https://talisman.xyz",
   "license": "UNLICENSED",
@@ -26,12 +26,13 @@
     "clean": "rm -rf dist && rm -rf .turbo rm -rf node_modules"
   },
   "dependencies": {
-    "@talismn/balances": "^0.0.0-pr642-20230322025617",
-    "@talismn/chain-connector": "^0.0.0-pr642-20230322025617",
-    "@talismn/chain-connector-evm": "^0.0.0-pr642-20230322025617",
-    "@talismn/chaindata-provider": "^0.0.0-pr642-20230322025617",
-    "@talismn/chaindata-provider-extension": "^0.0.0-pr642-20230322025617",
-    "@talismn/token-rates": "^0.0.0-pr642-20230322025617",
+    "@talismn/balances": "^0.0.0-pr644-20230322035559",
+    "@talismn/chain-connector": "^0.0.0-pr644-20230322035559",
+    "@talismn/chain-connector-evm": "^0.0.0-pr644-20230322035559",
+    "@talismn/chaindata-provider": "^0.0.0-pr644-20230322035559",
+    "@talismn/chaindata-provider-extension": "^0.0.0-pr644-20230322035559",
+    "@talismn/connection-meta": "^0.0.0-pr644-20230322035559",
+    "@talismn/token-rates": "^0.0.0-pr644-20230322035559",
     "anylogger": "^1.0.11",
     "blueimp-md5": "2.19.0",
     "dexie": "^3.2.3",