wagmi-extended 0.8.0 → 1.0.1

package/dist/hooks/{useFetchAssetAllowance.d.ts → useTokenX.d.ts}

@@ -1,25 +1,47 @@
 import { Address } from "viem";
-export declare const fetchAllowance: (asset: Address, spender: Address, userAddress: Address, queryClient: any, config: any) => Promise<{
-    bigIntValue: bigint;
-    decimals: number;
-    symbol: string;
-}>;
 /**
- * Custom hook for fetching asset allowance.
+ * Returns a query key for fetching token data.
  *
- * @param {Address} asset - The address of the ERC20 token contract.
- * @param {Address} spender - The address of the spender to check allowance for.
+ * @param {Address | undefined} asset - The token address.
+ * @returns {Array} A unique query key for the token fetch.
+ *
+ * @example
+ * const queryKey = HookFetchTokenQK("0x123...");
+ */
+export declare const HookFetchTokenQK: (asset?: Address) => any[];
+/**
+ * Custom hook for fetching token metadata using extended Wagmi functionality.
+ *
+ * This hook leverages React Query for data fetching and caching.
+ * It retrieves token metadata (such as symbol, decimals, name, etc.) for a given token address.
+ *
+ * @param {Address} [asset] - The token address.
+ * @returns {Object} An object with the following properties:
+ *   - `data`: The token data (or undefined if not loaded).
+ *   - `isLoading`: Boolean indicating if the data is loading.
+ *   - `error`: Any error encountered during the fetch.
+ *   - `queryKey`: The unique key used for the query.
+ *
+ * @example
+ * // In your component:
+ * function MyTokenComponent() {
+ *   const { data, isLoading, error, queryKey } = useTokenX("0x123456...");
+ *
+ *   if (isLoading) return <div>Loading token data...</div>;
+ *   if (error) return <div>Error: {error.message}</div>;
+ *
+ *   return (
+ *     <div>
+ *       <p>Token Symbol: {data.symbol}</p>
+ *       <p>Decimals: {data.decimals}</p>
+ *       <p>Name: {data.name}</p>
+ *     </div>
+ *   );
+ * }
  */
