Add specifying osToken amount to batch deposit/mint calls

stakewise · Jul 1, 2024 · 53b48bd · 53b48bd
1 parent a2114e8
commit 53b48bd
Show file tree

Hide file tree

Showing 37 changed files with 301 additions and 131 deletions.
diff --git a/abi/IEthBlocklistErc20Vault.json b/abi/IEthBlocklistErc20Vault.json
@@ -866,6 +866,11 @@
         "name": "receiver",
         "type": "address"
       },
+      {
+        "internalType": "uint256",
+        "name": "osTokenShares",
+        "type": "uint256"
+      },
       {
         "internalType": "address",
         "name": "referrer",
@@ -876,7 +881,7 @@
     "outputs": [
       {
         "internalType": "uint256",
-        "name": "osTokenShares",
+        "name": "",
         "type": "uint256"
       }
     ],
@@ -1570,6 +1575,11 @@
         "name": "receiver",
         "type": "address"
       },
+      {
+        "internalType": "uint256",
+        "name": "osTokenShares",
+        "type": "uint256"
+      },
       {
         "internalType": "address",
         "name": "referrer",
@@ -1607,7 +1617,7 @@
     "outputs": [
       {
         "internalType": "uint256",
-        "name": "osTokenShares",
+        "name": "",
         "type": "uint256"
       }
     ],

diff --git a/abi/IEthBlocklistVault.json b/abi/IEthBlocklistVault.json
@@ -723,6 +723,11 @@
         "name": "receiver",
         "type": "address"
       },
+      {
+        "internalType": "uint256",
+        "name": "osTokenShares",
+        "type": "uint256"
+      },
       {
         "internalType": "address",
         "name": "referrer",
@@ -733,7 +738,7 @@
     "outputs": [
       {
         "internalType": "uint256",
-        "name": "osTokenShares",
+        "name": "",
         "type": "uint256"
       }
     ],
@@ -1273,6 +1278,11 @@
         "name": "receiver",
         "type": "address"
       },
+      {
+        "internalType": "uint256",
+        "name": "osTokenShares",
+        "type": "uint256"
+      },
       {
         "internalType": "address",
         "name": "referrer",
@@ -1310,7 +1320,7 @@
     "outputs": [
       {
         "internalType": "uint256",
-        "name": "osTokenShares",
+        "name": "",
         "type": "uint256"
       }
     ],

diff --git a/abi/IEthErc20Vault.json b/abi/IEthErc20Vault.json
@@ -790,6 +790,11 @@
         "name": "receiver",
         "type": "address"
       },
+      {
+        "internalType": "uint256",
+        "name": "osTokenShares",
+        "type": "uint256"
+      },
       {
         "internalType": "address",
         "name": "referrer",
@@ -800,7 +805,7 @@
     "outputs": [
       {
         "internalType": "uint256",
-        "name": "osTokenShares",
+        "name": "",
         "type": "uint256"
       }
     ],
@@ -1463,6 +1468,11 @@
         "name": "receiver",
         "type": "address"
       },
+      {
+        "internalType": "uint256",
+        "name": "osTokenShares",
+        "type": "uint256"
+      },
       {
         "internalType": "address",
         "name": "referrer",
@@ -1500,7 +1510,7 @@
     "outputs": [
       {
         "internalType": "uint256",
-        "name": "osTokenShares",
+        "name": "",
         "type": "uint256"
       }
     ],

diff --git a/abi/IEthGenesisVault.json b/abi/IEthGenesisVault.json
@@ -710,6 +710,11 @@
         "name": "receiver",
         "type": "address"
       },
+      {
+        "internalType": "uint256",
+        "name": "osTokenShares",
+        "type": "uint256"
+      },
       {
         "internalType": "address",
         "name": "referrer",
@@ -720,7 +725,7 @@
     "outputs": [
       {
         "internalType": "uint256",
-        "name": "osTokenShares",
+        "name": "",
         "type": "uint256"
       }
     ],
@@ -1253,6 +1258,11 @@
         "name": "receiver",
         "type": "address"
       },
