Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
N
nebula
Project
Project
Details
Activity
Releases
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
exchain
nebula
Commits
e9d39076
Unverified
Commit
e9d39076
authored
Nov 30, 2023
by
Maurelian
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Add spec for superchain-config with pausability
parent
e7f0e9d6
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
68 additions
and
0 deletions
+68
-0
superchain-configuration.md
specs/superchain-configuration.md
+68
-0
No files found.
specs/superchain-configuration.md
0 → 100644
View file @
e9d39076
# Superchain Configuration
The SuperchainConfig contract is used to manage global configuration values for multiple OP Chains within
a single Superchain network.
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
**Table of Contents**
-
[
Configurable values
](
#configurable-values
)
-
[
Configuration data flow
](
#configuration-data-flow
)
-
[
Pausability
](
#pausability
)
-
[
Paused identifiers
](
#paused-identifiers
)
-
[
Scope of pausability
](
#scope-of-pausability
)
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
## Configurable values
Configurability of the Superchain is currently limited to two values:
The
`SuperchainConfig`
contract manages the following configuration values:
-
`PAUSED_SLOT`
: A boolean value indicating whether the Superchain is paused.
-
`GUARDIAN_SLOT`
: The address of the guardian, which can pause and unpause the system.
## Configuration data flow
All contracts which read from the
`SuperchainConfig`
contract hold its address as storage values
in the proxy account, and call directly to it when reading configuration data.
```
mermaid
flowchart TD
StandardBridge --> SuperchainConfig
L1ERC721Bridge --> SuperchainConfig
L1CrossDomainMessenger --> SuperchainConfig
OptimismPortal --> SuperchainConfig
```
### Pausability
The Superchain pause feature is a safety mechanism designed to temporarily halt withdrawals from the system in
an emergency situation. The Guardian role is authorized to pause and unpause the system.
#### Paused identifiers
The Guardian may distributed a set of presigned transactions to trusted partners, so that the
`pause()`
method may be called as quickly as possible in the event of an emergency. Although this increases the risk of
the system being paused unnecessarily, this is preferable to not pausing when assets are legitimately
vulnerable.
When the system is paused the
`Paused(string identifier)`
event is emitted, which enables easy attribution
of which partner triggered the pause.
#### Scope of pausability
The pause applies specifically to withdrawals of assets from the L1 bridge contracts. The L2 bridge contracts
are not pausable, on the basis that issues on L2 can be addressed more easily by a hard fork in the consensus
layer.
When the Pause is activated, the following methods are disabled:
1.
`OptimismPortal.proveWithdrawalTransaction()`
2.
`OptimismPortal.finalizeWithdrawalTransaction()`
3.
`StandardBridge.finalizeBridgeERC20()`
4.
`StandardBridge.finalizeBridgeETH()`
5.
`L1ERC721Bridge.finalizeBridgeERC721()`
6.
`L1CrossDomainMessenger.relayMessage()`
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment