From 0256e606120c74f4cc73fdc52344c962f3724fbe Mon Sep 17 00:00:00 2001 From: Madeline Murray Date: Wed, 5 Feb 2025 12:42:29 +1000 Subject: [PATCH 1/9] Minimal restructure to demo Concept/How To/Reference/Tutorial approach --- docs/developers/Concepts/_category_.json | 4 ++++ docs/developers/{ => Concepts}/avs-developer-guide.md | 0 docs/developers/Concepts/security/_category_.json | 4 ++++ .../security}/avs-developer-best-practices.md | 0 docs/developers/HowTo/_category_.json | 4 ++++ docs/developers/{ => HowTo}/avs-opset-slashing.md | 4 ++-- docs/developers/{ => HowTo}/avs-permissionlesss.md | 4 ++-- docs/developers/{ => HowTo}/deployment-testnet-mainnet.md | 8 ++++---- docs/developers/{ => HowTo}/how-to-build-an-avs.md | 4 ++-- .../implement-avs-marketplace-interfaces.md} | 4 ++-- docs/developers/{ => HowTo}/rewards.md | 4 ++-- docs/developers/{ => HowTo}/support.md | 4 ++-- docs/developers/Reference/_category_.json | 4 ++++ docs/developers/{ => Reference}/resources.md | 0 docs/developers/{ => Tutorials}/quickstart.md | 2 +- docs/eigenlayer/resources/learning-resources.md | 2 +- docs/eigenlayer/restaking-guides/overview.md | 2 +- .../rewards-claiming/rewards-claiming-overview.md | 2 +- src/pages/index.js | 2 +- 19 files changed, 37 insertions(+), 21 deletions(-) create mode 100644 docs/developers/Concepts/_category_.json rename docs/developers/{ => Concepts}/avs-developer-guide.md (100%) create mode 100644 docs/developers/Concepts/security/_category_.json rename docs/developers/{ => Concepts/security}/avs-developer-best-practices.md (100%) create mode 100644 docs/developers/HowTo/_category_.json rename docs/developers/{ => HowTo}/avs-opset-slashing.md (99%) rename docs/developers/{ => HowTo}/avs-permissionlesss.md (94%) rename docs/developers/{ => HowTo}/deployment-testnet-mainnet.md (76%) rename docs/developers/{ => HowTo}/how-to-build-an-avs.md (96%) rename docs/developers/{avs-dashboard-onboarding.md => HowTo/implement-avs-marketplace-interfaces.md} (99%) rename docs/developers/{ => HowTo}/rewards.md (98%) rename docs/developers/{ => HowTo}/support.md (87%) create mode 100644 docs/developers/Reference/_category_.json rename docs/developers/{ => Reference}/resources.md (100%) rename docs/developers/{ => Tutorials}/quickstart.md (98%) diff --git a/docs/developers/Concepts/_category_.json b/docs/developers/Concepts/_category_.json new file mode 100644 index 00000000..4f6616f2 --- /dev/null +++ b/docs/developers/Concepts/_category_.json @@ -0,0 +1,4 @@ +{ + "position": 1, + "label": "Concepts" +} \ No newline at end of file diff --git a/docs/developers/avs-developer-guide.md b/docs/developers/Concepts/avs-developer-guide.md similarity index 100% rename from docs/developers/avs-developer-guide.md rename to docs/developers/Concepts/avs-developer-guide.md diff --git a/docs/developers/Concepts/security/_category_.json b/docs/developers/Concepts/security/_category_.json new file mode 100644 index 00000000..535d2317 --- /dev/null +++ b/docs/developers/Concepts/security/_category_.json @@ -0,0 +1,4 @@ +{ + "position": 1, + "label": "Security" +} \ No newline at end of file diff --git a/docs/developers/avs-developer-best-practices.md b/docs/developers/Concepts/security/avs-developer-best-practices.md similarity index 100% rename from docs/developers/avs-developer-best-practices.md rename to docs/developers/Concepts/security/avs-developer-best-practices.md diff --git a/docs/developers/HowTo/_category_.json b/docs/developers/HowTo/_category_.json new file mode 100644 index 00000000..40c82b3b --- /dev/null +++ b/docs/developers/HowTo/_category_.json @@ -0,0 +1,4 @@ +{ + "position": 1, + "label": "How To" +} \ No newline at end of file diff --git a/docs/developers/avs-opset-slashing.md b/docs/developers/HowTo/avs-opset-slashing.md similarity index 99% rename from docs/developers/avs-opset-slashing.md rename to docs/developers/HowTo/avs-opset-slashing.md index e4f3f767..da5c5622 100644 --- a/docs/developers/avs-opset-slashing.md +++ b/docs/developers/HowTo/avs-opset-slashing.md @@ -1,6 +1,6 @@ --- -sidebar_position: 4 -title: AVS Operator Set and Slashing of Unique Stake +sidebar_position: 3 +title: Implement Slashing of Unique Stake --- diff --git a/docs/developers/avs-permissionlesss.md b/docs/developers/HowTo/avs-permissionlesss.md similarity index 94% rename from docs/developers/avs-permissionlesss.md rename to docs/developers/HowTo/avs-permissionlesss.md index d6cc784f..3259aaae 100644 --- a/docs/developers/avs-permissionlesss.md +++ b/docs/developers/HowTo/avs-permissionlesss.md @@ -1,6 +1,6 @@ --- -sidebar_position: 8 -title: Permissionless Token Strategies +sidebar_position: 6 +title: Add ERC-20 Tokens as Restakable Asset --- # Permissionless Token Strategies diff --git a/docs/developers/deployment-testnet-mainnet.md b/docs/developers/HowTo/deployment-testnet-mainnet.md similarity index 76% rename from docs/developers/deployment-testnet-mainnet.md rename to docs/developers/HowTo/deployment-testnet-mainnet.md index 5fa70ea9..863c27cf 100644 --- a/docs/developers/deployment-testnet-mainnet.md +++ b/docs/developers/HowTo/deployment-testnet-mainnet.md @@ -1,6 +1,6 @@ --- -sidebar_position: 9 -title: Preparing for Testnet and Mainnet Deployment +sidebar_position: 5 +title: Prepare for and Deploy to Testnet and Mainnet --- @@ -15,13 +15,13 @@ title: Preparing for Testnet and Mainnet Deployment - Communication channels that will be utilized for AVS upgrades. - Describe Operator monitoring tooling available, such as GraFana dashboards, log files or similar. -3. Follow the [AVS Developer Security Best Practices](./avs-developer-best-practices.md) and [Key Manage Considerations for Developers](./avs-developer-best-practices.md#key-management-recommendation-for-developers). +3. Follow the [AVS Developer Security Best Practices](../Concepts/security/avs-developer-best-practices.md) and [Key Manage Considerations for Developers](../Concepts/security/avs-developer-best-practices.md#key-management-recommendation-for-developers). 4. Implement the [Node Specification](https://docs.eigenlayer.xyz/eigenlayer/avs-guides/spec/intro) for your Operator executable package. 5. Follow the [Testnet Dashboard Onboarding instructions](https://docs.eigenlayer.xyz/eigenlayer/avs-guides/avs-dashboard-onboarding). -6. Implement Rewards distributions per the instructions [here](./rewards.md). +6. Implement Rewards distributions per the instructions [here](rewards.md). ## Preparing and Deploying to Mainnet diff --git a/docs/developers/how-to-build-an-avs.md b/docs/developers/HowTo/how-to-build-an-avs.md similarity index 96% rename from docs/developers/how-to-build-an-avs.md rename to docs/developers/HowTo/how-to-build-an-avs.md index e2541425..bf6cb755 100644 --- a/docs/developers/how-to-build-an-avs.md +++ b/docs/developers/HowTo/how-to-build-an-avs.md @@ -1,11 +1,11 @@ --- -sidebar_position: 3 +sidebar_position: 1 title: Build Your Own AVS --- This section will walk you through the process of designing and building your own AVS from scratch. It is intended to take you from an idea to a working local prototype. -Before proceeding, please review the previous sections on [AVS Overview](./avs-developer-guide.md), [EigenLayer Overview](/docs/eigenlayer/overview/README.md) and the [Quick Start example](./quickstart.md) to become familiar with the basic concepts. +Before proceeding, please review the previous sections on [AVS Overview](../Concepts/avs-developer-guide.md), [EigenLayer Overview](/docs/eigenlayer/overview/README.md) and the [Quick Start example](../Tutorials/quickstart.md) to become familiar with the basic concepts. ## Step 1: AVS Design diff --git a/docs/developers/avs-dashboard-onboarding.md b/docs/developers/HowTo/implement-avs-marketplace-interfaces.md similarity index 99% rename from docs/developers/avs-dashboard-onboarding.md rename to docs/developers/HowTo/implement-avs-marketplace-interfaces.md index ad42b905..bb403712 100644 --- a/docs/developers/avs-dashboard-onboarding.md +++ b/docs/developers/HowTo/implement-avs-marketplace-interfaces.md @@ -1,6 +1,6 @@ --- -sidebar_position: 7 -title: AVS Dashboard Onboarding +sidebar_position: 4 +title: Implement AVS Marketplace Interfaces --- diff --git a/docs/developers/rewards.md b/docs/developers/HowTo/rewards.md similarity index 98% rename from docs/developers/rewards.md rename to docs/developers/HowTo/rewards.md index 3b226f55..116f49b5 100644 --- a/docs/developers/rewards.md +++ b/docs/developers/HowTo/rewards.md @@ -1,6 +1,6 @@ --- -sidebar_position: 8 -title: AVS Rewards +sidebar_position: 2 +title: Implement Rewards --- ## Overview diff --git a/docs/developers/support.md b/docs/developers/HowTo/support.md similarity index 87% rename from docs/developers/support.md rename to docs/developers/HowTo/support.md index 0b481536..86aef675 100644 --- a/docs/developers/support.md +++ b/docs/developers/HowTo/support.md @@ -1,6 +1,6 @@ --- -sidebar_position: 4 -title: Developer Support +sidebar_position: 7 +title: Get Support --- If you have any questions or comments throughout the AVS development process, you can get support by reaching out to us using the Intercom button on the bottom right side of this page or clicking here. We will promptly follow up with support! \ No newline at end of file diff --git a/docs/developers/Reference/_category_.json b/docs/developers/Reference/_category_.json new file mode 100644 index 00000000..953bad76 --- /dev/null +++ b/docs/developers/Reference/_category_.json @@ -0,0 +1,4 @@ +{ + "position": 1, + "label": "Reference" +} \ No newline at end of file diff --git a/docs/developers/resources.md b/docs/developers/Reference/resources.md similarity index 100% rename from docs/developers/resources.md rename to docs/developers/Reference/resources.md diff --git a/docs/developers/quickstart.md b/docs/developers/Tutorials/quickstart.md similarity index 98% rename from docs/developers/quickstart.md rename to docs/developers/Tutorials/quickstart.md index 1a05d61e..9b392dae 100644 --- a/docs/developers/quickstart.md +++ b/docs/developers/Tutorials/quickstart.md @@ -84,7 +84,7 @@ function respondToTask( } ``` -Please find a complete list of the requirements to implement an AVS at [Build Your Own AVS: Step 2 Idea to Code](/docs/developers/how-to-build-an-avs.md#step-2-idea-to-code-building-and-deploying-your-avs-locally). +Please find a complete list of the requirements to implement an AVS at [Build Your Own AVS: Step 2 Idea to Code](/docs/developers/HowTo/how-to-build-an-avs.md#step-2-idea-to-code-building-and-deploying-your-avs-locally). ### Contract Deployment Scripts diff --git a/docs/eigenlayer/resources/learning-resources.md b/docs/eigenlayer/resources/learning-resources.md index 949abd30..4f773c0d 100644 --- a/docs/eigenlayer/resources/learning-resources.md +++ b/docs/eigenlayer/resources/learning-resources.md @@ -31,7 +31,7 @@ title: Learning Resources ### Developer resources -Please see Developer Learning Resources [here](/docs/developers/resources.md). +Please see Developer Learning Resources [here](/docs/developers/Reference/resources.md). ### Community diff --git a/docs/eigenlayer/restaking-guides/overview.md b/docs/eigenlayer/restaking-guides/overview.md index 50d3be86..9a38ba5c 100644 --- a/docs/eigenlayer/restaking-guides/overview.md +++ b/docs/eigenlayer/restaking-guides/overview.md @@ -6,7 +6,7 @@ title: Restaking Overview ## **Liquid & Native Restaking** -**Liquid restaking** is the process of depositing "liquid" tokens, including LSTs, EIGEN token, and any ERC20 token into the EigenLayer smart contracts. For more information about adding new ERC20 tokens, please see [Permissionless Token Strategies](/docs/developers/avs-permissionlesss.md). +**Liquid restaking** is the process of depositing "liquid" tokens, including LSTs, EIGEN token, and any ERC20 token into the EigenLayer smart contracts. For more information about adding new ERC20 tokens, please see [Permissionless Token Strategies](/docs/developers/HowTo/avs-permissionlesss.md). **Native restaking** is the process of changing an Ethereum validator's[ withdrawal credentials](https://notes.ethereum.org/@launchpad/withdrawals-faq#Q-What-are-withdrawals) to EigenLayer's smart contracts. You must operate an Ethereum Validator node in order to participate in Native Restaking. To learn more or set up your Ethereum Validator please follow this link from the[ Ethereum Foundation](https://launchpad.ethereum.org/). diff --git a/docs/eigenlayer/rewards-claiming/rewards-claiming-overview.md b/docs/eigenlayer/rewards-claiming/rewards-claiming-overview.md index 81477d93..b2133e89 100644 --- a/docs/eigenlayer/rewards-claiming/rewards-claiming-overview.md +++ b/docs/eigenlayer/rewards-claiming/rewards-claiming-overview.md @@ -45,4 +45,4 @@ Rewards are calculated via an off-chain process. A Merkle root is posted which r ## AVS Integrations -Please refer to [AVS Guide: AVS Rewards](/docs/developers/rewards.md) for complete instructions. +Please refer to [AVS Guide: AVS Rewards](/docs/developers/HowTo/rewards.md) for complete instructions. diff --git a/src/pages/index.js b/src/pages/index.js index 52af0ce1..d90fb9ae 100644 --- a/src/pages/index.js +++ b/src/pages/index.js @@ -52,7 +52,7 @@ function Home() { Date: Wed, 5 Feb 2025 12:31:45 -0500 Subject: [PATCH 2/9] fixed redirects and urls --- docs/eigenlayer/overview/README.md | 2 +- docusaurus.config.js | 7 ++----- 2 files changed, 3 insertions(+), 6 deletions(-) diff --git a/docs/eigenlayer/overview/README.md b/docs/eigenlayer/overview/README.md index c49ce3e6..a1b878b0 100644 --- a/docs/eigenlayer/overview/README.md +++ b/docs/eigenlayer/overview/README.md @@ -48,6 +48,6 @@ To learn more about EigenLayer please read the [**Whitepaper**](/pdf/EigenLayer_ Get started with EigenLayer: - [Restake on EigenLayer](/eigenlayer/restaking-guides/overview) - [Register as an Operator](/eigenlayer/operator-guides/operator-installation) -- [Build an AVS](/developers/avs-developer-guide) +- [Build an AVS](/developers/Concepts/avs-developer-guide) - Join our Ecosystem: [Discord](https://discord.com/invite/eigenlayer), [Twitter](https://twitter.com/eigenlayer) diff --git a/docusaurus.config.js b/docusaurus.config.js index 804976ed..c1318edc 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -75,10 +75,7 @@ const config = { to: "/eigenlayer/operator-guides/operator-faq", }, - { - from: "/eigenlayer/avs-guides/avs-development-guide", - to: "/developers/how-to-build-an-avs", - }, + { from: "/eigenlayer/restaking-guides/restaking-user-guide/testnet/rewards-claiming/rewards-claiming-instructions", @@ -209,7 +206,7 @@ const config = { activeBasePath: 'eigenlayer/', }, { - to: "developers/avs-developer-guide", + to: "developers/Concepts/avs-developer-guide", label: "Developers", position: "left", activeBasePath: 'developer/', From bd627ef1cf52b5c748f8fdec7c0ae4a4d5bcd39a Mon Sep 17 00:00:00 2001 From: Madeline Murray Date: Thu, 6 Feb 2025 14:55:28 +1000 Subject: [PATCH 3/9] Addressing review comments --- docs/developers/Concepts/security/_category_.json | 4 ---- docs/developers/HowTo/avs-opset-slashing.md | 2 +- docs/developers/HowTo/avs-permissionlesss.md | 2 +- docs/developers/HowTo/deployment-testnet-mainnet.md | 4 ++-- docs/developers/HowTo/how-to-build-an-avs.md | 4 ++-- ...avs-marketplace-interfaces.md => onboard-avs-dashboard.md} | 4 ++-- docs/developers/{Tutorials => HowTo}/quickstart.md | 4 ++-- docs/developers/HowTo/rewards.md | 2 +- docs/developers/HowTo/support.md | 2 +- .../security => Reference}/avs-developer-best-practices.md | 0 docusaurus.config.js | 4 ++++ 11 files changed, 16 insertions(+), 16 deletions(-) delete mode 100644 docs/developers/Concepts/security/_category_.json rename docs/developers/HowTo/{implement-avs-marketplace-interfaces.md => onboard-avs-dashboard.md} (99%) rename docs/developers/{Tutorials => HowTo}/quickstart.md (99%) rename docs/developers/{Concepts/security => Reference}/avs-developer-best-practices.md (100%) diff --git a/docs/developers/Concepts/security/_category_.json b/docs/developers/Concepts/security/_category_.json deleted file mode 100644 index 535d2317..00000000 --- a/docs/developers/Concepts/security/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "position": 1, - "label": "Security" -} \ No newline at end of file diff --git a/docs/developers/HowTo/avs-opset-slashing.md b/docs/developers/HowTo/avs-opset-slashing.md index da5c5622..48918b35 100644 --- a/docs/developers/HowTo/avs-opset-slashing.md +++ b/docs/developers/HowTo/avs-opset-slashing.md @@ -1,5 +1,5 @@ --- -sidebar_position: 3 +sidebar_position: 4 title: Implement Slashing of Unique Stake --- diff --git a/docs/developers/HowTo/avs-permissionlesss.md b/docs/developers/HowTo/avs-permissionlesss.md index 3259aaae..5f4fdf4f 100644 --- a/docs/developers/HowTo/avs-permissionlesss.md +++ b/docs/developers/HowTo/avs-permissionlesss.md @@ -1,5 +1,5 @@ --- -sidebar_position: 6 +sidebar_position: 7 title: Add ERC-20 Tokens as Restakable Asset --- diff --git a/docs/developers/HowTo/deployment-testnet-mainnet.md b/docs/developers/HowTo/deployment-testnet-mainnet.md index 863c27cf..6c4655bd 100644 --- a/docs/developers/HowTo/deployment-testnet-mainnet.md +++ b/docs/developers/HowTo/deployment-testnet-mainnet.md @@ -1,5 +1,5 @@ --- -sidebar_position: 5 +sidebar_position: 6 title: Prepare for and Deploy to Testnet and Mainnet --- @@ -15,7 +15,7 @@ title: Prepare for and Deploy to Testnet and Mainnet - Communication channels that will be utilized for AVS upgrades. - Describe Operator monitoring tooling available, such as GraFana dashboards, log files or similar. -3. Follow the [AVS Developer Security Best Practices](../Concepts/security/avs-developer-best-practices.md) and [Key Manage Considerations for Developers](../Concepts/security/avs-developer-best-practices.md#key-management-recommendation-for-developers). +3. Follow the [AVS Developer Security Best Practices](../Reference/avs-developer-best-practices.md) and [Key Manage Considerations for Developers](../Reference/avs-developer-best-practices.md#key-management-recommendation-for-developers). 4. Implement the [Node Specification](https://docs.eigenlayer.xyz/eigenlayer/avs-guides/spec/intro) for your Operator executable package. diff --git a/docs/developers/HowTo/how-to-build-an-avs.md b/docs/developers/HowTo/how-to-build-an-avs.md index bf6cb755..e180eca9 100644 --- a/docs/developers/HowTo/how-to-build-an-avs.md +++ b/docs/developers/HowTo/how-to-build-an-avs.md @@ -1,11 +1,11 @@ --- -sidebar_position: 1 +sidebar_position: 2 title: Build Your Own AVS --- This section will walk you through the process of designing and building your own AVS from scratch. It is intended to take you from an idea to a working local prototype. -Before proceeding, please review the previous sections on [AVS Overview](../Concepts/avs-developer-guide.md), [EigenLayer Overview](/docs/eigenlayer/overview/README.md) and the [Quick Start example](../Tutorials/quickstart.md) to become familiar with the basic concepts. +Before proceeding, please review the previous sections on [AVS Overview](../Concepts/avs-developer-guide.md), [EigenLayer Overview](/docs/eigenlayer/overview/README.md) and the [Quick Start example](quickstart.md) to become familiar with the basic concepts. ## Step 1: AVS Design diff --git a/docs/developers/HowTo/implement-avs-marketplace-interfaces.md b/docs/developers/HowTo/onboard-avs-dashboard.md similarity index 99% rename from docs/developers/HowTo/implement-avs-marketplace-interfaces.md rename to docs/developers/HowTo/onboard-avs-dashboard.md index bb403712..7f3953ea 100644 --- a/docs/developers/HowTo/implement-avs-marketplace-interfaces.md +++ b/docs/developers/HowTo/onboard-avs-dashboard.md @@ -1,6 +1,6 @@ --- -sidebar_position: 4 -title: Implement AVS Marketplace Interfaces +sidebar_position: 5 +title: Onboard to AVS Dashboard --- diff --git a/docs/developers/Tutorials/quickstart.md b/docs/developers/HowTo/quickstart.md similarity index 99% rename from docs/developers/Tutorials/quickstart.md rename to docs/developers/HowTo/quickstart.md index 9b392dae..6539492d 100644 --- a/docs/developers/Tutorials/quickstart.md +++ b/docs/developers/HowTo/quickstart.md @@ -1,6 +1,6 @@ --- -sidebar_position: 2 -title: Quick Start Example +sidebar_position: 1 +title: Get started --- ## Hello World AVS: Local Deployment diff --git a/docs/developers/HowTo/rewards.md b/docs/developers/HowTo/rewards.md index 116f49b5..f2e9948d 100644 --- a/docs/developers/HowTo/rewards.md +++ b/docs/developers/HowTo/rewards.md @@ -1,5 +1,5 @@ --- -sidebar_position: 2 +sidebar_position: 3 title: Implement Rewards --- diff --git a/docs/developers/HowTo/support.md b/docs/developers/HowTo/support.md index 86aef675..624c57f2 100644 --- a/docs/developers/HowTo/support.md +++ b/docs/developers/HowTo/support.md @@ -1,5 +1,5 @@ --- -sidebar_position: 7 +sidebar_position: 8 title: Get Support --- diff --git a/docs/developers/Concepts/security/avs-developer-best-practices.md b/docs/developers/Reference/avs-developer-best-practices.md similarity index 100% rename from docs/developers/Concepts/security/avs-developer-best-practices.md rename to docs/developers/Reference/avs-developer-best-practices.md diff --git a/docusaurus.config.js b/docusaurus.config.js index 804976ed..b39dcfcd 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -131,6 +131,10 @@ const config = { from: "/eigenlayer/restaking-guides/restaking-user-guide/testnet/obtaining-testnet-eth-and-liquid-staking-tokens-lsts", to: "/eigenlayer/restaking-guides/testnet/obtaining-testnet-eth-and-liquid-staking-tokens-lsts", }, + { + from: "/developers", + to: "/developers/Concepts/avs-developer-guide", + }, { from: "/eigenlayer/economy/economy-overview", to: "/eigenlayer/economy/economy-calculation-and-formulas", From 96bbf96136e1c86c14c513d8ed530ea9e52d0f50 Mon Sep 17 00:00:00 2001 From: Madeline Murray Date: Thu, 6 Feb 2025 15:45:06 +1000 Subject: [PATCH 4/9] Added redirects --- docusaurus.config.js | 45 +++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 44 insertions(+), 1 deletion(-) diff --git a/docusaurus.config.js b/docusaurus.config.js index d87f512c..a0cc5d77 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -136,7 +136,50 @@ const config = { from: "/eigenlayer/economy/economy-overview", to: "/eigenlayer/economy/economy-calculation-and-formulas", }, - + { + from: "/developers/avs-developer-guide.md", + to: "/developers/Concepts/avs-developer-guide.md", + }, + { + from: "/developers/avs-developer-best-practices.md", + to: "/developers/Reference/avs-developer-best-practices.md", + }, + { + from: "/developers/avs-opset-slashing.md", + to: "/developers/HowTo/avs-opset-slashing.md", + }, + { + from: "/developers/avs-permissionlesss.md", + to: "/developers/HowTo/avs-permissionlesss.md.md", + }, + { + from: "/developers/deployment-testnet-mainnet.md", + to: "/developers/HowTo/deployment-testnet-mainnet.md", + }, + { + from: "/developers/how-to-build-an-avs.md", + to: "/developers/HowTo/how-to-build-an-avs.md", + }, + { + from: "/developers/avs-dashboard-onboarding.md", + to: "/developers/HowTo/onboard-avs-dashboard.md", + }, + { + from: "/developers/rewards.md", + to: "/developers/HowTo/rewards.md", + }, + { + from: "/developers/support.md", + to: "/developers/HowTo/support.md", + }, + { + from: "/developers/resources.md", + to: "/developers/Reference/resources.md", + }, + { + from: "/developers/quickstart.md", + to: "/developers/Tutorials/quickstart.md", + }, ], createRedirects(existingPath) { From 52643299099a922db2671a9cd997850e9ff11f6e Mon Sep 17 00:00:00 2001 From: Madeline Murray Date: Thu, 6 Feb 2025 16:02:15 +1000 Subject: [PATCH 5/9] fixed redirects --- docusaurus.config.js | 44 ++++++++++++++++++++++---------------------- 1 file changed, 22 insertions(+), 22 deletions(-) diff --git a/docusaurus.config.js b/docusaurus.config.js index a0cc5d77..ab74d7c9 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -137,48 +137,48 @@ const config = { to: "/eigenlayer/economy/economy-calculation-and-formulas", }, { - from: "/developers/avs-developer-guide.md", - to: "/developers/Concepts/avs-developer-guide.md", + from: "/developers/avs-developer-guide", + to: "/developers/Concepts/avs-developer-guide", }, { - from: "/developers/avs-developer-best-practices.md", - to: "/developers/Reference/avs-developer-best-practices.md", + from: "/developers/avs-developer-best-practices", + to: "/developers/Reference/avs-developer-best-practices", }, { - from: "/developers/avs-opset-slashing.md", - to: "/developers/HowTo/avs-opset-slashing.md", + from: "/developers/avs-opset-slashing", + to: "/developers/HowTo/avs-opset-slashing", }, { - from: "/developers/avs-permissionlesss.md", - to: "/developers/HowTo/avs-permissionlesss.md.md", + from: "/developers/avs-permissionlesss", + to: "/developers/HowTo/avs-permissionlesss", }, { - from: "/developers/deployment-testnet-mainnet.md", - to: "/developers/HowTo/deployment-testnet-mainnet.md", + from: "/developers/deployment-testnet-mainnet", + to: "/developers/HowTo/deployment-testnet-mainnet", }, { - from: "/developers/how-to-build-an-avs.md", - to: "/developers/HowTo/how-to-build-an-avs.md", + from: "/developers/how-to-build-an-avs", + to: "/developers/HowTo/how-to-build-an-avs", }, { - from: "/developers/avs-dashboard-onboarding.md", - to: "/developers/HowTo/onboard-avs-dashboard.md", + from: "/developers/avs-dashboard-onboarding", + to: "/developers/HowTo/onboard-avs-dashboard", }, { - from: "/developers/rewards.md", - to: "/developers/HowTo/rewards.md", + from: "/developers/rewards", + to: "/developers/HowTo/rewards", }, { - from: "/developers/support.md", - to: "/developers/HowTo/support.md", + from: "/developers/support", + to: "/developers/HowTo/support", }, { - from: "/developers/resources.md", - to: "/developers/Reference/resources.md", + from: "/developers/resources", + to: "/developers/Reference/resources", }, { - from: "/developers/quickstart.md", - to: "/developers/Tutorials/quickstart.md", + from: "/developers/quickstart", + to: "/developers/Tutorials/quickstart", }, ], createRedirects(existingPath) { From 4e5b0bdc95527fb0a6af7a3b6f203fb5c10cc035 Mon Sep 17 00:00:00 2001 From: Madeline Murray Date: Thu, 6 Feb 2025 16:10:06 +1000 Subject: [PATCH 6/9] more redirect fixing --- docusaurus.config.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docusaurus.config.js b/docusaurus.config.js index ab74d7c9..cef5e2dc 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -178,7 +178,7 @@ const config = { }, { from: "/developers/quickstart", - to: "/developers/Tutorials/quickstart", + to: "/developers/HowTo/quickstart", }, ], createRedirects(existingPath) { From bbfe304db576db7beb58daae4ffd4b6ba293e399 Mon Sep 17 00:00:00 2001 From: Madeline Murray Date: Thu, 6 Mar 2025 14:44:56 +1000 Subject: [PATCH 7/9] Updating for Sepolia launch --- .../HowTo/build/how-to-build-an-avs.md | 2 +- .../operator-sets/operator-sets-concept.md | 2 +- .../strategies-and-magnitudes.md | 2 +- .../concepts/slashing/slashing-concept.md | 2 +- .../concepts/slashing/unique-stake.md | 2 +- docs/eigenlayer/releases.md | 38 +++++++++++-------- .../claim-rewards/via-cli.mdx | 18 ++++----- .../rewards-claiming/rewards-snapshot-data.md | 4 +- .../howto/operator-rewards-config.md | 4 +- docs/operators/howto/operator-sets.md | 4 +- 10 files changed, 43 insertions(+), 35 deletions(-) diff --git a/docs/developers/HowTo/build/how-to-build-an-avs.md b/docs/developers/HowTo/build/how-to-build-an-avs.md index 740a3caf..8a41e496 100644 --- a/docs/developers/HowTo/build/how-to-build-an-avs.md +++ b/docs/developers/HowTo/build/how-to-build-an-avs.md @@ -24,7 +24,7 @@ Operator responses to tasks are often signed using the BLS or ECDSA algorithm. T The following section covers the minimum set of smart contract integrations and deployment scripts that an AVS needs to build in order to: 1. Be considered a fully functional AVS for demo and proof of concept purposes. -2. Prepare your AVS to integrate Slashing functionality. Slashing is [live on Holesky Testnet](https://www.blog.eigenlayer.xyz/introducing-slashing/) and Mainnet deployment is proposed for late Q1 2025. +2. Prepare your AVS to integrate Slashing functionality. Slashing is [live on testnet](../../../eigenlayer/releases.md) and Mainnet deployment is proposed for late Q1 2025. :::info diff --git a/docs/eigenlayer/concepts/operator-sets/operator-sets-concept.md b/docs/eigenlayer/concepts/operator-sets/operator-sets-concept.md index fba84593..ee82acac 100644 --- a/docs/eigenlayer/concepts/operator-sets/operator-sets-concept.md +++ b/docs/eigenlayer/concepts/operator-sets/operator-sets-concept.md @@ -4,7 +4,7 @@ title: Operator Sets Overview --- :::note -Operator Sets are currently available on the Holesky testnet. [ELIP-002 Slashing via Unique Stake & Operator Sets](https://github.com/eigenfoundation/ELIPs/blob/main/ELIPs/ELIP-002.md) +Operator Sets are currently available on [testnet](../../releases.md). [ELIP-002 Slashing via Unique Stake & Operator Sets](https://github.com/eigenfoundation/ELIPs/blob/main/ELIPs/ELIP-002.md) introduced Operator Sets. Currently, Operators register to an AVS to earn rewards in the AVSDirectory. We recommend existing AVSs [migrate to Operator Sets on testnet](../../../developers/HowTo/slashing/migrate-to-operatorsets.md). diff --git a/docs/eigenlayer/concepts/operator-sets/strategies-and-magnitudes.md b/docs/eigenlayer/concepts/operator-sets/strategies-and-magnitudes.md index 447e284f..87f32f68 100644 --- a/docs/eigenlayer/concepts/operator-sets/strategies-and-magnitudes.md +++ b/docs/eigenlayer/concepts/operator-sets/strategies-and-magnitudes.md @@ -4,7 +4,7 @@ title: Strategies and Magnitudes --- :::note -Operator Sets are currently available on the Holesky testnet. [ELIP-002 Slashing via Unique Stake & Operator Sets](https://github.com/eigenfoundation/ELIPs/blob/main/ELIPs/ELIP-002.md) +Operator Sets are currently available on [testnet](../../releases.md). [ELIP-002 Slashing via Unique Stake & Operator Sets](https://github.com/eigenfoundation/ELIPs/blob/main/ELIPs/ELIP-002.md) introduced Operator Sets. ::: diff --git a/docs/eigenlayer/concepts/slashing/slashing-concept.md b/docs/eigenlayer/concepts/slashing/slashing-concept.md index 2ec14278..cb570405 100644 --- a/docs/eigenlayer/concepts/slashing/slashing-concept.md +++ b/docs/eigenlayer/concepts/slashing/slashing-concept.md @@ -4,7 +4,7 @@ title: Slashing Overview --- :::note -Slashing is currently available on the Holesky testnet. The Slashing release implements [ELIP-002: Slashing via Unique Stake & Operator Sets](https://github.com/eigenfoundation/ELIPs/blob/main/ELIPs/ELIP-002.md). +Slashing is currently available on [testnet](../../releases.md). The Slashing release implements [ELIP-002: Slashing via Unique Stake & Operator Sets](https://github.com/eigenfoundation/ELIPs/blob/main/ELIPs/ELIP-002.md). ::: Slashing is a type of penalty determined by an AVS as a deterrent for broken commitments by Operators. Broken commitments diff --git a/docs/eigenlayer/concepts/slashing/unique-stake.md b/docs/eigenlayer/concepts/slashing/unique-stake.md index 289c0097..04906292 100644 --- a/docs/eigenlayer/concepts/slashing/unique-stake.md +++ b/docs/eigenlayer/concepts/slashing/unique-stake.md @@ -4,7 +4,7 @@ title: Unique Stake --- :::note -Operator Sets and Slashing are currently available on the Holesky testnet. [ELIP-002 Slashing via Unique Stake & Operator Sets](https://github.com/eigenfoundation/ELIPs/blob/main/ELIPs/ELIP-002.md) +Operator Sets and Slashing are currently available on [testnet](../../releases.md). [ELIP-002 Slashing via Unique Stake & Operator Sets](https://github.com/eigenfoundation/ELIPs/blob/main/ELIPs/ELIP-002.md) introduced Operator Sets and Slashing. ::: diff --git a/docs/eigenlayer/releases.md b/docs/eigenlayer/releases.md index 26875337..d8b33ab8 100644 --- a/docs/eigenlayer/releases.md +++ b/docs/eigenlayer/releases.md @@ -2,41 +2,50 @@ sidebar_position: 3 title: Releases --- -# Mainnet +## Mainnet The [Rewards v2 release](https://www.blog.eigenlayer.xyz/rewards-v2/) is available on mainnet. The [eigenlayer-contracts](https://github.com/Layr-Labs/eigenlayer-contracts) and [eigenlayer-middleware](https://github.com/Layr-Labs/eigenlayer-middleware) include the Rewards v2 release on the `mainnet` branch in each repository. -# Testnet +## Testnet -The [Slashing](https://www.blog.eigenlayer.xyz/introducing-slashing/) and Rewards v2.1 releases are available on the Holesky testnet. +The [Slashing](https://www.blog.eigenlayer.xyz/introducing-slashing/) and Rewards v2.1 releases are available on the Sepolia testnet. The [eigenlayer-contracts](https://github.com/Layr-Labs/eigenlayer-contracts) and [eigenlayer-middleware](https://github.com/Layr-Labs/eigenlayer-middleware) -include the Slashing release on the `testnet-holesky` branch. +include the Slashing release on the `testnet-sepolia` branch. (todo-confirm) :::important -Unless specified otherwise, this documentation matches the functionality available on the Holesky testnet. For mainnet +Unless specified otherwise, this documentation matches the functionality available on the Sepolia testnet. For mainnet specific documentation, refer to the `/docs` repository on the `mainnet` branch in the [eigenlayer-contracts](https://github.com/Layr-Labs/eigenlayer-contracts) and [eigenlayer-middleware](https://github.com/Layr-Labs/eigenlayer-middleware) repositories. ::: -## What's changed +### What's changed -### Operator Sets +#### Sepolia Testnet -The Slashing release on the Holesky testnet introduced Operator Sets. The AllocationManager core contract manages Operator Sets and replaces +Due to recent instability on Holesky testnet, EigenLayer has launched on Sepolia. AVS developers can use Sepolia for development and testing. + +Currently, EigenPods and native ETH restaking are not available on Holesky. EigenLayer will continue to support Holesky as +it stabilizes for end to end protocol testing. + +For more information, refer to the [EigenLayer blog](https://www.blog.eigenlayer.xyz/). + +#### Operator Sets + +The Slashing release on testnet introduced Operator Sets. The AllocationManager core contract manages Operator Sets and replaces the AVSDirectory for registering Operators to an AVS. [The AVSDirectory will be deprecated in a future upgrade](https://docs.eigenlayer.xyz/developers/HowTo/slashing/migrate-to-operatorsets). -### Rewards v2.1 +#### Rewards v2.1 -Rewards v2.1 on the Holesky testnet introduced Operator directed rewards for Operator sets. For AVSs using Operator Sets, use `createOperatorDirectedOperatorSetRewardsSubmission`. +Rewards v2.1 on testnet introduced Operator directed rewards for Operator sets. For AVSs using Operator Sets, use `createOperatorDirectedOperatorSetRewardsSubmission`. `createAVSRewardsSubmission` and `createOperatorDirectedAVSRewardsSubmission` remain available for use by AVSs that have not yet [migrated to Operator Sets](https://docs.eigenlayer.xyz/developers/HowTo/slashing/migrate-to-operatorsets). -### Release notes +#### Release Notes For complete release notes, refer to the [`eigenlayer-contracts` repository](https://github.com/Layr-Labs/eigenlayer-contracts/releases). -# SDKs +## SDKs The [EigenLayer Rust SDK](https://github.com/Layr-Labs/eigensdk-rs) supports two bindngs: * Rewards v2 - Current mainnet release. @@ -44,9 +53,8 @@ The [EigenLayer Rust SDK](https://github.com/Layr-Labs/eigensdk-rs) supports two The [EigenLayer Go SDK](https://github.com/Layr-Labs/eigensdk-go) supports the Rewards v2.1 release. -# Samples +## Samples The [Hello World AVS](https://github.com/Layr-Labs/hello-world-avs) and [Incredible Squaring](https://github.com/Layr-Labs/incredible-squaring-avs) samples are available to for development and testing to get familiar with EigenLayer. We are currently updating these to -include rewards and slashing capabilities. - +include rewards and slashing capabilities. \ No newline at end of file diff --git a/docs/eigenlayer/rewards-claiming/claim-rewards/via-cli.mdx b/docs/eigenlayer/rewards-claiming/claim-rewards/via-cli.mdx index 79fbe606..7365aca8 100644 --- a/docs/eigenlayer/rewards-claiming/claim-rewards/via-cli.mdx +++ b/docs/eigenlayer/rewards-claiming/claim-rewards/via-cli.mdx @@ -41,10 +41,10 @@ eigenlayer version v ``` - + ```bash ./bin/eigenlayer rewards show \ - --network holesky \ + --network sepolia \ --earner-address \ --claim-type unclaimed ``` @@ -98,13 +98,13 @@ Make sure the keys you are using to claim is the claimer you have set. `comma-separated-list-of-token-addresses` - You can get this from output of [Step 3](#step-3-check-if-rewards-are-available-to-claim) - + If you are using local keystore file, use the following command to claim rewards ```bash ./bin/eigenlayer rewards claim \ - --network holesky \ - --eth-rpc-url \ + --network sepolia \ + --eth-rpc-url \ --earner-address \ --recipient-address \ --path-to-key-store /path/to/key/store-json \ @@ -128,7 +128,7 @@ If you want to see the rewards parameters before claiming, you can use the follo ```bash ./bin/eigenlayer rewards claim \ - --network holesky \ + --network mainnet \ --eth-rpc-url \ --earner-address \ --token-addresses @@ -136,13 +136,13 @@ If you want to see the rewards parameters before claiming, you can use the follo `comma-separated-list-of-token-addresses` - You can get this from output of [Step 3](#step-3-check-if-rewards-are-available-to-claim) - + If you are using local keystore file, use the following command to claim rewards ```bash ./bin/eigenlayer rewards claim \ - --network holesky \ - --eth-rpc-url \ + --network sepolia \ + --eth-rpc-url \ --earner-address \ --token-addresses ``` diff --git a/docs/eigenlayer/rewards-claiming/rewards-snapshot-data.md b/docs/eigenlayer/rewards-claiming/rewards-snapshot-data.md index c674d8ed..a6214b4f 100644 --- a/docs/eigenlayer/rewards-claiming/rewards-snapshot-data.md +++ b/docs/eigenlayer/rewards-claiming/rewards-snapshot-data.md @@ -23,10 +23,10 @@ Rewards snapshot distribution data is available via a public S3 bucket. Users ma `////claim-amounts.json` * bucket_url: - * [https://eigenlabs-rewards-testnet-holesky.s3.amazonaws.com](https://eigenlabs-rewards-testnet-holesky.s3.amazonaws.com) + * [https://eigenlabs-rewards-testnet-sepolia.s3.amazonaws.com](https://eigenlabs-rewards-testnet-sepolia.s3.amazonaws.com) * [https://eigenlabs-rewards-mainnet-ethereum.s3.amazonaws.com](https://eigenlabs-rewards-mainnet-ethereum.s3.amazonaws.com) * environment: testnet or mainnet -* network: holesky or ethereum +* network: sepolia or ethereum Example: diff --git a/docs/operators/howto/operator-rewards-config.md b/docs/operators/howto/operator-rewards-config.md index f9df6481..499a4b6f 100644 --- a/docs/operators/howto/operator-rewards-config.md +++ b/docs/operators/howto/operator-rewards-config.md @@ -21,10 +21,10 @@ Operators can set their per-AVS fee rate via the EigenLayer CLI with the followi ``` # Get the current per-AVS fee rate -eigenlayer-cli operator get-rewards-split --operator-address [operator_address] --avs-address [avs_address] --eth-rpc-url [rpc_endpoint] --network holesky +eigenlayer-cli operator get-rewards-split --operator-address [operator_address] --avs-address [avs_address] --eth-rpc-url [rpc_endpoint] --network sepolia # Set the current per-AVS fee rate -eigenlayer-cli operator set-rewards-split --operator-address [operator_address] --avs-address [avs_address] --eth-rpc-url [rpc_endpoint] --network holesky --path-to-key-store [path_to_local_operator_ecdsa_keystore.ecdsa.key.json] --operator-split [split in bips] --broadcast +eigenlayer-cli operator set-rewards-split --operator-address [operator_address] --avs-address [avs_address] --eth-rpc-url [rpc_endpoint] --network sepolia --path-to-key-store [path_to_local_operator_ecdsa_keystore.ecdsa.key.json] --operator-split [split in bips] --broadcast ``` Please note the Operator split is denoted in units of bips (basis points). E.g. 1000 = 10%. diff --git a/docs/operators/howto/operator-sets.md b/docs/operators/howto/operator-sets.md index c5718db1..eecd1093 100644 --- a/docs/operators/howto/operator-sets.md +++ b/docs/operators/howto/operator-sets.md @@ -19,7 +19,7 @@ Set Allocations per Operator Set and Strategy ``` eigenlayer operator allocations update - --network holesky + --network sepolia --operator-address --csv-file updates.csv --caller-address @@ -46,7 +46,7 @@ View all your allocations with show command as below ``` eigenlayer operator allocations show - --network holesky + --network sepolia --operator-address --strategy-addresses From ade320d659d6db29ba7571835d36fa0084ed6051 Mon Sep 17 00:00:00 2001 From: Madeline Murray Date: Fri, 7 Mar 2025 09:20:22 +1000 Subject: [PATCH 8/9] Restored snapshot data to original state --- docs/eigenlayer/rewards-claiming/rewards-snapshot-data.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/eigenlayer/rewards-claiming/rewards-snapshot-data.md b/docs/eigenlayer/rewards-claiming/rewards-snapshot-data.md index a6214b4f..c674d8ed 100644 --- a/docs/eigenlayer/rewards-claiming/rewards-snapshot-data.md +++ b/docs/eigenlayer/rewards-claiming/rewards-snapshot-data.md @@ -23,10 +23,10 @@ Rewards snapshot distribution data is available via a public S3 bucket. Users ma `////claim-amounts.json` * bucket_url: - * [https://eigenlabs-rewards-testnet-sepolia.s3.amazonaws.com](https://eigenlabs-rewards-testnet-sepolia.s3.amazonaws.com) + * [https://eigenlabs-rewards-testnet-holesky.s3.amazonaws.com](https://eigenlabs-rewards-testnet-holesky.s3.amazonaws.com) * [https://eigenlabs-rewards-mainnet-ethereum.s3.amazonaws.com](https://eigenlabs-rewards-mainnet-ethereum.s3.amazonaws.com) * environment: testnet or mainnet -* network: sepolia or ethereum +* network: holesky or ethereum Example: From 93af9d76a853893ff1655d31d68b70d46813437a Mon Sep 17 00:00:00 2001 From: Madeline Murray Date: Fri, 7 Mar 2025 09:26:17 +1000 Subject: [PATCH 9/9] Updating from testnet-holesky branch to testnet-sepolia branch --- .../eigenlayer-contracts/core-contracts.md | 20 +++++++++---------- docs/eigenlayer/releases.md | 2 +- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/developers/Concepts/eigenlayer-contracts/core-contracts.md b/docs/developers/Concepts/eigenlayer-contracts/core-contracts.md index cf75a372..297b124d 100644 --- a/docs/developers/Concepts/eigenlayer-contracts/core-contracts.md +++ b/docs/developers/Concepts/eigenlayer-contracts/core-contracts.md @@ -11,17 +11,17 @@ to the core contracts. The EigenLayer core contracts are documented in the [eigenlayer-contracts](https://github.com/Layr-Labs/eigenlayer-contracts) repository. The core contracts include: -| Core contract | Description | -|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| [StrategyManager](https://github.com/Layr-Labs/eigenlayer-contracts/tree/testnet-holesky/docs#strategymanager) | Responsible for handling the accounting for Restakers as they deposit and withdraw ERC20 tokens from their corresponding strategies. The StrategyManager tracks the amount of restaked assets each Restaker has within Eigenlayer. | -| [DelegationManager](https://github.com/Layr-Labs/eigenlayer-contracts/tree/testnet-holesky/docs#delegationmanager) | Responsible for enabling Restakers to delegate assets to Operators, and withdraw assets. The DelegationManager tracks the amount of assets from each Strategy that have been delegated to each Operator, and tracks accounting for slashing. | -| [EigenPodManager](https://github.com/Layr-Labs/eigenlayer-contracts/tree/testnet-holesky/docs#eigenpodmanager) | Enables native ETH restaking | -| [AllocationManager](https://github.com/Layr-Labs/eigenlayer-contracts/tree/testnet-holesky/docs#allocationmanager) | Responsible for creating Operator Sets, and Operator registrations to Operator Sets. The Allocation Manager also tracks allocation of stake to a Operator Set, and enables AVSs to slash that stake. -| [RewardsCoordinator](https://github.com/Layr-Labs/eigenlayer-contracts/tree/testnet-holesky/docs#allocationmanager) | Enables AVSs to distribute ERC20 tokens to Operators and Restakers who delegated assets to Operators. The RewardsCoordinator tracks the rewards and enables Operators and Restakers to claim them. -| [PermissionController](https://github.com/Layr-Labs/eigenlayer-contracts/tree/testnet-holesky/docs#permissioncontroller) |Enables AVSs and operators to delegate the ability to call certain core contract functions to other addresses.| -| [AVSDirectory](https://github.com/Layr-Labs/eigenlayer-contracts/tree/testnet-holesky/docs#avsdirectory) | Has been replaced by AllocationManager and will be deprecated in a future release. | +| Core contract | Description | +|--------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [StrategyManager](https://github.com/Layr-Labs/eigenlayer-contracts/tree/testnet-sepolia/docs#strategymanager) | Responsible for handling the accounting for Restakers as they deposit and withdraw ERC20 tokens from their corresponding strategies. The StrategyManager tracks the amount of restaked assets each Restaker has within Eigenlayer. | +| [DelegationManager](https://github.com/Layr-Labs/eigenlayer-contracts/tree/testnet-sepolia/docs#delegationmanager) | Responsible for enabling Restakers to delegate assets to Operators, and withdraw assets. The DelegationManager tracks the amount of assets from each Strategy that have been delegated to each Operator, and tracks accounting for slashing. | +| [EigenPodManager](https://github.com/Layr-Labs/eigenlayer-contracts/tree/testnet-sepolia/docs#eigenpodmanager) | Enables native ETH restaking | +| [AllocationManager](https://github.com/Layr-Labs/eigenlayer-contracts/tree/testnet-sepolia/docs#allocationmanager) | Responsible for creating Operator Sets, and Operator registrations to Operator Sets. The Allocation Manager also tracks allocation of stake to a Operator Set, and enables AVSs to slash that stake. +| [RewardsCoordinator](https://github.com/Layr-Labs/eigenlayer-contracts/tree/testnet-sepolia/docs#allocationmanager) | Enables AVSs to distribute ERC20 tokens to Operators and Restakers who delegated assets to Operators. The RewardsCoordinator tracks the rewards and enables Operators and Restakers to claim them. +| [PermissionController](https://github.com/Layr-Labs/eigenlayer-contracts/tree/testnet-sepolia/docs#permissioncontroller) |Enables AVSs and operators to delegate the ability to call certain core contract functions to other addresses.| +| [AVSDirectory](https://github.com/Layr-Labs/eigenlayer-contracts/tree/testnet-sepolia/docs#avsdirectory) | Has been replaced by AllocationManager and will be deprecated in a future release. | -This documentation matches the functionality available on the Holesky testnet. For mainnet +This documentation matches the functionality available on the Sepolia testnet. For mainnet specific documentation, refer to the `/docs` repository on the `mainnet` branch in the [eigenlayer-contracts](https://github.com/Layr-Labs/eigenlayer-contracts) repository. diff --git a/docs/eigenlayer/releases.md b/docs/eigenlayer/releases.md index d8b33ab8..ddcc2982 100644 --- a/docs/eigenlayer/releases.md +++ b/docs/eigenlayer/releases.md @@ -12,7 +12,7 @@ in each repository. The [Slashing](https://www.blog.eigenlayer.xyz/introducing-slashing/) and Rewards v2.1 releases are available on the Sepolia testnet. The [eigenlayer-contracts](https://github.com/Layr-Labs/eigenlayer-contracts) and [eigenlayer-middleware](https://github.com/Layr-Labs/eigenlayer-middleware) -include the Slashing release on the `testnet-sepolia` branch. (todo-confirm) +include the Slashing release on the `testnet-sepolia` branch. :::important Unless specified otherwise, this documentation matches the functionality available on the Sepolia testnet. For mainnet