+      {
+        "internalType": "uint256",
+        "name": "osTokenShares",
+        "type": "uint256"
+      },
       {
         "internalType": "address",
         "name": "referrer",
@@ -1290,7 +1300,7 @@
     "outputs": [
       {
         "internalType": "uint256",
-        "name": "osTokenShares",
+        "name": "",
         "type": "uint256"
       }
     ],

diff --git a/abi/IEthPrivErc20Vault.json b/abi/IEthPrivErc20Vault.json
@@ -834,6 +834,11 @@
         "name": "receiver",
         "type": "address"
       },
+      {
+        "internalType": "uint256",
+        "name": "osTokenShares",
+        "type": "uint256"
+      },
       {
         "internalType": "address",
         "name": "referrer",
@@ -844,7 +849,7 @@
     "outputs": [
       {
         "internalType": "uint256",
-        "name": "osTokenShares",
+        "name": "",
         "type": "uint256"
       }
     ],
@@ -1520,6 +1525,11 @@
         "name": "receiver",
         "type": "address"
       },
+      {
+        "internalType": "uint256",
+        "name": "osTokenShares",
+        "type": "uint256"
+      },
       {
         "internalType": "address",
         "name": "referrer",
@@ -1557,7 +1567,7 @@
     "outputs": [
       {
         "internalType": "uint256",
-        "name": "osTokenShares",
+        "name": "",
         "type": "uint256"
       }
     ],

diff --git a/abi/IEthPrivVault.json b/abi/IEthPrivVault.json
@@ -691,6 +691,11 @@
         "name": "receiver",
         "type": "address"
       },
+      {
+        "internalType": "uint256",
+        "name": "osTokenShares",
+        "type": "uint256"
+      },
       {
         "internalType": "address",
         "name": "referrer",
@@ -701,7 +706,7 @@
     "outputs": [
       {
         "internalType": "uint256",
-        "name": "osTokenShares",
+        "name": "",
         "type": "uint256"
       }
     ],
@@ -1223,6 +1228,11 @@
         "name": "receiver",
         "type": "address"
       },
+      {
+        "internalType": "uint256",
+        "name": "osTokenShares",
+        "type": "uint256"
+      },
       {
         "internalType": "address",
         "name": "referrer",
@@ -1260,7 +1270,7 @@
     "outputs": [
       {
         "internalType": "uint256",
-        "name": "osTokenShares",
+        "name": "",
         "type": "uint256"
       }
     ],

diff --git a/abi/IEthVault.json b/abi/IEthVault.json
@@ -647,6 +647,11 @@
         "name": "receiver",
         "type": "address"
       },
+      {
+        "internalType": "uint256",
+        "name": "osTokenShares",
+        "type": "uint256"
+      },
       {
         "internalType": "address",
         "name": "referrer",
@@ -657,7 +662,7 @@
     "outputs": [
       {
         "internalType": "uint256",
-        "name": "osTokenShares",
+        "name": "",
         "type": "uint256"
       }
     ],
@@ -1166,6 +1171,11 @@
         "name": "receiver",
         "type": "address"
       },
