PancakeSwapV4StandardModule

Git Source

Inherits: ReentrancyGuardUpgradeable, PausableUpgradeable, IArrakisLPModule, IArrakisLPModuleID, IPancakeSwapV4StandardModule, ILockCallback

this module can set pancakeswap v4 pool that have a generic hook, that don't require specific action to become liquidity provider.

due to native coin standard difference between pancakeswap and arrakis, we are assuming that all inputed amounts are using arrakis vault token0/token1 as reference. Internal logic of PancakeSwapV4StandardModule will handle the conversion or use the poolKey to interact with the poolManager.

State Variables

poolManager

ICLPoolManager public immutable poolManager;

vault

IVault public immutable vault;

distributor

IDistributor public immutable distributor;

collector

address public immutable collector;

_guardian

address internal immutable _guardian;

metaVault

module's metaVault as IArrakisMetaVault.

IArrakisMetaVault public metaVault;

token0

module's token0 as IERC20Metadata.

IERC20Metadata public token0;

token1

module's token1 as IERC20Metadata.

IERC20Metadata public token1;

isInversed

boolean to know if the poolKey's currencies pair are inversed.

bool public isInversed;

managerFeePIPS

manager fees share.

uint256 public managerFeePIPS;

oracle

oracle that will be used to proctect rebalances against attacks.

IOracleWrapper public oracle;

maxSlippage

max slippage that can occur during swap rebalance.

uint24 public maxSlippage;

poolKey

pool's key of the module.

PoolKey public poolKey;

ethWithdrawers

list of allowed addresses to withdraw eth.

mapping(address => uint256) public ethWithdrawers;

_init0

uint256 internal _init0;

_init1

uint256 internal _init1;

_ranges

Range[] internal _ranges;

_activeRanges

mapping(bytes32 => bool) internal _activeRanges;

Functions

onlyManager

modifier onlyManager();

onlyMetaVault

modifier onlyMetaVault();

onlyGuardian

modifier onlyGuardian();

onlyMetaVaultOwner

modifier onlyMetaVaultOwner();

constructor

constructor(
    address poolManager_,
    address guardian_,
    address vault_,
    address distributor_,
    address collector_
);

pause

function used to pause the module.

only callable by guardian

function pause() external whenNotPaused onlyGuardian;

unpause

function used to unpause the module.

only callable by guardian

function unpause() external whenPaused onlyGuardian;

initialize

initialize function to delegate call onced the beacon proxy is deployed, for initializing the uniswap v4 standard module.

function initialize(
    uint256 init0_,
    uint256 init1_,
    bool isInversed_,
    PoolKey calldata poolKey_,
    IOracleWrapper oracle_,
    uint24 maxSlippage_,
    address metaVault_
) external initializer;

Parameters

initializePosition

function used to initialize the module when a module switch happen

check if the pool is initialized.

function initializePosition(
    bytes calldata
) external virtual onlyMetaVault;

withdrawEth

left over will sit on the module.

function withdrawEth(
    uint256 amount_
) external nonReentrant whenNotPaused;

approve

function approve(
    address spender_,
    address[] calldata tokens_,
    uint256[] calldata amounts_
) external nonReentrant whenNotPaused onlyMetaVaultOwner;

setPool

function used to set the pool for the module.

function setPool(
    PoolKey calldata poolKey_,
    LiquidityRange[] calldata liquidityRanges_,
    SwapPayload calldata swapPayload_,
    uint256 minBurn0_,
    uint256 minBurn1_,
    uint256 minDeposit0_,
    uint256 minDeposit1_
) external onlyManager nonReentrant whenNotPaused;

Parameters

withdraw

function used by metaVault to withdraw tokens from the strategy.

function withdraw(
    address receiver_,
    uint256 proportion_
)
    public
    virtual
    onlyMetaVault
    nonReentrant
    returns (uint256 amount0, uint256 amount1);

Parameters

Returns

rebalance

function used to rebalance the inventory of the module.

function rebalance(
    LiquidityRange[] memory liquidityRanges_,
    SwapPayload memory swapPayload_,
    uint256 minBurn0_,
    uint256 minBurn1_,
    uint256 minDeposit0_,
    uint256 minDeposit1_
)
    public
    onlyManager
    nonReentrant
    whenNotPaused
    returns (
        uint256 amount0Minted,
        uint256 amount1Minted,
        uint256 amount0Burned,
        uint256 amount1Burned
    );

Parameters

Returns

withdrawManagerBalance

function used by metaVault or manager to get manager fees.

function withdrawManagerBalance()
    public
    nonReentrant
    whenNotPaused
    returns (uint256 amount0, uint256 amount1);

Returns

setManagerFeePIPS

function used to set manager fees.

default swapPayload, no swap happens here. swapPayload will be empty. And will use it to do rebalance and collect fees.

function setManagerFeePIPS(
    uint256 newFeePIPS_
) external onlyManager whenNotPaused;

Parameters

receive

receive() external payable;

guardian

function used to get the address that can pause the module.

function guardian() external view returns (address);

Returns

getRanges

function used to get the list of active ranges.

function getRanges() external view returns (Range[] memory ranges);

Returns

getInits

function used to get the initial amounts needed to open a position.

function getInits()
    external
    view
    returns (uint256 init0, uint256 init1);

Returns

totalUnderlying

function used to get the amount of token0 and token1 sitting on the position.

function totalUnderlying()
    external
    view
    returns (uint256 amount0, uint256 amount1);

Returns

totalUnderlyingAtPrice

function used to get the amounts of token0 and token1 sitting on the position for a specific price.

function totalUnderlyingAtPrice(
    uint160 priceX96_
) external view returns (uint256 amount0, uint256 amount1);

Parameters

Returns

validateRebalance

function used to validate if module state is not manipulated before rebalance.

function validateRebalance(
    IOracleWrapper oracle_,
    uint24 maxDeviation_
) external view;

Parameters

managerBalance0

function used to get manager token0 balance.

amount of fees in token0 that manager have not taken yet.

function managerBalance0()
    external
    view
    returns (uint256 managerFee0);

Returns

managerBalance1

function used to get manager token1 balance.

amount of fees in token1 that manager have not taken yet.

function managerBalance1()
    external
    view
    returns (uint256 managerFee1);

Returns

_lockAcquired

function _lockAcquired(
    Action action_,
    bytes memory data_
) internal returns (bytes memory);

_internalRebalance

function _internalRebalance(
    LiquidityRange[] memory liquidityRanges_,
    SwapPayload memory swapPayload_
)
    internal
    returns (
        uint256 amount0Minted,
        uint256 amount1Minted,
        uint256 amount0Burned,
        uint256 amount1Burned
    );

Enums

Action

enum Action {
    WITHDRAW,
    REBALANCE,
    DEPOSIT_FUND
}