@talismn/balances-react 0.6.1 → 0.7.0

package/dist/declarations/src/atoms/allAddresses.d.ts

@@ -0,0 +1,4 @@
+/** Sets the list of addresses for which token balances will be fetched by the balances subscription */
+export declare const allAddressesAtom: import("jotai").PrimitiveAtom<string[]> & {
+    init: string[];
+};

package/dist/declarations/src/atoms/balanceModules.d.ts

@@ -0,0 +1,2 @@
+import { AnyBalanceModule } from "@talismn/balances";
+export declare const balanceModulesAtom: import("jotai").Atom<AnyBalanceModule[]>;

package/dist/declarations/src/atoms/balances.d.ts

@@ -0,0 +1,6 @@
+import { Balances } from "@talismn/balances";
+import { BalancesPersistBackend } from "../util/balancesPersist";
+export declare const allBalancesAtom: import("jotai").Atom<Promise<Balances>>;
+export declare const balancesPersistBackendAtom: import("jotai").PrimitiveAtom<BalancesPersistBackend> & {
+    init: BalancesPersistBackend;
+};

package/dist/declarations/src/atoms/chainConnectors.d.ts

@@ -0,0 +1,2 @@
+import { ChainConnectors } from "@talismn/balances";
+export declare const chainConnectorsAtom: import("jotai").Atom<ChainConnectors>;

package/dist/declarations/src/atoms/chaindata.d.ts

@@ -0,0 +1,34 @@
+import { Token } from "@talismn/chaindata-provider";
+export declare const chainsAtom: import("jotai").Atom<Promise<(import("@talismn/chaindata-provider").Chain | import("@talismn/chaindata-provider").CustomChain)[]>>;
+export declare const chainsByIdAtom: import("jotai").Atom<Promise<Record<string, import("@talismn/chaindata-provider").Chain | import("@talismn/chaindata-provider").CustomChain>>>;
+export declare const chainsByGenesisHashAtom: import("jotai").Atom<Promise<Record<string, import("@talismn/chaindata-provider").Chain | import("@talismn/chaindata-provider").CustomChain>>>;
+export declare const evmNetworksAtom: import("jotai").Atom<Promise<(import("@talismn/chaindata-provider").EvmNetwork | import("@talismn/chaindata-provider").CustomEvmNetwork)[]>>;
+export declare const evmNetworksByIdAtom: import("jotai").Atom<Promise<Record<string, import("@talismn/chaindata-provider").EvmNetwork | import("@talismn/chaindata-provider").CustomEvmNetwork>>>;
+export declare const tokensAtom: import("jotai").Atom<Promise<Token[]>>;
+export declare const tokensByIdAtom: import("jotai").Atom<Promise<{
+    [k: string]: Token;
+}>>;
+export declare const miniMetadatasAtom: import("jotai").Atom<Promise<import("@talismn/balances").MiniMetadata[]>>;
+export declare const chaindataAtom: import("jotai").Atom<{
+    chains: (import("@talismn/chaindata-provider").Chain | import("@talismn/chaindata-provider").CustomChain)[];
+    chainsById: Record<string, import("@talismn/chaindata-provider").Chain | import("@talismn/chaindata-provider").CustomChain>;
+    chainsByGenesisHash: Record<string, import("@talismn/chaindata-provider").Chain | import("@talismn/chaindata-provider").CustomChain>;
+    evmNetworks: (import("@talismn/chaindata-provider").EvmNetwork | import("@talismn/chaindata-provider").CustomEvmNetwork)[];
+    evmNetworksById: Record<string, import("@talismn/chaindata-provider").EvmNetwork | import("@talismn/chaindata-provider").CustomEvmNetwork>;
+    tokens: Token[];
+    tokensById: {
+        [k: string]: Token;
+    };
+    miniMetadatas: import("@talismn/balances").MiniMetadata[];
+} | Promise<{
+    chains: (import("@talismn/chaindata-provider").Chain | import("@talismn/chaindata-provider").CustomChain)[];
+    chainsById: Record<string, import("@talismn/chaindata-provider").Chain | import("@talismn/chaindata-provider").CustomChain>;
+    chainsByGenesisHash: Record<string, import("@talismn/chaindata-provider").Chain | import("@talismn/chaindata-provider").CustomChain>;
+    evmNetworks: (import("@talismn/chaindata-provider").EvmNetwork | import("@talismn/chaindata-provider").CustomEvmNetwork)[];
+    evmNetworksById: Record<string, import("@talismn/chaindata-provider").EvmNetwork | import("@talismn/chaindata-provider").CustomEvmNetwork>;
+    tokens: Token[];
+    tokensById: {
+        [k: string]: Token;
+    };
+    miniMetadatas: import("@talismn/balances").MiniMetadata[];
+}>>;

