refactor: introduce TransparentProxy in favor of StakeManagerProxy

We use `IStakeManagerProxy` to ensure instances of `TransparentProxy` are stake managers where necessary.
vacp2p · Feb 3, 2025 · a47d46d · a47d46d
1 parent a22da25
commit a47d46d
Show file tree

Hide file tree

Showing 8 changed files with 240 additions and 72 deletions.
diff --git a/.gas-report b/.gas-report
diff --git a/.gas-snapshot b/.gas-snapshot
@@ -10,7 +10,7 @@ IntegrationTest:testStakeFoo() (gas: 1218594)
 LeaveTest:test_LeaveShouldProperlyUpdateAccounting() (gas: 6214173)
 LeaveTest:test_RevertWhenStakeManagerIsTrusted() (gas: 297675)
 LeaveTest:test_TrustNewStakeManager() (gas: 6269901)
-LockTest:test_LockFailsWithInvalidPeriod(uint256) (runs: 1002, μ: 344783, ~: 344801)
+LockTest:test_LockFailsWithInvalidPeriod(uint256) (runs: 1000, μ: 344783, ~: 344801)
 LockTest:test_LockFailsWithNoStake() (gas: 102637)
 LockTest:test_LockFailsWithZero() (gas: 315022)
 LockTest:test_LockWithoutPriorLock() (gas: 393335)

diff --git a/script/DeployRewardsStreamerMP.s.sol b/script/DeployRewardsStreamerMP.s.sol
@@ -3,8 +3,8 @@ pragma solidity ^0.8.26;
 
 import { BaseScript } from "./Base.s.sol";
 import { DeploymentConfig } from "./DeploymentConfig.s.sol";
+import { TransparentProxy } from "../src/TransparentProxy.sol";
 import { IStakeManagerProxy } from "../src/interfaces/IStakeManagerProxy.sol";
-import { StakeManagerProxy } from "../src/StakeManagerProxy.sol";
 import { RewardsStreamerMP } from "../src/RewardsStreamerMP.sol";
 import { StakeVault } from "../src/StakeVault.sol";
 
@@ -16,8 +16,11 @@ contract DeployRewardsStreamerMPScript is BaseScript {
         bytes memory initializeData = abi.encodeCall(RewardsStreamerMP.initialize, (deployer, stakingToken));
 
         vm.startBroadcast(deployer);
+
+        // Deploy RewardsStreamerMP logic contract
         address impl = address(new RewardsStreamerMP());
-        address proxy = address(new StakeManagerProxy(impl, initializeData));
+        // Create upgradeable proxy
+        address proxy = address(new TransparentProxy(impl, initializeData));
         vm.stopBroadcast();
 
         RewardsStreamerMP stakeManager = RewardsStreamerMP(proxy);

diff --git a/src/StakeManagerProxy.sol → src/TransparentProxy.sol b/src/StakeManagerProxy.sol → src/TransparentProxy.sol
@@ -3,7 +3,7 @@ pragma solidity ^0.8.26;
 
 import { ERC1967Proxy } from "@openzeppelin/contracts/proxy/ERC1967/ERC1967Proxy.sol";
 
-contract StakeManagerProxy is ERC1967Proxy {
+contract TransparentProxy is ERC1967Proxy {
     constructor(address _implementation, bytes memory _data) ERC1967Proxy(_implementation, _data) { }
 
     function implementation() external view returns (address) {

diff --git a/src/interfaces/IStakeManagerProxy.sol b/src/interfaces/IStakeManagerProxy.sol
@@ -2,7 +2,6 @@
 pragma solidity ^0.8.26;
 
 import { IStakeManager } from "./IStakeManager.sol";
+import { ITransparentProxy } from "./ITransparentProxy.sol";
 
-interface IStakeManagerProxy is IStakeManager {
-    function implementation() external view returns (address);
-}
+interface IStakeManagerProxy is IStakeManager, ITransparentProxy { }
diff --git a/src/interfaces/ITransparentProxy.sol b/src/interfaces/ITransparentProxy.sol
@@ -0,0 +1,6 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.26;
+
+interface ITransparentProxy {
+    function implementation() external view returns (address);
+}
diff --git a/test/RewardsStreamerMP.t.sol b/test/RewardsStreamerMP.t.sol
@@ -12,7 +12,6 @@ import { RewardsStreamerMP } from "../src/RewardsStreamerMP.sol";
 import { StakeMath } from "../src/math/StakeMath.sol";
 import { StakeVault } from "../src/StakeVault.sol";
 import { IStakeManagerProxy } from "../src/interfaces/IStakeManagerProxy.sol";
-import { StakeManagerProxy } from "../src/StakeManagerProxy.sol";
 import { MockToken } from "./mocks/MockToken.sol";
 import { StackOverflowStakeManager } from "./mocks/StackOverflowStakeManager.sol";
 

diff --git a/test/StakeVault.test.sol b/test/StakeVault.test.sol
@@ -4,7 +4,7 @@ pragma solidity ^0.8.26;
 import { Test } from "forge-std/Test.sol";
 
 import { IStakeManagerProxy } from "../src/interfaces/IStakeManagerProxy.sol";
-import { StakeManagerProxy } from "../src/StakeManagerProxy.sol";
+import { TransparentProxy } from "../src/TransparentProxy.sol";
 import { RewardsStreamerMP } from "../src/RewardsStreamerMP.sol";
 import { StakeVault } from "../src/StakeVault.sol";
 import { MockToken } from "./mocks/MockToken.sol";
@@ -33,7 +33,7 @@ contract StakeVaultTest is Test {
         bytes memory initializeData = abi.encodeWithSelector(
             RewardsStreamerMP.initialize.selector, address(this), address(stakingToken), address(rewardToken)
         );
-        address proxy = address(new StakeManagerProxy(impl, initializeData));
+        address proxy = address(new TransparentProxy(impl, initializeData));
         streamer = RewardsStreamerMP(proxy);
 
         stakingToken.mint(alice, 10_000e18);