@reservoir0x/relay-kit-hooks
Version:
Relay is the Fastest and Cheapest Way to Bridge and Transact Across Chains.
141 lines • 5.83 kB
TypeScript
import { type paths } from '@reservoir0x/relay-sdk';
import { useQuery, type DefaultError, type QueryKey } from '@tanstack/react-query';
type ChainsQuery = paths['/chains']['get']['parameters']['query'] & {
referrer?: string;
};
export type ChainsResponse = paths['/chains']['get']['responses']['200']['content']['application/json'];
type QueryType = typeof useQuery<ChainsResponse, DefaultError, ChainsResponse, QueryKey>;
type QueryOptions = Parameters<QueryType>['0'];
export declare const queryRelayChains: (baseApiUrl?: string, options?: ChainsQuery, headers?: HeadersInit) => Promise<ChainsResponse>;
export default function (baseApiUrl?: string, options?: ChainsQuery, queryOptions?: Partial<QueryOptions>): import("@tanstack/react-query").UseQueryResult<{
chains?: {
id?: number | undefined;
name?: string | undefined;
displayName?: string | undefined;
httpRpcUrl?: string | undefined;
wsRpcUrl?: string | undefined;
explorerUrl?: string | undefined;
explorerName?: string | undefined;
explorerPaths?: {
transaction?: string | undefined;
} | null | undefined;
depositEnabled?: boolean | undefined;
tokenSupport?: "All" | "Limited" | undefined;
disabled?: boolean | undefined;
partialDisableLimit?: number | undefined;
blockProductionLagging?: boolean | undefined;
currency?: {
id?: string | undefined;
symbol?: string | undefined;
name?: string | undefined;
address?: string | undefined;
decimals?: number | undefined;
supportsBridging?: boolean | undefined;
} | undefined;
withdrawalFee?: number | undefined;
depositFee?: number | undefined;
surgeEnabled?: boolean | undefined;
featuredTokens?: {
id?: string | undefined;
symbol?: string | undefined;
name?: string | undefined;
address?: string | undefined;
decimals?: number | undefined;
supportsBridging?: boolean | undefined;
metadata?: {
logoURI?: string | undefined;
} | undefined;
}[] | undefined;
erc20Currencies?: {
id?: string | undefined;
symbol?: string | undefined;
name?: string | undefined;
address?: string | undefined;
decimals?: number | undefined;
supportsBridging?: boolean | undefined;
supportsPermit?: boolean | undefined;
withdrawalFee?: number | undefined;
depositFee?: number | undefined;
surgeEnabled?: boolean | undefined;
}[] | undefined;
solverCurrencies?: {
id?: string | undefined;
symbol?: string | undefined;
name?: string | undefined;
address?: string | undefined;
decimals?: number | undefined;
}[] | undefined;
iconUrl?: string | null | undefined;
logoUrl?: string | null | undefined;
brandColor?: string | null | undefined;
contracts?: {
multicall3?: string | undefined;
multicaller?: string | undefined;
onlyOwnerMulticaller?: string | undefined;
relayReceiver?: string | undefined;
erc20Router?: string | undefined;
approvalProxy?: string | undefined;
} | undefined;
vmType?: "evm" | "svm" | "bvm" | undefined;
explorerQueryParams?: {
[key: string]: unknown;
} | null | undefined;
baseChainId?: number | null | undefined;
statusMessage?: string | null | undefined;
solverAddresses?: string[] | undefined;
tags?: string[] | undefined;
protocol?: {
v2?: {
chainId?: string | null | undefined;
depository?: string | null | undefined;
} | undefined;
} | undefined;
}[] | undefined;
}, Error> & {
viemChains?: ({
blockExplorers?: {
[key: string]: {
name: string;
url: string;
apiUrl?: string | undefined;
};
default: {
name: string;
url: string;
apiUrl?: string | undefined;
};
} | undefined;
contracts?: {
[x: string]: import("viem").ChainContract | {
[sourceId: number]: import("viem").ChainContract | undefined;
} | undefined;
ensRegistry?: import("viem").ChainContract | undefined;
ensUniversalResolver?: import("viem").ChainContract | undefined;
multicall3?: import("viem").ChainContract | undefined;
universalSignatureVerifier?: import("viem").ChainContract | undefined;
} | undefined;
ensTlds?: readonly string[] | undefined;
id: number;
name: string;
nativeCurrency: {
name: string;
symbol: string;
decimals: number;
};
rpcUrls: {
[key: string]: {
http: readonly string[];
webSocket?: readonly string[] | undefined;
};
default: {
http: readonly string[];
webSocket?: readonly string[] | undefined;
};
};
sourceId?: number | undefined;
testnet?: boolean | undefined;
} & import("viem").ChainConfig<import("viem").ChainFormatters | undefined, Record<string, unknown> | undefined>)[] | undefined;
chains?: (import("@reservoir0x/relay-sdk").RelayChain & Required<Pick<import("@reservoir0x/relay-sdk").RelayChain, "viemChain">>)[] | undefined;
};
export {};
//# sourceMappingURL=useRelayChains.d.ts.map