Giter VIP home page Giter VIP logo

eigenlayer-contracts's Introduction

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

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:

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

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'

  1. Install slither, then run:

slither .

Generate Inheritance and Control-Flow Graphs

  1. Install surya and graphviz:
npm i -g surya

apt install graphviz
  1. Then, run:
surya inheritance ./src/contracts/**/*.sol | dot -Tpng > InheritanceGraph.png

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

Deployments

Current Mainnet Deployment

The current mainnet deployment is our M1 release, and is from a much older version of this repo. You can view the deployed contract addresses in Current Mainnet Deployment below, or check out the init-mainnet-deployment branch in "Releases".

Name Solidity Proxy Implementation Notes
StrategyManager StrategyManager 0x8586...075A 0x5d25...42Fb Proxy: OpenZeppelin [email protected]
Strategy: cbETH StrategyBaseTVLLimits 0x5494...56bc 0xdfdA...46d3 Proxy: OpenZeppelin [email protected]
Strategy: stETH StrategyBaseTVLLimits 0x93c4...564D 0xdfdA...46d3 Proxy: OpenZeppelin [email protected]
Strategy: rETH StrategyBaseTVLLimits 0x1BeE...dCD2 0xdfdA...46d3 Proxy: OpenZeppelin [email protected]
EigenPodManager EigenPodManager 0x91E6...A338 0xEB86...e111 Proxy: OpenZeppelin [email protected]
EigenPod (beacon) EigenPod 0x5a2a...9073 0x5c86...9dA7 - Beacon: OpenZeppelin [email protected]
- Deployed pods use [email protected]
DelayedWithdrawalRouter DelayedWithdrawalRouter 0x7Fe7...23D8 0x44Bc...E2AF Proxy: OpenZeppelin [email protected]
DelegationManager DelegationManager 0x3905...f37A 0xf97E...75e4 Proxy: OpenZeppelin [email protected]
Slasher Slasher 0xD921...c3Cd 0xef31...d6d8 Proxy: OpenZeppelin [email protected]
PauserRegistry PauserRegistry - 0x0c43...7060
Pauser Multisig [email protected] 0x5050โ€ฆ2390 0xd9db...9552 Proxy: [email protected]
Community Multisig [email protected] 0xFEA4...c598 0xd9db...9552 Proxy: [email protected]
Executor Multisig [email protected] 0x369e...9111 0xd9db...9552 Proxy: [email protected]
Operations Multisig [email protected] 0xBE16...3e90 0xd9db...9552 Proxy: [email protected]
Timelock Compound: Timelock.sol - 0xA6Db...0EAF
Proxy Admin OpenZeppelin [email protected] - 0x8b95...2444

Current Testnet Deployment

The current testnet deployment is from our M2 beta release, which is a slightly older version of this repo. You can view the deployed contract addresses in Current Testnet Deployment, or check out the goerli-m2-deployment branch in "Releases".

Name Solidity Proxy Implementation Notes
StrategyManager StrategyManager 0x779d...E907 0x8676...0055 Proxy: OpenZeppelin [email protected]
Strategy: stETH StrategyBaseTVLLimits 0xB613...14da 0x81E9...8ebA Proxy: OpenZeppelin [email protected]
Strategy: rETH StrategyBaseTVLLimits 0x8799...70b5 0x81E9...8ebA Proxy: OpenZeppelin [email protected]
EigenPodManager EigenPodManager 0xa286...df41 0xdD09...901b Proxy: OpenZeppelin [email protected]
EigenLayerBeaconOracle succinctlabs/EigenLayerBeaconOracle.sol 0x40B1...9f2c 0x0a6e...db01 OpenZeppelin UUPS
EigenPod (beacon) EigenPod 0x3093...C9a5 0x86bf...6CcA - Beacon: OpenZeppelin [email protected]
- Deployed pods use [email protected]
DelayedWithdrawalRouter DelayedWithdrawalRouter 0x8958...388f 0x6070...27fe Proxy: OpenZeppelin [email protected]
DelegationManager DelegationManager 0x1b7b...b0a8 0x9b79...A99d Proxy: OpenZeppelin [email protected]
Slasher Slasher 0xD11d...0C22 0x3865...8Be6 Proxy: OpenZeppelin [email protected]
PauserRegistry PauserRegistry - 0x2588...0010
Timelock Compound: Timelock.sol - 0xa7e7...796e
Proxy Admin OpenZeppelin [email protected] - 0x28ce...02e2

eigenlayer-contracts's People

Contributors

sidu28 avatar chaoticwalrus avatar gpsanant avatar 8sunyuan avatar wadealexc avatar 0x0aa0 avatar ypatil12 avatar samlaf avatar gajesh2007 avatar omahs avatar teryanarmen avatar stevennevins avatar pandabadger avatar wesfloyd avatar bowenli86 avatar cryptogakusei avatar haythemsellami avatar adlerjohn avatar mooselumph avatar rsproule avatar daweth avatar tudorpintea999 avatar joaolago1113 avatar xiaolou86 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.