react.useburntoken

Home > @openformat/react > useBurnToken

useBurnToken() function

Hook to mint

Signature:

export declare function useBurnToken(token: ERC20Base): {
    burn: import("@tanstack/react-query").UseMutateAsyncFunction<import("ethers").ContractReceipt, unknown, import("@openformat/sdk").ERC20BurnParams, unknown>;
    data: undefined;
    error: null;
    isError: false;
    isIdle: true;
    isLoading: false;
    isSuccess: false;
    status: "idle";
    mutate: import("@tanstack/react-query").UseMutateFunction<import("ethers").ContractReceipt, unknown, import("@openformat/sdk").ERC20BurnParams, unknown>;
    reset: () => void;
    context: unknown;
    failureCount: number;
    failureReason: unknown;
    isPaused: boolean;
    variables: import("@openformat/sdk").ERC20BurnParams | undefined;
} | {
    burn: import("@tanstack/react-query").UseMutateAsyncFunction<import("ethers").ContractReceipt, unknown, import("@openformat/sdk").ERC20BurnParams, unknown>;
    data: undefined;
    error: null;
    isError: false;
    isIdle: false;
    isLoading: true;
    isSuccess: false;
    status: "loading";
    mutate: import("@tanstack/react-query").UseMutateFunction<import("ethers").ContractReceipt, unknown, import("@openformat/sdk").ERC20BurnParams, unknown>;
    reset: () => void;
    context: unknown;
    failureCount: number;
    failureReason: unknown;
    isPaused: boolean;
    variables: import("@openformat/sdk").ERC20BurnParams | undefined;
} | {
    burn: import("@tanstack/react-query").UseMutateAsyncFunction<import("ethers").ContractReceipt, unknown, import("@openformat/sdk").ERC20BurnParams, unknown>;
    data: undefined;
    error: unknown;
    isError: true;
    isIdle: false;
    isLoading: false;
    isSuccess: false;
    status: "error";
    mutate: import("@tanstack/react-query").UseMutateFunction<import("ethers").ContractReceipt, unknown, import("@openformat/sdk").ERC20BurnParams, unknown>;
    reset: () => void;
    context: unknown;
    failureCount: number;
    failureReason: unknown;
    isPaused: boolean;
    variables: import("@openformat/sdk").ERC20BurnParams | undefined;
} | {
    burn: import("@tanstack/react-query").UseMutateAsyncFunction<import("ethers").ContractReceipt, unknown, import("@openformat/sdk").ERC20BurnParams, unknown>;
    data: import("ethers").ContractReceipt;
    error: null;
    isError: false;
    isIdle: false;
    isLoading: false;
    isSuccess: true;
    status: "success";
    mutate: import("@tanstack/react-query").UseMutateFunction<import("ethers").ContractReceipt, unknown, import("@openformat/sdk").ERC20BurnParams, unknown>;
    reset: () => void;
    context: unknown;
    failureCount: number;
    failureReason: unknown;
    isPaused: boolean;
    variables: import("@openformat/sdk").ERC20BurnParams | undefined;
};

Parameters

Parameter	Type	Description
token	ERC20Base	ERC20Base

Returns:

{ burn: import("@tanstack/react-query").UseMutateAsyncFunction<import("ethers").ContractReceipt, unknown, import("@openformat/sdk").ERC20BurnParams, unknown>; data: undefined; error: null; isError: false; isIdle: true; isLoading: false; isSuccess: false; status: "idle"; mutate: import("@tanstack/react-query").UseMutateFunction<import("ethers").ContractReceipt, unknown, import("@openformat/sdk").ERC20BurnParams, unknown>; reset: () => void; context: unknown; failureCount: number; failureReason: unknown; isPaused: boolean; variables: import("@openformat/sdk").ERC20BurnParams | undefined; } | { burn: import("@tanstack/react-query").UseMutateAsyncFunction<import("ethers").ContractReceipt, unknown, import("@openformat/sdk").ERC20BurnParams, unknown>; data: undefined; error: null; isError: false; isIdle: false; isLoading: true; isSuccess: false; status: "loading"; mutate: import("@tanstack/react-query").UseMutateFunction<import("ethers").ContractReceipt, unknown, import("@openformat/sdk").ERC20BurnParams, unknown>; reset: () => void; context: unknown; failureCount: number; failureReason: unknown; isPaused: boolean; variables: import("@openformat/sdk").ERC20BurnParams | undefined; } | { burn: import("@tanstack/react-query").UseMutateAsyncFunction<import("ethers").ContractReceipt, unknown, import("@openformat/sdk").ERC20BurnParams, unknown>; data: undefined; error: unknown; isError: true; isIdle: false; isLoading: false; isSuccess: false; status: "error"; mutate: import("@tanstack/react-query").UseMutateFunction<import("ethers").ContractReceipt, unknown, import("@openformat/sdk").ERC20BurnParams, unknown>; reset: () => void; context: unknown; failureCount: number; failureReason: unknown; isPaused: boolean; variables: import("@openformat/sdk").ERC20BurnParams | undefined; } | { burn: import("@tanstack/react-query").UseMutateAsyncFunction<import("ethers").ContractReceipt, unknown, import("@openformat/sdk").ERC20BurnParams, unknown>; data: import("ethers").ContractReceipt; error: null; isError: false; isIdle: false; isLoading: false; isSuccess: true; status: "success"; mutate: import("@tanstack/react-query").UseMutateFunction<import("ethers").ContractReceipt, unknown, import("@openformat/sdk").ERC20BurnParams, unknown>; reset: () => void; context: unknown; failureCount: number; failureReason: unknown; isPaused: boolean; variables: import("@openformat/sdk").ERC20BurnParams | undefined; }

Example

const { data: transactionReceipt, burn } = useBurn(token);