README.md

Burn Tokens

Tries to buy one or more tokens for a given smart contract id.

You must own a token to be able to burn it.

The nftContactId can be supplied as an argument or through the CONTRACT_ADDRESS environment variable.

As with all new SDK api methods, this call should be wrapped in execute and passed a signing method

burn(args: BurnArgs): NearContractCall

burn takes a single argument of type BurnArgs

type BurnArgs = {
  burn: {
    //the contract from which to burn tokens
    //as an argument or through CONTRACT_ADDRESS env
    contractAddress?: string;
    //the array of token ids to burn
    tokenIds: string[];
  }[];
};

React example

Example usage of burn method in a hypothetical React component: {% code title="BurnComponent.ts" overflow="wrap" lineNumbers="true" %}

import { useState } from 'react';
import { useWallet } from '@mintbase-js/react';
import { execute, burn, BurnArgs } from '@mintbase-js/sdk';


export const BurnComponent = ({ tokenIds, contractAddress }:BurnArgs): JSX.Element => {
  
  const { selector } = useWallet();
  
  const handleBurn = async (): Promise<void> => {
    
    const wallet = await selector.wallet();

    await execute(
      {wallet},
      burn({ contractAddress: contractAddress, tokenIds: tokenIds })
    );

  }

  return (
    <div>
      <button onClick={handleBurn}>
        Burn provided token array from {contractAddress}
      </button>
    </div>
  );
};

{% endcode %}