/fixed-rate-eth-vault

Primary LanguageTypeScript

Fixed Rate ETH Vault

Specifications

Hopefully, you are familiar with the LSD product offered on top of the Stakehouse protocol; if not, please take a look here: https://docs.joinstakehouse.com/lsd/overview

Take a look at the section on giant pools. Users can stake in either to either choose between a fixed rate of return from consensus layer yield or get unpredictable but potentially higher returns from the fees and mev pool.

What if users can get a fixed rate of return using both sources? The idea is that they supply ETH, and someone else manages that ETH to ensure a fixed rate of return.

Challenge: Create a yearn vault-style contract that will take ETH from users and give them an LP token back. The vault manager can choose to re-market that with either giant pool mentioned above in order to get LP tokens from those contracts. The ETH from users cannot be used for other purposes other than depositing ETH into giant pools (using depositETH method as appropriate).

  • Withdraw dETH from giant savETH pool contract and method for selling the dETH for ETH on UniswapClaim
  • ETH rewards from giant fees and mev pool contract into your contract
  • Claim percentage of profits i.e. the contract will give users a fixed rate of return where any excess profits go to the manager of the contract

You can get a preview of the LSD contracts here to give you an idea of methods available for this: https://github.com/stakehouse-dev/lsd-arena

You can also use docs on LSD wizard above to find out other info. Take a look here for contract addresses for giant pools: https://github.com/stakehouse-dev/contract-deployments#goerli-deployment-1

Development steps

Implementation

Vault contract

  • Vault contract itself is ERC20 token represents the pool share of the user.
  • Owner can update annual fixed rate and strategy contract address.
  • Users can deposit ETH and get shares of the vault. And the deposited ETH is transferred to the strategy. Here shares = amount / index where index is increased by time (based on annual fixed rate)
  • Users can withdraw amount based on their shares of the vault. Here amount = share * index where index is increased by time (based on annual fixed rate)

Strategy contract

  • updateManager Owner can set manager of the strategy.
  • updateDEthUniswapV3PoolFee Manager can update the fee of DETH/ETH Uniswap V3 Pool. This pool fee is used to swap DETH to ETH in sellDETH function.
  • depositETH Manager can deposit ETH into Giant Protected Staking Pool or Giant Fees And Mev Pool.
  • withdrawETH Manager can withdraw ETH from Giant Protected Staking Pool or Giant Fees And Mev Pool.
  • withdrawDETH Manager can withdraw DETH from Giant Protected Staking Pool. Here if sell flag is true, then it will automatically sell withdrawn DETH to ETH vai Uniswap V3.
  • sellDETH Manager can well DETH withdrawn from Giant Protected Staking Pool. This function will be called with sell flag of withdrawDETH function.
  • claimRewards Manager can claim rewards from Giant Fees And Mev Pool.
  • withdrawManagerProfit Manager can withdraw excess profit. profit = totalETH of stratey - totalETH owed to users
  • withdraw This function is only called through vault contract when users try to withdraw their ETH. It checks the ETH balance of strategy. If ETH balance is not enough, it will withdraw ETH from Giant Protected Staking Pool for the lack of quantity. If it's even not enough, it will withdraw ETH from Giant Fees And Mev Pool. Then it will withdraw ETH to users. ** here we can update this withdraw logic if we want. e.g. we can try to withdarw half of lack from Giant Protected Staking Pool and another half from Giant Fees And Mev Pool.

Hardhat

Update .env

GOERLI_URL=goerli rpc url for forking
ETHERSCAN_API_KEY=etherscan api key for contracts verification

Compile contracts

yarn compile

Run tests

yarn test

Run coverage tests

yarn coverage