@sodax/dapp-kit 1.0.0-rc.3 → 1.0.0-rc.5

package/README.md

@@ -302,6 +302,7 @@ function BridgeComponent() {
 - [`useReservesData()`](./src/hooks/mm/useReservesData.ts) - Get reserves data
 - [`useMMAllowance()`](./src/hooks/mm/useMMAllowance.ts) - Check token allowance for a specific amount
 - [`useMMApprove()`](./src/hooks/mm/useMMApprove.ts) - Approve token spending
+- [`useAToken()`](./src/hooks/mm/useAToken.ts) - Fetch aToken token data
 
 #### Swap Hooks
 - [`useQuote()`](./src/hooks/swap/useQuote.ts) - Get quote for an intent order

package/dist/index.d.mts

@@ -1,5 +1,5 @@
 import * as _sodax_sdk from '@sodax/sdk';
-import { Sodax, SpokeProvider, GetEstimateGasReturnType, TxReturnType, SpokeChainId, StellarSpokeProvider, EvmHubProvider, IWalletProvider, UserReserveData, MoneyMarketAction, SolverIntentQuoteRequest, Result, SolverIntentQuoteResponse, SolverErrorResponse, SolverExecutionResponse, Intent, IntentDeliveryInfo, IntentError, IntentErrorCode, CreateIntentParams, Hex, SolverIntentStatusResponse, IntentResponse, OrderbookResponse, MoneyMarketPosition, MoneyMarketAsset, MoneyMarketAssetBorrowers, MoneyMarketAssetSuppliers, MoneyMarketBorrowers, CreateBridgeIntentParams, SpokeTxHash, HubTxHash, BridgeError, BridgeErrorCode, XToken as XToken$1, StakeParams, UnstakeParams, ClaimParams, CancelUnstakeParams, StakingInfo, UnstakingInfo, UnstakeRequestWithPenalty, StakingConfig, InstantUnstakeParams, SodaxConfig } from '@sodax/sdk';
+import { Sodax, SpokeProvider, GetEstimateGasReturnType, TxReturnType, SpokeChainId, StellarSpokeProvider, EvmHubProvider, IWalletProvider, UserReserveData, MoneyMarketAction, Address as Address$1, XToken as XToken$1, SolverIntentQuoteRequest, Result, SolverIntentQuoteResponse, SolverErrorResponse, SolverExecutionResponse, Intent, IntentDeliveryInfo, IntentError, IntentErrorCode, CreateIntentParams, Hex, SolverIntentStatusResponse, IntentResponse, OrderbookResponse, MoneyMarketPosition, MoneyMarketAsset, MoneyMarketAssetBorrowers, MoneyMarketAssetSuppliers, MoneyMarketBorrowers, CreateBridgeIntentParams, SpokeTxHash, HubTxHash, BridgeError, BridgeErrorCode, StakeParams, UnstakeParams, ClaimParams, CancelUnstakeParams, StakingInfo, UnstakingInfo, UnstakeRequestWithPenalty, StakingConfig, InstantUnstakeParams, SodaxConfig } from '@sodax/sdk';
 import { RpcConfig, SpokeChainId as SpokeChainId$1, XToken, ChainId } from '@sodax/types';
 import * as _tanstack_react_query from '@tanstack/react-query';
 import { UseMutationResult, UseQueryResult } from '@tanstack/react-query';
@@ -350,6 +350,30 @@ interface UseApproveReturn$2 {
  */
 declare function useMMApprove(token: XToken, spokeProvider: SpokeProvider | undefined): UseApproveReturn$2;
 
+/**
+ * React hook for fetching an AToken's ERC20 metadata from the Sodax money market.
+ *
+ * Fetches and caches the metadata (name, symbol, decimals, address) for a given aToken address and chain using React Query.
+ * This metadata is typically required for rendering balances and labels in UI components.
+ *
+ * @param {Address | undefined} aToken - The aToken contract address to look up. Should be an EVM address.
+ * @param {ChainId | undefined} chainId - The EVM chain ID for the aToken.
+ *
+ * @example
+ * ```typescript
+ * const { data: aToken, isLoading, error } = useAToken(aTokenAddress, chainId);
+ * if (aToken) {
+ *   console.log(aToken.symbol); // 'aETH'
+ * }
+ * ```
+ *
+ * @returns {UseQueryResult<Erc20Token, Error>} A React Query result object containing:
+ *   - data: The aToken ERC20 metadata when available.
+ *   - isLoading: Loading state indicator.
+ *   - error: Any error that occurred during data fetching.
+ */
+declare function useAToken(aToken: Address$1 | undefined): UseQueryResult<XToken$1, Error>;
+
 /**
  * Hook for fetching a quote for an intent-based swap.
  *
@@ -1511,4 +1535,4 @@ declare const SodaxProvider: ({ children, testnet, config, rpcConfig }: SodaxPro
 
 declare const getSpokeTokenAddressByVault: (spokeChainId: ChainId, vault: string) => string | undefined;
 
-export { MIGRATION_MODE_BNUSD, MIGRATION_MODE_ICX_SODA, type MigrationIntentParams, type MigrationMode, SodaxProvider, getSpokeTokenAddressByVault, useBackendAllMoneyMarketAssets, useBackendAllMoneyMarketBorrowers, useBackendIntentByHash, useBackendIntentByTxHash, useBackendMoneyMarketAsset, useBackendMoneyMarketAssetBorrowers, useBackendMoneyMarketAssetSuppliers, useBackendMoneyMarketPosition, useBackendOrderbook, useBorrow, useBridge, useBridgeAllowance, useBridgeApprove, useCancelSwap, useCancelUnstake, useClaim, useConvertedAssets, useDeriveUserWalletAddress, useEstimateGas, useGetBridgeableAmount, useGetBridgeableTokens, useHubProvider, useInstantUnstake, useInstantUnstakeAllowance, useInstantUnstakeApprove, useInstantUnstakeRatio, useMMAllowance, useMMApprove, useMigrate, useMigrationAllowance, useMigrationApprove, useQuote, useRepay, useRequestTrustline, useReservesData, useSodaxContext, useSpokeProvider, useStake, useStakeAllowance, useStakeApprove, useStakeRatio, useStakingConfig, useStakingInfo, useStatus, useStellarTrustlineCheck, useSupply, useSwap, useSwapAllowance, useSwapApprove, useUnstake, useUnstakeAllowance, useUnstakeApprove, useUnstakingInfo, useUnstakingInfoWithPenalty, useUserReservesData, useWithdraw };
+export { MIGRATION_MODE_BNUSD, MIGRATION_MODE_ICX_SODA, type MigrationIntentParams, type MigrationMode, SodaxProvider, getSpokeTokenAddressByVault, useAToken, useBackendAllMoneyMarketAssets, useBackendAllMoneyMarketBorrowers, useBackendIntentByHash, useBackendIntentByTxHash, useBackendMoneyMarketAsset, useBackendMoneyMarketAssetBorrowers, useBackendMoneyMarketAssetSuppliers, useBackendMoneyMarketPosition, useBackendOrderbook, useBorrow, useBridge, useBridgeAllowance, useBridgeApprove, useCancelSwap, useCancelUnstake, useClaim, useConvertedAssets, useDeriveUserWalletAddress, useEstimateGas, useGetBridgeableAmount, useGetBridgeableTokens, useHubProvider, useInstantUnstake, useInstantUnstakeAllowance, useInstantUnstakeApprove, useInstantUnstakeRatio, useMMAllowance, useMMApprove, useMigrate, useMigrationAllowance, useMigrationApprove, useQuote, useRepay, useRequestTrustline, useReservesData, useSodaxContext, useSpokeProvider, useStake, useStakeAllowance, useStakeApprove, useStakeRatio, useStakingConfig, useStakingInfo, useStatus, useStellarTrustlineCheck, useSupply, useSwap, useSwapAllowance, useSwapApprove, useUnstake, useUnstakeAllowance, useUnstakeApprove, useUnstakingInfo, useUnstakingInfoWithPenalty, useUserReservesData, useWithdraw };

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as _sodax_sdk from '@sodax/sdk';
-import { Sodax, SpokeProvider, GetEstimateGasReturnType, TxReturnType, SpokeChainId, StellarSpokeProvider, EvmHubProvider, IWalletProvider, UserReserveData, MoneyMarketAction, SolverIntentQuoteRequest, Result, SolverIntentQuoteResponse, SolverErrorResponse, SolverExecutionResponse, Intent, IntentDeliveryInfo, IntentError, IntentErrorCode, CreateIntentParams, Hex, SolverIntentStatusResponse, IntentResponse, OrderbookResponse, MoneyMarketPosition, MoneyMarketAsset, MoneyMarketAssetBorrowers, MoneyMarketAssetSuppliers, MoneyMarketBorrowers, CreateBridgeIntentParams, SpokeTxHash, HubTxHash, BridgeError, BridgeErrorCode, XToken as XToken$1, StakeParams, UnstakeParams, ClaimParams, CancelUnstakeParams, StakingInfo, UnstakingInfo, UnstakeRequestWithPenalty, StakingConfig, InstantUnstakeParams, SodaxConfig } from '@sodax/sdk';
+import { Sodax, SpokeProvider, GetEstimateGasReturnType, TxReturnType, SpokeChainId, StellarSpokeProvider, EvmHubProvider, IWalletProvider, UserReserveData, MoneyMarketAction, Address as Address$1, XToken as XToken$1, SolverIntentQuoteRequest, Result, SolverIntentQuoteResponse, SolverErrorResponse, SolverExecutionResponse, Intent, IntentDeliveryInfo, IntentError, IntentErrorCode, CreateIntentParams, Hex, SolverIntentStatusResponse, IntentResponse, OrderbookResponse, MoneyMarketPosition, MoneyMarketAsset, MoneyMarketAssetBorrowers, MoneyMarketAssetSuppliers, MoneyMarketBorrowers, CreateBridgeIntentParams, SpokeTxHash, HubTxHash, BridgeError, BridgeErrorCode, StakeParams, UnstakeParams, ClaimParams, CancelUnstakeParams, StakingInfo, UnstakingInfo, UnstakeRequestWithPenalty, StakingConfig, InstantUnstakeParams, SodaxConfig } from '@sodax/sdk';
 import { RpcConfig, SpokeChainId as SpokeChainId$1, XToken, ChainId } from '@sodax/types';
 import * as _tanstack_react_query from '@tanstack/react-query';
 import { UseMutationResult, UseQueryResult } from '@tanstack/react-query';
@@ -350,6 +350,30 @@ interface UseApproveReturn$2 {
  */
 declare function useMMApprove(token: XToken, spokeProvider: SpokeProvider | undefined): UseApproveReturn$2;
 
+/**
+ * React hook for fetching an AToken's ERC20 metadata from the Sodax money market.
+ *
+ * Fetches and caches the metadata (name, symbol, decimals, address) for a given aToken address and chain using React Query.
+ * This metadata is typically required for rendering balances and labels in UI components.
+ *
+ * @param {Address | undefined} aToken - The aToken contract address to look up. Should be an EVM address.
+ * @param {ChainId | undefined} chainId - The EVM chain ID for the aToken.
+ *
+ * @example
+ * ```typescript
+ * const { data: aToken, isLoading, error } = useAToken(aTokenAddress, chainId);
+ * if (aToken) {
+ *   console.log(aToken.symbol); // 'aETH'
+ * }
+ * ```
+ *
+ * @returns {UseQueryResult<Erc20Token, Error>} A React Query result object containing:
+ *   - data: The aToken ERC20 metadata when available.
+ *   - isLoading: Loading state indicator.
+ *   - error: Any error that occurred during data fetching.
+ */
+declare function useAToken(aToken: Address$1 | undefined): UseQueryResult<XToken$1, Error>;
+
 /**
  * Hook for fetching a quote for an intent-based swap.
  *
@@ -1511,4 +1535,4 @@ declare const SodaxProvider: ({ children, testnet, config, rpcConfig }: SodaxPro
 
 declare const getSpokeTokenAddressByVault: (spokeChainId: ChainId, vault: string) => string | undefined;
 
-export { MIGRATION_MODE_BNUSD, MIGRATION_MODE_ICX_SODA, type MigrationIntentParams, type MigrationMode, SodaxProvider, getSpokeTokenAddressByVault, useBackendAllMoneyMarketAssets, useBackendAllMoneyMarketBorrowers, useBackendIntentByHash, useBackendIntentByTxHash, useBackendMoneyMarketAsset, useBackendMoneyMarketAssetBorrowers, useBackendMoneyMarketAssetSuppliers, useBackendMoneyMarketPosition, useBackendOrderbook, useBorrow, useBridge, useBridgeAllowance, useBridgeApprove, useCancelSwap, useCancelUnstake, useClaim, useConvertedAssets, useDeriveUserWalletAddress, useEstimateGas, useGetBridgeableAmount, useGetBridgeableTokens, useHubProvider, useInstantUnstake, useInstantUnstakeAllowance, useInstantUnstakeApprove, useInstantUnstakeRatio, useMMAllowance, useMMApprove, useMigrate, useMigrationAllowance, useMigrationApprove, useQuote, useRepay, useRequestTrustline, useReservesData, useSodaxContext, useSpokeProvider, useStake, useStakeAllowance, useStakeApprove, useStakeRatio, useStakingConfig, useStakingInfo, useStatus, useStellarTrustlineCheck, useSupply, useSwap, useSwapAllowance, useSwapApprove, useUnstake, useUnstakeAllowance, useUnstakeApprove, useUnstakingInfo, useUnstakingInfoWithPenalty, useUserReservesData, useWithdraw };
+export { MIGRATION_MODE_BNUSD, MIGRATION_MODE_ICX_SODA, type MigrationIntentParams, type MigrationMode, SodaxProvider, getSpokeTokenAddressByVault, useAToken, useBackendAllMoneyMarketAssets, useBackendAllMoneyMarketBorrowers, useBackendIntentByHash, useBackendIntentByTxHash, useBackendMoneyMarketAsset, useBackendMoneyMarketAssetBorrowers, useBackendMoneyMarketAssetSuppliers, useBackendMoneyMarketPosition, useBackendOrderbook, useBorrow, useBridge, useBridgeAllowance, useBridgeApprove, useCancelSwap, useCancelUnstake, useClaim, useConvertedAssets, useDeriveUserWalletAddress, useEstimateGas, useGetBridgeableAmount, useGetBridgeableTokens, useHubProvider, useInstantUnstake, useInstantUnstakeAllowance, useInstantUnstakeApprove, useInstantUnstakeRatio, useMMAllowance, useMMApprove, useMigrate, useMigrationAllowance, useMigrationApprove, useQuote, useRepay, useRequestTrustline, useReservesData, useSodaxContext, useSpokeProvider, useStake, useStakeAllowance, useStakeApprove, useStakeRatio, useStakingConfig, useStakingInfo, useStatus, useStellarTrustlineCheck, useSupply, useSwap, useSwapAllowance, useSwapApprove, useUnstake, useUnstakeAllowance, useUnstakeApprove, useUnstakingInfo, useUnstakingInfoWithPenalty, useUserReservesData, useWithdraw };

package/dist/index.js

@@ -357,6 +357,23 @@ function useMMApprove(token, spokeProvider) {
     resetError
   };
 }
+function useAToken(aToken) {
+  const { sodax } = useSodaxContext();
+  return reactQuery.useQuery({
+    queryKey: ["aToken", sodax.hubProvider.chainConfig.chain.id, aToken],
+    queryFn: async () => {
+      if (!aToken) {
+        throw new Error("aToken address or hub provider is not defined");
+      }
+      const aTokenData = await sodax.moneyMarket.data.getATokenData(aToken);
+      return {
+        ...aTokenData,
+        xChainId: sodax.hubProvider.chainConfig.chain.id
+      };
+    },
+    enabled: !!aToken
+  });
+}
 var useQuote = (payload) => {
   const { sodax } = useSodaxContext();
   const queryKey = React.useMemo(() => {
@@ -1259,6 +1276,7 @@ exports.MIGRATION_MODE_BNUSD = MIGRATION_MODE_BNUSD;
 exports.MIGRATION_MODE_ICX_SODA = MIGRATION_MODE_ICX_SODA;
 exports.SodaxProvider = SodaxProvider;
 exports.getSpokeTokenAddressByVault = getSpokeTokenAddressByVault;
+exports.useAToken = useAToken;
 exports.useBackendAllMoneyMarketAssets = useBackendAllMoneyMarketAssets;
 exports.useBackendAllMoneyMarketBorrowers = useBackendAllMoneyMarketBorrowers;
 exports.useBackendIntentByHash = useBackendIntentByHash;