package/dist/declarations/src/atoms/chaindataProvider.d.ts

@@ -0,0 +1,5 @@
+import { ChaindataProvider } from "@talismn/chaindata-provider";
+export declare const chaindataProviderAtom: import("jotai").Atom<ChaindataProvider>;
+export declare const miniMetadataHydratedAtom: import("jotai").PrimitiveAtom<boolean> & {
+    init: boolean;
+};

package/dist/declarations/src/atoms/config.d.ts

@@ -0,0 +1,18 @@
+import { AnyBalanceModule, Hydrate } from "@talismn/balances";
+import { CoingeckoConfig } from "@talismn/token-rates";
+export declare const balanceModuleCreatorsAtom: import("jotai").PrimitiveAtom<((hydrate: Hydrate) => AnyBalanceModule)[]> & {
+    init: ((hydrate: Hydrate) => AnyBalanceModule)[];
+};
+export declare const onfinalityApiKeyAtom: import("jotai").PrimitiveAtom<string | undefined> & {
+    init: string | undefined;
+};
+export declare const coingeckoConfigAtom: import("jotai").WritableAtom<CoingeckoConfig, [Partial<CoingeckoConfig>], void>;
+export declare const enableTestnetsAtom: import("jotai").PrimitiveAtom<boolean> & {
+    init: boolean;
+};
+export declare const enabledChainsAtom: import("jotai").PrimitiveAtom<string[] | undefined> & {
+    init: string[] | undefined;
+};
+export declare const enabledTokensAtom: import("jotai").PrimitiveAtom<string[] | undefined> & {
+    init: string[] | undefined;
+};

package/dist/declarations/src/atoms/cryptoWaitReady.d.ts

@@ -0,0 +1 @@
+export declare const cryptoWaitReadyAtom: import("jotai").Atom<Promise<boolean>>;

package/dist/declarations/src/atoms/tokenRates.d.ts

@@ -0,0 +1,3 @@
+export declare const tokenRatesAtom: import("jotai").Atom<Promise<{
+    [k: string]: import("@talismn/token-rates").TokenRates;
+}>>;

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

@@ -1,3 +1,27 @@
-import { AddressesByToken } from "@talismn/balances";
-import { Token } from "@talismn/chaindata-provider";
-export declare function useBalances(addressesByToken: AddressesByToken<Token> | null): any;
+import { Balances } from "@talismn/balances";
+import { BalancesPersistBackend } from "../util/balancesPersist";
+export declare const useSetBalancesAddresses: (addresses: string[]) => void;
+/**
+ * @name useBalances
+ * @description Hook to get the current balances state.
+ * @param persistBackend an optional BalancesPersistBackend backend to use for persisting the balances state. By default, indexedDB is used.
+ * @returns a Balances object containing the current balances state.
+ */
+export declare const useBalances: (persistBackend?: BalancesPersistBackend) => 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.
+ * @returns An instance of `BalancesStatus` which represents the status of the balances collection.
+
+ */
+export declare const useBalancesStatus: (balances: Balances) => BalancesStatus;
+export declare const getStaleChains: (balances: Balances) => string[];

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

