@talismn/balances-react 0.3.1 → 0.3.2

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @talismn/balances-react
 
+## 0.3.2
+
+### Patch Changes
+
+- 62d7a783: fix: allow @talismn/balances-react users to specify onfinality api key
+  - @talismn/balances@0.3.2
+
 ## 0.3.1
 
 ### Patch Changes

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

@@ -1,3 +1,6 @@
-import { AddressesByToken, BalanceModule, Balances } from "@talismn/balances";
+import { AddressesByToken, BalanceModule } from "@talismn/balances";
 import { ChaindataProvider, Token } from "@talismn/chaindata-provider";
-export declare function useBalances(balanceModules: Array<BalanceModule<any, any, any, any>>, chaindataProvider: ChaindataProvider | null, addressesByToken: AddressesByToken<Token> | null): Balances | undefined;
+export type Options = {
+    onfinalityApiKey?: string;
+};
+export declare function useBalances(balanceModules: Array<BalanceModule<any, any, any, any>>, chaindataProvider: ChaindataProvider | null, addressesByToken: AddressesByToken<Token> | null, options?: Options): any;

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

@@ -1,5 +1,8 @@
 import { Chain, ChainId, ChainList, ChaindataProvider, EvmNetwork, EvmNetworkId, EvmNetworkList, Token, TokenId, TokenList } from "@talismn/chaindata-provider";
-export declare function useChaindata(): (ChaindataProvider & {
+export type Options = {
+    onfinalityApiKey?: string;
+};
+export declare function useChaindata(options?: Options): (ChaindataProvider & {
     generation?: number | undefined;
 }) | null;
 export declare function useChains(chaindata: (ChaindataProvider & {

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

@@ -18,7 +18,7 @@ var anylogger__default = /*#__PURE__*/_interopDefault(anylogger);
 
 var packageJson = {
 	name: "@talismn/balances-react",
-	version: "0.3.1",
+	version: "0.3.2",
 	author: "Talisman",
 	homepage: "https://talisman.xyz",
 	license: "UNLICENSED",
@@ -81,14 +81,15 @@ var packageJson = {
 var log = anylogger__default["default"](packageJson.name);
 
 // TODO: Allow user to call useChaindata from multiple places
-
-function useChaindata() {
+function useChaindata(options = {}) {
   const [chaindataProvider, setChaindataProvider] = react.useState(null);
 
   // this number is incremented each time the chaindataProvider has fetched new data
   const [generation, setGeneration] = react.useState(0);
   react.useEffect(() => {
-    const chaindataProvider = new chaindataProviderExtension.ChaindataProviderExtension();
+    const chaindataProvider = new chaindataProviderExtension.ChaindataProviderExtension({
+      onfinalityApiKey: options.onfinalityApiKey
+    });
     let shouldHydrate = true;
     const timer = 300_000; // 300_000ms = 300s = 5 minutes
     const hydrate = async () => {
@@ -108,7 +109,7 @@ function useChaindata() {
     return () => {
       shouldHydrate = false;
     };
-  }, []);
+  }, [options.onfinalityApiKey]);
   if (chaindataProvider) chaindataProvider.generation = generation;
   return chaindataProvider;
 }
@@ -121,7 +122,7 @@ function useChains(chaindata) {
       if (thisGeneration !== chaindata.generation) return;
       setChains(chains);
     });
-  }, [chaindata?.generation]);
+  }, [chaindata, chaindata?.generation]);
   return chains || {};
 }
 function useChain(chaindata, chainId) {
@@ -130,7 +131,7 @@ function useChain(chaindata, chainId) {
     if (chaindata === null) return;
     if (!chainId) return;
     chaindata.getChain(chainId).then(setChain);
-  }, [chaindata?.generation]);
+  }, [chainId, chaindata, chaindata?.generation]);
   return chain;
 }
 function useEvmNetworks(chaindata) {
@@ -142,7 +143,7 @@ function useEvmNetworks(chaindata) {
       if (thisGeneration !== chaindata.generation) return;
       setEvmNetworks(evmNetworks);
     });
-  }, [chaindata?.generation]);
+  }, [chaindata, chaindata?.generation]);
   return evmNetworks || {};
 }
 function useEvmNetwork(chaindata, evmNetworkId) {
@@ -151,7 +152,7 @@ function useEvmNetwork(chaindata, evmNetworkId) {
     if (chaindata === null) return;
     if (!evmNetworkId) return;
     chaindata.getEvmNetwork(evmNetworkId).then(setEvmNetwork);
-  }, [chaindata?.generation]);
+  }, [chaindata, chaindata?.generation, evmNetworkId]);
   return evmNetwork;
 }
 function useTokens(chaindata) {
@@ -163,7 +164,7 @@ function useTokens(chaindata) {
       if (thisGeneration !== chaindata.generation) return;
       setTokens(tokens);
     });
