-
Notifications
You must be signed in to change notification settings - Fork 462
feat: release notes; fix compile; add ProtocolRegistry docs
#1672
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
nadir-akhtar
merged 5 commits into
release-dev/slashing-ux-improvements
from
yash/slashing-ux-release-notes
Dec 2, 2025
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,61 @@ | ||
| # v1.9.0 Slashing UX Improvements | ||
|
|
||
| ## Release Manager | ||
|
|
||
| @ypatil12 @eigenmikem @0xclandestine | ||
|
|
||
| # Overview | ||
|
|
||
| The Slashing UX improvement release is a tech debt-focused release that improves key parts of the Eigenlayer Core UX. This release will upgrade every core contract. | ||
|
|
||
| The below release notes cover Core Contracts. | ||
|
|
||
| ## Highlights | ||
|
|
||
| 🚀 New Features | ||
|
|
||
| - The `AllocationManager` has been split into two contracts to address size limitations of the contract. The main contract handles state-mutating operations, while `AllocationManagerView` handles all read-only view functions. **This is not a breaking change for introspection as previous introspection calls fallback to `delegateCall` into the `AllocationManagerView` contract.**. For more information, see the [contract architecture](../docs/core/AllocationManager.md#contract-architecture). | ||
| - The `ProtocolRegistry` is a new contract that stores all proxy contract addresses, global semver, and has the ability to pause the entire protocol. This contract will be deployed on all chains. | ||
| - Two new `createOperatorSets` functions (for redistributing and non redistributing operatorSets) have been added that take in a slasher address. This address is the *only* address that can slash an operatorSet. Changing the address is behind a `ALLOCATION_CONFIGURATION_DELAY` (17.5 days on mainnet). | ||
|
|
||
| ⛔ Breaking Changes | ||
|
|
||
| - The slasher permissions are set and stored in the `AllocationManager` instead of the `PermissionController`. Only one address can slash an operatorSet; the address is initially set upon creation of the operatorSet. OperatorSets created prior to this release will have their slasher migrated based on the following rules: | ||
| - If there is no slasher set or the slasher in the `PermissionController` is the 0 address, the AVS address will be set as the slasher | ||
| - If there are multiple slashers set in the `PermissionController`, the first address will be set as the slasher | ||
| - Semver (`SemverMixin.sol`) has been removed from all contracts, except from those that inherit the `SignatureUtilsMixin`. The version of the core protocol can be introspected via the `ProtocolRegistry`. | ||
|
|
||
| 📌 Deprecations | ||
|
|
||
| The old `createOperatorSets` functions in the leftmost column will be deprecated in Q2 2026 in favor of the newly specified functions. The old functions do not pass in a slasher. The new functions do pass in a slasher. If the old function is used, the slasher of the operatorSet is set to the avs address. | ||
|
|
||
| | Function | MigrateTo | Notes | | ||
| | -------- | -------- | -------- | | ||
| | `createOperatorSets(avs, CreateSetParams[])` | `createOperatorSets(address avs, CreateSetParamsV2[])` | New function takes in a slasher address | | ||
| | `createRedistributingOperatorSets(avs, CreateSetParams[], redistributionRecipients[])` | `createRedistributingOperatorSets(avs, CreateSetParamsV2[], redistributionRecipients[])` | New function takes in a slasher address | | ||
|
|
||
| 🔧 Improvements | ||
|
|
||
| - Added a non-revert `_canCall` in the `PermissionControllerMixin` for space savings. This function is used in the `AllocationManager` and `DelegationManager`. | ||
| - The allocation delay for a newly created operator is active immediately. This allows operators to make allocations instantly after registering in the core. | ||
| - The internal `SlashingLib.scaleForBurning` function has been deprecated in favor of `SlashingLib.calcSlashedAmount`, standardizing the calculation of slashed shares across the withdrawal queue and storage. See [PR #1502](https://github.com/Layr-Labs/eigenlayer-contracts/pull/1502) for more information. | ||
|
|
||
|
|
||
| # Changelog | ||
|
|
||
| - feat: re-enable forge fmt + foundry v1.5.0 [PR #1669](https://github.com/layr-labs/eigenlayer-contracts/pull/1669) | ||
| - feat: substitute calcSlashedAmount for scaleForBurning [PR #1502](https://github.com/layr-labs/eigenlayer-contracts/pull/1502) | ||
| - fix: `v1.9.0` upgrade script [PR #1666](https://github.com/layr-labs/eigenlayer-contracts/pull/1666) | ||
| - feat: `v1.9.0` upgrade scripts + reusable upgrade helpers [PR #1665](https://github.com/layr-labs/eigenlayer-contracts/pull/1665) | ||
| - chore: update interface natspec for DM [PR #1664](https://github.com/layr-labs/eigenlayer-contracts/pull/1664) | ||
| - feat: slashing commitments [PR #1645](https://github.com/layr-labs/eigenlayer-contracts/pull/1645) | ||
| - feat: remove semver + minor optimizations [PR #1654](https://github.com/layr-labs/eigenlayer-contracts/pull/1654) | ||
| - feat: split `AllocationManager` [PR #1643](https://github.com/layr-labs/eigenlayer-contracts/pull/1643) | ||
| - feat: add protocol registry [PR #1655](https://github.com/layr-labs/eigenlayer-contracts/pull/1655) | ||
| - feat: instant alloc delay from dm [PR #1646](https://github.com/layr-labs/eigenlayer-contracts/pull/1646) | ||
| - chore: remove holesky [PR #1662](https://github.com/layr-labs/eigenlayer-contracts/pull/1662) | ||
| - chore: hardcode foundry ci to v1.3.5 [PR #1658](https://github.com/layr-labs/eigenlayer-contracts/pull/1658) | ||
| - chore: hardcode foundry to v1.3.5 in ci [PR #1657](https://github.com/layr-labs/eigenlayer-contracts/pull/1657) | ||
| - feat(audit): publish Hourglass + Multichain + RMS audit reports [PR #1644](https://github.com/layr-labs/eigenlayer-contracts/pull/1644) | ||
| - docs: add transport frequency for multichain [PR #1642](https://github.com/layr-labs/eigenlayer-contracts/pull/1642) | ||
| - chore: update readMe for multichain/hourglass [PR #1637](https://github.com/layr-labs/eigenlayer-contracts/pull/1637) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,143 @@ | ||
| # ProtocolRegistry | ||
|
|
||
| | File | Notes | | ||
| | --- | --- | | ||
| | [`ProtocolRegistry.sol`](../../src/contracts/core/ProtocolRegistry.sol) | core logic | | ||
| | [`ProtocolRegistryStorage.sol`](../../src/contracts/core/storage/ProtocolRegistryStorage.sol) | state variables | | ||
| | [`IProtocolRegistry.sol`](../../src/contracts/interfaces/IProtocolRegistry.sol) | interface, events, and types | | ||
|
|
||
| Libraries and Mixins: | ||
|
|
||
| | File | Notes | | ||
| | --- | --- | | ||
| | [`AccessControlEnumerableUpgradeable`](https://docs.openzeppelin.com/contracts/5.x/api/access#AccessControlEnumerableUpgradeable) | role-based access control | | ||
| | [`Initializable`](https://docs.openzeppelin.com/contracts/5.x/api/proxy#Initializable) | protects initializer | | ||
| | [`ShortStringsUpgradeable`](https://docs.openzeppelin.com/contracts/5.x/api/utils#ShortStringsUpgradeable) | compact semantic version storage | | ||
| | [`EnumerableMap`](https://docs.openzeppelin.com/contracts/5.x/api/utils#EnumerableMap) | iterable mapping for deployment catalog | | ||
| | [`IPausable`](../../src/contracts/interfaces/IPausable.sol) | pause hook invoked during emergencies | | ||
|
|
||
| ## Overview | ||
|
|
||
| `ProtocolRegistry` is the canonical catalog of EigenLayer protocol deployments. It maps human-readable deployment names to contract addresses, tracks per-contract configuration flags, emits semantic-version updates every time a new protocol shipment occurs, and exposes functionality to pause the the entire core protocol. This contract is deployed on all EigenLayer source and destination chains. | ||
|
|
||
| ### Roles and Permissions | ||
|
|
||
| * `DEFAULT_ADMIN_ROLE`: Full control, required for `initialize`, `ship`, and `configure`. | ||
| * `PAUSER_ROLE`: Defined as `hex"01"` in storage. Addresses with this role can invoke `pauseAll()`. | ||
|
|
||
| ### Deployment Config Structure | ||
|
|
||
| ```solidity | ||
| struct DeploymentConfig { | ||
| bool pausable; // deployment supports IPausable.pauseAll() | ||
| bool deprecated; // deployment should no longer be interacted with | ||
| } | ||
| ``` | ||
|
|
||
| * `pausable` gates whether `pauseAll()` targets the deployment. | ||
| * `deprecated` prevents new pauses from being attempted against sunset contracts. | ||
|
|
||
| --- | ||
|
|
||
| ## Write Functions | ||
|
|
||
| ### `initialize` | ||
|
|
||
| ```solidity | ||
| function initialize(address initialAdmin, address pauserMultisig) external initializer | ||
| ``` | ||
|
|
||
| Initializes the proxy once by granting: | ||
|
|
||
| * `DEFAULT_ADMIN_ROLE` to `initialAdmin`. | ||
| * `PAUSER_ROLE` to `pauserMultisig`. | ||
|
|
||
| The constructor disables further initializers; therefore `initialize` must be called exactly once after deployment. Upon deployment the `executorMultisig` will be the default admin and the `pauserMultisig` will hold the `PAUSER_ROLE`. | ||
|
|
||
| ### `ship` | ||
|
|
||
| ```solidity | ||
| function ship( | ||
| address[] calldata addresses, | ||
| DeploymentConfig[] calldata configs, | ||
| string[] calldata names, | ||
| string calldata semanticVersion | ||
| ) external onlyRole(DEFAULT_ADMIN_ROLE) | ||
| ``` | ||
|
|
||
| Ships a new semantic version and batch-registers deployments: | ||
|
|
||
| *Effects*: | ||
| * Calls `_updateSemanticVersion(semanticVersion)` and emits `SemanticVersionUpdated`. | ||
| * For each address to ship: | ||
| * Calls `_appendDeployment`, which stores the name→address mapping, records the config, and emits `DeploymentShipped`. | ||
|
|
||
| *Requirements*: | ||
| * Caller must hold `DEFAULT_ADMIN_ROLE`. | ||
|
|
||
| In practice, for upgrades that do not deploy net new contracts, only the `semanticVersion` parameter will be populated, with the rest left empty. | ||
|
|
||
| A contract name may be passed to this function repeatedly; each time, the previous address mapping for that name is overwritten with the new one. In general, this should be uncommon, as changing a core contract's address is an exceptional event. | ||
|
|
||
| ### `configure` | ||
|
|
||
| ```solidity | ||
| function configure(address addr, DeploymentConfig calldata config) external onlyRole(DEFAULT_ADMIN_ROLE) | ||
| ``` | ||
|
|
||
| Updates the stored `DeploymentConfig` for a single deployment: | ||
|
|
||
| *Effects*: | ||
| * Overwrites `_deploymentConfigs[addr]` with the supplied configuration. | ||
| * Emits `DeploymentConfigured(addr, config)`. | ||
|
|
||
| *Requirements*: | ||
| * Caller must hold `DEFAULT_ADMIN_ROLE`. | ||
|
|
||
| ### `pauseAll` | ||
|
|
||
| ```solidity | ||
| function pauseAll() external onlyRole(PAUSER_ROLE) | ||
| ``` | ||
|
|
||
| Triggers emergency pausing across all tracked deployments: | ||
|
|
||
| *Effects*: | ||
| * Iterates over `_deployments`, invoking `IPausable(addr).pauseAll()` on every entry marked `pausable` and not `deprecated`. | ||
| * Silently skips deployments that fail the interface call (propagates no revert) to maximize coverage in emergencies. | ||
|
|
||
| *Requirements*: | ||
| * Caller must hold `PAUSER_ROLE`. | ||
| * Deployments targeted must implement `IPausable`; registry does not enforce this at compile time, so operators should ensure configs reflect actual contract capabilities. | ||
|
|
||
| Intended for crisis response (e.g., discovered exploit) where pauser multisig needs to freeze protocol components rapidly. | ||
|
|
||
| --- | ||
|
|
||
| ## View Functions | ||
|
|
||
| ### `version` | ||
|
|
||
| Returns the full semantic version string (e.g., `"1.9.0"`) by decoding `_semanticVersion`. | ||
|
|
||
| ### `majorVersion` | ||
|
|
||
| Extracts and returns only the major component (characters before the first dot) of the semantic version. | ||
|
|
||
| ### `getAddress` | ||
|
|
||
| Resolves a deployment name to its registered address. Useful for on-chain lookups by other contracts that only need the address. | ||
|
|
||
| ### `getDeployment` | ||
|
|
||
| Returns both the address and `DeploymentConfig` for a given name. Preferred by off-chain services that need to inspect configuration flags alongside the address. | ||
|
|
||
| ### `getAllDeployments` | ||
|
|
||
| Materializes the entire registry into parallel arrays of names, addresses, and configs. Primarily intended for off-chain introspection. | ||
|
|
||
| ### `totalDeployments` | ||
|
|
||
| Returns the length of `_deployments`, which doubles as the number of rows the registry will iterate over during `pauseAll()`. | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.