ValantisModule

initialize function to delegate call onced the beacon proxy is deployed, for initializing the valantis module. who can call deposit and withdraw functions.

function initialize(
    address pool_,
    uint256 init0_,
    uint256 init1_,
    uint24 maxSlippage_,
    address metaVault_
) external initializer;

Parameters

Name	Type	Description
`pool_`	`address`	address of the valantis sovereign pool.
`init0_`	`uint256`	initial amount of token0 to provide to valantis module.
`init1_`	`uint256`	initial amount of token1 to provide to valantis module.
`maxSlippage_`	`uint24`	allowed to manager for rebalancing the inventory using swap.
`metaVault_`	`address`	address of the meta vault

initializePosition

function used to initialize the module when a module switch happen

function initializePosition(bytes calldata data_)
    external
    virtual
    onlyMetaVault;

Parameters

Name	Type	Description
`data_`	`bytes`	bytes that contain information to initialize the position.

pause

function used to pause the module.

only callable by guardian

function pause() external onlyGuardian;

unpause

function used to unpause the module.

only callable by guardian

function unpause() external onlyGuardian;

setALMAndManagerFees

set HOT, oracle (wrapper of HOT) and init manager fees function.

function setALMAndManagerFees(
    address alm_,
    address oracle_
) external;

Parameters

Name	Type	Description
`alm_`	`address`	address of the valantis HOT ALM.
`oracle_`	`address`	address of the oracle used by the valantis HOT module.

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

Name	Type	Description
`receiver_`	`address`	address that will receive tokens.
`proportion_`	`uint256`	the proportion of the total position that need to be withdrawn.

Returns

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

withdrawManagerBalance

function used by metaVault or manager to get manager fees.

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

Returns

Name	Type	Description
`amount0`	`uint256`	amount of token0 sent to manager.
`amount1`	`uint256`	amount of token1 sent to manager.

setManagerFeePIPS

function used to set manager fees.

function setManagerFeePIPS(uint256 newFeePIPS_)
    external
    whenNotPaused
    onlyManager;

Parameters

Name	Type	Description
`newFeePIPS_`	`uint256`	new fee that will be applied.

setPriceBounds

fucntion used to set range on valantis AMM

function setPriceBounds(
    uint160 sqrtPriceLowX96_,
    uint160 sqrtPriceHighX96_,
    uint160 expectedSqrtSpotPriceUpperX96_,
    uint160 expectedSqrtSpotPriceLowerX96_
) external onlyManager;

Parameters

Name	Type	Description
`sqrtPriceLowX96_`	`uint160`	lower bound of the range in sqrt price.
`sqrtPriceHighX96_`	`uint160`	upper bound of the range in sqrt price.
`expectedSqrtSpotPriceUpperX96_`	`uint160`	expected lower limit of current spot price (to prevent sandwich attack and manipulation).
`expectedSqrtSpotPriceLowerX96_`	`uint160`	expected upper limit of current spot price (to prevent sandwich attack and manipulation).

swap

function to swap token0->token1 or token1->token0 and then change inventory.

function swap(
    bool zeroForOne_,
    uint256 expectedMinReturn_,
    uint256 amountIn_,
    address router_,
    uint160 expectedSqrtSpotPriceUpperX96_,
    uint160 expectedSqrtSpotPriceLowerX96_,
    bytes calldata payload_
) external onlyManager whenNotPaused;

Parameters

Name	Type	Description
`zeroForOne_`	`bool`	boolean if true token0->token1, if false token1->token0.
`expectedMinReturn_`	`uint256`	minimum amount of tokenOut expected.
`amountIn_`	`uint256`	amount of tokenIn used during swap.
`router_`	`address`	address of smart contract that will execute swap.
`expectedSqrtSpotPriceUpperX96_`	`uint160`	upper bound of current price.
`expectedSqrtSpotPriceLowerX96_`	`uint160`	lower bound of current price.
`payload_`	`bytes`	data payload used for swapping.

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 fees0);

Returns

Name	Type	Description
`fees0`	`uint256`	amount of token0 that manager earned.

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 fees1);

Returns

Name	Type	Description
`fees1`	`uint256`	amount of token1 that manager earned.

validateRebalance

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

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

Parameters

Name	Type	Description
`oracle_`	`IOracleWrapper`	onchain oracle to check the current amm price against.
`maxDeviation_`	`uint24`	maximum deviation tolerated by management.

managerFeePIPS

function used to get manager fees.

function managerFeePIPS() external view returns (uint256);

Returns

Name	Type	Description
`<none>`	`uint256`	managerFeePIPS amount of token1 that manager earned.

getInits

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

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

Returns

Name	Type	Description
`init0`	`uint256`	the amount of token0 needed to open a position.
`init1`	`uint256`	the amount of token1 needed to open a position.

totalUnderlying

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

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

Returns

Name	Type	Description
`<none>`	`uint256`	amount0 the amount of token0 sitting on the position.
`<none>`	`uint256`	amount1 the amount of token1 sitting on the position.

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, uint256);

Parameters

Name	Type	Description
`priceX96_`	`uint160`	price at which we want to simulate our tokens composition

Returns

Name	Type	Description
`<none>`	`uint256`	amount0 the amount of token0 sitting on the position for priceX96.
`<none>`	`uint256`	amount1 the amount of token1 sitting on the position for priceX96.

guardian

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

function guardian() external view returns (address);

Returns

Name	Type	Description
`<none>`	`address`	guardian address of the pauser.

_initializePosition

function _initializePosition() internal;

_checkMinReturn

function _checkMinReturn(
    bool zeroForOne_,
    uint256 expectedMinReturn_,
    uint256 amountIn_,
    uint8 decimals0_,
    uint8 decimals1_
) internal view;

Arrakis Documentation