eigenlayer-contracts v1.0.4

EigenLayer

EigenLayer is a set of smart contracts deployed on Ethereum that enable restaking of assets to secure new services. This repo contains the EigenLayer core contracts, whose currently-supported assets include beacon chain ETH and several liquid staking tokens (LSTs). Users use these contracts to deposit and withdraw these assets, as well as delegate them to operators providing services to AVSs.

Getting Started

• Branching
• Documentation
• Building and Running Tests
• Deployments

Branching

The main branches we use are:

• dev (default): The most up-to-date branch, containing the work-in-progress code for upcoming releases
• testnet-holesky: Our current testnet deployment
• mainnet: Our current mainnet deloyment

Documentation

Basics

To get a basic understanding of EigenLayer, check out You Could've Invented EigenLayer. Note that some of the document's content describes features that do not exist yet (like the Slasher). To understand more about how restakers and operators interact with EigenLayer, check out these guides:

• Restaking User Guide
• Operator Guide

Deep Dive

The most up-to-date and technical documentation can be found in /docs. If you're a shadowy super coder, this is a great place to get an overview of the contracts before diving into the code.

To get an idea of how users interact with these contracts, check out our integration tests: /src/test/integration.

Building and Running Tests

This repository uses Foundry. See the Foundry docs for more info on installation and usage. If you already have foundry, you can build this project and run tests with these commands:

foundryup

forge build
forge test

Contributor Setup

To set up this repo for the first time, run:

make deps

This will:

• Install the pre-commit hook
• Install foundry and its tools
• Install abigen

Running Fork Tests

We have a few fork tests against ETH mainnet. Passing these requires the environment variable RPC_MAINNET to be set. See .env.example for an example. Once you've set up your environment, forge test should show these fork tests passing.

Additionally, to run all tests in a forked environment, install yq. Then, set up your environment using this script to read from config.yml:

source source-env.sh [goerli|local]

Then run the tests:

forge test --fork-url [RPC_URL]

Running Static Analysis

1. Install solhint, then run:

solhint 'src/contracts/**/*.sol'

2. Install slither, then run:

slither .

Generate Inheritance and Control-Flow Graphs

1. Install surya and graphviz:

npm i -g surya

apt install graphviz

2. Then, run:

surya inheritance ./src/contracts/**/*.sol | dot -Tpng > InheritanceGraph.png

surya mdreport surya_report.md ./src/contracts/**/*.sol

Generate Go bindings

make bindings

Deployments

Current Mainnet Deployment

The current mainnet deployment is our M2 release. You can view the deployed contract addresses below, or check out the code itself on the mainnet branch.

Core

Strategies

Anyone can deploy and whitelist strategies for standard ERC20s by using the StrategyFactory deployed to the address below (see docs). Strategies deployed from the StrategyFactory are deployed using the beacon proxy pattern:

The following strategies were originally deployed and whitelisted outside of the StrategyFactory:

Strategies - Special

The following strategies differ significantly from the other strategies deployed/used above:

EigenPods

EIGEN/bEIGEN

Multisigs

Current Testnet Deployment

You can view the deployed contract addresses below, or check out the code itself on the testnet-holesky branch.

Core

Strategies

Anyone can deploy and whitelist strategies for standard ERC20s by using the StrategyFactory deployed to the address below (see docs). Strategies deployed from the StrategyFactory are deployed using the beacon proxy pattern:

The following strategies were originally deployed and whitelisted outside of the StrategyFactory:

Strategies - Special

The following strategies differ significantly from the other strategies deployed/used above:

EigenPods

EIGEN/bEIGEN

Multisigs