Merge pull request #311 from chainbound/jonas/feat/periphery-deploy

feat: periphery deployments

.gitmodules

@@ -4,15 +4,18 @@
 [submodule "bolt-contracts/lib/openzeppelin-contracts"]
 	path = bolt-contracts/lib/openzeppelin-contracts
 	url = https://github.com/OpenZeppelin/openzeppelin-contracts
-[submodule "bolt-contracts/lib/core"]
-	path = bolt-contracts/lib/core
-	url = https://github.com/symbioticfi/core
-[submodule "bolt-contracts/lib/eigenlayer-contracts"]
-	path = bolt-contracts/lib/eigenlayer-contracts
-	url = https://github.com/layr-labs/eigenlayer-contracts
 [submodule "bolt-contracts/lib/openzeppelin-contracts-upgradeable"]
 	path = bolt-contracts/lib/openzeppelin-contracts-upgradeable
 	url = https://github.com/OpenZeppelin/openzeppelin-contracts-upgradeable
 [submodule "bolt-contracts/lib/openzeppelin-foundry-upgrades"]
 	path = bolt-contracts/lib/openzeppelin-foundry-upgrades
 	url = https://github.com/OpenZeppelin/openzeppelin-foundry-upgrades
+[submodule "bolt-contracts/lib/eigenlayer-contracts"]
+	path = bolt-contracts/lib/eigenlayer-contracts
+	url = https://github.com/layr-labs/eigenlayer-contracts
+[submodule "bolt-contracts/lib/core"]
+	path = bolt-contracts/lib/core
+	url = https://github.com/symbioticfi/core
+[submodule "bolt-contracts/lib/eigenlayer-middleware"]
+	path = bolt-contracts/lib/eigenlayer-middleware
+	url = https://github.com/layr-labs/eigenlayer-middleware

bolt-contracts/config/holesky/deployments.json

