This is a vault that autocompound the yield when deposited.

Stake Amount & Deposit Amount are used synonymously.

Shares Amount & Receipt Amount are used synonymously.

Redeemable Amount is calculated during redeeming i.e. redeem function. Here, the deposited amount can't be withdrawn unlike in a simple vault (without auto-compounding yield). Here, the deposited amount can only be redeemed by giving back the receipt tokens.

To deploy the contract with an APY of 0.1% (0.001 in decimal representation) per day, you would use the following value as the constructor argument:

0.001 * 10^18 = 1000000000000000

In the FE UI, the value would be fed in wei, which is 18 decimal places. User might write 0.1% as 0.1, but it is fed as 0.001 * 1e18 in the contract.

It is assumed that whenever someone deposits into the vault, the vault will automatically compound the yield based on the APY set during deployment.

Suppose, if someone stakes token for a month, still the accrued yield will be compounded for the whole month.

CRV:stETH Deposit Token is generally a LP Token of CRV:stETH Pool. And it is based on ERC20 standard. But, we created a mock DepositToken.sol for testing purpose.

• IDepositToken.sol is publicly available.

Here is the user workflow to deposit token into Vault:

sequenceDiagram
actor Alice
participant Vault
participant CRVstETH
participant SCRVstETH
Alice->>CRVstETH: `approve` deposit tokens to Vault
Alice->>Vault: `deposit` for investment
Vault->+CRVstETH: `transferFrom` tokens
CRVstETH->>-Vault: to Vault
Vault->+SCRVstETH: `mint` tokens
SCRVstETH->>-Alice: to Alice

Here is the user workflow to redeem deposited token from Vault:

sequenceDiagram
actor Alice
participant Vault
participant CRVstETH
participant SCRVstETH
Alice->>Vault: `redeem` to withdraw CRVstETH (including accrued interest).
Vault->>SCRVstETH: `burn` tokens
Vault->+CRVstETH: `transfer` tokens
CRVstETH->>-Alice: to Alice

For calculation (simulated), refer to this excel.

This is a list of the most frequently needed commands.

Build the contracts:

$ forge build

Delete the build artifacts and cache directories:

$ forge clean

Get a test coverage report:

$ forge coverage

Deploy to Anvil:

$ forge script script/AutoCompVault.s.sol:AutoCompVaultScript --rpc-url http://localhost:8545 --private-key 0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80 --broadcast

For this script to work, you need to have a MNEMONIC environment variable set to a valid BIP39 mnemonic.

For instructions on how to deploy to a testnet or mainnet, check out the Solidity Scripting tutorial.

Deploy to Goerli and verify on Etherscan:

Set the .env as per the .env.example file.

$ source .env
$ forge script script/AutoCompVault.s.sol --rpc-url $GOERLI_RPC_URL --private-key $DEPLOYER_PRIVATE_KEY --broadcast --verify -vvvvv

With logs enabled using -vvvvv, you can see the transaction hash and the etherscan link.

$ forge flatten src/AutoCompoundVault.sol -o flatten/src/AutoCompoundVaultFlattened.sol

Format the contracts:

$ forge fmt

Get a gas report:

$ forge test --gas-report

To get the snapshot:

$ forge snapshot

Lint the contracts:

$ pnpm lint

Run the tests:

$ forge test

This project is licensed under MIT.