1 of 1

hts/wipeToken

How to call the API from an app

Hedera Wallet Snap connects to your currently connected Metamask account by default. To learn how apps can connect to Hedera Wallet Snap using a non-metamask(external) account, refer to this documentation.

Then, depending on whether you're trying to connect to a metamask account or a non-metamask account, you can call the snap API in the following way:

const snapId = `npm:@hashgraph/hedera-wallet-snap`

const wipeTokenAPI = async () => {
  const externalAccountParams = {
    externalAccount: {
      accountIdOrEvmAddress: '0.0.12345',
      curve: 'ED25519'
    }
  }

  await window.ethereum.request({
    method: 'wallet_invokeSnap',
    params: {
      snapId,
      request: {
        method: 'hts/wipeToken',
        params: {
          network: 'testnet',
          assetType: 'TOKEN', // TOKEN | NFT
          tokenId: '0.0.4279119',
          accountId: '0.0.1',
          amount: 100,
          serialNumbers?, // Optional param - only needed for NFTs and is of type Number[]
          /* 
            Uncomment the below line if you want to connect 
            to a non-metamask account
          */
          // ...externalAccountParams
        }
      }
    }
  })
}

You must call this API with the account that has the ability to wipe tokens from an account. This is defined during account creation with wipePublicKey parameter.

What the API does

Retrieves the currently connected account the user has selected on Metamask. If it's the first time, a new snap account is created and the account info is saved in snap state.
Parses the arguments that were passed such as the tokenId, accountId, amount, etc.
Calls the Hedera SDK Wipe Token API to wipes the provided amount of fungible or non-fungible tokens from the specified Hedera account. This transaction does not delete tokens from the treasury account. Wiping an account's tokens burns the tokens and decreases the total supply.
This action cannot be called if this token was created without passing the wipePublicKey parameter. Furthermore, this action must also be called using the same public key account.
Returns the transaction receipt as response

An example response:

{
    "currentAccount": {
        "metamaskEvmAddress": "0x0b3628d1b838993b5fceec8b2a26502e7a8e5241",
        "externalEvmAddress": "",
        "hederaAccountId": "0.0.3581604",
        "hederaEvmAddress": "0xca53f9c93d30e0b7212d67901e5a24fb090d542b",
        "publicKey": "0x0206022cea4c6dd6d2e7263b8802253971de922f5380661d97cba82dee66f57ad6",
        "balance": {
            "hbars": 96.02237649,
            "timestamp": "Fri, 26 Apr 2024 17:18:14 GMT",
            "tokens": {
                "0.0.4279119": {
                    "balance": 50,
                    "decimals": 1,
                    "tokenId": "0.0.4279119",
                    "name": "Tuum",
                    "symbol": "TUUM",
                    "tokenType": "FUNGIBLE_COMMON",
                    "supplyType": "INFINITE",
                    "totalSupply": "50",
                    "maxSupply": "0"
                },
                "0.0.4284930": {
                    "balance": 50,
                    "decimals": 1,
                    "tokenId": "0.0.4284930",
                    "name": "Pulse",
                    "symbol": "PULSE",
                    "tokenType": "FUNGIBLE_COMMON",
                    "supplyType": "INFINITE",
                    "totalSupply": "100",
                    "maxSupply": "0"
                }
            }
        },
        "network": "testnet",
        "mirrorNodeUrl": "https://testnet.mirrornode.hedera.com"
    },
    "receipt": {
        "status": "SUCCESS",
        "accountId": "",
        "fileId": "",
        "contractId": "",
        "topicId": "",
        "tokenId": "",
        "scheduleId": "",
        "exchangeRate": {
            "hbars": 30000,
            "cents": 331526,
            "expirationTime": "Fri, 26 Apr 2024 18:00:00 GMT",
            "exchangeRateInCents": 11.050866666666666
        },
        "topicSequenceNumber": "0",
        "topicRunningHash": "",
        "totalSupply": "900",
        "scheduledTransactionId": "",
        "serials": [],
        "duplicates": [],
        "children": []
    }
}

Live Demo on CodePen

Note: Visit https://pulse.tuum.tech/ to activate your hedera account before you interact with the demo
If you're getting any errors with the live demo, make sure you go through the FAQs section to learn about what you may be missing. You need to install Metamask in your browser for the live demo to work.
To ease the integration of Hedera Wallet Snap on an application, we have created a template web application that you can run locally and check out the code in its entirety to learn how you can integrate and interact with various APIs exposed by Hedera Wallet Snap. Check out the full source code at template application github repository.
You can also check out the API reference to learn how each API works.

