Burn

Uniswap V3 Action Plugin - Burn

Description

Burns a token ID, which deletes it from the NFT contract. The token must have 0 liquidity and all tokens must be collected first.

Method

burn(uint256)

Input Parameters

Name	Plugin Type	Description
to	FctAddress	Non-fungible Position Manager Address

Method Parameters

Name	Plugin Type	Description
tokenId	FctValue	The ID of the token that is being burned

Returned Values

No returned values

Example

Example with initParams

const burn = new UniswapV3.actions.Burn({
 chainId: 1,
 initParams: {
   to: "0x..." // Non-fungible Position Manager
   methodParams: {
     tokenId: "..."
   }
 }
})

Example without initParams

const burn = new UniswapV3.actions.Burn({ chainId: 1 })

burn.input.set({
   to: "0x..." // Non-fungible Position Manager
   methodParams: {
     tokenId: "..."
   }
})

Learn more

Learn more about Uniswap V3 Burn function here