arrakis-modular

install deps

forge install

compile contracts

forge compile

fill in env vars

cp .envExample .env

NOTE: you must add your own alchemy api key to ETH_RPC_URL

test

forge test -vv

Addresses

Name	Address
ArrakisStandardManager	0x2e6E879648293e939aA68bA4c6c129A1Be733bDA
ArrakisTimeLock	0xAf6f9640092cB1236E5DB6E517576355b6C40b7f
Factory	0x820FB8127a689327C863de8433278d6181123982
PrivateVaultNFT	0x44A801e7E2E073bd8bcE4bCCf653239Fa156B762
Renderer Controller	0x1Cc0Adff599F244f036a5C2425f646Aef884149D
Guardian	0x6F441151B478E0d60588f221f1A35BcC3f7aB981
Public Registry	0x791d75F87a701C3F7dFfcEC1B6094dB22c779603
Private Registry	0xe278C1944BA3321C1079aBF94961E9fF1127A265
Router	0x72aa2C8e6B14F30131081401Fa999fC964A66041
RouterExecutor	0x19488620Cdf3Ff1B0784AC4529Fb5c5AbAceb1B6
Router Resolver	0xC6c53369c36D6b4f4A6c195441Fe2d33149FB265
Valantis Public Module Implementation	0x9Ac1249E37EE1bDc38dC0fF873F1dB0c5E6aDdE3
Valantis Private Module Implementation	0x7E2fc9b2D37EA3E771b6F2375915b87CcA9E55bc

NOTE : deployed on mainnet, arbitrum, base and sepolia.

Arrakis Router Integration

Add Liquidity

Structs

AddLiquidityData :

• amount0Max : maximum amount of token0 user want to use to add liquidity into the vault.
• amount1Max : maximum amount of token1 user want to use to add liquidity into the vault.
• amount0Min : amount of token0 needed to mint shares should be higher or equal to this number.
• amount1Min : amount of token1 needed to mint shares should be higher or equal to this number.
• amountSharesMin : amount of shares of vault token minted should be higher or equal to this number.
• vault : address of the vault where user want to mint shares.
• receiver : address that will receive the shares of vault tokens.

amount0Min, amount1Min and amountSharesMin will help us to protect against vault's underlying tokens ratio manipulation by an attacker. In the same time, it's also possible that the ratio change a bit between our view call to getMintAmounts and the router addLiquidity function call, due to normal activity of other users. So these three values amount0Min, amount1Min and amountSharesMin should be wisely choosen.

Step 1 : Call getMintAmounts

Once we know how much amount0 of token0 and amount1 of token1 user want to provide as liquidity on the selected vault, we can call getMintAmounts of ArrakisPublicVaultRouter.

The function getMintAmounts will give back three values :

• shareToMint : amount of shares of vault receiver will get for amount0ToDeposit and amount0ToDeposit.
• amount0ToDeposit : amount of token0 to deposit into the vault.
• amount1ToDeposit : amount of token1 to deposit into the vault.

Step 2 : Construct AddLiquidityData

We need now to construct AddLiquidityData struct to call addLiquidity function of the router.

• amount0Max will be equal to amount0 inputed by user.
• amount1Max will be equal to amount1 inputed by user.
• amount0Min will be equal to amount0ToDeposit minus a little delta (for example that can be 99% of amount0ToDeposit value).
• amount1Min will be equal to amount1ToDeposit minus a little delta (for example that can be 99% of amount1ToDeposit value).
• amountSharesMin will be equal to shareToMint minus a little delta (for example that can be 99% of shareToMint value).
• vault will be equal to the vault address.
• receiver will be equal to the address that will receive vault's token.