Rocket Pool Vault

.solcover.js

@@ -1,3 +1,3 @@
 module.exports = {
-  skipFiles: ["vendor/", "test/", "interfaces/"],
+  skipFiles: ["vendor/", "test/", "interfaces/", "vaults/"],
 };

contracts/facets/BidMarketFacet.sol

@@ -3,7 +3,7 @@ pragma solidity ^0.8.0;
 
 import { IBidMarket } from "../interfaces/facets/IBidMarket.sol";
 import { ICryptoPunksMarket } from "../interfaces/ICryptoPunksMarket.sol";
-import { IVault } from "../interfaces/IVault.sol";
+import { IVault } from "../interfaces/vaults/IVault.sol";
 import { LibStorage, BidMarketStorage, VaultStorage, TokenAddressStorage } from "../libraries/LibStorage.sol";
 import { LibVaultUtils } from "../libraries/LibVaultUtils.sol";
 import { BidInputParams, BidInfo } from "../FukuTypes.sol";
@@ -152,7 +152,7 @@ contract BidMarketFacet is IBidMarket {
         // update user balance
         vs.userVaultBalances[bidInfo.bidder][bidInfo.bidInput.vault] -= bidLPTokenAmount;
         // withdraw funds from vault
-        uint256 ethReturned = vault.withdraw(bidLPTokenAmount, payable(this));
+        uint256 ethReturned = vault.withdraw(bidLPTokenAmount, payable(this), abi.encode(bidInfo.bidder));
         // another safety check to make sure enough ETH was withdrawn
         require(bidInfo.bidInput.amount <= ethReturned, "Didn't burn enough LP tokens");
 

contracts/facets/OptionMarketFacet.sol

@@ -3,7 +3,7 @@ pragma solidity ^0.8.0;
 
 import { IOptionMarket } from "../interfaces/facets/IOptionMarket.sol";
 import { ICryptoPunksMarket } from "../interfaces/ICryptoPunksMarket.sol";
-import { IVault } from "../interfaces/IVault.sol";
+import { IVault } from "../interfaces/vaults/IVault.sol";
 import { LibStorage, OptionMarketStorage, VaultStorage, TokenAddressStorage } from "../libraries/LibStorage.sol";
 import { LibVaultUtils } from "../libraries/LibVaultUtils.sol";
 import { OptionDuration, OptionInputParams, OptionInfo } from "../FukuTypes.sol";
@@ -156,7 +156,7 @@ contract OptionMarketFacet is IOptionMarket, IERC721Receiver {
         // update user balance
         vs.userVaultBalances[option.bidder][option.optionInput.bidInput.vault] -= premiumLPTokenAmount;
         // withdraw the premium from bidder's vault
-        uint256 ethReturned = vault.withdraw(premiumLPTokenAmount, payable(this));
+        uint256 ethReturned = vault.withdraw(premiumLPTokenAmount, payable(this), abi.encode(option.bidder));
         // another safety check to make sure enough ETH was withdrawn
         require(option.optionInput.premium <= ethReturned, "Didn't burn enough LP tokens");
 
@@ -244,7 +244,11 @@ contract OptionMarketFacet is IOptionMarket, IERC721Receiver {
         // update user balance
         vs.userVaultBalances[option.bidder][option.optionInput.bidInput.vault] -= strikeLPTokenAmount;
         // withdraw the strike amount from bidder's vault
-        uint256 ethReturned = vault.withdraw(strikeLPTokenAmount, payable(oms.acceptedOptions[optionId].seller));
+        uint256 ethReturned = vault.withdraw(
+            strikeLPTokenAmount,
+            payable(oms.acceptedOptions[optionId].seller),
+            abi.encode(option.bidder)
+        );
         // another safety check to make sure enough ETH was withdrawn
         require(option.optionInput.bidInput.amount <= ethReturned, "Didn't burn enough LP tokens");
 

contracts/facets/VaultAccountingFacet.sol

@@ -2,7 +2,7 @@
 pragma solidity ^0.8.0;
 
 import { IVaultAccounting } from "../interfaces/facets/IVaultAccounting.sol";
-import { IVault } from "../interfaces/IVault.sol";
+import { IVault } from "../interfaces/vaults/IVault.sol";
 import { LibStorage, VaultStorage, DepositsRewardsStorage, TokenAddressStorage } from "../libraries/LibStorage.sol";
 import { LibVaultUtils } from "../libraries/LibVaultUtils.sol";
 import { LibDiamond } from "../vendor/libraries/LibDiamond.sol";
@@ -51,7 +51,8 @@ contract VaultAccountingFacet is IVaultAccounting {
         address vaultAddress = vs.vaultAddresses[vaultName];
 
         // deposit into vault on behalf of sender
-        uint256 lpTokensAmount = IVault(vaultAddress).deposit{ value: msg.value }();
+        bytes memory optionalData = LibVaultUtils.getVaultOptionalData(vaultName);
+        uint256 lpTokensAmount = IVault(vaultAddress).deposit{ value: msg.value }(optionalData);
         vs.userVaultBalances[msg.sender][vaultName] += lpTokensAmount;
 
         emit DepositEth(msg.sender, vaultName, msg.value, lpTokensAmount);
@@ -70,7 +71,8 @@ contract VaultAccountingFacet is IVaultAccounting {
         address vaultAddress = vs.vaultAddresses[vaultName];
 
         // deposit into vault on behalf of sender
-        IVault(vaultAddress).depositLpToken(amount, msg.sender);
+        bytes memory optionalData = LibVaultUtils.getVaultOptionalData(vaultName);
+        IVault(vaultAddress).depositLpToken(amount, msg.sender, optionalData);
         vs.userVaultBalances[msg.sender][vaultName] += amount;
 
         emit DepositLpToken(msg.sender, vaultName, amount);
@@ -93,7 +95,8 @@ contract VaultAccountingFacet is IVaultAccounting {
         // update user balance
         vs.userVaultBalances[msg.sender][vaultName] -= lpTokenAmount;
         // withdraw from vault and send to recipient
-        uint256 amountWithdrawn = IVault(vaultAddress).withdraw(lpTokenAmount, payable(msg.sender));
+        bytes memory optionalData = LibVaultUtils.getVaultOptionalData(vaultName);
+        uint256 amountWithdrawn = IVault(vaultAddress).withdraw(lpTokenAmount, payable(msg.sender), optionalData);
 
         emit Withdraw(msg.sender, vaultName, amountWithdrawn, lpTokenAmount);
     }
@@ -119,7 +122,8 @@ contract VaultAccountingFacet is IVaultAccounting {
         // update user balance
         vs.userVaultBalances[msg.sender][vaultName] -= lpTokenAmount;
         // withdraw from vault and send to recipient
-        IVault(vaultAddress).withdrawLpToken(lpTokenAmount, payable(msg.sender));
+        bytes memory optionalData = LibVaultUtils.getVaultOptionalData(vaultName);
+        IVault(vaultAddress).withdrawLpToken(lpTokenAmount, payable(msg.sender), optionalData);
 
         emit WithdrawLpToken(msg.sender, vaultName, lpTokenAmount);
     }

contracts/facets/VaultManagementFacet.sol

@@ -2,7 +2,7 @@
 pragma solidity ^0.8.0;
 
 import { IVaultManagement } from "../interfaces/facets/IVaultManagement.sol";
-import { IVault } from "../interfaces/IVault.sol";
+import { IVault } from "../interfaces/vaults/IVault.sol";
 import { LibStorage, VaultStorage } from "../libraries/LibStorage.sol";
 import { LibDiamond } from "../vendor/libraries/LibDiamond.sol";
 

contracts/interfaces/vaults/IRocketDelegate.sol

@@ -0,0 +1,36 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity ^0.8.0;
+
+interface IRocketDelegate {
+    /**
+     * @dev Deposits ETH and converts to vault's LP token
+     *
+     * @return The amount of LP tokens received from ETH deposit
+     */
+    function deposit() external payable returns (uint256);
+
+    /**
+     * @dev Deposits LP token directly into vault
+     *
+     * @param amount The amount of LP tokens to deposit
+     * @param user The user depositing
+     */
+    function depositLpToken(uint256 amount, address user) external;
+
+    /**
+     * @dev Converts LP token and withdraws as ETH
+     *
+     * @param lpTokenAmount The amount of LP tokens to withdraw before converting
+     * @param recipient The recipient of the converted ETH
+     * @return The amount of ETH withdrawn
+     */
+    function withdraw(uint256 lpTokenAmount, address payable recipient) external returns (uint256);
+
+    /**
+     * @dev Withdraws LP token directly from vault
+     *
+     * @param lpTokenAmount The amount of LP tokens to withdraw
+     * @param recipient The recipient of the LP tokens
+     */
+    function withdrawLpToken(uint256 lpTokenAmount, address recipient) external;
+}

contracts/interfaces/vaults/IRocketDepositPool.sol

@@ -0,0 +1,8 @@
+// SPDX-License-Identifier: GPL-3.0-only
+pragma solidity ^0.8.0;
+
+interface IRocketDepositPool {
+    function deposit() external payable;
+
+    function getUserLastDepositBlock(address _address) external view returns (uint256);
+}

contracts/interfaces/vaults/IRocketPoolVaultStorage.sol

@@ -0,0 +1,12 @@
+// SPDX-License-Identifier: GPL-3.0-only
+pragma solidity ^0.8.0;
+
+interface IRocketPoolVaultStorage {
+    function setDelegateAddress(address user, address delegateAddress) external;
+
+    function getDelegateAddress(address user) external view returns (address);
+
+    function transferOwnership(address newOwner) external;
+
+    function owner() external view returns (address);
+}

contracts/interfaces/vaults/IRocketStorage.sol

@@ -0,0 +1,6 @@
+// SPDX-License-Identifier: GPL-3.0-only
+pragma solidity ^0.8.0;
+
+interface IRocketStorage {
+    function getAddress(bytes32 _key) external view returns (address);
+}

contracts/interfaces/vaults/IRocketTokenRETH.sol

@@ -0,0 +1,14 @@
+// SPDX-License-Identifier: GPL-3.0-only
+pragma solidity ^0.8.0;
+
+import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
+
+interface IRocketTokenRETH is IERC20 {
+    function getEthValue(uint256 _rethAmount) external view returns (uint256);
+
+    function getRethValue(uint256 _ethAmount) external view returns (uint256);
+
+    function mint(uint256 _ethAmount, address _to) external;
+
+    function burn(uint256 _rethAmount) external;
+}

contracts/interfaces/vaults/IRocketVault.sol

@@ -0,0 +1,35 @@
+pragma solidity ^0.8.0;
+
+// SPDX-License-Identifier: GPL-3.0-only
+import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
+import "@openzeppelin/contracts/token/ERC20/extensions/ERC20Burnable.sol";
+
+interface IRocketVault {
+    function balanceOf(string memory _networkContractName) external view returns (uint256);
+
+    function depositEther() external payable;
+
+    function withdrawEther(uint256 _amount) external;
+
+    function depositToken(
+        string memory _networkContractName,
+        IERC20 _tokenAddress,
+        uint256 _amount
+    ) external;
+
+    function withdrawToken(
+        address _withdrawalAddress,
+        IERC20 _tokenAddress,
+        uint256 _amount
+    ) external;
+
+    function balanceOfToken(string memory _networkContractName, IERC20 _tokenAddress) external view returns (uint256);
+
+    function transferToken(
+        string memory _networkContractName,
+        IERC20 _tokenAddress,
+        uint256 _amount
+    ) external;
+
+    function burnToken(ERC20Burnable _tokenAddress, uint256 _amount) external;
+}

contracts/interfaces/IVault.sol → contracts/interfaces/vaults/IVault.sol

@@ -5,34 +5,50 @@ interface IVault {
     /**
      * @dev Deposits ETH and converts to vault's LP token
      *
+     * @param _data Additional user data if needed
      * @return The amount of LP tokens received from ETH deposit
      */
-    function deposit() external payable returns (uint256);
+    function deposit(bytes memory _data) external payable returns (uint256);
 
     /**
      * @dev Deposits LP token directly into vault
      *
      * @param amount The amount of LP tokens to deposit
      * @param user The user depositing
+     * @param _data Additional user data if needed
      */
-    function depositLpToken(uint256 amount, address user) external;
+    function depositLpToken(
+        uint256 amount,
+        address user,
+        bytes memory _data
+    ) external;
 
     /**
      * @dev Converts LP token and withdraws as ETH
      *
      * @param lpTokenAmount The amount of LP tokens to withdraw before converting
      * @param recipient The recipient of the converted ETH
+     * @param _data Additional user data if needed
      * @return The amount of ETH withdrawn
      */
-    function withdraw(uint256 lpTokenAmount, address payable recipient) external returns (uint256);
+    function withdraw(
+        uint256 lpTokenAmount,
+        address payable recipient,
+        bytes memory _data
+    ) external returns (uint256);
 
     /**
      * @dev Withdraws LP token directly from vault
      *
      * @param lpTokenAmount The amount of LP tokens to withdraw
      * @param recipient The recipient of the LP tokens
+     * @param _data Additional user data if needed
      */
-    function withdrawLpToken(uint256 lpTokenAmount, address recipient) external;
+    function withdrawLpToken(
+        uint256 lpTokenAmount,
+        address recipient,
+        bytes memory _data
+    ) external;
 
     /**
      * @dev Transfers LP tokens to new vault

contracts/libraries/LibVaultUtils.sol

@@ -2,7 +2,7 @@
 pragma solidity ^0.8.0;
 
 import { LibStorage, VaultStorage } from "./LibStorage.sol";
-import { IVault } from "../interfaces/IVault.sol";
+import { IVault } from "../interfaces/vaults/IVault.sol";
 
 import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
 
@@ -30,4 +30,13 @@ library LibVaultUtils {
             return IERC20(vaultLpToken).balanceOf(vault);
         }
     }
+
+    function getVaultOptionalData(bytes12 vaultName) internal view returns (bytes memory optionalData) {
+        // todo: find alternative solution instead of hardcoding
+        bytes12 rocket_vault_name = 0xeeeeeeeeeeeeeeeeeeeeeeed;
+
+        if (vaultName == rocket_vault_name) {
+            optionalData = abi.encode(msg.sender);
+        }
+    }
 }

contracts/test/TestLpTokenVault.sol

@@ -12,19 +12,31 @@ contract TestLpTokenVault is BaseVault {
         lpToken = _lpToken;
     }
 
-    function deposit() external payable override returns (uint256) {
+    function deposit(bytes memory) external payable override returns (uint256) {
         revert("Disabled.");
     }
 
-    function depositLpToken(uint256 amount, address user) external override {
+    function depositLpToken(
+        uint256 amount,
+        address user,
+        bytes memory
+    ) external override {
         IERC20(lpToken).transferFrom(user, address(this), amount);
     }
 
-    function withdraw(uint256, address payable) external pure override returns (uint256) {
+    function withdraw(
+        uint256,
+        address payable,
+        bytes memory
+    ) external pure override returns (uint256) {
         revert("Disabled.");
     }
 
-    function withdrawLpToken(uint256 lpTokenAmount, address recipient) external override {
+    function withdrawLpToken(
+        uint256 lpTokenAmount,
+        address recipient,
+        bytes memory
+    ) external override {
         IERC20(lpToken).transfer(recipient, lpTokenAmount);
     }