-  }, [chaindata?.generation]);
+  }, [chaindata, chaindata?.generation]);
   return tokens || {};
 }
 function useToken(chaindata, tokenId) {
@@ -172,7 +173,7 @@ function useToken(chaindata, tokenId) {
     if (chaindata === null) return;
     if (!tokenId) return;
     chaindata.getToken(tokenId).then(setToken);
-  }, [chaindata?.generation]);
+  }, [chaindata, chaindata?.generation, tokenId]);
   return token;
 }
 
@@ -205,8 +206,8 @@ function useTokenRates(tokens) {
 //       the caller of useChains/useTokens/etc has provided.
 function useBalances(
 // TODO: Make this array of BalanceModules more type-safe
-balanceModules, chaindataProvider, addressesByToken) {
-  useBalancesSubscriptions(balanceModules, chaindataProvider, addressesByToken);
+balanceModules, chaindataProvider, addressesByToken, options = {}) {
+  useBalancesSubscriptions(balanceModules, chaindataProvider, addressesByToken, options);
   const chains = useChains(chaindataProvider);
   const evmNetworks = useEvmNetworks(chaindataProvider);
   const tokens = useTokens(chaindataProvider);
@@ -251,7 +252,7 @@ const subscriptions = {};
 // balance subscriptions
 function useBalancesSubscriptions(
 // TODO: Make this array of BalanceModules more type-safe
-balanceModules, chaindataProvider, addressesByToken) {
+balanceModules, chaindataProvider, addressesByToken, options = {}) {
   // const subscriptions = useRef<
   //   Record<string, { unsub: Promise<() => void>; refcount: number; generation: number }>
   // >({})
@@ -307,7 +308,7 @@ balanceModules, chaindataProvider, addressesByToken) {
     }
   };
   const chainConnector = useChainConnector(chaindataProvider);
-  const chainConnectorEvm = useChainConnectorEvm(chaindataProvider);
+  const chainConnectorEvm = useChainConnectorEvm(chaindataProvider, options);
   const tokens = useTokens(chaindataProvider);
   react.useEffect(() => {
     if (chainConnector === null) return;
@@ -336,7 +337,7 @@ balanceModules, chaindataProvider, addressesByToken) {
     });
     const unsubAll = () => unsubs.forEach(unsub => unsub());
     return unsubAll;
-  }, [addressesByToken, chainConnector, chainConnectorEvm, chaindataProvider, tokens]);
+  }, [addressesByToken, balanceModules, chainConnector, chainConnectorEvm, chaindataProvider, tokens]);
 }
 
 // TODO: Allow advanced users of this library to provide their own chain connector
@@ -349,12 +350,14 @@ function useChainConnector(chaindataProvider) {
   return chainConnector$1;
 }
 // TODO: Allow advanced users of this library to provide their own chain connector
-function useChainConnectorEvm(chaindataProvider) {
+function useChainConnectorEvm(chaindataProvider, options = {}) {
   const [chainConnectorEvm$1, setChainConnectorEvm] = react.useState(null);
   react.useEffect(() => {
     if (chaindataProvider === null) return;
-    setChainConnectorEvm(new chainConnectorEvm.ChainConnectorEvm(chaindataProvider));
-  }, [chaindataProvider]);
+    setChainConnectorEvm(new chainConnectorEvm.ChainConnectorEvm(chaindataProvider, {
+      onfinalityApiKey: options.onfinalityApiKey
+    }));
+  }, [chaindataProvider, options.onfinalityApiKey]);
   return chainConnectorEvm$1;
 }
 

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

