IArrakisMetaVaultPrivate

Functions

function used to deposit tokens or expand position inside the inherent strategy.

function deposit(
    uint256 amount0_,
    uint256 amount1_
) external payable;

Parameters

Name	Type	Description
`amount0_`	`uint256`	amount of token0 need to increase the position by proportion_;
`amount1_`	`uint256`	amount of token1 need to increase the position by proportion_;

function used to withdraw tokens or position contraction of the underpin strategy.

function withdraw(
    uint256 proportion_,
    address receiver_
) external returns (uint256 amount0, uint256 amount1);

Parameters

Name	Type	Description
`proportion_`	`uint256`	the proportion of position contraction.
`receiver_`	`address`	the address that will receive withdrawn tokens.

Returns

Name	Type	Description
`amount0`	`uint256`	amount of token0 returned.
`amount1`	`uint256`	amount of token1 returned.

function used to whitelist depositors.

function whitelistDepositors(address[] calldata depositors_)
    external;

Parameters

Name	Type	Description
`depositors_`	`address[]`	list of address that will be granted to depositor role.

function used to blacklist depositors.

function blacklistDepositors(address[] calldata depositors_)
    external;

Parameters

Name	Type	Description
`depositors_`	`address[]`	list of address who depositor role will be revoked.

function used to get the list of depositors.

function depositors() external view returns (address[] memory);

Returns

Name	Type	Description
`<none>`	`address[]`	depositors list of address granted to depositor role.

Event describing a deposit done by an user inside this vault.

event LogDeposit(uint256 amount0, uint256 amount1);

Parameters

Name	Type	Description
`amount0`	`uint256`	amount of token0 needed to increase the portfolio of "proportion" percent.
`amount1`	`uint256`	amount of token1 needed to increase the portfolio of "proportion" percent.

Event describing a withdrawal of participation by an user inside this vault.

event LogWithdraw(
    uint256 proportion, uint256 amount0, uint256 amount1
);

Parameters

Name	Type	Description
`proportion`	`uint256`	percentage of the current position that user want to withdraw.
`amount0`	`uint256`	amount of token0 withdrawn due to withdraw action.
`amount1`	`uint256`	amount of token1 withdrawn due to withdraw action.

Event describing the whitelist of fund depositor.

event LogWhitelistDepositors(address[] depositors);

Parameters

Name	Type	Description
`depositors`	`address[]`	list of address that are granted to depositor role.

Event describing the blacklist of fund depositor.

event LogBlacklistDepositors(address[] depositors);

Parameters

Name	Type	Description
`depositors`	`address[]`	list of address who depositor role is revoked.

error MintZero();

error BurnZero();

error BurnOverflow();

error DepositorAlreadyWhitelisted();

error NotAlreadyWhitelistedDepositor();

error OnlyDepositor();