@talismn/balances-react 0.0.0-pr611-20230314172319 → 0.0.0-pr611-20230316232708

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # @talismn/balances-react
 
-## 0.0.0-pr611-20230314172319
+## 0.0.0-pr611-20230316232708
 
 ### Minor Changes
 
@@ -15,13 +15,13 @@
 - Updated dependencies [6643a4e]
 - Updated dependencies [79f6ccf]
 - Updated dependencies [6643a4e]
-  - @talismn/chain-connector@0.0.0-pr611-20230314172319
-  - @talismn/connection-meta@0.0.0-pr611-20230314172319
-  - @talismn/balances@0.0.0-pr611-20230314172319
-  - @talismn/token-rates@0.0.0-pr611-20230314172319
-  - @talismn/chaindata-provider-extension@0.0.0-pr611-20230314172319
-  - @talismn/chaindata-provider@0.0.0-pr611-20230314172319
-  - @talismn/chain-connector-evm@0.0.0-pr611-20230314172319
+  - @talismn/chain-connector@0.0.0-pr611-20230316232708
+  - @talismn/connection-meta@0.0.0-pr611-20230316232708
+  - @talismn/balances@0.0.0-pr611-20230316232708
+  - @talismn/token-rates@0.0.0-pr611-20230316232708
+  - @talismn/chaindata-provider-extension@0.0.0-pr611-20230316232708
+  - @talismn/chaindata-provider@0.0.0-pr611-20230316232708
+  - @talismn/chain-connector-evm@0.0.0-pr611-20230316232708
 
 ## 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