@@ -18,7 +18,7 @@ var anylogger__default = /*#__PURE__*/_interopDefault(anylogger);
 
 var packageJson = {
 	name: "@talismn/balances-react",
-	version: "0.3.1",
+	version: "0.3.2",
 	author: "Talisman",
 	homepage: "https://talisman.xyz",
 	license: "UNLICENSED",
@@ -81,14 +81,15 @@ var packageJson = {
 var log = anylogger__default["default"](packageJson.name);
 
 // TODO: Allow user to call useChaindata from multiple places
-
-function useChaindata() {
+function useChaindata(options = {}) {
   const [chaindataProvider, setChaindataProvider] = react.useState(null);
 
   // this number is incremented each time the chaindataProvider has fetched new data
   const [generation, setGeneration] = react.useState(0);
   react.useEffect(() => {
-    const chaindataProvider = new chaindataProviderExtension.ChaindataProviderExtension();
+    const chaindataProvider = new chaindataProviderExtension.ChaindataProviderExtension({
+      onfinalityApiKey: options.onfinalityApiKey
+    });
     let shouldHydrate = true;
     const timer = 300_000; // 300_000ms = 300s = 5 minutes
     const hydrate = async () => {
@@ -108,7 +109,7 @@ function useChaindata() {
     return () => {
       shouldHydrate = false;
     };
-  }, []);
+  }, [options.onfinalityApiKey]);
   if (chaindataProvider) chaindataProvider.generation = generation;
   return chaindataProvider;
 }
@@ -121,7 +122,7 @@ function useChains(chaindata) {
       if (thisGeneration !== chaindata.generation) return;
       setChains(chains);
     });
-  }, [chaindata?.generation]);
+  }, [chaindata, chaindata?.generation]);
   return chains || {};
 }
 function useChain(chaindata, chainId) {
@@ -130,7 +131,7 @@ function useChain(chaindata, chainId) {
     if (chaindata === null) return;
     if (!chainId) return;
     chaindata.getChain(chainId).then(setChain);
-  }, [chaindata?.generation]);
+  }, [chainId, chaindata, chaindata?.generation]);
   return chain;
 }
 function useEvmNetworks(chaindata) {
@@ -142,7 +143,7 @@ function useEvmNetworks(chaindata) {
       if (thisGeneration !== chaindata.generation) return;
       setEvmNetworks(evmNetworks);
     });
-  }, [chaindata?.generation]);
+  }, [chaindata, chaindata?.generation]);
   return evmNetworks || {};
 }
 function useEvmNetwork(chaindata, evmNetworkId) {
@@ -151,7 +152,7 @@ function useEvmNetwork(chaindata, evmNetworkId) {
     if (chaindata === null) return;
     if (!evmNetworkId) return;
     chaindata.getEvmNetwork(evmNetworkId).then(setEvmNetwork);
-  }, [chaindata?.generation]);
+  }, [chaindata, chaindata?.generation, evmNetworkId]);
   return evmNetwork;
 }
 function useTokens(chaindata) {
@@ -163,7 +164,7 @@ function useTokens(chaindata) {
       if (thisGeneration !== chaindata.generation) return;
       setTokens(tokens);
     });
-  }, [chaindata?.generation]);
+  }, [chaindata, chaindata?.generation]);
   return tokens || {};
 }
 function useToken(chaindata, tokenId) {
@@ -172,7 +173,7 @@ function useToken(chaindata, tokenId) {
     if (chaindata === null) return;
     if (!tokenId) return;
     chaindata.getToken(tokenId).then(setToken);
-  }, [chaindata?.generation]);
+  }, [chaindata, chaindata?.generation, tokenId]);
   return token;
 }
 
@@ -205,8 +206,8 @@ function useTokenRates(tokens) {
 //       the caller of useChains/useTokens/etc has provided.
 function useBalances(
 // TODO: Make this array of BalanceModules more type-safe
-balanceModules, chaindataProvider, addressesByToken) {
-  useBalancesSubscriptions(balanceModules, chaindataProvider, addressesByToken);
+balanceModules, chaindataProvider, addressesByToken, options = {}) {
+  useBalancesSubscriptions(balanceModules, chaindataProvider, addressesByToken, options);
   const chains = useChains(chaindataProvider);
   const evmNetworks = useEvmNetworks(chaindataProvider);
   const tokens = useTokens(chaindataProvider);
@@ -251,7 +252,7 @@ const subscriptions = {};
 // balance subscriptions
 function useBalancesSubscriptions(
 // TODO: Make this array of BalanceModules more type-safe
-balanceModules, chaindataProvider, addressesByToken) {
+balanceModules, chaindataProvider, addressesByToken, options = {}) {
   // const subscriptions = useRef<
   //   Record<string, { unsub: Promise<() => void>; refcount: number; generation: number }>
   // >({})
@@ -307,7 +308,7 @@ balanceModules, chaindataProvider, addressesByToken) {
     }
   };
   const chainConnector = useChainConnector(chaindataProvider);
-  const chainConnectorEvm = useChainConnectorEvm(chaindataProvider);
+  const chainConnectorEvm = useChainConnectorEvm(chaindataProvider, options);
   const tokens = useTokens(chaindataProvider);
   react.useEffect(() => {
     if (chainConnector === null) return;
@@ -336,7 +337,7 @@ balanceModules, chaindataProvider, addressesByToken) {
     });
     const unsubAll = () => unsubs.forEach(unsub => unsub());
     return unsubAll;
-  }, [addressesByToken, chainConnector, chainConnectorEvm, chaindataProvider, tokens]);
+  }, [addressesByToken, balanceModules, chainConnector, chainConnectorEvm, chaindataProvider, tokens]);
 }
 
 // TODO: Allow advanced users of this library to provide their own chain connector
