@0xsquid/react-hooks 8.6.1 → 8.7.0

package/dist/core/constants.d.ts

@@ -69,6 +69,9 @@ export declare const CHAIN_IDS: {
     readonly SONEIUM: "1868";
     readonly PEAQ: "3338";
     readonly HEDERA: "295";
+    readonly MANTRA: "5888";
+    readonly CITREA: "4114";
+    readonly TEMPO: "4217";
     readonly BITCOIN: "bitcoin";
     readonly SOLANA: "solana-mainnet-beta";
     readonly SUI: "sui-mainnet";

package/dist/core/queries/queries-keys.d.ts

@@ -56,7 +56,7 @@ export declare const keys: () => {
     tokenData: (token?: TokenWithBalance) => (string | undefined)[];
     balance: (chainId?: number | string, tokenAddress?: string, userAddress?: string) => (string | number | undefined)[];
     allTokensBalance: (address: string | undefined, chainType: ChainType | undefined, direction?: SwapDirection) => (string | undefined)[];
-    transaction: (fromChainId: string | undefined, toChainId: string | undefined, toTokenAddress: string | undefined, fromTokenAddress: string | undefined, price: string | undefined, slippage: SlippageOption | undefined, getGasOnDestination: boolean | undefined, sourceUserAddress: string | undefined, degenMode: boolean | undefined, destinationAddress: string | undefined, fallbackAddress: string | undefined, quoteOnly: boolean | undefined, fromChainType: ChainType | undefined, preHook: AppConfig["preHook"] | undefined, postHook: AppConfig["postHook"] | undefined, overrideGasRefundAddress: AppConfig["overrideGasRefundAddress"] | undefined) => (string | number | boolean | Omit<import("@0xsquid/squid-types").Hook, "fundAmount" | "fundToken"> | undefined)[];
+    transaction: (fromChainId: string | undefined, toChainId: string | undefined, toTokenAddress: string | undefined, fromTokenAddress: string | undefined, price: string | undefined, slippage: SlippageOption | undefined, sourceUserAddress: string | undefined, degenMode: boolean | undefined, destinationAddress: string | undefined, fallbackAddress: string | undefined, quoteOnly: boolean | undefined, fromChainType: ChainType | undefined, preHook: AppConfig["preHook"] | undefined, postHook: AppConfig["postHook"] | undefined, overrideGasRefundAddress: AppConfig["overrideGasRefundAddress"] | undefined) => (string | number | boolean | Omit<import("@0xsquid/squid-types").Hook, "fundAmount" | "fundToken"> | undefined)[];
     swapTransactionStatus: (transactionId: string | undefined) => (string | undefined)[];
     fiatToCryptoStatus: (transactionId?: string) => (string | undefined)[];
     sendTransactionStatus: (txHash: string | undefined, chainId: string | undefined) => (string | undefined)[];

package/dist/core/types/config.d.ts

@@ -14,7 +14,6 @@ export type NamedTokenConfig = {
 export interface AppConfig {
     integratorId: string;
     slippage?: SlippageOption;
-    enableGetGasOnDestination?: boolean;
     /**
      * If set to true, will load initial tokens and chains from local storage
      */

package/dist/hooks/index.d.ts

@@ -29,6 +29,7 @@ export { useMultipleTokenPrices } from "./tokens/useMultipleTokenPrices";
 export { useBitcoinNativeBalance, useCosmosNativeBalance, useEvmNativeBalance, useNativeBalance, useSolanaNativeBalance, useStellarNativeBalance, useSuiNativeBalance, useXrplNativeBalance, } from "./tokens/useNativeBalance";
 export { useNativeTokenForChain } from "./tokens/useNativeTokenForChain";
 export { useSingleTokenPrice } from "./tokens/useSingleTokenPrice";
+export { useSourceChainGasToken } from "./tokens/useSourceChainGasToken";
 export { useSquidTokens } from "./tokens/useSquidTokens";
 export { useHistoricalData, useTokensData, } from "./tokens/useTokenHistoricalData";
 export { useEstimateSendTransaction } from "./transaction/send/useEstimateSendTransactionGas";
@@ -45,7 +46,6 @@ export { useSendTransactionStatus } from "./transaction/useSendTransactionStatus
 export { useSwapTransactionStatus } from "./transaction/useSwapTransactionStatus";
 export { useAvatar } from "./user/useAvatar";
 export { useHistory } from "./user/useHistory";
-export { useUserParams } from "./user/useUserParams";
 export { useDebouncedValue } from "./utils/useUtils";
 export { useAddToken } from "./wallet/useAddToken";
 export { useAutoConnect } from "./wallet/useAutoConnect";

package/dist/hooks/tokens/useSourceChainGasToken.d.ts

@@ -0,0 +1,13 @@
+import { ChainData } from "@0xsquid/squid-types";
+import { Token } from "../../core";
+import { ChainFeeParams } from "../../services/internal/tempoService";
+/**
+ * Hook that returns the gas token and chain fee params for a given source chain and token.
+ */
+export declare function useSourceChainGasToken({ fromChain, fromToken, }: {
+    fromChain: ChainData | undefined;
+    fromToken: Token | undefined;
+}): {
+    gasToken: Token | undefined;
+    chainFeeParams: ChainFeeParams | null;
+};

package/dist/hooks/transaction/send/useEstimateSendTransactionGas.d.ts

@@ -6,9 +6,9 @@ interface UseEstimateSendReturnType {
     estimatedGas: bigint | undefined;
     isLoading: boolean;
     /**
-     * Whether the native balance is enough to pay for the network gas fees
+     * Whether the gas token balance is enough to pay for the network gas fees
      */
-    isNativeBalanceEnoughToPayGasFees: boolean;
+    isGasBalanceEnough: boolean;
     /**
      * Whether the balance of the selected token is enough to send the requested `amount`.
      */
@@ -17,6 +17,15 @@ interface UseEstimateSendReturnType {
      * The safe amount the user can send to have enough balance to pay for the network gas fees
      */
     minAmountValueWarnMsg: string | undefined;
+    /**
+     * Whether the selected token pays the network fee
+     */
+    tokenPaysGasFees: boolean;
+    /**
+     * The balance of the gas token needed
+     * including source amount if the source token is the gas token
+     */
+    gasBalanceNeeded: string | undefined;
 }
 export declare function useEstimateSendTransaction({ chain, token, amount, balance, from, }: {
     chain: ChainData | undefined;

package/dist/hooks/transaction/useEstimate.d.ts

@@ -5,25 +5,20 @@ type FeeFormatted = {
     imageUrl: string;
 };
 export declare const useEstimate: (squidRoute?: RouteResponse["route"]) => {
-    balanceFormatted: string;
+    fromBalanceFormatted: string;
     slippageFormatted: string;
     totalWithRefundEstimate: {
         totalAmount: string;
         totalAmountUSD: number;
         feeToken: import("@0xsquid/squid-types").Token | undefined;
     };
-    proposedGasDestinationAmount: {
-        value: number;
-        currency: string | undefined;
-    };
-    enoughBalanceToSwap: boolean;
+    fromBalanceEnoughToSwap: boolean;
     feeCostsFormatted: FeeFormatted[];
     totalFeeCostsUsd: string;
-    fromToken: any;
+    gasToken: import("../..").Token | undefined;
+    fromToken: import("@0xsquid/squid-types").Token | undefined;
     fromAmount: string | undefined;
     fromAmountFormatted: string;
-    sourceChainNativeToken: import("@0xsquid/squid-types").Token | undefined;
-    destChainNativeToken: import("@0xsquid/squid-types").Token | undefined;
     toAmountUSD: string | undefined;
     exchangeRate: string;
     toAmountMinUSD: string;
@@ -38,14 +33,14 @@ export declare const useEstimate: (squidRoute?: RouteResponse["route"]) => {
     expectedGasRefundCost: bigint;
     expectedGasRefundCostUSD: string;
     sameTokenBetweenFees: boolean;
-    isFromTokenNative: boolean;
+    fromTokenPaysGasFees: boolean;
     totalNativeFees: bigint;
-    totalFeesInNativeTokenPlusRatio: bigint;
-    fromBalanceEnoughToSwap: boolean;
+    isGasBalanceEnough: boolean;
     minAmountValueWarnMsg: string | undefined;
     estimatedRouteDuration: {
         seconds: number;
         format: (sTemplate?: string | undefined, mTemplate?: string | undefined, hTemplate?: string | undefined) => string;
     };
+    gasBalanceNeeded: string | undefined;
 };
 export {};

package/dist/hooks/transaction/useTempoFeeCheck.d.ts

@@ -0,0 +1,11 @@
+import { ChainData } from "@0xsquid/squid-types";
+import { Token } from "../../core/types";
+import { TempoFeeData } from "../../services/internal/tempoService";
+/**
+ * Returns raw on-chain gas token data for Tempo chains, or null when the source
+ * chain is not Tempo.
+ */
+export declare const useTempoFeeCheck: ({ fromChain, fromToken, }: {
+    fromChain: ChainData | undefined;
+    fromToken: Token | undefined;
+}) => TempoFeeData | null;