Enable async withdrawals on superOETHb (#2275)

* Enable async withdrawals on superOETHb * Clean up code * revert modifier change * Update comment * Avoid two reads * Fix base fork tests * A bit more tweaks * Tweak hardhat config a bit * Fix base fork test * Increase optimizer runs * Fix solcover issue * Fix moved file * Slither fixes and a bit more tests * Fix unit tests * Fix bit more tests * Address CR comments * Lint * Remove old values from event * Revert changes to FixedRateDripper * Address CR comments * Fix test
OriginProtocol · Oct 28, 2024 · f484add · f484add
1 parent 95ece09
commit f484add
Show file tree

Hide file tree

Showing 11 changed files with 252 additions and 64 deletions.
diff --git a/contracts/contracts/interfaces/IVault.sol b/contracts/contracts/interfaces/IVault.sol
@@ -264,4 +264,8 @@ interface IVault {
         external
         view
         returns (bool);
+
+    function withdrawalClaimDelay() external view returns (uint256);
+
+    function setWithdrawalClaimDelay(uint256 newDelay) external;
 }
diff --git a/contracts/contracts/vault/OETHBaseVaultCore.sol b/contracts/contracts/vault/OETHBaseVaultCore.sol
@@ -77,37 +77,4 @@ contract OETHBaseVaultCore is OETHVaultCore {
 
         super._redeem(_amount, _minimumUnitAmount);
     }
-
-    // @inheritdoc OETHVaultCore
-    // solhint-disable-next-line no-unused-vars
-    function requestWithdrawal(uint256 _amount)
-        external
-        virtual
-        override
-        returns (uint256, uint256)
-    {
-        revert("Async withdrawals disabled");
-    }
-
-    // @inheritdoc OETHVaultCore
-    // solhint-disable-next-line no-unused-vars
-    function claimWithdrawal(uint256 _requestId)
-        external
-        virtual
-        override
-        returns (uint256)
-    {
-        revert("Async withdrawals disabled");
-    }
-
-    // @inheritdoc OETHVaultCore
-    // solhint-disable-next-line no-unused-vars
-    function claimWithdrawals(uint256[] memory _requestIds)
-        external
-        virtual
-        override
-        returns (uint256[] memory, uint256)
-    {
-        revert("Async withdrawals disabled");
-    }
 }
