@sodax/dapp-kit 0.0.1-rc.30 → 0.0.1-rc.32

package/dist/index.d.mts

@@ -83,29 +83,28 @@ declare function useStellarTrustlineCheck<T extends SpokeProvider = SpokeProvide
 /**
  * React hook to request a Stellar trustline for a given token and amount.
  *
- * This hook provides a mutation for requesting a trustline on the Stellar network
+ * This hook provides a callback function for requesting a trustline on the Stellar network
  * using the provided SpokeProvider. It is intended for use with StellarSpokeProvider
  * and will throw if used with a non-Stellar provider. Upon success, it invalidates
  * the trustline check query to ensure UI reflects the updated trustline state.
  *
  * @template T - The type of SpokeProvider, defaults to SpokeProvider.
  * @param {string | undefined} token - The Stellar asset code or token address for which to request a trustline.
- * @returns {UseMutationResult<TxReturnType<StellarSpokeProvider, false>, Error, { token: string; amount: bigint; spokeProvider: T }>}
- *   A React Query mutation result object containing:
- *   - `mutate`/`mutateAsync`: Function to trigger the trustline request.
- *   - `data`: The transaction result if successful.
+ * @returns {Object} An object containing:
+ *   - `requestTrustline`: Function to trigger the trustline request.
+ *   - `isLoading`: Whether the request is in progress.
+ *   - `isRequested`: Whether a trustline has been successfully requested.
  *   - `error`: Any error encountered during the request.
- *   - `isLoading`: Whether the mutation is in progress.
- *   - Other React Query mutation state.
+ *   - `data`: The transaction result if successful.
  *
  * @example
  * ```tsx
  * import { useRequestTrustline } from '@sodax/dapp-kit';
  *
- * const { mutate: requestTrustline, isLoading, error, data } = useRequestTrustline('USDC-G...TOKEN');
+ * const { requestTrustline, isLoading, isRequested, error, data } = useRequestTrustline('USDC-G...TOKEN');
  *
  * // To request a trustline:
- * requestTrustline({
+ * await requestTrustline({
  *   token: 'USDC-G...TOKEN',
  *   amount: 10000000n,
  *   spokeProvider: stellarProvider,
@@ -113,14 +112,20 @@ declare function useStellarTrustlineCheck<T extends SpokeProvider = SpokeProvide
  *
  * if (isLoading) return <span>Requesting trustline...</span>;
  * if (error) return <span>Error: {error.message}</span>;
- * if (data) return <span>Trustline requested! Tx: {data.txHash}</span>;
+ * if (isRequested) return <span>Trustline requested! Tx: {data?.txHash}</span>;
  * ```
  */
-declare function useRequestTrustline<T extends SpokeProvider = SpokeProvider>(token: string | undefined): UseMutationResult<TxReturnType<StellarSpokeProvider, false>, Error, {
-    token: string;
-    amount: bigint;
-    spokeProvider: T;
-}>;
+declare function useRequestTrustline<T extends SpokeProvider = SpokeProvider>(token: string | undefined): {
+    requestTrustline: (params: {
+        token: string;
+        amount: bigint;
+        spokeProvider: T;
+    }) => Promise<TxReturnType<StellarSpokeProvider, false>>;
+    isLoading: boolean;
+    isRequested: boolean;
+    error: Error | null;
+    data: TxReturnType<StellarSpokeProvider, false> | null;
+};
 
 declare function useHubProvider(): EvmHubProvider;
 
@@ -321,7 +326,7 @@ declare function useReservesData(): _tanstack_react_query.UseQueryResult<readonl
  */
 declare function useMMAllowance(token: XToken, amount: string, action: MoneyMarketAction, spokeProvider: SpokeProvider | undefined): UseQueryResult<boolean, Error>;
 
