feat(contracts): Refactor dependency routing to ensure seamless usability from importer contract repos

.github/workflows/test-contracts.yml

@@ -12,8 +12,12 @@ concurrency:
   group: ${{github.workflow}}-${{github.ref}}
   cancel-in-progress: true
 
+## TODO: Add automations specifically to ensure:
+##       - changes that affect storage are caught by CI
+##       - (stretch) yarn fmt
+##       - some level of security through automated static analysis (e.g, slither)
 jobs:
-  check:
+  tests:
     name: Foundry Project
     runs-on: ubuntu-22.04
     steps:
@@ -30,6 +34,16 @@ jobs:
         run: forge install
         working-directory: ./contracts
 
+      - name: Set Node.js 16.x
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16.x
+
+      - name: Run install
+        uses: borales/actions-yarn@v4
+        with:
+          cmd: install
+
       - name: Run tests
         run: forge test -vvv
         working-directory: ./contracts

contracts/.gitignore

@@ -18,3 +18,7 @@ data/
 
 script/output/*
 script/input/eigenda_deploy_config.json
+
+# yarn dependencies
+yarn.lock
+node_modules

contracts/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "@eigenda/contracts",
+  "version": "0.1.0-rc-1",
+  "description": "EigenDA core contracts",
+  "main": "index.js",
+  "directories": {
+    "lib": "lib",
+    "test": "test",
+    "src": "src"
+  },
+  "files": [
+    "out/",
+    "src/",
+    "lib/"
+  ],
+  "scripts": {
+    "test": "forge test -v",
+    "build": "forge build"
+  },
+  "repository": {
+    "type": "git",
+    "url": "github.com/Layr-Labs/eigenda"
+  },
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "@openzeppelin/contracts": "4.7.0",
+    "@openzeppelin/contracts-upgradeable": "4.7.0"
+  }
+}

contracts/remappings.txt

@@ -1,6 +1 @@
-@openzeppelin-upgrades/=lib/openzeppelin-contracts-upgradeable/
-@openzeppelin/=lib/openzeppelin-contracts/
-eigenlayer-middleware/=lib/eigenlayer-middleware/src/
-eigenlayer-core/=lib/eigenlayer-middleware/lib/eigenlayer-contracts/src/
-eigenlayer-scripts/=lib/eigenlayer-middleware/lib/eigenlayer-contracts/script/
-forge-std/=lib/forge-std/src/
+@openzeppelin/=node_modules/@openzeppelin/

contracts/script/DeployOpenEigenLayer.s.sol

@@ -6,23 +6,23 @@ import "@openzeppelin/contracts/proxy/transparent/ProxyAdmin.sol";
 import "@openzeppelin/contracts/proxy/transparent/TransparentUpgradeableProxy.sol";
 import "@openzeppelin/contracts/proxy/beacon/UpgradeableBeacon.sol";
 
-import "eigenlayer-core/contracts/interfaces/IETHPOSDeposit.sol";
+import "lib/eigenlayer-middleware/lib/eigenlayer-contracts/src/contracts/interfaces/IETHPOSDeposit.sol";
 
-import "eigenlayer-core/contracts/core/StrategyManager.sol";
-import "eigenlayer-core/contracts/core/Slasher.sol";
-import "eigenlayer-core/contracts/core/DelegationManager.sol";
-import "eigenlayer-core/contracts/core/AVSDirectory.sol";
-import "eigenlayer-core/contracts/core/RewardsCoordinator.sol";
+import "lib/eigenlayer-middleware/lib/eigenlayer-contracts/src/contracts/core/StrategyManager.sol";
+import "lib/eigenlayer-middleware/lib/eigenlayer-contracts/src/contracts/core/Slasher.sol";
+import "lib/eigenlayer-middleware/lib/eigenlayer-contracts/src/contracts/core/DelegationManager.sol";
+import "lib/eigenlayer-middleware/lib/eigenlayer-contracts/src/contracts/core/AVSDirectory.sol";
+import "lib/eigenlayer-middleware/lib/eigenlayer-contracts/src/contracts/core/RewardsCoordinator.sol";
 
-import "eigenlayer-core/contracts/strategies/StrategyBaseTVLLimits.sol";
+import "lib/eigenlayer-middleware/lib/eigenlayer-contracts/src/contracts/strategies/StrategyBaseTVLLimits.sol";
 
-import "eigenlayer-core/contracts/pods/EigenPod.sol";
-import "eigenlayer-core/contracts/pods/EigenPodManager.sol";
+import "lib/eigenlayer-middleware/lib/eigenlayer-contracts/src/contracts/pods/EigenPod.sol";
+import "lib/eigenlayer-middleware/lib/eigenlayer-contracts/src/contracts/pods/EigenPodManager.sol";
 
-import "eigenlayer-core/contracts/permissions/PauserRegistry.sol";
+import "lib/eigenlayer-middleware/lib/eigenlayer-contracts/src/contracts/permissions/PauserRegistry.sol";
 
-import "eigenlayer-core/test/mocks/EmptyContract.sol";
-import "eigenlayer-core/test/mocks/ETHDepositMock.sol";
+import "lib/eigenlayer-middleware/lib/eigenlayer-contracts/src/test/mocks/EmptyContract.sol";
+import "lib/eigenlayer-middleware/lib/eigenlayer-contracts/src/test/mocks/ETHDepositMock.sol";
 
 import "forge-std/Script.sol";
 import "forge-std/Test.sol";

contracts/script/EigenDADeployer.s.sol

@@ -1,19 +1,19 @@
 // SPDX-License-Identifier: UNLICENSED 
 pragma solidity ^0.8.9;
 
-import {PauserRegistry} from "eigenlayer-core/contracts/permissions/PauserRegistry.sol";
-import {EmptyContract} from "eigenlayer-core/test/mocks/EmptyContract.sol";
-
-import {BLSApkRegistry} from "eigenlayer-middleware/BLSApkRegistry.sol";
-import {RegistryCoordinator} from "eigenlayer-middleware/RegistryCoordinator.sol";
-import {OperatorStateRetriever} from "eigenlayer-middleware/OperatorStateRetriever.sol";
-import {IRegistryCoordinator} from "eigenlayer-middleware/interfaces/IRegistryCoordinator.sol";
-import {IndexRegistry} from "eigenlayer-middleware/IndexRegistry.sol";
-import {IIndexRegistry} from "eigenlayer-middleware/interfaces/IIndexRegistry.sol";
-import {StakeRegistry, IStrategy} from "eigenlayer-middleware/StakeRegistry.sol";
-import {IStakeRegistry, IDelegationManager} from "eigenlayer-middleware/interfaces/IStakeRegistry.sol";
-import {IServiceManager} from "eigenlayer-middleware/interfaces/IServiceManager.sol";
-import {IBLSApkRegistry} from "eigenlayer-middleware/interfaces/IBLSApkRegistry.sol";
+import {PauserRegistry} from "../lib/eigenlayer-middleware/lib/eigenlayer-contracts/src/contracts/permissions/PauserRegistry.sol";
+import {EmptyContract} from "../lib/eigenlayer-middleware/lib/eigenlayer-contracts/src/test/mocks/EmptyContract.sol";
+
+import {BLSApkRegistry} from "../lib/eigenlayer-middleware/src/BLSApkRegistry.sol";
+import {RegistryCoordinator} from "../lib/eigenlayer-middleware/src/RegistryCoordinator.sol";
+import {OperatorStateRetriever} from "../lib/eigenlayer-middleware/src/OperatorStateRetriever.sol";
+import {IRegistryCoordinator} from "../lib/eigenlayer-middleware/src/interfaces/IRegistryCoordinator.sol";
+import {IndexRegistry} from "../lib/eigenlayer-middleware/src/IndexRegistry.sol";
+import {IIndexRegistry} from "../lib/eigenlayer-middleware/src/interfaces/IIndexRegistry.sol";
+import {StakeRegistry, IStrategy} from "../lib/eigenlayer-middleware/src/StakeRegistry.sol";
+import {IStakeRegistry, IDelegationManager} from "../lib/eigenlayer-middleware/src/interfaces/IStakeRegistry.sol";
+import {IServiceManager} from "../lib/eigenlayer-middleware/src/interfaces/IServiceManager.sol";
+import {IBLSApkRegistry} from "../lib/eigenlayer-middleware/src/interfaces/IBLSApkRegistry.sol";
 import {EigenDAServiceManager, IAVSDirectory, IRewardsCoordinator} from "../src/core/EigenDAServiceManager.sol";
 import {EigenDAHasher} from "../src/libraries/EigenDAHasher.sol";
 import {EigenDAThresholdRegistry} from "../src/core/EigenDAThresholdRegistry.sol";
@@ -27,7 +27,7 @@ import {PaymentVault} from "../src/payments/PaymentVault.sol";
 import {EigenDADisperserRegistry} from "../src/core/EigenDADisperserRegistry.sol";
 import {IEigenDADisperserRegistry} from "../src/interfaces/IEigenDADisperserRegistry.sol";
 import {EigenDARelayRegistry} from "../src/core/EigenDARelayRegistry.sol";
-import {ISocketRegistry, SocketRegistry} from "eigenlayer-middleware/SocketRegistry.sol";
+import {ISocketRegistry, SocketRegistry} from "../lib/eigenlayer-middleware/src/SocketRegistry.sol";
 import {DeployOpenEigenLayer, ProxyAdmin, ERC20PresetFixedSupply, TransparentUpgradeableProxy, IPauserRegistry} from "./DeployOpenEigenLayer.s.sol";
 import "forge-std/Test.sol";
 import "forge-std/Script.sol";

contracts/script/EigenLayerUtils.s.sol

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: BUSL-1.1
 pragma solidity =0.8.12;
 
-import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
+import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
 
 import "forge-std/Script.sol";
 import "forge-std/StdJson.sol";

contracts/script/EjectionManagerDeployer.s.sol

@@ -1,13 +1,13 @@
 // SPDX-License-Identifier: BUSL-1.1
 pragma solidity =0.8.12;
 
-import {EmptyContract} from "eigenlayer-core/test/mocks/EmptyContract.sol";
-import {EjectionManager} from "eigenlayer-middleware/EjectionManager.sol";
-import {IEjectionManager} from "eigenlayer-middleware/interfaces/IEjectionManager.sol";
-import {RegistryCoordinator} from "eigenlayer-middleware/RegistryCoordinator.sol";
-import {IRegistryCoordinator} from "eigenlayer-middleware/interfaces/IRegistryCoordinator.sol";
-import {StakeRegistry} from "eigenlayer-middleware/StakeRegistry.sol";
-import {IStakeRegistry} from "eigenlayer-middleware/interfaces/IStakeRegistry.sol";
+import {EmptyContract} from "../lib/eigenlayer-middleware/lib/eigenlayer-contracts/src/test/mocks/EmptyContract.sol";
+import {EjectionManager} from "../lib/eigenlayer-middleware/src/EjectionManager.sol";
+import {IEjectionManager} from "../lib/eigenlayer-middleware/src/interfaces/IEjectionManager.sol";
+import {RegistryCoordinator} from "../lib/eigenlayer-middleware/src/RegistryCoordinator.sol";
+import {IRegistryCoordinator} from "../lib/eigenlayer-middleware/src/interfaces/IRegistryCoordinator.sol";
+import {StakeRegistry} from "../lib/eigenlayer-middleware/src/StakeRegistry.sol";
+import {IStakeRegistry} from "../lib/eigenlayer-middleware/src/interfaces/IStakeRegistry.sol";
 import "@openzeppelin/contracts/proxy/transparent/ProxyAdmin.sol";
 
 import "forge-std/Test.sol";

contracts/script/SetUpEigenDA.s.sol

@@ -1,13 +1,13 @@
 // SPDX-License-Identifier: UNLICENSED 
 pragma solidity ^0.8.9;
 
-import {PauserRegistry} from "eigenlayer-core/contracts/permissions/PauserRegistry.sol";
-import {EmptyContract} from "eigenlayer-core/test/mocks/EmptyContract.sol";
+import {PauserRegistry} from "../lib/eigenlayer-middleware/lib/eigenlayer-contracts/src/contracts/permissions/PauserRegistry.sol";
+import {EmptyContract} from "../lib/eigenlayer-middleware/lib/eigenlayer-contracts/src/test/mocks/EmptyContract.sol";
 
-import {RegistryCoordinator} from "eigenlayer-middleware/RegistryCoordinator.sol";
-import {IndexRegistry} from "eigenlayer-middleware/IndexRegistry.sol";
-import {StakeRegistry} from "eigenlayer-middleware/StakeRegistry.sol";
-import {IIndexRegistry} from "eigenlayer-middleware/interfaces/IIndexRegistry.sol";
+import {RegistryCoordinator} from "../lib/eigenlayer-middleware/src/RegistryCoordinator.sol";
+import {IndexRegistry} from "../lib/eigenlayer-middleware/src/IndexRegistry.sol";
+import {StakeRegistry} from "../lib/eigenlayer-middleware/src/StakeRegistry.sol";
+import {IIndexRegistry} from "../lib/eigenlayer-middleware/src/interfaces/IIndexRegistry.sol";
 
 import {EigenDAServiceManager} from "../src/core/EigenDAServiceManager.sol";
 import {PaymentVault} from "../src/payments/PaymentVault.sol";
@@ -16,6 +16,9 @@ import {EigenDAHasher} from "../src/libraries/EigenDAHasher.sol";
 import {EigenDADeployer} from "./EigenDADeployer.s.sol";
 import {EigenLayerUtils} from "./EigenLayerUtils.s.sol";
 
+import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
+
+
 import "./DeployOpenEigenLayer.s.sol";
 import "forge-std/Test.sol";
 import "forge-std/Script.sol";

contracts/script/deploy/goerliv2/GoerliV2_Deploy.s.sol

@@ -1,20 +1,20 @@
 // SPDX-License-Identifier: BUSL-1.1
 pragma solidity =0.8.12;
 /*
-import {PauserRegistry} from "eigenlayer-core/contracts/permissions/PauserRegistry.sol";
-import {EmptyContract} from "eigenlayer-core/test/mocks/EmptyContract.sol";
-
-import {BLSApkRegistry} from "eigenlayer-middleware/BLSApkRegistry.sol";
-import {IBLSApkRegistry} from "eigenlayer-middleware/interfaces/IBLSApkRegistry.sol";
-import {RegistryCoordinator} from "eigenlayer-middleware/RegistryCoordinator.sol";
-import {IRegistryCoordinator} from "eigenlayer-middleware/interfaces/IRegistryCoordinator.sol";
-import {IndexRegistry} from "eigenlayer-middleware/IndexRegistry.sol";
-import {IIndexRegistry} from "eigenlayer-middleware/interfaces/IIndexRegistry.sol";
-import {StakeRegistry} from "eigenlayer-middleware/StakeRegistry.sol";
-import {IStakeRegistry} from "eigenlayer-middleware/interfaces/IStakeRegistry.sol";
+import {PauserRegistry} from "../lib/eigenlayer-middleware/src/contracts/permissions/PauserRegistry.sol";
+import {EmptyContract} from "../lib/eigenlayer-middleware/src/test/mocks/EmptyContract.sol";
+
+import {BLSApkRegistry} from "../lib/eigenlayer-middleware/BLSApkRegistry.sol";
+import {IBLSApkRegistry} from "../lib/eigenlayer-middleware/interfaces/IBLSApkRegistry.sol";
+import {RegistryCoordinator} from "../lib/eigenlayer-middleware/RegistryCoordinator.sol";
+import {IRegistryCoordinator} from "../lib/eigenlayer-middleware/interfaces/IRegistryCoordinator.sol";
+import {IndexRegistry} from "../lib/eigenlayer-middleware/IndexRegistry.sol";
+import {IIndexRegistry} from "../lib/eigenlayer-middleware/interfaces/IIndexRegistry.sol";
+import {StakeRegistry} from "../lib/eigenlayer-middleware/StakeRegistry.sol";
+import {IStakeRegistry} from "../lib/eigenlayer-middleware/interfaces/IStakeRegistry.sol";
 import {EigenDAServiceManager} from "src/core/EigenDAServiceManager.sol";
-import {IServiceManager} from "eigenlayer-middleware/interfaces/IServiceManager.sol";
-import {OperatorStateRetriever} from "eigenlayer-middleware/OperatorStateRetriever.sol";
+import {IServiceManager} from "../lib/eigenlayer-middleware/interfaces/IServiceManager.sol";
+import {OperatorStateRetriever} from "../lib/eigenlayer-middleware/OperatorStateRetriever.sol";
 
 import "eigenlayer-scripts/utils/ExistingDeploymentParser.sol";
 import "forge-std/Test.sol";

contracts/script/deploy/holesky/EigenDASM_RewardsUpgrade.s.sol

@@ -2,9 +2,9 @@
 /*
 pragma solidity ^0.8.12;
 
-import {TransparentUpgradeableProxy} from "@openzeppelin/contracts/proxy/transparent/TransparentUpgradeableProxy.sol";
-import {ERC20PresetFixedSupply} from "@openzeppelin/contracts/token/ERC20/presets/ERC20PresetFixedSupply.sol";
-import {ProxyAdmin} from "@openzeppelin/contracts/proxy/transparent/ProxyAdmin.sol";
+import {TransparentUpgradeableProxy} from "lib/openzeppelin-contracts/contracts/proxy/transparent/TransparentUpgradeableProxy.sol";
+import {ERC20PresetFixedSupply} from "lib/openzeppelin-contracts/contracts/token/ERC20/presets/ERC20PresetFixedSupply.sol";
+import {ProxyAdmin} from "lib/openzeppelin-contracts/contracts/proxy/transparent/ProxyAdmin.sol";
 import {
     ExistingDeploymentParser,
     RewardsCoordinator,
@@ -13,8 +13,8 @@ import {
     IStrategy,
     IERC20
 } from "eigenlayer-scripts/utils/ExistingDeploymentParser.sol";
-import {IRegistryCoordinator} from "eigenlayer-middleware/interfaces/IRegistryCoordinator.sol";
-import {IStakeRegistry} from "eigenlayer-middleware/interfaces/IStakeRegistry.sol";
+import {IRegistryCoordinator} from "../lib/eigenlayer-middleware/interfaces/IRegistryCoordinator.sol";
+import {IStakeRegistry} from "../lib/eigenlayer-middleware/interfaces/IStakeRegistry.sol";
 
 import {EigenDAServiceManager} from "../../../src/core/EigenDAServiceManager.sol";
 

contracts/script/deploy/holesky/Holesky_Deploy.s.sol

@@ -2,21 +2,21 @@
 /*
 pragma solidity =0.8.12;
 
-import {PauserRegistry} from "eigenlayer-core/contracts/permissions/PauserRegistry.sol";
-import {EmptyContract} from "eigenlayer-core/test/mocks/EmptyContract.sol";
-
-import {BLSApkRegistry} from "eigenlayer-middleware/BLSApkRegistry.sol";
-import {IBLSApkRegistry} from "eigenlayer-middleware/interfaces/IBLSApkRegistry.sol";
-import {RegistryCoordinator} from "eigenlayer-middleware/RegistryCoordinator.sol";
-import {IRegistryCoordinator} from "eigenlayer-middleware/interfaces/IRegistryCoordinator.sol";
-import {IndexRegistry} from "eigenlayer-middleware/IndexRegistry.sol";
-import {IIndexRegistry} from "eigenlayer-middleware/interfaces/IIndexRegistry.sol";
-import {StakeRegistry} from "eigenlayer-middleware/StakeRegistry.sol";
-import {IStakeRegistry} from "eigenlayer-middleware/interfaces/IStakeRegistry.sol";
+import {PauserRegistry} from "../lib/eigenlayer-middleware/src/contracts/permissions/PauserRegistry.sol";
+import {EmptyContract} from "../lib/eigenlayer-middleware/src/test/mocks/EmptyContract.sol";
+
+import {BLSApkRegistry} from "../lib/eigenlayer-middleware/BLSApkRegistry.sol";
+import {IBLSApkRegistry} from "../lib/eigenlayer-middleware/interfaces/IBLSApkRegistry.sol";
+import {RegistryCoordinator} from "../lib/eigenlayer-middleware/RegistryCoordinator.sol";
+import {IRegistryCoordinator} from "../lib/eigenlayer-middleware/interfaces/IRegistryCoordinator.sol";
+import {IndexRegistry} from "../lib/eigenlayer-middleware/IndexRegistry.sol";
+import {IIndexRegistry} from "../lib/eigenlayer-middleware/interfaces/IIndexRegistry.sol";
+import {StakeRegistry} from "../lib/eigenlayer-middleware/StakeRegistry.sol";
+import {IStakeRegistry} from "../lib/eigenlayer-middleware/interfaces/IStakeRegistry.sol";
 import {EigenDAServiceManager} from "src/core/EigenDAServiceManager.sol";
-import {IServiceManager} from "eigenlayer-middleware/interfaces/IServiceManager.sol";
-import {OperatorStateRetriever} from "eigenlayer-middleware/OperatorStateRetriever.sol";
-import {ServiceManagerRouter} from "eigenlayer-middleware/ServiceManagerRouter.sol";
+import {IServiceManager} from "../lib/eigenlayer-middleware/interfaces/IServiceManager.sol";
+import {OperatorStateRetriever} from "../lib/eigenlayer-middleware/OperatorStateRetriever.sol";
+import {ServiceManagerRouter} from "../lib/eigenlayer-middleware/ServiceManagerRouter.sol";
 import {MockRollup, BN254, IEigenDAServiceManager} from "src/rollup/MockRollup.sol";
 
 import "eigenlayer-scripts/utils/ExistingDeploymentParser.sol";

contracts/script/deploy/m2/M2_Deploy.s.sol

@@ -4,14 +4,14 @@ pragma solidity =0.8.12;
 
 import "eigenlayer-scripts/utils/ExistingDeploymentParser.sol";
 
-import "eigenlayer-middleware/BLSPublicKeyCompendium.sol";
-import "eigenlayer-middleware/BLSRegistryCoordinatorWithIndices.sol";
-import "eigenlayer-middleware/BLSPubkeyRegistry.sol";
-import "eigenlayer-middleware/IndexRegistry.sol";
-import "eigenlayer-middleware/StakeRegistry.sol";
-import "eigenlayer-middleware/BLSOperatorStateRetriever.sol";
-
-import "eigenlayer-core/contracts/permissions/PauserRegistry.sol";
+import "../lib/eigenlayer-middleware/BLSPublicKeyCompendium.sol";
+import "../lib/eigenlayer-middleware/BLSRegistryCoordinatorWithIndices.sol";
+import "../lib/eigenlayer-middleware/BLSPubkeyRegistry.sol";
+import "../lib/eigenlayer-middleware/IndexRegistry.sol";
+import "../lib/eigenlayer-middleware/StakeRegistry.sol";
+import "../lib/eigenlayer-middleware/BLSOperatorStateRetriever.sol";
+
+import "../lib/eigenlayer-middleware/src/contracts/permissions/PauserRegistry.sol";
 
 import {EigenDAServiceManager} from "../../src/core/EigenDAServiceManager.sol";