diff --git a/contracts/contracts/vault/OETHVaultCore.sol b/contracts/contracts/vault/OETHVaultCore.sol
@@ -18,7 +18,6 @@ contract OETHVaultCore is VaultCore {
     using SafeERC20 for IERC20;
     using StableMath for uint256;
 
-    uint256 public constant CLAIM_DELAY = 10 minutes;
     address public immutable weth;
     uint256 public wethAssetIndex;
 
@@ -172,6 +171,8 @@ contract OETHVaultCore is VaultCore {
         nonReentrant
         returns (uint256 requestId, uint256 queued)
     {
+        require(withdrawalClaimDelay > 0, "Async withdrawals not enabled");
+
         // The check that the requester has enough OETH is done in to later burn call
 
         requestId = withdrawalQueueMetadata.nextWithdrawalIndex;
@@ -287,12 +288,14 @@ contract OETHVaultCore is VaultCore {
         internal
         returns (uint256 amount)
     {
+        require(withdrawalClaimDelay > 0, "Async withdrawals not enabled");
+
         // Load the structs from storage into memory
         WithdrawalRequest memory request = withdrawalRequests[requestId];
         WithdrawalQueueMetadata memory queue = withdrawalQueueMetadata;
 
         require(
-            request.timestamp + CLAIM_DELAY <= block.timestamp,
+            request.timestamp + withdrawalClaimDelay <= block.timestamp,
             "Claim delay not met"
         );
         // If there isn't enough reserved liquidity in the queue to claim

diff --git a/contracts/contracts/vault/VaultAdmin.sol b/contracts/contracts/vault/VaultAdmin.sol
@@ -163,6 +163,20 @@ contract VaultAdmin is VaultStorage {
         emit DripperChanged(_dripper);
     }
 
+    /**
+     * @notice Changes the async withdrawal claim period for OETH & superOETHb
+     * @param _delay Delay period (should be between 10 mins to 7 days).
+     *          Set to 0 to disable async withdrawals
+     */
+    function setWithdrawalClaimDelay(uint256 _delay) external onlyGovernor {
+        require(
+            _delay == 0 || (_delay >= 10 minutes && _delay <= 15 days),
+            "Invalid claim delay period"
+        );
+        withdrawalClaimDelay = _delay;
+        emit WithdrawalClaimDelayUpdated(_delay);
+    }
+
     /***************************************
                     Swaps
     ****************************************/

diff --git a/contracts/contracts/vault/VaultStorage.sol b/contracts/contracts/vault/VaultStorage.sol
@@ -68,6 +68,7 @@ contract VaultStorage is Initializable, Governable {
         uint256 _amount
     );
     event WithdrawalClaimable(uint256 _claimable, uint256 _newClaimable);
+    event WithdrawalClaimDelayUpdated(uint256 _newDelay);
 
     // Assets supported by the Vault, i.e. Stablecoins
     enum UnitConversion {
@@ -236,8 +237,16 @@ contract VaultStorage is Initializable, Governable {
     /// @notice Mapping of withdrawal request indices to the user withdrawal request data
     mapping(uint256 => WithdrawalRequest) public withdrawalRequests;
 
+    /// @notice Sets a minimum delay that is required to elapse between
+    ///     requesting async withdrawals and claiming the request.
+    ///     When set to 0 async withdrawals are disabled.
+    // slither-disable-start constable-states
+    // slither-disable-next-line uninitialized-state
+    uint256 public withdrawalClaimDelay;
+    // slither-disable-end constable-states
+
     // For future use
-    uint256[45] private __gap;
+    uint256[44] private __gap;
 
     /**
      * @notice set the implementation for the admin, this needs to be in a base class else we cannot set it

diff --git a/contracts/deploy/base/019_async_withdrawals.js b/contracts/deploy/base/019_async_withdrawals.js
@@ -0,0 +1,45 @@
+const { deployOnBaseWithGuardian } = require("../../utils/deploy-l2");
+const { deployWithConfirmation } = require("../../utils/deploy");
+const addresses = require("../../utils/addresses");
+
+module.exports = deployOnBaseWithGuardian(
+  {
+    deployName: "019_async_withdrawals",
+  },
+  async ({ ethers }) => {
+    const cOETHbVaultProxy = await ethers.getContract("OETHBaseVaultProxy");
+    const cOETHbVault = await ethers.getContractAt(
+      "IVault",
+      cOETHbVaultProxy.address
+    );
+
+    // Deploy new implementation
+    const dOETHbVaultCore = await deployWithConfirmation("OETHBaseVaultCore", [
+      addresses.base.WETH,
+    ]);
+    const dOETHbVaultAdmin = await deployWithConfirmation("OETHBaseVaultAdmin");
+
+    return {
+      actions: [
+        {
+          // 1. Upgrade VaultCore
+          contract: cOETHbVaultProxy,
+          signature: "upgradeTo(address)",
+          args: [dOETHbVaultCore.address],
+        },
+        {
+          // 2. Upgrade VaultAdmin
+          contract: cOETHbVault,
+          signature: "setAdminImpl(address)",
+          args: [dOETHbVaultAdmin.address],
+        },
+        {
+          // 3. Set async claim delay to 1 day
+          contract: cOETHbVault,
+          signature: "setWithdrawalClaimDelay(uint256)",
+          args: [24 * 60 * 60], // 1d
+        },
+      ],
+    };
+  }
+);
diff --git a/contracts/deploy/deployActions.js b/contracts/deploy/deployActions.js
@@ -495,6 +495,11 @@ const configureOETHVault = async (isSimpleOETH) => {
       .connect(sGovernor)
       .setAutoAllocateThreshold(ethers.utils.parseUnits("5", 18))
   );
+
+  // Set withdrawal claim delay to 10m
+  await withConfirmation(
+    cVault.connect(sGovernor).setWithdrawalClaimDelay(10 * 60)
+  );
 };
 
 const deployOUSDHarvester = async (ousdDripper) => {

diff --git a/contracts/deploy/mainnet/108_vault_upgrade.js b/contracts/deploy/mainnet/108_vault_upgrade.js
@@ -0,0 +1,55 @@
+const addresses = require("../../utils/addresses");
+const { deploymentWithGovernanceProposal } = require("../../utils/deploy");
+
+module.exports = deploymentWithGovernanceProposal(
+  {
+    deployName: "108_vault_upgrade",
+    forceDeploy: false,
+    //forceSkip: true,
+    reduceQueueTime: true,
+    deployerIsProposer: false,
+    proposalId: "",
+  },
+  async ({ deployWithConfirmation }) => {
+    // Deployer Actions
+    // ----------------
+
+    // 1. Deploy new OETH Vault Core and Admin implementations
+    const dVaultCore = await deployWithConfirmation("OETHVaultCore", [
+      addresses.mainnet.WETH,
+    ]);
+    const dVaultAdmin = await deployWithConfirmation("OETHVaultAdmin", [
+      addresses.mainnet.WETH,
+    ]);
+
+    // 2. Connect to the OETH Vault as its governor via the proxy
+    const cVaultProxy = await ethers.getContract("OETHVaultProxy");
+    const cVault = await ethers.getContractAt("IVault", cVaultProxy.address);
+
+    // Governance Actions
+    // ----------------
+    return {
+      name: "Upgrade OETH Vault",
+      actions: [
+        // 1. Upgrade the OETH Vault proxy to the new core vault implementation
+        {
+          contract: cVaultProxy,
+          signature: "upgradeTo(address)",
+          args: [dVaultCore.address],
+        },
+        // 2. Set OETH Vault proxy to the new admin vault implementation
+        {
+          contract: cVault,
+          signature: "setAdminImpl(address)",
+          args: [dVaultAdmin.address],
+        },
+        {
+          // 3. Set async claim delay to 10 minutes
+          contract: cVault,
+          signature: "setWithdrawalClaimDelay(uint256)",
+          args: [10 * 60], // 10 mins
+        },
+      ],
+    };
+  }
+);
diff --git a/contracts/hardhat.config.js b/contracts/hardhat.config.js
@@ -104,6 +104,7 @@ module.exports = {
         mnemonic,
       },
       blockGasLimit: 1000000000,
+      allowUnlimitedContractSize: true,
       chainId,
       ...(isArbitrumFork
         ? { tags: ["arbitrumOne"] }

diff --git a/...trategies/aerodrome-amo.base.fork-test.js → ...gies/base/aerodrome-amo.base.fork-test.js b/...trategies/aerodrome-amo.base.fork-test.js → ...gies/base/aerodrome-amo.base.fork-test.js
@@ -3,19 +3,19 @@ const {
   createFixtureLoader,
   nodeRevert,
   nodeSnapshot,
-} = require("../_fixture");
+} = require("../../_fixture");
 
-const addresses = require("../../utils/addresses");
-const { defaultBaseFixture } = require("../_fixture-base");
+const addresses = require("../../../utils/addresses");
+const { defaultBaseFixture } = require("../../_fixture-base");
 const { expect } = require("chai");
-const { oethUnits } = require("../helpers");
+const { oethUnits } = require("../../helpers");
 const ethers = require("ethers");
-const { impersonateAndFund } = require("../../utils/signers");
+const { impersonateAndFund } = require("../../../utils/signers");
 //const { formatUnits } = ethers.utils;
 const { BigNumber } = ethers;
 
 const baseFixture = createFixtureLoader(defaultBaseFixture);
-const { setERC20TokenBalance } = require("../_fund");
+const { setERC20TokenBalance } = require("../../_fund");
 const futureEpoch = 1924064072;
 
 describe("ForkTest: Aerodrome AMO Strategy empty pool setup (Base)", async function () {
@@ -270,6 +270,7 @@ describe("ForkTest: Aerodrome AMO Strategy (Base)", async function () {
     rafael,
     aeroSwapRouter,
     aeroNftManager,
+    harvester,
     quoter;
 
   beforeEach(async () => {
@@ -287,6 +288,7 @@ describe("ForkTest: Aerodrome AMO Strategy (Base)", async function () {
     oethbVaultSigner = await impersonateAndFund(oethbVault.address);
     gauge = fixture.aeroClGauge;
     quoter = fixture.quoter;
+    harvester = fixture.harvester;
 
     await setup();
     await weth
@@ -369,7 +371,7 @@ describe("ForkTest: Aerodrome AMO Strategy (Base)", async function () {
 
       // correct harvester set
       expect(await aerodromeAmoStrategy.harvesterAddress()).to.equal(
-        await strategist.getAddress()
+        harvester.address
       );
 
       await assetLpStakedInGauge();
@@ -471,18 +473,16 @@ describe("ForkTest: Aerodrome AMO Strategy (Base)", async function () {
 
   describe("Harvest rewards", function () {
     it("Should be able to collect reward tokens", async () => {
-      const strategistAddr = await strategist.getAddress();
-
       await setERC20TokenBalance(
         aerodromeAmoStrategy.address,
         aero,
         "1337",
         hre
       );
-      const aeroBalanceBefore = await aero.balanceOf(strategistAddr);
-      await aerodromeAmoStrategy.connect(strategist).collectRewardTokens();
+      const aeroBalanceBefore = await aero.balanceOf(strategist.address);
+      await harvester.connect(strategist).harvest();
 
-      const aeroBalancediff = (await aero.balanceOf(strategistAddr)).sub(
+      const aeroBalancediff = (await aero.balanceOf(strategist.address)).sub(
         aeroBalanceBefore
       );