UniV4StandardModulePrivate

Git Source

Inherits: UniV4StandardModule, IArrakisLPModulePrivate

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

State Variables

id

id = keccak256(abi.encode("UniV4StandardModulePrivate"))

bytes32 public constant id =
    0xae9c8e22b1f7ab201e144775cd6f848c3c1b0a82315571de8c67ce32ca9a7d44;

Functions

constructor

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

fund

fund function for private vault.

function fund(
    address depositor_,
    uint256 amount0_,
    uint256 amount1_
) external payable onlyMetaVault whenNotPaused nonReentrant;

Parameters

NameTypeDescription
depositor_addressaddress that will provide the tokens.
amount0_uint256amount of token0 that depositor want to send to module.
amount1_uint256amount of token1 that depositor want to send to module.

unlockCallback

Called by the pool manager on msg.sender when a lock is acquired

function unlockCallback(
    bytes calldata data_
) public virtual returns (bytes memory);

Parameters

NameTypeDescription
data_bytesThe data that was passed to the call to lock

Returns

NameTypeDescription
<none>bytesresult data that you want to be returned from the lock call

_fund

use data to do specific action.

function _fund(
    address depositor_,
    uint256 amount0_,
    uint256 amount1_
) internal;