@sodax/dapp-kit 1.0.0-rc.6 → 1.0.0-rc.8

package/dist/index.d.mts

@@ -1,6 +1,6 @@
 import * as _sodax_sdk 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 { Sodax, SpokeProvider, GetEstimateGasReturnType, TxReturnType, SpokeChainId, StellarSpokeProvider, EvmHubProvider, IWalletProvider, UserReserveData, MoneyMarketAction, Address as Address$1, XToken as XToken$1, ReserveData, FormatReserveUSDResponse, 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 } from '@sodax/types';
 import * as _tanstack_react_query from '@tanstack/react-query';
 import { UseMutationResult, UseQueryResult } from '@tanstack/react-query';
 import { Address } from 'viem';
@@ -374,6 +374,27 @@ declare function useMMApprove(token: XToken, spokeProvider: SpokeProvider | unde
  */
 declare function useAToken(aToken: Address$1 | undefined): UseQueryResult<XToken$1, Error>;
 
+/**
+ * Hook for fetching formatted summary of Sodax user portfolio (holdings, total liquidity,
+ *  collateral, borrows, liquidation threshold, health factor, available borrowing power, etc..).
+ *
+ * This hook provides access to the current state of user portfolio in the money market protocol.
+ * The data is automatically fetched and cached using React Query.
+ *
+ * @example
+ * ```typescript
+ * const { data: userFormattedSummary, isLoading, error } = useUserFormattedSummary();
+ * ```
+ *
+ * @returns A React Query result object containing:
+ *   - data: The formatted summary of Sodax user portfolio when available
+ *   - isLoading: Loading state indicator
+ *   - error: Any error that occurred during data fetching
+ */
+declare function useReservesUsdFormat(): UseQueryResult<(ReserveData & {
+    priceInMarketReferenceCurrency: string;
+} & FormatReserveUSDResponse)[], Error>;
+
 /**
  * Hook for fetching a quote for an intent-based swap.
  *
@@ -537,13 +558,13 @@ type CancelIntentResult = Result<TxReturnType<SpokeProvider, boolean>>;
 declare function useCancelSwap(spokeProvider: SpokeProvider | undefined): UseMutationResult<CancelIntentResult, Error, CancelIntentParams>;
 
 /**
- * Hook for fetching intent details by transaction hash from the backend API.
+ * Hook for fetching intent details by intent created transaction hash from the backend API.
  *
- * This hook provides access to intent data associated with a specific transaction hash,
- * including intent details, events, and transaction information. The data is automatically
- * fetched and cached using React Query.
+ * This hook provides access to intent data associated with the transaction hash from when
+ * the intent was created on the hub chain, including intent details, events, and transaction
+ * information. The data is automatically fetched and cached using React Query.
  *
- * @param {string | undefined} txHash - The transaction hash to fetch intent for. If undefined, the query will be disabled.
+ * @param {string | undefined} txHash - The intent created transaction hash from the hub chain to fetch intent for. If undefined, the query will be disabled.
  *
  * @returns {UseQueryResult<IntentResponse | undefined>} A query result object containing:
  *   - data: The intent response data when available
@@ -563,11 +584,12 @@ declare function useCancelSwap(spokeProvider: SpokeProvider | undefined): UseMut
  * ```
  *
  * @remarks
+ * - Intents are only created on the hub chain, so the transaction hash must be from the hub chain
  * - The query is disabled when txHash is undefined or empty
  * - Uses React Query for efficient caching and state management
  * - Automatically handles error states and loading indicators
  */
-declare const useBackendIntentByTxHash: (txHash: string | undefined) => UseQueryResult<IntentResponse | undefined>;
+declare const useBackendIntentByTxHash: (txHash: string | undefined, refetchInterval?: number) => UseQueryResult<IntentResponse | undefined>;
 
 /**
  * Hook for fetching intent details by intent hash from the backend API.
@@ -1533,6 +1555,4 @@ interface SodaxProviderProps {
 }
 declare const SodaxProvider: ({ children, testnet, config, rpcConfig }: SodaxProviderProps) => ReactElement;
 
-declare const getSpokeTokenAddressByVault: (spokeChainId: ChainId, vault: string) => string | undefined;
-
-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 };
+export { MIGRATION_MODE_BNUSD, MIGRATION_MODE_ICX_SODA, type MigrationIntentParams, type MigrationMode, SodaxProvider, 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, useReservesUsdFormat, 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,6 +1,6 @@
 import * as _sodax_sdk 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 { Sodax, SpokeProvider, GetEstimateGasReturnType, TxReturnType, SpokeChainId, StellarSpokeProvider, EvmHubProvider, IWalletProvider, UserReserveData, MoneyMarketAction, Address as Address$1, XToken as XToken$1, ReserveData, FormatReserveUSDResponse, 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 } from '@sodax/types';
 import * as _tanstack_react_query from '@tanstack/react-query';
 import { UseMutationResult, UseQueryResult } from '@tanstack/react-query';
 import { Address } from 'viem';
@@ -374,6 +374,27 @@ declare function useMMApprove(token: XToken, spokeProvider: SpokeProvider | unde
  */
 declare function useAToken(aToken: Address$1 | undefined): UseQueryResult<XToken$1, Error>;
 
+/**
+ * Hook for fetching formatted summary of Sodax user portfolio (holdings, total liquidity,
+ *  collateral, borrows, liquidation threshold, health factor, available borrowing power, etc..).
+ *
+ * This hook provides access to the current state of user portfolio in the money market protocol.
+ * The data is automatically fetched and cached using React Query.
+ *
+ * @example
+ * ```typescript
+ * const { data: userFormattedSummary, isLoading, error } = useUserFormattedSummary();
+ * ```
+ *
+ * @returns A React Query result object containing:
+ *   - data: The formatted summary of Sodax user portfolio when available
+ *   - isLoading: Loading state indicator
+ *   - error: Any error that occurred during data fetching
+ */
+declare function useReservesUsdFormat(): UseQueryResult<(ReserveData & {
+    priceInMarketReferenceCurrency: string;
+} & FormatReserveUSDResponse)[], Error>;
+
 /**
  * Hook for fetching a quote for an intent-based swap.
  *
@@ -537,13 +558,13 @@ type CancelIntentResult = Result<TxReturnType<SpokeProvider, boolean>>;
 declare function useCancelSwap(spokeProvider: SpokeProvider | undefined): UseMutationResult<CancelIntentResult, Error, CancelIntentParams>;
 
 /**
- * Hook for fetching intent details by transaction hash from the backend API.
+ * Hook for fetching intent details by intent created transaction hash from the backend API.
  *
- * This hook provides access to intent data associated with a specific transaction hash,
- * including intent details, events, and transaction information. The data is automatically
- * fetched and cached using React Query.
+ * This hook provides access to intent data associated with the transaction hash from when
+ * the intent was created on the hub chain, including intent details, events, and transaction
+ * information. The data is automatically fetched and cached using React Query.
  *
- * @param {string | undefined} txHash - The transaction hash to fetch intent for. If undefined, the query will be disabled.
+ * @param {string | undefined} txHash - The intent created transaction hash from the hub chain to fetch intent for. If undefined, the query will be disabled.
  *
  * @returns {UseQueryResult<IntentResponse | undefined>} A query result object containing:
  *   - data: The intent response data when available
@@ -563,11 +584,12 @@ declare function useCancelSwap(spokeProvider: SpokeProvider | undefined): UseMut
  * ```
  *
  * @remarks
+ * - Intents are only created on the hub chain, so the transaction hash must be from the hub chain
  * - The query is disabled when txHash is undefined or empty
  * - Uses React Query for efficient caching and state management
  * - Automatically handles error states and loading indicators
  */
-declare const useBackendIntentByTxHash: (txHash: string | undefined) => UseQueryResult<IntentResponse | undefined>;
+declare const useBackendIntentByTxHash: (txHash: string | undefined, refetchInterval?: number) => UseQueryResult<IntentResponse | undefined>;
 
 /**
  * Hook for fetching intent details by intent hash from the backend API.
@@ -1533,6 +1555,4 @@ interface SodaxProviderProps {
 }
 declare const SodaxProvider: ({ children, testnet, config, rpcConfig }: SodaxProviderProps) => ReactElement;
 
-declare const getSpokeTokenAddressByVault: (spokeChainId: ChainId, vault: string) => string | undefined;
-
-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 };
+export { MIGRATION_MODE_BNUSD, MIGRATION_MODE_ICX_SODA, type MigrationIntentParams, type MigrationMode, SodaxProvider, 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, useReservesUsdFormat, 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

@@ -374,6 +374,16 @@ function useAToken(aToken) {
     enabled: !!aToken
   });
 }
+function useReservesUsdFormat() {
+  const { sodax } = useSodaxContext();
+  return reactQuery.useQuery({
+    queryKey: ["reservesUsdFormat"],
+    queryFn: async () => {
+      const reserves = await sodax.moneyMarket.data.getReservesHumanized();
+      return sodax.moneyMarket.data.formatReservesUSD(sodax.moneyMarket.data.buildReserveDataWithPrice(reserves));
+    }
+  });
+}
 var useQuote = (payload) => {
   const { sodax } = useSodaxContext();
   const queryKey = React.useMemo(() => {
@@ -495,7 +505,7 @@ function useCancelSwap(spokeProvider) {
     }
   });
 }
-var useBackendIntentByTxHash = (txHash) => {
+var useBackendIntentByTxHash = (txHash, refetchInterval = 1e3) => {
   const { sodax } = useSodaxContext();
   return reactQuery.useQuery({
     queryKey: ["backend", "intent", "txHash", txHash],
@@ -505,6 +515,7 @@ var useBackendIntentByTxHash = (txHash) => {
       }
       return sodax.backendApi.getIntentByTxHash(txHash);
     },
+    refetchInterval,
     enabled: !!txHash && txHash.length > 0,
     retry: 3
   });
@@ -1264,18 +1275,10 @@ var SodaxProvider = ({ children, testnet = false, config, rpcConfig }) => {
   const sodax = new sdk.Sodax(config);
   return /* @__PURE__ */ React__default.default.createElement(SodaxContext.Provider, { value: { sodax, testnet, rpcConfig } }, children);
 };
-var getSpokeTokenAddressByVault = (spokeChainId, vault) => {
-  const tokens = sdk.hubAssets[spokeChainId];
-  const address = Object.keys(tokens).find(
-    (tokenAddress) => tokens[tokenAddress].vault.toLowerCase() === vault.toLowerCase()
-  );
-  return address;
-};
 
 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;
@@ -1312,6 +1315,7 @@ exports.useQuote = useQuote;
 exports.useRepay = useRepay;
 exports.useRequestTrustline = useRequestTrustline;
 exports.useReservesData = useReservesData;
+exports.useReservesUsdFormat = useReservesUsdFormat;
 exports.useSodaxContext = useSodaxContext;
 exports.useSpokeProvider = useSpokeProvider;
 exports.useStake = useStake;