@talismn/balances-react 1.3.0 → 1.3.2

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

@@ -1,3 +0,0 @@
-import { ChaindataProvider } from "@talismn/chaindata-provider";
-export declare const chaindataProviderAtom: import("jotai").Atom<ChaindataProvider>;
-export declare const useSyncSwapsChaindata: () => [void, never];

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

@@ -1,11 +0,0 @@
-import { CoinsApiConfig } from "@talismn/token-rates";
-export declare const coinsApiConfigAtom: import("jotai").WritableAtom<CoinsApiConfig, [Partial<CoinsApiConfig>], 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

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

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

@@ -1 +0,0 @@
-export declare const tokenRatesAtom: import("jotai").Atom<Promise<import("@talismn/token-rates").TokenRatesList>>;

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

@@ -1,26 +0,0 @@
-import { Balances } from "@talismn/balances";
-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: () => 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 +0,0 @@
-export declare const useChainConnectors: () => import("@talismn/balances").ChainConnectors;

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

@@ -1,3 +0,0 @@
-import { TokenId } from "@talismn/chaindata-provider";
-export declare const useTokenRates: () => import("@talismn/token-rates").TokenRatesList;
-export declare const useTokenRate: (tokenId?: TokenId) => import("@talismn/token-rates").TokenRates;

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