+      {
+        "internalType": "uint256",
+        "name": "osTokenShares",
+        "type": "uint256"
+      },
       {
         "internalType": "address",
         "name": "referrer",
@@ -1203,7 +1213,7 @@
     "outputs": [
       {
         "internalType": "uint256",
-        "name": "osTokenShares",
+        "name": "",
         "type": "uint256"
       }
     ],

diff --git a/contracts/interfaces/IEthErc20Vault.sol b/contracts/interfaces/IEthErc20Vault.sol
@@ -58,24 +58,30 @@ interface IEthErc20Vault is
   /**
    * @notice Deposits assets to the vault and mints OsToken shares to the receiver
    * @param receiver The address to receive the OsToken
+   * @param osTokenShares The amount of OsToken shares to mint.
+   *        If set to type(uint256).max, max OsToken shares will be minted based on the deposited amount.
    * @param referrer The address of the referrer
-   * @return osTokenShares The amount of OsToken shares minted
+   * @return The amount of OsToken shares minted
    */
   function depositAndMintOsToken(
     address receiver,
+    uint256 osTokenShares,
     address referrer
-  ) external payable returns (uint256 osTokenShares);
+  ) external payable returns (uint256);
 
   /**
    * @notice Updates the state, deposits assets to the vault and mints OsToken shares to the receiver
    * @param receiver The address to receive the OsToken
+   * @param osTokenShares The amount of OsToken shares to mint.
+   *        If set to type(uint256).max, max OsToken shares will be minted based on the deposited amount.
    * @param referrer The address of the referrer
    * @param harvestParams The parameters for the harvest
-   * @return osTokenShares The amount of OsToken shares minted
+   * @return The amount of OsToken shares minted
    */
   function updateStateAndDepositAndMintOsToken(
     address receiver,
+    uint256 osTokenShares,
     address referrer,
     IKeeperRewards.HarvestParams calldata harvestParams
-  ) external payable returns (uint256 osTokenShares);
+  ) external payable returns (uint256);
 }
diff --git a/contracts/interfaces/IEthVault.sol b/contracts/interfaces/IEthVault.sol
@@ -52,24 +52,30 @@ interface IEthVault is
   /**
    * @notice Deposits assets to the vault and mints OsToken shares to the receiver
    * @param receiver The address to receive the OsToken
+   * @param osTokenShares The amount of OsToken shares to mint.
+   *        If set to type(uint256).max, max OsToken shares will be minted based on the deposited amount.
    * @param referrer The address of the referrer
-   * @return osTokenShares The amount of OsToken shares minted
+   * @return The amount of OsToken shares minted
    */
   function depositAndMintOsToken(
     address receiver,
+    uint256 osTokenShares,
     address referrer
-  ) external payable returns (uint256 osTokenShares);
+  ) external payable returns (uint256);
 
   /**
    * @notice Updates the state, deposits assets to the vault and mints OsToken shares to the receiver
    * @param receiver The address to receive the OsToken
+   * @param osTokenShares The amount of OsToken shares to mint.
+   *        If set to type(uint256).max, max OsToken shares will be minted based on the deposited amount.
    * @param referrer The address of the referrer
    * @param harvestParams The parameters for the harvest
-   * @return osTokenShares The amount of OsToken shares minted
+   * @return The amount of OsToken shares minted
    */
   function updateStateAndDepositAndMintOsToken(
     address receiver,
+    uint256 osTokenShares,
     address referrer,
     IKeeperRewards.HarvestParams calldata harvestParams
-  ) external payable returns (uint256 osTokenShares);
+  ) external payable returns (uint256);
 }
diff --git a/contracts/vaults/ethereum/EthErc20Vault.sol b/contracts/vaults/ethereum/EthErc20Vault.sol
@@ -97,21 +97,27 @@ contract EthErc20Vault is
   /// @inheritdoc IEthErc20Vault
   function depositAndMintOsToken(
     address receiver,
+    uint256 osTokenShares,
     address referrer
-  ) public payable override returns (uint256 osTokenShares) {
+  ) public payable override returns (uint256) {
     deposit(msg.sender, referrer);
-    osTokenShares = _calcMaxOsTokenShares(msg.value);
+    if (osTokenShares == type(uint256).max) {
+      // mint max OsToken shares based on the deposited amount
+      osTokenShares = _calcMaxOsTokenShares(msg.value);
+    }
     mintOsToken(receiver, osTokenShares, referrer);
+    return osTokenShares;
   }
 
   /// @inheritdoc IEthErc20Vault
   function updateStateAndDepositAndMintOsToken(
     address receiver,
+    uint256 osTokenShares,
     address referrer,
     IKeeperRewards.HarvestParams calldata harvestParams
-  ) external payable override returns (uint256 osTokenShares) {
+  ) external payable override returns (uint256) {
     updateState(harvestParams);
-    return depositAndMintOsToken(receiver, referrer);
+    return depositAndMintOsToken(receiver, osTokenShares, referrer);
   }
 
   /// @inheritdoc IERC20