-interface UseApproveReturn$1 {
+interface UseApproveReturn$2 {
     approve: ({ amount, action }: {
         amount: string;
         action: MoneyMarketAction;
@@ -343,7 +348,7 @@ interface UseApproveReturn$1 {
  * await approve({ amount: "100", action: "supply" });
  * ```
  */
-declare function useMMApprove(token: XToken, spokeProvider: SpokeProvider | undefined): UseApproveReturn$1;
+declare function useMMApprove(token: XToken, spokeProvider: SpokeProvider | undefined): UseApproveReturn$2;
 
 /**
  * Hook for fetching a quote for an intent-based swap.
@@ -458,7 +463,7 @@ declare const useStatus: (intent_tx_hash: Hex) => UseQueryResult<Result<SolverIn
  */
 declare function useSwapAllowance(params: CreateIntentParams | undefined, spokeProvider: SpokeProvider | undefined): UseQueryResult<boolean, Error>;
 
-interface UseApproveReturn {
+interface UseApproveReturn$1 {
     approve: ({ params }: {
         params: CreateIntentParams;
     }) => Promise<boolean>;
@@ -479,7 +484,7 @@ interface UseApproveReturn {
  * await approve({ amount: "100", action: "supply" });
  * ```
  */
-declare function useSwapApprove(params: CreateIntentParams | undefined, spokeProvider: SpokeProvider | undefined): UseApproveReturn;
+declare function useSwapApprove(params: CreateIntentParams | undefined, spokeProvider: SpokeProvider | undefined): UseApproveReturn$1;
 
 type CancelIntentParams = {
     intent: Intent;
@@ -1412,6 +1417,90 @@ declare function useInstantUnstakeApprove(spokeProvider: SpokeProvider | undefin
  */
 declare function useInstantUnstakeAllowance(params: Omit<InstantUnstakeParams, 'action'> | undefined, spokeProvider: SpokeProvider | undefined): UseQueryResult<boolean, Error>;
 
+declare const MIGRATION_MODE_ICX_SODA = "icxsoda";
+declare const MIGRATION_MODE_BNUSD = "bnusd";
+type MigrationMode = typeof MIGRATION_MODE_ICX_SODA | typeof MIGRATION_MODE_BNUSD;
+interface MigrationIntentParams {
+    token: XToken | undefined;
+    amount: string | undefined;
+    sourceAddress: string | undefined;
+    migrationMode?: MigrationMode;
+    toToken?: XToken;
+    destinationAddress?: string;
+}
+
+/**
+ * Hook for executing migration operations between chains.
+ *
+ * This hook handles ICX/SODA and bnUSD migrations by accepting a spoke provider
+ * and returning a mutation function that accepts migration parameters.
+ *
+ * @param {SpokeProvider} spokeProvider - The spoke provider to use for the migration
+ * @returns {UseMutationResult} Mutation result object containing migration function and state
+ *
+ * @example
+ * ```typescript
+ * const { mutateAsync: migrate, isPending } = useMigrate(spokeProvider);
+ *
+ * const result = await migrate({
+ *   token: { address: "0x...", decimals: 18 },
+ *   amount: "100",
+ *   migrationMode: MIGRATION_MODE_ICX_SODA,
+ *   toToken: { address: "0x...", decimals: 18 },
+ *   destinationAddress: "0x..."
+ * });
+ * ```
+ */
+declare function useMigrate(spokeProvider: SpokeProvider | undefined): UseMutationResult<{
+    spokeTxHash: string;
+    hubTxHash: `0x${string}`;
+}, Error, MigrationIntentParams>;
+
+/**
+ * Hook for checking token allowance for migration operations.
+ *
+ * This hook verifies if the user has approved enough tokens for migration operations.
+ * It handles both ICX/SODA and bnUSD migration allowance checks.
+ *
+ * @param {MigrationIntentParams} params - The parameters for the migration allowance check
+ * @param {SpokeProvider} spokeProvider - The spoke provider to use for allowance checks
+ *
+ * @returns {UseQueryResult<boolean, Error>} A React Query result containing:
+ *   - data: Boolean indicating if allowance is sufficient
+ *   - isLoading: Loading state indicator
+ *   - error: Any error that occurred during the check
+ *
+ * @example
+ * ```typescript
+ * const { data: hasAllowed, isLoading } = useMigrationAllowance(params, spokeProvider);
+ * ```
+ */
+declare function useMigrationAllowance(params: MigrationIntentParams | undefined, spokeProvider: SpokeProvider | undefined): UseQueryResult<boolean, Error>;
+
+interface UseApproveReturn {
+    approve: ({ params }: {
+        params: MigrationIntentParams;
+    }) => Promise<boolean>;
+    isLoading: boolean;
+    error: Error | null;
+    resetError: () => void;
+    isApproved: boolean;
+}
+/**
+ * Hook for approving token spending for migration actions
+ * @param params The parameters for the migration approval
+ * @param spokeProvider The spoke provider instance for the chain
+ * @returns Object containing approve function, loading state, error state and reset function
+ * @example
+ * ```tsx
+ * const { approve, isLoading, error } = useMigrationApprove(params, spokeProvider);
+ *
+ * // Approve tokens for migration
+ * await approve({ params });
+ * ```
+ */
+declare function useMigrationApprove(params: MigrationIntentParams | undefined, spokeProvider: SpokeProvider | undefined): UseApproveReturn;
+
 interface SodaxProviderProps {
     children: ReactNode;
     testnet?: boolean;
@@ -1422,4 +1511,4 @@ declare const SodaxProvider: ({ children, testnet, config, rpcConfig }: SodaxPro
 
 declare const getSpokeTokenAddressByVault: (spokeChainId: ChainId, vault: string) => string | undefined;
 
-export { 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, 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, 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

@@ -83,29 +83,28 @@ declare function useStellarTrustlineCheck<T extends SpokeProvider = SpokeProvide
 /**
  * React hook to request a Stellar trustline for a given token and amount.
  *
- * This hook provides a mutation for requesting a trustline on the Stellar network
+ * This hook provides a callback function for requesting a trustline on the Stellar network
  * using the provided SpokeProvider. It is intended for use with StellarSpokeProvider
  * and will throw if used with a non-Stellar provider. Upon success, it invalidates
  * the trustline check query to ensure UI reflects the updated trustline state.
  *
  * @template T - The type of SpokeProvider, defaults to SpokeProvider.
  * @param {string | undefined} token - The Stellar asset code or token address for which to request a trustline.
- * @returns {UseMutationResult<TxReturnType<StellarSpokeProvider, false>, Error, { token: string; amount: bigint; spokeProvider: T }>}
- *   A React Query mutation result object containing:
- *   - `mutate`/`mutateAsync`: Function to trigger the trustline request.
- *   - `data`: The transaction result if successful.
+ * @returns {Object} An object containing:
+ *   - `requestTrustline`: Function to trigger the trustline request.
+ *   - `isLoading`: Whether the request is in progress.
+ *   - `isRequested`: Whether a trustline has been successfully requested.
  *   - `error`: Any error encountered during the request.
- *   - `isLoading`: Whether the mutation is in progress.
- *   - Other React Query mutation state.
+ *   - `data`: The transaction result if successful.
  *
  * @example
  * ```tsx
  * import { useRequestTrustline } from '@sodax/dapp-kit';
  *
- * const { mutate: requestTrustline, isLoading, error, data } = useRequestTrustline('USDC-G...TOKEN');
+ * const { requestTrustline, isLoading, isRequested, error, data } = useRequestTrustline('USDC-G...TOKEN');
  *
  * // To request a trustline:
- * requestTrustline({
+ * await requestTrustline({
  *   token: 'USDC-G...TOKEN',
  *   amount: 10000000n,
  *   spokeProvider: stellarProvider,
@@ -113,14 +112,20 @@ declare function useStellarTrustlineCheck<T extends SpokeProvider = SpokeProvide
  *
  * if (isLoading) return <span>Requesting trustline...</span>;
  * if (error) return <span>Error: {error.message}</span>;
- * if (data) return <span>Trustline requested! Tx: {data.txHash}</span>;
+ * if (isRequested) return <span>Trustline requested! Tx: {data?.txHash}</span>;
  * ```
  */
-declare function useRequestTrustline<T extends SpokeProvider = SpokeProvider>(token: string | undefined): UseMutationResult<TxReturnType<StellarSpokeProvider, false>, Error, {
-    token: string;
-    amount: bigint;
-    spokeProvider: T;
-}>;
+declare function useRequestTrustline<T extends SpokeProvider = SpokeProvider>(token: string | undefined): {
+    requestTrustline: (params: {
+        token: string;
+        amount: bigint;
+        spokeProvider: T;
+    }) => Promise<TxReturnType<StellarSpokeProvider, false>>;
+    isLoading: boolean;
+    isRequested: boolean;
+    error: Error | null;
+    data: TxReturnType<StellarSpokeProvider, false> | null;
+};
 
 declare function useHubProvider(): EvmHubProvider;
 
@@ -321,7 +326,7 @@ declare function useReservesData(): _tanstack_react_query.UseQueryResult<readonl
  */
 declare function useMMAllowance(token: XToken, amount: string, action: MoneyMarketAction, spokeProvider: SpokeProvider | undefined): UseQueryResult<boolean, Error>;
 
-interface UseApproveReturn$1 {
+interface UseApproveReturn$2 {
     approve: ({ amount, action }: {
         amount: string;
         action: MoneyMarketAction;
@@ -343,7 +348,7 @@ interface UseApproveReturn$1 {
  * await approve({ amount: "100", action: "supply" });
  * ```
  */
-declare function useMMApprove(token: XToken, spokeProvider: SpokeProvider | undefined): UseApproveReturn$1;
+declare function useMMApprove(token: XToken, spokeProvider: SpokeProvider | undefined): UseApproveReturn$2;
 
 /**
  * Hook for fetching a quote for an intent-based swap.
@@ -458,7 +463,7 @@ declare const useStatus: (intent_tx_hash: Hex) => UseQueryResult<Result<SolverIn
  */
 declare function useSwapAllowance(params: CreateIntentParams | undefined, spokeProvider: SpokeProvider | undefined): UseQueryResult<boolean, Error>;
 
-interface UseApproveReturn {
+interface UseApproveReturn$1 {
     approve: ({ params }: {
         params: CreateIntentParams;
     }) => Promise<boolean>;
@@ -479,7 +484,7 @@ interface UseApproveReturn {
  * await approve({ amount: "100", action: "supply" });
  * ```
  */
-declare function useSwapApprove(params: CreateIntentParams | undefined, spokeProvider: SpokeProvider | undefined): UseApproveReturn;
+declare function useSwapApprove(params: CreateIntentParams | undefined, spokeProvider: SpokeProvider | undefined): UseApproveReturn$1;
 
 type CancelIntentParams = {
     intent: Intent;
@@ -1412,6 +1417,90 @@ declare function useInstantUnstakeApprove(spokeProvider: SpokeProvider | undefin
  */
 declare function useInstantUnstakeAllowance(params: Omit<InstantUnstakeParams, 'action'> | undefined, spokeProvider: SpokeProvider | undefined): UseQueryResult<boolean, Error>;
 
+declare const MIGRATION_MODE_ICX_SODA = "icxsoda";
+declare const MIGRATION_MODE_BNUSD = "bnusd";
+type MigrationMode = typeof MIGRATION_MODE_ICX_SODA | typeof MIGRATION_MODE_BNUSD;
+interface MigrationIntentParams {
+    token: XToken | undefined;
+    amount: string | undefined;
+    sourceAddress: string | undefined;
+    migrationMode?: MigrationMode;
+    toToken?: XToken;
+    destinationAddress?: string;
+}
+
+/**
+ * Hook for executing migration operations between chains.
+ *
+ * This hook handles ICX/SODA and bnUSD migrations by accepting a spoke provider
+ * and returning a mutation function that accepts migration parameters.
+ *
+ * @param {SpokeProvider} spokeProvider - The spoke provider to use for the migration
+ * @returns {UseMutationResult} Mutation result object containing migration function and state
+ *
+ * @example
+ * ```typescript
+ * const { mutateAsync: migrate, isPending } = useMigrate(spokeProvider);
+ *
+ * const result = await migrate({
+ *   token: { address: "0x...", decimals: 18 },
+ *   amount: "100",
+ *   migrationMode: MIGRATION_MODE_ICX_SODA,
+ *   toToken: { address: "0x...", decimals: 18 },
+ *   destinationAddress: "0x..."
+ * });
+ * ```
+ */
+declare function useMigrate(spokeProvider: SpokeProvider | undefined): UseMutationResult<{
+    spokeTxHash: string;
+    hubTxHash: `0x${string}`;
+}, Error, MigrationIntentParams>;
+
+/**
+ * Hook for checking token allowance for migration operations.
+ *
+ * This hook verifies if the user has approved enough tokens for migration operations.
+ * It handles both ICX/SODA and bnUSD migration allowance checks.
+ *
+ * @param {MigrationIntentParams} params - The parameters for the migration allowance check
+ * @param {SpokeProvider} spokeProvider - The spoke provider to use for allowance checks
+ *
+ * @returns {UseQueryResult<boolean, Error>} A React Query result containing:
+ *   - data: Boolean indicating if allowance is sufficient
+ *   - isLoading: Loading state indicator
+ *   - error: Any error that occurred during the check
+ *
+ * @example
+ * ```typescript
+ * const { data: hasAllowed, isLoading } = useMigrationAllowance(params, spokeProvider);
+ * ```
+ */
+declare function useMigrationAllowance(params: MigrationIntentParams | undefined, spokeProvider: SpokeProvider | undefined): UseQueryResult<boolean, Error>;
+
+interface UseApproveReturn {
+    approve: ({ params }: {
+        params: MigrationIntentParams;
+    }) => Promise<boolean>;
+    isLoading: boolean;
+    error: Error | null;
+    resetError: () => void;
+    isApproved: boolean;
+}
+/**
+ * Hook for approving token spending for migration actions
+ * @param params The parameters for the migration approval
+ * @param spokeProvider The spoke provider instance for the chain
+ * @returns Object containing approve function, loading state, error state and reset function
+ * @example
+ * ```tsx
+ * const { approve, isLoading, error } = useMigrationApprove(params, spokeProvider);
+ *
+ * // Approve tokens for migration
+ * await approve({ params });
+ * ```
+ */
+declare function useMigrationApprove(params: MigrationIntentParams | undefined, spokeProvider: SpokeProvider | undefined): UseApproveReturn;
+
 interface SodaxProviderProps {
     children: ReactNode;
     testnet?: boolean;
@@ -1422,4 +1511,4 @@ declare const SodaxProvider: ({ children, testnet, config, rpcConfig }: SodaxPro
 
 declare const getSpokeTokenAddressByVault: (spokeChainId: ChainId, vault: string) => string | undefined;
 
-export { 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, 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, 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 };