Function useBurnToken

  • Beta

    Burn tokens

    Parameters

    Returns UseMutationResult<Omit<{
        data: (() => Promise<unknown>);
        receipt: providers.TransactionReceipt;
    }, "data">, unknown, TokenBurnParams, unknown>

    a mutation object that can be used to burn tokens from the connected wallet

    Example

    const Component = () => {
      const { contract } = useContract("{{contract_address}}");
      const {
        mutate: burnTokens,
        isLoading,
        error,
      } = useBurnToken(contract);

      if (error) {
        console.error("failed to burn tokens", error);
      }

      return (
        <button
          disabled={isLoading}
          onClick={() => burnTokens({ amount: 1000 })}
        >
          Burn!
        </button>
      );
    };

    Twfeature

    ERC20Burnable

    See

    Documentation

Settings

Member Visibility

Theme

Generated using TypeDoc