@sodax/dapp-kit 1.0.2-beta → 1.0.4-beta-rc1

package/dist/index.d.mts

@@ -424,6 +424,42 @@ type UseATokenParams = {
  */
 declare function useAToken({ aToken, queryOptions }: UseATokenParams): UseQueryResult<XToken, Error>;
 
+type UseATokensBalancesParams = {
+    aTokens: readonly Address[];
+    spokeProvider?: SpokeProvider;
+    userAddress?: string;
+    queryOptions?: UseQueryOptions<Map<Address, bigint>, Error>;
+};
+/**
+ * React hook to fetch and cache aToken balances for multiple aToken addresses in a single multicall.
+ *
+ * Accepts an array of aToken addresses, a spoke provider, and user address. The hook derives the user's
+ * hub wallet address and then fetches balanceOf for each aToken in a single multicall. Returns a Map
+ * of aToken address to balance, with querying/caching powered by React Query. This hook uses viem's
+ * multicall to batch all requests into a single RPC call for better performance.
+ *
+ * @param {UseATokensBalancesParams} params - Required params object:
+ *   @property {readonly Address[]} aTokens - Array of aToken contract addresses to query balances for.
+ *   @property {SpokeProvider} spokeProvider - The spoke provider to derive hub wallet address from.
+ *   @property {string} userAddress - User's wallet address on the spoke chain.
+ *   @property {UseQueryOptions<Map<Address, bigint>, Error>} queryOptions - React Query options to control query (e.g., staleTime, refetch, etc.).
+ *
+ * @returns {UseQueryResult<Map<Address, bigint>, Error>} React Query result object:
+ *   - data: Map of aToken address to balance, if available
+ *   - isLoading: Boolean loading state
+ *   - error: Error, if API call fails
+ *
+ * @example
+ * const { data: aTokenBalances, isLoading, error } = useATokensBalances({
+ *   aTokens: [aToken1, aToken2, aToken3],
+ *   spokeProvider,
+ *   userAddress: '0x...',
+ *   queryOptions: {}
+ * });
+ * const aToken1Balance = aTokenBalances?.get(aToken1);
+ */
+declare function useATokensBalances({ aTokens, spokeProvider, userAddress, queryOptions, }: UseATokensBalancesParams): UseQueryResult<Map<Address, bigint>, Error>;
+
 type UseReservesUsdFormatParams = {
     queryOptions?: UseQueryOptions<(ReserveData & {
         priceInMarketReferenceCurrency: string;
@@ -1756,4 +1792,4 @@ interface SodaxProviderProps {
 }
 declare const SodaxProvider: ({ children, testnet, config, rpcConfig }: SodaxProviderProps) => ReactElement;
 
-export { type BackendPaginationParams, MIGRATION_MODE_BNUSD, MIGRATION_MODE_ICX_SODA, type MigrationIntentParams, type MigrationMode, SodaxProvider, type UseATokenParams, type UseBorrowParams, type UseMMAllowanceParams, type UseMMApproveParams, type UseRepayParams, type UseReservesDataParams, type UseReservesUsdFormatParams, type UseSupplyParams, type UseUserFormattedSummaryParams, type UseUserReservesDataParams, type UseWithdrawParams, useAToken, useBackendAllMoneyMarketAssets, useBackendAllMoneyMarketBorrowers, useBackendIntentByHash, useBackendIntentByTxHash, useBackendMoneyMarketAsset, useBackendMoneyMarketAssetBorrowers, useBackendMoneyMarketAssetSuppliers, useBackendMoneyMarketPosition, useBackendOrderbook, useBackendUserIntents, useBorrow, useBridge, useBridgeAllowance, useBridgeApprove, useCancelLimitOrder, useCancelSwap, useCancelUnstake, useClaim, useConvertedAssets, useCreateLimitOrder, useDeriveUserWalletAddress, useEstimateGas, useGetBridgeableAmount, useGetBridgeableTokens, useHubProvider, useInstantUnstake, useInstantUnstakeAllowance, useInstantUnstakeApprove, useInstantUnstakeRatio, useMMAllowance, useMMApprove, useMigrate, useMigrationAllowance, useMigrationApprove, useQuote, useRepay, useRequestTrustline, useReservesData, useReservesUsdFormat, useSodaxContext, useSpokeProvider, useStake, useStakeAllowance, useStakeApprove, useStakeRatio, useStakingConfig, useStakingInfo, useStatus, useStellarTrustlineCheck, useSupply, useSwap, useSwapAllowance, useSwapApprove, useUnstake, useUnstakeAllowance, useUnstakeApprove, useUnstakingInfo, useUnstakingInfoWithPenalty, useUserFormattedSummary, useUserReservesData, useWithdraw };
+export { type BackendPaginationParams, MIGRATION_MODE_BNUSD, MIGRATION_MODE_ICX_SODA, type MigrationIntentParams, type MigrationMode, SodaxProvider, type UseATokenParams, type UseATokensBalancesParams, type UseBorrowParams, type UseMMAllowanceParams, type UseMMApproveParams, type UseRepayParams, type UseReservesDataParams, type UseReservesUsdFormatParams, type UseSupplyParams, type UseUserFormattedSummaryParams, type UseUserReservesDataParams, type UseWithdrawParams, useAToken, useATokensBalances, useBackendAllMoneyMarketAssets, useBackendAllMoneyMarketBorrowers, useBackendIntentByHash, useBackendIntentByTxHash, useBackendMoneyMarketAsset, useBackendMoneyMarketAssetBorrowers, useBackendMoneyMarketAssetSuppliers, useBackendMoneyMarketPosition, useBackendOrderbook, useBackendUserIntents, useBorrow, useBridge, useBridgeAllowance, useBridgeApprove, useCancelLimitOrder, useCancelSwap, useCancelUnstake, useClaim, useConvertedAssets, useCreateLimitOrder, useDeriveUserWalletAddress, useEstimateGas, useGetBridgeableAmount, useGetBridgeableTokens, useHubProvider, useInstantUnstake, useInstantUnstakeAllowance, useInstantUnstakeApprove, useInstantUnstakeRatio, useMMAllowance, useMMApprove, useMigrate, useMigrationAllowance, useMigrationApprove, useQuote, useRepay, useRequestTrustline, useReservesData, useReservesUsdFormat, useSodaxContext, useSpokeProvider, useStake, useStakeAllowance, useStakeApprove, useStakeRatio, useStakingConfig, useStakingInfo, useStatus, useStellarTrustlineCheck, useSupply, useSwap, useSwapAllowance, useSwapApprove, useUnstake, useUnstakeAllowance, useUnstakeApprove, useUnstakingInfo, useUnstakingInfoWithPenalty, useUserFormattedSummary, useUserReservesData, useWithdraw };

package/dist/index.d.ts

@@ -424,6 +424,42 @@ type UseATokenParams = {
  */
 declare function useAToken({ aToken, queryOptions }: UseATokenParams): UseQueryResult<XToken, Error>;
 
+type UseATokensBalancesParams = {
+    aTokens: readonly Address[];
+    spokeProvider?: SpokeProvider;
+    userAddress?: string;
+    queryOptions?: UseQueryOptions<Map<Address, bigint>, Error>;
+};
+/**
+ * React hook to fetch and cache aToken balances for multiple aToken addresses in a single multicall.
+ *
+ * Accepts an array of aToken addresses, a spoke provider, and user address. The hook derives the user's
+ * hub wallet address and then fetches balanceOf for each aToken in a single multicall. Returns a Map
+ * of aToken address to balance, with querying/caching powered by React Query. This hook uses viem's
+ * multicall to batch all requests into a single RPC call for better performance.
+ *
+ * @param {UseATokensBalancesParams} params - Required params object:
+ *   @property {readonly Address[]} aTokens - Array of aToken contract addresses to query balances for.
+ *   @property {SpokeProvider} spokeProvider - The spoke provider to derive hub wallet address from.
+ *   @property {string} userAddress - User's wallet address on the spoke chain.
+ *   @property {UseQueryOptions<Map<Address, bigint>, Error>} queryOptions - React Query options to control query (e.g., staleTime, refetch, etc.).
+ *
+ * @returns {UseQueryResult<Map<Address, bigint>, Error>} React Query result object:
+ *   - data: Map of aToken address to balance, if available
+ *   - isLoading: Boolean loading state
+ *   - error: Error, if API call fails
+ *
+ * @example
+ * const { data: aTokenBalances, isLoading, error } = useATokensBalances({
+ *   aTokens: [aToken1, aToken2, aToken3],
+ *   spokeProvider,
+ *   userAddress: '0x...',
+ *   queryOptions: {}
+ * });
+ * const aToken1Balance = aTokenBalances?.get(aToken1);
+ */
+declare function useATokensBalances({ aTokens, spokeProvider, userAddress, queryOptions, }: UseATokensBalancesParams): UseQueryResult<Map<Address, bigint>, Error>;
+
 type UseReservesUsdFormatParams = {
     queryOptions?: UseQueryOptions<(ReserveData & {
         priceInMarketReferenceCurrency: string;
@@ -1756,4 +1792,4 @@ interface SodaxProviderProps {
 }
 declare const SodaxProvider: ({ children, testnet, config, rpcConfig }: SodaxProviderProps) => ReactElement;
 
-export { type BackendPaginationParams, MIGRATION_MODE_BNUSD, MIGRATION_MODE_ICX_SODA, type MigrationIntentParams, type MigrationMode, SodaxProvider, type UseATokenParams, type UseBorrowParams, type UseMMAllowanceParams, type UseMMApproveParams, type UseRepayParams, type UseReservesDataParams, type UseReservesUsdFormatParams, type UseSupplyParams, type UseUserFormattedSummaryParams, type UseUserReservesDataParams, type UseWithdrawParams, useAToken, useBackendAllMoneyMarketAssets, useBackendAllMoneyMarketBorrowers, useBackendIntentByHash, useBackendIntentByTxHash, useBackendMoneyMarketAsset, useBackendMoneyMarketAssetBorrowers, useBackendMoneyMarketAssetSuppliers, useBackendMoneyMarketPosition, useBackendOrderbook, useBackendUserIntents, useBorrow, useBridge, useBridgeAllowance, useBridgeApprove, useCancelLimitOrder, useCancelSwap, useCancelUnstake, useClaim, useConvertedAssets, useCreateLimitOrder, useDeriveUserWalletAddress, useEstimateGas, useGetBridgeableAmount, useGetBridgeableTokens, useHubProvider, useInstantUnstake, useInstantUnstakeAllowance, useInstantUnstakeApprove, useInstantUnstakeRatio, useMMAllowance, useMMApprove, useMigrate, useMigrationAllowance, useMigrationApprove, useQuote, useRepay, useRequestTrustline, useReservesData, useReservesUsdFormat, useSodaxContext, useSpokeProvider, useStake, useStakeAllowance, useStakeApprove, useStakeRatio, useStakingConfig, useStakingInfo, useStatus, useStellarTrustlineCheck, useSupply, useSwap, useSwapAllowance, useSwapApprove, useUnstake, useUnstakeAllowance, useUnstakeApprove, useUnstakingInfo, useUnstakingInfoWithPenalty, useUserFormattedSummary, useUserReservesData, useWithdraw };
+export { type BackendPaginationParams, MIGRATION_MODE_BNUSD, MIGRATION_MODE_ICX_SODA, type MigrationIntentParams, type MigrationMode, SodaxProvider, type UseATokenParams, type UseATokensBalancesParams, type UseBorrowParams, type UseMMAllowanceParams, type UseMMApproveParams, type UseRepayParams, type UseReservesDataParams, type UseReservesUsdFormatParams, type UseSupplyParams, type UseUserFormattedSummaryParams, type UseUserReservesDataParams, type UseWithdrawParams, useAToken, useATokensBalances, useBackendAllMoneyMarketAssets, useBackendAllMoneyMarketBorrowers, useBackendIntentByHash, useBackendIntentByTxHash, useBackendMoneyMarketAsset, useBackendMoneyMarketAssetBorrowers, useBackendMoneyMarketAssetSuppliers, useBackendMoneyMarketPosition, useBackendOrderbook, useBackendUserIntents, useBorrow, useBridge, useBridgeAllowance, useBridgeApprove, useCancelLimitOrder, useCancelSwap, useCancelUnstake, useClaim, useConvertedAssets, useCreateLimitOrder, useDeriveUserWalletAddress, useEstimateGas, useGetBridgeableAmount, useGetBridgeableTokens, useHubProvider, useInstantUnstake, useInstantUnstakeAllowance, useInstantUnstakeApprove, useInstantUnstakeRatio, useMMAllowance, useMMApprove, useMigrate, useMigrationAllowance, useMigrationApprove, useQuote, useRepay, useRequestTrustline, useReservesData, useReservesUsdFormat, useSodaxContext, useSpokeProvider, useStake, useStakeAllowance, useStakeApprove, useStakeRatio, useStakingConfig, useStakingInfo, useStatus, useStellarTrustlineCheck, useSupply, useSwap, useSwapAllowance, useSwapApprove, useUnstake, useUnstakeAllowance, useUnstakeApprove, useUnstakingInfo, useUnstakingInfoWithPenalty, useUserFormattedSummary, useUserReservesData, useWithdraw };

package/dist/index.js

@@ -366,6 +366,45 @@ function useAToken({ aToken, queryOptions }) {
     }
   });
 }
+function useATokensBalances({
+  aTokens,
+  spokeProvider,
+  userAddress,
+  queryOptions
+}) {
+  const { sodax } = useSodaxContext();
+  const defaultQueryOptions = {
+    queryKey: ["mm", "aTokensBalances", aTokens, spokeProvider?.chainConfig.chain.id, userAddress],
+    enabled: aTokens.length > 0 && aTokens.every((token) => viem.isAddress(token)) && !!spokeProvider && !!userAddress
+  };
+  queryOptions = {
+    ...defaultQueryOptions,
+    ...queryOptions
+    // override default query options if provided
+  };
+  return reactQuery.useQuery({
+    ...queryOptions,
+    queryFn: async () => {
+      if (aTokens.length === 0) {
+        return /* @__PURE__ */ new Map();
+      }
+      if (!spokeProvider || !userAddress) {
+        throw new Error("Spoke provider and user address are required");
+      }
+      for (const aToken of aTokens) {
+        if (!viem.isAddress(aToken)) {
+          throw new Error(`Invalid aToken address: ${aToken}`);
+        }
+      }
+      const hubWalletAddress = await sdk.deriveUserWalletAddress(
+        sodax.hubProvider,
+        spokeProvider.chainConfig.chain.id,
+        userAddress
+      );
+      return await sodax.moneyMarket.data.getATokensBalances(aTokens, hubWalletAddress);
+    }
+  });
+}
 function useReservesUsdFormat(params) {
   const { sodax } = useSodaxContext();
   const defaultQueryOptions = { queryKey: ["mm", "reservesUsdFormat"] };
@@ -1426,6 +1465,7 @@ exports.MIGRATION_MODE_BNUSD = MIGRATION_MODE_BNUSD;
 exports.MIGRATION_MODE_ICX_SODA = MIGRATION_MODE_ICX_SODA;
 exports.SodaxProvider = SodaxProvider;
 exports.useAToken = useAToken;
+exports.useATokensBalances = useATokensBalances;
 exports.useBackendAllMoneyMarketAssets = useBackendAllMoneyMarketAssets;
 exports.useBackendAllMoneyMarketBorrowers = useBackendAllMoneyMarketBorrowers;
 exports.useBackendIntentByHash = useBackendIntentByHash;