wagmi-extended 0.4.0 → 0.8.0

package/dist/hooks/useContractWriteExtended.d.ts

@@ -1,4 +1,4 @@
-import { WriteExtendedAsyncParams } from "./useHandleTransactionMutation";
+import { WriteExtendedAsyncParams } from "./useHandleTransactionMutation.js";
 /**
  * Custom hook for writing to a smart contract using Wagmi.
  *

package/dist/hooks/useERC20Approve.d.ts

@@ -0,0 +1,28 @@
+import { Address } from "viem";
+/**
+ * Helper function to determine human readable state of approve.
+ *
+ * @param {boolean} isApproved - Indicates if the approval is already done.
+ * @param {boolean} justApproved - Indicates if the user has just approved.
+ * @return {string} - The appropriate button text.
+ */
+export declare function getApproveState(isApproved?: boolean, justApproved?: boolean): "Approve Confirmed" | "Approved" | "Approve";
+/**
+ * Custom hook for approving ERC20 token transfers.
+ *
+ * This hook provides functionality for approving ERC20 token transfers, checking the current allowance, and handling the approval transaction using Wagmi.
+ *
+ * @param {Address} tokenAddress - The address of the ERC20 token contract.
+ * @param {Address} spenderAddress - The address of the spender to approve the transfer to.
+ * @param {bigint} [amount=BigInt(0)] - The amount of tokens to approve for transfer. Defaults to 0.
+ * @returns {Object} Object containing the following properties:
+ * - {boolean} isApproved - Indicates whether the spender is already approved to transfer the specified amount of tokens.
+ * - {boolean} isApproving - Indicates whether an approval transaction is currently pending.
+ * - {Function} approveAsync - Function to trigger the approval transaction.
+ */
+export declare const useERC20Approve: (tokenAddress?: Address, spenderAddress?: Address, amount?: bigint) => {
+    isApproved: boolean;
+    isApproving: boolean;
+    justApproved: boolean;
+    approveAsync: () => Promise<void>;
+};

package/dist/hooks/useFetchAssetAllowance.d.ts

@@ -0,0 +1,250 @@
+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.
+ *
+ * @param {Address} asset - The address of the ERC20 token contract.
+ * @param {Address} spender - The address of the spender to check allowance for.
+ */
+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];
+    error: Error;
+    isError: true;
+    isPending: false;
+    isLoading: false;
+    isLoadingError: false;
+    isRefetchError: true;
+    isSuccess: false;
+    isPlaceholderData: false;
+    status: "error";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    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>>;
+    fetchStatus: import("@tanstack/react-query").FetchStatus;
+    promise: Promise<{
+        bigIntValue: bigint;
+        decimals: number;
+        symbol: string;
+    }>;
+} | {
+    data: {
+        bigIntValue: bigint;
+        decimals: number;
+        symbol: string;
+    } | undefined;
+    queryKey: readonly ["hookFetchAllowance", `0x${string}`, `0x${string}`, `0x${string}`, any, any];
+    error: null;
+    isError: false;
+    isPending: false;
+    isLoading: false;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: true;
+    isPlaceholderData: false;
+    status: "success";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    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>>;
+    fetchStatus: import("@tanstack/react-query").FetchStatus;
+    promise: Promise<{
+        bigIntValue: bigint;
+        decimals: number;
+        symbol: string;
+    }>;
+} | {
+    data: {
+        bigIntValue: bigint;
+        decimals: number;
+        symbol: string;
+    } | undefined;
+    queryKey: readonly ["hookFetchAllowance", `0x${string}`, `0x${string}`, `0x${string}`, any, any];
+    error: Error;
+    isError: true;
+    isPending: false;
+    isLoading: false;
+    isLoadingError: true;
+    isRefetchError: false;
+    isSuccess: false;
+    isPlaceholderData: false;
+    status: "error";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    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>>;
+    fetchStatus: import("@tanstack/react-query").FetchStatus;
+    promise: Promise<{
+        bigIntValue: bigint;
+        decimals: number;
+        symbol: string;
+    }>;
+} | {
+    data: {
+        bigIntValue: bigint;
+        decimals: number;
+        symbol: string;
+    } | undefined;
+    queryKey: readonly ["hookFetchAllowance", `0x${string}`, `0x${string}`, `0x${string}`, any, any];
+    error: null;
+    isError: false;
+    isPending: true;
+    isLoading: true;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: false;
+    isPlaceholderData: false;
+    status: "pending";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    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>>;
+    fetchStatus: import("@tanstack/react-query").FetchStatus;
+    promise: Promise<{
+        bigIntValue: bigint;
+        decimals: number;
+        symbol: string;
+    }>;
+} | {
+    data: {
+        bigIntValue: bigint;
+        decimals: number;
+        symbol: string;
+    } | undefined;
+    queryKey: readonly ["hookFetchAllowance", `0x${string}`, `0x${string}`, `0x${string}`, any, any];
+    error: null;
+    isError: false;
+    isPending: true;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: false;
+    isPlaceholderData: false;
+    status: "pending";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isLoading: boolean;
+    isInitialLoading: boolean;
+    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>>;
+    fetchStatus: import("@tanstack/react-query").FetchStatus;
+    promise: Promise<{
+        bigIntValue: bigint;
+        decimals: number;
+        symbol: string;
+    }>;
+} | {
+    data: {
+        bigIntValue: bigint;
+        decimals: number;
+        symbol: string;
+    } | undefined;
+    queryKey: readonly ["hookFetchAllowance", `0x${string}`, `0x${string}`, `0x${string}`, any, any];
+    isError: false;
+    error: null;
+    isPending: false;
+    isLoading: false;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: true;
+    isPlaceholderData: true;
+    status: "success";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    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>>;
+    fetchStatus: import("@tanstack/react-query").FetchStatus;
+    promise: Promise<{
+        bigIntValue: bigint;
+        decimals: number;
+        symbol: string;
+    }>;
+};

