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

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { Sodax, SpokeProvider, GetEstimateGasReturnType, TxReturnType, SpokeChainId, StellarSpokeProvider, EvmHubProvider, IWalletProvider, MoneyMarketBorrowParams, MoneyMarketError, RelayErrorCode, MoneyMarketRepayParams, MoneyMarketSupplyParams, MoneyMarketWithdrawParams, UserReserveData, AggregatedReserveData, BaseCurrencyInfo, MoneyMarketParams, XToken, ReserveData, FormatReserveUSDResponse, FormatUserSummaryResponse, SolverIntentQuoteRequest, Result, SolverIntentQuoteResponse, SolverErrorResponse, SolverExecutionResponse, Intent, IntentDeliveryInfo, IntentError, IntentErrorCode, CreateIntentParams, Hex, SolverIntentStatusResponse, CreateLimitOrderParams, IntentResponse, Address as Address$1, UserIntentsResponse, 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 { Sodax, SpokeProvider, GetEstimateGasReturnType, TxReturnType, SpokeChainId, StellarSpokeProvider, EvmHubProvider, IWalletProvider, MoneyMarketBorrowParams, MoneyMarketError, RelayErrorCode, MoneyMarketRepayParams, MoneyMarketSupplyParams, MoneyMarketWithdrawParams, UserReserveData, AggregatedReserveData, BaseCurrencyInfo, MoneyMarketParams, XToken, ReserveData, FormatReserveUSDResponse, FormatUserSummaryResponse, SolverIntentQuoteRequest, Result, SolverIntentQuoteResponse, SolverErrorResponse, SolverExecutionResponse, Intent, IntentDeliveryInfo, IntentError, IntentErrorCode, CreateIntentParams, Hex, SolverIntentStatusResponse, CreateLimitOrderParams, IntentResponse, Address as Address$1, UserIntentsResponse, OrderbookResponse, MoneyMarketPosition, MoneyMarketAsset, MoneyMarketAssetBorrowers, MoneyMarketAssetSuppliers, MoneyMarketBorrowers, CreateBridgeIntentParams, SpokeTxHash, HubTxHash, BridgeError, BridgeErrorCode, BridgeLimit, StakeParams, UnstakeParams, ClaimParams, CancelUnstakeParams, StakingInfo, UnstakingInfo, UnstakeRequestWithPenalty, StakingConfig, InstantUnstakeParams, SodaxConfig } from '@sodax/sdk';
 import { RpcConfig, SpokeChainId as SpokeChainId$1, XToken as XToken$1 } from '@sodax/types';
 import { UseMutationResult, UseQueryResult, UseQueryOptions } from '@tanstack/react-query';
 import { Address } from 'viem';
@@ -132,6 +132,35 @@ declare function useRequestTrustline<T extends SpokeProvider = SpokeProvider>(to
     data: TxReturnType<StellarSpokeProvider, false> | null;
 };
 
+/**
+ * Hook for deriving user wallet address for hub abstraction.
+ *
+ * This hook derives the user's abstracted wallet address for the hub chain based on the spoke chain ID and address.
+ * If the spoke chain is the same as the hub chain, it returns the encoded spoke address.
+ * Otherwise, it derives and returns the abstracted wallet address for cross-chain operations.
+ * NOTE: This hook is different from useDeriveUserWalletAddress because it uses wallet router address instead of CREATE3 address for Sonic (hub).
+ *
+ * The query is automatically enabled when both `spokeChainId` and `spokeAddress` are provided.
+ * This is a deterministic operation, so the result is cached and not refetched automatically.
+ *
+ * @param spokeChainId - Optional spoke chain ID. If not provided, the query will be disabled.
+ * @param spokeAddress - Optional user wallet address on the spoke chain. If not provided, the query will be disabled.
+ * @returns A React Query result object containing:
+ *   - data: The derived user wallet address (Address) when available
+ *   - isLoading: Loading state indicator
+ *   - error: Any error that occurred during derivation (Error)
+ *
+ * @example
+ * ```typescript
+ * const { data: derivedAddress, isLoading, error } = useDeriveUserWalletAddress(spokeChainId, userAddress);
+ *
+ * if (isLoading) return <div>Deriving address...</div>;
+ * if (error) return <div>Error: {error.message}</div>;
+ * if (derivedAddress) return <div>Derived Address: {derivedAddress}</div>;
+ * ```
+ */
+declare function useGetUserHubWalletAddress(spokeChainId?: SpokeChainId | SpokeProvider | undefined, spokeAddress?: string | undefined): UseQueryResult<Address, Error>;
+
 declare function useHubProvider(): EvmHubProvider;
 
 /**
@@ -1232,8 +1261,8 @@ declare function useBridge(spokeProvider: SpokeProvider | undefined): UseMutatio
  * @param {SpokeChainId | undefined} chainId - The chain ID to get the balance for
  * @param {string | undefined} token - The token address to get the balance for
  *
- * @returns {UseQueryResult<bigint, Error>} A React Query result containing:
- *   - data: The available amount to be bridged (bigint)
+ * @returns {UseQueryResult<BridgeLimit, Error>} A React Query result containing:
+ *   - data: Data about available amount to be bridged
  *   - error: Any error that occurred during the check
  *
  * @example
@@ -1245,7 +1274,7 @@ declare function useBridge(spokeProvider: SpokeProvider | undefined): UseMutatio
  * }
  * ```
  */
-declare function useGetBridgeableAmount(from: XToken | undefined, to: XToken | undefined): UseQueryResult<bigint, Error>;
+declare function useGetBridgeableAmount(from: XToken | undefined, to: XToken | undefined): UseQueryResult<BridgeLimit, Error>;
 
 /**
 /**
@@ -1792,4 +1821,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 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 };
+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, useGetUserHubWalletAddress, 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

@@ -1,4 +1,4 @@
-import { Sodax, SpokeProvider, GetEstimateGasReturnType, TxReturnType, SpokeChainId, StellarSpokeProvider, EvmHubProvider, IWalletProvider, MoneyMarketBorrowParams, MoneyMarketError, RelayErrorCode, MoneyMarketRepayParams, MoneyMarketSupplyParams, MoneyMarketWithdrawParams, UserReserveData, AggregatedReserveData, BaseCurrencyInfo, MoneyMarketParams, XToken, ReserveData, FormatReserveUSDResponse, FormatUserSummaryResponse, SolverIntentQuoteRequest, Result, SolverIntentQuoteResponse, SolverErrorResponse, SolverExecutionResponse, Intent, IntentDeliveryInfo, IntentError, IntentErrorCode, CreateIntentParams, Hex, SolverIntentStatusResponse, CreateLimitOrderParams, IntentResponse, Address as Address$1, UserIntentsResponse, 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 { Sodax, SpokeProvider, GetEstimateGasReturnType, TxReturnType, SpokeChainId, StellarSpokeProvider, EvmHubProvider, IWalletProvider, MoneyMarketBorrowParams, MoneyMarketError, RelayErrorCode, MoneyMarketRepayParams, MoneyMarketSupplyParams, MoneyMarketWithdrawParams, UserReserveData, AggregatedReserveData, BaseCurrencyInfo, MoneyMarketParams, XToken, ReserveData, FormatReserveUSDResponse, FormatUserSummaryResponse, SolverIntentQuoteRequest, Result, SolverIntentQuoteResponse, SolverErrorResponse, SolverExecutionResponse, Intent, IntentDeliveryInfo, IntentError, IntentErrorCode, CreateIntentParams, Hex, SolverIntentStatusResponse, CreateLimitOrderParams, IntentResponse, Address as Address$1, UserIntentsResponse, OrderbookResponse, MoneyMarketPosition, MoneyMarketAsset, MoneyMarketAssetBorrowers, MoneyMarketAssetSuppliers, MoneyMarketBorrowers, CreateBridgeIntentParams, SpokeTxHash, HubTxHash, BridgeError, BridgeErrorCode, BridgeLimit, StakeParams, UnstakeParams, ClaimParams, CancelUnstakeParams, StakingInfo, UnstakingInfo, UnstakeRequestWithPenalty, StakingConfig, InstantUnstakeParams, SodaxConfig } from '@sodax/sdk';
 import { RpcConfig, SpokeChainId as SpokeChainId$1, XToken as XToken$1 } from '@sodax/types';
 import { UseMutationResult, UseQueryResult, UseQueryOptions } from '@tanstack/react-query';
 import { Address } from 'viem';
@@ -132,6 +132,35 @@ declare function useRequestTrustline<T extends SpokeProvider = SpokeProvider>(to
     data: TxReturnType<StellarSpokeProvider, false> | null;
 };
 
+/**
+ * Hook for deriving user wallet address for hub abstraction.
+ *
+ * This hook derives the user's abstracted wallet address for the hub chain based on the spoke chain ID and address.
+ * If the spoke chain is the same as the hub chain, it returns the encoded spoke address.
+ * Otherwise, it derives and returns the abstracted wallet address for cross-chain operations.
+ * NOTE: This hook is different from useDeriveUserWalletAddress because it uses wallet router address instead of CREATE3 address for Sonic (hub).
+ *
+ * The query is automatically enabled when both `spokeChainId` and `spokeAddress` are provided.
+ * This is a deterministic operation, so the result is cached and not refetched automatically.
+ *
+ * @param spokeChainId - Optional spoke chain ID. If not provided, the query will be disabled.
+ * @param spokeAddress - Optional user wallet address on the spoke chain. If not provided, the query will be disabled.
+ * @returns A React Query result object containing:
+ *   - data: The derived user wallet address (Address) when available
+ *   - isLoading: Loading state indicator
+ *   - error: Any error that occurred during derivation (Error)
+ *
+ * @example
+ * ```typescript
+ * const { data: derivedAddress, isLoading, error } = useDeriveUserWalletAddress(spokeChainId, userAddress);
+ *
+ * if (isLoading) return <div>Deriving address...</div>;
+ * if (error) return <div>Error: {error.message}</div>;
+ * if (derivedAddress) return <div>Derived Address: {derivedAddress}</div>;
+ * ```
+ */
+declare function useGetUserHubWalletAddress(spokeChainId?: SpokeChainId | SpokeProvider | undefined, spokeAddress?: string | undefined): UseQueryResult<Address, Error>;
+
 declare function useHubProvider(): EvmHubProvider;
 
 /**
@@ -1232,8 +1261,8 @@ declare function useBridge(spokeProvider: SpokeProvider | undefined): UseMutatio
  * @param {SpokeChainId | undefined} chainId - The chain ID to get the balance for
  * @param {string | undefined} token - The token address to get the balance for
  *
- * @returns {UseQueryResult<bigint, Error>} A React Query result containing:
- *   - data: The available amount to be bridged (bigint)
+ * @returns {UseQueryResult<BridgeLimit, Error>} A React Query result containing:
+ *   - data: Data about available amount to be bridged
  *   - error: Any error that occurred during the check
  *
  * @example
@@ -1245,7 +1274,7 @@ declare function useBridge(spokeProvider: SpokeProvider | undefined): UseMutatio
  * }
  * ```
  */
-declare function useGetBridgeableAmount(from: XToken | undefined, to: XToken | undefined): UseQueryResult<bigint, Error>;
+declare function useGetBridgeableAmount(from: XToken | undefined, to: XToken | undefined): UseQueryResult<BridgeLimit, Error>;
 
 /**
 /**
@@ -1792,4 +1821,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 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 };
+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, useGetUserHubWalletAddress, 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

@@ -113,6 +113,22 @@ function useRequestTrustline(token) {
     data
   };
 }
+function useGetUserHubWalletAddress(spokeChainId, spokeAddress) {
+  const { sodax } = useSodaxContext();
+  return reactQuery.useQuery({
+    queryKey: ["getUserHubWalletAddress", spokeChainId, spokeAddress],
+    queryFn: async () => {
+      if (!spokeChainId || !spokeAddress) {
+        throw new Error("Spoke chain id and address are required");
+      }
+      spokeChainId = typeof spokeChainId === "object" ? spokeChainId.chainConfig.chain.id : spokeChainId;
+      return await sdk.HubService.getUserHubWalletAddress(spokeAddress, spokeChainId, sodax.hubProvider);
+    },
+    enabled: !!spokeChainId && !!spokeAddress,
+    refetchInterval: false
+    // This is a deterministic operation, no need to refetch
+  });
+}
 
 // src/hooks/provider/useHubProvider.ts
 function useHubProvider() {
@@ -396,11 +412,7 @@ function useATokensBalances({
           throw new Error(`Invalid aToken address: ${aToken}`);
         }
       }
-      const hubWalletAddress = await sdk.deriveUserWalletAddress(
-        sodax.hubProvider,
-        spokeProvider.chainConfig.chain.id,
-        userAddress
-      );
+      const hubWalletAddress = await sdk.HubService.getUserHubWalletAddress(userAddress, spokeProvider.chainConfig.chain.id, sodax.hubProvider);
       return await sodax.moneyMarket.data.getATokensBalances(aTokens, hubWalletAddress);
     }
   });
@@ -898,14 +910,14 @@ function useGetBridgeableAmount(from, to) {
     queryKey: ["spoke-asset-manager-token-balance", from, to],
     queryFn: async () => {
       if (!from || !to) {
-        return 0n;
+        return { amount: 0n, decimals: 0, type: "DEPOSIT_LIMIT" };
       }
       const result = await sodax.bridge.getBridgeableAmount(from, to);
       if (result.ok) {
         return result.value;
       }
       console.error("Error getting bridgeable amount:", result.error);
-      return 0n;
+      return { amount: 0n, decimals: 0, type: "DEPOSIT_LIMIT" };
     },
     enabled: !!from && !!to
   });
@@ -1490,6 +1502,7 @@ exports.useDeriveUserWalletAddress = useDeriveUserWalletAddress;
 exports.useEstimateGas = useEstimateGas;
 exports.useGetBridgeableAmount = useGetBridgeableAmount;
 exports.useGetBridgeableTokens = useGetBridgeableTokens;
+exports.useGetUserHubWalletAddress = useGetUserHubWalletAddress;
 exports.useHubProvider = useHubProvider;
 exports.useInstantUnstake = useInstantUnstake;
 exports.useInstantUnstakeAllowance = useInstantUnstakeAllowance;