@sodax/dapp-kit 1.5.7-beta → 2.0.0-rc.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +300 -422
- package/ai-exported/AGENTS.md +134 -0
- package/ai-exported/integration/README.md +49 -0
- package/ai-exported/integration/ai-rules.md +79 -0
- package/ai-exported/integration/architecture.md +274 -0
- package/ai-exported/integration/features/README.md +29 -0
- package/ai-exported/integration/features/auxiliary-services.md +169 -0
- package/ai-exported/integration/features/bitcoin.md +87 -0
- package/ai-exported/integration/features/bridge.md +91 -0
- package/ai-exported/integration/features/dex.md +152 -0
- package/ai-exported/integration/features/migration.md +118 -0
- package/ai-exported/integration/features/money-market.md +116 -0
- package/ai-exported/integration/features/staking.md +123 -0
- package/ai-exported/integration/features/swap.md +101 -0
- package/ai-exported/integration/quickstart.md +187 -0
- package/ai-exported/integration/recipes/README.md +136 -0
- package/ai-exported/integration/recipes/backend-queries.md +157 -0
- package/ai-exported/integration/recipes/bitcoin.md +193 -0
- package/ai-exported/integration/recipes/bridge.md +174 -0
- package/ai-exported/integration/recipes/dex.md +204 -0
- package/ai-exported/integration/recipes/invalidations.md +115 -0
- package/ai-exported/integration/recipes/migration.md +212 -0
- package/ai-exported/integration/recipes/money-market.md +206 -0
- package/ai-exported/integration/recipes/mutation-error-handling.md +118 -0
- package/ai-exported/integration/recipes/observability.md +93 -0
- package/ai-exported/integration/recipes/setup.md +144 -0
- package/ai-exported/integration/recipes/staking.md +202 -0
- package/ai-exported/integration/recipes/swap.md +272 -0
- package/ai-exported/integration/recipes/wallet-connectivity.md +101 -0
- package/ai-exported/integration/reference/README.md +12 -0
- package/ai-exported/integration/reference/glossary.md +188 -0
- package/ai-exported/integration/reference/hooks-index.md +190 -0
- package/ai-exported/integration/reference/public-api.md +110 -0
- package/ai-exported/integration/reference/querykey-conventions.md +179 -0
- package/ai-exported/migration/README.md +60 -0
- package/ai-exported/migration/ai-rules.md +81 -0
- package/ai-exported/migration/breaking-changes/hook-signatures.md +233 -0
- package/ai-exported/migration/breaking-changes/querykey-conventions.md +108 -0
- package/ai-exported/migration/breaking-changes/result-handling.md +211 -0
- package/ai-exported/migration/breaking-changes/sdk-leakage.md +165 -0
- package/ai-exported/migration/checklist.md +89 -0
- package/ai-exported/migration/features/README.md +34 -0
- package/ai-exported/migration/features/auxiliary-services.md +114 -0
- package/ai-exported/migration/features/bitcoin.md +88 -0
- package/ai-exported/migration/features/bridge.md +123 -0
- package/ai-exported/migration/features/dex.md +101 -0
- package/ai-exported/migration/features/migration.md +120 -0
- package/ai-exported/migration/features/money-market.md +97 -0
- package/ai-exported/migration/features/staking.md +109 -0
- package/ai-exported/migration/features/swap.md +118 -0
- package/ai-exported/migration/recipes.md +188 -0
- package/ai-exported/migration/reference/README.md +15 -0
- package/ai-exported/migration/reference/deleted-hooks.md +110 -0
- package/ai-exported/migration/reference/error-shape-crosswalk.md +144 -0
- package/ai-exported/migration/reference/renamed-hooks.md +66 -0
- package/dist/index.cjs +2642 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.cts +1550 -0
- package/dist/index.d.ts +1020 -2051
- package/dist/index.mjs +1581 -1531
- package/dist/index.mjs.map +1 -1
- package/package.json +21 -11
- package/src/contexts/index.ts +0 -3
- package/src/hooks/_mutationContract.test.ts +99 -0
- package/src/hooks/backend/README.md +2 -2
- package/src/hooks/backend/index.ts +13 -13
- package/src/hooks/backend/unwrapResult.ts +1 -0
- package/src/hooks/backend/useBackendAllMoneyMarketAssets.ts +13 -45
- package/src/hooks/backend/useBackendAllMoneyMarketBorrowers.ts +29 -59
- package/src/hooks/backend/useBackendIntentByHash.ts +21 -47
- package/src/hooks/backend/useBackendIntentByTxHash.ts +23 -50
- package/src/hooks/backend/useBackendMoneyMarketAsset.ts +21 -54
- package/src/hooks/backend/useBackendMoneyMarketAssetBorrowers.ts +30 -57
- package/src/hooks/backend/useBackendMoneyMarketAssetSuppliers.ts +31 -58
- package/src/hooks/backend/useBackendMoneyMarketPosition.ts +22 -38
- package/src/hooks/backend/useBackendOrderbook.ts +27 -49
- package/src/hooks/backend/useBackendSubmitSwapTx.ts +30 -36
- package/src/hooks/backend/useBackendSubmitSwapTxStatus.ts +38 -58
- package/src/hooks/backend/useBackendUserIntents.ts +25 -63
- package/src/hooks/bitcoin/index.ts +9 -8
- package/src/hooks/bitcoin/useBitcoinBalance.ts +20 -5
- package/src/hooks/bitcoin/useExpiredUtxos.ts +26 -16
- package/src/hooks/bitcoin/useFundTradingWallet.ts +33 -30
- package/src/hooks/bitcoin/useRadfiAuth.ts +43 -40
- package/src/hooks/bitcoin/useRadfiSession.ts +53 -59
- package/src/hooks/bitcoin/useRadfiWithdraw.ts +35 -53
- package/src/hooks/bitcoin/useRenewUtxos.ts +30 -50
- package/src/hooks/bitcoin/useTradingWallet.ts +1 -1
- package/src/hooks/bitcoin/useTradingWalletBalance.ts +25 -14
- package/src/hooks/bridge/index.ts +5 -5
- package/src/hooks/bridge/useBridge.ts +29 -55
- package/src/hooks/bridge/useBridgeAllowance.ts +38 -38
- package/src/hooks/bridge/useBridgeApprove.ts +32 -57
- package/src/hooks/bridge/useGetBridgeableAmount.ts +23 -37
- package/src/hooks/bridge/useGetBridgeableTokens.ts +27 -50
- package/src/hooks/dex/index.ts +16 -16
- package/src/hooks/dex/useClaimRewards.ts +35 -54
- package/src/hooks/dex/useCreateDecreaseLiquidityParams.ts +7 -20
- package/src/hooks/dex/useCreateDepositParams.ts +7 -21
- package/src/hooks/dex/useCreateSupplyLiquidityParams.ts +13 -28
- package/src/hooks/dex/useCreateWithdrawParams.ts +7 -20
- package/src/hooks/dex/useDecreaseLiquidity.ts +40 -66
- package/src/hooks/dex/useDexAllowance.ts +29 -75
- package/src/hooks/dex/useDexApprove.ts +32 -43
- package/src/hooks/dex/useDexDeposit.ts +42 -49
- package/src/hooks/dex/useDexWithdraw.ts +32 -43
- package/src/hooks/dex/useLiquidityAmounts.ts +13 -82
- package/src/hooks/dex/usePoolBalances.ts +50 -72
- package/src/hooks/dex/usePoolData.ts +17 -43
- package/src/hooks/dex/usePools.ts +11 -38
- package/src/hooks/dex/usePositionInfo.ts +27 -62
- package/src/hooks/dex/useSupplyLiquidity.ts +80 -75
- package/src/hooks/index.ts +12 -10
- package/src/hooks/migrate/index.ts +13 -4
- package/src/hooks/migrate/useMigrateBaln.ts +42 -0
- package/src/hooks/migrate/useMigrateIcxToSoda.ts +44 -0
- package/src/hooks/migrate/useMigratebnUSD.ts +47 -0
- package/src/hooks/migrate/useMigrationAllowance.ts +76 -0
- package/src/hooks/migrate/useMigrationApprove.ts +66 -0
- package/src/hooks/migrate/useRevertMigrateSodaToIcx.ts +39 -0
- package/src/hooks/mm/index.ts +14 -12
- package/src/hooks/mm/useAToken.ts +25 -41
- package/src/hooks/mm/useATokensBalances.ts +29 -60
- package/src/hooks/mm/useBorrow.ts +38 -56
- package/src/hooks/mm/useMMAllowance.ts +37 -73
- package/src/hooks/mm/useMMApprove.ts +36 -43
- package/src/hooks/mm/useRepay.ts +33 -53
- package/src/hooks/mm/useReservesData.ts +12 -38
- package/src/hooks/mm/useReservesHumanized.ts +12 -31
- package/src/hooks/mm/useReservesList.ts +11 -31
- package/src/hooks/mm/useReservesUsdFormat.ts +15 -35
- package/src/hooks/mm/useSupply.ts +45 -51
- package/src/hooks/mm/useUserFormattedSummary.ts +32 -84
- package/src/hooks/mm/useUserReservesData.ts +27 -77
- package/src/hooks/mm/useWithdraw.ts +38 -54
- package/src/hooks/partner/index.ts +6 -0
- package/src/hooks/partner/useApproveToken.ts +42 -0
- package/src/hooks/partner/useFeeClaimSwap.ts +38 -0
- package/src/hooks/partner/useFetchAssetsBalances.ts +37 -0
- package/src/hooks/partner/useGetAutoSwapPreferences.ts +37 -0
- package/src/hooks/partner/useIsTokenApproved.ts +39 -0
- package/src/hooks/partner/useSetSwapPreference.ts +50 -0
- package/src/hooks/provider/index.ts +1 -2
- package/src/hooks/provider/useHubProvider.ts +1 -1
- package/src/hooks/recovery/index.ts +2 -0
- package/src/hooks/recovery/useHubAssetBalances.ts +43 -0
- package/src/hooks/recovery/useWithdrawHubAsset.ts +48 -0
- package/src/hooks/shared/index.ts +10 -6
- package/src/hooks/shared/types.ts +77 -0
- package/src/hooks/shared/unwrapResult.ts +19 -0
- package/src/hooks/shared/useDeriveUserWalletAddress.ts +22 -40
- package/src/hooks/shared/useEstimateGas.ts +18 -15
- package/src/hooks/shared/useGetUserHubWalletAddress.ts +25 -26
- package/src/hooks/shared/useRequestTrustline.ts +28 -61
- package/src/hooks/shared/useSafeMutation.test.ts +43 -0
- package/src/hooks/shared/useSafeMutation.ts +68 -0
- package/src/hooks/shared/useSodaxContext.ts +1 -1
- package/src/hooks/shared/useStellarTrustlineCheck.ts +30 -64
- package/src/hooks/shared/useXBalances.test.ts +113 -0
- package/src/hooks/shared/useXBalances.ts +61 -0
- package/src/hooks/staking/index.ts +18 -18
- package/src/hooks/staking/useCancelUnstake.ts +30 -41
- package/src/hooks/staking/useClaim.ts +27 -36
- package/src/hooks/staking/useConvertedAssets.ts +24 -34
- package/src/hooks/staking/useInstantUnstake.ts +33 -40
- package/src/hooks/staking/useInstantUnstakeAllowance.ts +37 -45
- package/src/hooks/staking/useInstantUnstakeApprove.ts +42 -42
- package/src/hooks/staking/useInstantUnstakeRatio.ts +24 -41
- package/src/hooks/staking/useStake.ts +32 -37
- package/src/hooks/staking/useStakeAllowance.ts +30 -43
- package/src/hooks/staking/useStakeApprove.ts +40 -40
- package/src/hooks/staking/useStakeRatio.ts +24 -40
- package/src/hooks/staking/useStakingConfig.ts +14 -27
- package/src/hooks/staking/useStakingInfo.ts +30 -38
- package/src/hooks/staking/useUnstake.ts +29 -43
- package/src/hooks/staking/useUnstakeAllowance.ts +37 -44
- package/src/hooks/staking/useUnstakeApprove.ts +40 -43
- package/src/hooks/staking/useUnstakingInfo.ts +29 -41
- package/src/hooks/staking/useUnstakingInfoWithPenalty.ts +31 -47
- package/src/hooks/swap/index.ts +8 -8
- package/src/hooks/swap/useCancelLimitOrder.ts +24 -41
- package/src/hooks/swap/useCancelSwap.ts +24 -33
- package/src/hooks/swap/useCreateLimitOrder.ts +29 -62
- package/src/hooks/swap/useQuote.ts +17 -43
- package/src/hooks/swap/useStatus.ts +22 -29
- package/src/hooks/swap/useSwap.ts +31 -49
- package/src/hooks/swap/useSwapAllowance.ts +38 -35
- package/src/hooks/swap/useSwapApprove.ts +48 -57
- package/src/index.ts +5 -3
- package/src/providers/SodaxProvider.tsx +17 -11
- package/src/providers/createSodaxQueryClient.ts +96 -0
- package/src/providers/index.ts +2 -1
- package/src/utils/dex-utils.ts +27 -5
- package/src/utils/index.ts +1 -1
- package/dist/index.d.mts +0 -2581
- package/dist/index.js +0 -2574
- package/dist/index.js.map +0 -1
- package/src/hooks/migrate/types.ts +0 -15
- package/src/hooks/migrate/useMigrate.tsx +0 -110
- package/src/hooks/migrate/useMigrationAllowance.tsx +0 -79
- package/src/hooks/migrate/useMigrationApprove.tsx +0 -129
- package/src/hooks/provider/useSpokeProvider.ts +0 -172
package/dist/index.d.mts
DELETED
|
@@ -1,2581 +0,0 @@
|
|
|
1
|
-
import { Sodax, SpokeProvider, GetEstimateGasReturnType, TxReturnType, SpokeChainId, StellarSpokeProvider, EvmHubProvider, IWalletProvider, BitcoinSpokeProvider, RadfiWalletBalance, RadfiUtxo, 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, RequestOverrideConfig, OrderbookResponse, MoneyMarketPosition, MoneyMarketAsset, MoneyMarketAssetBorrowers, MoneyMarketAssetSuppliers, MoneyMarketBorrowers, CreateBridgeIntentParams, SpokeTxHash, HubTxHash, BridgeError, BridgeErrorCode, BridgeLimit, StakeParams, UnstakeParams, ClaimParams, CancelUnstakeParams, StakingInfo, UnstakingInfo, UnstakeRequestWithPenalty, StakingConfig, InstantUnstakeParams, PoolKey, PoolData, ClPositionInfo, CreateAssetDepositParams, CreateAssetWithdrawParams, ConcentratedLiquiditySupplyParams, ConcentratedLiquidityIncreaseLiquidityParams, ConcentratedLiquidityDecreaseLiquidityParams, PoolSpokeAssets, DestinationParamsType, ConcentratedLiquidityClaimRewardsParams, ConcentratedLiquidityError, ConcentratedLiquidityErrorCode, SodaxConfig } from '@sodax/sdk';
|
|
2
|
-
import { RpcConfig, SpokeChainId as SpokeChainId$1, SubmitSwapTxResponse, SubmitSwapTxRequest, SubmitSwapTxStatusResponse, XToken as XToken$1 } from '@sodax/types';
|
|
3
|
-
import { UseMutationResult, UseQueryResult, UseQueryOptions, UseMutationOptions, QueryObserverOptions } from '@tanstack/react-query';
|
|
4
|
-
import { Address } from 'viem';
|
|
5
|
-
import { ReactNode, ReactElement } from 'react';
|
|
6
|
-
|
|
7
|
-
interface SodaxContextType {
|
|
8
|
-
sodax: Sodax;
|
|
9
|
-
testnet: boolean;
|
|
10
|
-
rpcConfig: RpcConfig;
|
|
11
|
-
}
|
|
12
|
-
|
|
13
|
-
/**
|
|
14
|
-
* Hook to access the Sodax context which provides access to the Sodax SDK instance and chain configuration
|
|
15
|
-
* @throws {Error} If used outside of a SodaxProvider
|
|
16
|
-
* @returns {SodaxContextType} The Sodax context containing SDK instance and configuration
|
|
17
|
-
*/
|
|
18
|
-
declare const useSodaxContext: () => SodaxContextType;
|
|
19
|
-
|
|
20
|
-
declare function useEstimateGas<T extends SpokeProvider = SpokeProvider>(spokeProvider: T | undefined): UseMutationResult<GetEstimateGasReturnType<T>, Error, TxReturnType<T, true>>;
|
|
21
|
-
|
|
22
|
-
/**
|
|
23
|
-
* Hook for deriving user wallet address for hub abstraction.
|
|
24
|
-
*
|
|
25
|
-
* This hook derives the user's abstracted wallet address for the hub chain based on the spoke chain ID and address.
|
|
26
|
-
* If the spoke chain is the same as the hub chain, it returns the encoded spoke address.
|
|
27
|
-
* Otherwise, it derives and returns the abstracted wallet address for cross-chain operations.
|
|
28
|
-
*
|
|
29
|
-
* The query is automatically enabled when both `spokeChainId` and `spokeAddress` are provided.
|
|
30
|
-
* This is a deterministic operation, so the result is cached and not refetched automatically.
|
|
31
|
-
*
|
|
32
|
-
* @param spokeChainId - Optional spoke chain ID. If not provided, the query will be disabled.
|
|
33
|
-
* @param spokeAddress - Optional user wallet address on the spoke chain. If not provided, the query will be disabled.
|
|
34
|
-
* @returns A React Query result object containing:
|
|
35
|
-
* - data: The derived user wallet address (Address) when available
|
|
36
|
-
* - isLoading: Loading state indicator
|
|
37
|
-
* - error: Any error that occurred during derivation (Error)
|
|
38
|
-
*
|
|
39
|
-
* @example
|
|
40
|
-
* ```typescript
|
|
41
|
-
* const { data: derivedAddress, isLoading, error } = useDeriveUserWalletAddress(spokeChainId, userAddress);
|
|
42
|
-
*
|
|
43
|
-
* if (isLoading) return <div>Deriving address...</div>;
|
|
44
|
-
* if (error) return <div>Error: {error.message}</div>;
|
|
45
|
-
* if (derivedAddress) return <div>Derived Address: {derivedAddress}</div>;
|
|
46
|
-
* ```
|
|
47
|
-
*/
|
|
48
|
-
declare function useDeriveUserWalletAddress(spokeChainId?: SpokeChainId | SpokeProvider | undefined, spokeAddress?: string | undefined): UseQueryResult<Address, Error>;
|
|
49
|
-
|
|
50
|
-
/**
|
|
51
|
-
* React hook to check if a Stellar account has a sufficient trustline for a given token and amount.
|
|
52
|
-
*
|
|
53
|
-
* This hook queries the Stellar network (via the provided SpokeProvider) to determine
|
|
54
|
-
* whether the account has established a trustline for the specified token and if the trustline
|
|
55
|
-
* is sufficient for the intended amount. It is useful for gating UI actions that require
|
|
56
|
-
* a trustline to be present and funded.
|
|
57
|
-
*
|
|
58
|
-
* @template T - The type of SpokeProvider, defaults to SpokeProvider.
|
|
59
|
-
* @param {string | undefined} token - The Stellar asset code or token address to check the trustline for.
|
|
60
|
-
* @param {bigint | undefined} amount - The minimum amount required for the trustline.
|
|
61
|
-
* @param {T | undefined} spokeProvider - The provider instance for interacting with the Stellar network.
|
|
62
|
-
* @param {SpokeChainId | undefined} chainId - The chain ID to determine if the check should be performed (only on Stellar mainnet).
|
|
63
|
-
* @returns {UseQueryResult<boolean, Error>} A React Query result object containing:
|
|
64
|
-
* - `data`: `true` if the trustline exists and is sufficient, `false` otherwise.
|
|
65
|
-
* - `error`: Any error encountered during the check.
|
|
66
|
-
* - `isLoading`: Whether the query is in progress.
|
|
67
|
-
* - Other React Query state.
|
|
68
|
-
*
|
|
69
|
-
* @example
|
|
70
|
-
* ```tsx
|
|
71
|
-
* import { useStellarTrustlineCheck } from '@sodax/dapp-kit';
|
|
72
|
-
*
|
|
73
|
-
* const { data: hasTrustline, isLoading, error } = useStellarTrustlineCheck(
|
|
74
|
-
* 'USDC-G...TOKEN',
|
|
75
|
-
* 10000000n,
|
|
76
|
-
* stellarProvider,
|
|
77
|
-
* 'stellar'
|
|
78
|
-
* );
|
|
79
|
-
*
|
|
80
|
-
* if (isLoading) return <span>Checking trustline...</span>;
|
|
81
|
-
* if (error) return <span>Error: {error.message}</span>;
|
|
82
|
-
* if (!hasTrustline) return <span>Trustline not established or insufficient.</span>;
|
|
83
|
-
* return <span>Trustline is sufficient!</span>;
|
|
84
|
-
* ```
|
|
85
|
-
*/
|
|
86
|
-
declare function useStellarTrustlineCheck<T extends SpokeProvider = SpokeProvider>(token: string | undefined, amount: bigint | undefined, spokeProvider: T | undefined, chainId: SpokeChainId | undefined): UseQueryResult<boolean, Error>;
|
|
87
|
-
|
|
88
|
-
/**
|
|
89
|
-
* React hook to request a Stellar trustline for a given token and amount.
|
|
90
|
-
*
|
|
91
|
-
* This hook provides a callback function for requesting a trustline on the Stellar network
|
|
92
|
-
* using the provided SpokeProvider. It is intended for use with StellarSpokeProvider
|
|
93
|
-
* and will throw if used with a non-Stellar provider. Upon success, it invalidates
|
|
94
|
-
* the trustline check query to ensure UI reflects the updated trustline state.
|
|
95
|
-
*
|
|
96
|
-
* @template T - The type of SpokeProvider, defaults to SpokeProvider.
|
|
97
|
-
* @param {string | undefined} token - The Stellar asset code or token address for which to request a trustline.
|
|
98
|
-
* @returns {Object} An object containing:
|
|
99
|
-
* - `requestTrustline`: Function to trigger the trustline request.
|
|
100
|
-
* - `isLoading`: Whether the request is in progress.
|
|
101
|
-
* - `isRequested`: Whether a trustline has been successfully requested.
|
|
102
|
-
* - `error`: Any error encountered during the request.
|
|
103
|
-
* - `data`: The transaction result if successful.
|
|
104
|
-
*
|
|
105
|
-
* @example
|
|
106
|
-
* ```tsx
|
|
107
|
-
* import { useRequestTrustline } from '@sodax/dapp-kit';
|
|
108
|
-
*
|
|
109
|
-
* const { requestTrustline, isLoading, isRequested, error, data } = useRequestTrustline('USDC-G...TOKEN');
|
|
110
|
-
*
|
|
111
|
-
* // To request a trustline:
|
|
112
|
-
* await requestTrustline({
|
|
113
|
-
* token: 'USDC-G...TOKEN',
|
|
114
|
-
* amount: 10000000n,
|
|
115
|
-
* spokeProvider: stellarProvider,
|
|
116
|
-
* });
|
|
117
|
-
*
|
|
118
|
-
* if (isLoading) return <span>Requesting trustline...</span>;
|
|
119
|
-
* if (error) return <span>Error: {error.message}</span>;
|
|
120
|
-
* if (isRequested) return <span>Trustline requested! Tx: {data?.txHash}</span>;
|
|
121
|
-
* ```
|
|
122
|
-
*/
|
|
123
|
-
declare function useRequestTrustline<T extends SpokeProvider = SpokeProvider>(token: string | undefined): {
|
|
124
|
-
requestTrustline: (params: {
|
|
125
|
-
token: string;
|
|
126
|
-
amount: bigint;
|
|
127
|
-
spokeProvider: T;
|
|
128
|
-
}) => Promise<TxReturnType<StellarSpokeProvider, false>>;
|
|
129
|
-
isLoading: boolean;
|
|
130
|
-
isRequested: boolean;
|
|
131
|
-
error: Error | null;
|
|
132
|
-
data: TxReturnType<StellarSpokeProvider, false> | null;
|
|
133
|
-
};
|
|
134
|
-
|
|
135
|
-
/**
|
|
136
|
-
* Hook for deriving user wallet address for hub abstraction.
|
|
137
|
-
*
|
|
138
|
-
* This hook derives the user's abstracted wallet address for the hub chain based on the spoke chain ID and address.
|
|
139
|
-
* If the spoke chain is the same as the hub chain, it returns the encoded spoke address.
|
|
140
|
-
* Otherwise, it derives and returns the abstracted wallet address for cross-chain operations.
|
|
141
|
-
* NOTE: This hook is different from useDeriveUserWalletAddress because it uses wallet router address instead of CREATE3 address for Sonic (hub).
|
|
142
|
-
*
|
|
143
|
-
* The query is automatically enabled when both `spokeChainId` and `spokeAddress` are provided.
|
|
144
|
-
* This is a deterministic operation, so the result is cached and not refetched automatically.
|
|
145
|
-
*
|
|
146
|
-
* @param spokeChainId - Optional spoke chain ID. If not provided, the query will be disabled.
|
|
147
|
-
* @param spokeAddress - Optional user wallet address on the spoke chain. If not provided, the query will be disabled.
|
|
148
|
-
* @returns A React Query result object containing:
|
|
149
|
-
* - data: The derived user wallet address (Address) when available
|
|
150
|
-
* - isLoading: Loading state indicator
|
|
151
|
-
* - error: Any error that occurred during derivation (Error)
|
|
152
|
-
*
|
|
153
|
-
* @example
|
|
154
|
-
* ```typescript
|
|
155
|
-
* const { data: derivedAddress, isLoading, error } = useDeriveUserWalletAddress(spokeChainId, userAddress);
|
|
156
|
-
*
|
|
157
|
-
* if (isLoading) return <div>Deriving address...</div>;
|
|
158
|
-
* if (error) return <div>Error: {error.message}</div>;
|
|
159
|
-
* if (derivedAddress) return <div>Derived Address: {derivedAddress}</div>;
|
|
160
|
-
* ```
|
|
161
|
-
*/
|
|
162
|
-
declare function useGetUserHubWalletAddress(spokeChainId?: SpokeChainId | SpokeProvider | undefined, spokeAddress?: string | undefined): UseQueryResult<Address, Error>;
|
|
163
|
-
|
|
164
|
-
declare function useHubProvider(): EvmHubProvider;
|
|
165
|
-
|
|
166
|
-
/**
|
|
167
|
-
* Hook to get the appropriate spoke provider based on the chain type.
|
|
168
|
-
* Supports EVM, SUI, ICON and INJECTIVE chains.
|
|
169
|
-
*
|
|
170
|
-
* @param {SpokeChainId | undefined} spokeChainId - The spoke chain ID to get the provider for
|
|
171
|
-
* @param {IWalletProvider | undefined} walletProvider - The wallet provider to use
|
|
172
|
-
* @returns {SpokeProvider | undefined} The appropriate spoke provider instance for the given chain ID, or undefined if invalid/unsupported
|
|
173
|
-
*
|
|
174
|
-
* @example
|
|
175
|
-
* ```tsx
|
|
176
|
-
* // Using a specific SpokeChainId and wallet provider
|
|
177
|
-
* const spokeProvider = useSpokeProvider(spokeChainId, walletProvider);
|
|
178
|
-
* ```
|
|
179
|
-
*/
|
|
180
|
-
declare function useSpokeProvider(spokeChainId: SpokeChainId$1 | undefined, walletProvider?: IWalletProvider | undefined): SpokeProvider | undefined;
|
|
181
|
-
|
|
182
|
-
type RadfiSession = {
|
|
183
|
-
accessToken: string;
|
|
184
|
-
refreshToken: string;
|
|
185
|
-
tradingAddress: string;
|
|
186
|
-
publicKey: string;
|
|
187
|
-
};
|
|
188
|
-
type RadfiAuthResult = {
|
|
189
|
-
accessToken: string;
|
|
190
|
-
refreshToken: string;
|
|
191
|
-
tradingAddress: string;
|
|
192
|
-
};
|
|
193
|
-
declare function saveRadfiSession(address: string, session: RadfiSession): void;
|
|
194
|
-
declare function loadRadfiSession(address: string): RadfiSession | null;
|
|
195
|
-
declare function clearRadfiSession(address: string): void;
|
|
196
|
-
/**
|
|
197
|
-
* Hook to authenticate with Radfi using BIP322 message signing.
|
|
198
|
-
* Saves session (accessToken, refreshToken, tradingAddress, publicKey) to localStorage.
|
|
199
|
-
*/
|
|
200
|
-
declare function useRadfiAuth(spokeProvider: BitcoinSpokeProvider | undefined): UseMutationResult<RadfiAuthResult, Error, void>;
|
|
201
|
-
|
|
202
|
-
type UseRadfiSessionReturn = {
|
|
203
|
-
walletAddress: string | undefined;
|
|
204
|
-
isAuthed: boolean;
|
|
205
|
-
tradingAddress: string | undefined;
|
|
206
|
-
login: () => Promise<void>;
|
|
207
|
-
isLoginPending: boolean;
|
|
208
|
-
};
|
|
209
|
-
/**
|
|
210
|
-
* Manages the full Radfi session lifecycle:
|
|
211
|
-
* - On mount / wallet switch: refreshes token to validate session
|
|
212
|
-
* - Single interval (~5 min): refreshes access token. If refresh fails → clears session, isAuthed=false
|
|
213
|
-
* - ensureRadfiAccessToken (SDK layer) acts as safety net before swap/bridge
|
|
214
|
-
* - Exposes login() and isAuthed for UI
|
|
215
|
-
*/
|
|
216
|
-
declare function useRadfiSession(spokeProvider: BitcoinSpokeProvider | undefined): UseRadfiSessionReturn;
|
|
217
|
-
|
|
218
|
-
/**
|
|
219
|
-
* Hook to fund the Radfi trading wallet by sending BTC from the user's personal wallet.
|
|
220
|
-
*
|
|
221
|
-
* @param {BitcoinSpokeProvider | undefined} spokeProvider - The Bitcoin spoke provider with signing capability
|
|
222
|
-
* @returns {UseMutationResult} Mutation result — input is amount in satoshis, output is transaction ID
|
|
223
|
-
*
|
|
224
|
-
* @example
|
|
225
|
-
* ```tsx
|
|
226
|
-
* const { mutateAsync: fundWallet, isPending } = useFundTradingWallet(spokeProvider);
|
|
227
|
-
*
|
|
228
|
-
* const handleFund = async () => {
|
|
229
|
-
* const txId = await fundWallet(100_000n); // fund 100,000 satoshis
|
|
230
|
-
* console.log('Funded:', txId);
|
|
231
|
-
* };
|
|
232
|
-
* ```
|
|
233
|
-
*/
|
|
234
|
-
declare function useFundTradingWallet(spokeProvider: BitcoinSpokeProvider | undefined): UseMutationResult<string, Error, bigint>;
|
|
235
|
-
|
|
236
|
-
/**
|
|
237
|
-
* Hook to fetch BTC balance for any Bitcoin address.
|
|
238
|
-
* Sums all UTXOs (confirmed + unconfirmed) from mempool.space API.
|
|
239
|
-
*
|
|
240
|
-
* The UTXO set already excludes spent outputs (even from unconfirmed txs),
|
|
241
|
-
* so the total is always the correct spendable balance.
|
|
242
|
-
*/
|
|
243
|
-
declare function useBitcoinBalance(address: string | undefined, rpcUrl?: string): UseQueryResult<bigint, Error>;
|
|
244
|
-
|
|
245
|
-
/**
|
|
246
|
-
* Hook to fetch trading wallet balance from Radfi API.
|
|
247
|
-
* Returns confirmed + pending satoshi balances.
|
|
248
|
-
*/
|
|
249
|
-
declare function useTradingWalletBalance(spokeProvider: BitcoinSpokeProvider | undefined, tradingAddress: string | undefined): UseQueryResult<RadfiWalletBalance, Error>;
|
|
250
|
-
|
|
251
|
-
/**
|
|
252
|
-
* Hook to fetch expired UTXOs for a trading wallet address.
|
|
253
|
-
* UTXOs that are expired or within 2 weeks of expiry are considered invalid for trading
|
|
254
|
-
* and need to be renewed via the Radfi renew-utxo flow.
|
|
255
|
-
*/
|
|
256
|
-
declare function useExpiredUtxos(spokeProvider: BitcoinSpokeProvider | undefined, tradingAddress: string | undefined): UseQueryResult<RadfiUtxo[], Error>;
|
|
257
|
-
|
|
258
|
-
type RenewUtxosParams = {
|
|
259
|
-
txIdVouts: string[];
|
|
260
|
-
};
|
|
261
|
-
/**
|
|
262
|
-
* Hook to renew expired UTXOs in the Radfi trading wallet.
|
|
263
|
-
*
|
|
264
|
-
* Flow:
|
|
265
|
-
* 1. Build renew-utxo transaction via Radfi API (returns unsigned PSBT)
|
|
266
|
-
* 2. User signs the PSBT with their wallet
|
|
267
|
-
* 3. Submit signed PSBT back to Radfi for co-signing and broadcasting
|
|
268
|
-
*
|
|
269
|
-
* @example
|
|
270
|
-
* ```tsx
|
|
271
|
-
* const { mutateAsync: renewUtxos, isPending } = useRenewUtxos(spokeProvider);
|
|
272
|
-
*
|
|
273
|
-
* const handleRenew = async (expiredUtxos: RadfiUtxo[]) => {
|
|
274
|
-
* const txIdVouts = expiredUtxos.map(u => u.txidVout);
|
|
275
|
-
* const txId = await renewUtxos({ txIdVouts });
|
|
276
|
-
* console.log('Renewed:', txId);
|
|
277
|
-
* };
|
|
278
|
-
* ```
|
|
279
|
-
*/
|
|
280
|
-
declare function useRenewUtxos(spokeProvider: BitcoinSpokeProvider | undefined): UseMutationResult<string, Error, RenewUtxosParams>;
|
|
281
|
-
|
|
282
|
-
type WithdrawToUserParams = {
|
|
283
|
-
amount: string;
|
|
284
|
-
tokenId: string;
|
|
285
|
-
withdrawTo: string;
|
|
286
|
-
};
|
|
287
|
-
type WithdrawResult = {
|
|
288
|
-
txId: string;
|
|
289
|
-
fee: number;
|
|
290
|
-
};
|
|
291
|
-
/**
|
|
292
|
-
* Hook to withdraw BTC from Radfi trading wallet to user's personal wallet.
|
|
293
|
-
*
|
|
294
|
-
* Flow:
|
|
295
|
-
* 1. Build withdraw transaction via Radfi API (returns unsigned PSBT)
|
|
296
|
-
* 2. User signs the PSBT with their wallet
|
|
297
|
-
* 3. Submit signed PSBT back to Radfi for co-signing and broadcasting
|
|
298
|
-
*
|
|
299
|
-
* @example
|
|
300
|
-
* ```tsx
|
|
301
|
-
* const { mutateAsync: withdraw, isPending } = useRadfiWithdraw(spokeProvider);
|
|
302
|
-
*
|
|
303
|
-
* const handleWithdraw = async () => {
|
|
304
|
-
* const result = await withdraw({
|
|
305
|
-
* amount: '10000',
|
|
306
|
-
* tokenId: '0:0',
|
|
307
|
-
* withdrawTo: 'bc1q...', // user's segwit address
|
|
308
|
-
* });
|
|
309
|
-
* console.log('Withdrawn:', result.txId);
|
|
310
|
-
* };
|
|
311
|
-
* ```
|
|
312
|
-
*/
|
|
313
|
-
declare function useRadfiWithdraw(spokeProvider: BitcoinSpokeProvider | undefined): UseMutationResult<WithdrawResult, Error, WithdrawToUserParams>;
|
|
314
|
-
|
|
315
|
-
interface BorrowResponse {
|
|
316
|
-
ok: true;
|
|
317
|
-
value: [string, string];
|
|
318
|
-
}
|
|
319
|
-
type UseBorrowParams = {
|
|
320
|
-
params: MoneyMarketBorrowParams;
|
|
321
|
-
spokeProvider: SpokeProvider;
|
|
322
|
-
};
|
|
323
|
-
/**
|
|
324
|
-
* React hook for borrowing tokens in the Sodax money market protocol.
|
|
325
|
-
*
|
|
326
|
-
* Encapsulates the async process to initiate a borrow transaction via the money market,
|
|
327
|
-
* handling transaction creation, submission, and cross-chain logic.
|
|
328
|
-
*
|
|
329
|
-
* @returns {UseMutationResult<
|
|
330
|
-
* BorrowResponse,
|
|
331
|
-
* MoneyMarketError<'CREATE_BORROW_INTENT_FAILED' | 'BORROW_UNKNOWN_ERROR' | RelayErrorCode>,
|
|
332
|
-
* UseBorrowParams
|
|
333
|
-
* >} A React Query mutation result object containing:
|
|
334
|
-
* - mutateAsync: (params: UseBorrowParams) => Promise<BorrowResponse>
|
|
335
|
-
* Triggers the borrow action. Expects an object with valid borrow params and a `SpokeProvider`.
|
|
336
|
-
* - isPending: `boolean` if a borrow transaction is in progress.
|
|
337
|
-
* - error: `MoneyMarketError` if the transaction fails, or `null`.
|
|
338
|
-
*
|
|
339
|
-
* @example
|
|
340
|
-
* ```typescript
|
|
341
|
-
* const { mutateAsync: borrow, isPending, error } = useBorrow();
|
|
342
|
-
* await borrow({ params: borrowParams, spokeProvider });
|
|
343
|
-
* ```
|
|
344
|
-
*
|
|
345
|
-
* @throws {Error} When:
|
|
346
|
-
* - `spokeProvider` is missing or invalid.
|
|
347
|
-
* - The underlying borrow transaction fails.
|
|
348
|
-
*/
|
|
349
|
-
declare function useBorrow(): UseMutationResult<BorrowResponse, MoneyMarketError<'CREATE_BORROW_INTENT_FAILED' | 'BORROW_UNKNOWN_ERROR' | RelayErrorCode>, UseBorrowParams>;
|
|
350
|
-
|
|
351
|
-
interface RepayResponse {
|
|
352
|
-
ok: true;
|
|
353
|
-
value: [string, string];
|
|
354
|
-
}
|
|
355
|
-
type UseRepayParams = {
|
|
356
|
-
params: MoneyMarketRepayParams;
|
|
357
|
-
spokeProvider: SpokeProvider;
|
|
358
|
-
};
|
|
359
|
-
/**
|
|
360
|
-
* React hook for repaying a borrow in the Sodax money market protocol.
|
|
361
|
-
*
|
|
362
|
-
* This hook encapsulates the process of sending a repay transaction to the money market.
|
|
363
|
-
* It manages the asynchronous operation for repayment, including sending the transaction
|
|
364
|
-
* and error handling.
|
|
365
|
-
*
|
|
366
|
-
* @returns {UseMutationResult<RepayResponse, MoneyMarketError<'CREATE_REPAY_INTENT_FAILED' | 'REPAY_UNKNOWN_ERROR' | RelayErrorCode>, UseRepayParams>} React Query mutation result object containing:
|
|
367
|
-
* - mutateAsync: (params: UseRepayParams) => Promise<RepayResponse>
|
|
368
|
-
* Initiates a repay transaction using the given MoneyMarketRepayParams and SpokeProvider.
|
|
369
|
-
* - isPending: boolean indicating if a transaction is in progress.
|
|
370
|
-
* - error: MoneyMarketError if an error occurred while repaying, otherwise undefined.
|
|
371
|
-
*
|
|
372
|
-
* @example
|
|
373
|
-
* ```typescript
|
|
374
|
-
* const { mutateAsync: repay, isPending, error } = useRepay();
|
|
375
|
-
* await repay({ params: repayParams, spokeProvider });
|
|
376
|
-
* ```
|
|
377
|
-
*
|
|
378
|
-
* @throws {Error} When:
|
|
379
|
-
* - `spokeProvider` is missing or invalid.
|
|
380
|
-
* - The underlying repay transaction fails.
|
|
381
|
-
*/
|
|
382
|
-
declare function useRepay(): UseMutationResult<RepayResponse, MoneyMarketError<'CREATE_REPAY_INTENT_FAILED' | 'REPAY_UNKNOWN_ERROR' | RelayErrorCode>, UseRepayParams>;
|
|
383
|
-
|
|
384
|
-
interface SupplyResponse {
|
|
385
|
-
ok: true;
|
|
386
|
-
value: [string, string];
|
|
387
|
-
}
|
|
388
|
-
type UseSupplyParams = {
|
|
389
|
-
params: MoneyMarketSupplyParams;
|
|
390
|
-
spokeProvider: SpokeProvider;
|
|
391
|
-
};
|
|
392
|
-
/**
|
|
393
|
-
* React hook for supplying tokens to the Sodax money market protocol.
|
|
394
|
-
*
|
|
395
|
-
* Provides a mutation for performing the supply operation using React Query. Useful
|
|
396
|
-
* for UI components needing to manage the full state (pending, error, etc.) of a supply
|
|
397
|
-
* transaction. It handles transaction creation, cross-chain logic, and errors.
|
|
398
|
-
*
|
|
399
|
-
* @returns {UseMutationResult<SupplyResponse, MoneyMarketError<'CREATE_SUPPLY_INTENT_FAILED' | 'SUPPLY_UNKNOWN_ERROR' | RelayErrorCode>, UseSupplyParams>}
|
|
400
|
-
* Mutation result object from React Query, where:
|
|
401
|
-
* - mutateAsync(params: UseSupplyParams): Promise<SupplyResponse>
|
|
402
|
-
* Initiates a supply transaction using the given MoneyMarketSupplyParams and SpokeProvider.
|
|
403
|
-
* - isPending: boolean indicating if a transaction is in progress.
|
|
404
|
-
* - error: MoneyMarketError if an error occurred while supplying, otherwise undefined.
|
|
405
|
-
*
|
|
406
|
-
* @example
|
|
407
|
-
* ```typescript
|
|
408
|
-
* const { mutateAsync: supply, isPending, error } = useSupply();
|
|
409
|
-
* await supply({ params: supplyParams, spokeProvider });
|
|
410
|
-
* ```
|
|
411
|
-
*
|
|
412
|
-
* @throws {Error|MoneyMarketError<...>} When:
|
|
413
|
-
* - `spokeProvider` is not provided or invalid.
|
|
414
|
-
* - The underlying supply transaction fails.
|
|
415
|
-
*/
|
|
416
|
-
declare function useSupply(): UseMutationResult<SupplyResponse, MoneyMarketError<'CREATE_SUPPLY_INTENT_FAILED' | 'SUPPLY_UNKNOWN_ERROR' | RelayErrorCode>, UseSupplyParams>;
|
|
417
|
-
|
|
418
|
-
type UseWithdrawParams = {
|
|
419
|
-
params: MoneyMarketWithdrawParams;
|
|
420
|
-
spokeProvider: SpokeProvider;
|
|
421
|
-
};
|
|
422
|
-
interface WithdrawResponse {
|
|
423
|
-
ok: true;
|
|
424
|
-
value: [string, string];
|
|
425
|
-
}
|
|
426
|
-
/**
|
|
427
|
-
* Hook for performing withdrawals from the Sodax money market.
|
|
428
|
-
*
|
|
429
|
-
* This hook exposes a mutation that executes the complete withdrawal logic, including transaction
|
|
430
|
-
* creation and handling cross-chain communication. It leverages React Query's mutation API for
|
|
431
|
-
* easy asynchronous handling and status tracking within UI components.
|
|
432
|
-
*
|
|
433
|
-
* @returns {UseMutationResult<WithdrawResponse, MoneyMarketError<'CREATE_WITHDRAW_INTENT_FAILED' | 'WITHDRAW_UNKNOWN_ERROR' | RelayErrorCode>, UseWithdrawParams>}
|
|
434
|
-
* Mutation result object, with:
|
|
435
|
-
* - mutateAsync: (params: UseWithdrawParams) => Promise<WithdrawResponse>
|
|
436
|
-
* Initiates the withdrawal using the provided params.
|
|
437
|
-
* - isPending: boolean indicating if a transaction is in progress.
|
|
438
|
-
* - error: MoneyMarketError if an error occurred while withdrawing, otherwise undefined.
|
|
439
|
-
*
|
|
440
|
-
* @example
|
|
441
|
-
* ```typescript
|
|
442
|
-
* const { mutateAsync: withdraw, isPending, error } = useWithdraw();
|
|
443
|
-
* await withdraw({ params: withdrawParams, spokeProvider });
|
|
444
|
-
* ```
|
|
445
|
-
*
|
|
446
|
-
* @throws {Error} When:
|
|
447
|
-
* - spokeProvider is not provided or invalid.
|
|
448
|
-
* - Underlying withdrawal logic fails.
|
|
449
|
-
*/
|
|
450
|
-
declare function useWithdraw(): UseMutationResult<WithdrawResponse, MoneyMarketError<'CREATE_WITHDRAW_INTENT_FAILED' | 'WITHDRAW_UNKNOWN_ERROR' | RelayErrorCode>, UseWithdrawParams>;
|
|
451
|
-
|
|
452
|
-
type BaseQueryOptions$1 = {
|
|
453
|
-
queryOptions?: UseQueryOptions<readonly [readonly UserReserveData[], number], Error>;
|
|
454
|
-
};
|
|
455
|
-
type NewParams$1 = BaseQueryOptions$1 & {
|
|
456
|
-
/** Spoke chain id (e.g. '0xa86a.avax') */
|
|
457
|
-
spokeChainId: SpokeChainId$1 | undefined;
|
|
458
|
-
/** User wallet address on the spoke chain */
|
|
459
|
-
userAddress: string | undefined;
|
|
460
|
-
};
|
|
461
|
-
/** @deprecated Use `{ spokeChainId, userAddress }` instead */
|
|
462
|
-
type LegacyParams$1 = BaseQueryOptions$1 & {
|
|
463
|
-
/** @deprecated Use `spokeChainId` instead */
|
|
464
|
-
spokeProvider: SpokeProvider | undefined;
|
|
465
|
-
/** @deprecated Use `userAddress` instead */
|
|
466
|
-
address: string | undefined;
|
|
467
|
-
};
|
|
468
|
-
type UseUserReservesDataParams = NewParams$1 | LegacyParams$1;
|
|
469
|
-
/**
|
|
470
|
-
* Hook for fetching user reserves data from the Sodax money market.
|
|
471
|
-
*
|
|
472
|
-
* @param params (optional) - Object including:
|
|
473
|
-
* - spokeChainId: The spoke chain id whose reserves data will be fetched. If not provided, data fetching is disabled.
|
|
474
|
-
* - userAddress: The user's address (string) whose reserves data will be fetched. If not provided, data fetching is disabled.
|
|
475
|
-
* - queryOptions: (optional) Custom React Query options such as `queryKey`, `enabled`, or cache policy.
|
|
476
|
-
*
|
|
477
|
-
* @returns {UseQueryResult<readonly [readonly UserReserveData[], number], Error>} React Query result object containing:
|
|
478
|
-
* - data: A tuple with array of UserReserveData and associated number, or undefined if loading
|
|
479
|
-
* - isLoading: Boolean loading state
|
|
480
|
-
* - isError: Boolean error state
|
|
481
|
-
* - error: Error object, if present
|
|
482
|
-
*
|
|
483
|
-
* @example
|
|
484
|
-
* const { data: userReservesData, isLoading, error } = useUserReservesData({
|
|
485
|
-
* spokeChainId,
|
|
486
|
-
* userAddress,
|
|
487
|
-
* });
|
|
488
|
-
*/
|
|
489
|
-
declare function useUserReservesData(params?: UseUserReservesDataParams): UseQueryResult<readonly [readonly UserReserveData[], number], Error>;
|
|
490
|
-
|
|
491
|
-
type UseReservesDataParams = {
|
|
492
|
-
queryOptions?: UseQueryOptions<readonly [readonly AggregatedReserveData[], BaseCurrencyInfo], Error>;
|
|
493
|
-
};
|
|
494
|
-
/**
|
|
495
|
-
* React hook for fetching the latest reserves data from the Sodax money market.
|
|
496
|
-
*
|
|
497
|
-
* Provides the full set of aggregated reserves and base currency information.
|
|
498
|
-
* Optionally accepts React Query options for customizing the query key, cache time, and related behaviors.
|
|
499
|
-
*
|
|
500
|
-
* @param params (optional) - Object including:
|
|
501
|
-
* - queryOptions: Custom React Query options
|
|
502
|
-
*
|
|
503
|
-
* @returns {UseQueryResult<readonly [readonly AggregatedReserveData[], BaseCurrencyInfo], Error>}
|
|
504
|
-
* React Query result object containing:
|
|
505
|
-
* - data: [aggregated reserves[], base currency info], or undefined if not loaded
|
|
506
|
-
* - isLoading: True if the request is loading
|
|
507
|
-
* - isError: True if the request failed
|
|
508
|
-
* - error: Error object, if present
|
|
509
|
-
*
|
|
510
|
-
* @example
|
|
511
|
-
* const { data, isLoading, error } = useReservesData();
|
|
512
|
-
* const { data } = useReservesData({ queryOptions: { queryKey: ['custom', 'reservesData'] } });
|
|
513
|
-
*/
|
|
514
|
-
declare function useReservesData(params?: UseReservesDataParams): UseQueryResult<readonly [readonly AggregatedReserveData[], BaseCurrencyInfo], Error>;
|
|
515
|
-
|
|
516
|
-
type UseMMAllowanceParams = {
|
|
517
|
-
params: MoneyMarketParams | undefined;
|
|
518
|
-
spokeProvider: SpokeProvider | undefined;
|
|
519
|
-
queryOptions?: UseQueryOptions<boolean, Error>;
|
|
520
|
-
};
|
|
521
|
-
/**
|
|
522
|
-
* Hook for checking token allowance for money market operations.
|
|
523
|
-
*
|
|
524
|
-
* This hook verifies if the user has approved enough tokens for a specific money market action
|
|
525
|
-
* (borrow/repay). It automatically queries and tracks the allowance status.
|
|
526
|
-
*
|
|
527
|
-
* @param {XToken} token - The token to check allowance for. Must be an XToken with valid address and chain information.
|
|
528
|
-
* @param {string} amount - The amount to check allowance for, as a decimal string
|
|
529
|
-
* @param {MoneyMarketAction} action - The money market action to check allowance for ('borrow' or 'repay')
|
|
530
|
-
* @param {SpokeProvider} spokeProvider - The spoke provider to use for allowance checks
|
|
531
|
-
*
|
|
532
|
-
* @returns {UseQueryResult<boolean, Error>} A React Query result containing:
|
|
533
|
-
* - data: Boolean indicating if allowance is sufficient
|
|
534
|
-
* - isLoading: Loading state indicator
|
|
535
|
-
* - error: Any error that occurred during the check
|
|
536
|
-
*
|
|
537
|
-
* @example
|
|
538
|
-
* ```typescript
|
|
539
|
-
* const { data: hasAllowed, isLoading } = useMMAllowance(token, "100", "repay", provider);
|
|
540
|
-
* ```
|
|
541
|
-
*/
|
|
542
|
-
declare function useMMAllowance({ params, spokeProvider, queryOptions, }: UseMMAllowanceParams): UseQueryResult<boolean, Error>;
|
|
543
|
-
|
|
544
|
-
type UseMMApproveParams = {
|
|
545
|
-
params: MoneyMarketParams;
|
|
546
|
-
spokeProvider: SpokeProvider | undefined;
|
|
547
|
-
};
|
|
548
|
-
/**
|
|
549
|
-
* Hook for approving ERC20 token spending for Sodax money market actions.
|
|
550
|
-
*
|
|
551
|
-
* This hook manages the approval transaction, allowing the user
|
|
552
|
-
* to grant the protocol permission to spend their tokens for specific money market actions
|
|
553
|
-
* (such as supply, borrow, or repay). Upon successful approval, it also invalidates and
|
|
554
|
-
* refetches the associated allowance status so the UI remains up-to-date.
|
|
555
|
-
*
|
|
556
|
-
* @returns {UseMutationResult<string, Error, UseMMApproveParams>} A React Query mutation result containing:
|
|
557
|
-
* - mutateAsync: Function to trigger the approval (see below)
|
|
558
|
-
* - isPending: Boolean indicating if approval transaction is in progress
|
|
559
|
-
* - error: Error object if the last approval failed, null otherwise
|
|
560
|
-
*
|
|
561
|
-
* @example
|
|
562
|
-
* ```tsx
|
|
563
|
-
* const { mutateAsync: approve, isPending, error } = useMMApprove();
|
|
564
|
-
* await approve({ params: { token, amount: "100", action: "supply", ... }, spokeProvider });
|
|
565
|
-
* ```
|
|
566
|
-
*
|
|
567
|
-
* @throws {Error} When:
|
|
568
|
-
* - spokeProvider is undefined or invalid
|
|
569
|
-
* - Approval transaction fails for any reason
|
|
570
|
-
*/
|
|
571
|
-
declare function useMMApprove(): UseMutationResult<string, Error, UseMMApproveParams>;
|
|
572
|
-
|
|
573
|
-
type UseATokenParams = {
|
|
574
|
-
aToken: string;
|
|
575
|
-
queryOptions?: UseQueryOptions<XToken, Error>;
|
|
576
|
-
};
|
|
577
|
-
/**
|
|
578
|
-
* React hook to fetch and cache metadata for a given aToken address.
|
|
579
|
-
*
|
|
580
|
-
* Accepts an aToken address and React Query options to control query behavior.
|
|
581
|
-
* Returns the aToken's ERC20-style metadata from the Sodax money market, with querying/caching
|
|
582
|
-
* powered by React Query.
|
|
583
|
-
*
|
|
584
|
-
* @param {UseATokenParams} params - Required params object:
|
|
585
|
-
* @property {Address} aToken - The aToken contract address to query.
|
|
586
|
-
* @property {UseQueryOptions<XToken, Error>} queryOptions - React Query options to control query (e.g., staleTime, refetch, etc.).
|
|
587
|
-
*
|
|
588
|
-
* @returns {UseQueryResult<XToken, Error>} React Query result object:
|
|
589
|
-
* - data: XToken metadata, if available
|
|
590
|
-
* - isLoading: Boolean loading state
|
|
591
|
-
* - error: Error, if API call fails
|
|
592
|
-
*
|
|
593
|
-
* @example
|
|
594
|
-
* const { data: xToken, isLoading, error } = useAToken({ aToken: aTokenAddress, queryOptions: {} });
|
|
595
|
-
* if (xToken) {
|
|
596
|
-
* console.log(xToken.symbol);
|
|
597
|
-
* }
|
|
598
|
-
*/
|
|
599
|
-
declare function useAToken({ aToken, queryOptions }: UseATokenParams): UseQueryResult<XToken, Error>;
|
|
600
|
-
|
|
601
|
-
type UseATokensBalancesParams = {
|
|
602
|
-
aTokens: readonly Address[];
|
|
603
|
-
spokeProvider?: SpokeProvider;
|
|
604
|
-
userAddress?: string;
|
|
605
|
-
queryOptions?: UseQueryOptions<Map<Address, bigint>, Error>;
|
|
606
|
-
};
|
|
607
|
-
/**
|
|
608
|
-
* React hook to fetch and cache aToken balances for multiple aToken addresses in a single multicall.
|
|
609
|
-
*
|
|
610
|
-
* Accepts an array of aToken addresses, a spoke provider, and user address. The hook derives the user's
|
|
611
|
-
* hub wallet address and then fetches balanceOf for each aToken in a single multicall. Returns a Map
|
|
612
|
-
* of aToken address to balance, with querying/caching powered by React Query. This hook uses viem's
|
|
613
|
-
* multicall to batch all requests into a single RPC call for better performance.
|
|
614
|
-
*
|
|
615
|
-
* @param {UseATokensBalancesParams} params - Required params object:
|
|
616
|
-
* @property {readonly Address[]} aTokens - Array of aToken contract addresses to query balances for.
|
|
617
|
-
* @property {SpokeProvider} spokeProvider - The spoke provider to derive hub wallet address from.
|
|
618
|
-
* @property {string} userAddress - User's wallet address on the spoke chain.
|
|
619
|
-
* @property {UseQueryOptions<Map<Address, bigint>, Error>} queryOptions - React Query options to control query (e.g., staleTime, refetch, etc.).
|
|
620
|
-
*
|
|
621
|
-
* @returns {UseQueryResult<Map<Address, bigint>, Error>} React Query result object:
|
|
622
|
-
* - data: Map of aToken address to balance, if available
|
|
623
|
-
* - isLoading: Boolean loading state
|
|
624
|
-
* - error: Error, if API call fails
|
|
625
|
-
*
|
|
626
|
-
* @example
|
|
627
|
-
* const { data: aTokenBalances, isLoading, error } = useATokensBalances({
|
|
628
|
-
* aTokens: [aToken1, aToken2, aToken3],
|
|
629
|
-
* spokeProvider,
|
|
630
|
-
* userAddress: '0x...',
|
|
631
|
-
* queryOptions: {}
|
|
632
|
-
* });
|
|
633
|
-
* const aToken1Balance = aTokenBalances?.get(aToken1);
|
|
634
|
-
*/
|
|
635
|
-
declare function useATokensBalances({ aTokens, spokeProvider, userAddress, queryOptions, }: UseATokensBalancesParams): UseQueryResult<Map<Address, bigint>, Error>;
|
|
636
|
-
|
|
637
|
-
type UseReservesUsdFormatParams = {
|
|
638
|
-
queryOptions?: UseQueryOptions<(ReserveData & {
|
|
639
|
-
priceInMarketReferenceCurrency: string;
|
|
640
|
-
} & FormatReserveUSDResponse)[], Error>;
|
|
641
|
-
};
|
|
642
|
-
/**
|
|
643
|
-
* Hook for fetching reserves data formatted with USD values in the Sodax money market.
|
|
644
|
-
*
|
|
645
|
-
* This hook returns an array of reserve objects, each extended with its price in the market reference
|
|
646
|
-
* currency and formatted USD values. Data is automatically fetched and cached using React Query.
|
|
647
|
-
*
|
|
648
|
-
* @param params (optional) - Object including:
|
|
649
|
-
* - queryOptions: Custom React Query options such as `queryKey`, cache behavior, or refetching policy.
|
|
650
|
-
*
|
|
651
|
-
* @returns {UseQueryResult<(ReserveData & { priceInMarketReferenceCurrency: string } & FormatReserveUSDResponse)[], Error>} React Query result object containing:
|
|
652
|
-
* - data: Array of reserves with USD-formatted values, or undefined if loading
|
|
653
|
-
* - isLoading: Boolean loading state
|
|
654
|
-
* - isError: Boolean error state
|
|
655
|
-
* - error: Error object, if present
|
|
656
|
-
*
|
|
657
|
-
* @example
|
|
658
|
-
* const { data: reservesUSD, isLoading, error } = useReservesUsdFormat();
|
|
659
|
-
*/
|
|
660
|
-
declare function useReservesUsdFormat(params?: UseReservesUsdFormatParams): UseQueryResult<(ReserveData & {
|
|
661
|
-
priceInMarketReferenceCurrency: string;
|
|
662
|
-
} & FormatReserveUSDResponse)[], Error>;
|
|
663
|
-
|
|
664
|
-
type BaseQueryOptions = {
|
|
665
|
-
queryOptions?: UseQueryOptions<FormatUserSummaryResponse<FormatReserveUSDResponse>, Error>;
|
|
666
|
-
};
|
|
667
|
-
type NewParams = BaseQueryOptions & {
|
|
668
|
-
/** Spoke chain id (e.g. '0xa86a.avax') */
|
|
669
|
-
spokeChainId: SpokeChainId$1 | undefined;
|
|
670
|
-
/** User wallet address on the spoke chain */
|
|
671
|
-
userAddress: string | undefined;
|
|
672
|
-
};
|
|
673
|
-
/** @deprecated Use `{ spokeChainId, userAddress }` instead */
|
|
674
|
-
type LegacyParams = BaseQueryOptions & {
|
|
675
|
-
/** @deprecated Use `spokeChainId` instead */
|
|
676
|
-
spokeProvider: SpokeProvider | undefined;
|
|
677
|
-
/** @deprecated Use `userAddress` instead */
|
|
678
|
-
address: string | undefined;
|
|
679
|
-
};
|
|
680
|
-
type UseUserFormattedSummaryParams = NewParams | LegacyParams;
|
|
681
|
-
/**
|
|
682
|
-
* React hook to fetch a formatted summary of a user's Sodax money market portfolio.
|
|
683
|
-
*
|
|
684
|
-
* @param params (optional) - Object including:
|
|
685
|
-
* - spokeChainId: The spoke chain id whose data will be fetched. If not provided, data fetching is disabled.
|
|
686
|
-
* - userAddress: The user's address (string) whose summary will be fetched. If not provided, data fetching is disabled.
|
|
687
|
-
* - queryOptions: (optional) Custom React Query options such as `queryKey`, `enabled`, or cache policy.
|
|
688
|
-
*
|
|
689
|
-
* @returns {UseQueryResult<FormatUserSummaryResponse<FormatReserveUSDResponse>, Error>}
|
|
690
|
-
* A result object from React Query including:
|
|
691
|
-
* - data: The user's formatted portfolio summary (or undefined if not loaded)
|
|
692
|
-
* - isLoading: Boolean loading state
|
|
693
|
-
* - isError: Boolean error state
|
|
694
|
-
* - error: Error if thrown in fetching
|
|
695
|
-
*
|
|
696
|
-
* @example
|
|
697
|
-
* const { data, isLoading, error } = useUserFormattedSummary({ spokeChainId, userAddress });
|
|
698
|
-
*/
|
|
699
|
-
declare function useUserFormattedSummary(params?: UseUserFormattedSummaryParams): UseQueryResult<FormatUserSummaryResponse<FormatReserveUSDResponse>, Error>;
|
|
700
|
-
|
|
701
|
-
/**
|
|
702
|
-
* Hook for fetching a quote for an intent-based swap.
|
|
703
|
-
*
|
|
704
|
-
* This hook provides real-time quote data for an intent-based swap.
|
|
705
|
-
*
|
|
706
|
-
* @param {SolverIntentQuoteRequest | undefined} payload - The intent quote request parameters. If undefined, the query will be disabled.
|
|
707
|
-
*
|
|
708
|
-
* @returns {UseQueryResult<Result<SolverIntentQuoteResponse, SolverErrorResponse> | undefined>} A query result object containing:
|
|
709
|
-
* - data: The quote result from the solver
|
|
710
|
-
* - isLoading: Boolean indicating if the quote is being fetched
|
|
711
|
-
* - error: Error object if the quote request failed
|
|
712
|
-
* - refetch: Function to manually trigger a quote refresh
|
|
713
|
-
*
|
|
714
|
-
* @example
|
|
715
|
-
* ```typescript
|
|
716
|
-
* const { data: quote, isLoading } = useQuote({
|
|
717
|
-
* token_src: '0x...',
|
|
718
|
-
* token_src_blockchain_id: '1',
|
|
719
|
-
* token_dst: '0x...',
|
|
720
|
-
* token_dst_blockchain_id: '2',
|
|
721
|
-
* amount: '1000000000000000000',
|
|
722
|
-
* quote_type: 'exact_input',
|
|
723
|
-
* });
|
|
724
|
-
*
|
|
725
|
-
* if (isLoading) return <div>Loading quote...</div>;
|
|
726
|
-
* if (quote) {
|
|
727
|
-
* console.log('Quote received:', quote);
|
|
728
|
-
* }
|
|
729
|
-
* ```
|
|
730
|
-
*
|
|
731
|
-
* @remarks
|
|
732
|
-
* - The quote is automatically refreshed every 3 seconds
|
|
733
|
-
* - The query is disabled when payload is undefined
|
|
734
|
-
* - Uses React Query for efficient caching and state management
|
|
735
|
-
*/
|
|
736
|
-
declare const useQuote: (payload: SolverIntentQuoteRequest | undefined) => UseQueryResult<Result<SolverIntentQuoteResponse, SolverErrorResponse> | undefined>;
|
|
737
|
-
|
|
738
|
-
type CreateIntentResult = Result<[SolverExecutionResponse, Intent, IntentDeliveryInfo], IntentError<IntentErrorCode>>;
|
|
739
|
-
/**
|
|
740
|
-
* Hook for creating and submitting an swap intent order for cross-chain swaps.
|
|
741
|
-
* Uses React Query's useMutation for better state management and caching.
|
|
742
|
-
*
|
|
743
|
-
* @param {SpokeProvider} spokeProvider - The spoke provider to use for the swap
|
|
744
|
-
* @returns {UseMutationResult} Mutation result object containing mutation function and state
|
|
745
|
-
*
|
|
746
|
-
* @example
|
|
747
|
-
* ```typescript
|
|
748
|
-
* const { mutateAsync: swap, isPending } = useSwap(spokeProvider);
|
|
749
|
-
*
|
|
750
|
-
* const handleSwap = async () => {
|
|
751
|
-
* const result = await swap({
|
|
752
|
-
* token_src: '0x...',
|
|
753
|
-
* token_src_blockchain_id: 'arbitrum',
|
|
754
|
-
* token_dst: '0x...',
|
|
755
|
-
* token_dst_blockchain_id: 'polygon',
|
|
756
|
-
* amount: '1000000000000000000',
|
|
757
|
-
* min_output_amount: '900000000000000000'
|
|
758
|
-
* });
|
|
759
|
-
* };
|
|
760
|
-
* ```
|
|
761
|
-
*/
|
|
762
|
-
declare function useSwap(spokeProvider: SpokeProvider | undefined): UseMutationResult<CreateIntentResult, Error, CreateIntentParams>;
|
|
763
|
-
|
|
764
|
-
/**
|
|
765
|
-
* Hook for monitoring the status of an intent-based swap.
|
|
766
|
-
*
|
|
767
|
-
* This hook provides real-time status updates for an intent-based swap transaction.
|
|
768
|
-
*
|
|
769
|
-
* @param {Hex} intent_tx_hash - The transaction hash of the intent order on the hub chain
|
|
770
|
-
*
|
|
771
|
-
* @returns {UseQueryResult<Result<SolverIntentStatusResponse, SolverErrorResponse> | undefined>} A query result object containing:
|
|
772
|
-
* - data: The status result from the solver
|
|
773
|
-
* - isLoading: Boolean indicating if the status is being fetched
|
|
774
|
-
* - error: Error object if the status request failed
|
|
775
|
-
* - refetch: Function to manually trigger a status refresh
|
|
776
|
-
*
|
|
777
|
-
* @example
|
|
778
|
-
* ```typescript
|
|
779
|
-
* const { data: status, isLoading } = useStatus('0x...');
|
|
780
|
-
*
|
|
781
|
-
* if (isLoading) return <div>Loading status...</div>;
|
|
782
|
-
* if (status?.ok) {
|
|
783
|
-
* console.log('Status:', status.value);
|
|
784
|
-
* }
|
|
785
|
-
* ```
|
|
786
|
-
*
|
|
787
|
-
* @remarks
|
|
788
|
-
* - The status is automatically refreshed every 3 seconds
|
|
789
|
-
* - Uses React Query for efficient caching and state management
|
|
790
|
-
*/
|
|
791
|
-
declare const useStatus: (intent_tx_hash: Hex) => UseQueryResult<Result<SolverIntentStatusResponse, SolverErrorResponse> | undefined>;
|
|
792
|
-
|
|
793
|
-
/**
|
|
794
|
-
* Hook for checking token allowance for swap operations.
|
|
795
|
-
*
|
|
796
|
-
* This hook verifies if the user has approved enough tokens for a specific swap action.
|
|
797
|
-
* It automatically queries and tracks the allowance status.
|
|
798
|
-
*
|
|
799
|
-
* @param {CreateIntentParams | CreateLimitOrderParams} params - The parameters for the intent to check allowance for.
|
|
800
|
-
* @param {SpokeProvider} spokeProvider - The spoke provider to use for allowance checks
|
|
801
|
-
*
|
|
802
|
-
* @returns {UseQueryResult<boolean, Error>} A React Query result containing:
|
|
803
|
-
* - data: Boolean indicating if allowance is sufficient
|
|
804
|
-
* - isLoading: Loading state indicator
|
|
805
|
-
* - error: Any error that occurred during the check
|
|
806
|
-
*
|
|
807
|
-
* @example
|
|
808
|
-
* ```typescript
|
|
809
|
-
* const { data: hasAllowed, isLoading } = useSwapAllowance(params, spokeProvider);
|
|
810
|
-
* ```
|
|
811
|
-
*/
|
|
812
|
-
declare function useSwapAllowance(params: CreateIntentParams | CreateLimitOrderParams | undefined, spokeProvider: SpokeProvider | undefined): UseQueryResult<boolean, Error>;
|
|
813
|
-
|
|
814
|
-
interface UseApproveReturn$1 {
|
|
815
|
-
approve: ({ params }: {
|
|
816
|
-
params: CreateIntentParams | CreateLimitOrderParams;
|
|
817
|
-
}) => Promise<boolean>;
|
|
818
|
-
isLoading: boolean;
|
|
819
|
-
error: Error | null;
|
|
820
|
-
resetError: () => void;
|
|
821
|
-
}
|
|
822
|
-
/**
|
|
823
|
-
* Hook for approving token spending for swap actions
|
|
824
|
-
* @param params The parameters for the intent to approve spending for
|
|
825
|
-
* @param spokeProvider The spoke provider instance for the chain
|
|
826
|
-
* @returns Object containing approve function, loading state, error state and reset function
|
|
827
|
-
* @example
|
|
828
|
-
* ```tsx
|
|
829
|
-
* const { approve, isLoading, error } = useApprove(token, spokeProvider);
|
|
830
|
-
*
|
|
831
|
-
* // Approve tokens for supply action
|
|
832
|
-
* await approve({ amount: "100", action: "supply" });
|
|
833
|
-
* ```
|
|
834
|
-
*/
|
|
835
|
-
declare function useSwapApprove(params: CreateIntentParams | CreateLimitOrderParams | undefined, spokeProvider: SpokeProvider | undefined): UseApproveReturn$1;
|
|
836
|
-
|
|
837
|
-
type CancelIntentParams = {
|
|
838
|
-
intent: Intent;
|
|
839
|
-
raw?: boolean;
|
|
840
|
-
};
|
|
841
|
-
type CancelIntentResult = Result<TxReturnType<SpokeProvider, boolean>>;
|
|
842
|
-
/**
|
|
843
|
-
* Hook for canceling a swap intent order.
|
|
844
|
-
* Uses React Query's useMutation for better state management and caching.
|
|
845
|
-
*
|
|
846
|
-
* @param {SpokeProvider} spokeProvider - The spoke provider to use for canceling the intent
|
|
847
|
-
* @returns {UseMutationResult} Mutation result object containing mutation function and state
|
|
848
|
-
*
|
|
849
|
-
* @example
|
|
850
|
-
* ```typescript
|
|
851
|
-
* const { mutateAsync: cancelSwap, isPending } = useCancelSwap(spokeProvider);
|
|
852
|
-
*
|
|
853
|
-
* const handleCancelSwap = async () => {
|
|
854
|
-
* const result = await cancelSwap({
|
|
855
|
-
* intent: intentObject,
|
|
856
|
-
* raw: false // optional, defaults to false
|
|
857
|
-
* });
|
|
858
|
-
* };
|
|
859
|
-
* ```
|
|
860
|
-
*/
|
|
861
|
-
declare function useCancelSwap(spokeProvider: SpokeProvider | undefined): UseMutationResult<CancelIntentResult, Error, CancelIntentParams>;
|
|
862
|
-
|
|
863
|
-
type CreateLimitOrderResult = Result<[
|
|
864
|
-
SolverExecutionResponse,
|
|
865
|
-
Intent,
|
|
866
|
-
IntentDeliveryInfo
|
|
867
|
-
], IntentError<IntentErrorCode>>;
|
|
868
|
-
/**
|
|
869
|
-
* Hook for creating a limit order intent (no deadline, must be cancelled manually by user).
|
|
870
|
-
* Uses React Query's useMutation for better state management and caching.
|
|
871
|
-
*
|
|
872
|
-
* Limit orders remain active until manually cancelled by the user. Unlike swaps, limit orders
|
|
873
|
-
* do not have a deadline (deadline is automatically set to 0n).
|
|
874
|
-
*
|
|
875
|
-
* @param {SpokeProvider} spokeProvider - The spoke provider to use for creating the limit order
|
|
876
|
-
* @returns {UseMutationResult} Mutation result object containing mutation function and state
|
|
877
|
-
*
|
|
878
|
-
* @example
|
|
879
|
-
* ```typescript
|
|
880
|
-
* const { mutateAsync: createLimitOrder, isPending } = useCreateLimitOrder(spokeProvider);
|
|
881
|
-
*
|
|
882
|
-
* const handleCreateLimitOrder = async () => {
|
|
883
|
-
* const result = await createLimitOrder({
|
|
884
|
-
* inputToken: '0x...',
|
|
885
|
-
* outputToken: '0x...',
|
|
886
|
-
* inputAmount: 1000000000000000000n,
|
|
887
|
-
* minOutputAmount: 900000000000000000n,
|
|
888
|
-
* allowPartialFill: false,
|
|
889
|
-
* srcChain: '0xa4b1.arbitrum',
|
|
890
|
-
* dstChain: '0x89.polygon',
|
|
891
|
-
* srcAddress: '0x...',
|
|
892
|
-
* dstAddress: '0x...',
|
|
893
|
-
* solver: '0x0000000000000000000000000000000000000000',
|
|
894
|
-
* data: '0x'
|
|
895
|
-
* });
|
|
896
|
-
*
|
|
897
|
-
* if (result.ok) {
|
|
898
|
-
* const [solverExecutionResponse, intent, intentDeliveryInfo] = result.value;
|
|
899
|
-
* console.log('Limit order created:', intent);
|
|
900
|
-
* console.log('Intent hash:', solverExecutionResponse.intent_hash);
|
|
901
|
-
* }
|
|
902
|
-
* };
|
|
903
|
-
* ```
|
|
904
|
-
*/
|
|
905
|
-
declare function useCreateLimitOrder(spokeProvider: SpokeProvider | undefined): UseMutationResult<CreateLimitOrderResult, Error, CreateLimitOrderParams>;
|
|
906
|
-
|
|
907
|
-
type CancelLimitOrderParams = {
|
|
908
|
-
intent: Intent;
|
|
909
|
-
spokeProvider: SpokeProvider;
|
|
910
|
-
timeout?: number;
|
|
911
|
-
};
|
|
912
|
-
type CancelLimitOrderResult = Result<[string, string], IntentError<IntentErrorCode>>;
|
|
913
|
-
/**
|
|
914
|
-
* Hook for canceling a limit order intent and submitting it to the Relayer API.
|
|
915
|
-
* Uses React Query's useMutation for better state management and caching.
|
|
916
|
-
*
|
|
917
|
-
* This hook wraps cancelLimitOrder which cancels the intent on the spoke chain,
|
|
918
|
-
* submits it to the relayer API, and waits for execution on the destination/hub chain.
|
|
919
|
-
*
|
|
920
|
-
* @returns {UseMutationResult} Mutation result object containing mutation function and state
|
|
921
|
-
*
|
|
922
|
-
* @example
|
|
923
|
-
* ```typescript
|
|
924
|
-
* const { mutateAsync: cancelLimitOrder, isPending } = useCancelLimitOrder();
|
|
925
|
-
*
|
|
926
|
-
* const handleCancelLimitOrder = async () => {
|
|
927
|
-
* const result = await cancelLimitOrder({
|
|
928
|
-
* intent: intentObject,
|
|
929
|
-
* spokeProvider,
|
|
930
|
-
* timeout: 60000 // optional, defaults to 60 seconds
|
|
931
|
-
* });
|
|
932
|
-
*
|
|
933
|
-
* if (result.ok) {
|
|
934
|
-
* const [cancelTxHash, dstTxHash] = result.value;
|
|
935
|
-
* console.log('Cancel transaction hash:', cancelTxHash);
|
|
936
|
-
* console.log('Destination transaction hash:', dstTxHash);
|
|
937
|
-
* }
|
|
938
|
-
* };
|
|
939
|
-
* ```
|
|
940
|
-
*/
|
|
941
|
-
declare function useCancelLimitOrder(): UseMutationResult<CancelLimitOrderResult, Error, CancelLimitOrderParams>;
|
|
942
|
-
|
|
943
|
-
type UseBackendIntentByTxHashParams = {
|
|
944
|
-
params: {
|
|
945
|
-
txHash: string | undefined;
|
|
946
|
-
};
|
|
947
|
-
queryOptions?: UseQueryOptions<IntentResponse | undefined, Error>;
|
|
948
|
-
};
|
|
949
|
-
/**
|
|
950
|
-
* React hook for fetching intent details from the backend API using a transaction hash.
|
|
951
|
-
*
|
|
952
|
-
* @param {UseBackendIntentByTxHashParams | undefined} params - Parameters for the query:
|
|
953
|
-
* - params: { txHash: string | undefined }
|
|
954
|
-
* - `txHash`: Transaction hash used to retrieve the associated intent; query is disabled if undefined or empty.
|
|
955
|
-
* - queryOptions (optional): React Query options to customize request behavior (e.g., caching, retry, refetchInterval, etc.).
|
|
956
|
-
*
|
|
957
|
-
* @returns {UseQueryResult<IntentResponse | undefined, Error>} React Query result object, including:
|
|
958
|
-
* - `data`: The intent response or undefined if unavailable,
|
|
959
|
-
* - `isLoading`: Loading state,
|
|
960
|
-
* - `error`: Error (if request failed),
|
|
961
|
-
* - `refetch`: Function to refetch the data.
|
|
962
|
-
*
|
|
963
|
-
* @example
|
|
964
|
-
* const { data: intent, isLoading, error } = useBackendIntentByTxHash({
|
|
965
|
-
* params: { txHash: '0x123...' },
|
|
966
|
-
* });
|
|
967
|
-
*
|
|
968
|
-
* if (isLoading) return <div>Loading intent...</div>;
|
|
969
|
-
* if (error) return <div>Error: {error.message}</div>;
|
|
970
|
-
* if (intent) {
|
|
971
|
-
* console.log('Intent found:', intent.intentHash);
|
|
972
|
-
* }
|
|
973
|
-
*
|
|
974
|
-
* @remarks
|
|
975
|
-
* - Intents are only created on the hub chain, so `txHash` must originate from there.
|
|
976
|
-
* - Query is disabled if `params` is undefined, or if `params.params.txHash` is undefined or an empty string.
|
|
977
|
-
* - Default refetch interval is 1 second. Uses React Query for state management, caching, and retries.
|
|
978
|
-
*/
|
|
979
|
-
declare const useBackendIntentByTxHash: (params: UseBackendIntentByTxHashParams | undefined) => UseQueryResult<IntentResponse | undefined, Error>;
|
|
980
|
-
|
|
981
|
-
type UseBackendIntentByHashParams = {
|
|
982
|
-
params: {
|
|
983
|
-
intentHash: string | undefined;
|
|
984
|
-
};
|
|
985
|
-
queryOptions?: UseQueryOptions<IntentResponse | undefined, Error>;
|
|
986
|
-
};
|
|
987
|
-
/**
|
|
988
|
-
* React hook to fetch intent details from the backend API using an intent hash.
|
|
989
|
-
*
|
|
990
|
-
* @param {UseBackendIntentByHashParams | undefined} params - Parameters for the query:
|
|
991
|
-
* - params: { intentHash: string | undefined }
|
|
992
|
-
* - `intentHash`: The hash identifying the intent to fetch (disables query if undefined or empty).
|
|
993
|
-
* - queryOptions (optional): Options to customize React Query (e.g., staleTime, enabled).
|
|
994
|
-
*
|
|
995
|
-
* @returns {UseQueryResult<IntentResponse | undefined, Error>} React Query result containing intent response data, loading, error, and refetch states.
|
|
996
|
-
*
|
|
997
|
-
* @example
|
|
998
|
-
* const { data: intent, isLoading, error } = useBackendIntentByHash({
|
|
999
|
-
* params: { intentHash: '0xabc...' },
|
|
1000
|
-
* });
|
|
1001
|
-
*
|
|
1002
|
-
* if (isLoading) return <div>Loading intent...</div>;
|
|
1003
|
-
* if (error) return <div>Error: {error.message}</div>;
|
|
1004
|
-
* if (intent) {
|
|
1005
|
-
* console.log('Intent found:', intent.intentHash);
|
|
1006
|
-
* }
|
|
1007
|
-
*
|
|
1008
|
-
* @remarks
|
|
1009
|
-
* - Returns `undefined` data if no intentHash is provided or query is disabled.
|
|
1010
|
-
* - Query is cached and managed using React Query.
|
|
1011
|
-
* - Use `queryOptions` to customize caching, retry and fetch behavior.
|
|
1012
|
-
*/
|
|
1013
|
-
declare const useBackendIntentByHash: (params: UseBackendIntentByHashParams | undefined) => UseQueryResult<IntentResponse | undefined, Error>;
|
|
1014
|
-
|
|
1015
|
-
type BackendPaginationParams = {
|
|
1016
|
-
offset: string;
|
|
1017
|
-
limit: string;
|
|
1018
|
-
};
|
|
1019
|
-
|
|
1020
|
-
type GetUserIntentsParams = {
|
|
1021
|
-
userAddress: Address$1;
|
|
1022
|
-
startDate?: number;
|
|
1023
|
-
endDate?: number;
|
|
1024
|
-
};
|
|
1025
|
-
type UseBackendUserIntentsParams = {
|
|
1026
|
-
params?: GetUserIntentsParams;
|
|
1027
|
-
queryOptions?: UseQueryOptions<UserIntentsResponse | undefined, Error>;
|
|
1028
|
-
pagination?: BackendPaginationParams;
|
|
1029
|
-
};
|
|
1030
|
-
/**
|
|
1031
|
-
* React hook for fetching user-created intents from the backend API for a given user address,
|
|
1032
|
-
* with optional support for a date filtering range.
|
|
1033
|
-
*
|
|
1034
|
-
* @param {UseBackendUserIntentsParams} args - Query configuration.
|
|
1035
|
-
* @param {GetUserIntentsParams | undefined} args.params - User intent filter parameters.
|
|
1036
|
-
* @param {Address} args.params.userAddress - The wallet address of the user (required).
|
|
1037
|
-
* @param {number} [args.params.startDate] - Include intents created after this timestamp (ms).
|
|
1038
|
-
* @param {number} [args.params.endDate] - Include intents created before this timestamp (ms).
|
|
1039
|
-
* @param {UseQueryOptions<UserIntentsResponse | undefined, Error>} [args.queryOptions] - Optional React Query options.
|
|
1040
|
-
* @param {BackendPaginationParams} [args.pagination] - (currently ignored) Pagination options.
|
|
1041
|
-
*
|
|
1042
|
-
* @returns {UseQueryResult<UserIntentsResponse | undefined, Error>} React Query result:
|
|
1043
|
-
* - `data`: The user intent response, or undefined if unavailable.
|
|
1044
|
-
* - `isLoading`: `true` if loading.
|
|
1045
|
-
* - `error`: An Error instance if any occurred.
|
|
1046
|
-
* - `refetch`: Function to refetch data.
|
|
1047
|
-
*
|
|
1048
|
-
* @example
|
|
1049
|
-
* const { data: userIntents, isLoading, error } = useBackendUserIntents({
|
|
1050
|
-
* params: { userAddress: "0x123..." }
|
|
1051
|
-
* });
|
|
1052
|
-
*
|
|
1053
|
-
* @example
|
|
1054
|
-
* const { data } = useBackendUserIntents({
|
|
1055
|
-
* params: {
|
|
1056
|
-
* userAddress: "0xabc...",
|
|
1057
|
-
* startDate: Date.now() - 1_000_000,
|
|
1058
|
-
* endDate: Date.now(),
|
|
1059
|
-
* },
|
|
1060
|
-
* });
|
|
1061
|
-
*
|
|
1062
|
-
* @remarks
|
|
1063
|
-
* The query is disabled if `params` or `params.userAddress` is missing or empty. Uses React Query for
|
|
1064
|
-
* cache/state management and auto-retries failed requests three times by default.
|
|
1065
|
-
*/
|
|
1066
|
-
declare const useBackendUserIntents: ({ params, queryOptions, }: UseBackendUserIntentsParams) => UseQueryResult<UserIntentsResponse | undefined, Error>;
|
|
1067
|
-
|
|
1068
|
-
type UseBackendSubmitSwapTxParams = {
|
|
1069
|
-
apiConfig?: RequestOverrideConfig;
|
|
1070
|
-
mutationOptions?: UseMutationOptions<SubmitSwapTxResponse, Error, SubmitSwapTxRequest>;
|
|
1071
|
-
};
|
|
1072
|
-
/**
|
|
1073
|
-
* React hook for submitting a swap transaction to be processed by the backend
|
|
1074
|
-
* (relay, post execution to solver, etc.).
|
|
1075
|
-
*
|
|
1076
|
-
* @param {UseBackendSubmitSwapTxParams | undefined} params - Optional parameters:
|
|
1077
|
-
* - `mutationOptions`: React Query mutation options to customize behavior (e.g., onSuccess, onError, retry).
|
|
1078
|
-
*
|
|
1079
|
-
* @returns {UseMutationResult<SubmitSwapTxResponse, Error, SubmitSwapTxRequest>} React Query mutation result:
|
|
1080
|
-
* - `mutate` / `mutateAsync`: Functions to trigger the submission.
|
|
1081
|
-
* - `data`: The submit response on success.
|
|
1082
|
-
* - `isPending`: Loading state.
|
|
1083
|
-
* - `error`: Error instance if the mutation failed.
|
|
1084
|
-
*
|
|
1085
|
-
* @example
|
|
1086
|
-
* const { mutateAsync: submitSwapTx, isPending, error } = useBackendSubmitSwapTx();
|
|
1087
|
-
*
|
|
1088
|
-
* const result = await submitSwapTx({
|
|
1089
|
-
* txHash: '0x123...',
|
|
1090
|
-
* srcChainId: '1',
|
|
1091
|
-
* walletAddress: '0xabc...',
|
|
1092
|
-
* intent: { ... },
|
|
1093
|
-
* relayData: '0x...',
|
|
1094
|
-
* });
|
|
1095
|
-
*/
|
|
1096
|
-
declare const useBackendSubmitSwapTx: (params?: UseBackendSubmitSwapTxParams) => UseMutationResult<SubmitSwapTxResponse, Error, SubmitSwapTxRequest>;
|
|
1097
|
-
|
|
1098
|
-
type UseBackendSubmitSwapTxStatusParams = {
|
|
1099
|
-
params: {
|
|
1100
|
-
txHash: string | undefined;
|
|
1101
|
-
srcChainId?: string;
|
|
1102
|
-
};
|
|
1103
|
-
apiConfig?: RequestOverrideConfig;
|
|
1104
|
-
queryOptions?: UseQueryOptions<SubmitSwapTxStatusResponse | undefined, Error>;
|
|
1105
|
-
};
|
|
1106
|
-
/**
|
|
1107
|
-
* React hook for polling the processing status of a submitted swap transaction.
|
|
1108
|
-
*
|
|
1109
|
-
* @param {UseBackendSubmitSwapTxStatusParams | undefined} params - Parameters for the query:
|
|
1110
|
-
* - `params.txHash`: The transaction hash of the submitted swap; query is disabled if undefined or empty.
|
|
1111
|
-
* - `params.srcChainId`: Optional source chain ID to narrow the status lookup.
|
|
1112
|
-
* - `queryOptions`: Optional React Query options to override default behavior (e.g., refetchInterval, retry).
|
|
1113
|
-
*
|
|
1114
|
-
* @returns {UseQueryResult<SubmitSwapTxStatusResponse | undefined, Error>} React Query result object:
|
|
1115
|
-
* - `data`: The status response or undefined if unavailable.
|
|
1116
|
-
* - `isLoading`: Loading state.
|
|
1117
|
-
* - `error`: Error instance if the query failed.
|
|
1118
|
-
* - `refetch`: Function to re-trigger the query.
|
|
1119
|
-
*
|
|
1120
|
-
* @example
|
|
1121
|
-
* const { data: status, isLoading, error } = useBackendSubmitSwapTxStatus({
|
|
1122
|
-
* params: { txHash: '0x123...', srcChainId: '1' },
|
|
1123
|
-
* });
|
|
1124
|
-
*
|
|
1125
|
-
* if (status?.data.status === 'executed') {
|
|
1126
|
-
* console.log('Swap completed!', status.data.result);
|
|
1127
|
-
* }
|
|
1128
|
-
*
|
|
1129
|
-
* @remarks
|
|
1130
|
-
* - Query is disabled if `params` is undefined or `txHash` is undefined/empty.
|
|
1131
|
-
* - Default refetch interval is 1 second for real-time status polling.
|
|
1132
|
-
* - Uses React Query for state management, caching, and retries.
|
|
1133
|
-
*/
|
|
1134
|
-
declare const useBackendSubmitSwapTxStatus: (params: UseBackendSubmitSwapTxStatusParams | undefined) => UseQueryResult<SubmitSwapTxStatusResponse | undefined, Error>;
|
|
1135
|
-
|
|
1136
|
-
type UseBackendOrderbookParams = {
|
|
1137
|
-
queryOptions?: UseQueryOptions<OrderbookResponse | undefined, Error>;
|
|
1138
|
-
pagination?: BackendPaginationParams;
|
|
1139
|
-
};
|
|
1140
|
-
/**
|
|
1141
|
-
* Hook for fetching the solver orderbook from the backend API.
|
|
1142
|
-
*
|
|
1143
|
-
* @param {UseBackendOrderbookParams | undefined} params - Optional parameters:
|
|
1144
|
-
* - `pagination`: Pagination configuration (see `BackendPaginationParams`), including
|
|
1145
|
-
* `offset` and `limit` (both required for fetch to be enabled).
|
|
1146
|
-
* - `queryOptions`: Optional React Query options to override default behavior.
|
|
1147
|
-
*
|
|
1148
|
-
* @returns {UseQueryResult<OrderbookResponse | undefined, Error>} React Query result object:
|
|
1149
|
-
* - `data`: The orderbook response, or undefined if unavailable.
|
|
1150
|
-
* - `isLoading`: Loading state.
|
|
1151
|
-
* - `error`: Error instance if the query failed.
|
|
1152
|
-
* - `refetch`: Function to re-trigger the query.
|
|
1153
|
-
*
|
|
1154
|
-
* @example
|
|
1155
|
-
* const { data, isLoading, error } = useBackendOrderbook({
|
|
1156
|
-
* pagination: { offset: '0', limit: '10' },
|
|
1157
|
-
* queryOptions: { staleTime: 60000 },
|
|
1158
|
-
* });
|
|
1159
|
-
*
|
|
1160
|
-
* @remarks
|
|
1161
|
-
* - Query is disabled if `params?.pagination`, `offset`, or `limit` are missing/empty.
|
|
1162
|
-
* - Caches and manages server state using React Query.
|
|
1163
|
-
* - Default `staleTime` is 30 seconds to support near-real-time updates.
|
|
1164
|
-
*/
|
|
1165
|
-
declare const useBackendOrderbook: (params: UseBackendOrderbookParams | undefined) => UseQueryResult<OrderbookResponse | undefined>;
|
|
1166
|
-
|
|
1167
|
-
type UseBackendMoneyMarketPositionParams = {
|
|
1168
|
-
userAddress: string | undefined;
|
|
1169
|
-
queryOptions?: UseQueryOptions<MoneyMarketPosition | undefined, Error>;
|
|
1170
|
-
};
|
|
1171
|
-
/**
|
|
1172
|
-
* React hook for fetching a user's money market position from the backend API.
|
|
1173
|
-
*
|
|
1174
|
-
* @param {UseBackendMoneyMarketPositionParams | undefined} params - Parameters object:
|
|
1175
|
-
* - userAddress: The user's wallet address to fetch positions for. If undefined or empty, the query is disabled.
|
|
1176
|
-
* - queryOptions: (Optional) React Query options to customize behavior (e.g., staleTime, enabled).
|
|
1177
|
-
*
|
|
1178
|
-
* @returns {UseQueryResult<MoneyMarketPosition | undefined, Error>} - React Query result object with:
|
|
1179
|
-
* - data: The user's money market position data, or undefined if not available.
|
|
1180
|
-
* - isLoading: Loading state.
|
|
1181
|
-
* - error: An Error instance if fetching failed.
|
|
1182
|
-
* - refetch: Function to manually trigger a refetch.
|
|
1183
|
-
*
|
|
1184
|
-
* @example
|
|
1185
|
-
* const { data, isLoading, error } = useBackendMoneyMarketPosition({
|
|
1186
|
-
* userAddress: '0xabc...',
|
|
1187
|
-
* queryOptions: { staleTime: 60000 },
|
|
1188
|
-
* });
|
|
1189
|
-
*/
|
|
1190
|
-
declare const useBackendMoneyMarketPosition: (params: UseBackendMoneyMarketPositionParams | undefined) => UseQueryResult<MoneyMarketPosition | undefined, Error>;
|
|
1191
|
-
|
|
1192
|
-
type UseBackendAllMoneyMarketAssetsParams = {
|
|
1193
|
-
queryOptions?: UseQueryOptions<MoneyMarketAsset[], Error>;
|
|
1194
|
-
};
|
|
1195
|
-
/**
|
|
1196
|
-
* React hook to fetch all money market assets from the backend API.
|
|
1197
|
-
*
|
|
1198
|
-
* @param {UseBackendAllMoneyMarketAssetsParams | undefined} params - Optional parameters:
|
|
1199
|
-
* - `queryOptions` (optional): React Query options to override default behavior (e.g., caching, retry, etc).
|
|
1200
|
-
*
|
|
1201
|
-
* @returns {UseQueryResult<MoneyMarketAsset[], Error>} React Query result object:
|
|
1202
|
-
* - `data`: Array of all money market asset data when available.
|
|
1203
|
-
* - `isLoading`: Boolean indicating if the request is in progress.
|
|
1204
|
-
* - `error`: Error object if the request failed.
|
|
1205
|
-
* - `refetch`: Function to manually trigger a data refresh.
|
|
1206
|
-
*
|
|
1207
|
-
* @example
|
|
1208
|
-
* const { data: assets, isLoading, error } = useBackendAllMoneyMarketAssets();
|
|
1209
|
-
*
|
|
1210
|
-
* if (isLoading) return <div>Loading assets...</div>;
|
|
1211
|
-
* if (error) return <div>Error: {error.message}</div>;
|
|
1212
|
-
* if (assets) {
|
|
1213
|
-
* console.log('Total assets:', assets.length);
|
|
1214
|
-
* assets.forEach(asset => {
|
|
1215
|
-
* console.log(`${asset.symbol}: ${asset.liquidityRate} liquidity rate`);
|
|
1216
|
-
* });
|
|
1217
|
-
* }
|
|
1218
|
-
*
|
|
1219
|
-
* @remarks
|
|
1220
|
-
* - No required parameters — fetches all available money market assets from backend.
|
|
1221
|
-
* - Uses React Query for caching, retries, and loading/error state management.
|
|
1222
|
-
* - Supports overriding React Query config via `queryOptions`.
|
|
1223
|
-
*/
|
|
1224
|
-
declare const useBackendAllMoneyMarketAssets: (params: UseBackendAllMoneyMarketAssetsParams | undefined) => UseQueryResult<MoneyMarketAsset[], Error>;
|
|
1225
|
-
|
|
1226
|
-
type UseBackendMoneyMarketAssetParams = {
|
|
1227
|
-
params: {
|
|
1228
|
-
reserveAddress: string | undefined;
|
|
1229
|
-
};
|
|
1230
|
-
queryOptions?: UseQueryOptions<MoneyMarketAsset | undefined, Error>;
|
|
1231
|
-
};
|
|
1232
|
-
/**
|
|
1233
|
-
* React hook to fetch a specific money market asset from the backend API.
|
|
1234
|
-
*
|
|
1235
|
-
* @param params - The hook input parameter object (may be undefined):
|
|
1236
|
-
* - `params`: An object containing:
|
|
1237
|
-
* - `reserveAddress` (string | undefined): Reserve contract address to fetch asset details. Disables query if undefined or empty.
|
|
1238
|
-
* - `queryOptions` (optional): React Query options for advanced configuration (e.g. caching, staleTime, retry, etc.).
|
|
1239
|
-
*
|
|
1240
|
-
* @returns A React Query result object: {@link UseQueryResult} for {@link MoneyMarketAsset} or `undefined` on error or if disabled,
|
|
1241
|
-
* including:
|
|
1242
|
-
* - `data`: The money market asset (when available) or `undefined`.
|
|
1243
|
-
* - `isLoading`: Whether the query is running.
|
|
1244
|
-
* - `error`: An error encountered by the query (if any).
|
|
1245
|
-
* - `refetch`: Function to manually refetch the asset.
|
|
1246
|
-
*
|
|
1247
|
-
* @example
|
|
1248
|
-
* const { data: asset, isLoading, error } = useBackendMoneyMarketAsset({
|
|
1249
|
-
* params: { reserveAddress: '0xabc...' },
|
|
1250
|
-
* });
|
|
1251
|
-
* if (isLoading) return <div>Loading asset...</div>;
|
|
1252
|
-
* if (error) return <div>Error: {error.message}</div>;
|
|
1253
|
-
* if (asset) {
|
|
1254
|
-
* console.log('Asset symbol:', asset.symbol);
|
|
1255
|
-
* console.log('Liquidity rate:', asset.liquidityRate);
|
|
1256
|
-
* console.log('Variable borrow rate:', asset.variableBorrowRate);
|
|
1257
|
-
* }
|
|
1258
|
-
*
|
|
1259
|
-
* @remarks
|
|
1260
|
-
* - Query is disabled if `params`, `params.params`, or `params.params.reserveAddress` is missing or empty.
|
|
1261
|
-
* - Uses React Query for caching and background-state management.
|
|
1262
|
-
* - Loading and error handling are managed automatically.
|
|
1263
|
-
*/
|
|
1264
|
-
declare const useBackendMoneyMarketAsset: (params: UseBackendMoneyMarketAssetParams | undefined) => UseQueryResult<MoneyMarketAsset | undefined, Error>;
|
|
1265
|
-
|
|
1266
|
-
type UseBackendMoneyMarketAssetBorrowersParams = {
|
|
1267
|
-
params: {
|
|
1268
|
-
reserveAddress: string | undefined;
|
|
1269
|
-
};
|
|
1270
|
-
pagination: BackendPaginationParams;
|
|
1271
|
-
queryOptions?: UseQueryOptions<MoneyMarketAssetBorrowers | undefined, Error>;
|
|
1272
|
-
};
|
|
1273
|
-
/**
|
|
1274
|
-
* React hook for fetching borrowers for a specific money market asset from the backend API with pagination.
|
|
1275
|
-
*
|
|
1276
|
-
* @param {UseBackendMoneyMarketAssetBorrowersParams | undefined} params - Query parameters:
|
|
1277
|
-
* - `params`: Object containing:
|
|
1278
|
-
* - `reserveAddress`: Reserve contract address for which to fetch borrowers, or `undefined` to disable query.
|
|
1279
|
-
* - `pagination`: Pagination controls with `offset` and `limit` (both required as strings).
|
|
1280
|
-
* - `queryOptions` (optional): React Query options to override defaults (e.g. `staleTime`, `enabled`, etc.).
|
|
1281
|
-
*
|
|
1282
|
-
* @returns {UseQueryResult<MoneyMarketAssetBorrowers | undefined, Error>} React Query result object including:
|
|
1283
|
-
* - `data`: The money market asset borrowers data, or `undefined` if not available.
|
|
1284
|
-
* - `isLoading`: Boolean indicating whether the query is loading.
|
|
1285
|
-
* - `error`: An Error instance if the request failed.
|
|
1286
|
-
* - `refetch`: Function to manually trigger a data refresh.
|
|
1287
|
-
*
|
|
1288
|
-
* @example
|
|
1289
|
-
* const { data: borrowers, isLoading, error } = useBackendMoneyMarketAssetBorrowers({
|
|
1290
|
-
* params: { reserveAddress: '0xabc...' },
|
|
1291
|
-
* pagination: { offset: '0', limit: '20' }
|
|
1292
|
-
* });
|
|
1293
|
-
*
|
|
1294
|
-
* if (isLoading) return <div>Loading borrowers...</div>;
|
|
1295
|
-
* if (error) return <div>Error: {error.message}</div>;
|
|
1296
|
-
* if (borrowers) {
|
|
1297
|
-
* console.log('Total borrowers:', borrowers.total);
|
|
1298
|
-
* console.log('Borrowers:', borrowers.borrowers);
|
|
1299
|
-
* }
|
|
1300
|
-
*
|
|
1301
|
-
* @remarks
|
|
1302
|
-
* - The query is disabled if `reserveAddress`, `offset`, or `limit` are not provided.
|
|
1303
|
-
* - Uses React Query for caching, retries, and auto error/loading management.
|
|
1304
|
-
* - Pagination is handled via `pagination.offset` and `pagination.limit`.
|
|
1305
|
-
*/
|
|
1306
|
-
declare const useBackendMoneyMarketAssetBorrowers: (params: UseBackendMoneyMarketAssetBorrowersParams | undefined) => UseQueryResult<MoneyMarketAssetBorrowers | undefined, Error>;
|
|
1307
|
-
|
|
1308
|
-
type UseBackendMoneyMarketAssetSuppliersParams = {
|
|
1309
|
-
params: {
|
|
1310
|
-
reserveAddress: string | undefined;
|
|
1311
|
-
};
|
|
1312
|
-
pagination: BackendPaginationParams;
|
|
1313
|
-
queryOptions?: UseQueryOptions<MoneyMarketAssetSuppliers | undefined, Error>;
|
|
1314
|
-
};
|
|
1315
|
-
/**
|
|
1316
|
-
* React hook for fetching suppliers for a specific money market asset from the backend API, with pagination support.
|
|
1317
|
-
*
|
|
1318
|
-
* @param {UseBackendMoneyMarketAssetSuppliersParams | undefined} params - Hook parameters:
|
|
1319
|
-
* - `params`: Object containing:
|
|
1320
|
-
* - `reserveAddress`: The reserve contract address to query, or undefined to disable the query.
|
|
1321
|
-
* - `pagination`: Backend pagination controls (`offset` and `limit` as strings).
|
|
1322
|
-
* - `queryOptions` (optional): React Query options to override defaults.
|
|
1323
|
-
*
|
|
1324
|
-
* @returns {UseQueryResult<MoneyMarketAssetSuppliers | undefined, Error>} - Query result object with:
|
|
1325
|
-
* - `data`: The asset suppliers data when available.
|
|
1326
|
-
* - `isLoading`: Indicates if the request is in progress.
|
|
1327
|
-
* - `error`: Error object if the request failed.
|
|
1328
|
-
* - `refetch`: Function to trigger a manual data refresh.
|
|
1329
|
-
*
|
|
1330
|
-
* @example
|
|
1331
|
-
* const { data: suppliers, isLoading, error } = useBackendMoneyMarketAssetSuppliers({
|
|
1332
|
-
* params: { reserveAddress: '0xabc...' },
|
|
1333
|
-
* pagination: { offset: '0', limit: '20' }
|
|
1334
|
-
* });
|
|
1335
|
-
*
|
|
1336
|
-
* if (isLoading) return <div>Loading suppliers...</div>;
|
|
1337
|
-
* if (error) return <div>Error: {error.message}</div>;
|
|
1338
|
-
* if (suppliers) {
|
|
1339
|
-
* console.log('Total suppliers:', suppliers.total);
|
|
1340
|
-
* console.log('Suppliers:', suppliers.suppliers);
|
|
1341
|
-
* }
|
|
1342
|
-
*
|
|
1343
|
-
* @remarks
|
|
1344
|
-
* - The query is disabled if `reserveAddress`, `offset`, or `limit` are not provided.
|
|
1345
|
-
* - Uses React Query for efficient caching, automatic retries, and error/loading handling.
|
|
1346
|
-
* - Pagination is handled via `pagination.offset` and `pagination.limit`.
|
|
1347
|
-
*/
|
|
1348
|
-
declare const useBackendMoneyMarketAssetSuppliers: (params: UseBackendMoneyMarketAssetSuppliersParams | undefined) => UseQueryResult<MoneyMarketAssetSuppliers | undefined, Error>;
|
|
1349
|
-
|
|
1350
|
-
type UseBackendAllMoneyMarketBorrowersParams = {
|
|
1351
|
-
pagination: BackendPaginationParams;
|
|
1352
|
-
queryOptions?: UseQueryOptions<MoneyMarketBorrowers | undefined, Error>;
|
|
1353
|
-
};
|
|
1354
|
-
/**
|
|
1355
|
-
* Hook for fetching all money market borrowers from the backend API.
|
|
1356
|
-
*
|
|
1357
|
-
* This hook provides access to the list of all borrowers across all money market assets,
|
|
1358
|
-
* with pagination support. The data is automatically fetched and cached using React Query.
|
|
1359
|
-
*
|
|
1360
|
-
* @param {Object} params - Pagination parameters for fetching all borrowers
|
|
1361
|
-
* @param {string} params.offset - The offset for pagination (number as string)
|
|
1362
|
-
* @param {string} params.limit - The limit for pagination (number as string)
|
|
1363
|
-
*
|
|
1364
|
-
* @returns {UseQueryResult<MoneyMarketBorrowers | undefined>} A query result object containing:
|
|
1365
|
-
* - data: The all borrowers data when available
|
|
1366
|
-
* - isLoading: Boolean indicating if the request is in progress
|
|
1367
|
-
* - error: Error object if the request failed
|
|
1368
|
-
* - refetch: Function to manually trigger a data refresh
|
|
1369
|
-
*
|
|
1370
|
-
* @example
|
|
1371
|
-
* ```typescript
|
|
1372
|
-
* const { data: borrowers, isLoading, error } = useAllMoneyMarketBorrowers({
|
|
1373
|
-
* offset: '0',
|
|
1374
|
-
* limit: '50'
|
|
1375
|
-
* });
|
|
1376
|
-
*
|
|
1377
|
-
* if (isLoading) return <div>Loading borrowers...</div>;
|
|
1378
|
-
* if (error) return <div>Error: {error.message}</div>;
|
|
1379
|
-
* if (borrowers) {
|
|
1380
|
-
* console.log('Total borrowers:', borrowers.total);
|
|
1381
|
-
* console.log('Borrowers:', borrowers.borrowers);
|
|
1382
|
-
* }
|
|
1383
|
-
* ```
|
|
1384
|
-
*
|
|
1385
|
-
* @remarks
|
|
1386
|
-
* - The query is disabled when params are undefined or invalid
|
|
1387
|
-
* - Uses React Query for efficient caching and state management
|
|
1388
|
-
* - Automatically handles error states and loading indicators
|
|
1389
|
-
* - Supports pagination through offset and limit parameters
|
|
1390
|
-
* - Returns borrowers across all money market assets
|
|
1391
|
-
*/
|
|
1392
|
-
declare const useBackendAllMoneyMarketBorrowers: (params: UseBackendAllMoneyMarketBorrowersParams | undefined) => UseQueryResult<MoneyMarketBorrowers | undefined>;
|
|
1393
|
-
|
|
1394
|
-
/**
|
|
1395
|
-
* Hook for checking token allowance for bridge operations.
|
|
1396
|
-
*
|
|
1397
|
-
* This hook verifies if the user has approved enough tokens for a specific bridge action.
|
|
1398
|
-
* It automatically queries and tracks the allowance status.
|
|
1399
|
-
*
|
|
1400
|
-
* @param {BridgeParams} params - The parameters for the bridge to check allowance for.
|
|
1401
|
-
* @param {SpokeProvider} spokeProvider - The spoke provider to use for allowance checks
|
|
1402
|
-
*
|
|
1403
|
-
* @returns {UseQueryResult<boolean, Error>} A React Query result containing:
|
|
1404
|
-
* - data: Boolean indicating if allowance is sufficient
|
|
1405
|
-
* - isLoading: Loading state indicator
|
|
1406
|
-
* - error: Any error that occurred during the check
|
|
1407
|
-
*
|
|
1408
|
-
* @example
|
|
1409
|
-
* ```typescript
|
|
1410
|
-
* const { data: hasAllowed, isLoading } = useBridgeAllowance(params, spokeProvider);
|
|
1411
|
-
* ```
|
|
1412
|
-
*/
|
|
1413
|
-
declare function useBridgeAllowance(params: CreateBridgeIntentParams | undefined, spokeProvider: SpokeProvider | undefined): UseQueryResult<boolean, Error>;
|
|
1414
|
-
|
|
1415
|
-
interface UseBridgeApproveReturn {
|
|
1416
|
-
approve: (params: CreateBridgeIntentParams) => Promise<boolean>;
|
|
1417
|
-
isLoading: boolean;
|
|
1418
|
-
error: Error | null;
|
|
1419
|
-
resetError: () => void;
|
|
1420
|
-
}
|
|
1421
|
-
/**
|
|
1422
|
-
* Hook for approving token spending for bridge actions
|
|
1423
|
-
* @param spokeProvider The spoke provider instance for the chain
|
|
1424
|
-
* @returns Object containing approve function, loading state, error state and reset function
|
|
1425
|
-
* @example
|
|
1426
|
-
* ```tsx
|
|
1427
|
-
* const { approve, isLoading, error } = useBridgeApprove(spokeProvider);
|
|
1428
|
-
*
|
|
1429
|
-
* // Approve tokens for bridge action
|
|
1430
|
-
* await approve({
|
|
1431
|
-
* srcChainId: '0x2105.base',
|
|
1432
|
-
* srcAsset: '0x...',
|
|
1433
|
-
* amount: 1000n,
|
|
1434
|
-
* dstChainId: '0x89.polygon',
|
|
1435
|
-
* dstAsset: '0x...',
|
|
1436
|
-
* recipient: '0x...'
|
|
1437
|
-
* });
|
|
1438
|
-
* ```
|
|
1439
|
-
*/
|
|
1440
|
-
declare function useBridgeApprove(spokeProvider: SpokeProvider | undefined): UseBridgeApproveReturn;
|
|
1441
|
-
|
|
1442
|
-
/**
|
|
1443
|
-
* Hook for executing bridge transactions to transfer tokens between chains.
|
|
1444
|
-
* Uses React Query's useMutation for better state management and caching.
|
|
1445
|
-
*
|
|
1446
|
-
* @param {SpokeProvider} spokeProvider - The spoke provider to use for the bridge
|
|
1447
|
-
* @returns {UseMutationResult} Mutation result object containing mutation function and state
|
|
1448
|
-
*
|
|
1449
|
-
* @example
|
|
1450
|
-
* ```typescript
|
|
1451
|
-
* const { mutateAsync: bridge, isPending } = useBridge(spokeProvider);
|
|
1452
|
-
*
|
|
1453
|
-
* const handleBridge = async () => {
|
|
1454
|
-
* const result = await bridge({
|
|
1455
|
-
* srcChainId: '0x2105.base',
|
|
1456
|
-
* srcAsset: '0x...',
|
|
1457
|
-
* amount: 1000n,
|
|
1458
|
-
* dstChainId: '0x89.polygon',
|
|
1459
|
-
* dstAsset: '0x...',
|
|
1460
|
-
* recipient: '0x...'
|
|
1461
|
-
* });
|
|
1462
|
-
*
|
|
1463
|
-
* console.log('Bridge transaction hashes:', {
|
|
1464
|
-
* spokeTxHash: result.spokeTxHash,
|
|
1465
|
-
* hubTxHash: result.hubTxHash
|
|
1466
|
-
* });
|
|
1467
|
-
* };
|
|
1468
|
-
* ```
|
|
1469
|
-
*/
|
|
1470
|
-
declare function useBridge(spokeProvider: SpokeProvider | undefined): UseMutationResult<Result<[SpokeTxHash, HubTxHash], BridgeError<BridgeErrorCode>>, Error, CreateBridgeIntentParams>;
|
|
1471
|
-
|
|
1472
|
-
/**
|
|
1473
|
-
* Hook for getting the amount available to be bridged.
|
|
1474
|
-
*
|
|
1475
|
-
* This hook is used to check if a target chain has enough balance to bridge when bridging.
|
|
1476
|
-
* It automatically queries and tracks the available amount to be bridged.
|
|
1477
|
-
*
|
|
1478
|
-
* @param {SpokeChainId | undefined} chainId - The chain ID to get the balance for
|
|
1479
|
-
* @param {string | undefined} token - The token address to get the balance for
|
|
1480
|
-
*
|
|
1481
|
-
* @returns {UseQueryResult<BridgeLimit, Error>} A React Query result containing:
|
|
1482
|
-
* - data: Data about available amount to be bridged
|
|
1483
|
-
* - error: Any error that occurred during the check
|
|
1484
|
-
*
|
|
1485
|
-
* @example
|
|
1486
|
-
* ```typescript
|
|
1487
|
-
* const { data: balance, isLoading } = useSpokeAssetManagerTokenBalance(chainId, tokenAddress);
|
|
1488
|
-
*
|
|
1489
|
-
* if (balance) {
|
|
1490
|
-
* console.log('Asset manager token balance:', balance.toString());
|
|
1491
|
-
* }
|
|
1492
|
-
* ```
|
|
1493
|
-
*/
|
|
1494
|
-
declare function useGetBridgeableAmount(from: XToken | undefined, to: XToken | undefined): UseQueryResult<BridgeLimit, Error>;
|
|
1495
|
-
|
|
1496
|
-
/**
|
|
1497
|
-
/**
|
|
1498
|
-
* Hook for retrieving all bridgeable tokens from a source token on one chain to a destination chain.
|
|
1499
|
-
*
|
|
1500
|
-
* This hook queries and tracks the set of tokens on the destination chain that can be bridged to,
|
|
1501
|
-
* given a source chain, destination chain, and source token address.
|
|
1502
|
-
*
|
|
1503
|
-
* @param {SpokeChainId | undefined} from - The source chain ID
|
|
1504
|
-
* @param {SpokeChainId | undefined} to - The destination chain ID
|
|
1505
|
-
* @param {string | undefined} token - The source token address
|
|
1506
|
-
*
|
|
1507
|
-
* @returns {UseQueryResult<XToken[], Error>} A React Query result containing:
|
|
1508
|
-
* - data: Array of bridgeable tokens (XToken[]) on the destination chain
|
|
1509
|
-
* - error: Any error that occurred during the query
|
|
1510
|
-
*
|
|
1511
|
-
*
|
|
1512
|
-
* @example
|
|
1513
|
-
* ```typescript
|
|
1514
|
-
* const { data: bridgeableTokens, isLoading } = useGetBridgeableTokens(
|
|
1515
|
-
* fromChainId,
|
|
1516
|
-
* toChainId,
|
|
1517
|
-
* fromTokenAddress
|
|
1518
|
-
* );
|
|
1519
|
-
*
|
|
1520
|
-
* if (bridgeableTokens && bridgeableTokens.length > 0) {
|
|
1521
|
-
* bridgeableTokens.forEach(token => {
|
|
1522
|
-
* console.log(`Bridgeable token: ${token.symbol} (${token.address}) on chain ${token.xChainId}`);
|
|
1523
|
-
* });
|
|
1524
|
-
* } else {
|
|
1525
|
-
* console.log('No bridgeable tokens found for the selected route.');
|
|
1526
|
-
* }
|
|
1527
|
-
* ```
|
|
1528
|
-
*/
|
|
1529
|
-
declare function useGetBridgeableTokens(from: SpokeChainId | undefined, to: SpokeChainId | undefined, token: string | undefined): UseQueryResult<XToken[], Error>;
|
|
1530
|
-
|
|
1531
|
-
/**
|
|
1532
|
-
* Hook for executing stake transactions to stake SODA tokens and receive xSODA shares.
|
|
1533
|
-
* Uses React Query's useMutation for better state management and caching.
|
|
1534
|
-
*
|
|
1535
|
-
* @param {SpokeProvider | undefined} spokeProvider - The spoke provider to use for the stake
|
|
1536
|
-
* @returns {UseMutationResult<[SpokeTxHash, HubTxHash], Error, StakeParams>} Mutation result object containing mutation function and state
|
|
1537
|
-
*
|
|
1538
|
-
* @example
|
|
1539
|
-
* ```typescript
|
|
1540
|
-
* const { mutateAsync: stake, isPending } = useStake(spokeProvider);
|
|
1541
|
-
*
|
|
1542
|
-
* const handleStake = async () => {
|
|
1543
|
-
* const result = await stake({
|
|
1544
|
-
* amount: 1000000000000000000n, // 1 SODA
|
|
1545
|
-
* account: '0x...'
|
|
1546
|
-
* });
|
|
1547
|
-
*
|
|
1548
|
-
* console.log('Stake successful:', result);
|
|
1549
|
-
* };
|
|
1550
|
-
* ```
|
|
1551
|
-
*/
|
|
1552
|
-
declare function useStake(spokeProvider: SpokeProvider | undefined): UseMutationResult<[SpokeTxHash, HubTxHash], Error, StakeParams>;
|
|
1553
|
-
|
|
1554
|
-
/**
|
|
1555
|
-
* Hook for approving SODA token spending for staking operations.
|
|
1556
|
-
* Uses React Query's useMutation for better state management and caching.
|
|
1557
|
-
*
|
|
1558
|
-
* @param {SpokeProvider | undefined} spokeProvider - The spoke provider to use for the approval
|
|
1559
|
-
* @returns {UseMutationResult<TxReturnType<SpokeProvider, false>, Error, Omit<StakeParams, 'action'>>} Mutation result object containing mutation function and state
|
|
1560
|
-
*
|
|
1561
|
-
* @example
|
|
1562
|
-
* ```typescript
|
|
1563
|
-
* const { mutateAsync: approve, isPending } = useStakeApprove(spokeProvider);
|
|
1564
|
-
*
|
|
1565
|
-
* const handleApprove = async () => {
|
|
1566
|
-
* const result = await approve({
|
|
1567
|
-
* amount: 1000000000000000000n, // 1 SODA
|
|
1568
|
-
* account: '0x...'
|
|
1569
|
-
* });
|
|
1570
|
-
*
|
|
1571
|
-
* console.log('Approval successful:', result);
|
|
1572
|
-
* };
|
|
1573
|
-
* ```
|
|
1574
|
-
*/
|
|
1575
|
-
declare function useStakeApprove(spokeProvider: SpokeProvider | undefined): UseMutationResult<TxReturnType<SpokeProvider, false>, Error, Omit<StakeParams, 'action'>>;
|
|
1576
|
-
|
|
1577
|
-
/**
|
|
1578
|
-
* Hook for checking SODA token allowance for staking operations.
|
|
1579
|
-
* Uses React Query for efficient caching and state management.
|
|
1580
|
-
*
|
|
1581
|
-
* @param {Omit<StakeParams, 'action'> | undefined} params - The staking parameters. If undefined, the query will be disabled.
|
|
1582
|
-
* @param {SpokeProvider | undefined} spokeProvider - The spoke provider to use for the allowance check
|
|
1583
|
-
* @returns {UseQueryResult<boolean, Error>} Query result object containing allowance data and state
|
|
1584
|
-
*
|
|
1585
|
-
* @example
|
|
1586
|
-
* ```typescript
|
|
1587
|
-
* const { data: hasAllowed, isLoading } = useStakeAllowance(
|
|
1588
|
-
* {
|
|
1589
|
-
* amount: 1000000000000000000n, // 1 SODA
|
|
1590
|
-
* account: '0x...'
|
|
1591
|
-
* },
|
|
1592
|
-
* spokeProvider
|
|
1593
|
-
* );
|
|
1594
|
-
*
|
|
1595
|
-
* if (isLoading) return <div>Checking allowance...</div>;
|
|
1596
|
-
* if (hasAllowed) {
|
|
1597
|
-
* console.log('Sufficient allowance for staking');
|
|
1598
|
-
* }
|
|
1599
|
-
* ```
|
|
1600
|
-
*/
|
|
1601
|
-
declare function useStakeAllowance(params: Omit<StakeParams, 'action'> | undefined, spokeProvider: SpokeProvider | undefined): UseQueryResult<boolean, Error>;
|
|
1602
|
-
|
|
1603
|
-
/**
|
|
1604
|
-
* Hook for executing unstake transactions to unstake xSODA shares.
|
|
1605
|
-
* Uses React Query's useMutation for better state management and caching.
|
|
1606
|
-
*
|
|
1607
|
-
* @param {SpokeProvider | undefined} spokeProvider - The spoke provider to use for the unstake
|
|
1608
|
-
* @returns {UseMutationResult<[SpokeTxHash, HubTxHash], Error, Omit<UnstakeParams, 'action'>>} Mutation result object containing mutation function and state
|
|
1609
|
-
*
|
|
1610
|
-
* @example
|
|
1611
|
-
* ```typescript
|
|
1612
|
-
* const { mutateAsync: unstake, isPending } = useUnstake(spokeProvider);
|
|
1613
|
-
*
|
|
1614
|
-
* const handleUnstake = async () => {
|
|
1615
|
-
* const result = await unstake({
|
|
1616
|
-
* amount: 1000000000000000000n, // 1 xSODA
|
|
1617
|
-
* account: '0x...'
|
|
1618
|
-
* });
|
|
1619
|
-
*
|
|
1620
|
-
* console.log('Unstake successful:', result);
|
|
1621
|
-
* };
|
|
1622
|
-
* ```
|
|
1623
|
-
*/
|
|
1624
|
-
declare function useUnstake(spokeProvider: SpokeProvider | undefined): UseMutationResult<[SpokeTxHash, HubTxHash], Error, Omit<UnstakeParams, 'action'>>;
|
|
1625
|
-
|
|
1626
|
-
/**
|
|
1627
|
-
* Hook for executing claim transactions to claim unstaked SODA tokens after the unstaking period.
|
|
1628
|
-
* Uses React Query's useMutation for better state management and caching.
|
|
1629
|
-
*
|
|
1630
|
-
* @param {SpokeProvider | undefined} spokeProvider - The spoke provider to use for the claim
|
|
1631
|
-
* @returns {UseMutationResult<[SpokeTxHash, HubTxHash], Error, Omit<ClaimParams, 'action'>>} Mutation result object containing mutation function and state
|
|
1632
|
-
*
|
|
1633
|
-
* @example
|
|
1634
|
-
* ```typescript
|
|
1635
|
-
* const { mutateAsync: claim, isPending } = useClaim(spokeProvider);
|
|
1636
|
-
*
|
|
1637
|
-
* const handleClaim = async () => {
|
|
1638
|
-
* const result = await claim({
|
|
1639
|
-
* requestId: 1n
|
|
1640
|
-
* });
|
|
1641
|
-
*
|
|
1642
|
-
* console.log('Claim successful:', result);
|
|
1643
|
-
* };
|
|
1644
|
-
* ```
|
|
1645
|
-
*/
|
|
1646
|
-
declare function useClaim(spokeProvider: SpokeProvider | undefined): UseMutationResult<[SpokeTxHash, HubTxHash], Error, Omit<ClaimParams, 'action'>>;
|
|
1647
|
-
|
|
1648
|
-
/**
|
|
1649
|
-
* Hook for executing cancel unstake transactions to cancel pending unstake requests.
|
|
1650
|
-
* Uses React Query's useMutation for better state management and caching.
|
|
1651
|
-
*
|
|
1652
|
-
* @param {SpokeProvider | undefined} spokeProvider - The spoke provider to use for the cancel unstake
|
|
1653
|
-
* @returns {UseMutationResult<[SpokeTxHash, HubTxHash], Error, Omit<CancelUnstakeParams, 'action'>>} Mutation result object containing mutation function and state
|
|
1654
|
-
*
|
|
1655
|
-
* @example
|
|
1656
|
-
* ```typescript
|
|
1657
|
-
* const { mutateAsync: cancelUnstake, isPending } = useCancelUnstake(spokeProvider);
|
|
1658
|
-
*
|
|
1659
|
-
* const handleCancelUnstake = async () => {
|
|
1660
|
-
* const result = await cancelUnstake({
|
|
1661
|
-
* requestId: 1n
|
|
1662
|
-
* });
|
|
1663
|
-
*
|
|
1664
|
-
* console.log('Cancel unstake successful:', result);
|
|
1665
|
-
* };
|
|
1666
|
-
* ```
|
|
1667
|
-
*/
|
|
1668
|
-
declare function useCancelUnstake(spokeProvider: SpokeProvider | undefined): UseMutationResult<[SpokeTxHash, HubTxHash], Error, Omit<CancelUnstakeParams, 'action'>>;
|
|
1669
|
-
|
|
1670
|
-
/**
|
|
1671
|
-
* Hook for fetching comprehensive staking information for a user.
|
|
1672
|
-
* Uses React Query for efficient caching and state management.
|
|
1673
|
-
*
|
|
1674
|
-
* @param {SpokeProvider | undefined} spokeProvider - The spoke provider to use for the query
|
|
1675
|
-
* @param {number} refetchInterval - The interval in milliseconds to refetch data (default: 5000)
|
|
1676
|
-
* @returns {UseQueryResult<StakingInfo, Error>} Query result object containing staking info and state
|
|
1677
|
-
*
|
|
1678
|
-
* @example
|
|
1679
|
-
* ```typescript
|
|
1680
|
-
* const { data: stakingInfo, isLoading, error } = useStakingInfo(spokeProvider);
|
|
1681
|
-
*
|
|
1682
|
-
* if (isLoading) return <div>Loading staking info...</div>;
|
|
1683
|
-
* if (stakingInfo) {
|
|
1684
|
-
* console.log('Total staked:', stakingInfo.totalStaked);
|
|
1685
|
-
* console.log('User staked:', stakingInfo.userStaked);
|
|
1686
|
-
* console.log('xSODA balance:', stakingInfo.userXSodaBalance);
|
|
1687
|
-
* }
|
|
1688
|
-
* ```
|
|
1689
|
-
*/
|
|
1690
|
-
declare function useStakingInfo(spokeProvider: SpokeProvider | undefined, refetchInterval?: number): UseQueryResult<StakingInfo, Error>;
|
|
1691
|
-
|
|
1692
|
-
type UnstakingInfoWithPenalty = UnstakingInfo & {
|
|
1693
|
-
requestsWithPenalty: UnstakeRequestWithPenalty[];
|
|
1694
|
-
};
|
|
1695
|
-
/**
|
|
1696
|
-
* Hook for fetching unstaking information with penalty calculations from the stakedSoda contract.
|
|
1697
|
-
* Uses React Query for efficient caching and state management.
|
|
1698
|
-
*
|
|
1699
|
-
* @param {string | undefined} userAddress - The user address to fetch unstaking info for
|
|
1700
|
-
* @param {SpokeProvider | undefined} spokeProvider - The spoke provider instance
|
|
1701
|
-
* @param {number} refetchInterval - The interval in milliseconds to refetch data (default: 5000)
|
|
1702
|
-
* @returns {UseQueryResult<UnstakingInfoWithPenalty, Error>} Query result object containing unstaking info with penalties and state
|
|
1703
|
-
*
|
|
1704
|
-
* @example
|
|
1705
|
-
* ```typescript
|
|
1706
|
-
* const { data: unstakingInfo, isLoading, error } = useUnstakingInfoWithPenalty(userAddress, spokeProvider);
|
|
1707
|
-
*
|
|
1708
|
-
* if (isLoading) return <div>Loading unstaking info...</div>;
|
|
1709
|
-
* if (unstakingInfo) {
|
|
1710
|
-
* console.log('Total unstaking:', unstakingInfo.totalUnstaking);
|
|
1711
|
-
* unstakingInfo.requestsWithPenalty.forEach(request => {
|
|
1712
|
-
* console.log('Penalty:', request.penaltyPercentage + '%');
|
|
1713
|
-
* console.log('Claimable amount:', request.claimableAmount);
|
|
1714
|
-
* });
|
|
1715
|
-
* }
|
|
1716
|
-
* ```
|
|
1717
|
-
*/
|
|
1718
|
-
declare function useUnstakingInfoWithPenalty(userAddress: string | undefined, spokeProvider: SpokeProvider | undefined, refetchInterval?: number): UseQueryResult<UnstakingInfoWithPenalty, Error>;
|
|
1719
|
-
|
|
1720
|
-
/**
|
|
1721
|
-
* Hook for fetching staking configuration from the stakedSoda contract.
|
|
1722
|
-
* Uses React Query for efficient caching and state management.
|
|
1723
|
-
*
|
|
1724
|
-
* @param {number} refetchInterval - The interval in milliseconds to refetch data (default: 30000)
|
|
1725
|
-
* @returns {UseQueryResult<StakingConfig, Error>} Query result object containing staking config and state
|
|
1726
|
-
*
|
|
1727
|
-
* @example
|
|
1728
|
-
* ```typescript
|
|
1729
|
-
* const { data: stakingConfig, isLoading, error } = useStakingConfig();
|
|
1730
|
-
*
|
|
1731
|
-
* if (isLoading) return <div>Loading staking config...</div>;
|
|
1732
|
-
* if (stakingConfig) {
|
|
1733
|
-
* console.log('Unstaking period (days):', stakingConfig.unstakingPeriod / 86400n);
|
|
1734
|
-
* console.log('Max penalty (%):', stakingConfig.maxPenalty);
|
|
1735
|
-
* }
|
|
1736
|
-
* ```
|
|
1737
|
-
*/
|
|
1738
|
-
declare function useStakingConfig(refetchInterval?: number): UseQueryResult<StakingConfig, Error>;
|
|
1739
|
-
|
|
1740
|
-
/**
|
|
1741
|
-
* Hook for fetching stake ratio estimates (xSoda amount and preview deposit).
|
|
1742
|
-
* Uses React Query for efficient caching and state management.
|
|
1743
|
-
*
|
|
1744
|
-
* @param {bigint | undefined} amount - The amount of SODA to estimate stake for
|
|
1745
|
-
* @param {number} refetchInterval - The interval in milliseconds to refetch data (default: 10000)
|
|
1746
|
-
* @returns {UseQueryResult<[bigint, bigint], Error>} Query result object containing stake ratio estimates and state
|
|
1747
|
-
*
|
|
1748
|
-
* @example
|
|
1749
|
-
* ```typescript
|
|
1750
|
-
* const { data: stakeRatio, isLoading, error } = useStakeRatio(1000000000000000000n); // 1 SODA
|
|
1751
|
-
*
|
|
1752
|
-
* if (isLoading) return <div>Loading stake ratio...</div>;
|
|
1753
|
-
* if (stakeRatio) {
|
|
1754
|
-
* const [xSodaAmount, previewDepositAmount] = stakeRatio;
|
|
1755
|
-
* console.log('xSoda amount:', xSodaAmount);
|
|
1756
|
-
* console.log('Preview deposit:', previewDepositAmount);
|
|
1757
|
-
* }
|
|
1758
|
-
* ```
|
|
1759
|
-
*/
|
|
1760
|
-
declare function useStakeRatio(amount: bigint | undefined, refetchInterval?: number): UseQueryResult<[bigint, bigint], Error>;
|
|
1761
|
-
|
|
1762
|
-
/**
|
|
1763
|
-
* Hook for fetching instant unstake ratio estimates.
|
|
1764
|
-
* Uses React Query for efficient caching and state management.
|
|
1765
|
-
*
|
|
1766
|
-
* @param {bigint | undefined} amount - The amount of xSoda to estimate instant unstake for
|
|
1767
|
-
* @param {number} refetchInterval - The interval in milliseconds to refetch data (default: 10000)
|
|
1768
|
-
* @returns {UseQueryResult<bigint, Error>} Query result object containing instant unstake ratio and state
|
|
1769
|
-
*
|
|
1770
|
-
* @example
|
|
1771
|
-
* ```typescript
|
|
1772
|
-
* const { data: instantUnstakeRatio, isLoading, error } = useInstantUnstakeRatio(1000000000000000000n); // 1 xSoda
|
|
1773
|
-
*
|
|
1774
|
-
* if (isLoading) return <div>Loading instant unstake ratio...</div>;
|
|
1775
|
-
* if (instantUnstakeRatio) {
|
|
1776
|
-
* console.log('Instant unstake ratio:', instantUnstakeRatio);
|
|
1777
|
-
* }
|
|
1778
|
-
* ```
|
|
1779
|
-
*/
|
|
1780
|
-
declare function useInstantUnstakeRatio(amount: bigint | undefined, refetchInterval?: number): UseQueryResult<bigint, Error>;
|
|
1781
|
-
|
|
1782
|
-
/**
|
|
1783
|
-
* Hook for fetching converted assets amount for xSODA shares.
|
|
1784
|
-
* Uses React Query for efficient caching and state management.
|
|
1785
|
-
*
|
|
1786
|
-
* @param {bigint | undefined} amount - The amount of xSODA shares to convert
|
|
1787
|
-
* @param {number} refetchInterval - The interval in milliseconds to refetch data (default: 10000)
|
|
1788
|
-
* @returns {UseQueryResult<bigint, Error>} Query result object containing converted assets amount and state
|
|
1789
|
-
*
|
|
1790
|
-
* @example
|
|
1791
|
-
* ```typescript
|
|
1792
|
-
* const { data: convertedAssets, isLoading, error } = useConvertedAssets(1000000000000000000n); // 1 xSODA
|
|
1793
|
-
*
|
|
1794
|
-
* if (isLoading) return <div>Loading converted assets...</div>;
|
|
1795
|
-
* if (convertedAssets) {
|
|
1796
|
-
* console.log('Converted assets:', convertedAssets);
|
|
1797
|
-
* }
|
|
1798
|
-
* ```
|
|
1799
|
-
*/
|
|
1800
|
-
declare function useConvertedAssets(amount: bigint | undefined, refetchInterval?: number): UseQueryResult<bigint, Error>;
|
|
1801
|
-
|
|
1802
|
-
/**
|
|
1803
|
-
* Hook for executing instant unstake operations.
|
|
1804
|
-
* Uses React Query for efficient state management and error handling.
|
|
1805
|
-
*
|
|
1806
|
-
* @param {SpokeProvider | undefined} spokeProvider - The spoke provider for the transaction
|
|
1807
|
-
* @returns {UseMutationResult<[string, string], Error, Omit<InstantUnstakeParams, 'action'>>} Mutation result object containing instant unstake state and methods
|
|
1808
|
-
*
|
|
1809
|
-
* @example
|
|
1810
|
-
* ```typescript
|
|
1811
|
-
* const { mutateAsync: instantUnstake, isPending } = useInstantUnstake(spokeProvider);
|
|
1812
|
-
*
|
|
1813
|
-
* const handleInstantUnstake = async () => {
|
|
1814
|
-
* const result = await instantUnstake({
|
|
1815
|
-
* amount: 1000000000000000000n,
|
|
1816
|
-
* minAmount: 950000000000000000n,
|
|
1817
|
-
* account: '0x...'
|
|
1818
|
-
* });
|
|
1819
|
-
* console.log('Instant unstake successful:', result);
|
|
1820
|
-
* };
|
|
1821
|
-
* ```
|
|
1822
|
-
*/
|
|
1823
|
-
declare function useInstantUnstake(spokeProvider: SpokeProvider | undefined): UseMutationResult<[string, string], Error, Omit<InstantUnstakeParams, 'action'>>;
|
|
1824
|
-
|
|
1825
|
-
/**
|
|
1826
|
-
* Hook for checking xSODA token allowance for unstaking operations.
|
|
1827
|
-
* Uses React Query for efficient caching and state management.
|
|
1828
|
-
*
|
|
1829
|
-
* @param {Omit<UnstakeParams, 'action'> | undefined} params - The unstaking parameters. If undefined, the query will be disabled.
|
|
1830
|
-
* @param {SpokeProvider | undefined} spokeProvider - The spoke provider to use for the allowance check
|
|
1831
|
-
* @returns {UseQueryResult<boolean, Error>} Query result object containing allowance data and state
|
|
1832
|
-
*
|
|
1833
|
-
* @example
|
|
1834
|
-
* ```typescript
|
|
1835
|
-
* const { data: hasAllowed, isLoading } = useUnstakeAllowance(
|
|
1836
|
-
* {
|
|
1837
|
-
* amount: 1000000000000000000n, // 1 xSODA
|
|
1838
|
-
* account: '0x...'
|
|
1839
|
-
* },
|
|
1840
|
-
* spokeProvider
|
|
1841
|
-
* );
|
|
1842
|
-
*
|
|
1843
|
-
* if (isLoading) return <div>Checking allowance...</div>;
|
|
1844
|
-
* if (hasAllowed) {
|
|
1845
|
-
* console.log('Sufficient allowance for unstaking');
|
|
1846
|
-
* }
|
|
1847
|
-
* ```
|
|
1848
|
-
*/
|
|
1849
|
-
declare function useUnstakeAllowance(params: Omit<UnstakeParams, 'action'> | undefined, spokeProvider: SpokeProvider | undefined): UseQueryResult<boolean, Error>;
|
|
1850
|
-
|
|
1851
|
-
/**
|
|
1852
|
-
* Hook for approving xSODA token spending for unstaking operations.
|
|
1853
|
-
* Uses React Query's useMutation for better state management and caching.
|
|
1854
|
-
*
|
|
1855
|
-
* @param {SpokeProvider | undefined} spokeProvider - The spoke provider to use for the approval
|
|
1856
|
-
* @returns {UseMutationResult<TxReturnType<SpokeProvider, false>, Error, Omit<UnstakeParams, 'action'>>} Mutation result object containing mutation function and state
|
|
1857
|
-
*
|
|
1858
|
-
* @example
|
|
1859
|
-
* ```typescript
|
|
1860
|
-
* const { mutateAsync: approve, isPending } = useUnstakeApprove(spokeProvider);
|
|
1861
|
-
*
|
|
1862
|
-
* const handleApprove = async () => {
|
|
1863
|
-
* const result = await approve({
|
|
1864
|
-
* amount: 1000000000000000000n, // 1 xSODA
|
|
1865
|
-
* account: '0x...'
|
|
1866
|
-
* });
|
|
1867
|
-
*
|
|
1868
|
-
* console.log('Approval successful:', result);
|
|
1869
|
-
* };
|
|
1870
|
-
* ```
|
|
1871
|
-
*/
|
|
1872
|
-
declare function useUnstakeApprove(spokeProvider: SpokeProvider | undefined): UseMutationResult<TxReturnType<SpokeProvider, false>, Error, Omit<UnstakeParams, 'action'>>;
|
|
1873
|
-
|
|
1874
|
-
/**
|
|
1875
|
-
* Hook for fetching unstaking information from the stakedSoda contract.
|
|
1876
|
-
* Uses React Query for efficient caching and state management.
|
|
1877
|
-
*
|
|
1878
|
-
* @param {string | undefined} userAddress - The user address to fetch unstaking info for
|
|
1879
|
-
* @param {SpokeProvider | undefined} spokeProvider - The spoke provider instance
|
|
1880
|
-
* @param {number} refetchInterval - The interval in milliseconds to refetch data (default: 5000)
|
|
1881
|
-
* @returns {UseQueryResult<UnstakingInfo, Error>} Query result object containing unstaking info and state
|
|
1882
|
-
*
|
|
1883
|
-
* @example
|
|
1884
|
-
* ```typescript
|
|
1885
|
-
* const { data: unstakingInfo, isLoading, error } = useUnstakingInfo(userAddress, spokeProvider);
|
|
1886
|
-
*
|
|
1887
|
-
* if (isLoading) return <div>Loading unstaking info...</div>;
|
|
1888
|
-
* if (unstakingInfo) {
|
|
1889
|
-
* console.log('Total unstaking:', unstakingInfo.totalUnstaking);
|
|
1890
|
-
* unstakingInfo.userUnstakeSodaRequests.forEach(request => {
|
|
1891
|
-
* console.log('Request amount:', request.request.amount);
|
|
1892
|
-
* });
|
|
1893
|
-
* }
|
|
1894
|
-
* ```
|
|
1895
|
-
*/
|
|
1896
|
-
declare function useUnstakingInfo(userAddress: string | undefined, spokeProvider: SpokeProvider | undefined, refetchInterval?: number): UseQueryResult<UnstakingInfo, Error>;
|
|
1897
|
-
|
|
1898
|
-
/**
|
|
1899
|
-
* Hook for approving xSODA token spending for instant unstaking operations.
|
|
1900
|
-
* Uses React Query's useMutation for better state management and caching.
|
|
1901
|
-
*
|
|
1902
|
-
* @param {SpokeProvider | undefined} spokeProvider - The spoke provider to use for the approval
|
|
1903
|
-
* @returns {UseMutationResult<TxReturnType<SpokeProvider, false>, Error, Omit<InstantUnstakeParams, 'action'>>} Mutation result object containing mutation function and state
|
|
1904
|
-
*
|
|
1905
|
-
* @example
|
|
1906
|
-
* ```typescript
|
|
1907
|
-
* const { mutateAsync: approve, isPending } = useInstantUnstakeApprove(spokeProvider);
|
|
1908
|
-
*
|
|
1909
|
-
* const handleApprove = async () => {
|
|
1910
|
-
* const result = await approve({
|
|
1911
|
-
* amount: 1000000000000000000n, // 1 xSODA
|
|
1912
|
-
* minAmount: 950000000000000000n, // 0.95 SODA
|
|
1913
|
-
* account: '0x...'
|
|
1914
|
-
* });
|
|
1915
|
-
*
|
|
1916
|
-
* console.log('Approval successful:', result);
|
|
1917
|
-
* };
|
|
1918
|
-
* ```
|
|
1919
|
-
*/
|
|
1920
|
-
declare function useInstantUnstakeApprove(spokeProvider: SpokeProvider | undefined): UseMutationResult<TxReturnType<SpokeProvider, false>, Error, Omit<InstantUnstakeParams, 'action'>>;
|
|
1921
|
-
|
|
1922
|
-
/**
|
|
1923
|
-
* Hook for checking xSODA token allowance for instant unstaking operations.
|
|
1924
|
-
* Uses React Query for efficient caching and state management.
|
|
1925
|
-
*
|
|
1926
|
-
* @param {Omit<InstantUnstakeParams, 'action'> | undefined} params - The instant unstaking parameters. If undefined, the query will be disabled.
|
|
1927
|
-
* @param {SpokeProvider | undefined} spokeProvider - The spoke provider to use for the allowance check
|
|
1928
|
-
* @returns {UseQueryResult<boolean, Error>} Query result object containing allowance data and state
|
|
1929
|
-
*
|
|
1930
|
-
* @example
|
|
1931
|
-
* ```typescript
|
|
1932
|
-
* const { data: hasAllowed, isLoading } = useInstantUnstakeAllowance(
|
|
1933
|
-
* {
|
|
1934
|
-
* amount: 1000000000000000000n, // 1 xSODA
|
|
1935
|
-
* minAmount: 950000000000000000n, // 0.95 SODA
|
|
1936
|
-
* account: '0x...'
|
|
1937
|
-
* },
|
|
1938
|
-
* spokeProvider
|
|
1939
|
-
* );
|
|
1940
|
-
*
|
|
1941
|
-
* if (isLoading) return <div>Checking allowance...</div>;
|
|
1942
|
-
* if (hasAllowed) {
|
|
1943
|
-
* console.log('Sufficient allowance for instant unstaking');
|
|
1944
|
-
* }
|
|
1945
|
-
* ```
|
|
1946
|
-
*/
|
|
1947
|
-
declare function useInstantUnstakeAllowance(params: Omit<InstantUnstakeParams, 'action'> | undefined, spokeProvider: SpokeProvider | undefined): UseQueryResult<boolean, Error>;
|
|
1948
|
-
|
|
1949
|
-
declare const MIGRATION_MODE_ICX_SODA = "icxsoda";
|
|
1950
|
-
declare const MIGRATION_MODE_BNUSD = "bnusd";
|
|
1951
|
-
type MigrationMode = typeof MIGRATION_MODE_ICX_SODA | typeof MIGRATION_MODE_BNUSD;
|
|
1952
|
-
interface MigrationIntentParams {
|
|
1953
|
-
token: XToken$1 | undefined;
|
|
1954
|
-
amount: string | undefined;
|
|
1955
|
-
sourceAddress: string | undefined;
|
|
1956
|
-
migrationMode?: MigrationMode;
|
|
1957
|
-
toToken?: XToken$1;
|
|
1958
|
-
destinationAddress?: string;
|
|
1959
|
-
}
|
|
1960
|
-
|
|
1961
|
-
/**
|
|
1962
|
-
* Hook for executing migration operations between chains.
|
|
1963
|
-
*
|
|
1964
|
-
* This hook handles ICX/SODA and bnUSD migrations by accepting a spoke provider
|
|
1965
|
-
* and returning a mutation function that accepts migration parameters.
|
|
1966
|
-
*
|
|
1967
|
-
* @param {SpokeProvider} spokeProvider - The spoke provider to use for the migration
|
|
1968
|
-
* @returns {UseMutationResult} Mutation result object containing migration function and state
|
|
1969
|
-
*
|
|
1970
|
-
* @example
|
|
1971
|
-
* ```typescript
|
|
1972
|
-
* const { mutateAsync: migrate, isPending } = useMigrate(spokeProvider);
|
|
1973
|
-
*
|
|
1974
|
-
* const result = await migrate({
|
|
1975
|
-
* token: { address: "0x...", decimals: 18 },
|
|
1976
|
-
* amount: "100",
|
|
1977
|
-
* migrationMode: MIGRATION_MODE_ICX_SODA,
|
|
1978
|
-
* toToken: { address: "0x...", decimals: 18 },
|
|
1979
|
-
* destinationAddress: "0x..."
|
|
1980
|
-
* });
|
|
1981
|
-
* ```
|
|
1982
|
-
*/
|
|
1983
|
-
declare function useMigrate(spokeProvider: SpokeProvider | undefined): UseMutationResult<{
|
|
1984
|
-
spokeTxHash: string;
|
|
1985
|
-
hubTxHash: `0x${string}`;
|
|
1986
|
-
}, Error, MigrationIntentParams>;
|
|
1987
|
-
|
|
1988
|
-
/**
|
|
1989
|
-
* Hook for checking token allowance for migration operations.
|
|
1990
|
-
*
|
|
1991
|
-
* This hook verifies if the user has approved enough tokens for migration operations.
|
|
1992
|
-
* It handles both ICX/SODA and bnUSD migration allowance checks.
|
|
1993
|
-
*
|
|
1994
|
-
* @param {MigrationIntentParams} params - The parameters for the migration allowance check
|
|
1995
|
-
* @param {SpokeProvider} spokeProvider - The spoke provider to use for allowance checks
|
|
1996
|
-
*
|
|
1997
|
-
* @returns {UseQueryResult<boolean, Error>} A React Query result containing:
|
|
1998
|
-
* - data: Boolean indicating if allowance is sufficient
|
|
1999
|
-
* - isLoading: Loading state indicator
|
|
2000
|
-
* - error: Any error that occurred during the check
|
|
2001
|
-
*
|
|
2002
|
-
* @example
|
|
2003
|
-
* ```typescript
|
|
2004
|
-
* const { data: hasAllowed, isLoading } = useMigrationAllowance(params, spokeProvider);
|
|
2005
|
-
* ```
|
|
2006
|
-
*/
|
|
2007
|
-
declare function useMigrationAllowance(params: MigrationIntentParams | undefined, spokeProvider: SpokeProvider | undefined): UseQueryResult<boolean, Error>;
|
|
2008
|
-
|
|
2009
|
-
interface UseApproveReturn {
|
|
2010
|
-
approve: ({ params }: {
|
|
2011
|
-
params: MigrationIntentParams;
|
|
2012
|
-
}) => Promise<boolean>;
|
|
2013
|
-
isLoading: boolean;
|
|
2014
|
-
error: Error | null;
|
|
2015
|
-
resetError: () => void;
|
|
2016
|
-
isApproved: boolean;
|
|
2017
|
-
}
|
|
2018
|
-
/**
|
|
2019
|
-
* Hook for approving token spending for migration actions
|
|
2020
|
-
* @param params The parameters for the migration approval
|
|
2021
|
-
* @param spokeProvider The spoke provider instance for the chain
|
|
2022
|
-
* @returns Object containing approve function, loading state, error state and reset function
|
|
2023
|
-
* @example
|
|
2024
|
-
* ```tsx
|
|
2025
|
-
* const { approve, isLoading, error } = useMigrationApprove(params, spokeProvider);
|
|
2026
|
-
*
|
|
2027
|
-
* // Approve tokens for migration
|
|
2028
|
-
* await approve({ params });
|
|
2029
|
-
* ```
|
|
2030
|
-
*/
|
|
2031
|
-
declare function useMigrationApprove(params: MigrationIntentParams | undefined, spokeProvider: SpokeProvider | undefined): UseApproveReturn;
|
|
2032
|
-
|
|
2033
|
-
type UsePoolsProps = {
|
|
2034
|
-
/**
|
|
2035
|
-
* Optional react-query QueryObserverOptions for customizing query behavior such as
|
|
2036
|
-
* staleTime, refetchInterval, cacheTime, etc. These are merged with sensible defaults.
|
|
2037
|
-
*/
|
|
2038
|
-
queryOptions?: QueryObserverOptions<PoolKey[], Error>;
|
|
2039
|
-
};
|
|
2040
|
-
/**
|
|
2041
|
-
* Loads and caches the available list of pools from the DEX service's ConcentratedLiquidityService.
|
|
2042
|
-
*
|
|
2043
|
-
* By default, the query result is cached indefinitely (with `staleTime` set to Infinity), reflecting the
|
|
2044
|
-
* assumption that the pools list is mostly static.
|
|
2045
|
-
*
|
|
2046
|
-
* @param params
|
|
2047
|
-
* Optional configuration object:
|
|
2048
|
-
* - queryOptions: Partial QueryObserverOptions for react-query (merged with built-in defaults).
|
|
2049
|
-
*
|
|
2050
|
-
* @returns
|
|
2051
|
-
* A UseQueryResult object from @tanstack/react-query containing:
|
|
2052
|
-
* - `data`: Array of PoolKey objects or undefined if not loaded or errored.
|
|
2053
|
-
* - Status fields: `isLoading`, `isError`, `error`, etc.
|
|
2054
|
-
*
|
|
2055
|
-
* @example
|
|
2056
|
-
* const { data: pools, isLoading, error } = usePools();
|
|
2057
|
-
* if (isLoading) return <div>Loading pools...</div>;
|
|
2058
|
-
* if (error) return <div>Error: {error.message}</div>;
|
|
2059
|
-
* if (pools) pools.forEach((pool, idx) => console.log(pool.id, pool.fee));
|
|
2060
|
-
*/
|
|
2061
|
-
declare function usePools(params?: UsePoolsProps): UseQueryResult<PoolKey[], Error>;
|
|
2062
|
-
|
|
2063
|
-
type UsePoolDataProps = {
|
|
2064
|
-
poolKey: PoolKey | null;
|
|
2065
|
-
enabled?: boolean;
|
|
2066
|
-
queryOptions?: QueryObserverOptions<PoolData, Error>;
|
|
2067
|
-
};
|
|
2068
|
-
/**
|
|
2069
|
-
* React hook to fetch on-chain data for a given DEX pool.
|
|
2070
|
-
*
|
|
2071
|
-
* @param {UsePoolDataProps} props - The props object:
|
|
2072
|
-
* - `poolKey`: PoolKey | null — The unique identifier for the pool to fetch data for. If null, disables the query.
|
|
2073
|
-
* - `enabled`: boolean (optional) — Whether the query is enabled. Defaults to enabled if a poolKey is provided, otherwise false.
|
|
2074
|
-
* - `queryOptions`: QueryObserverOptions<PoolData, Error> (optional) — Additional React Query options (e.g., staleTime, refetchInterval).
|
|
2075
|
-
*
|
|
2076
|
-
* @returns {UseQueryResult<PoolData, Error>} React Query result containing pool data (`data`), loading state (`isLoading`), error (`error`), and status fields.
|
|
2077
|
-
*
|
|
2078
|
-
* @example
|
|
2079
|
-
* ```typescript
|
|
2080
|
-
* const { data: poolData, isLoading, error } = usePoolData({ poolKey });
|
|
2081
|
-
* if (isLoading) return <div>Loading…</div>;
|
|
2082
|
-
* if (error) return <div>Error!</div>;
|
|
2083
|
-
* if (poolData) {
|
|
2084
|
-
* // poolData is available
|
|
2085
|
-
* }
|
|
2086
|
-
* ```
|
|
2087
|
-
*
|
|
2088
|
-
* @remarks
|
|
2089
|
-
* - Refetches pool data every 30 seconds by default, and may be configured via `queryOptions`.
|
|
2090
|
-
* - If `poolKey` is `null`, the query is disabled and no network request is performed.
|
|
2091
|
-
* - Throws an error if `poolKey` is missing when the query is enabled.
|
|
2092
|
-
*/
|
|
2093
|
-
declare function usePoolData({ poolKey, queryOptions, }: UsePoolDataProps): UseQueryResult<PoolData, Error>;
|
|
2094
|
-
|
|
2095
|
-
interface UsePoolBalancesResponse {
|
|
2096
|
-
token0Balance: bigint;
|
|
2097
|
-
token1Balance: bigint;
|
|
2098
|
-
}
|
|
2099
|
-
interface UsePoolBalancesProps {
|
|
2100
|
-
poolData: PoolData | null;
|
|
2101
|
-
poolKey: PoolKey | null;
|
|
2102
|
-
spokeProvider: SpokeProvider | null;
|
|
2103
|
-
enabled?: boolean;
|
|
2104
|
-
queryOptions?: QueryObserverOptions<UsePoolBalancesResponse, Error>;
|
|
2105
|
-
}
|
|
2106
|
-
/**
|
|
2107
|
-
* React hook to query a user's token balances for a DEX pool.
|
|
2108
|
-
*
|
|
2109
|
-
* Given the pool data (with token addresses), the pool's key, and a SpokeProvider,
|
|
2110
|
-
* fetches the user's protocol balances for both token0 and token1 for the specified pool.
|
|
2111
|
-
* Queries are auto-refreshed; advanced options can be customized via `queryOptions`.
|
|
2112
|
-
*
|
|
2113
|
-
* @param {UsePoolBalancesProps} props
|
|
2114
|
-
* Object containing:
|
|
2115
|
-
* - `poolData`: {PoolData | null} - Pool info (must include token0 and token1 addresses). Required unless disabling.
|
|
2116
|
-
* - `poolKey`: {PoolKey | null} - Unique key for the DEX pool. Required unless disabling.
|
|
2117
|
-
* - `spokeProvider`: {SpokeProvider | null} - Provider instance for the chain. Required unless disabling.
|
|
2118
|
-
* - `enabled`: {boolean} (optional) - Whether to enable the query. Defaults to `true` if all other arguments are provided.
|
|
2119
|
-
* - `queryOptions`: {QueryObserverOptions<UsePoolBalancesResponse, Error>} (optional) - Advanced react-query options.
|
|
2120
|
-
*
|
|
2121
|
-
* @returns {UseQueryResult<UsePoolBalancesResponse, Error>}
|
|
2122
|
-
* React Query result object:
|
|
2123
|
-
* - `data`: `{ token0Balance: bigint, token1Balance: bigint }` if loaded, undefined otherwise.
|
|
2124
|
-
* - `isLoading`, `isError`, etc. for status handling.
|
|
2125
|
-
*
|
|
2126
|
-
* @remarks
|
|
2127
|
-
* - Throws an error if any of `poolData`, `poolKey`, or `spokeProvider` is missing when enabled.
|
|
2128
|
-
* - Suitable for tracking current protocol/wallet balances for both pool tokens.
|
|
2129
|
-
* - The hook is designed for use within a React component tree that provides the Sodax context.
|
|
2130
|
-
* - Data are automatically refreshed at the provided or default polling interval (default: refetch every 10s).
|
|
2131
|
-
*
|
|
2132
|
-
* @example
|
|
2133
|
-
* ```typescript
|
|
2134
|
-
* const { data, isLoading } = usePoolBalances({ poolData, poolKey, spokeProvider });
|
|
2135
|
-
* if (data) {
|
|
2136
|
-
* console.log('Balances:', data.token0Balance, data.token1Balance);
|
|
2137
|
-
* }
|
|
2138
|
-
* ```
|
|
2139
|
-
*/
|
|
2140
|
-
declare function usePoolBalances({ poolData, poolKey, spokeProvider, enabled, queryOptions, }: UsePoolBalancesProps): UseQueryResult<UsePoolBalancesResponse, Error>;
|
|
2141
|
-
|
|
2142
|
-
interface UsePositionInfoResponse {
|
|
2143
|
-
positionInfo: ClPositionInfo;
|
|
2144
|
-
isValid: boolean;
|
|
2145
|
-
}
|
|
2146
|
-
interface UsePositionInfoProps {
|
|
2147
|
-
tokenId: string | null;
|
|
2148
|
-
poolKey: PoolKey | null;
|
|
2149
|
-
queryOptions?: QueryObserverOptions<UsePositionInfoResponse, Error>;
|
|
2150
|
-
}
|
|
2151
|
-
/**
|
|
2152
|
-
* React hook to fetch and validate CL position details by position NFT token ID.
|
|
2153
|
-
*
|
|
2154
|
-
* Fetches position data on-chain for a given tokenId, and checks if it matches the expected PoolKey.
|
|
2155
|
-
* This is commonly used in DEX dashboards to show or pre-validate user positions by ID.
|
|
2156
|
-
*
|
|
2157
|
-
* @param {string | null} tokenId
|
|
2158
|
-
* Position NFT token ID to query, as a string. Pass `null` or empty string to disable.
|
|
2159
|
-
* @param {PoolKey | null} poolKey
|
|
2160
|
-
* PoolKey to match against the position's underlying pool. Pass `null` to disable.
|
|
2161
|
-
* @param {QueryObserverOptions<UsePositionInfoResponse, Error>} [queryOptions]
|
|
2162
|
-
* Optional react-query options for polling/refresh and config. Merged with sensible defaults.
|
|
2163
|
-
*
|
|
2164
|
-
* @returns {UseQueryResult<UsePositionInfoResponse, Error>}
|
|
2165
|
-
* Standard React Query result object:
|
|
2166
|
-
* - `data`: { positionInfo, isValid } if loaded, or undefined if not loaded/error
|
|
2167
|
-
* - `isLoading`: boolean (query active)
|
|
2168
|
-
* - `isError`: boolean (query failed)
|
|
2169
|
-
* - ...other react-query helpers (refetch, status, etc)
|
|
2170
|
-
*
|
|
2171
|
-
* @example
|
|
2172
|
-
* ```typescript
|
|
2173
|
-
* const { data, isLoading, error } = usePositionInfo({ tokenId, poolKey });
|
|
2174
|
-
* if (isLoading) return <div>Loading position...</div>;
|
|
2175
|
-
* if (error) return <div>Error: {error.message}</div>;
|
|
2176
|
-
* if (data) {
|
|
2177
|
-
* console.log('Valid for pool:', data.isValid);
|
|
2178
|
-
* console.log('Liquidity:', data.positionInfo.liquidity);
|
|
2179
|
-
* }
|
|
2180
|
-
* ```
|
|
2181
|
-
*
|
|
2182
|
-
* @remarks
|
|
2183
|
-
* - Validates the underlying position's pool definition (currency0, currency1, fee) with the supplied PoolKey.
|
|
2184
|
-
* - Returns `isValid: false` if any field mismatches.
|
|
2185
|
-
* - Pass `null` as tokenId or poolKey to disable the query.
|
|
2186
|
-
* - Defaults: 10s stale, not enabled if missing arguments. Customizable via `queryOptions`.
|
|
2187
|
-
* - Throws error if called with invalid/null tokenId or poolKey when enabled.
|
|
2188
|
-
*/
|
|
2189
|
-
declare function usePositionInfo({ tokenId, poolKey, queryOptions, }: UsePositionInfoProps): UseQueryResult<UsePositionInfoResponse, Error>;
|
|
2190
|
-
|
|
2191
|
-
type UseDexDepositParams = {
|
|
2192
|
-
params: CreateAssetDepositParams;
|
|
2193
|
-
spokeProvider: SpokeProvider;
|
|
2194
|
-
};
|
|
2195
|
-
/**
|
|
2196
|
-
/**
|
|
2197
|
-
* React hook that provides a mutation to perform a deposit into a DEX pool using the provided parameters and SpokeProvider.
|
|
2198
|
-
*
|
|
2199
|
-
* The hook returns a mutation object for executing the deposit (`mutateAsync`), tracking its state (`isPending`), and any resulting error (`error`).
|
|
2200
|
-
* On successful deposit, all queries matching ['dex', 'poolBalances'] are invalidated and refetched.
|
|
2201
|
-
*
|
|
2202
|
-
* @returns {UseMutationResult<[SpokeTxHash, HubTxHash], Error, UseDexDepositParams>}
|
|
2203
|
-
* React Query mutation result:
|
|
2204
|
-
* - `mutateAsync({ params, spokeProvider })`: Triggers the deposit with {@link CreateDepositParams} and the target SpokeProvider.
|
|
2205
|
-
* - `isPending`: True while the deposit transaction is pending.
|
|
2206
|
-
* - `error`: Error if the mutation fails.
|
|
2207
|
-
*
|
|
2208
|
-
* @example
|
|
2209
|
-
* ```typescript
|
|
2210
|
-
* const { mutateAsync: deposit, isPending, error } = useDexDeposit();
|
|
2211
|
-
* await deposit({ params: { asset, amount, poolToken }, spokeProvider });
|
|
2212
|
-
* ```
|
|
2213
|
-
*
|
|
2214
|
-
* @remarks
|
|
2215
|
-
* - Throws if called with missing `spokeProvider` or `params`.
|
|
2216
|
-
* - Upon success, automatically refetches up-to-date pool balances.
|
|
2217
|
-
*/
|
|
2218
|
-
declare function useDexDeposit(): UseMutationResult<[SpokeTxHash, HubTxHash], Error, UseDexDepositParams>;
|
|
2219
|
-
|
|
2220
|
-
type UseDexWithdrawParams = {
|
|
2221
|
-
params: CreateAssetWithdrawParams;
|
|
2222
|
-
spokeProvider: SpokeProvider;
|
|
2223
|
-
};
|
|
2224
|
-
/**
|
|
2225
|
-
* React hook to provide a mutation for withdrawing assets from a DEX pool.
|
|
2226
|
-
*
|
|
2227
|
-
* This hook returns a mutation result object valid for use with React Query.
|
|
2228
|
-
* The mutation function expects an object with the withdrawal parameters and a SpokeProvider,
|
|
2229
|
-
* and triggers the withdrawal operation on the DEX. On success, it invalidates the relevant
|
|
2230
|
-
* ['dex', 'poolBalances'] query to fetch the updated balances.
|
|
2231
|
-
*
|
|
2232
|
-
* @returns {UseMutationResult<[SpokeTxHash, HubTxHash], Error, UseDexWithdrawParams>}
|
|
2233
|
-
* Mutation result object. Use its properties to:
|
|
2234
|
-
* - Call `mutateAsync({ params, spokeProvider })` to perform the withdrawal.
|
|
2235
|
-
* - Track progress with `isPending`.
|
|
2236
|
-
* - Access any `error` encountered during the mutation.
|
|
2237
|
-
*
|
|
2238
|
-
* @example
|
|
2239
|
-
* const { mutateAsync: withdraw, isPending, error } = useDexWithdraw();
|
|
2240
|
-
* await withdraw({ params, spokeProvider });
|
|
2241
|
-
*/
|
|
2242
|
-
declare function useDexWithdraw(): UseMutationResult<[SpokeTxHash, HubTxHash], Error, UseDexWithdrawParams>;
|
|
2243
|
-
|
|
2244
|
-
type UseDexAllowanceProps = {
|
|
2245
|
-
params: CreateAssetDepositParams | undefined;
|
|
2246
|
-
spokeProvider: SpokeProvider | null;
|
|
2247
|
-
enabled?: boolean;
|
|
2248
|
-
queryOptions?: QueryObserverOptions<boolean, Error>;
|
|
2249
|
-
};
|
|
2250
|
-
/**
|
|
2251
|
-
* Hook to check if the user has approved sufficient token allowance for DEX deposits.
|
|
2252
|
-
*
|
|
2253
|
-
* This hook automatically queries and tracks the allowance status, indicating whether
|
|
2254
|
-
* the user has granted enough allowance to allow a specific deposit to the DEX. It leverages
|
|
2255
|
-
* React Query for status, caching, and background refetching.
|
|
2256
|
-
*
|
|
2257
|
-
* @param {CreateAssetDepositParams | undefined} params
|
|
2258
|
-
* The deposit parameters: asset address, poolToken, and raw amount (BigInt), or undefined to disable.
|
|
2259
|
-
* @param {SpokeProvider | undefined} spokeProvider
|
|
2260
|
-
* The provider interface for the selected chain. When undefined, the query is disabled.
|
|
2261
|
-
* @param {boolean} [enabled]
|
|
2262
|
-
* Whether the allowance status check is enabled. Defaults to true if both params and spokeProvider are truthy.
|
|
2263
|
-
* @param {QueryObserverOptions<boolean, Error>} [queryOptions]
|
|
2264
|
-
* Optional react-query options. Any override here (e.g. staleTime, refetchInterval) will merge with defaults.
|
|
2265
|
-
*
|
|
2266
|
-
* @returns {UseQueryResult<boolean, Error>}
|
|
2267
|
-
* React Query result object: `data` is boolean (true if allowance is sufficient), plus `isLoading`, `error`, etc.
|
|
2268
|
-
*
|
|
2269
|
-
* @example
|
|
2270
|
-
* ```typescript
|
|
2271
|
-
* const { data: isAllowed, isLoading, error } = useDexAllowance({
|
|
2272
|
-
* params: { asset, amount: parseUnits('100', 18), poolToken },
|
|
2273
|
-
* spokeProvider,
|
|
2274
|
-
* });
|
|
2275
|
-
* if (isLoading) return <Spinner />;
|
|
2276
|
-
* if (error) return <div>Error: {error.message}</div>;
|
|
2277
|
-
* if (isAllowed) { ... }
|
|
2278
|
-
* ```
|
|
2279
|
-
*
|
|
2280
|
-
* @remarks
|
|
2281
|
-
* - The allowance is checked every 5 seconds as long as enabled, params, and spokeProvider are all defined.
|
|
2282
|
-
* - Returns `false` if allowance cannot be determined or any error occurs in isAllowanceValid.
|
|
2283
|
-
* - Suitable for gating UI actions that require token approval before depositing in the DEX.
|
|
2284
|
-
*/
|
|
2285
|
-
declare function useDexAllowance({ params, spokeProvider, queryOptions, }: UseDexAllowanceProps): UseQueryResult<boolean, Error>;
|
|
2286
|
-
|
|
2287
|
-
type UseDexApproveParams = {
|
|
2288
|
-
params: CreateAssetDepositParams;
|
|
2289
|
-
spokeProvider: SpokeProvider;
|
|
2290
|
-
};
|
|
2291
|
-
/**
|
|
2292
|
-
* React hook for performing a DEX token allowance approval transaction.
|
|
2293
|
-
*
|
|
2294
|
-
* Returns a mutation object that allows explicitly triggering a token approval
|
|
2295
|
-
* for a DEX deposit, using the specified approval parameters and spoke provider.
|
|
2296
|
-
* On successful approval, the related allowance query is invalidated and refetched
|
|
2297
|
-
* for consistent UI state.
|
|
2298
|
-
*
|
|
2299
|
-
* @returns {UseMutationResult<SpokeTxHash, Error, UseDexApproveParams>}
|
|
2300
|
-
* React Query mutation result for the approval operation. Use `mutateAsync` with
|
|
2301
|
-
* an object of shape `{ params, spokeProvider }` to initiate approval.
|
|
2302
|
-
*
|
|
2303
|
-
* @example
|
|
2304
|
-
* ```typescript
|
|
2305
|
-
* const { mutateAsync: approve, isPending, error } = useDexApprove();
|
|
2306
|
-
* await approve({ params: { asset, amount, poolToken }, spokeProvider });
|
|
2307
|
-
* ```
|
|
2308
|
-
*
|
|
2309
|
-
* @remarks
|
|
2310
|
-
* - Throws if called without both a valid `params` and `spokeProvider`.
|
|
2311
|
-
* - On approval success, the query for ['dex', 'allowance'] is invalidated/refetched.
|
|
2312
|
-
*/
|
|
2313
|
-
declare function useDexApprove(): UseMutationResult<SpokeTxHash, Error, UseDexApproveParams>;
|
|
2314
|
-
|
|
2315
|
-
interface UseLiquidityAmountsResult {
|
|
2316
|
-
liquidityToken0Amount: string;
|
|
2317
|
-
liquidityToken1Amount: string;
|
|
2318
|
-
lastEditedToken: 'token0' | 'token1' | null;
|
|
2319
|
-
setLiquidityToken0Amount: (value: string) => void;
|
|
2320
|
-
setLiquidityToken1Amount: (value: string) => void;
|
|
2321
|
-
handleToken0AmountChange: (value: string) => void;
|
|
2322
|
-
handleToken1AmountChange: (value: string) => void;
|
|
2323
|
-
}
|
|
2324
|
-
/**
|
|
2325
|
-
* Hook for calculating liquidity amounts based on price range.
|
|
2326
|
-
*
|
|
2327
|
-
* This hook manages the state and calculations for liquidity token amounts.
|
|
2328
|
-
* It automatically calculates the corresponding token amount when one is changed,
|
|
2329
|
-
* based on the current price range and pool data.
|
|
2330
|
-
*
|
|
2331
|
-
* @param {string} minPrice - Minimum price for the liquidity range
|
|
2332
|
-
* @param {string} maxPrice - Maximum price for the liquidity range
|
|
2333
|
-
* @param {PoolData | null} poolData - The pool data containing token information
|
|
2334
|
-
* @returns {UseLiquidityAmountsResult} Object containing amounts, state, and handlers
|
|
2335
|
-
*
|
|
2336
|
-
* @example
|
|
2337
|
-
* ```typescript
|
|
2338
|
-
* const {
|
|
2339
|
-
* liquidityToken0Amount,
|
|
2340
|
-
* liquidityToken1Amount,
|
|
2341
|
-
* handleToken0AmountChange,
|
|
2342
|
-
* handleToken1AmountChange,
|
|
2343
|
-
* } = useLiquidityAmounts(minPrice, maxPrice, poolData);
|
|
2344
|
-
*
|
|
2345
|
-
* <Input
|
|
2346
|
-
* value={liquidityToken0Amount}
|
|
2347
|
-
* onChange={(e) => handleToken0AmountChange(e.target.value)}
|
|
2348
|
-
* />
|
|
2349
|
-
* ```
|
|
2350
|
-
*/
|
|
2351
|
-
declare function useLiquidityAmounts(minPrice: string, maxPrice: string, poolData: PoolData | null): UseLiquidityAmountsResult;
|
|
2352
|
-
|
|
2353
|
-
type UseCreateSupplyLiquidityParamsProps = {
|
|
2354
|
-
poolData: PoolData;
|
|
2355
|
-
poolKey: PoolKey;
|
|
2356
|
-
minPrice: string;
|
|
2357
|
-
maxPrice: string;
|
|
2358
|
-
liquidityToken0Amount: string;
|
|
2359
|
-
liquidityToken1Amount: string;
|
|
2360
|
-
slippageTolerance: string | number;
|
|
2361
|
-
positionId?: string | null;
|
|
2362
|
-
isValidPosition?: boolean;
|
|
2363
|
-
};
|
|
2364
|
-
type UseCreateSupplyLiquidityParamsResult = ConcentratedLiquiditySupplyParams & Omit<ConcentratedLiquidityIncreaseLiquidityParams, 'tokenId'> & {
|
|
2365
|
-
tokenId?: string | bigint;
|
|
2366
|
-
positionId?: string | null;
|
|
2367
|
-
isValidPosition?: boolean;
|
|
2368
|
-
};
|
|
2369
|
-
/**
|
|
2370
|
-
* React hook to create the supply liquidity parameters for a given pool.
|
|
2371
|
-
*
|
|
2372
|
-
* Purpose:
|
|
2373
|
-
* - Provides a hook which memoizes the supply liquidity parameters for a given pool.
|
|
2374
|
-
*
|
|
2375
|
-
* Usage:
|
|
2376
|
-
* - Call the function with the pool data, pool key, minimum price, maximum price, liquidity token0 amount, liquidity token1 amount, slippage tolerance, position id, and validity of the position to create the supply liquidity parameters.
|
|
2377
|
-
*
|
|
2378
|
-
* Params:
|
|
2379
|
-
* @param poolData - The pool data of the pool to supply liquidity to.
|
|
2380
|
-
* @param poolKey - The pool key of the pool to supply liquidity to.
|
|
2381
|
-
* @param minPrice - The minimum price of the liquidity to supply.
|
|
2382
|
-
* @param maxPrice - The maximum price of the liquidity to supply.
|
|
2383
|
-
* @param liquidityToken0Amount - The amount of the token0 to supply.
|
|
2384
|
-
* @param liquidityToken1Amount - The amount of the token1 to supply.
|
|
2385
|
-
* @param slippageTolerance - The slippage tolerance to use for the supply.
|
|
2386
|
-
* @param positionId - The position id of the position to supply liquidity to.
|
|
2387
|
-
* @param isValidPosition - Whether the position is valid.
|
|
2388
|
-
* @returns The supply liquidity parameters.
|
|
2389
|
-
*/
|
|
2390
|
-
declare function useCreateSupplyLiquidityParams({ poolData, poolKey, minPrice, maxPrice, liquidityToken0Amount, liquidityToken1Amount, slippageTolerance, positionId, isValidPosition, }: UseCreateSupplyLiquidityParamsProps): UseCreateSupplyLiquidityParamsResult;
|
|
2391
|
-
|
|
2392
|
-
type UseSupplyLiquidityProps = {
|
|
2393
|
-
params: UseCreateSupplyLiquidityParamsResult;
|
|
2394
|
-
spokeProvider: SpokeProvider;
|
|
2395
|
-
};
|
|
2396
|
-
/**
|
|
2397
|
-
* Hook for supplying liquidity to a pool.
|
|
2398
|
-
*
|
|
2399
|
-
* This hook handles both minting new positions and increasing liquidity in existing positions.
|
|
2400
|
-
* It applies slippage tolerance before calculating liquidity and handles the complete transaction flow.
|
|
2401
|
-
*
|
|
2402
|
-
* @param {SpokeProvider} spokeProvider - The spoke provider for the chain
|
|
2403
|
-
* @returns {UseMutationResult<void, Error, SupplyLiquidityParams>} Mutation result with supply function
|
|
2404
|
-
*
|
|
2405
|
-
* @example
|
|
2406
|
-
* ```typescript
|
|
2407
|
-
* const { mutateAsync: supplyLiquidity, isPending, error } = useSupplyLiquidity(spokeProvider);
|
|
2408
|
-
*
|
|
2409
|
-
* await supplyLiquidity({
|
|
2410
|
-
* poolData,
|
|
2411
|
-
* poolKey,
|
|
2412
|
-
* minPrice: '100',
|
|
2413
|
-
* maxPrice: '200',
|
|
2414
|
-
* liquidityToken0Amount: '10',
|
|
2415
|
-
* liquidityToken1Amount: '20',
|
|
2416
|
-
* slippageTolerance: '0.5',
|
|
2417
|
-
* });
|
|
2418
|
-
* ```
|
|
2419
|
-
*/
|
|
2420
|
-
declare function useSupplyLiquidity(): UseMutationResult<[SpokeTxHash, HubTxHash], Error, UseSupplyLiquidityProps>;
|
|
2421
|
-
|
|
2422
|
-
type UseDecreaseLiquidityParams = {
|
|
2423
|
-
params: ConcentratedLiquidityDecreaseLiquidityParams;
|
|
2424
|
-
spokeProvider: SpokeProvider;
|
|
2425
|
-
};
|
|
2426
|
-
/**
|
|
2427
|
-
* React hook that provides a mutation for decreasing liquidity in a concentrated liquidity position.
|
|
2428
|
-
*
|
|
2429
|
-
* This hook returns a mutation for removing liquidity from a position using the provided
|
|
2430
|
-
* `ConcentratedLiquidityDecreaseLiquidityParams` and `SpokeProvider`. The mutation returns a tuple of
|
|
2431
|
-
* the spoke transaction hash and the hub transaction hash upon success.
|
|
2432
|
-
*
|
|
2433
|
-
* @returns {UseMutationResult<[SpokeTxHash, HubTxHash], Error, UseDecreaseLiquidityParams>}
|
|
2434
|
-
* React Query mutation result:
|
|
2435
|
-
* - `mutateAsync({ params, spokeProvider })`: Triggers the decrease liquidity mutation.
|
|
2436
|
-
* - On success, returns `[spokeTxHash, hubTxHash]`.
|
|
2437
|
-
* - On failure, throws an error.
|
|
2438
|
-
*
|
|
2439
|
-
* @example
|
|
2440
|
-
* ```typescript
|
|
2441
|
-
* const { mutateAsync: decreaseLiquidity, isPending, error } = useDecreaseLiquidity();
|
|
2442
|
-
*
|
|
2443
|
-
* await decreaseLiquidity({
|
|
2444
|
-
* params: {
|
|
2445
|
-
* poolKey,
|
|
2446
|
-
* tokenId: 123n,
|
|
2447
|
-
* liquidity: 100000n,
|
|
2448
|
-
* amount0Min: 0n,
|
|
2449
|
-
* amount1Min: 0n,
|
|
2450
|
-
* },
|
|
2451
|
-
* spokeProvider,
|
|
2452
|
-
* });
|
|
2453
|
-
* ```
|
|
2454
|
-
*
|
|
2455
|
-
* @param {UseDecreaseLiquidityParams} variables
|
|
2456
|
-
* - `params`: Parameters for the decrease liquidity operation, matching `ConcentratedLiquidityDecreaseLiquidityParams`.
|
|
2457
|
-
* - `spokeProvider`: The provider instance for the target spoke chain.
|
|
2458
|
-
*
|
|
2459
|
-
* @remarks
|
|
2460
|
-
* - After a successful liquidity decrease, the hook will invalidate DEX pool balances and position info queries.
|
|
2461
|
-
*/
|
|
2462
|
-
declare function useDecreaseLiquidity(): UseMutationResult<[SpokeTxHash, HubTxHash], Error, UseDecreaseLiquidityParams>;
|
|
2463
|
-
|
|
2464
|
-
type UseCreateDepositParamsProps = {
|
|
2465
|
-
tokenIndex: 0 | 1;
|
|
2466
|
-
amount: string | number;
|
|
2467
|
-
poolData: PoolData;
|
|
2468
|
-
poolSpokeAssets: PoolSpokeAssets;
|
|
2469
|
-
};
|
|
2470
|
-
/**
|
|
2471
|
-
* React hook to create the deposit parameters for a given pool and token.
|
|
2472
|
-
*
|
|
2473
|
-
* Purpose:
|
|
2474
|
-
* - Provides a hook which memoizes the deposit parameters for a given pool and token.
|
|
2475
|
-
*
|
|
2476
|
-
* Usage:
|
|
2477
|
-
* - Call the function with the token index, amount, pool data, pool key, and spoke provider to create the deposit parameters.
|
|
2478
|
-
*
|
|
2479
|
-
* Params:
|
|
2480
|
-
* @param tokenIndex - The index of the token to deposit.
|
|
2481
|
-
* @param amount - The amount of the token to deposit.
|
|
2482
|
-
* @param poolData - The pool data of the pool to deposit to.
|
|
2483
|
-
* @param poolKey - The pool key of the pool to deposit to.
|
|
2484
|
-
* @param spokeProvider - The spoke provider to use for the deposit.
|
|
2485
|
-
* @returns The deposit parameters or undefined if the pool key, spoke provider, or amount is not set.
|
|
2486
|
-
*/
|
|
2487
|
-
declare function useCreateDepositParams({ tokenIndex, amount, poolData, poolSpokeAssets, }: UseCreateDepositParamsProps): CreateAssetDepositParams | undefined;
|
|
2488
|
-
|
|
2489
|
-
type UseCreateDecreaseLiquidityParamsProps = {
|
|
2490
|
-
poolKey: PoolKey;
|
|
2491
|
-
tokenId: string | bigint;
|
|
2492
|
-
percentage: string | number;
|
|
2493
|
-
positionInfo: ClPositionInfo;
|
|
2494
|
-
slippageTolerance: string | number;
|
|
2495
|
-
};
|
|
2496
|
-
/**
|
|
2497
|
-
* React hook to create the decrease liquidity parameters for a given pool and position.
|
|
2498
|
-
*
|
|
2499
|
-
* Purpose:
|
|
2500
|
-
* - Provides a hook which memoizes the decrease liquidity parameters for a given pool and position.
|
|
2501
|
-
*
|
|
2502
|
-
* Usage:
|
|
2503
|
-
* - Call the function with the pool key, token ID, percentage, position info, and slippage tolerance to create the decrease liquidity parameters.
|
|
2504
|
-
*
|
|
2505
|
-
* Params:
|
|
2506
|
-
* @param poolKey - The pool key of the pool to decrease the liquidity from.
|
|
2507
|
-
* @param tokenId - The token ID of the position to decrease the liquidity from.
|
|
2508
|
-
* @param percentage - The percentage of liquidity to decrease.
|
|
2509
|
-
* @param positionInfo - The position info of the position to decrease the liquidity from.
|
|
2510
|
-
* @param slippageTolerance - The slippage tolerance to use for the decrease.
|
|
2511
|
-
* @returns The decrease liquidity parameters.
|
|
2512
|
-
*/
|
|
2513
|
-
declare function useCreateDecreaseLiquidityParams({ poolKey, tokenId, percentage, positionInfo, slippageTolerance, }: UseCreateDecreaseLiquidityParamsProps): ConcentratedLiquidityDecreaseLiquidityParams;
|
|
2514
|
-
|
|
2515
|
-
type UseCreateWithdrawParamsProps = {
|
|
2516
|
-
tokenIndex: 0 | 1;
|
|
2517
|
-
amount: string | number;
|
|
2518
|
-
poolData: PoolData;
|
|
2519
|
-
poolSpokeAssets: PoolSpokeAssets;
|
|
2520
|
-
dst?: DestinationParamsType;
|
|
2521
|
-
};
|
|
2522
|
-
/**
|
|
2523
|
-
* React hook to create the withdrawal parameters for a given pool and token.
|
|
2524
|
-
*
|
|
2525
|
-
* Purpose:
|
|
2526
|
-
* - Provides a hook which memoizes the withdrawal parameters for a given pool and token.
|
|
2527
|
-
*
|
|
2528
|
-
* Usage:
|
|
2529
|
-
* - Call the function with the token index, amount, pool data, pool spoke assets, and destination parameters to create the withdrawal parameters.
|
|
2530
|
-
*
|
|
2531
|
-
* Params:
|
|
2532
|
-
* @param tokenIndex - The index of the token to withdraw.
|
|
2533
|
-
* @param amount - The amount of the token to withdraw.
|
|
2534
|
-
* @param poolData - The pool data of the pool to withdraw from.
|
|
2535
|
-
* @param poolSpokeAssets - The pool spoke assets of the pool to withdraw from.
|
|
2536
|
-
* @param dst - The destination parameters for the withdrawal.
|
|
2537
|
-
* @returns The withdrawal parameters or undefined if the amount is not set.
|
|
2538
|
-
*/
|
|
2539
|
-
declare function useCreateWithdrawParams({ tokenIndex, amount, poolData, poolSpokeAssets, dst, }: UseCreateWithdrawParamsProps): CreateAssetWithdrawParams | undefined;
|
|
2540
|
-
|
|
2541
|
-
type UseClaimRewardsParams = {
|
|
2542
|
-
params: ConcentratedLiquidityClaimRewardsParams;
|
|
2543
|
-
spokeProvider: SpokeProvider;
|
|
2544
|
-
};
|
|
2545
|
-
/**
|
|
2546
|
-
* React hook for creating a mutation to claim DEX rewards for a concentrated liquidity position.
|
|
2547
|
-
*
|
|
2548
|
-
* @returns {UseMutationResult<[SpokeTxHash, HubTxHash], ConcentratedLiquidityError<ConcentratedLiquidityErrorCode>, UseClaimRewardsParams>}
|
|
2549
|
-
* Returns a react-query mutation result object:
|
|
2550
|
-
* - On success: resolves to a tuple `[SpokeTxHash, HubTxHash]`.
|
|
2551
|
-
* - On error: the error is of type `ConcentratedLiquidityError<ConcentratedLiquidityErrorCode>`.
|
|
2552
|
-
* - The mutation function expects an argument of type {@link UseClaimRewardsParams}
|
|
2553
|
-
* containing `params` (the claim parameters) and `spokeProvider` (the target provider).
|
|
2554
|
-
* - On mutation success, invalidates the queries `'dex/poolBalances'` and `'dex/positionInfo'`.
|
|
2555
|
-
*
|
|
2556
|
-
* @example
|
|
2557
|
-
* const claimRewardsMutation = useClaimRewards();
|
|
2558
|
-
* claimRewardsMutation.mutateAsync({
|
|
2559
|
-
* params: { poolKey, tokenId, tickLower, tickUpper },
|
|
2560
|
-
* spokeProvider,
|
|
2561
|
-
* });
|
|
2562
|
-
*/
|
|
2563
|
-
declare function useClaimRewards(): UseMutationResult<[
|
|
2564
|
-
SpokeTxHash,
|
|
2565
|
-
HubTxHash
|
|
2566
|
-
], ConcentratedLiquidityError<ConcentratedLiquidityErrorCode>, UseClaimRewardsParams>;
|
|
2567
|
-
|
|
2568
|
-
interface SodaxProviderProps {
|
|
2569
|
-
children: ReactNode;
|
|
2570
|
-
testnet?: boolean;
|
|
2571
|
-
config?: SodaxConfig;
|
|
2572
|
-
rpcConfig: RpcConfig;
|
|
2573
|
-
}
|
|
2574
|
-
declare const SodaxProvider: ({ children, testnet, config, rpcConfig }: SodaxProviderProps) => ReactElement;
|
|
2575
|
-
|
|
2576
|
-
declare function createDecreaseLiquidityParamsProps({ poolKey, tokenId, percentage, positionInfo, slippageTolerance, }: UseCreateDecreaseLiquidityParamsProps): ConcentratedLiquidityDecreaseLiquidityParams;
|
|
2577
|
-
declare function createDepositParamsProps({ tokenIndex, amount, poolData, poolSpokeAssets, }: UseCreateDepositParamsProps): CreateAssetDepositParams;
|
|
2578
|
-
declare function createSupplyLiquidityParamsProps({ poolData, poolKey, minPrice, maxPrice, liquidityToken0Amount, liquidityToken1Amount, slippageTolerance, positionId, isValidPosition, }: UseCreateSupplyLiquidityParamsProps): UseCreateSupplyLiquidityParamsResult;
|
|
2579
|
-
declare function createWithdrawParamsProps({ tokenIndex, amount, poolData, poolSpokeAssets, dst, }: UseCreateWithdrawParamsProps): CreateAssetWithdrawParams;
|
|
2580
|
-
|
|
2581
|
-
export { type BackendPaginationParams, MIGRATION_MODE_BNUSD, MIGRATION_MODE_ICX_SODA, type MigrationIntentParams, type MigrationMode, type RadfiSession, SodaxProvider, type UseATokenParams, type UseATokensBalancesParams, type UseBorrowParams, type UseClaimRewardsParams, type UseCreateDecreaseLiquidityParamsProps, type UseCreateDepositParamsProps, type UseCreateSupplyLiquidityParamsProps, type UseCreateSupplyLiquidityParamsResult, type UseCreateWithdrawParamsProps, type UseDecreaseLiquidityParams, type UseDexAllowanceProps, type UseDexApproveParams, type UseDexDepositParams, type UseDexWithdrawParams, type UseMMAllowanceParams, type UseMMApproveParams, type UsePoolBalancesProps, type UsePoolBalancesResponse, type UsePoolDataProps, type UsePoolsProps, type UsePositionInfoProps, type UsePositionInfoResponse, type UseRadfiSessionReturn, type UseRepayParams, type UseReservesDataParams, type UseReservesUsdFormatParams, type UseSupplyLiquidityProps, type UseSupplyParams, type UseUserFormattedSummaryParams, type UseUserReservesDataParams, type UseWithdrawParams, clearRadfiSession, createDecreaseLiquidityParamsProps, createDepositParamsProps, createSupplyLiquidityParamsProps, createWithdrawParamsProps, loadRadfiSession, saveRadfiSession, useAToken, useATokensBalances, useBackendAllMoneyMarketAssets, useBackendAllMoneyMarketBorrowers, useBackendIntentByHash, useBackendIntentByTxHash, useBackendMoneyMarketAsset, useBackendMoneyMarketAssetBorrowers, useBackendMoneyMarketAssetSuppliers, useBackendMoneyMarketPosition, useBackendOrderbook, useBackendSubmitSwapTx, useBackendSubmitSwapTxStatus, useBackendUserIntents, useBitcoinBalance, useBorrow, useBridge, useBridgeAllowance, useBridgeApprove, useCancelLimitOrder, useCancelSwap, useCancelUnstake, useClaim, useClaimRewards, useConvertedAssets, useCreateDecreaseLiquidityParams, useCreateDepositParams, useCreateLimitOrder, useCreateSupplyLiquidityParams, useCreateWithdrawParams, useDecreaseLiquidity, useDeriveUserWalletAddress, useDexAllowance, useDexApprove, useDexDeposit, useDexWithdraw, useEstimateGas, useExpiredUtxos, useFundTradingWallet, useGetBridgeableAmount, useGetBridgeableTokens, useGetUserHubWalletAddress, useHubProvider, useInstantUnstake, useInstantUnstakeAllowance, useInstantUnstakeApprove, useInstantUnstakeRatio, useLiquidityAmounts, useMMAllowance, useMMApprove, useMigrate, useMigrationAllowance, useMigrationApprove, usePoolBalances, usePoolData, usePools, usePositionInfo, useQuote, useRadfiAuth, useRadfiSession, useRadfiWithdraw, useRenewUtxos, useRepay, useRequestTrustline, useReservesData, useReservesUsdFormat, useSodaxContext, useSpokeProvider, useStake, useStakeAllowance, useStakeApprove, useStakeRatio, useStakingConfig, useStakingInfo, useStatus, useStellarTrustlineCheck, useSupply, useSupplyLiquidity, useSwap, useSwapAllowance, useSwapApprove, useTradingWalletBalance, useUnstake, useUnstakeAllowance, useUnstakeApprove, useUnstakingInfo, useUnstakingInfoWithPenalty, useUserFormattedSummary, useUserReservesData, useWithdraw };
|