CircuitBreaker spec [DO NOT MERGE]#884
Draft
failingtwice wants to merge 2 commits intomainfrom
Draft
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds documentation for the new CircuitBreaker emergency-pause layer (per LIP-34) and wires it into the Contracts docs navigation, while marking GateSeal as deprecated in favor of CircuitBreaker.
Changes:
- Adds a new
CircuitBreakercontract specification page with roles, parameters, and method/event reference. - Updates the Contracts sidebar to include the new CircuitBreaker doc.
- Adds a deprecation notice to the existing GateSeal documentation pointing readers to CircuitBreaker.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| sidebars.js | Adds contracts/circuit-breaker to the Contracts section navigation. |
| docs/contracts/gate-seal.md | Adds a deprecation notice directing users to CircuitBreaker (LIP-34). |
| docs/contracts/circuit-breaker.md | Introduces a full spec/reference page for CircuitBreaker, including addresses and API details. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+3
to
+4
| :::info | ||
| GateSeals have been deprecated and replaced by [CircuitBreaker](/contracts/circuit-breaker) ([LIP-34](https://github.com/lidofinance/lido-improvement-proposals/blob/develop/LIPS/lip-34.md)). |
|
|
||
| Each pauser has its own heartbeat expiry timestamp. The pauser is considered *live* while their expiry timestamp is in the future. While live, the pauser can pause any of its assigned contracts and can extend its expiry by sending a heartbeat. Once the expiry passes, the pauser is no longer considered live and can neither pause nor extend expiry. | ||
|
|
||
| A heartbeat is a drill transaction that updates the caller's heartbeat. An expired pauser cannot revive itself, so the pauser must renew their heartebat before it expires. |
|
|
||
| The set of pausables and their assigned pausers is maintained by the DAO. See the deployed-contracts pages for the current registry on each network: | ||
|
|
||
| - [Mainnet deployments](/deployed-contracts/) #TODO |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Please, go through these steps before you request a review:
📝 Describe your changes
🔎 Attach a source of truth or evidence that allows reviewers to confirm the changes independently