@@ -174,9 +174,9 @@ const consolidateDbCache = (chainsMap, evmNetworksMap, tokensMap, tokenRates, al
 };
 const useDbCacheProvider = () => {
   const chaindataProvider = useChaindata();
-  const chainList = dexieReactHooks.useLiveQuery(() => chaindataProvider === null || chaindataProvider === void 0 ? void 0 : chaindataProvider.chains(), [chaindataProvider]);
-  const evmNetworkList = dexieReactHooks.useLiveQuery(() => chaindataProvider === null || chaindataProvider === void 0 ? void 0 : chaindataProvider.evmNetworks(), [chaindataProvider]);
-  const tokenList = dexieReactHooks.useLiveQuery(() => chaindataProvider === null || chaindataProvider === void 0 ? void 0 : chaindataProvider.tokens(), [chaindataProvider]);
+  const chainList = dexieReactHooks.useLiveQuery(() => chaindataProvider?.chains(), [chaindataProvider]);
+  const evmNetworkList = dexieReactHooks.useLiveQuery(() => chaindataProvider?.evmNetworks(), [chaindataProvider]);
+  const tokenList = dexieReactHooks.useLiveQuery(() => chaindataProvider?.tokens(), [chaindataProvider]);
   const tokenRates$1 = dexieReactHooks.useLiveQuery(() => tokenRates.db.tokenRates.toArray(), []);
   const rawBalances = dexieReactHooks.useLiveQuery(() => balances.db.balances.toArray(), []);
   const [dbData, setDbData] = react.useState(DEFAULT_VALUE);
@@ -200,7 +200,7 @@ const [DbCacheProvider, useDbCache] = provideContext(useDbCacheProvider);
 
 var packageJson = {
 	name: "@talismn/balances-react",
-	version: "0.0.0-pr611-20230314172319",
+	version: "0.0.0-pr611-20230316232708",
 	author: "Talisman",
 	homepage: "https://talisman.xyz",
 	license: "UNLICENSED",
@@ -218,7 +218,7 @@ var packageJson = {
 		"/dist"
 	],
 	engines: {
-		node: ">=14"
+		node: ">=18"
 	},
 	scripts: {
 		test: "jest",
@@ -530,7 +530,7 @@ const subscribeBalances = (tokens, addresses, balanceModules) => {
     const unsub = balances.balances(balanceModule, addressesByModuleToken, (error, balances$1) => {
       // log errors
       if (error) {
-        if ((error === null || error === void 0 ? void 0 : error.type) === "STALE_RPC_ERROR") return balances.db.balances.where({
+        if (error?.type === "STALE_RPC_ERROR") return balances.db.balances.where({
           source: balanceModule.type,
           chainId: error.chainId
         }).filter(balance => {
@@ -658,6 +658,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,
@@ -689,11 +718,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

@@ -174,9 +174,9 @@ const consolidateDbCache = (chainsMap, evmNetworksMap, tokensMap, tokenRates, al
 };
 const useDbCacheProvider = () => {
   const chaindataProvider = useChaindata();
-  const chainList = dexieReactHooks.useLiveQuery(() => chaindataProvider === null || chaindataProvider === void 0 ? void 0 : chaindataProvider.chains(), [chaindataProvider]);
-  const evmNetworkList = dexieReactHooks.useLiveQuery(() => chaindataProvider === null || chaindataProvider === void 0 ? void 0 : chaindataProvider.evmNetworks(), [chaindataProvider]);
-  const tokenList = dexieReactHooks.useLiveQuery(() => chaindataProvider === null || chaindataProvider === void 0 ? void 0 : chaindataProvider.tokens(), [chaindataProvider]);
+  const chainList = dexieReactHooks.useLiveQuery(() => chaindataProvider?.chains(), [chaindataProvider]);
+  const evmNetworkList = dexieReactHooks.useLiveQuery(() => chaindataProvider?.evmNetworks(), [chaindataProvider]);
+  const tokenList = dexieReactHooks.useLiveQuery(() => chaindataProvider?.tokens(), [chaindataProvider]);
   const tokenRates$1 = dexieReactHooks.useLiveQuery(() => tokenRates.db.tokenRates.toArray(), []);
   const rawBalances = dexieReactHooks.useLiveQuery(() => balances.db.balances.toArray(), []);
   const [dbData, setDbData] = react.useState(DEFAULT_VALUE);
@@ -200,7 +200,7 @@ const [DbCacheProvider, useDbCache] = provideContext(useDbCacheProvider);
 
 var packageJson = {
 	name: "@talismn/balances-react",
-	version: "0.0.0-pr611-20230314172319",
+	version: "0.0.0-pr611-20230316232708",
 	author: "Talisman",
 	homepage: "https://talisman.xyz",
 	license: "UNLICENSED",
@@ -218,7 +218,7 @@ var packageJson = {
 		"/dist"
 	],
 	engines: {
-		node: ">=14"
+		node: ">=18"
 	},
 	scripts: {
 		test: "jest",
@@ -530,7 +530,7 @@ const subscribeBalances = (tokens, addresses, balanceModules) => {
     const unsub = balances.balances(balanceModule, addressesByModuleToken, (error, balances$1) => {
       // log errors
       if (error) {
-        if ((error === null || error === void 0 ? void 0 : error.type) === "STALE_RPC_ERROR") return balances.db.balances.where({
+        if (error?.type === "STALE_RPC_ERROR") return balances.db.balances.where({
           source: balanceModule.type,
           chainId: error.chainId
         }).filter(balance => {
@@ -658,6 +658,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,
@@ -689,11 +718,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

@@ -165,9 +165,9 @@ const consolidateDbCache = (chainsMap, evmNetworksMap, tokensMap, tokenRates, al
 };
 const useDbCacheProvider = () => {
   const chaindataProvider = useChaindata();
-  const chainList = useLiveQuery(() => chaindataProvider === null || chaindataProvider === void 0 ? void 0 : chaindataProvider.chains(), [chaindataProvider]);
-  const evmNetworkList = useLiveQuery(() => chaindataProvider === null || chaindataProvider === void 0 ? void 0 : chaindataProvider.evmNetworks(), [chaindataProvider]);
-  const tokenList = useLiveQuery(() => chaindataProvider === null || chaindataProvider === void 0 ? void 0 : chaindataProvider.tokens(), [chaindataProvider]);
+  const chainList = useLiveQuery(() => chaindataProvider?.chains(), [chaindataProvider]);
+  const evmNetworkList = useLiveQuery(() => chaindataProvider?.evmNetworks(), [chaindataProvider]);
+  const tokenList = useLiveQuery(() => chaindataProvider?.tokens(), [chaindataProvider]);
   const tokenRates = useLiveQuery(() => db.tokenRates.toArray(), []);
   const rawBalances = useLiveQuery(() => db$1.balances.toArray(), []);
   const [dbData, setDbData] = useState(DEFAULT_VALUE);
@@ -191,7 +191,7 @@ const [DbCacheProvider, useDbCache] = provideContext(useDbCacheProvider);
 
 var packageJson = {
 	name: "@talismn/balances-react",
-	version: "0.0.0-pr611-20230314172319",
+	version: "0.0.0-pr611-20230316232708",
 	author: "Talisman",
 	homepage: "https://talisman.xyz",
 	license: "UNLICENSED",
@@ -209,7 +209,7 @@ var packageJson = {
 		"/dist"
 	],
 	engines: {
-		node: ">=14"
+		node: ">=18"
 	},
 	scripts: {
 		test: "jest",
@@ -521,7 +521,7 @@ const subscribeBalances = (tokens, addresses, balanceModules) => {
     const unsub = balances(balanceModule, addressesByModuleToken, (error, balances) => {
       // log errors
       if (error) {
-        if ((error === null || error === void 0 ? void 0 : error.type) === "STALE_RPC_ERROR") return db$1.balances.where({
+        if (error?.type === "STALE_RPC_ERROR") return db$1.balances.where({
           source: balanceModule.type,
           chainId: error.chainId
         }).filter(balance => {
@@ -649,6 +649,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,
@@ -672,4 +701,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-pr611-20230314172319",
+  "version": "0.0.0-pr611-20230316232708",
   "author": "Talisman",
   "homepage": "https://talisman.xyz",
   "license": "UNLICENSED",
@@ -18,7 +18,7 @@
     "/dist"
   ],
   "engines": {
-    "node": ">=14"
+    "node": ">=18"
   },
   "scripts": {
     "test": "jest",
@@ -26,13 +26,13 @@
     "clean": "rm -rf dist && rm -rf .turbo rm -rf node_modules"
   },
   "dependencies": {
-    "@talismn/balances": "^0.0.0-pr611-20230314172319",
-    "@talismn/chain-connector": "^0.0.0-pr611-20230314172319",
-    "@talismn/chain-connector-evm": "^0.0.0-pr611-20230314172319",
-    "@talismn/chaindata-provider": "^0.0.0-pr611-20230314172319",
-    "@talismn/chaindata-provider-extension": "^0.0.0-pr611-20230314172319",
-    "@talismn/connection-meta": "^0.0.0-pr611-20230314172319",
-    "@talismn/token-rates": "^0.0.0-pr611-20230314172319",
+    "@talismn/balances": "^0.0.0-pr611-20230316232708",
+    "@talismn/chain-connector": "^0.0.0-pr611-20230316232708",
+    "@talismn/chain-connector-evm": "^0.0.0-pr611-20230316232708",
+    "@talismn/chaindata-provider": "^0.0.0-pr611-20230316232708",
+    "@talismn/chaindata-provider-extension": "^0.0.0-pr611-20230316232708",
+    "@talismn/connection-meta": "^0.0.0-pr611-20230316232708",
+    "@talismn/token-rates": "^0.0.0-pr611-20230316232708",
     "anylogger": "^1.0.11",
     "blueimp-md5": "2.19.0",
     "dexie": "^3.2.3",