EigenLayer (formerly 'EigenLayr') is a set of smart contracts deployed on Ethereum that enable restaking of assets to secure new services. At present, this repository contains both the contracts for EigenLayer and a set of general "middleware" contracts, designed to be reuseable across different applications built on top of EigenLayer.
Note that the interactions between middleware and EigenLayer are not yet "set in stone", and may change somewhat prior to the platform being fully live on mainnet; in particular, payment architecture is likely to evolve. As such, the "middleware" contracts should not be treated as definitive, but merely as a helpful reference, at least until the architecture is more settled.
Click the links in the Table of Contents below to access more specific documentation. We recommend starting with the EigenLayer Technical Specification to get a better overview before diving into any of the other docs. For contracts addresses deployed on Goerli, click here.
Design Docs
Flow Docs
- EigenLayer Withdrawal Flow
- EigenLayer Deposit Flow
- EigenLayer Delegation Flow
- Middleware Registration Flow for Operators
foundryup
This repository uses Foundry as a smart contract development toolchain.
See the Foundry Docs for more info on installation and usage.
You will notice that we also have hardhat installed in this repo. This is only used to generate natspec docgen. This is our workaround until foundry finishes implementing the forge doc command.
To generate the docs, run npx hardhat docgen (you may need to run npm install first). The output is located in docs/docgen
Prior to running tests, you should set up your environment. At present this repository contains fork tests against ETH mainnet; your environment will need an RPC_MAINNET key to run these tests. See the .env.example file for an example -- two simple options are to copy the LlamaNodes RPC url to your env or use your own infura API key in the provided format.
The main command to run tests is:
forge test -vv
Environment config is contained in config.yml. Before running the following commands, install yq. Then set up the environment with this script:
source source-env.sh [CHAIN]
for example, on goerli: source source-env.sh goerli. Currently options for [CHAIN] are goerli, local. Then to run the actual tests:
forge test --fork-url [RPC_URL]
solhint 'src/contracts/**/*.sol'
slither .
first install surya
then run
surya inheritance ./src/contracts/**/*.sol | dot -Tpng > InheritanceGraph.png
and/or
surya graph ./src/contracts/middleware/*.sol | dot -Tpng > MiddlewareControlFlowGraph.png
and/or
surya mdreport surya_report.md ./src/contracts/**/*.sol