@@ -349,12 +350,14 @@ function useChainConnector(chaindataProvider) {
   return chainConnector$1;
 }
 // TODO: Allow advanced users of this library to provide their own chain connector
-function useChainConnectorEvm(chaindataProvider) {
+function useChainConnectorEvm(chaindataProvider, options = {}) {
   const [chainConnectorEvm$1, setChainConnectorEvm] = react.useState(null);
   react.useEffect(() => {
     if (chaindataProvider === null) return;
-    setChainConnectorEvm(new chainConnectorEvm.ChainConnectorEvm(chaindataProvider));
-  }, [chaindataProvider]);
+    setChainConnectorEvm(new chainConnectorEvm.ChainConnectorEvm(chaindataProvider, {
+      onfinalityApiKey: options.onfinalityApiKey
+    }));
+  }, [chaindataProvider, options.onfinalityApiKey]);
   return chainConnectorEvm$1;
 }
 

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

@@ -10,7 +10,7 @@ import { fetchTokenRates } from '@talismn/token-rates';
 
 var packageJson = {
 	name: "@talismn/balances-react",
-	version: "0.3.1",
+	version: "0.3.2",
 	author: "Talisman",
 	homepage: "https://talisman.xyz",
 	license: "UNLICENSED",
@@ -73,14 +73,15 @@ var packageJson = {
 var log = anylogger(packageJson.name);
 
 // TODO: Allow user to call useChaindata from multiple places
-
-function useChaindata() {
+function useChaindata(options = {}) {
   const [chaindataProvider, setChaindataProvider] = useState(null);
 
   // this number is incremented each time the chaindataProvider has fetched new data
   const [generation, setGeneration] = useState(0);
   useEffect(() => {
-    const chaindataProvider = new ChaindataProviderExtension();
+    const chaindataProvider = new ChaindataProviderExtension({
+      onfinalityApiKey: options.onfinalityApiKey
+    });
     let shouldHydrate = true;
     const timer = 300_000; // 300_000ms = 300s = 5 minutes
     const hydrate = async () => {
@@ -100,7 +101,7 @@ function useChaindata() {
     return () => {
       shouldHydrate = false;
     };
-  }, []);
+  }, [options.onfinalityApiKey]);
   if (chaindataProvider) chaindataProvider.generation = generation;
   return chaindataProvider;
 }
@@ -113,7 +114,7 @@ function useChains(chaindata) {
       if (thisGeneration !== chaindata.generation) return;
       setChains(chains);
     });
-  }, [chaindata?.generation]);
+  }, [chaindata, chaindata?.generation]);
   return chains || {};
 }
 function useChain(chaindata, chainId) {
@@ -122,7 +123,7 @@ function useChain(chaindata, chainId) {
     if (chaindata === null) return;
     if (!chainId) return;
     chaindata.getChain(chainId).then(setChain);
-  }, [chaindata?.generation]);
+  }, [chainId, chaindata, chaindata?.generation]);
   return chain;
 }
 function useEvmNetworks(chaindata) {
@@ -134,7 +135,7 @@ function useEvmNetworks(chaindata) {
       if (thisGeneration !== chaindata.generation) return;
       setEvmNetworks(evmNetworks);
     });
-  }, [chaindata?.generation]);
+  }, [chaindata, chaindata?.generation]);
   return evmNetworks || {};
 }
 function useEvmNetwork(chaindata, evmNetworkId) {
@@ -143,7 +144,7 @@ function useEvmNetwork(chaindata, evmNetworkId) {
     if (chaindata === null) return;
     if (!evmNetworkId) return;
     chaindata.getEvmNetwork(evmNetworkId).then(setEvmNetwork);
-  }, [chaindata?.generation]);
+  }, [chaindata, chaindata?.generation, evmNetworkId]);
   return evmNetwork;
 }
 function useTokens(chaindata) {
@@ -155,7 +156,7 @@ function useTokens(chaindata) {
       if (thisGeneration !== chaindata.generation) return;
       setTokens(tokens);
     });
