DecreaseLiquidity

Uniswap V3 Action Plugin - DecreaseLiquidity

Description

Decreases the amount of liquidity in a position and accounts it to the position

Method

decreaseLiquidity((uint256,uint128,uint256,uint256,uint256))

Input Parameters

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

Method Parameters

Name	Plugin Type	Description
params.tuple	FctTuple

"Params.tuple" parameters

Name	Plugin Type	Required?	Description
tokenId	FctValue		The ID of the token
liquidity	FctValue128		Amount of liquidity to decrease
amount0Min	FctValue
amount1Min	FctValue
deadline	FctValue		Deadline of the transaction. Default: block.timestamp

Returned Values

Name	Plugin Type	Description
amount0	FctValue	The amount of token0 sent to recipient
amount1	FctValue	The amount of token1 sent to recipient

Example

Example with initParams

const decreaseLiquidity = new UniswapV3.actions.DecreaseLiquidity({
 chainId: 1,
 initParams: {
   to: "0x..." // Non-fungible Position Manager
   methodParams: {
     "params.tuple": {
       tokenId: "...",
       liquidity: "...",
       amount0Min: "...", 
       amount1Min: "...",
       deadline: "...",
     }
   }
 }
})

Example without initParams

const decreaseLiquidity = new UniswapV3.actions.DecreaseLiquidity({ chainId: 1 })

decreaseLiquidity.input.set({
   to: "0x..." // Non-fungible Position Manager
   methodParams: {
     "params.tuple": {
       tokenId: "...",
       liquidity: "...",
       amount0Min: "...", 
       amount1Min: "...",
       deadline: "...",
     }
   }
})

Learn more

Learn more about Uniswap V3 DecreaseLiquidity function here