Merge pull request #328 from golemfoundation/support/use-fixed-addresses-for-deployed-contracts

mslomnicki · web-flow · commit 1129987d1d5d · 2025-11-24T12:13:51.000+01:00
chore: modify deployment script to use officially deployed contracts
diff --git a/script/deployment/staging/DeployProtocol.s.sol b/script/deployment/staging/DeployProtocol.s.sol
@@ -15,6 +15,7 @@ import { DeploySkyCompounderStrategyFactory } from "script/deploy/DeploySkyCompo
 import { DeployMorphoCompounderStrategyFactory } from "script/deploy/DeployMorphoCompounderStrategyFactory.sol";
 import { DeployRegenStakerFactory } from "script/deploy/DeployRegenStakerFactory.sol";
 import { DeployAllocationMechanismFactory } from "script/deploy/DeployAllocationMechanismFactory.sol";
+import { DeployedAddresses } from "script/helpers/DeployedAddresses.sol";
 
 /**
  * @title DeployProtocol
@@ -35,6 +36,9 @@ contract DeployProtocol is Script {
     DeployRegenStakerFactory public deployRegenStakerFactory;
     DeployAllocationMechanismFactory public deployAllocationMechanismFactory;
 
+    // Address registry for network-specific deployments
+    DeployedAddresses public immutable deployedAddresses;
+
     // Deployed contract addresses
     address public moduleProxyFactoryAddress;
     address public linearAllowanceSingletonForGnosisSafeAddress;
@@ -50,9 +54,20 @@ contract DeployProtocol is Script {
     address public morphoCompounderStrategyFactoryAddress;
     address public regenStakerFactoryAddress;
     address public allocationMechanismFactoryAddress;
+    // External strategy contracts (tracked for reference, not deployed by this script)
+    address public yieldDonatingTokenizedStrategyAddress;
+    address public yearnV3StrategyFactoryAddress;
 
     error DeploymentFailed();
 
+    /**
+     * @notice Constructor to initialize the deployed addresses registry
+     * @dev Initializes the immutable deployedAddresses variable once
+     */
+    constructor() {
+        deployedAddresses = new DeployedAddresses();
+    }
+
     function setUp() public {
         // Initialize deployment scripts
         deployModuleProxyFactory = new DeployModuleProxyFactory(msg.sender, msg.sender, msg.sender);
@@ -68,66 +83,140 @@ contract DeployProtocol is Script {
         deployAllocationMechanismFactory = new DeployAllocationMechanismFactory();
     }
 
+    /**
+     * @notice Load previously deployed contract addresses for the current network
+     * @dev Uses DeployedAddresses helper to get network-specific addresses via DEPLOYMENT_NETWORK env var
+     *      Any address set to address(0) will trigger fresh deployment in the run() function
+     *      Set DEPLOYMENT_NETWORK to: "mainnet", "sepolia", "staging", or "anvil"
+     */
+    function setUpDeployedContracts() public {
+        DeployedAddresses.ContractAddresses memory addresses = deployedAddresses.getAddressesByEnv();
+
+        // Load all addresses from the centralized registry
+        // Note: yieldDonatingTokenizedStrategy and yearnV3StrategyFactory are EXTERNAL dependencies,
+        // not deployed by this script. They are pre-existing contracts we reference.
+        moduleProxyFactoryAddress = addresses.moduleProxyFactory;
+        linearAllowanceSingletonForGnosisSafeAddress = addresses.linearAllowanceSingleton;
+        dragonTokenizedStrategyAddress = addresses.dragonTokenizedStrategy;
+        dragonRouterAddress = addresses.dragonRouter;
+        splitCheckerAddress = addresses.splitChecker;
+        mockStrategySingletonAddress = addresses.mockStrategySingleton;
+        mockTokenAddress = addresses.mockToken;
+        mockYieldSourceAddress = addresses.mockYieldSource;
+        hatsAddress = addresses.hats;
+        paymentSplitterFactoryAddress = addresses.paymentSplitterFactory;
+        skyCompounderStrategyFactoryAddress = addresses.skyCompounderStrategyFactory;
+        morphoCompounderStrategyFactoryAddress = addresses.morphoCompounderStrategyFactory;
+        regenStakerFactoryAddress = addresses.regenStakerFactory;
+        allocationMechanismFactoryAddress = addresses.allocationMechanismFactory;
+        yieldDonatingTokenizedStrategyAddress = addresses.yieldDonatingTokenizedStrategy;
+        yearnV3StrategyFactoryAddress = addresses.yearnV3StrategyFactory;
+    }
+
     function run() public {
         string memory startingBlock = vm.toString(block.number);
 
         setUp();
+        setUpDeployedContracts();
 
         // Deploy Module Proxy Factory
-        deployModuleProxyFactory.deploy();
-        moduleProxyFactoryAddress = address(deployModuleProxyFactory.moduleProxyFactory());
-        if (moduleProxyFactoryAddress == address(0)) revert DeploymentFailed();
+        if (moduleProxyFactoryAddress == address(0)) {
+            deployModuleProxyFactory.deploy();
+            moduleProxyFactoryAddress = address(deployModuleProxyFactory.moduleProxyFactory());
+            if (moduleProxyFactoryAddress == address(0)) revert DeploymentFailed();
+        }
 
         // Deploy LinearAllowanceSingletonForGnosisSafe
-        deployLinearAllowanceSingletonForGnosisSafe.deploy();
-        linearAllowanceSingletonForGnosisSafeAddress = address(
-            deployLinearAllowanceSingletonForGnosisSafe.linearAllowanceSingletonForGnosisSafe()
-        );
-        if (linearAllowanceSingletonForGnosisSafeAddress == address(0)) revert DeploymentFailed();
+        if (linearAllowanceSingletonForGnosisSafeAddress == address(0)) {
+            deployLinearAllowanceSingletonForGnosisSafe.deploy();
+            linearAllowanceSingletonForGnosisSafeAddress = address(
+                deployLinearAllowanceSingletonForGnosisSafe.linearAllowanceSingletonForGnosisSafe()
+            );
+            if (linearAllowanceSingletonForGnosisSafeAddress == address(0)) revert DeploymentFailed();
+        }
 
         // Deploy Dragon Tokenized Strategy Implementation
-        deployDragonTokenizedStrategy.deploy();
-        dragonTokenizedStrategyAddress = address(deployDragonTokenizedStrategy.dragonTokenizedStrategySingleton());
-        if (dragonTokenizedStrategyAddress == address(0)) revert DeploymentFailed();
+        if (dragonTokenizedStrategyAddress == address(0)) {
+            deployDragonTokenizedStrategy.deploy();
+            dragonTokenizedStrategyAddress = address(deployDragonTokenizedStrategy.dragonTokenizedStrategySingleton());
+            if (dragonTokenizedStrategyAddress == address(0)) revert DeploymentFailed();
+        }
 
         // Deploy Dragon Router
-        deployDragonRouter.deploy();
-        dragonRouterAddress = address(deployDragonRouter.dragonRouterProxy());
-        if (dragonRouterAddress == address(0)) revert DeploymentFailed();
-        splitCheckerAddress = address(deployDragonRouter.splitCheckerProxy());
+        if (dragonRouterAddress == address(0) || splitCheckerAddress == address(0)) {
+            if (dragonRouterAddress != address(0) || splitCheckerAddress != address(0)) {
+                revert DeploymentFailed();
+            }
+            deployDragonRouter.deploy();
+            dragonRouterAddress = address(deployDragonRouter.dragonRouterProxy());
+            if (dragonRouterAddress == address(0)) revert DeploymentFailed();
+            splitCheckerAddress = address(deployDragonRouter.splitCheckerProxy());
+        }
 
         // Deploy Mock Strategy
-        deployMockStrategy.deploy();
-        mockStrategySingletonAddress = address(deployMockStrategy.mockStrategySingleton());
-        if (mockStrategySingletonAddress == address(0)) revert DeploymentFailed();
-        mockTokenAddress = address(deployMockStrategy.token());
-        mockYieldSourceAddress = address(deployMockStrategy.mockYieldSource());
+        if (
+            mockStrategySingletonAddress == address(0) ||
+            mockTokenAddress == address(0) ||
+            mockYieldSourceAddress == address(0)
+        ) {
+            if (
+                mockStrategySingletonAddress != address(0) ||
+                mockTokenAddress != address(0) ||
+                mockYieldSourceAddress != address(0)
+            ) {
+                revert DeploymentFailed();
+            }
+            deployMockStrategy.deploy();
+            mockStrategySingletonAddress = address(deployMockStrategy.mockStrategySingleton());
+            if (mockStrategySingletonAddress == address(0)) revert DeploymentFailed();
+            mockTokenAddress = address(deployMockStrategy.token());
+            mockYieldSourceAddress = address(deployMockStrategy.mockYieldSource());
+        }
 
         // Deploy HATS
-        deployHatsProtocol.deploy();
-        hatsAddress = address(deployHatsProtocol.hats());
+        if (hatsAddress == address(0)) {
+            deployHatsProtocol.deploy();
+            hatsAddress = address(deployHatsProtocol.hats());
+        }
 
         // Deploy Payment Splitter Factory
-        deployPaymentSplitterFactory.deploy();
-        paymentSplitterFactoryAddress = address(deployPaymentSplitterFactory.paymentSplitterFactory());
+        if (paymentSplitterFactoryAddress == address(0)) {
+            deployPaymentSplitterFactory.deploy();
+            paymentSplitterFactoryAddress = address(deployPaymentSplitterFactory.paymentSplitterFactory());
+            if (paymentSplitterFactoryAddress == address(0)) revert DeploymentFailed();
+        }
 
         // Deploy Compounder Strategy Factories
-        deploySkyCompounderStrategyFactory.deploy();
-        skyCompounderStrategyFactoryAddress = address(
-            deploySkyCompounderStrategyFactory.skyCompounderStrategyFactory()
-        );
-        deployMorphoCompounderStrategyFactory.deploy();
-        morphoCompounderStrategyFactoryAddress = address(
-            deployMorphoCompounderStrategyFactory.morphoCompounderStrategyFactory()
-        );
+        if (skyCompounderStrategyFactoryAddress == address(0)) {
+            deploySkyCompounderStrategyFactory.deploy();
+            skyCompounderStrategyFactoryAddress = address(
+                deploySkyCompounderStrategyFactory.skyCompounderStrategyFactory()
+            );
+            if (skyCompounderStrategyFactoryAddress == address(0)) revert DeploymentFailed();
+        }
+
+        // Deploy Morpho Compounder Strategy Factory
+        if (morphoCompounderStrategyFactoryAddress == address(0)) {
+            deployMorphoCompounderStrategyFactory.deploy();
+            morphoCompounderStrategyFactoryAddress = address(
+                deployMorphoCompounderStrategyFactory.morphoCompounderStrategyFactory()
+            );
+            if (morphoCompounderStrategyFactoryAddress == address(0)) revert DeploymentFailed();
+        }
 
         // Deploy Regen Staker Factory
-        deployRegenStakerFactory.deploy();
-        regenStakerFactoryAddress = address(deployRegenStakerFactory.regenStakerFactory());
+        if (regenStakerFactoryAddress == address(0)) {
+            deployRegenStakerFactory.deploy();
+            regenStakerFactoryAddress = address(deployRegenStakerFactory.regenStakerFactory());
+            if (regenStakerFactoryAddress == address(0)) revert DeploymentFailed();
+        }
 
         // Deploy Allocation Mechanism Factory
-        deployAllocationMechanismFactory.deploy();
-        allocationMechanismFactoryAddress = address(deployAllocationMechanismFactory.allocationMechanismFactory());
+        if (allocationMechanismFactoryAddress == address(0)) {
+            deployAllocationMechanismFactory.deploy();
+            allocationMechanismFactoryAddress = address(deployAllocationMechanismFactory.allocationMechanismFactory());
+            if (allocationMechanismFactoryAddress == address(0)) revert DeploymentFailed();
+        }
 
         // Log deployment addresses
         console2.log("\nDeployment Summary:");
diff --git a/script/deployment/staging/README.md b/script/deployment/staging/README.md
@@ -12,10 +12,39 @@ The DeployProtocol script handles the sequential deployment of:
 4. Dragon Router
 5. Mock Strategy (for testing)
 6. Hats Protocol & Dragon Hatter
-7. Payment Splitter Factory
-8. Sky Compounder Strategy Factory
-9. Morpho Compounder Strategy Factory
+7. Payment Splitter Factory (conditional)
+8. Sky Compounder Strategy Factory (conditional)
+9. Morpho Compounder Strategy Factory (conditional)
 10. Regen Staker Factory
+11. Allocation Mechanism Factory
+
+### Smart Deployment with Address Reuse
+
+The deployment script uses a centralized address registry (`script/helpers/DeployedAddresses.sol`) that:
+
+- Reads the `DEPLOYMENT_NETWORK` environment variable to select the network
+- Loads previously deployed contract addresses for that network
+- Skips redeployment for contracts with existing addresses (set to non-zero)
+- Deploys fresh instances for contracts with address(0)
+
+**Why explicit network selection?**
+- Tenderly staging is a mainnet FORK (chain ID = 1)
+- Cannot distinguish between staging and production mainnet by chain ID alone
+- Explicit network selection via env var prevents deployment mistakes
+
+**Supported Networks:**
+- `mainnet` - Ethereum mainnet (production)
+- `sepolia` - Sepolia testnet
+- `staging` - Tenderly virtual testnet (mainnet fork)
+- `anvil` - Local Anvil testnet
+
+This approach:
+- Saves gas by reusing stable factory contracts
+- Ensures consistency across deployments
+- Makes network-specific configuration maintainable
+- Prevents accidental deployments to wrong network
+
+To add addresses for a new network, edit `script/helpers/DeployedAddresses.sol` and add the addresses to the appropriate network function.
 
 ## Prerequisites
 
@@ -27,14 +56,26 @@ The DeployProtocol script handles the sequential deployment of:
 
 Create `.env` file:
 ```
+# Network selection (mainnet, sepolia, staging, or anvil)
+DEPLOYMENT_NETWORK=staging
+
+# Deployment credentials
 PRIVATE_KEY=(deployer private key ex. MetaMask account)
 RPC_URL=https://rpc.ov2sm.octant.build
 VERIFIER_URL=$RPC_URL/verify/etherscan
 VERIFIER_API_KEY=(your Personal Tenderly accessToken)
+
+# Protocol parameters
 MAX_OPEX_SPLIT=5 # to confirm
 MIN_METAPOOL_SPLIT=0 # to confirm
 ```
 
+**Important:** Set `DEPLOYMENT_NETWORK` to match your target environment:
+- Use `staging` for Tenderly virtual testnet (default if not set)
+- Use `mainnet` for production Ethereum mainnet
+- Use `sepolia` for Sepolia testnet
+- Use `anvil` for local Anvil testnet
+
 ## Running the Deployment
 
 ### Automatically
diff --git a/script/helpers/DeployedAddresses.sol b/script/helpers/DeployedAddresses.sol