@@ -1,18 +1,25 @@
 {
     "bolt": {
-        "validators": "0x47D2DC1DE1eFEFA5e6944402f2eda3981D36a9c8"
+        "validators": "0x47D2DC1DE1eFEFA5e6944402f2eda3981D36a9c8",
+        "parameters": "0x20d1cf3A5BD5928dB3118b2CfEF54FDF9fda5c12",
+        "manager": "0x440202829b493F9FF43E730EB5e8379EEa3678CF"
     },
     "symbiotic": {
         "network": "0xb017002D8024d8c8870A5CECeFCc63887650D2a4",
-        "operatorRegistry": "0xAdFC41729fF447974cE27DdFa358A0f2096c3F39",
-        "networkOptInService": "0xF5AFc9FA3Ca63a07E529DDbB6eae55C665cCa83E",
-        "vaultFactory": "0x18C659a269a7172eF78BBC19Fe47ad2237Be0590",
-        "networkRegistry": "0xac5acD8A105C8305fb980734a5AD920b5920106A",
-        "networkMiddlewareService": "0x683F470440964E353b389391CdDDf8df381C282f",
+        "operatorRegistry": "0x6F75a4ffF97326A00e52662d82EA4FdE86a2C548",
+        "networkOptInService": "0x58973d16FFA900D11fC22e5e2B6840d9f7e13401",
+        "vaultFactory": "0x407A039D94948484D356eFB765b3c74382A050B4",
+        "vaultConfigurator": "0xD2191FE92987171691d552C219b8caEf186eb9cA",
+        "networkRegistry": "0x7d03b7343BF8d5cEC7C0C27ecE084a20113D15C9",
+        "networkMiddlewareService": "0x62a1ddfD86b4c1636759d9286D3A0EC722D086e3",
         "middleware": "0x04f40d9CaE475E5BaA462acE53E5c58A0DD8D8e8",
         "supportedVaults": [
-            "0x1df2fbfcD600ADd561013f44B2D055E2e974f605",
-            "0xf427d00c34609053d97167352061DD2F0F27F853"
+            "0xc79c533a77691641d52ebD5e87E51dCbCaeb0D78",
+            "0xe5708788c90e971f73D928b7c5A8FD09137010e0",
+            "0x11c5b9A9cd8269580aDDbeE38857eE451c1CFacd",
+            "0xC56Ba584929c6f381744fA2d7a028fA927817f2b",
+            "0xcDdeFfcD2bA579B8801af1d603812fF64c301462",
+            "0x91e84e12Bb65576C0a6614c5E6EbbB2eA595E10f"
         ]
     },
     "eigenLayer": {

bolt-contracts/config/holesky/vaults.json

@@ -0,0 +1,26 @@
+[
+    {
+        "admin": "0x20A1305Ec6c13FFE8e5289f98ba1A18Aa262c15E",
+        "collateral": "0x8d09a4502Cc8Cf1547aD300E066060D043f6982D"
+    },
+    {
+        "admin": "0x20A1305Ec6c13FFE8e5289f98ba1A18Aa262c15E",
+        "collateral": "0x7322c24752f79c05FFD1E2a6FCB97020C1C264F1"
+    },
+    {
+        "admin": "0x20A1305Ec6c13FFE8e5289f98ba1A18Aa262c15E",
+        "collateral": "0x3F1c547b21f65e10480dE3ad8E19fAAC46C95034"
+    },
+    {
+        "admin": "0x20A1305Ec6c13FFE8e5289f98ba1A18Aa262c15E",
+        "collateral": "0x94373a4919B3240D86eA41593D5eBa789FEF3848"
+    },
+    {
+        "admin": "0x20A1305Ec6c13FFE8e5289f98ba1A18Aa262c15E",
+        "collateral": "0x8720095Fa5739Ab051799211B146a2EEE4Dd8B37"
+    },
+    {
+        "admin": "0x20A1305Ec6c13FFE8e5289f98ba1A18Aa262c15E",
+        "collateral": "0xe3C063B1BEe9de02eb28352b55D49D85514C67FF"
+    }
+]

bolt-contracts/docs/admin/deploying.md

@@ -34,19 +34,28 @@ export ADMIN_PRIVATE_KEY=0x...
 
 ### Pre-deployment
 
-Register a Symbiotic network for Bolt with the Symbiotic `NetworkRegistry`. The private key with which the script is run will determine the network address. This private key will also need to be used later.
+- Register a Symbiotic network for Bolt with the Symbiotic `NetworkRegistry`. The private key with which the script is run will determine the network address. This private key will also need to be used later.
 
 ```bash
 forge script script/holesky/admin/helpers/Symbiotic.s.sol --rpc-url $HOLESKY_RPC --private-key $NETWORK_PRIVATE_KEY --broadcast -vvvv --sig "run(string memory arg)" registerNetwork
 ```
 
-Make sure `deployments.json` contains the correct address for the Symbiotic network.
+Make sure [`deployments.json`](../../config/holesky/deployments.json) contains the correct address for the Symbiotic network.
+
+- Deploy Bolt-specific Symbiotic Vaults. Vaults will be deployed from the [`vaults.json`](../../config/holesky/vaults.json) configuration file.
+
+```bash
+forge script script/holesky/admin/helpers/DeployVaults.s.sol --rpc-url $HOLESKY_RPC --private-key $ADMIN_PRIVATE_KEY --verify --broadcast -vvvv
+```
+
+If vaults with the `(collateral, admin)` combination already exist, they won't be recreated. After these vaults have been created, copy their
+addresses into the [`deployments.json`](../../config/holesky/deployments.json) file under `symbiotic.supportedVaults`.
 
 ### Deployment
 
 Run the following script to deploy Bolt V1:
 ```bash
-forge script script/holesky/admin/Deploy.s.sol --rpc-url $HOLESKY_RPC --private-key $ADMIN_PRIVATE_KEY --broadcast -vvvv
+forge script script/holesky/admin/Deploy.s.sol --rpc-url $HOLESKY_RPC --private-key $ADMIN_PRIVATE_KEY --verify --broadcast -vvvv
 ```
 
 This will deploy all the contracts. The address corresponding to the private key will be the system admin.
@@ -71,3 +80,11 @@ forge script script/holesky/admin/helpers/RegisterAVS.s.sol --rpc-url $HOLESKY_R
 > [!IMPORTANT]
 > After the `deployments.json` file has been fully updated with the correct contract addresses, push it to Github.
 
+
+### Other Scripts
+
+#### Modifying supported Symbiotic Vaults
+This script will update supported vaults according to `deployments.json`, and remove any vaults that have been whitelisted but are no longer in the `symbiotic.supportedVaults` list.
+```bash
+forge script script/holesky/admin/helpers/UpdateSupportedVaults.s.sol --rpc-url $HOLESKY_RPC --private-key $ADMIN_PRIVATE_KEY --broadcast -vvv
+```

bolt-contracts/docs/admin/upgrading.md

@@ -13,4 +13,47 @@ bytes memory initManager = abi.encodeCall(BoltManagerV2.initialize, (params));
 Upgrades.upgradeProxy(proxy, "BoltManagerV2.sol", initManager, opts);
 ```
 
-Before an upgrade, update the [`Upgrade.s.sol`](../script/holesky/Upgrade.s.sol) script to include the correct contracts, references and configurations.
+Before an upgrade, update the [`Upgrade.s.sol`](../script/holesky/Upgrade.s.sol) script to include the correct contracts, references and configurations.
+
+## Unsafe
+In order to run an unsafe upgrade, set `Options.unsafeSkipAllChecks` to `true`:
+```solidity
+Options memory opts;
+opts.unsafeSkipAllChecks = true;
+```
+
+## Verifying Storage Layout
+You can verify storage layouts using `forge inspect`. Example:
+
+```bash
+forge inspect BoltSymbioticMiddlewareV2 storage-layout --pretty
+```
+
+This will output the following table:
+| Name                   | Type                                  | Slot | Offset | Bytes | Contract                                                              |
+|------------------------|---------------------------------------|------|--------|-------|-----------------------------------------------------------------------|
+| INSTANT_SLASHER_TYPE   | uint256                               | 0    | 0      | 32    | src/contracts/BoltSymbioticMiddlewareV2.sol:BoltSymbioticMiddlewareV2 |
+| VETO_SLASHER_TYPE      | uint256                               | 1    | 0      | 32    | src/contracts/BoltSymbioticMiddlewareV2.sol:BoltSymbioticMiddlewareV2 |
+| START_TIMESTAMP        | uint48                                | 2    | 0      | 6     | src/contracts/BoltSymbioticMiddlewareV2.sol:BoltSymbioticMiddlewareV2 |
+| parameters             | contract IBoltParametersV1            | 2    | 6      | 20    | src/contracts/BoltSymbioticMiddlewareV2.sol:BoltSymbioticMiddlewareV2 |
+| manager                | contract IBoltManagerV1               | 3    | 0      | 20    | src/contracts/BoltSymbioticMiddlewareV2.sol:BoltSymbioticMiddlewareV2 |
+| vaults                 | struct EnumerableMap.AddressToUintMap | 4    | 0      | 96    | src/contracts/BoltSymbioticMiddlewareV2.sol:BoltSymbioticMiddlewareV2 |
+| BOLT_SYMBIOTIC_NETWORK | address                               | 7    | 0      | 20    | src/contracts/BoltSymbioticMiddlewareV2.sol:BoltSymbioticMiddlewareV2 |
+| OPERATOR_REGISTRY      | address                               | 8    | 0      | 20    | src/contracts/BoltSymbioticMiddlewareV2.sol:BoltSymbioticMiddlewareV2 |
+| VAULT_FACTORY          | address                               | 9    | 0      | 20    | src/contracts/BoltSymbioticMiddlewareV2.sol:BoltSymbioticMiddlewareV2 |
+| OPERATOR_NET_OPTIN     | address                               | 10   | 0      | 20    | src/contracts/BoltSymbioticMiddlewareV2.sol:BoltSymbioticMiddlewareV2 |
+| NAME_HASH              | bytes32                               | 11   | 0      | 32    | src/contracts/BoltSymbioticMiddlewareV2.sol:BoltSymbioticMiddlewareV2 |
+| __gap                  | uint256[38]                           | 12   | 0      | 1216  | src/contracts/BoltSymbioticMiddlewareV2.sol:BoltSymbioticMiddlewareV2 |
+
+The last line indicating the `__gap` storage slot is what's most important. `__gap` has a total of 50 storage slots reserved. You **MUST** verify that the array length of `__gap`, in this case `38`, is equal to `50 - __gap.Slot`. In this case, the `Slot` column for `__gap` shows 12, so the layout is correct.
+
+## Reinitializers
+In case you need to reinitialize your contract, you'll need to create a reinitializer.
+
+Let `x` = your version number. Add the following new initializer to the contract to be upgraded:
+
+```solidity
+function initializeVx() public reinitializer(x) { ... }
+```
+
+For more info, check out https://docs.openzeppelin.com/contracts/5.x/api/proxy#Initializable.

bolt-contracts/foundry.toml

@@ -26,6 +26,7 @@ remappings = [
   "@relic/=lib/relic-sdk/packages/contracts",
   "@symbiotic/=lib/core/src/",
   "@eigenlayer/=lib/eigenlayer-contracts/",
+  "@eigenlayer-middleware/=lib/eigenlayer-middleware/",
   "@openzeppelin/contracts/=lib/openzeppelin-contracts/contracts/",
   "@openzeppelin/contracts-upgradeable/=lib/openzeppelin-contracts-upgradeable/contracts/",
   "@openzeppelin-foundry-upgrades/=lib/openzeppelin-foundry-upgrades/",

bolt-contracts/script/holesky/admin/Upgrade.s.sol

@@ -4,19 +4,124 @@ pragma solidity 0.8.25;
 import {Script, console} from "forge-std/Script.sol";
 
 import {ERC1967Proxy} from "@openzeppelin/contracts/proxy/ERC1967/ERC1967Proxy.sol";
-import {Upgrades} from "@openzeppelin-foundry-upgrades/src/Upgrades.sol";
+import {Upgrades, Options} from "@openzeppelin-foundry-upgrades/src/Upgrades.sol";
 
 import {BoltParametersV1} from "../../../src/contracts/BoltParametersV1.sol";
 import {BoltValidatorsV1} from "../../../src/contracts/BoltValidatorsV1.sol";
 import {BoltManagerV1} from "../../../src/contracts/BoltManagerV1.sol";
 import {BoltEigenLayerMiddlewareV1} from "../../../src/contracts/BoltEigenLayerMiddlewareV1.sol";
+import {BoltEigenLayerMiddlewareV2} from "../../../src/contracts/BoltEigenLayerMiddlewareV2.sol";
 import {BoltSymbioticMiddlewareV1} from "../../../src/contracts/BoltSymbioticMiddlewareV1.sol";
+import {BoltSymbioticMiddlewareV2} from "../../../src/contracts/BoltSymbioticMiddlewareV2.sol";
 import {BoltConfig} from "../../../src/lib/Config.sol";
 
 contract UpgradeBolt is Script {
-    function run() public {
+    struct Deployments {
+        address boltManager;
+        address boltParameters;
+        address symbioticNetwork;
+        address symbioticOperatorRegistry;
+        address symbioticOperatorNetOptIn;
+        address symbioticVaultFactory;
+        address symbioticMiddleware;
+        address[] supportedVaults;
+        address eigenLayerAVSDirectory;
+        address eigenLayerDelegationManager;
+        address eigenLayerStrategyManager;
+        address eigenLayerMiddleware;
+        address[] supportedStrategies;
+    }
+
+    function upgradeSymbioticMiddleware() public {
+        address admin = msg.sender;
+        console.log("Upgrading Symbiotic middleware with admin", admin);
         // TODO: Validate upgrades with Upgrades.validateUpgrade
 
+        Options memory opts;
+        opts.unsafeSkipAllChecks = true;
+        opts.referenceContract = "BoltSymbioticMiddlewareV1.sol";
+
+        string memory upgradeTo = "BoltSymbioticMiddlewareV2.sol";
+
+        Deployments memory deployments = _readDeployments();
+
+        bytes memory initSymbioticMiddleware = abi.encodeCall(
+            BoltSymbioticMiddlewareV2.initializeV2,
+            (
+                admin,
+                deployments.boltParameters,
+                deployments.boltManager,
+                deployments.symbioticNetwork,
+                deployments.symbioticOperatorRegistry,
+                deployments.symbioticOperatorNetOptIn,
+                deployments.symbioticVaultFactory
+            )
+        );
+
+        vm.startBroadcast(admin);
+
+        Upgrades.upgradeProxy(deployments.symbioticMiddleware, upgradeTo, initSymbioticMiddleware, opts);
+
+        vm.stopBroadcast();
+
+        console.log("BoltSymbioticMiddleware proxy upgraded from %s to %s", opts.referenceContract, upgradeTo);
+
         // TODO: Upgrade contracts with Upgrades.upgradeProxy
     }
+
+    function upgradeEigenLayerMiddleware() public {
+        address admin = msg.sender;
+        console.log("Upgrading EigenLayer middleware with admin", admin);
+        // TODO: Validate upgrades with Upgrades.validateUpgrade
+
+        Options memory opts;
+        opts.unsafeSkipAllChecks = true;
+        opts.referenceContract = "BoltEigenLayerMiddlewareV1.sol";
+
+        string memory upgradeTo = "BoltEigenLayerMiddlewareV2.sol";
+
+        Deployments memory deployments = _readDeployments();
+
+        bytes memory initEigenLayerMiddleware = abi.encodeCall(
+            BoltEigenLayerMiddlewareV2.initializeV2,
+            (
+                admin,
+                deployments.boltParameters,
+                deployments.boltManager,
+                deployments.eigenLayerAVSDirectory,
+                deployments.eigenLayerDelegationManager,
+                deployments.eigenLayerStrategyManager
+            )
+        );
+
+        vm.startBroadcast(admin);
+
+        Upgrades.upgradeProxy(deployments.eigenLayerMiddleware, upgradeTo, initEigenLayerMiddleware, opts);
+
+        vm.stopBroadcast();
+
+        console.log("BoltSymbioticMiddleware proxy upgraded from %s to %s", opts.referenceContract, upgradeTo);
+    }
+
+    function _readDeployments() public view returns (Deployments memory) {
+        string memory root = vm.projectRoot();
+        string memory path = string.concat(root, "/config/holesky/deployments.json");
+        string memory json = vm.readFile(path);
+
+        return Deployments({
+            boltParameters: vm.parseJsonAddress(json, ".bolt.parameters"),
+            boltManager: vm.parseJsonAddress(json, ".bolt.manager"),
+            symbioticNetwork: vm.parseJsonAddress(json, ".symbiotic.network"),
+            symbioticOperatorRegistry: vm.parseJsonAddress(json, ".symbiotic.operatorRegistry"),
+            symbioticOperatorNetOptIn: vm.parseJsonAddress(json, ".symbiotic.networkOptInService"),
+            symbioticVaultFactory: vm.parseJsonAddress(json, ".symbiotic.vaultFactory"),
+            supportedVaults: vm.parseJsonAddressArray(json, ".symbiotic.supportedVaults"),
+            symbioticMiddleware: vm.parseJsonAddress(json, ".symbiotic.middleware"),
+            eigenLayerAVSDirectory: vm.parseJsonAddress(json, ".eigenLayer.avsDirectory"),
+            eigenLayerDelegationManager: vm.parseJsonAddress(json, ".eigenLayer.delegationManager"),
+            eigenLayerStrategyManager: vm.parseJsonAddress(json, ".eigenLayer.strategyManager"),
+            eigenLayerMiddleware: vm.parseJsonAddress(json, ".eigenLayer.middleware"),
+            supportedStrategies: vm.parseJsonAddressArray(json, ".eigenLayer.supportedStrategies")
+        });
+    }
 }