-  }, [chaindata?.generation]);
+  }, [chaindata, chaindata?.generation]);
   return tokens || {};
 }
 function useToken(chaindata, tokenId) {
@@ -164,7 +165,7 @@ function useToken(chaindata, tokenId) {
     if (chaindata === null) return;
     if (!tokenId) return;
     chaindata.getToken(tokenId).then(setToken);
-  }, [chaindata?.generation]);
+  }, [chaindata, chaindata?.generation, tokenId]);
   return token;
 }
 
@@ -197,8 +198,8 @@ function useTokenRates(tokens) {
 //       the caller of useChains/useTokens/etc has provided.
 function useBalances(
 // TODO: Make this array of BalanceModules more type-safe
-balanceModules, chaindataProvider, addressesByToken) {
-  useBalancesSubscriptions(balanceModules, chaindataProvider, addressesByToken);
+balanceModules, chaindataProvider, addressesByToken, options = {}) {
+  useBalancesSubscriptions(balanceModules, chaindataProvider, addressesByToken, options);
   const chains = useChains(chaindataProvider);
   const evmNetworks = useEvmNetworks(chaindataProvider);
   const tokens = useTokens(chaindataProvider);
@@ -243,7 +244,7 @@ const subscriptions = {};
 // balance subscriptions
 function useBalancesSubscriptions(
 // TODO: Make this array of BalanceModules more type-safe
-balanceModules, chaindataProvider, addressesByToken) {
+balanceModules, chaindataProvider, addressesByToken, options = {}) {
   // const subscriptions = useRef<
   //   Record<string, { unsub: Promise<() => void>; refcount: number; generation: number }>
   // >({})
@@ -299,7 +300,7 @@ balanceModules, chaindataProvider, addressesByToken) {
     }
   };
   const chainConnector = useChainConnector(chaindataProvider);
-  const chainConnectorEvm = useChainConnectorEvm(chaindataProvider);
+  const chainConnectorEvm = useChainConnectorEvm(chaindataProvider, options);
   const tokens = useTokens(chaindataProvider);
   useEffect(() => {
     if (chainConnector === null) return;
@@ -328,7 +329,7 @@ balanceModules, chaindataProvider, addressesByToken) {
     });
     const unsubAll = () => unsubs.forEach(unsub => unsub());
     return unsubAll;
-  }, [addressesByToken, chainConnector, chainConnectorEvm, chaindataProvider, tokens]);
+  }, [addressesByToken, balanceModules, chainConnector, chainConnectorEvm, chaindataProvider, tokens]);
 }
 
 // TODO: Allow advanced users of this library to provide their own chain connector
@@ -341,12 +342,14 @@ function useChainConnector(chaindataProvider) {
   return chainConnector;
 }
 // TODO: Allow advanced users of this library to provide their own chain connector
-function useChainConnectorEvm(chaindataProvider) {
+function useChainConnectorEvm(chaindataProvider, options = {}) {
   const [chainConnectorEvm, setChainConnectorEvm] = useState(null);
   useEffect(() => {
     if (chaindataProvider === null) return;
-    setChainConnectorEvm(new ChainConnectorEvm(chaindataProvider));
-  }, [chaindataProvider]);
+    setChainConnectorEvm(new ChainConnectorEvm(chaindataProvider, {
+      onfinalityApiKey: options.onfinalityApiKey
+    }));
+  }, [chaindataProvider, options.onfinalityApiKey]);
   return chainConnectorEvm;
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@talismn/balances-react",
-  "version": "0.3.1",
+  "version": "0.3.2",
   "author": "Talisman",
   "homepage": "https://talisman.xyz",
   "license": "UNLICENSED",
@@ -26,7 +26,7 @@
     "clean": "rm -rf dist && rm -rf .turbo rm -rf node_modules"
   },
   "dependencies": {
-    "@talismn/balances": "^0.3.1",
+    "@talismn/balances": "^0.3.2",
     "@talismn/chain-connector": "^0.4.1",
     "@talismn/chain-connector-evm": "^0.4.1",
     "@talismn/chaindata-provider": "^0.4.1",