@talismn/balances-react 0.0.0-pr997-20230816131858 → 0.0.0-pr997-20230920005904

package/CHANGELOG.md

@@ -1,20 +1,27 @@
 # @talismn/balances-react
 
-## 0.0.0-pr997-20230816131858
+## 0.0.0-pr997-20230920005904
 
 ### Patch Changes
 
+- 8f8de177: fix: typing
+- 24398768: fix: remove old tokenRates for tokens which have no coingeckoId anymore
+- c0b25f24: feat: add enableChains prop to BalancesProvider
 - Updated dependencies [03939d5f]
 - Updated dependencies [d2ccdafb]
 - Updated dependencies [a916db00]
+- Updated dependencies [a3a1bd7c]
+- Updated dependencies [850381a5]
+- Updated dependencies [5aadf998]
 - Updated dependencies [4cace80d]
-  - @talismn/chaindata-provider@0.0.0-pr997-20230816131858
-  - @talismn/chaindata-provider-extension@0.0.0-pr997-20230816131858
-  - @talismn/balances@0.0.0-pr997-20230816131858
-  - @talismn/chain-connector@0.0.0-pr997-20230816131858
-  - @talismn/chain-connector-evm@0.0.0-pr997-20230816131858
-  - @talismn/connection-meta@0.0.0-pr997-20230816131858
-  - @talismn/token-rates@0.0.0-pr997-20230816131858
+- Updated dependencies [9ebcd938]
+  - @talismn/chaindata-provider@0.0.0-pr997-20230920005904
+  - @talismn/chaindata-provider-extension@0.0.0-pr997-20230920005904
+  - @talismn/balances@0.0.0-pr997-20230920005904
+  - @talismn/chain-connector-evm@0.0.0-pr997-20230920005904
+  - @talismn/chain-connector@0.0.0-pr997-20230920005904
+  - @talismn/connection-meta@0.0.0-pr997-20230920005904
+  - @talismn/token-rates@0.0.0-pr997-20230920005904
 
 ## 0.6.0
 

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

@@ -18,6 +18,32 @@ export type BalancesProviderProps = {
     balanceModules: Array<(hydrate: Hydrate) => AnyBalanceModule>;
     onfinalityApiKey?: string;
     withTestnets?: boolean;
+    /**
+     * A list of chain genesisHashes to fetch balances for.
+     *
+     * If undefined, balances will be fetched for all chains.
+     *
+     * Only applies to built-in chains, custom chains will always fetch balances.
+     *
+     * NOTE: This is an allowlist to enable the dapp to disable balances for chains it does not care about.
+     * Adding a chain here which is not already supported by the library will not automagically begin to fetch balances.
+     * It will just be ignored.
+     *
+     * In a similar vein, if you add testnets here then make sure you've also set the `withTestnets` prop to `true`.
+     *
+     * @example
+     * enabledChains={[
+     *   // polkadot
+     *   "0x91b171bb158e2d3848fa23a9f1c25182fb8e20313b2c1eb49219da7a70ce90c3",
+     *   // kusama
+     *   "0xb0a8d493285c2df73290dfb7e61f870f17b41801197a149ca93654499ea3dafe",
+     *   // rococo
+     *   "0x6408de7737c59c238890533af25896a2c20608d8b380bb01029acb392781063e",
+     *   // westend
+     *   "0xe143f23803ac50e8f6f8e62695d1ce9e4e1d68aa36c1cd2cfd15340213f3423e",
+     * ]}
+     */
+    enabledChains?: string[];
     children?: ReactNode;
 };
-export declare const BalancesProvider: ({ balanceModules, onfinalityApiKey, withTestnets, children, }: BalancesProviderProps) => JSX.Element;
+export declare const BalancesProvider: ({ balanceModules, onfinalityApiKey, withTestnets, enabledChains, children, }: BalancesProviderProps) => JSX.Element;

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

@@ -0,0 +1,8 @@
+/// <reference types="react" />
+export declare const EnabledChainsProvider: import("react").FC<{
+    enabledChains?: string[] | undefined;
+} & {
+    children?: import("react").ReactNode;
+}>, useEnabledChains: () => {
+    enabledChains: string[] | undefined;
+};

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