hts/wipeToken

How to call the API from an app

Then, depending on whether you're trying to connect to a metamask account or a non-metamask account, you can call the snap API in the following way:

const snapId = `npm:@hashgraph/hedera-wallet-snap`

const wipeTokenAPI = async () => {
  const externalAccountParams = {
    externalAccount: {
      accountIdOrEvmAddress: '0.0.12345',
      curve: 'ED25519'
    }
  }

  await window.ethereum.request({
    method: 'wallet_invokeSnap',
    params: {
      snapId,
      request: {
        method: 'hts/wipeToken',
        params: {
          network: 'testnet',
          assetType: 'TOKEN', // TOKEN | NFT
          tokenId: '0.0.4279119',
          accountId: '0.0.1',
          amount: 100,
          serialNumbers?, // Optional param - only needed for NFTs and is of type Number[]
          /* 
            Uncomment the below line if you want to connect 
            to a non-metamask account
          */
          // ...externalAccountParams
        }
      }
    }
  })
}

You must call this API with the account that has the ability to wipe tokens from an account. This is defined during account creation with wipePublicKey parameter.

What the API does

Retrieves the currently connected account the user has selected on Metamask. If it's the first time, a new snap account is created and the account info is saved in snap state.
Parses the arguments that were passed such as the tokenId, accountId, amount, etc.
Calls the Hedera SDK Wipe Token API to wipes the provided amount of fungible or non-fungible tokens from the specified Hedera account. This transaction does not delete tokens from the treasury account. Wiping an account's tokens burns the tokens and decreases the total supply.
This action cannot be called if this token was created without passing the wipePublicKey parameter. Furthermore, this action must also be called using the same public key account.
Returns the transaction receipt as response

An example response:

{
    "currentAccount": {
        "metamaskEvmAddress": "0x0b3628d1b838993b5fceec8b2a26502e7a8e5241",
        "externalEvmAddress": "",
        "hederaAccountId": "0.0.3581604",
        "hederaEvmAddress": "0xca53f9c93d30e0b7212d67901e5a24fb090d542b",
        "publicKey": "0x0206022cea4c6dd6d2e7263b8802253971de922f5380661d97cba82dee66f57ad6",
        "balance": {
            "hbars": 96.02237649,
            "timestamp": "Fri, 26 Apr 2024 17:18:14 GMT",
            "tokens": {
                "0.0.4279119": {
                    "balance": 50,
                    "decimals": 1,
                    "tokenId": "0.0.4279119",
                    "name": "Tuum",
                    "symbol": "TUUM",
                    "tokenType": "FUNGIBLE_COMMON",
                    "supplyType": "INFINITE",
                    "totalSupply": "50",
                    "maxSupply": "0"
                },
                "0.0.4284930": {
                    "balance": 50,
                    "decimals": 1,
                    "tokenId": "0.0.4284930",
                    "name": "Pulse",
                    "symbol": "PULSE",
                    "tokenType": "FUNGIBLE_COMMON",
                    "supplyType": "INFINITE",
                    "totalSupply": "100",
                    "maxSupply": "0"
                }
            }
        },
        "network": "testnet",
        "mirrorNodeUrl": "https://testnet.mirrornode.hedera.com"
    },
    "receipt": {
        "status": "SUCCESS",
        "accountId": "",
        "fileId": "",
        "contractId": "",
        "topicId": "",
        "tokenId": "",
        "scheduleId": "",
        "exchangeRate": {
            "hbars": 30000,
            "cents": 331526,
            "expirationTime": "Fri, 26 Apr 2024 18:00:00 GMT",
            "exchangeRateInCents": 11.050866666666666
        },
        "topicSequenceNumber": "0",
        "topicRunningHash": "",
        "totalSupply": "900",
        "scheduledTransactionId": "",
        "serials": [],
        "duplicates": [],
        "children": []
    }
}

Live Demo on CodePen

Note: Visit https://pulse.tuum.tech/ to activate your hedera account before you interact with the demo
If you're getting any errors with the live demo, make sure you go through the FAQs section to learn about what you may be missing. You need to install Metamask in your browser for the live demo to work.
To ease the integration of Hedera Wallet Snap on an application, we have created a template web application that you can run locally and check out the code in its entirety to learn how you can integrate and interact with various APIs exposed by Hedera Wallet Snap. Check out the full source code at template application github repository.
You can also check out the API reference to learn how each API works.