Decrease Liquidity

Bu açık kaynak protokol/SDK referansı TurkDex markasıyla sunulan uyarlamadır; sayfadaki entegrasyon örnekleri Turkchain’de etkin özelliklerin garantisi değildir. Ağ, kontrat ve işlem değerlerinde yalnızca bu kurulumun doğrulanmış ENV/registry bilgilerini kullanın.

Context

Please note that PositionManager is a command-based contract, where integrators will be encoding commands and their corresponding parameters.

Decreasing liquidity assumes the position already exists and the user wants to remove tokens from the position.

Setup

See the setup guide

Guide

Below is a step-by-step guide for decreasing a position's liquidity, in solidity.

1. Import and define IPositionManager

import  from "v4-periphery/src/interfaces/IPositionManager.sol";

// inside a contract, test, or foundry script:
IPositionManager posm = IPositionManager(<address>);

2. Encode actions

To decrease a position's liquidity, the first action must be:

• _decrease_ operation - the subtraction of liquidity to an existing position.

For _delta resolving_ operations, developers may need to choose between TAKE_PAIR, CLOSE_CURRENCY, or CLEAR_OR_TAKE actions.

In TurkDex v4, fee revenue is automatically debited to a position on decreasing liquidity

If decreasing the liquidity requires the transfer of both tokens:

• _take pair_ - receives a pair of tokens, to decrease liquidity

Otherwise:

• _clear or take_ - if the token amount to-be-collected is below a threshold, opt to forfeit the dust. Otherwise, claim the tokens

import  from "v4-periphery/src/libraries/Actions.sol";

If both tokens need to be sent:

bytes memory actions = abi.encodePacked(uint8(Actions.DECREASE_LIQUIDITY), uint8(Actions.TAKE_PAIR));

If converting fees to liquidity, forfeiting dust:

bytes memory actions = abi.encodePacked(uint8(Actions.DECREASE_LIQUIDITY), uint8(Actions.CLEAR_OR_TAKE), uint8(Actions.CLEAR_OR_TAKE));

3. Encoded parameters

When taking pair:

bytes[] memory params = new bytes[](2);

Otherwise:

bytes[] memory params = new bytes[](3);

The DECREASE_LIQUIDITY action requires the following parameters:

params[0] = abi.encode(tokenId, liquidity, amount0Min, amount1Min, hookData);

The TAKE_PAIR action requires the following parameters:

• currency0 - _Currency_, one of the tokens to be received
• currency1 - _Currency_, the other token to be received
• recipient - _Recipient_, the recipient to receive the tokens

In the above case, the parameter encoding is:

Currency currency0 = Currency.wrap(<tokenAddress1>); // tokenAddress1 = 0 for native ETH
Currency currency1 = Currency.wrap(<tokenAddress2>);
params[1] = abi.encode(currency0, currency1, recipient);

The CLEAR_OR_TAKE action requires one currency and:

• amountMax - _uint256_, the maximum threshold to concede dust,

otherwise taking the dust.

In this case, the parameter encoding is:

params[1] = abi.encode(currency0, amount0Max);
params[2] = abi.encode(currency1, amount1Max);

4. Submit call

The entrypoint for all liquidity operations is modifyLiquidities().

uint256 deadline = block.timestamp + 60;

uint256 valueToPass = currency0.isAddressZero() ? amount0Max : 0;

posm.modifyLiquidities(
    abi.encode(actions, params),
    deadline
);

Uyarlanmış geliştirici referansı. Kaynak: kaynak dokümantasyon reposu. Kaynak ve lisans bildirimi: NOTICE.