@@ -1,12 +1 @@
-/// <reference types="react" />
-import { ChainConnector } from "@talismn/chain-connector";
-import { ChainConnectorEvm } from "@talismn/chain-connector-evm";
-export type ChainConnectorsProviderOptions = {
-    onfinalityApiKey?: string;
-};
-export declare const ChainConnectorsProvider: import("react").FC<ChainConnectorsProviderOptions & {
-    children?: import("react").ReactNode;
-}>, useChainConnectors: () => {
-    substrate: ChainConnector;
-    evm: ChainConnectorEvm;
-};
+export declare const useChainConnectors: () => import("@talismn/balances").ChainConnectors;

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

@@ -1,8 +1,24 @@
-/// <reference types="react" />
-import { ChaindataProviderExtension } from "@talismn/chaindata-provider-extension";
-export type ChaindataProviderOptions = {
-    onfinalityApiKey?: string;
+import { ChainId, EvmNetworkId, TokenId } from "@talismn/chaindata-provider";
+export declare const useChaindataProvider: () => import("@talismn/chaindata-provider").ChaindataProvider;
+export declare const useChaindata: () => {
+    chains: (import("@talismn/chaindata-provider").Chain | import("@talismn/chaindata-provider").CustomChain)[];
+    chainsById: Record<string, import("@talismn/chaindata-provider").Chain | import("@talismn/chaindata-provider").CustomChain>;
+    chainsByGenesisHash: Record<string, import("@talismn/chaindata-provider").Chain | import("@talismn/chaindata-provider").CustomChain>;
+    evmNetworks: (import("@talismn/chaindata-provider").EvmNetwork | import("@talismn/chaindata-provider").CustomEvmNetwork)[];
+    evmNetworksById: Record<string, import("@talismn/chaindata-provider").EvmNetwork | import("@talismn/chaindata-provider").CustomEvmNetwork>;
+    tokens: import("@talismn/chaindata-provider").Token[];
+    tokensById: {
+        [k: string]: import("@talismn/chaindata-provider").Token;
+    };
+    miniMetadatas: import("@talismn/balances").MiniMetadata[];
 };
-export declare const ChaindataProvider: import("react").FC<ChaindataProviderOptions & {
-    children?: import("react").ReactNode;
-}>, useChaindata: () => ChaindataProviderExtension;
+export declare const useChains: () => Record<string, import("@talismn/chaindata-provider").Chain | import("@talismn/chaindata-provider").CustomChain>;
+export declare const useChainsByGenesisHash: () => Record<string, import("@talismn/chaindata-provider").Chain | import("@talismn/chaindata-provider").CustomChain>;
+export declare const useEvmNetworks: () => Record<string, import("@talismn/chaindata-provider").EvmNetwork | import("@talismn/chaindata-provider").CustomEvmNetwork>;
+export declare const useTokens: () => {
+    [k: string]: import("@talismn/chaindata-provider").Token;
+};
+export declare const useMiniMetadatas: () => import("@talismn/balances").MiniMetadata[];
+export declare const useChain: (chainId?: ChainId) => import("@talismn/chaindata-provider").Chain | import("@talismn/chaindata-provider").CustomChain;
+export declare const useEvmNetwork: (evmNetworkId?: EvmNetworkId) => import("@talismn/chaindata-provider").EvmNetwork | import("@talismn/chaindata-provider").CustomEvmNetwork;
+export declare const useToken: (tokenId?: TokenId) => import("@talismn/chaindata-provider").Token;

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

@@ -1,3 +1,5 @@
 import { TokenId } from "@talismn/chaindata-provider";
-export declare function useTokenRates(): Record<string, import("@talismn/token-rates").TokenRates>;
-export declare function useTokenRate(tokenId?: TokenId): import("@talismn/token-rates").TokenRates | undefined;
+export declare const useTokenRates: () => {
+    [k: string]: import("@talismn/token-rates").TokenRates;
+};
+export declare const useTokenRate: (tokenId?: TokenId) => import("@talismn/token-rates").TokenRates;

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

@@ -1,2 +1,80 @@
-export * from "./hooks";
-export * from "./util";
+import { AnyBalanceModule, Hydrate } from "@talismn/balances";
+import { ReactNode } from "react";
+export { evmErc20TokenId, evmNativeTokenId, subNativeTokenId, subEquilibriumTokenId, subAssetTokenId, subPsp22TokenId, subTokensTokenId, } from "@talismn/balances";
+export * from "./hooks/useBalances";
+export * from "./hooks/useChainConnectors";
+export * from "./hooks/useChaindata";
+export * from "./hooks/useTokenRates";
+export * from "./atoms/allAddresses";
+export * from "./atoms/balanceModules";
+export * from "./atoms/balances";
+export * from "./atoms/chainConnectors";
+export * from "./atoms/chaindata";
+export * from "./atoms/chaindataProvider";
+export * from "./atoms/config";
+export * from "./atoms/cryptoWaitReady";
+export * from "./atoms/tokenRates";
+export type BalancesConfig = {
+    /**
+     * Optionally provide your own array of BalanceModules, when you don't want to use the defaults.
+     */
+    balanceModules?: Array<(hydrate: Hydrate) => AnyBalanceModule>;
+    /**
+     * This key will be used in place of any public onfinality RPCs
+     */
+    onfinalityApiKey?: string;
+    coingeckoApiUrl?: string;
+    coingeckoApiKeyName?: string;
+    coingeckoApiKeyValue?: string;
+    /** Enables balances fetching for tokens on testnet chains. */
+    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 `useTestnets` prop to `true`.
+     *
+     * @example
+     * enabledChains={[
+     *   // polkadot
+     *   "0x91b171bb158e2d3848fa23a9f1c25182fb8e20313b2c1eb49219da7a70ce90c3",
+     *   // kusama
+     *   "0xb0a8d493285c2df73290dfb7e61f870f17b41801197a149ca93654499ea3dafe",
+     *   // rococo
+     *   "0x6408de7737c59c238890533af25896a2c20608d8b380bb01029acb392781063e",
+     *   // westend
+     *   "0xe143f23803ac50e8f6f8e62695d1ce9e4e1d68aa36c1cd2cfd15340213f3423e",
+     * ]}
+     */
+    enabledChains?: string[];
+    /**
+     * A list of token ids to fetch balances for.
+     *
+     * If undefined, balances will be fetched for all tokens.
+     *
+     * If `enabledChains` is also defined, both filters will be applied,
+     * such that only the intersection of enabledChains and enabledTokens will be fetched.
+     *
+     * @example
+     * enabledTokens={[
+     *   // DOT (polkadot relay chain)
+     *   "polkadot-substrate-native",
+     *   // USDC (polkadot asset hub)
+     *   "polkadot-asset-hub-substrate-assets-1337-usdc",
+     *   // ETH (ethereum mainnet)
+     *   "1-evm-native",
+     *   // GM (gm chain)
+     *   "gm-substrate-tokens-gm",
+     * ]}
+     */
+    enabledTokens?: string[];
+    children?: ReactNode;
+};
+export declare const BalancesProvider: ({ balanceModules, onfinalityApiKey, coingeckoApiUrl, coingeckoApiKeyName, coingeckoApiKeyValue, withTestnets, enabledChains, enabledTokens, children, }: BalancesConfig) => import("react/jsx-runtime").JSX.Element;

package/dist/declarations/src/util/balancesPersist.d.ts

@@ -0,0 +1,10 @@
+import { BalanceJson } from "@talismn/balances";
+type PersistFn = (balances: BalanceJson[]) => Promise<void>;
+type RetrieveFn = () => Promise<BalanceJson[]>;
+export type BalancesPersistBackend = {
+    persist: PersistFn;
+    retrieve: RetrieveFn;
+};
+export declare const indexedDbBalancesPersistBackend: BalancesPersistBackend;
+export declare const localStorageBalancesPersistBackend: BalancesPersistBackend;
+export {};

package/dist/declarations/src/util/dexieToRxjs.d.ts

@@ -0,0 +1,6 @@
+import { Observable as DexieObservable } from "dexie";
+import { Observable as RxjsObservable } from "rxjs";
+/**
+ * Converts a dexie Observable into an rxjs Observable.
+ */
+export declare function dexieToRxjs<T>(o: DexieObservable<T>): RxjsObservable<T>;