@@ -1,68 +0,0 @@
-import { ReactNode } from "react";
-export { evmErc20TokenId, evmNativeTokenId, subAssetTokenId, subNativeTokenId, subPsp22TokenId, subTokensTokenId, } from "@talismn/chaindata-provider";
-export * from "./hooks/useBalances";
-export * from "./hooks/useChainConnectors";
-export * from "./hooks/useChaindata";
-export * from "./hooks/useTokenRates";
-export * from "./atoms/allAddresses";
-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 = {
-    coinsApiUrl?: 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: ({ coinsApiUrl, withTestnets, enabledChains, enabledTokens, children, }: BalancesConfig) => import("react/jsx-runtime").JSX.Element;

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

@@ -1,2 +0,0 @@
-declare const _default: import("anylogger").Logger<import("anylogger").BaseLevels>;
-export default _default;

package/dist/talismn-balances-react.cjs.d.ts

@@ -1 +0,0 @@
-export * from "./declarations/src/index";

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

@@ -1,351 +0,0 @@
-'use strict';
-
-var jotai = require('jotai');
-var react = require('react');
-var tokenRates = require('@talismn/token-rates');
-var jsxRuntime = require('react/jsx-runtime');
-var chaindataProvider = require('@talismn/chaindata-provider');
-var balances = require('@talismn/balances');
-var jotaiEffect = require('jotai-effect');
-var lodashEs = require('lodash-es');
-var chainConnectors = require('@talismn/chain-connectors');
-var connectionMeta = require('@talismn/connection-meta');
-var util = require('@talismn/util');
-var utils = require('jotai/utils');
-var rxjs = require('rxjs');
-var anylogger = require('anylogger');
-var utilCrypto = require('@polkadot/util-crypto');
-
-function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
-
-var anylogger__default = /*#__PURE__*/_interopDefault(anylogger);
-
-const innerCoinsApiConfigAtom = jotai.atom(tokenRates.DEFAULT_COINSAPI_CONFIG);
-const coinsApiConfigAtom = jotai.atom(get => get(innerCoinsApiConfigAtom), (_get, set, options) => set(innerCoinsApiConfigAtom, {
-  apiUrl: options.apiUrl ?? tokenRates.DEFAULT_COINSAPI_CONFIG.apiUrl
-}));
-const enableTestnetsAtom = jotai.atom(false);
-const enabledChainsAtom = jotai.atom(undefined);
-const enabledTokensAtom = jotai.atom(undefined);
-
-/** Sets the list of addresses for which token balances will be fetched by the balances subscription */
-const allAddressesAtom = jotai.atom([]);
-
-const chaindataProviderAtom = jotai.atom(() => {
-  return new chaindataProvider.ChaindataProvider({
-    // TODO pass persistedStorage
-  });
-});
-const useSyncSwapsChaindata = () => jotai.useAtom(syncSwapsChaindataAtomEffect);
-const syncSwapsChaindataAtomEffect = jotaiEffect.atomEffect(get => {
-  const chaindataProvider = get(chaindataProviderAtom);
-
-  // keep subscription open when swaps modal is open
-  const subscription = chaindataProvider.networks$.subscribe();
-
-  // close susbcription when swaps modal closes
-  return () => subscription.unsubscribe();
-});
-
-const chainConnectorsAtom = jotai.atom(get => {
-  const chaindataProvider = get(chaindataProviderAtom);
-  const substrate = new chainConnectors.ChainConnectorDot(chaindataProvider, connectionMeta.connectionMetaDb);
-  const evm = new chainConnectors.ChainConnectorEth(chaindataProvider);
-  const solana = new chainConnectors.ChainConnectorSol(chaindataProvider);
-  return {
-    substrate,
-    evm,
-    solana
-  };
-});
-
-const balancesProviderAtom = jotai.atom(get => {
-  return new balances.BalancesProvider(get(chaindataProviderAtom), get(chainConnectorsAtom)) // TODO pass storage
-  ;
-});
-
-const chaindataAtom = utils.atomWithObservable(get => {
-  return rxjs.combineLatest({
-    networks: get(chaindataProviderAtom).networks$,
-    tokens: get(chaindataProviderAtom).tokens$
-  }).pipe(util.firstThenDebounce(1_000));
-});
-const filteredChaindataAtom = jotai.atom(async get => {
-  const enabledNetworkIds = get(enabledChainsAtom);
-  const enabledTokenIds = get(enabledTokensAtom);
-  const enableTestnets = get(enableTestnetsAtom);
-  const chaindata = await get(chaindataAtom);
-  const networks = chaindata.networks.filter(n => (enabledNetworkIds?.includes(n.id) || n.isDefault) && (enableTestnets || !n.isTestnet));
-  const networkById = lodashEs.keyBy(networks, n => n.id);
-  const tokens = chaindata.tokens.filter(token => (enabledTokenIds?.includes(token.id) || token.isDefault) && networkById[token.networkId]);
-  return {
-    networks,
-    tokens
-  };
-});
-const tokensAtom = jotai.atom(async get => {
-  const chaindata = await get(filteredChaindataAtom);
-  return chaindata.tokens;
-});
-const networksAtom = jotai.atom(async get => {
-  const chaindata = await get(filteredChaindataAtom);
-  return chaindata.networks;
-});
-
-var packageJson = {
-	name: "@talismn/balances-react"};
-
-var log = anylogger__default.default(packageJson.name);
-
-const tokenRatesAtom = jotai.atom(async get => {
-  // runs a timer to keep tokenRates up to date
-  get(tokenRatesFetcherAtomEffect);
-  return (await get(tokenRatesDbAtom)).tokenRates;
-});
-
-// TODO: Persist to storage
-const tokenRates$ = new rxjs.ReplaySubject(1);
-const tokenRatesDbAtom = utils.atomWithObservable(() => {
-  tokenRates.tryToDeleteOldTokenRatesDb();
-  return tokenRates$.asObservable();
-});
-const tokenRatesFetcherAtomEffect = jotaiEffect.atomEffect(get => {
-  // lets us tear down the existing timer when the effect is restarted
-  const abort = new AbortController();
-
-  // we have to get these synchronously so that jotai knows to restart our timer when they change
-  const coinsApiConfig = get(coinsApiConfigAtom);
-  const tokensPromise = get(tokensAtom);
-  (async () => {
-    const tokensById = lodashEs.keyBy(await tokensPromise, "id");
-    const loopMs = 300_000; // 300_000ms = 300s = 5 minutes
-    const retryTimeout = 5_000; // 5_000ms = 5 seconds
-
-    const hydrate = async () => {
-      try {
-        if (abort.signal.aborted) return; // don't fetch if aborted
-        const tokenRates$1 = await tokenRates.fetchTokenRates(tokensById, tokenRates.ALL_CURRENCY_IDS, coinsApiConfig);
-        const putTokenRates = {
-          tokenRates: tokenRates$1
-        };
-        if (abort.signal.aborted) return; // don't insert into db if aborted
-        tokenRates$.next(putTokenRates);
-        if (abort.signal.aborted) return; // don't schedule next loop if aborted
-        setTimeout(hydrate, loopMs);
-      } catch (error) {
-        const retrying = !abort.signal.aborted;
-        const messageParts = ["Failed to fetch tokenRates", retrying && `retrying in ${Math.round(retryTimeout / 1000)} seconds`, !retrying && `giving up (timer no longer needed)`].filter(util.isTruthy);
-        log.error(messageParts.join(", "), error);
-        if (util.isAbortError(error)) return; // don't schedule retry if aborted
-        setTimeout(hydrate, retryTimeout);
-      }
-    };
-
-    // launch the loop
-    hydrate();
-  })();
-  return () => abort.abort("Unsubscribed");
-});
-
-const addressesByTokenIdAtom = jotai.atom(async get => {
-  const [tokens, addresses] = await Promise.all([get(tokensAtom), get(allAddressesAtom)]);
-  return lodashEs.fromPairs(tokens.map(token => [token.id, addresses]));
-});
-const rawBalancesAtom = jotai.atom([]);
-const subscribeBalancesAtom = jotaiEffect.atomEffect((get, set) => {
-  const unsub = (async () => {
-    const balancesProvider = get(balancesProviderAtom);
-    const addressesByTokenId = await get(addressesByTokenIdAtom);
-    const sub = balancesProvider.getBalances$(addressesByTokenId).subscribe(balances => {
-      set(rawBalancesAtom, balances.balances);
-    });
-    return () => {
-      return sub.unsubscribe();
-    };
-  })();
-  return () => {
-    unsub.then(unsubscribe => unsubscribe());
-  };
-});
-const balancesHydrateDataAtom = jotai.atom(async get => {
-  const [chaindata, tokenRates] = await Promise.all([get(chaindataAtom), get(tokenRatesAtom)]);
-  const networksById = lodashEs.keyBy(chaindata.networks, "id");
-  const tokensById = lodashEs.keyBy(chaindata.tokens, "id");
-  return {
-    networks: networksById,
-    tokens: tokensById,
-    tokenRates
-  };
-});
-const balancesAtom = jotai.atom(async get => {
-  // subscribe to balancesProvider getBalance with addressesByTokenIdAtom as param
-  get(subscribeBalancesAtom);
-  const hydrate = await get(balancesHydrateDataAtom);
-  const rawBalances = get(rawBalancesAtom);
-  return new balances.Balances(rawBalances, hydrate);
-});
-
-const useSetBalancesAddresses = addresses => {
-  const setAllAddresses = jotai.useSetAtom(allAddressesAtom);
-  react.useEffect(() => {
-    setAllAddresses(a => JSON.stringify(a) === JSON.stringify(addresses) ? a : addresses);
-  }, [addresses, setAllAddresses]);
-};
-
-/**
- * @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.
- */
-
-const useBalances = () => {
-  return jotai.useAtomValue(balancesAtom);
-};
-
-// TODO: Extract to shared definition between extension and @talismn/balances-react
-
-/**
- * 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.
-
- */
-const useBalancesStatus = balances => 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) return {
-    status: "fetching"
-  };
-
-  // live
-  return {
-    status: "live"
-  };
-}, [balances]);
-const getStaleChains = balances => [...new Set(balances.each.filter(b => b.status === "stale").map(b => b.network?.name ?? b.networkId ?? "Unknown"))];
-
-const useChainConnectors = () => jotai.useAtomValue(chainConnectorsAtom);
-
-const useChaindataProvider = () => jotai.useAtomValue(chaindataProviderAtom);
-const useChaindata = () => jotai.useAtomValue(chaindataAtom);
-const useNetworks = () => useChaindata().networks;
-const useNetworksById = () => {
-  const {
-    networks
-  } = useChaindata();
-  return react.useMemo(() => lodashEs.keyBy(networks, n => n.id), [networks]);
-};
-const useNetwork = networkId => {
-  const networksById = useNetworksById();
-  return networksById[networkId ?? ""] ?? null;
-};
-const useTokens = () => useChaindata().tokens;
-const useTokensById = () => {
-  const {
-    tokens
-  } = useChaindata();
-  return react.useMemo(() => lodashEs.keyBy(tokens, t => t.id), [tokens]);
-};
-const useToken = tokenId => {
-  const tokensById = useTokensById();
-  return tokensById[tokenId ?? ""] ?? null;
-};
-
-const useTokenRates = () => jotai.useAtomValue(tokenRatesAtom);
-const useTokenRate = tokenId => useTokenRates()[tokenId ?? ""] ?? undefined;
-
-const cryptoWaitReadyAtom = jotai.atom(async () => await utilCrypto.cryptoWaitReady());
-
-const BalancesProvider = ({
-  coinsApiUrl,
-  withTestnets,
-  enabledChains,
-  enabledTokens,
-  children
-}) => {
-  const setCoinsApiConfig = jotai.useSetAtom(coinsApiConfigAtom);
-  react.useEffect(() => {
-    setCoinsApiConfig({
-      apiUrl: coinsApiUrl
-    });
-  }, [coinsApiUrl, setCoinsApiConfig]);
-  const setEnableTestnets = jotai.useSetAtom(enableTestnetsAtom);
-  react.useEffect(() => {
-    setEnableTestnets(withTestnets ?? false);
-  }, [setEnableTestnets, withTestnets]);
-  const setEnabledChains = jotai.useSetAtom(enabledChainsAtom);
-  react.useEffect(() => {
-    setEnabledChains(enabledChains);
-  }, [enabledChains, setEnabledChains]);
-  const setEnabledTokens = jotai.useSetAtom(enabledTokensAtom);
-  react.useEffect(() => {
-    setEnabledTokens(enabledTokens);
-  }, [enabledTokens, setEnabledTokens]);
-  return /*#__PURE__*/jsxRuntime.jsx(jsxRuntime.Fragment, {
-    children: children
-  });
-};
-
-Object.defineProperty(exports, "evmErc20TokenId", {
-  enumerable: true,
-  get: function () { return chaindataProvider.evmErc20TokenId; }
-});
-Object.defineProperty(exports, "evmNativeTokenId", {
-  enumerable: true,
-  get: function () { return chaindataProvider.evmNativeTokenId; }
-});
-Object.defineProperty(exports, "subAssetTokenId", {
-  enumerable: true,
-  get: function () { return chaindataProvider.subAssetTokenId; }
-});
-Object.defineProperty(exports, "subNativeTokenId", {
-  enumerable: true,
-  get: function () { return chaindataProvider.subNativeTokenId; }
-});
-Object.defineProperty(exports, "subPsp22TokenId", {
-  enumerable: true,
-  get: function () { return chaindataProvider.subPsp22TokenId; }
-});
-Object.defineProperty(exports, "subTokensTokenId", {
-  enumerable: true,
-  get: function () { return chaindataProvider.subTokensTokenId; }
-});
-exports.BalancesProvider = BalancesProvider;
-exports.allAddressesAtom = allAddressesAtom;
-exports.balancesAtom = balancesAtom;
-exports.chainConnectorsAtom = chainConnectorsAtom;
-exports.chaindataAtom = chaindataAtom;
-exports.chaindataProviderAtom = chaindataProviderAtom;
-exports.coinsApiConfigAtom = coinsApiConfigAtom;
-exports.cryptoWaitReadyAtom = cryptoWaitReadyAtom;
-exports.enableTestnetsAtom = enableTestnetsAtom;
-exports.enabledChainsAtom = enabledChainsAtom;
-exports.enabledTokensAtom = enabledTokensAtom;
-exports.getStaleChains = getStaleChains;
-exports.networksAtom = networksAtom;
-exports.tokenRatesAtom = tokenRatesAtom;
-exports.tokensAtom = tokensAtom;
-exports.useBalances = useBalances;
-exports.useBalancesStatus = useBalancesStatus;
-exports.useChainConnectors = useChainConnectors;
-exports.useChaindata = useChaindata;
-exports.useChaindataProvider = useChaindataProvider;
-exports.useNetwork = useNetwork;
-exports.useNetworks = useNetworks;
-exports.useNetworksById = useNetworksById;
-exports.useSetBalancesAddresses = useSetBalancesAddresses;
-exports.useSyncSwapsChaindata = useSyncSwapsChaindata;
-exports.useToken = useToken;
-exports.useTokenRate = useTokenRate;
-exports.useTokenRates = useTokenRates;
-exports.useTokens = useTokens;
-exports.useTokensById = useTokensById;

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

@@ -1,7 +0,0 @@
-'use strict';
-
-if (process.env.NODE_ENV === "production") {
-  module.exports = require("./talismn-balances-react.cjs.prod.js");
-} else {
-  module.exports = require("./talismn-balances-react.cjs.dev.js");
-}