-export declare const useFetchAssetAllowance: ({ asset, spender, }: {
-    asset?: Address;
-    spender?: Address;
-}) => {
-    data: {
-        bigIntValue: bigint;
-        decimals: number;
-        symbol: string;
-    } | undefined;
-    queryKey: readonly ["hookFetchAllowance", `0x${string}`, `0x${string}`, `0x${string}`, any, any];
+export declare const useTokenX: (asset?: Address) => {
+    data: import("../fetch-functions/fetchTokenX.js").Token | undefined;
+    queryKey: any[];
     error: Error;
     isError: true;
     isPending: false;
@@ -41,24 +63,12 @@ export declare const useFetchAssetAllowance: ({ asset, spender, }: {
     isPaused: boolean;
     isRefetching: boolean;
     isStale: boolean;
-    refetch: (options?: import("@tanstack/react-query").RefetchOptions) => Promise<import("@tanstack/react-query").QueryObserverResult<{
-        bigIntValue: bigint;
-        decimals: number;
-        symbol: string;
-    }, Error>>;
+    refetch: (options?: import("@tanstack/react-query").RefetchOptions) => Promise<import("@tanstack/react-query").QueryObserverResult<import("../fetch-functions/fetchTokenX.js").Token, Error>>;
     fetchStatus: import("@tanstack/react-query").FetchStatus;
-    promise: Promise<{
-        bigIntValue: bigint;
-        decimals: number;
-        symbol: string;
-    }>;
+    promise: Promise<import("../fetch-functions/fetchTokenX.js").Token>;
 } | {
-    data: {
-        bigIntValue: bigint;
-        decimals: number;
-        symbol: string;
-    } | undefined;
-    queryKey: readonly ["hookFetchAllowance", `0x${string}`, `0x${string}`, `0x${string}`, any, any];
+    data: import("../fetch-functions/fetchTokenX.js").Token | undefined;
+    queryKey: any[];
     error: null;
     isError: false;
     isPending: false;
@@ -80,24 +90,12 @@ export declare const useFetchAssetAllowance: ({ asset, spender, }: {
     isPaused: boolean;
     isRefetching: boolean;
     isStale: boolean;
-    refetch: (options?: import("@tanstack/react-query").RefetchOptions) => Promise<import("@tanstack/react-query").QueryObserverResult<{
-        bigIntValue: bigint;
-        decimals: number;
-        symbol: string;
-    }, Error>>;
+    refetch: (options?: import("@tanstack/react-query").RefetchOptions) => Promise<import("@tanstack/react-query").QueryObserverResult<import("../fetch-functions/fetchTokenX.js").Token, Error>>;
     fetchStatus: import("@tanstack/react-query").FetchStatus;
-    promise: Promise<{
-        bigIntValue: bigint;
-        decimals: number;
-        symbol: string;
-    }>;
+    promise: Promise<import("../fetch-functions/fetchTokenX.js").Token>;
 } | {
-    data: {
-        bigIntValue: bigint;
-        decimals: number;
-        symbol: string;
-    } | undefined;
-    queryKey: readonly ["hookFetchAllowance", `0x${string}`, `0x${string}`, `0x${string}`, any, any];
+    data: import("../fetch-functions/fetchTokenX.js").Token | undefined;
+    queryKey: any[];
     error: Error;
     isError: true;
     isPending: false;
@@ -119,24 +117,12 @@ export declare const useFetchAssetAllowance: ({ asset, spender, }: {
     isPaused: boolean;
     isRefetching: boolean;
     isStale: boolean;
-    refetch: (options?: import("@tanstack/react-query").RefetchOptions) => Promise<import("@tanstack/react-query").QueryObserverResult<{
-        bigIntValue: bigint;
-        decimals: number;
-        symbol: string;
-    }, Error>>;
+    refetch: (options?: import("@tanstack/react-query").RefetchOptions) => Promise<import("@tanstack/react-query").QueryObserverResult<import("../fetch-functions/fetchTokenX.js").Token, Error>>;
     fetchStatus: import("@tanstack/react-query").FetchStatus;
-    promise: Promise<{
-        bigIntValue: bigint;
-        decimals: number;
-        symbol: string;
-    }>;
+    promise: Promise<import("../fetch-functions/fetchTokenX.js").Token>;
 } | {
-    data: {
-        bigIntValue: bigint;
-        decimals: number;
-        symbol: string;
-    } | undefined;
-    queryKey: readonly ["hookFetchAllowance", `0x${string}`, `0x${string}`, `0x${string}`, any, any];
+    data: import("../fetch-functions/fetchTokenX.js").Token | undefined;
+    queryKey: any[];
     error: null;
     isError: false;
     isPending: true;
@@ -158,24 +144,12 @@ export declare const useFetchAssetAllowance: ({ asset, spender, }: {
     isPaused: boolean;
     isRefetching: boolean;
     isStale: boolean;
-    refetch: (options?: import("@tanstack/react-query").RefetchOptions) => Promise<import("@tanstack/react-query").QueryObserverResult<{
-        bigIntValue: bigint;
-        decimals: number;
-        symbol: string;
-    }, Error>>;
+    refetch: (options?: import("@tanstack/react-query").RefetchOptions) => Promise<import("@tanstack/react-query").QueryObserverResult<import("../fetch-functions/fetchTokenX.js").Token, Error>>;
     fetchStatus: import("@tanstack/react-query").FetchStatus;
-    promise: Promise<{
-        bigIntValue: bigint;
-        decimals: number;
-        symbol: string;
-    }>;
+    promise: Promise<import("../fetch-functions/fetchTokenX.js").Token>;
 } | {
-    data: {
-        bigIntValue: bigint;
-        decimals: number;
-        symbol: string;
-    } | undefined;
-    queryKey: readonly ["hookFetchAllowance", `0x${string}`, `0x${string}`, `0x${string}`, any, any];
+    data: import("../fetch-functions/fetchTokenX.js").Token | undefined;
+    queryKey: any[];
     error: null;
     isError: false;
     isPending: true;
@@ -197,24 +171,12 @@ export declare const useFetchAssetAllowance: ({ asset, spender, }: {
     isPaused: boolean;
     isRefetching: boolean;
     isStale: boolean;
-    refetch: (options?: import("@tanstack/react-query").RefetchOptions) => Promise<import("@tanstack/react-query").QueryObserverResult<{
-        bigIntValue: bigint;
-        decimals: number;
-        symbol: string;
-    }, Error>>;
+    refetch: (options?: import("@tanstack/react-query").RefetchOptions) => Promise<import("@tanstack/react-query").QueryObserverResult<import("../fetch-functions/fetchTokenX.js").Token, Error>>;
     fetchStatus: import("@tanstack/react-query").FetchStatus;
-    promise: Promise<{
-        bigIntValue: bigint;
-        decimals: number;
-        symbol: string;
-    }>;
+    promise: Promise<import("../fetch-functions/fetchTokenX.js").Token>;
 } | {
-    data: {
-        bigIntValue: bigint;
-        decimals: number;
-        symbol: string;
-    } | undefined;
-    queryKey: readonly ["hookFetchAllowance", `0x${string}`, `0x${string}`, `0x${string}`, any, any];
+    data: import("../fetch-functions/fetchTokenX.js").Token | undefined;
+    queryKey: any[];
     isError: false;
     error: null;
     isPending: false;
@@ -236,15 +198,7 @@ export declare const useFetchAssetAllowance: ({ asset, spender, }: {
     isPaused: boolean;
     isRefetching: boolean;
     isStale: boolean;
-    refetch: (options?: import("@tanstack/react-query").RefetchOptions) => Promise<import("@tanstack/react-query").QueryObserverResult<{
-        bigIntValue: bigint;
-        decimals: number;
-        symbol: string;
-    }, Error>>;
+    refetch: (options?: import("@tanstack/react-query").RefetchOptions) => Promise<import("@tanstack/react-query").QueryObserverResult<import("../fetch-functions/fetchTokenX.js").Token, Error>>;
     fetchStatus: import("@tanstack/react-query").FetchStatus;
-    promise: Promise<{
-        bigIntValue: bigint;
-        decimals: number;
-        symbol: string;
-    }>;
+    promise: Promise<import("../fetch-functions/fetchTokenX.js").Token>;
 };