@0xsquid/react-hooks 7.7.0 → 8.0.0-beta.0

package/dist/core/constants.d.ts

@@ -20,8 +20,6 @@ export declare const nativeSolanaTokenAddress = "0xeeeeeeeeeeeeeeeeeeeeeeeeeeeee
 export declare const nativeBitcoinTokenAddress = "satoshi";
 export declare const nativeSuiTokenAddress = "0x0000000000000000000000000000000000000000000000000000000000000002::sui::SUI";
 export declare const nativeXrplTokenAddress = "xrp";
-export declare const maxPriceImpact = 30;
-export declare const limitTradeSizeUsd = 10000000;
 export declare const defaultSlippage: SlippageOption;
 export declare const destinationAddressResetValue = "null";
 export declare const fallbackAddressResetValue = "null";

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

@@ -1,6 +1,7 @@
 import { ChainType, RouteResponse } from "@0xsquid/squid-types";
 import { HistoryTransaction } from "../../core/types/history";
 import { AppConfig, SlippageOption } from "../types/config";
+import { SwapDirection } from "../types/swap";
 import { Timeframe, TokenWithBalance } from "../types/tokens";
 export declare enum QueryKeys {
     All = "all",
@@ -46,7 +47,7 @@ export declare const keys: () => {
     tokensData: (tokens?: TokenWithBalance[]) => (string | undefined)[];
     tokenData: (token?: TokenWithBalance) => (string | undefined)[];
     balance: (chainId?: number | string, tokenAddress?: string, userAddress?: string) => (string | number | undefined)[];
-    allTokensBalance: (address: string | undefined, chainType: ChainType | undefined) => (string | 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) => (string | number | boolean | Omit<import("@0xsquid/squid-types").Hook, "fundAmount" | "fundToken"> | undefined)[];
     swapTransactionStatus: (transactionId: string | undefined) => (string | undefined)[];
     fiatToCryptoStatus: (transactionId?: string) => (string | undefined)[];

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

@@ -1,5 +1,4 @@
 import { RouteRequest } from "@0xsquid/squid-types";
-import type { DexName } from "./dex";
 export type SlippageOption = RouteRequest["slippage"];
 export type TokenConfig = {
     address: string;
@@ -9,26 +8,50 @@ export interface AppConfig {
     integratorId: string;
     slippage?: SlippageOption;
     enableGetGasOnDestination?: boolean;
+    /**
+     * If set to true, will load initial tokens and chains from local storage
+     */
     loadPreviousStateFromLocalStorage?: boolean;
     apiUrl?: string;
-    preferDex?: DexName[] | string[];
     priceImpactWarnings?: {
         warning: number;
         critical: number;
     };
+    /**
+     * The initial from and to assets when widget loads
+     *
+     * If {@link loadPreviousStateFromLocalStorage} is set to true, this will be ignored
+     */
     initialAssets?: {
         from?: TokenConfig;
         to?: TokenConfig;
     };
+    /**
+     * When chains are changed, this allows to choose the first token that will be selected
+     */
     defaultTokensPerChain?: TokenConfig[];
+    /**
+     * Allows to enable only certain chains on a specific direction.
+     *
+     * This setting overrides {@link disabledChains}
+     */
     availableChains?: {
-        source?: (number | string)[];
-        destination?: (number | string)[];
+        source?: string[];
+        destination?: string[];
     };
+    /**
+     * Allows to whitelist tokens on specific chains.
+     */
+    availableTokensPerChain?: Record<string, string[]>;
     collectFees?: {
         integratorAddress: string;
         fee: number;
     };
+    /**
+     * Allows to disable chains on a specific direction.
+     *
+     * This setting is overridden by {@link availableChains}
+     */
     disabledChains?: {
         source?: string[];
         destination?: string[];

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

@@ -8,3 +8,4 @@ export interface SwapParams {
     destinationAddress?: FullAddressData;
     fallbackAddress?: string;
 }
+export type SwapDirection = "from" | "to";

package/dist/hooks/chains/useSquidChains.d.ts

@@ -1,15 +1,12 @@
 import { ChainData, ChainType, CosmosChain, EvmChain } from "@0xsquid/squid-types";
-export declare const useSquidChains: (direction?: "from" | "to") => {
+import { SwapDirection } from "../../core/types/swap";
+/**
+ * Returns an array of the available chains based on the provided config and direction
+ */
+export declare const useSquidChains: (direction?: SwapDirection) => {
     supportedSourceChains: ChainData[];
     supportedDestinationChains: ChainData[];
     chains: ChainData[];
-    fuseSearchOptions: {
-        isCaseSensitive: boolean;
-        includeScore: boolean;
-        minMatchCharLength: number;
-        threshold: number;
-        keys: string[];
-    };
     cosmosChains: CosmosChain[];
     evmChains: EvmChain[];
     suiChains: ChainData[];

package/dist/hooks/swap/useSwap.d.ts

@@ -6,7 +6,7 @@ export declare const useSwap: () => {
         to: import("../../core").Token[];
     };
     onSwapChange: (inputSwapParams: SwapParams) => SwapParams;
-    invertSwaps: () => void;
+    invertSwaps: (() => SwapParams) | undefined;
     fromPrice: string | undefined;
     fromPriceChanged: (price: string) => void;
     toToken: import("../../core").Token | undefined;

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

@@ -1,7 +1,8 @@
 import { UseQueryOptions } from "@tanstack/react-query";
+import { SwapDirection } from "../../core/types/swap";
 import { TokenWithBalance } from "../../core/types/tokens";
 export declare const useAllConnectedWalletBalances: ({ direction, queryOptions, }?: {
-    direction?: "from" | "to" | undefined;
+    direction?: SwapDirection | undefined;
     queryOptions?: UseQueryOptions<{
         tokens: TokenWithBalance[];
         totalUsdBalance: string;

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

@@ -1,5 +1,6 @@
 import { ChainType } from "@0xsquid/squid-types";
 import { UseQueryOptions, UseQueryResult } from "@tanstack/react-query";
+import { SwapDirection } from "../../core/types/swap";
 import { TokenWithBalance } from "../../core/types/tokens";
 export interface AllTokensBalanceQueryData {
     tokens: TokenWithBalance[];
@@ -8,6 +9,6 @@ export interface AllTokensBalanceQueryData {
 export declare const useAllTokensWithBalanceForChainType: ({ chainType, address, direction, queryOptions, }: {
     chainType?: ChainType | undefined;
     address?: string | undefined;
-    direction?: "from" | "to" | undefined;
+    direction?: SwapDirection | undefined;
     queryOptions?: UseQueryOptions<AllTokensBalanceQueryData, unknown, AllTokensBalanceQueryData, import("@tanstack/react-query").QueryKey> | undefined;
 }) => UseQueryResult<AllTokensBalanceQueryData>;

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

@@ -1,5 +1,9 @@
 import { Token } from "@0xsquid/squid-types";
-export declare const useSquidTokens: (direction?: "from" | "to") => {
+import { SwapDirection } from "../../core/types/swap";
+/**
+ * Returns an array of the available tokens based on the provided config and direction
+ */
+export declare const useSquidTokens: (direction?: SwapDirection) => {
     tokens: Token[];
     findToken: (address?: string, chainId?: string) => Token | undefined;
     evmTokens: Token[];

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

@@ -16,7 +16,6 @@ export declare const useEstimate: (squidRoute?: RouteResponse["route"]) => {
         value: number;
         currency: string | undefined;
     };
-    swapAmountExceedsLimit: boolean;
     enoughBalanceToSwap: boolean;
     feeCostsFormatted: FeeFormatted[];
     totalFeeCostsUsd: string;
@@ -26,7 +25,6 @@ export declare const useEstimate: (squidRoute?: RouteResponse["route"]) => {
     sourceChainNativeToken: import("@0xsquid/squid-types").Token | undefined;
     destChainNativeToken: import("@0xsquid/squid-types").Token | undefined;
     toAmountUSD: string | undefined;
-    toAmountUSDFloat: number;
     exchangeRate: string;
     toAmountMinUSD: string;
     toAmountMin: string;