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
833e7273
Unverified
Commit
833e7273
authored
Sep 13, 2023
by
protolambda
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
specs: update build-tag format and specify ProtocolVersions contract interface
parent
4732cfa2
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
19 additions
and
1 deletion
+19
-1
superchain-upgrades.md
specs/superchain-upgrades.md
+19
-1
No files found.
specs/superchain-upgrades.md
View file @
833e7273
...
...
@@ -25,6 +25,7 @@ chains following the same Superchain Target upgrade synchronously.
-
[
Protocol Version Exposure
](
#protocol-version-exposure
)
-
[
Superchain Target
](
#superchain-target
)
-
[
Superchain Version signaling
](
#superchain-version-signaling
)
-
[
`ProtocolVersions` L1 contract
](
#protocolversions-l1-contract
)
-
[
Activation rules
](
#activation-rules
)
-
[
L2 Block-number based activation (deprecated)
](
#l2-block-number-based-activation-deprecated
)
-
[
L2 Block-timestamp based activation
](
#l2-block-timestamp-based-activation
)
...
...
@@ -75,7 +76,7 @@ version-type `0`:
```
text
<reserved><build><major><minor><patch><pre-release>
<reserved> ::= <7 zeroed bytes>
<build> ::= <
big-endian uint64
>
<build> ::= <
8 bytes
>
<major> ::= <big-endian uint32>
<minor> ::= <big-endian uint32>
<patch> ::= <big-endian uint32>
...
...
@@ -99,6 +100,10 @@ The major/minor/patch versions should align with that of the upstream protocol t
Users of the protocol can choose to implement custom support for the alternative
`<build>`
,
but may work out of the box if the major features are consistent with that of the upstream protocol version.
The 8 byte
`<build>`
identifier may be presented as string for human readability if the contents are alpha-numeric,
including
`-`
and
`.`
, as outlined in the
[
Semver
]
format specs. Trailing
`0`
bytes can be used for padding.
It may be presented as
`0x`
-prefixed hex string otherwise.
#### Major versions
Major version changes indicate support for new consensus-breaking functionality.
...
...
@@ -166,6 +171,19 @@ cross-component APIs like the Engine API may be used to forward the Protocol Ver
to keep components encapsulated from L1.
See
[
`engine_signalOPStackVersionV1`
](
./exec-engine.md#enginesignalopstackversionv1
)
.
### `ProtocolVersions` L1 contract
The
`ProtocolVersions`
contract on L1 enables L2 nodes to pick up on superchain protocol version signals.
The interface is:
-
Required storage slot:
`bytes32(uint256(keccak256("protocolversion.required")) - 1)`
-
Recommended storage slot:
`bytes32(uint256(keccak256("protocolversion.recommended")) - 1)`
-
Required getter:
`required()`
returns
`ProtocolVersion`
-
Recommended getter
`recommended()`
returns
`ProtocolVersion`
-
Version updates also emit a typed event:
`event ConfigUpdate(uint256 indexed version, UpdateType indexed updateType, bytes data)`
## Activation rules
The below L2-block based activation rules may be applied in two contexts:
...
...
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