package/dist/hooks/useToken.d.ts

@@ -0,0 +1,179 @@
+import { Address } from "viem";
+export interface Token {
+    symbol: string;
+    decimals: number;
+    name: string;
+}
+export declare const EthTokenData: Token;
+export declare function fetchDecimals(token: Address, queryClient: any, wagmiConfig: any): Promise<number | undefined>;
+export declare function fetchSymbol(token: Address, queryClient: any, wagmiConfig: any): Promise<string>;
+export declare function fetchName(token: Address, queryClient: any, wagmiConfig: any): Promise<string>;
+/**
+ * Fetches the token metadata (symbol, decimals) for the given token address.
+ * Internally calls:
+ *  - `fetchSymbol(token)`   to retrieve the token symbol,
+ *  - `fetchDecimals(token)` to retrieve the token decimals
+ *  - `fetchName(token)`     to retrieve the token name
+ *
+ * @param token - The address of the token.
+ * @returns A `Token` object containing the symbol, decimals.
+ * @throws Will throw an error if symbol or decimals cannot be fetched.
+ */
+export declare function fetchToken(token: Address, queryClient: any, wagmiConfig: any): Promise<Token>;
+export declare const useToken: (asset?: Address) => {
+    data: Token | undefined;
+    error: Error;
+    isError: true;
+    isPending: false;
+    isLoading: false;
+    isLoadingError: false;
+    isRefetchError: true;
+    isSuccess: false;
+    isPlaceholderData: false;
+    status: "error";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    refetch: (options?: import("@tanstack/react-query").RefetchOptions) => Promise<import("@tanstack/react-query").QueryObserverResult<Token, Error>>;
+    fetchStatus: import("@tanstack/react-query").FetchStatus;
+    promise: Promise<Token>;
+} | {
+    data: Token | undefined;
+    error: null;
+    isError: false;
+    isPending: false;
+    isLoading: false;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: true;
+    isPlaceholderData: false;
+    status: "success";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    refetch: (options?: import("@tanstack/react-query").RefetchOptions) => Promise<import("@tanstack/react-query").QueryObserverResult<Token, Error>>;
+    fetchStatus: import("@tanstack/react-query").FetchStatus;
+    promise: Promise<Token>;
+} | {
+    data: Token | undefined;
+    error: Error;
+    isError: true;
+    isPending: false;
+    isLoading: false;
+    isLoadingError: true;
+    isRefetchError: false;
+    isSuccess: false;
+    isPlaceholderData: false;
+    status: "error";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    refetch: (options?: import("@tanstack/react-query").RefetchOptions) => Promise<import("@tanstack/react-query").QueryObserverResult<Token, Error>>;
+    fetchStatus: import("@tanstack/react-query").FetchStatus;
+    promise: Promise<Token>;
+} | {
+    data: Token | undefined;
+    error: null;
+    isError: false;
+    isPending: true;
+    isLoading: true;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: false;
+    isPlaceholderData: false;
+    status: "pending";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    refetch: (options?: import("@tanstack/react-query").RefetchOptions) => Promise<import("@tanstack/react-query").QueryObserverResult<Token, Error>>;
+    fetchStatus: import("@tanstack/react-query").FetchStatus;
+    promise: Promise<Token>;
+} | {
+    data: Token | undefined;
+    error: null;
+    isError: false;
+    isPending: true;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: false;
+    isPlaceholderData: false;
+    status: "pending";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isLoading: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    refetch: (options?: import("@tanstack/react-query").RefetchOptions) => Promise<import("@tanstack/react-query").QueryObserverResult<Token, Error>>;
+    fetchStatus: import("@tanstack/react-query").FetchStatus;
+    promise: Promise<Token>;
+} | {
+    data: Token | undefined;
+    isError: false;
+    error: null;
+    isPending: false;
+    isLoading: false;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: true;
+    isPlaceholderData: true;
+    status: "success";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    refetch: (options?: import("@tanstack/react-query").RefetchOptions) => Promise<import("@tanstack/react-query").QueryObserverResult<Token, Error>>;
+    fetchStatus: import("@tanstack/react-query").FetchStatus;
+    promise: Promise<Token>;
+};