@talismn/balances-react 0.1.17 → 0.1.19

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # @talismn/balances-react
 
+## 0.1.19
+
+### Patch Changes
+
+- @talismn/balances@0.1.19
+
+## 0.1.18
+
+### Patch Changes
+
+- fix: a variety of improvements from the wallet integration
+- Updated dependencies
+  - @talismn/balances@0.1.18
+  - @talismn/chain-connector@0.1.10
+  - @talismn/chain-connector-evm@0.1.10
+  - @talismn/chaindata-provider@0.1.10
+  - @talismn/chaindata-provider-extension@0.1.10
+  - @talismn/token-rates@0.1.10
+
 ## 0.1.17
 
 ### Patch Changes

package/dist/hooks/index.d.ts

@@ -1,2 +1,3 @@
 export * from "./useBalances";
 export * from "./useChaindata";
+export * from "./useTokenRates";

package/dist/hooks/index.js

@@ -1,2 +1,3 @@
 export * from "./useBalances";
 export * from "./useChaindata";
+export * from "./useTokenRates";

package/dist/hooks/useBalances.d.ts

@@ -1,8 +1,3 @@
-import { AddressesByToken, BalanceJson, BalanceModule, Balances } from "@talismn/balances";
+import { AddressesByToken, BalanceModule, Balances } from "@talismn/balances";
 import { ChaindataProvider, Token } from "@talismn/chaindata-provider";
-import { Dexie } from "dexie";
 export declare function useBalances(balanceModules: Array<BalanceModule<any, any, any, any>>, chaindataProvider: ChaindataProvider | null, addressesByToken: AddressesByToken<Token> | null): Balances | undefined;
-export declare class BalancesDatabase extends Dexie {
-    balances: Dexie.Table<BalanceJson, string>;
-    constructor();
-}

package/dist/hooks/useBalances.js

@@ -8,15 +8,23 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import { Balances, balances as balancesFn, } from "@talismn/balances";
+import { db } from "@talismn/balances";
 import { ChainConnector } from "@talismn/chain-connector";
 import { ChainConnectorEvm } from "@talismn/chain-connector-evm";
-import { Dexie } from "dexie";
 import { useLiveQuery } from "dexie-react-hooks";
 import { useEffect, useState } from "react";
 import { useDebounce } from "react-use";
 import log from "../log";
 import { useChains, useEvmNetworks, useTokens } from "./useChaindata";
 import { useTokenRates } from "./useTokenRates";
+// TODO: Add the equivalent functionalty of `useDbCache` directly to this library.
+//
+//       How it will work:
+//
+//       useChains/useEvmNetworks/useTokens/useTokenRates will all make use of a
+//       useCachedDb hook, which internally subscribes to all of the db tables
+//       for everything, and then filters the subscribed data based on what params
+//       the caller of useChains/useTokens/etc has provided.
 export function useBalances(
 // TODO: Make this array of BalanceModules more type-safe
 balanceModules, chaindataProvider, addressesByToken) {
@@ -28,17 +36,24 @@ balanceModules, chaindataProvider, addressesByToken) {
     const balances = useLiveQuery(() => __awaiter(this, void 0, void 0, function* () {
         return new Balances(yield db.balances
             .filter((balance) => {
+            // check that this balance is included in our queried balance modules
             if (!balanceModules.map(({ type }) => type).includes(balance.source))
                 return false;
+            // check that our query includes some tokens and addresses
             if (!addressesByToken)
                 return false;
+            // check that this balance is included in our queried tokens
             if (!Object.keys(addressesByToken).includes(balance.tokenId))
                 return false;
+            // check that this balance is included in our queried addresses for this token
             if (!addressesByToken[balance.tokenId].includes(balance.address))
                 return false;
+            // keep this balance
             return true;
         })
-            .toArray(), { chains, evmNetworks, tokens, tokenRates });
+            .toArray(), 
+        // hydrate balance chains, evmNetworks, tokens and tokenRates
+        { chains, evmNetworks, tokens, tokenRates });
     }), [balanceModules, addressesByToken, chains, evmNetworks, tokens, tokenRates]);
     // debounce every 100ms to prevent hammering UI with updates
     const [debouncedBalances, setDebouncedBalances] = useState(balances);
@@ -105,7 +120,7 @@ balanceModules, chaindataProvider, addressesByToken) {
         }
     };
     const chainConnector = useChainConnector(chaindataProvider);
-    const chainConnectorEvm = useChainConnectorEvm();
+    const chainConnectorEvm = useChainConnectorEvm(chaindataProvider);
     const tokens = useTokens(chaindataProvider);
     useEffect(() => {
         if (chainConnector === null)
@@ -142,26 +157,13 @@ function useChainConnector(chaindataProvider) {
     }, [chaindataProvider]);
     return chainConnector;
 }
-function useChainConnectorEvm() {
+// TODO: Allow advanced users of this library to provide their own chain connector
+function useChainConnectorEvm(chaindataProvider) {
     const [chainConnectorEvm, setChainConnectorEvm] = useState(null);
     useEffect(() => {
-        setChainConnectorEvm(new ChainConnectorEvm());
+        if (chaindataProvider === null)
+            return;
+        setChainConnectorEvm(new ChainConnectorEvm(chaindataProvider));
     }, []);
     return chainConnectorEvm;
 }
-export class BalancesDatabase extends Dexie {
-    constructor() {
-        super("Balances");
-        // https://dexie.org/docs/Tutorial/Design#database-versioning
-        this.version(1).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",
-        });
-    }
-}
-const db = new BalancesDatabase();

package/dist/hooks/useTokenRates.d.ts

@@ -1,3 +1,3 @@
-import { TokenList } from "@talismn/chaindata-provider";
+import { IToken, TokenId } from "@talismn/chaindata-provider";
 import { TokenRatesList } from "@talismn/token-rates";
-export declare function useTokenRates(tokens?: TokenList): TokenRatesList;
+export declare function useTokenRates(tokens?: Record<TokenId, IToken>): TokenRatesList;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@talismn/balances-react",
-  "version": "0.1.17",
+  "version": "0.1.19",
   "author": "Talisman",
   "homepage": "https://talisman.xyz",
   "license": "UNLICENSED",
@@ -30,11 +30,12 @@
     "clean": "rm -rf dist && rm -rf .turbo rm -rf node_modules"
   },
   "dependencies": {
-    "@talismn/balances": "^0.1.17",
-    "@talismn/chain-connector": "^0.1.9",
-    "@talismn/chain-connector-evm": "^0.1.9",
-    "@talismn/chaindata-provider": "^0.1.9",
-    "@talismn/chaindata-provider-extension": "^0.1.9",
+    "@talismn/balances": "^0.1.19",
+    "@talismn/chain-connector": "^0.1.10",
+    "@talismn/chain-connector-evm": "^0.1.10",
+    "@talismn/chaindata-provider": "^0.1.10",
+    "@talismn/chaindata-provider-extension": "^0.1.10",
+    "@talismn/token-rates": "^0.1.10",
     "anylogger": "^1.0.11",
     "dexie": "^3.2.2",
     "dexie-react-hooks": "^1.1.1",