@@ -185,7 +185,7 @@ const [DbCacheProvider, useDbCache] = provideContext(useDbCacheProvider);
 
 var packageJson = {
 	name: "@talismn/balances-react",
-	version: "0.0.0-pr997-20230816131858",
+	version: "0.0.0-pr997-20230920005904",
 	author: "Talisman",
 	homepage: "https://talisman.xyz",
 	license: "GPL-3.0-or-later",
@@ -341,6 +341,15 @@ const createMulticastSubscription = upstream => {
   return subscribe;
 };
 
+const useEnabledChainsProvider = ({
+  enabledChains
+}) => {
+  return {
+    enabledChains
+  };
+};
+const [EnabledChainsProvider, useEnabledChains] = provideContext(useEnabledChainsProvider);
+
 const useWithTestnetsProvider = ({
   withTestnets
 }) => {
@@ -400,11 +409,21 @@ function useDbCacheBalancesSubscription() {
   const {
     withTestnets
   } = useWithTestnets();
+  const {
+    enabledChains
+  } = useEnabledChains();
   const balanceModules = useBalanceModules();
   const chaindataProvider = useChaindata();
   const chainConnectors = useChainConnectors();
   const [allAddresses] = useAllAddresses();
-  const tokens = useTokens$1(withTestnets);
+  const chains = useChains$1(withTestnets);
+  const allTokens = useTokens$1(withTestnets);
+  const tokens = react.useMemo(() => {
+    if (!enabledChains) return allTokens;
+    const chainsByGenesisHash = new Map(Object.values(chains).flatMap(chain => chain.genesisHash ? [[chain.genesisHash, chain.id]] : []));
+    const enabledChainIds = enabledChains.flatMap(genesisHash => chainsByGenesisHash.get(genesisHash) ?? []);
+    return Object.fromEntries(Object.entries(allTokens).flatMap(([id, token]) => token.chain && enabledChainIds.includes(token.chain.id) ? [[id, token]] : []));
+  }, [allTokens, chains, enabledChains]);
   const subscriptionKey = react.useMemo(
   // not super sexy but we need key to change based on this stuff
   () => {
@@ -420,7 +439,14 @@ function useDbCacheBalancesSubscription() {
   useSharedSubscription(subscriptionKey, subscription);
 }
 
-// subscriptionless version of useTokens, prevents circular dependency
+// subscriptionless version of useChains and useTokens, prevents circular dependency
+const useChains$1 = withTestnets => {
+  const {
+    chainsWithTestnetsMap,
+    chainsWithoutTestnetsMap
+  } = useDbCache();
+  return withTestnets ? chainsWithTestnetsMap : chainsWithoutTestnetsMap;
+};
 const useTokens$1 = withTestnets => {
   const {
     tokensWithTestnetsMap,
@@ -465,7 +491,16 @@ const subscribeTokenRates = tokens => {
         tokenId,
         rates
       }));
-      tokenRates.db.transaction("rw", tokenRates.db.tokenRates, async () => await tokenRates.db.tokenRates.bulkPut(putTokenRates));
+      await tokenRates.db.transaction("rw", tokenRates.db.tokenRates, async () => {
+        // override all tokenRates
+        await tokenRates.db.tokenRates.bulkPut(putTokenRates);
+
+        // delete tokenRates for tokens which no longer exist
+        const tokenIds = await tokenRates.db.tokenRates.toCollection().primaryKeys();
+        const validTokenIds = new Set(Object.keys(tokenRates$1));
+        const deleteTokenIds = tokenIds.filter(tokenId => !validTokenIds.has(tokenId));
+        if (deleteTokenIds.length > 0) await tokenRates.db.tokenRates.bulkDelete(deleteTokenIds);
+      });
       timeout = setTimeout(() => {
         refreshTokenRates();
       }, REFRESH_INTERVAL);
@@ -691,18 +726,22 @@ const BalancesProvider = ({
   balanceModules,
   onfinalityApiKey,
   withTestnets,
+  enabledChains,
   children
 }) => /*#__PURE__*/jsxRuntime.jsx(WithTestnetsProvider, {
   withTestnets: withTestnets,
-  children: /*#__PURE__*/jsxRuntime.jsx(ChaindataProvider, {
-    onfinalityApiKey: onfinalityApiKey,
-    children: /*#__PURE__*/jsxRuntime.jsx(ChainConnectorsProvider, {
+  children: /*#__PURE__*/jsxRuntime.jsx(EnabledChainsProvider, {
+    enabledChains: enabledChains,
+    children: /*#__PURE__*/jsxRuntime.jsx(ChaindataProvider, {
       onfinalityApiKey: onfinalityApiKey,
-      children: /*#__PURE__*/jsxRuntime.jsx(AllAddressesProvider, {
-        children: /*#__PURE__*/jsxRuntime.jsx(BalanceModulesProvider, {
-          balanceModules: balanceModules,
-          children: /*#__PURE__*/jsxRuntime.jsx(DbCacheProvider, {
-            children: children
+      children: /*#__PURE__*/jsxRuntime.jsx(ChainConnectorsProvider, {
+        onfinalityApiKey: onfinalityApiKey,
+        children: /*#__PURE__*/jsxRuntime.jsx(AllAddressesProvider, {
+          children: /*#__PURE__*/jsxRuntime.jsx(BalanceModulesProvider, {
+            balanceModules: balanceModules,
+            children: /*#__PURE__*/jsxRuntime.jsx(DbCacheProvider, {
+              children: children
+            })
           })
         })
       })

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

@@ -185,7 +185,7 @@ const [DbCacheProvider, useDbCache] = provideContext(useDbCacheProvider);
 
 var packageJson = {
 	name: "@talismn/balances-react",
-	version: "0.0.0-pr997-20230816131858",
+	version: "0.0.0-pr997-20230920005904",
 	author: "Talisman",
 	homepage: "https://talisman.xyz",
 	license: "GPL-3.0-or-later",
@@ -341,6 +341,15 @@ const createMulticastSubscription = upstream => {
   return subscribe;
 };
 
+const useEnabledChainsProvider = ({
+  enabledChains
+}) => {
+  return {
+    enabledChains
+  };
+};
+const [EnabledChainsProvider, useEnabledChains] = provideContext(useEnabledChainsProvider);
+
 const useWithTestnetsProvider = ({
   withTestnets
 }) => {
@@ -400,11 +409,21 @@ function useDbCacheBalancesSubscription() {
   const {
     withTestnets
   } = useWithTestnets();
+  const {
+    enabledChains
+  } = useEnabledChains();
   const balanceModules = useBalanceModules();
   const chaindataProvider = useChaindata();
   const chainConnectors = useChainConnectors();
   const [allAddresses] = useAllAddresses();
-  const tokens = useTokens$1(withTestnets);
+  const chains = useChains$1(withTestnets);
+  const allTokens = useTokens$1(withTestnets);
+  const tokens = react.useMemo(() => {
+    if (!enabledChains) return allTokens;
+    const chainsByGenesisHash = new Map(Object.values(chains).flatMap(chain => chain.genesisHash ? [[chain.genesisHash, chain.id]] : []));
+    const enabledChainIds = enabledChains.flatMap(genesisHash => chainsByGenesisHash.get(genesisHash) ?? []);
+    return Object.fromEntries(Object.entries(allTokens).flatMap(([id, token]) => token.chain && enabledChainIds.includes(token.chain.id) ? [[id, token]] : []));
+  }, [allTokens, chains, enabledChains]);
   const subscriptionKey = react.useMemo(
   // not super sexy but we need key to change based on this stuff
   () => {
@@ -420,7 +439,14 @@ function useDbCacheBalancesSubscription() {
   useSharedSubscription(subscriptionKey, subscription);
 }
 
-// subscriptionless version of useTokens, prevents circular dependency
+// subscriptionless version of useChains and useTokens, prevents circular dependency
+const useChains$1 = withTestnets => {
+  const {
+    chainsWithTestnetsMap,
+    chainsWithoutTestnetsMap
+  } = useDbCache();
+  return withTestnets ? chainsWithTestnetsMap : chainsWithoutTestnetsMap;
+};
 const useTokens$1 = withTestnets => {
   const {
     tokensWithTestnetsMap,
@@ -465,7 +491,16 @@ const subscribeTokenRates = tokens => {
         tokenId,
         rates
       }));
-      tokenRates.db.transaction("rw", tokenRates.db.tokenRates, async () => await tokenRates.db.tokenRates.bulkPut(putTokenRates));
+      await tokenRates.db.transaction("rw", tokenRates.db.tokenRates, async () => {
+        // override all tokenRates
+        await tokenRates.db.tokenRates.bulkPut(putTokenRates);
+
+        // delete tokenRates for tokens which no longer exist
+        const tokenIds = await tokenRates.db.tokenRates.toCollection().primaryKeys();
+        const validTokenIds = new Set(Object.keys(tokenRates$1));
+        const deleteTokenIds = tokenIds.filter(tokenId => !validTokenIds.has(tokenId));
+        if (deleteTokenIds.length > 0) await tokenRates.db.tokenRates.bulkDelete(deleteTokenIds);
+      });
       timeout = setTimeout(() => {
         refreshTokenRates();
       }, REFRESH_INTERVAL);
@@ -691,18 +726,22 @@ const BalancesProvider = ({
   balanceModules,
   onfinalityApiKey,
   withTestnets,
+  enabledChains,
   children
 }) => /*#__PURE__*/jsxRuntime.jsx(WithTestnetsProvider, {
   withTestnets: withTestnets,
-  children: /*#__PURE__*/jsxRuntime.jsx(ChaindataProvider, {
-    onfinalityApiKey: onfinalityApiKey,
-    children: /*#__PURE__*/jsxRuntime.jsx(ChainConnectorsProvider, {
+  children: /*#__PURE__*/jsxRuntime.jsx(EnabledChainsProvider, {
+    enabledChains: enabledChains,
+    children: /*#__PURE__*/jsxRuntime.jsx(ChaindataProvider, {
       onfinalityApiKey: onfinalityApiKey,
-      children: /*#__PURE__*/jsxRuntime.jsx(AllAddressesProvider, {
-        children: /*#__PURE__*/jsxRuntime.jsx(BalanceModulesProvider, {
-          balanceModules: balanceModules,
-          children: /*#__PURE__*/jsxRuntime.jsx(DbCacheProvider, {
-            children: children
+      children: /*#__PURE__*/jsxRuntime.jsx(ChainConnectorsProvider, {
+        onfinalityApiKey: onfinalityApiKey,
+        children: /*#__PURE__*/jsxRuntime.jsx(AllAddressesProvider, {
+          children: /*#__PURE__*/jsxRuntime.jsx(BalanceModulesProvider, {
+            balanceModules: balanceModules,
+            children: /*#__PURE__*/jsxRuntime.jsx(DbCacheProvider, {
+              children: children
+            })
           })
         })
       })

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

@@ -176,7 +176,7 @@ const [DbCacheProvider, useDbCache] = provideContext(useDbCacheProvider);
 
 var packageJson = {
 	name: "@talismn/balances-react",
-	version: "0.0.0-pr997-20230816131858",
+	version: "0.0.0-pr997-20230920005904",
 	author: "Talisman",
 	homepage: "https://talisman.xyz",
 	license: "GPL-3.0-or-later",
@@ -332,6 +332,15 @@ const createMulticastSubscription = upstream => {
   return subscribe;
 };
 
+const useEnabledChainsProvider = ({
+  enabledChains
+}) => {
+  return {
+    enabledChains
+  };
+};
+const [EnabledChainsProvider, useEnabledChains] = provideContext(useEnabledChainsProvider);
+
 const useWithTestnetsProvider = ({
   withTestnets
 }) => {
@@ -391,11 +400,21 @@ function useDbCacheBalancesSubscription() {
   const {
     withTestnets
   } = useWithTestnets();
+  const {
+    enabledChains
+  } = useEnabledChains();
   const balanceModules = useBalanceModules();
   const chaindataProvider = useChaindata();
   const chainConnectors = useChainConnectors();
   const [allAddresses] = useAllAddresses();
-  const tokens = useTokens$1(withTestnets);
+  const chains = useChains$1(withTestnets);
+  const allTokens = useTokens$1(withTestnets);
+  const tokens = useMemo(() => {
+    if (!enabledChains) return allTokens;
+    const chainsByGenesisHash = new Map(Object.values(chains).flatMap(chain => chain.genesisHash ? [[chain.genesisHash, chain.id]] : []));
+    const enabledChainIds = enabledChains.flatMap(genesisHash => chainsByGenesisHash.get(genesisHash) ?? []);
+    return Object.fromEntries(Object.entries(allTokens).flatMap(([id, token]) => token.chain && enabledChainIds.includes(token.chain.id) ? [[id, token]] : []));
+  }, [allTokens, chains, enabledChains]);
   const subscriptionKey = useMemo(
   // not super sexy but we need key to change based on this stuff
   () => {
@@ -411,7 +430,14 @@ function useDbCacheBalancesSubscription() {
   useSharedSubscription(subscriptionKey, subscription);
 }
 
-// subscriptionless version of useTokens, prevents circular dependency
+// subscriptionless version of useChains and useTokens, prevents circular dependency
+const useChains$1 = withTestnets => {
+  const {
+    chainsWithTestnetsMap,
+    chainsWithoutTestnetsMap
+  } = useDbCache();
+  return withTestnets ? chainsWithTestnetsMap : chainsWithoutTestnetsMap;
+};
 const useTokens$1 = withTestnets => {
   const {
     tokensWithTestnetsMap,
@@ -456,7 +482,16 @@ const subscribeTokenRates = tokens => {
         tokenId,
         rates
       }));
-      db.transaction("rw", db.tokenRates, async () => await db.tokenRates.bulkPut(putTokenRates));
+      await db.transaction("rw", db.tokenRates, async () => {
+        // override all tokenRates
+        await db.tokenRates.bulkPut(putTokenRates);
+
+        // delete tokenRates for tokens which no longer exist
+        const tokenIds = await db.tokenRates.toCollection().primaryKeys();
+        const validTokenIds = new Set(Object.keys(tokenRates));
+        const deleteTokenIds = tokenIds.filter(tokenId => !validTokenIds.has(tokenId));
+        if (deleteTokenIds.length > 0) await db.tokenRates.bulkDelete(deleteTokenIds);
+      });
       timeout = setTimeout(() => {
         refreshTokenRates();
       }, REFRESH_INTERVAL);
@@ -682,18 +717,22 @@ const BalancesProvider = ({
   balanceModules,
   onfinalityApiKey,
   withTestnets,
+  enabledChains,
   children
 }) => /*#__PURE__*/jsx(WithTestnetsProvider, {
   withTestnets: withTestnets,
-  children: /*#__PURE__*/jsx(ChaindataProvider, {
-    onfinalityApiKey: onfinalityApiKey,
-    children: /*#__PURE__*/jsx(ChainConnectorsProvider, {
+  children: /*#__PURE__*/jsx(EnabledChainsProvider, {
+    enabledChains: enabledChains,
+    children: /*#__PURE__*/jsx(ChaindataProvider, {
       onfinalityApiKey: onfinalityApiKey,
-      children: /*#__PURE__*/jsx(AllAddressesProvider, {
-        children: /*#__PURE__*/jsx(BalanceModulesProvider, {
-          balanceModules: balanceModules,
-          children: /*#__PURE__*/jsx(DbCacheProvider, {
-            children: children
+      children: /*#__PURE__*/jsx(ChainConnectorsProvider, {
+        onfinalityApiKey: onfinalityApiKey,
+        children: /*#__PURE__*/jsx(AllAddressesProvider, {
+          children: /*#__PURE__*/jsx(BalanceModulesProvider, {
+            balanceModules: balanceModules,
+            children: /*#__PURE__*/jsx(DbCacheProvider, {
+              children: children
+            })
           })
         })
       })

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@talismn/balances-react",
-  "version": "0.0.0-pr997-20230816131858",
+  "version": "0.0.0-pr997-20230920005904",
   "author": "Talisman",
   "homepage": "https://talisman.xyz",
   "license": "GPL-3.0-or-later",
@@ -26,13 +26,13 @@
     "clean": "rm -rf dist && rm -rf .turbo rm -rf node_modules"
   },
   "dependencies": {
-    "@talismn/balances": "0.0.0-pr997-20230816131858",
-    "@talismn/chain-connector": "0.0.0-pr997-20230816131858",
-    "@talismn/chain-connector-evm": "0.0.0-pr997-20230816131858",
-    "@talismn/chaindata-provider": "0.0.0-pr997-20230816131858",
-    "@talismn/chaindata-provider-extension": "0.0.0-pr997-20230816131858",
-    "@talismn/connection-meta": "0.0.0-pr997-20230816131858",
-    "@talismn/token-rates": "0.0.0-pr997-20230816131858",
+    "@talismn/balances": "0.0.0-pr997-20230920005904",
+    "@talismn/chain-connector": "0.0.0-pr997-20230920005904",
+    "@talismn/chain-connector-evm": "0.0.0-pr997-20230920005904",
+    "@talismn/chaindata-provider": "0.0.0-pr997-20230920005904",
+    "@talismn/chaindata-provider-extension": "0.0.0-pr997-20230920005904",
+    "@talismn/connection-meta": "0.0.0-pr997-20230920005904",
+    "@talismn/token-rates": "0.0.0-pr997-20230920005904",
     "anylogger": "^1.0.11",
     "blueimp-md5": "2.19.0",
     "dexie": "^3.2.4",