diff --git a/pages/operators/chain-operators/deploy/overview.mdx b/pages/operators/chain-operators/deploy/overview.mdx index 3d2692263..551fe743b 100644 --- a/pages/operators/chain-operators/deploy/overview.mdx +++ b/pages/operators/chain-operators/deploy/overview.mdx @@ -38,7 +38,7 @@ contracts that are deployed when the chain is created. Standard OP Stack chains should only use governance approved and audited smart contracts. The monorepo has them tagged with the following pattern `op-contracts/vX.X.X` and you can review the release notes for details on the - changes. Read more about the details in our [Smart Contract Release Section](/stack/smart-contracts#official-releases). + changes. Read more about the details in our [Smart Contract Release Section](/stack/smart-contracts/smart-contracts#official-releases). ## Sequencer node diff --git a/pages/operators/chain-operators/deploy/smart-contracts.mdx b/pages/operators/chain-operators/deploy/smart-contracts.mdx index fd85d2456..bc3af43be 100644 --- a/pages/operators/chain-operators/deploy/smart-contracts.mdx +++ b/pages/operators/chain-operators/deploy/smart-contracts.mdx @@ -32,10 +32,9 @@ Deploying OP Stack L1 contracts is a critical step in setting up your rollup. generally not considered backwards compatible. -## Deployment workflow - - ### Install op-deployer + +### Install op-deployer First, install the `op-deployer` tool following the [installation instructions](/operators/chain-operators/tools/op-deployer#installation). diff --git a/pages/operators/chain-operators/self-hosted.mdx b/pages/operators/chain-operators/self-hosted.mdx index 747eef727..c7bc895a9 100644 --- a/pages/operators/chain-operators/self-hosted.mdx +++ b/pages/operators/chain-operators/self-hosted.mdx @@ -35,8 +35,8 @@ There are two main steps to get started building your own self-hosted OP Chain: * **Chain Architecture**: OP Chains use execution and consensus clients as well as the OP Stack's privileged roles. For more details, see the [Chain Architecture](/operators/chain-operators/architecture) guide. * **Smart Contracts**: OP Chains use several smart contracts on the L1 blockchain to manage aspects of the Rollup. Each OP Stack chain has its own - set of [L1 smart contracts](/stack/smart-contracts), - [L2 predeploy contracts](/stack/smart-contracts), + set of [L1 smart contracts](/stack/smart-contracts/smart-contracts), + [L2 predeploy contracts](/stack/smart-contracts/smart-contracts), and [L2 preinstall contracts](/operators/chain-operators/features/preinstalls) that are deployed when the chain is created. * **Preinstalls**: OP Chains come with [preinstalled core contracts](/operators/chain-operators/features/preinstalls), making them usable as soon as a chain is initialized on the OP Stack. diff --git a/pages/stack/_meta.json b/pages/stack/_meta.json index 4ad73a1e5..e6aa85300 100644 --- a/pages/stack/_meta.json +++ b/pages/stack/_meta.json @@ -9,9 +9,9 @@ "design-principles": "Design philosophy & principles", "components": "OP Stack components", "public-devnets": "Public devnets", - "smart-contracts": "Smart contracts", "superchain-ops-guide": "Superchain-ops upgrades", "opcm": "OP Contracts Manager", + "smart-contracts": "Smart contracts", "rollup": "Rollup", "fault-proofs": "Fault proofs", "transactions": "Transactions", diff --git a/pages/stack/opcm.mdx b/pages/stack/opcm.mdx index 88b5ac791..4d9734315 100644 --- a/pages/stack/opcm.mdx +++ b/pages/stack/opcm.mdx @@ -24,7 +24,7 @@ import { Callout, Tabs, Steps } from 'nextra/components' The OP Contracts Manager is a contract that deploys the L1 contracts for an OP Stack chain in a single transaction. It provides a minimal set of user-configurable parameters to ensure that the resulting chain meets the standard configuration requirements. Additionally, as of [Upgrade 13](https://gov.optimism.io/t/upgrade-proposal-13-opcm-and-incident-response-improvements/9739), instances of OPCM can upgrade existing OP Stack chains. -The version deployed is always a governance-approved contract release. The set of governance approved contract releases can be found on the Optimism Monorepo releases page, and is the set of releases named `op-contracts/vX.Y.Z`. It deploys the [Fault Proof System](/stack/fault-proofs/explainer), using the [PermissionedDisputeGame](/stack/smart-contracts#permissioneddisputegame). +The version deployed is always a governance-approved contract release. The set of governance approved contract releases can be found on the Optimism Monorepo releases page, and is the set of releases named `op-contracts/vX.Y.Z`. It deploys the [Fault Proof System](/stack/fault-proofs/explainer), using the [PermissionedDisputeGame](/stack/smart-contracts/smart-contracts#permissioneddisputegame). ## Purpose diff --git a/pages/stack/smart-contracts.mdx b/pages/stack/smart-contracts.mdx index 3c6152bce..8182a7d03 100644 --- a/pages/stack/smart-contracts.mdx +++ b/pages/stack/smart-contracts.mdx @@ -1,785 +1,19 @@ --- -title: Smart Contract overview -description: Learn about the smart contracts that make up the OP Stack. +title: Smart Contracts +description: Documentation covering Smart Contracts, Upgrade Op Contracts 1 6 1 8 in the Smart Contracts section of the OP Stack ecosystem. lang: en-US -content_type: guide -topic: smart-contract-overview -personas: - - protocol-developer - - chain-operator - - app-developer -categories: - - mainnet - - protocol - - l1-contracts - - predeploys - - contract-addresses - - contract-upgrades - - architecture - - fault-proofs -is_imported_content: 'false' --- -import { Callout } from 'nextra/components' +import { Card, Cards } from 'nextra/components' -# Smart Contract overview +# Smart Contracts -This guide provides an overview of the functionality of the smart contract components. You can also find [contract addresses](/superchain/addresses) on OP Mainnet. +Documentation covering Smart Contracts, Upgrade Op Contracts 1 6 1 8 in the Smart Contracts section of the OP Stack ecosystem. -## Layer 1 contracts + + + -The layer 1 contracts of the OP Stack are deployed on Ethereum. Their primary -purpose is to facilitate the cross domain message passing and maintain the -valid state root of the layer 2. - -### Official releases - -The full smart contract release process is documented in the [monorepo](https://github.com/ethereum-optimism/optimism/blob/develop/packages/contracts-bedrock/book/src/policies/versioning.md). -All production releases are always tagged, versioned as `/v`. -Contract releases have a component name of `op-contracts` and therefore are tagged as `op-contract/vX.Y.Z`. - - - For contract releases, refer to the GitHub release notes for a given release, - which will list the specific contracts being released—**not all contracts are - considered production ready within a release**, and many are under active - development. These release pages are linked below. - - Releases or tags of the form `v` without a component name, such as `v1.1.4`, indicate releases of all Go code - only, and **DO NOT** include smart contracts. DO NOT use these releases for deploying - smart contracts—only deploy from `op-contracts/vX.Y.Z` - - -#### op-contracts/v1.8.0 - Holocene contract changes - -This release is suitable for the L1 contracts as part of the Holocene network upgrade. The Holocene network upgrade contains three changes: - -* Holocene block derivation: a set of changes that render the derivation pipeline stricter and simpler, but also improve worst-case scenarios for Fault Proofs and Interoperability. - -* EIP-1559 configurability: The elasticity and denominator EIP-1559 parameters become configurable via the SystemConfig L1 contract, allowing gas target and gas limit to be independently configured. - -* MIPS contract upgrade: Updates to support additional calls made by the new op-program version. - -* [Official - Holocene Contract Release](https://github.com/ethereum-optimism/optimism/releases/tag/op-contracts%2Fv1.8.0) - -* [Governance Post](https://gov.optimism.io/t/upgrade-proposal-11-holocene-network-upgrade/9313) - -
- **Changelog** - **Added:** - - * MIPS: [1.2.1](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.8.0/packages/contracts-bedrock/src/cannon/MIPS.sol) - * SystemConfig: [2.3.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.8.0/packages/contracts-bedrock/src/L1/SystemConfig.sol) - * FaultDisputeGame: [1.3.1](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.8.0/packages/contracts-bedrock/src/dispute/FaultDisputeGame.sol) - * PermissionedDisputeGame: [1.3.1](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.8.0/packages/contracts-bedrock/src/dispute/PermissionedDisputeGame.sol) - - **No change:** - - * AddressManager: [Latest (this has no version)](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.2.0/packages/contracts-bedrock/src/legacy/AddressManager.sol) - * AnchorStateRegistry: [2.0.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.6.0/packages/contracts-bedrock/src/dispute/AnchorStateRegistry.sol#L31) - * DelayedWETH: [1.1.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.6.0/packages/contracts-bedrock/src/dispute/weth/DelayedWETH.sol#L25) - * L1CrossDomainMessenger: [2.3.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.3.0/packages/contracts-bedrock/src/L1/L1CrossDomainMessenger.sol#L24) - * L1ERC721Bridge: [2.1.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.3.0/packages/contracts-bedrock/src/L1/L1ERC721Bridge.sol#L27) - * L1StandardBridge: [2.1.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.3.0/packages/contracts-bedrock/src/L1/L1StandardBridge.sol#L73) - * OptimismMintableERC20Factory: [1.9.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.3.0/packages/contracts-bedrock/src/universal/OptimismMintableERC20Factory.sol#L46) - * OptimismPortal: [3.10.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.4.0/packages/contracts-bedrock/src/L1/OptimismPortal2.sol#L144) - * DisputeGameFactory: [1.0.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.4.0/packages/contracts-bedrock/src/dispute/DisputeGameFactory.sol#L25) - * PreimageOracle: [1.1.2](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.6.0/packages/contracts-bedrock/src/cannon/PreimageOracle.sol) - * ProtocolVersions: [1.0.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.2.0/packages/contracts-bedrock/src/L1/ProtocolVersions.sol#L39) - * SuperchainConfig: [1.1.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.2.0/packages/contracts-bedrock/src/L1/SuperchainConfig.sol#L38) -
- -#### op-contracts/v1.6.0 - Fault proof fixes - -The release fixes security vulnerabilities found in Fault Proof contracts. They were made in response to security vulnerabilities identified during a series of third-party security audits by Spearbit, Cantina, and Code4rena. None of the vulnerabilities have been exploited, and user assets are not and were never at risk. - -The upgrade was coupled with the Granite network upgrade to improve the stability and performance of the Fault Proof System. In addition, the capabilities of the Guardian and DeputyGuardian have been extended to set the anchor state for the Fault Proof System in order to prevent referencing invalid anchor states. - -* [Official - Fault Proof Fixes Release](https://github.com/ethereum-optimism/optimism/releases/tag/op-contracts%2Fv1.6.0) -* [Governance Post](https://gov.optimism.io/t/upgrade-proposal-10-granite-network-upgrade/8733) - -
- **Changelog** - **Added:** - - * MIPS: [1.1.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.6.0/packages/contracts-bedrock/src/cannon/MIPS.sol) - * PreimageOracle: [1.1.2](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.6.0/packages/contracts-bedrock/src/cannon/PreimageOracle.sol) - * FaultDisputeGame: [1.3.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.6.0/packages/contracts-bedrock/src/dispute/FaultDisputeGame.sol#L73) - * PermissionedDisputeGame: [1.3.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.6.0/packages/contracts-bedrock/src/dispute/PermissionedDisputeGame.sol) - * DelayedWETH: [1.1.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.6.0/packages/contracts-bedrock/src/dispute/weth/DelayedWETH.sol#L25) - * DeputyGuardianModule: [2.0.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.6.0/packages/contracts-bedrock/src/Safe/SafeSigners.sol) - * AnchorStateRegistry: [2.0.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.6.0/packages/contracts-bedrock/src/dispute/AnchorStateRegistry.sol#L31) - - **No change:** - - * AddressManager: [Latest (this has no version)](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.2.0/packages/contracts-bedrock/src/legacy/AddressManager.sol) - * L1CrossDomainMessenger: [2.3.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.3.0/packages/contracts-bedrock/src/L1/L1CrossDomainMessenger.sol#L24) - * L1ERC721Bridge: [2.1.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.3.0/packages/contracts-bedrock/src/L1/L1ERC721Bridge.sol#L27) - * L1StandardBridge: [2.1.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.3.0/packages/contracts-bedrock/src/L1/L1StandardBridge.sol#L73) - * OptimismMintableERC20Factory: [1.9.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.3.0/packages/contracts-bedrock/src/universal/OptimismMintableERC20Factory.sol#L46) - * OptimismPortal: [3.10.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.4.0/packages/contracts-bedrock/src/L1/OptimismPortal2.sol#L144) - * SystemConfig: [2.2.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.4.0/packages/contracts-bedrock/src/L1/SystemConfig.sol#L111) - * DisputeGameFactory: [1.0.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.4.0/packages/contracts-bedrock/src/dispute/DisputeGameFactory.sol#L25) - * SuperchainConfig: [1.1.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.2.0/packages/contracts-bedrock/src/L1/SuperchainConfig.sol#L38) - * ProtocolVersions: [1.0.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.2.0/packages/contracts-bedrock/src/L1/ProtocolVersions.sol#L39) -
- -#### op-contracts/v1.5.0 - Safe extensions - -The Safe Extensions protocol upgrade is intended to increase the security and -decentralization of the Superchain by: - -1. Increasing the Security Council Safe's signing threshold, from 4 to 10, out - of 13 owners. This meets the 75% threshold requirement for a Stage 1 rollup - outlined in [L2Beat's Stages framework](https://medium.com/l2beat/stages-update-security-council-requirements-4c79cea8ef52) -2. Reassigning the role of Guardian from the Foundation to a new Guardian Safe - with the Security Council Safe as its sole owner. This moves the Superchain - closer to satisfying the 1 week exit window requirement for Stage 1. - * Additionally the Foundation is appointed to the new DeputyGuardian role - which is able to act as Guardian through the Guardian Safe. This - appointment can be revoked by the Security Council Safe at any time. -3. Reassigning the owner of the L2ProxyAdmin contract from the Foundation to - the Security Council. This ensures the Security Council Safe has a blocking - vote for L2 predeploy upgrades and is a requirement for Stage 1. - -* [Official - Safe Extensions Release](https://github.com/ethereum-optimism/optimism/releases/tag/op-contracts%2Fv1.5.0) -* [Governance Post](https://gov.optimism.io/t/final-protocol-upgrade-8-guardian-security-council-threshold-and-l2-proxyadmin-ownership-changes-for-stage-1-decentralization/8157) - -
- **Changelog**\ - **Added:** - - * LivenessGuard: [1.0.0](https://github.com/ethereum-optimism/optimism/blob/9047beb54c66a5c572784efec8984f259302ec92/packages/contracts-bedrock/src/Safe/LivenessGuard.sol#L29) - * LivenessModule: [1.2.0](https://github.com/ethereum-optimism/optimism/blob/9047beb54c66a5c572784efec8984f259302ec92/packages/contracts-bedrock/src/Safe/LivenessModule.sol#L57) - * DeputyGuardianModule: [1.1.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.5.0/packages/contracts-bedrock/src/Safe/SafeSigners.sol) - - **No change:** - - * AddressManager: [Latest (this has no version)](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.2.0/packages/contracts-bedrock/src/legacy/AddressManager.sol) - * L1CrossDomainMessenger: [2.3.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.3.0/packages/contracts-bedrock/src/L1/L1CrossDomainMessenger.sol#L24) - * L1ERC721Bridge: [2.1.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.3.0/packages/contracts-bedrock/src/L1/L1ERC721Bridge.sol#L27) - * L1StandardBridge: [2.1.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.3.0/packages/contracts-bedrock/src/L1/L1StandardBridge.sol#L73) - * OptimismMintableERC20Factory: [1.9.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.3.0/packages/contracts-bedrock/src/universal/OptimismMintableERC20Factory.sol#L46) - * OptimismPortal: [3.10.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.4.0/packages/contracts-bedrock/src/L1/OptimismPortal2.sol#L144) - * SystemConfig: [2.2.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.4.0/packages/contracts-bedrock/src/L1/SystemConfig.sol#L111) - * FaultDisputeGame: [1.2.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.4.0/packages/contracts-bedrock/src/dispute/FaultDisputeGame.sol#L73) - * PermissionedDisputeGame: [1.2.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.4.0/packages/contracts-bedrock/src/dispute/PermissionedDisputeGame.sol) - * DisputeGameFactory: [1.0.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.4.0/packages/contracts-bedrock/src/dispute/DisputeGameFactory.sol#L25) - * AnchorStateRegistry: [1.0.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.4.0/packages/contracts-bedrock/src/dispute/AnchorStateRegistry.sol#L28) - * DelayedWETH: [1.0.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.4.0/packages/contracts-bedrock/src/dispute/weth/DelayedWETH.sol#L25) - * MIPS: [1.0.1](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.4.0/packages/contracts-bedrock/src/cannon/MIPS.sol#L47) - * PreimageOracle: [1.0.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.4.0/packages/contracts-bedrock/src/cannon/PreimageOracle.sol#L33) - * SuperchainConfig: [1.1.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.2.0/packages/contracts-bedrock/src/L1/SuperchainConfig.sol#L38) - * ProtocolVersions: [1.0.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.2.0/packages/contracts-bedrock/src/L1/ProtocolVersions.sol#L39) -
- -#### op-contracts/v1.4.0 - Fault proofs - -This protocol upgrade reduces the trust assumptions for users of the OP Stack -by enabling permissionless output proposals and a permissionless fault proof -system. As part of a responsible and safe rollout of Fault Proofs, it preserves -the ability for the guardian to override if necessary to maintain security. - -As a result, withdrawals no longer depend on the privileged proposer role -posting an output root, allowing the entire withdrawal process to be completed -without any privileged actions. The trust assumption is reduced to requiring -only that the Guardian role does not act to intervene. - -Combined with the Guardian, Security Council Threshold and L2 ProxyAdmin -Ownership changes 23 proposals, this satisfies the criteria to have OP Chains -reach Stage 1 status. - -* [Official - Fault Proof Release](https://github.com/ethereum-optimism/optimism/releases/tag/op-contracts/v1.4.0) -* [Governance Post](https://gov.optimism.io/t/final-protocol-upgrade-7-fault-proofs/8161) - -
- **Changelog** - **Added:** - - * FaultDisputeGame: [1.2.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.4.0/packages/contracts-bedrock/src/dispute/FaultDisputeGame.sol#L73) - * PermissionedDisputeGame: [1.2.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.4.0/packages/contracts-bedrock/src/dispute/PermissionedDisputeGame.sol) - * DisputeGameFactory: [1.0.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.4.0/packages/contracts-bedrock/src/dispute/DisputeGameFactory.sol#L25) - * AnchorStateRegistry: [1.0.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.4.0/packages/contracts-bedrock/src/dispute/AnchorStateRegistry.sol#L28) - * DelayedWETH: [1.0.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.4.0/packages/contracts-bedrock/src/dispute/weth/DelayedWETH.sol#L25) - * MIPS: [1.0.1](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.4.0/packages/contracts-bedrock/src/cannon/MIPS.sol#L47) - * PreimageOracle: [1.0.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.4.0/packages/contracts-bedrock/src/cannon/PreimageOracle.sol#L33) - - **Upgraded:** - - * OptimismPortal: [3.10.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.4.0/packages/contracts-bedrock/src/L1/OptimismPortal2.sol#L144) - * SystemConfig: [2.2.0](https://github.com/ethereum-optimism/optimism/blob/547ea72d9849e13ce169fd31df0f9197651b3f86/packages/contracts-bedrock/src/L1/SystemConfig.sol#L111) - - **Deprecated:** - - * L2OutputOracle: 1.8.0 - - **No change:** - - * AddressManager: [Latest (this has no version)](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.2.0/packages/contracts-bedrock/src/legacy/AddressManager.sol) - * L1CrossDomainMessenger: [2.3.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.3.0/packages/contracts-bedrock/src/L1/L1CrossDomainMessenger.sol#L24) - * L1ERC721Bridge: [2.1.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.3.0/packages/contracts-bedrock/src/L1/L1ERC721Bridge.sol#L27) - * L1StandardBridge: [2.1.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.3.0/packages/contracts-bedrock/src/L1/L1StandardBridge.sol#L73) - * OptimismMintableERC20Factory: [1.9.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.3.0/packages/contracts-bedrock/src/universal/OptimismMintableERC20Factory.sol#L46) - * SuperchainConfig: [1.1.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.2.0/packages/contracts-bedrock/src/L1/SuperchainConfig.sol#L38) - * ProtocolVersions: [1.0.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.2.0/packages/contracts-bedrock/src/L1/ProtocolVersions.sol#L39) -
- -#### op-contracts/v1.3.0 - Multi-Chain Prep (MCP) - - - This is the current recommended contract release for new production chains. - - -This protocol upgrade strengthens the security and upgradeability of the -Superchain by enabling L1 contracts to be upgraded atomically across multiple -chains in a single transaction. This upgrade also extends the `SystemConfig` -to contain the addresses of the contracts in the network, allowing users to -discover the system's contract addresses programmatically. - -* [Official - MCP Release](https://github.com/ethereum-optimism/optimism/releases/tag/op-contracts%2Fv1.3.0) -* [Governance Post](https://gov.optimism.io/t/upgrade-proposal-6-multi-chain-prep-mcp-l1/7677) - -
- **Changelog** - - **Upgraded:** - - * OptimismPortal: [2.5.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.3.0/packages/contracts-bedrock/src/L1/OptimismPortal.sol#L94) - * L1CrossDomainMessenger: [2.3.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.3.0/packages/contracts-bedrock/src/L1/L1CrossDomainMessenger.sol#L24) - * L1StandardBridge: [2.1.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.3.0/packages/contracts-bedrock/src/L1/L1StandardBridge.sol#L73) - * L1ERC721Bridge: [2.1.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.3.0/packages/contracts-bedrock/src/L1/L1ERC721Bridge.sol#L27) - * OptimismMintableERC20Factory: [1.9.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.3.0/packages/contracts-bedrock/src/universal/OptimismMintableERC20Factory.sol#L46) - * L2OutputOracle: [1.8.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.3.0/packages/contracts-bedrock/src/L1/L2OutputOracle.sol#L59) - * SystemConfig: [1.12.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.3.0/packages/contracts-bedrock/src/L1/SystemConfig.sol#L104) - - **No change:** - - * AddressManager: [Latest (this has no version)](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.2.0/packages/contracts-bedrock/src/legacy/AddressManager.sol) - * SuperchainConfig: [1.1.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.2.0/packages/contracts-bedrock/src/L1/SuperchainConfig.sol#L38) - * ProtocolVersions: [1.0.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.2.0/packages/contracts-bedrock/src/L1/ProtocolVersions.sol#L39) -
- -#### op-contracts/v1.2.0 - SuperchainConfig with Extended Pause Functionality - -The SuperchainConfig contract is used to manage global configuration values for -multiple OP Chains within a single Superchain network. - -* [Official - SuperchainConfig and Extended Pause Release](https://github.com/ethereum-optimism/optimism/releases/tag/op-contracts%2Fv1.2.0) -* [Governance post](https://gov.optimism.io/t/upgrade-proposal-4/7534) - -
- **Changelog** - - **Added:** - - * SuperchainConfig: [1.1.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.2.0/packages/contracts-bedrock/src/L1/SuperchainConfig.sol#L38) - - **Upgraded:** - - * AddressManager: [Latest (this has no version)](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.2.0/packages/contracts-bedrock/src/legacy/AddressManager.sol) - * L1CrossDomainMessenger: [2.2.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.2.0/packages/contracts-bedrock/src/L1/L1CrossDomainMessenger.sol#L25) - * L1ERC721Bridge: [2.0.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.2.0/packages/contracts-bedrock/src/L1/L1ERC721Bridge.sol#L26) - * L1StandardBridge: [2.0.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.2.0/packages/contracts-bedrock/src/L1/L1StandardBridge.sol#L73) - * L2OutputOracle: [1.7.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.2.0/packages/contracts-bedrock/src/L1/L2OutputOracle.sol#L63) - * OptimismMintableERC20Factory: [1.8.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.2.0/packages/contracts-bedrock/src/universal/OptimismMintableERC20Factory.sol#L35) - * OptimismPortal: [2.4.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.2.0/packages/contracts-bedrock/src/L1/OptimismPortal.sol#L96) - * SystemConfig: [1.11.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.2.0/packages/contracts-bedrock/src/L1/SystemConfig.sol#L67) - * ProtocolVersions: [1.0.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.2.0/packages/contracts-bedrock/src/L1/ProtocolVersions.sol#L39) - - **No change:** - - * AddressManager: Latest (this has no version) -
- -#### op-contracts/v1.1.0 - ProtocolVersions - -The Protocol Version documents the progression of the total set of canonical -OP Stack specifications. Components of the OP Stack implement the subset of -their respective protocol component domain, up to a given Protocol Version -of the OP Stack. - -The Protocol Version is NOT a hardfork identifier, but rather indicates -software-support for a well-defined set of features introduced in past and -future hardforks, not the activation of said hardforks. - - - The Protocol Version only applies to the Protocol specifications with the - [Superchain Targets](https://specs.optimism.io/protocol/superchain-upgrades.html?utm_source=op-docs&utm_medium=docs#superchain-target) - specified within. This versioning is independent of the Semver versioning - used in OP Stack smart contracts, and the Semver-versioned reference software - of the OP-Stack. This is an optional feature. - - -* [Official ProtocolVersions Release](https://github.com/ethereum-optimism/optimism/releases/tag/op-contracts%2Fv1.1.0) - -
- **Changelog** - - **Added:** - - * ProtocolVersions: 1.0.0 - - **No change:** - - * AddressManager: [Latest (this has no version)](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.2.0/packages/contracts-bedrock/src/legacy/AddressManager.sol) - * L1CrossDomainMessenger: [1.4.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.0.0/packages/contracts-bedrock/contracts/L1/L1CrossDomainMessenger.sol#L23) - * L1ERC721Bridge: [1.1.1](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.0.0/packages/contracts-bedrock/contracts/L1/L1ERC721Bridge.sol#L23) - * L1StandardBridge: [1.1.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.0.0/packages/contracts-bedrock/contracts/L1/L1StandardBridge.sol#L94) - * L2OutputOracle: [1.3.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.0.0/packages/contracts-bedrock/contracts/L1/L2OutputOracle.sol#L81) - * OptimismMintableERC20Factory: [1.1.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.0.0/packages/contracts-bedrock/contracts/universal/OptimismMintableERC20Factory.sol#L47) - * OptimismPortal: [1.6.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.0.0/packages/contracts-bedrock/contracts/L1/OptimismPortal.sol#L143) - * SystemConfig: [1.3.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.0.0/packages/contracts-bedrock/contracts/L1/SystemConfig.sol#L83) -
- -#### op-contracts/v1.0.0 - Bedrock - -The Bedrock protocol upgrade was designed to minimize the amount -of code in the OP Stack, pushes it as close as possible to Ethereum-Equivalence, -and most importantly making the stack modular. - -* [Official - Bedrock Release](https://github.com/ethereum-optimism/optimism/releases/tag/op-contracts%2Fv1.0.0) ... -* [Governance post](https://gov.optimism.io/t/final-upgrade-1-bedrock-protocol-upgrade-v2/5548) - -
- **Changelog** - - **Added:** - - * AddressManager: [Latest (this has no version)](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.2.0/packages/contracts-bedrock/src/legacy/AddressManager.sol) - * L1CrossDomainMessenger: [1.4.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.0.0/packages/contracts-bedrock/contracts/L1/L1CrossDomainMessenger.sol#L23) - * L1ERC721Bridge: [1.1.1](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.0.0/packages/contracts-bedrock/contracts/L1/L1ERC721Bridge.sol#L23) - * L1StandardBridge: [1.1.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.0.0/packages/contracts-bedrock/contracts/L1/L1StandardBridge.sol#L94) - * L2OutputOracle: [1.3.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.0.0/packages/contracts-bedrock/contracts/L1/L2OutputOracle.sol#L81) - * OptimismMintableERC20Factory: [1.1.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.0.0/packages/contracts-bedrock/contracts/universal/OptimismMintableERC20Factory.sol#L47) - * OptimismPortal: [1.6.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.0.0/packages/contracts-bedrock/contracts/L1/OptimismPortal.sol#L143) - * SystemConfig: [1.3.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.0.0/packages/contracts-bedrock/contracts/L1/SystemConfig.sol#L83) -
- -### L1 Contract Details - -#### AddressManager - -`AddressManager` is a legacy contract that was used in the old version of the -Optimism system to manage a registry of string names to addresses. We now use a -more standard proxy system for most contracts, but this contract is still used for -the L1CrossDomainMessenger, via ResolvedDelegateProxy - -#### SuperchainConfig - -The `SuperchainConfig` contract is used to manage configuration of global -superchain values. It has the ability to pause and unpause all withdrawals -in the Superchain. - -#### L1CrossDomainMessenger - -The `L1CrossDomainMessenger` is a message passing interface between L1 and L2 -responsible for sending and receiving data on the L1 side. Users are encouraged -to use this interface instead of interacting with lower-level contracts directly. - -#### L1ERC721Bridge - -The `L1ERC721bridge` is a contract which works together with the `L2ERC721Bridge` -to make it possible to transfer ERC721 tokens from Ethereum to OP Mainnet. This -contract acts as an escrow for ERC721 tokens deposited into L2. - -#### L1StandardBridge - - - This contract is not intended to support all variations of ERC20 tokens. Examples - of some token types that may not be properly supported by this contract include, but are - not limited to: tokens with transfer fees, rebasing tokens, and tokens with blocklists. - - -The `L1StandardBridge` is responsible for transferring ETH and ERC20 tokens between L1 and -L2. In the case that an ERC20 token is native to L1, it will be escrowed within this -contract. If the ERC20 token is native to L2, it will be burnt. - -#### OptimismPortal - -The `OptimismPortal` is a low-level contract responsible for passing messages between L1 -and L2. Messages sent directly to the `OptimismPortal` have no form of replayability. -Users are encouraged to use the `L1CrossDomainMessenger` for a higher-level interface. - -#### ProtocolVersions - -The `ProtocolVersions` contract is used to manage Superchain protocol version -information. It exposes a recommended and required version for node operators. -The recommended/required versions are changed with each hard fork. Nodes can -optionally halt if using the wrong version. - -#### SystemConfig - -The `SystemConfig` contract helps manage configuration of an OP Stack -network. Much of the network's configuration is stored on L1 and picked up by -L2 as part of the derivation of the L2 chain. The contract also contains -references to all other contract addresses for the chain. - -#### DisputeGameFactory - -The `DisputeGameFactory` deploys instances of `FaultDisputeGame` and `PermissionedDisputeGame` -to resolve disputes about the OP Stack chain state at specific block numbers. -It serves as the entry point for creating and managing dispute games. -The factory uses the `AnchorStateRegistry` for initialization, -and integrates the `DelayedWETH` contract to manage participant bonds. - -#### FaultDisputeGame - -The `FaultDisputeGame` resolves disputes about the OP Stack chain state by -allowing participants to propose or challenge states. -It is deployed by the `DisputeGameFactory` and includes logic to finalize disputes. -The contract uses the `AnchorStateRegistry` to start from trusted states, -`MIPS` to execute fault proofs, the `PreimageOracle` to validate hash-based claims, -and the `DelayedWETH` contract to handle bonds. - -#### PermissionedDisputeGame - -The `PermissionedDisputeGame` is also deployed by the `DisputeGameFactory`, -and inherits logic and dependencies from `FaultDisputeGame` while adding role-based restrictions. -It restricts participation to specific roles, such as designated proposers or challengers. -It is used when stricter access controls are required, as enforced by the Guardian. - -#### AnchorStateRegistry - -The `AnchorStateRegistry` stores the latest "anchor" state for each dispute game type. -An anchor state is the most recent state proposed on L1 that was not challenged within the challenge period. -These states allow new dispute games to start from a trusted, recent state, reducing offchain computation requirements. - -#### DelayedWETH - -The `DelayedWETH` contract manages bonds posted by participants during disputes. -It delays payouts to allow time for verification, ensuring that funds are distributed correctly. -This mechanism ensures participants are financially committed and disputes are finalized securely. - -#### MIPS - -The `MIPS` contract provides an on-chain implementation of a big-endian MIPS32 R1 virtual machine, -designed to execute fault proofs for disputes by processing a standardized instruction set. -This enables instances of `FaultDisputeGame` and `PermissionedDisputeGame` to resolve disputes -over state transitions accurately and consistently. -The process starts from the trusted anchor state provided by the `AnchorStateRegistry`, -ensuring that the dispute is based on a reliable foundation. -The `PreimageOracle` is then used to retrieve pre-images of hash-based claims, -validating the data used in the computation and ensuring its integrity. - -#### PreimageOracle - -The `PreimageOracle` maps hashes to their corresponding pre-images for secure and permissioned data retrieval. -It validates hash-based claims used in disputes, such as state transitions or computational steps. -This ensures the integrity of fault proofs in `FaultDisputeGame` and `PermissionedDisputeGame` instances. - -#### DEPRECATED - L2OutputOracle - -The `L2OutputOracle` contains an array of L2 state outputs, where each output is a -commitment to the state of the L2 chain. Other contracts like the `OptimismPortal` use -these outputs to verify information about the state of L2. - -## Layer 2 Contracts (Predeploys) - -Predeployed smart contracts exist at predetermined addresses in the genesis -state. They are similar to precompiles but instead run directly in the EVM -instead of running native code outside the EVM. - -Predeploys are used instead of precompiles to make it easier for multiclient -implementations as well as allowing for more integration with hardhat/foundry -network forking. - -### WETH9 - -`WETH9` is the standard implementation of Wrapped Ether. It is a commonly used -contract and is placed as a predeploy so that it is at a deterministic address. - -* **Address:** `0x4200000000000000000000000000000000000006` -* **Introduced:** Legacy -* **Deprecated:** no -* **Proxied:** no - -### L2CrossDomainMessenger - -The `L2CrossDomainMessenger` is a high-level interface for message passing -between L1 and L2 on the L2 side. Users are generally encouraged to use this -contract instead of lower level message passing contracts. - -* **Address:** `0x4200000000000000000000000000000000000007` -* **Introduced:** Legacy -* **Deprecated:** no -* **Proxied:** yes - -### L2StandardBridge - - - This contract is not intended to support all variations of ERC20 tokens. Examples - of some token types that may not be properly supported by this contract include, but are - not limited to: tokens with transfer fees, rebasing tokens, and tokens with blocklists. - - -The `L2StandardBridge` is responsible for transferring ETH and ERC20 tokens between L1 and -L2. In the case that an ERC20 token is native to L2, it will be escrowed within this -contract. If the ERC20 token is native to L1, it will be burnt. - -* **Address:** `0x4200000000000000000000000000000000000010` -* **Introduced:** Legacy -* **Deprecated:** no -* **Proxied:** yes - -### SequencerFeeVault - -The `SequencerFeeVault` is the contract that holds any fees paid to the -Sequencer during transaction processing and block production. - -* **Address:** `0x4200000000000000000000000000000000000011` -* **Introduced:** Legacy -* **Deprecated:** no -* **Proxied:** yes - -### OptimismMintableERC20Factory - -The `OptimismMintableERC20Factory` is responsible for creating ERC20 contracts -on L2 that can be used for depositing native L1 tokens into. These ERC20 -contracts can be created permissionlessly and implement the interface required -by the StandardBridge to just work with deposits and withdrawals. - -Each ERC20 contract that is created by the `OptimismMintableERC20Factory` -allows for the L2StandardBridge to mint and burn tokens, depending on if the -user is depositing from L1 to L2 or withdrawing from L2 to L1. - -* **Address:** `0x4200000000000000000000000000000000000012` -* **Introduced:** Legacy -* **Deprecated:** no -* **Proxied:** yes - -### GasPriceOracle - -The `GasPriceOracle` is no longer a permissioned contract like in the legacy -system. It only exists to preserve the API for offchain gas estimation. The -function `getL1Fee(bytes)` accepts an unsigned RLP transaction and will return -the L1 portion of the fee. This fee pays for using L1 as a data availability -layer and should be added to the L2 portion of the fee, which pays for -execution, to compute the total transaction fee. - -Following the Ecotone upgrade, the values used for L1 fee computation are: - -* `baseFeeScalar` -* `blobBaseFeeScalar` -* `decimals` - -These new scalar values are managed by the `SystemConfig` contract on the L1 by -introducing a backwards compatible versioned encoding scheme of its scalars -storage slot. The decimals remain hardcoded to 6, and the overhead value is -ignored. - -* **Address:** `0x420000000000000000000000000000000000000F` -* **Introduced:** Legacy -* **Deprecated:** no -* **Proxied:** yes - -### GovernanceToken - -The OP token used in governance and supporting voting and delegation. -Implements EIP 2612 allowing signed approvals. Contract is "owned" by a -`MintManager` instance with permission to the `mint` function only, for the -purposes of enforcing the token inflation schedule. - -* **Address:** `0x4200000000000000000000000000000000000042` -* **Introduced:** Legacy -* **Deprecated:** no -* **Proxied:** no - -### L1Block - -The `L1Block` predeploy gives users access to information about the last known -L1 block. Values within this contract are updated once per epoch (every L1 -block) and can only be set by the "depositor" account, a special system -address. Depositor account transactions are created by the protocol whenever we -move to a new epoch. - -* **Address:** `0x4200000000000000000000000000000000000015` -* **Introduced:** Bedrock -* **Deprecated:** no -* **Proxied:** yes - -### L2ToL1MessagePasser - -The `L2ToL1MessagePasser` is a dedicated contract where messages that are being -sent from L2 to L1 can be stored. The storage root of this contract is pulled -up to the top level of the L2 output to reduce the cost of proving the -existence of sent messages. - -* **Address:** `0x4200000000000000000000000000000000000016` -* **Introduced:** Bedrock -* **Deprecated:** no -* **Proxied:** yes - -### L2ERC721Bridge - - - Do not bridge an ERC721 that was originally deployed on Optimism. This - bridge ONLY supports ERC721s originally deployed on Ethereum. Users will need to - wait for the one-week challenge period to elapse before their Optimism-native NFT - can be refunded on L2. - - -The `L2ERC721Bridge` is a contract which works together with the `L1ERC721Bridge` to -make it possible to transfer ERC721 tokens from Ethereum to Optimism. This contract -acts as a minter for new tokens when it hears about deposits into the `L1ERC721Bridge`. -This contract also acts as a burner for tokens being withdrawn. - -* **Address:** `0x4200000000000000000000000000000000000014` -* **Introduced:** Legacy -* **Deprecated:** no -* **Proxied:** yes - -### OptimismMintableERC721Factory - -Factory contract for creating `OptimismMintableERC721` contracts. - -* **Address:** `0x4200000000000000000000000000000000000017` -* **Introduced:** Bedrock -* **Deprecated:** no -* **Proxied:** yes - -### ProxyAdmin - -The `ProxyAdmin` is the owner of all of the proxy contracts set at the -predeploys. It is itself behind a proxy. The owner of the `ProxyAdmin` will -have the ability to upgrade any of the other predeploy contracts. - -* **Address:** `0x4200000000000000000000000000000000000018` -* **Introduced:** Bedrock -* **Deprecated:** no -* **Proxied:** yes - -### BaseFeeVault - -The `BaseFeeVault` predeploy receives the base fees on L2. The base fee is not -burnt on L2 like it is on L1. Once the contract has received a certain amount -of fees, the ETH can be withdrawn to an immutable address on L1. - -* **Address:** `0x4200000000000000000000000000000000000019` -* **Introduced:** Bedrock -* **Deprecated:** no -* **Proxied:** yes - -### L1FeeVault - -The `L1FeeVault` predeploy receives the L1 portion of the transaction fees. -Once the contract has received a certain amount of fees, the ETH can be -withdrawn to an immutable address on L1. - -* **Address:** `0x420000000000000000000000000000000000001a` -* **Introduced:** Bedrock -* **Deprecated:** no -* **Proxied:** yes - -### SchemaRegistry - -The `SchemaRegistry` predeploy implements the global attestation schemas for the Ethereum Attestation Service protocol. - -* **Address:** `0x4200000000000000000000000000000000000020` -* **Introduced:** Bedrock -* **Deprecated:** no -* **Proxied:** yes - -The SchemaRegistry works alongside the Ethereum Attestation Service (EAS) to enable attestations. See [Build Decentralized Identity Apps with Attestations](https://community.optimism.io/identity/about-attestations?utm_source=op-docs&utm_medium=docs) for more details on schemas and usage. - -### EAS (Ethereum Attestation Service) - -The [Ethereum Attestation Service (EAS)](https://attest.sh/) is an open-source public good included as a predeploy in the OP Stack. It allows developers to issue and manage attestations on-chain, supporting use cases such as decentralized identity and other data integrity scenarios. - -The `EAS` predeploy implements the Ethereum Attestation Service protocol. - -* **Address:** `0x4200000000000000000000000000000000000021` -* **Introduced:** Bedrock -* **Deprecated:** no -* **Proxied:** yes - -### Contract addresses - -EAS contracts are deployed on these networks: - -| Network | Attestation Contract | Schema Registry Contract | -| ---------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -| OP Sepolia | [0x4200000000000000000000000000000000000021](https://sepolia-optimism.etherscan.io/address/0x4200000000000000000000000000000000000021) | [0x4200000000000000000000000000000000000020](https://sepolia-optimism.etherscan.io/address/0x4200000000000000000000000000000000000020) | -| OP Mainnet | [0x4200000000000000000000000000000000000021](https://optimistic.etherscan.io/address/0x4200000000000000000000000000000000000021) | [0x4200000000000000000000000000000000000020](https://optimistic.etherscan.io/address/0x4200000000000000000000000000000000000020) | - -### How to use EAS - -You can interact with the Ethereum Attestation Service in several ways: - -1. **Using the EAS Scan UI:** - * [EAS Scan for OP Mainnet](https://optimism.easscan.org/) - * [EAS Scan for OP Sepolia](https://optimism-sepolia.easscan.org/) - -2. **Using the JavaScript SDK:** - * [EAS SDK Documentation](https://docs.attest.sh/docs/developer-tools/eas-sdk) - -3. **Access Directly Onchain:** - * See the [EAS Smart Contract Implementation](https://github.com/ethereum-attestation-service/eas-contracts/blob/master/contracts/EAS.sol). - -### Indexing Attestations - -Attestations made via EAS can be indexed through the following tools: - -* [GraphQL Endpoint](https://docs.attest.sh/docs/developer-tools/api) -* [Ponder Graph](https://github.com/ethereum-attestation-service/eas-ponder-graph) -* [Open Source Indexer](https://github.com/ethereum-attestation-service/eas-indexing-service) - -For more information on working with attestations, see [Build Decentralized Identity Apps with Attestations](https://community.optimism.io/identity/about-attestations?utm_source=op-docs&utm_medium=docs). - -### BeaconBlockRoot - -The `BeaconBlockRoot` predeploy provides access to the L1 beacon block roots. -This was added during the Ecotone network upgrade and is specified in -[EIP-4788](https://eips.ethereum.org/EIPS/eip-4788). - -* **Address:** `0x000F3df6D732807Ef1319fB7B8bB8522d0Beac02` -* **Introduced:** Ecotone -* **Deprecated:** no -* **Proxied:** no - -### DEPRECATED Contracts - -#### DEPRECATED - LegacyMessagePasser - -The `LegacyMessagePasser` was the low-level mechanism used to send messages -from L2 to L1 before the Bedrock upgrade. - -* **Address:** `0x4200000000000000000000000000000000000000` -* **Introduced:** Legacy -* **Deprecated:** yes -* **Proxied:** yes - -#### DEPRECATED - DeployerWhitelist - -`DeployerWhitelist` is a legacy contract that was originally used to act as a -whitelist of addresses allowed to the Optimism network. The `DeployerWhitelist` -has since been disabled, but the code is kept in state for the sake of full -backwards compatibility. As of the Bedrock upgrade, the `DeployerWhitelist` is -completely unused by the Optimism system and could, in theory, be removed entirely. - -* **Address:** `0x4200000000000000000000000000000000000002` -* **Introduced:** Legacy -* **Deprecated:** yes -* **Proxied:** yes - -#### DEPRECATED - LegacyERC20ETH - -`LegacyERC20ETH` is a legacy contract that held ETH balances before the Bedrock -upgrade. All ETH balances held within this contract were migrated to the state -trie as part of the Bedrock upgrade. Functions within this contract that mutate -state were already disabled as part of the EVM equivalence upgrade. - -* **Address:** `0xDeadDeAddeAddEAddeadDEaDDEAdDeaDDeAD0000` -* **Introduced:** Legacy -* **Deprecated:** yes -* **Proxied:** yes - -#### DEPRECATED - L1BlockNumber - -`L1BlockNumber` is a legacy contract that fills the role of the -`OVM_L1BlockNumber` contract in the old version of the Optimism system. Only -necessary for backwards compatibility. If you want to access the L1 block -number going forward, you should use the `L1Block`contract instead. - -* **Address:** `0x4200000000000000000000000000000000000013` -* **Introduced:** Legacy -* **Deprecated:** yes -* **Proxied:** yes + + + diff --git a/pages/stack/smart-contracts/_meta.json b/pages/stack/smart-contracts/_meta.json new file mode 100644 index 000000000..03f633ca1 --- /dev/null +++ b/pages/stack/smart-contracts/_meta.json @@ -0,0 +1,6 @@ +{ + "smart-contracts": "Smart Contracts", + "superchain-ops-guide": "Upgrade using superchain-op", + "op-deployer-upgrade.mdx": "Upgrade using op-deployer", + "upgrade-op-contracts-1-3-1-8.mdx": "Upgrade OP Contracts v1.3.0 to v1.8.0" +} \ No newline at end of file diff --git a/pages/stack/smart-contracts/op-deployer-upgrade.mdx b/pages/stack/smart-contracts/op-deployer-upgrade.mdx new file mode 100644 index 000000000..707297ad5 --- /dev/null +++ b/pages/stack/smart-contracts/op-deployer-upgrade.mdx @@ -0,0 +1,85 @@ +--- +title: Upgrade L1 contracts using `op-deployer` +description: Learn about how to upgrade smart contracts using op-deployer +lang: en-US +content_type: guide +topic: smart-contract-deployer-upgrade +personas: + - protocol-developer + - chain-operator +categories: + - protocol + - l1-contracts + - contract-upgrades +is_imported_content: 'false' +--- + +import { Steps } from 'nextra/components' + +# Upgrade L1 contracts using `op-deployer` + +[`op-deployer`](/operators/chain-operators/tools/op-deployer) simplifies the process of deploying and upgrading the OP Stack. Using the `upgrade` command, you can upgrade a chain from one version to the next. + +It consists of several subcommands, one for each upgrade version. Think of it like a database migration: each upgrade command upgrades a chain from exactly one previous version to the next. A chain that is several versions behind can be upgraded to the latest version by running multiple upgrade commands in sequence. + +Unlike the bootstrap or apply commands, upgrade does not directly interact with the chain. Instead, it generates calldata. You can then use this calldata with cast, Gnosis SAFE, or whatever tooling you use to manage your L1. + +## Limitations of `upgrade` + +There are a few limitations to `upgrade`: + +Using the standard OP Contracts Manager currently requires you to be using the standard shared SuperchainConfig contract. If you're not using this, you will need to utilize the `bootstrap` command to deploy your own Superchain target, including your own `opcm` instance. + +## Using `upgrade` + + + ### Install `op-deployer` + + [Install `op-deployer`](/operators/chain-operators/tools/op-deployer#installation) from source or pre-built binary. + + ### Create a `config.json` file + + Create a `config.json` file using the following example: + + ```json + { + "prank": "
", + "opcm": "
", + "chainConfigs": [ + { + "systemConfigProxy": "
", + "proxyAdmin": "
", + "absolutePrestate": "<32-byte hash of the chain's absolute prestate>" + } + ] + } + ``` + + The standard OPCM instances (`opcm` in the example above) and absolute prestates (`absolutePrestate`) are found in the superchain registry: + + * `opcm`: under `op_contracts_manager` for [Mainnet](https://github.com/ethereum-optimism/superchain-registry/blob/main/validation/standard/standard-versions-mainnet.toml) and [Sepolia](https://github.com/ethereum-optimism/superchain-registry/blob/main/validation/standard/standard-versions-sepolia.toml). + * `absolutePrestate`: the `hash` under your [chosen upgrade](https://github.com/ethereum-optimism/superchain-registry/blob/main/validation/standard/standard-prestates.toml) + + ### Generate calldata + + Run the following command: + + ```bash + op-deployer upgrade \ + --config + ``` + + `version` must be either major release `2.0` or higher. + + The output should look like: + + ```json + { + "to": "", + "data": "", + "value": "0x0" + } + ``` + + Now you have the calldata that can be executed onchain to perform the L1 contract upgrade. You should simulate this upgrade and make sure the changes are expected. You can reference the validation files of previously executed upgrade tasks in the [superchain-ops repo](https://github.com/ethereum-optimism/superchain-ops/blob/main/tasks/eth/022-holocene-fp-upgrade/NestedSignFromJson.s.sol) to see what the expected changes are. Once you're confident the state changes are expected, you can sign and execute the upgrade. + diff --git a/pages/stack/smart-contracts/smart-contracts.mdx b/pages/stack/smart-contracts/smart-contracts.mdx new file mode 100644 index 000000000..6c827305c --- /dev/null +++ b/pages/stack/smart-contracts/smart-contracts.mdx @@ -0,0 +1,792 @@ +--- +title: Smart Contract overview +description: Learn about the smart contracts that make up the OP Stack. +lang: en-US +content_type: guide +topic: smart-contract-overview +personas: + - protocol-developer + - chain-operator + - app-developer +categories: + - mainnet + - protocol + - l1-contracts + - predeploys + - contract-addresses + - contract-upgrades + - architecture + - fault-proofs +is_imported_content: 'false' +--- + +import { Callout } from 'nextra/components' + +# Smart Contract overview + +This guide provides an overview of the functionality of the smart contract components. You can also find [contract addresses](/superchain/addresses) on OP Mainnet. + +## Layer 1 contracts + +The layer 1 contracts of the OP Stack are deployed on Ethereum. Their primary +purpose is to facilitate the cross domain message passing and maintain the +valid state root of the layer 2. + +### Upgrading Layer 1 contracts + +There are two main ways to upgrade L1 contracts: + +* [`op-deployer`](/stack/smart-contracts/op-deployer-upgrade): a simple tool to upgrade your contracts. +* [`superchain-ops`](/stack/smart-contracts/superchain-ops-guide): a workflow for chains that require security council signing or a more secure upgrade path. + +### Official releases + +The full smart contract release process is documented in the [monorepo](https://github.com/ethereum-optimism/optimism/blob/develop/packages/contracts-bedrock/book/src/policies/versioning.md). +All production releases are always tagged, versioned as `/v`. +Contract releases have a component name of `op-contracts` and therefore are tagged as `op-contract/vX.Y.Z`. + + + For contract releases, refer to the GitHub release notes for a given release, + which will list the specific contracts being released—**not all contracts are + considered production ready within a release**, and many are under active + development. These release pages are linked below. + + Releases or tags of the form `v` without a component name, such as `v1.1.4`, indicate releases of all Go code + only, and **DO NOT** include smart contracts. DO NOT use these releases for deploying + smart contracts—only deploy from `op-contracts/vX.Y.Z` + + +#### op-contracts/v1.8.0 - Holocene contract changes + +This release is suitable for the L1 contracts as part of the Holocene network upgrade. The Holocene network upgrade contains three changes: + +* Holocene block derivation: a set of changes that render the derivation pipeline stricter and simpler, but also improve worst-case scenarios for Fault Proofs and Interoperability. + +* EIP-1559 configurability: The elasticity and denominator EIP-1559 parameters become configurable via the SystemConfig L1 contract, allowing gas target and gas limit to be independently configured. + +* MIPS contract upgrade: Updates to support additional calls made by the new op-program version. + +* [Official - Holocene Contract Release](https://github.com/ethereum-optimism/optimism/releases/tag/op-contracts%2Fv1.8.0) + +* [Governance Post](https://gov.optimism.io/t/upgrade-proposal-11-holocene-network-upgrade/9313) + +
+ **Changelog** + **Added:** + + * MIPS: [1.2.1](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.8.0/packages/contracts-bedrock/src/cannon/MIPS.sol) + * SystemConfig: [2.3.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.8.0/packages/contracts-bedrock/src/L1/SystemConfig.sol) + * FaultDisputeGame: [1.3.1](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.8.0/packages/contracts-bedrock/src/dispute/FaultDisputeGame.sol) + * PermissionedDisputeGame: [1.3.1](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.8.0/packages/contracts-bedrock/src/dispute/PermissionedDisputeGame.sol) + + **No change:** + + * AddressManager: [Latest (this has no version)](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.2.0/packages/contracts-bedrock/src/legacy/AddressManager.sol) + * AnchorStateRegistry: [2.0.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.6.0/packages/contracts-bedrock/src/dispute/AnchorStateRegistry.sol#L31) + * DelayedWETH: [1.1.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.6.0/packages/contracts-bedrock/src/dispute/weth/DelayedWETH.sol#L25) + * L1CrossDomainMessenger: [2.3.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.3.0/packages/contracts-bedrock/src/L1/L1CrossDomainMessenger.sol#L24) + * L1ERC721Bridge: [2.1.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.3.0/packages/contracts-bedrock/src/L1/L1ERC721Bridge.sol#L27) + * L1StandardBridge: [2.1.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.3.0/packages/contracts-bedrock/src/L1/L1StandardBridge.sol#L73) + * OptimismMintableERC20Factory: [1.9.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.3.0/packages/contracts-bedrock/src/universal/OptimismMintableERC20Factory.sol#L46) + * OptimismPortal: [3.10.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.4.0/packages/contracts-bedrock/src/L1/OptimismPortal2.sol#L144) + * DisputeGameFactory: [1.0.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.4.0/packages/contracts-bedrock/src/dispute/DisputeGameFactory.sol#L25) + * PreimageOracle: [1.1.2](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.6.0/packages/contracts-bedrock/src/cannon/PreimageOracle.sol) + * ProtocolVersions: [1.0.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.2.0/packages/contracts-bedrock/src/L1/ProtocolVersions.sol#L39) + * SuperchainConfig: [1.1.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.2.0/packages/contracts-bedrock/src/L1/SuperchainConfig.sol#L38) +
+ +#### op-contracts/v1.6.0 - Fault proof fixes + +The release fixes security vulnerabilities found in Fault Proof contracts. They were made in response to security vulnerabilities identified during a series of third-party security audits by Spearbit, Cantina, and Code4rena. None of the vulnerabilities have been exploited, and user assets are not and were never at risk. + +The upgrade was coupled with the Granite network upgrade to improve the stability and performance of the Fault Proof System. In addition, the capabilities of the Guardian and DeputyGuardian have been extended to set the anchor state for the Fault Proof System in order to prevent referencing invalid anchor states. + +* [Official - Fault Proof Fixes Release](https://github.com/ethereum-optimism/optimism/releases/tag/op-contracts%2Fv1.6.0) +* [Governance Post](https://gov.optimism.io/t/upgrade-proposal-10-granite-network-upgrade/8733) + +
+ **Changelog** + **Added:** + + * MIPS: [1.1.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.6.0/packages/contracts-bedrock/src/cannon/MIPS.sol) + * PreimageOracle: [1.1.2](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.6.0/packages/contracts-bedrock/src/cannon/PreimageOracle.sol) + * FaultDisputeGame: [1.3.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.6.0/packages/contracts-bedrock/src/dispute/FaultDisputeGame.sol#L73) + * PermissionedDisputeGame: [1.3.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.6.0/packages/contracts-bedrock/src/dispute/PermissionedDisputeGame.sol) + * DelayedWETH: [1.1.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.6.0/packages/contracts-bedrock/src/dispute/weth/DelayedWETH.sol#L25) + * DeputyGuardianModule: [2.0.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.6.0/packages/contracts-bedrock/src/Safe/SafeSigners.sol) + * AnchorStateRegistry: [2.0.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.6.0/packages/contracts-bedrock/src/dispute/AnchorStateRegistry.sol#L31) + + **No change:** + + * AddressManager: [Latest (this has no version)](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.2.0/packages/contracts-bedrock/src/legacy/AddressManager.sol) + * L1CrossDomainMessenger: [2.3.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.3.0/packages/contracts-bedrock/src/L1/L1CrossDomainMessenger.sol#L24) + * L1ERC721Bridge: [2.1.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.3.0/packages/contracts-bedrock/src/L1/L1ERC721Bridge.sol#L27) + * L1StandardBridge: [2.1.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.3.0/packages/contracts-bedrock/src/L1/L1StandardBridge.sol#L73) + * OptimismMintableERC20Factory: [1.9.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.3.0/packages/contracts-bedrock/src/universal/OptimismMintableERC20Factory.sol#L46) + * OptimismPortal: [3.10.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.4.0/packages/contracts-bedrock/src/L1/OptimismPortal2.sol#L144) + * SystemConfig: [2.2.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.4.0/packages/contracts-bedrock/src/L1/SystemConfig.sol#L111) + * DisputeGameFactory: [1.0.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.4.0/packages/contracts-bedrock/src/dispute/DisputeGameFactory.sol#L25) + * SuperchainConfig: [1.1.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.2.0/packages/contracts-bedrock/src/L1/SuperchainConfig.sol#L38) + * ProtocolVersions: [1.0.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.2.0/packages/contracts-bedrock/src/L1/ProtocolVersions.sol#L39) +
+ +#### op-contracts/v1.5.0 - Safe extensions + +The Safe Extensions protocol upgrade is intended to increase the security and +decentralization of the Superchain by: + +1. Increasing the Security Council Safe's signing threshold, from 4 to 10, out + of 13 owners. This meets the 75% threshold requirement for a Stage 1 rollup + outlined in [L2Beat's Stages framework](https://medium.com/l2beat/stages-update-security-council-requirements-4c79cea8ef52) +2. Reassigning the role of Guardian from the Foundation to a new Guardian Safe + with the Security Council Safe as its sole owner. This moves the Superchain + closer to satisfying the 1 week exit window requirement for Stage 1. + * Additionally the Foundation is appointed to the new DeputyGuardian role + which is able to act as Guardian through the Guardian Safe. This + appointment can be revoked by the Security Council Safe at any time. +3. Reassigning the owner of the L2ProxyAdmin contract from the Foundation to + the Security Council. This ensures the Security Council Safe has a blocking + vote for L2 predeploy upgrades and is a requirement for Stage 1. + +* [Official - Safe Extensions Release](https://github.com/ethereum-optimism/optimism/releases/tag/op-contracts%2Fv1.5.0) +* [Governance Post](https://gov.optimism.io/t/final-protocol-upgrade-8-guardian-security-council-threshold-and-l2-proxyadmin-ownership-changes-for-stage-1-decentralization/8157) + +
+ **Changelog**\ + **Added:** + + * LivenessGuard: [1.0.0](https://github.com/ethereum-optimism/optimism/blob/9047beb54c66a5c572784efec8984f259302ec92/packages/contracts-bedrock/src/Safe/LivenessGuard.sol#L29) + * LivenessModule: [1.2.0](https://github.com/ethereum-optimism/optimism/blob/9047beb54c66a5c572784efec8984f259302ec92/packages/contracts-bedrock/src/Safe/LivenessModule.sol#L57) + * DeputyGuardianModule: [1.1.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.5.0/packages/contracts-bedrock/src/Safe/SafeSigners.sol) + + **No change:** + + * AddressManager: [Latest (this has no version)](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.2.0/packages/contracts-bedrock/src/legacy/AddressManager.sol) + * L1CrossDomainMessenger: [2.3.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.3.0/packages/contracts-bedrock/src/L1/L1CrossDomainMessenger.sol#L24) + * L1ERC721Bridge: [2.1.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.3.0/packages/contracts-bedrock/src/L1/L1ERC721Bridge.sol#L27) + * L1StandardBridge: [2.1.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.3.0/packages/contracts-bedrock/src/L1/L1StandardBridge.sol#L73) + * OptimismMintableERC20Factory: [1.9.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.3.0/packages/contracts-bedrock/src/universal/OptimismMintableERC20Factory.sol#L46) + * OptimismPortal: [3.10.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.4.0/packages/contracts-bedrock/src/L1/OptimismPortal2.sol#L144) + * SystemConfig: [2.2.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.4.0/packages/contracts-bedrock/src/L1/SystemConfig.sol#L111) + * FaultDisputeGame: [1.2.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.4.0/packages/contracts-bedrock/src/dispute/FaultDisputeGame.sol#L73) + * PermissionedDisputeGame: [1.2.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.4.0/packages/contracts-bedrock/src/dispute/PermissionedDisputeGame.sol) + * DisputeGameFactory: [1.0.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.4.0/packages/contracts-bedrock/src/dispute/DisputeGameFactory.sol#L25) + * AnchorStateRegistry: [1.0.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.4.0/packages/contracts-bedrock/src/dispute/AnchorStateRegistry.sol#L28) + * DelayedWETH: [1.0.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.4.0/packages/contracts-bedrock/src/dispute/weth/DelayedWETH.sol#L25) + * MIPS: [1.0.1](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.4.0/packages/contracts-bedrock/src/cannon/MIPS.sol#L47) + * PreimageOracle: [1.0.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.4.0/packages/contracts-bedrock/src/cannon/PreimageOracle.sol#L33) + * SuperchainConfig: [1.1.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.2.0/packages/contracts-bedrock/src/L1/SuperchainConfig.sol#L38) + * ProtocolVersions: [1.0.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.2.0/packages/contracts-bedrock/src/L1/ProtocolVersions.sol#L39) +
+ +#### op-contracts/v1.4.0 - Fault proofs + +This protocol upgrade reduces the trust assumptions for users of the OP Stack +by enabling permissionless output proposals and a permissionless fault proof +system. As part of a responsible and safe rollout of Fault Proofs, it preserves +the ability for the guardian to override if necessary to maintain security. + +As a result, withdrawals no longer depend on the privileged proposer role +posting an output root, allowing the entire withdrawal process to be completed +without any privileged actions. The trust assumption is reduced to requiring +only that the Guardian role does not act to intervene. + +Combined with the Guardian, Security Council Threshold and L2 ProxyAdmin +Ownership changes 23 proposals, this satisfies the criteria to have OP Chains +reach Stage 1 status. + +* [Official - Fault Proof Release](https://github.com/ethereum-optimism/optimism/releases/tag/op-contracts/v1.4.0) +* [Governance Post](https://gov.optimism.io/t/final-protocol-upgrade-7-fault-proofs/8161) + +
+ **Changelog** + **Added:** + + * FaultDisputeGame: [1.2.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.4.0/packages/contracts-bedrock/src/dispute/FaultDisputeGame.sol#L73) + * PermissionedDisputeGame: [1.2.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.4.0/packages/contracts-bedrock/src/dispute/PermissionedDisputeGame.sol) + * DisputeGameFactory: [1.0.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.4.0/packages/contracts-bedrock/src/dispute/DisputeGameFactory.sol#L25) + * AnchorStateRegistry: [1.0.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.4.0/packages/contracts-bedrock/src/dispute/AnchorStateRegistry.sol#L28) + * DelayedWETH: [1.0.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.4.0/packages/contracts-bedrock/src/dispute/weth/DelayedWETH.sol#L25) + * MIPS: [1.0.1](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.4.0/packages/contracts-bedrock/src/cannon/MIPS.sol#L47) + * PreimageOracle: [1.0.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.4.0/packages/contracts-bedrock/src/cannon/PreimageOracle.sol#L33) + + **Upgraded:** + + * OptimismPortal: [3.10.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.4.0/packages/contracts-bedrock/src/L1/OptimismPortal2.sol#L144) + * SystemConfig: [2.2.0](https://github.com/ethereum-optimism/optimism/blob/547ea72d9849e13ce169fd31df0f9197651b3f86/packages/contracts-bedrock/src/L1/SystemConfig.sol#L111) + + **Deprecated:** + + * L2OutputOracle: 1.8.0 + + **No change:** + + * AddressManager: [Latest (this has no version)](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.2.0/packages/contracts-bedrock/src/legacy/AddressManager.sol) + * L1CrossDomainMessenger: [2.3.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.3.0/packages/contracts-bedrock/src/L1/L1CrossDomainMessenger.sol#L24) + * L1ERC721Bridge: [2.1.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.3.0/packages/contracts-bedrock/src/L1/L1ERC721Bridge.sol#L27) + * L1StandardBridge: [2.1.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.3.0/packages/contracts-bedrock/src/L1/L1StandardBridge.sol#L73) + * OptimismMintableERC20Factory: [1.9.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.3.0/packages/contracts-bedrock/src/universal/OptimismMintableERC20Factory.sol#L46) + * SuperchainConfig: [1.1.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.2.0/packages/contracts-bedrock/src/L1/SuperchainConfig.sol#L38) + * ProtocolVersions: [1.0.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.2.0/packages/contracts-bedrock/src/L1/ProtocolVersions.sol#L39) +
+ +#### op-contracts/v1.3.0 - Multi-Chain Prep (MCP) + + + This is the current recommended contract release for new production chains. + + +This protocol upgrade strengthens the security and upgradeability of the +Superchain by enabling L1 contracts to be upgraded atomically across multiple +chains in a single transaction. This upgrade also extends the `SystemConfig` +to contain the addresses of the contracts in the network, allowing users to +discover the system's contract addresses programmatically. + +* [Official - MCP Release](https://github.com/ethereum-optimism/optimism/releases/tag/op-contracts%2Fv1.3.0) +* [Governance Post](https://gov.optimism.io/t/upgrade-proposal-6-multi-chain-prep-mcp-l1/7677) + +
+ **Changelog** + + **Upgraded:** + + * OptimismPortal: [2.5.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.3.0/packages/contracts-bedrock/src/L1/OptimismPortal.sol#L94) + * L1CrossDomainMessenger: [2.3.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.3.0/packages/contracts-bedrock/src/L1/L1CrossDomainMessenger.sol#L24) + * L1StandardBridge: [2.1.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.3.0/packages/contracts-bedrock/src/L1/L1StandardBridge.sol#L73) + * L1ERC721Bridge: [2.1.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.3.0/packages/contracts-bedrock/src/L1/L1ERC721Bridge.sol#L27) + * OptimismMintableERC20Factory: [1.9.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.3.0/packages/contracts-bedrock/src/universal/OptimismMintableERC20Factory.sol#L46) + * L2OutputOracle: [1.8.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.3.0/packages/contracts-bedrock/src/L1/L2OutputOracle.sol#L59) + * SystemConfig: [1.12.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.3.0/packages/contracts-bedrock/src/L1/SystemConfig.sol#L104) + + **No change:** + + * AddressManager: [Latest (this has no version)](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.2.0/packages/contracts-bedrock/src/legacy/AddressManager.sol) + * SuperchainConfig: [1.1.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.2.0/packages/contracts-bedrock/src/L1/SuperchainConfig.sol#L38) + * ProtocolVersions: [1.0.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.2.0/packages/contracts-bedrock/src/L1/ProtocolVersions.sol#L39) +
+ +#### op-contracts/v1.2.0 - SuperchainConfig with Extended Pause Functionality + +The SuperchainConfig contract is used to manage global configuration values for +multiple OP Chains within a single Superchain network. + +* [Official - SuperchainConfig and Extended Pause Release](https://github.com/ethereum-optimism/optimism/releases/tag/op-contracts%2Fv1.2.0) +* [Governance post](https://gov.optimism.io/t/upgrade-proposal-4/7534) + +
+ **Changelog** + + **Added:** + + * SuperchainConfig: [1.1.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.2.0/packages/contracts-bedrock/src/L1/SuperchainConfig.sol#L38) + + **Upgraded:** + + * AddressManager: [Latest (this has no version)](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.2.0/packages/contracts-bedrock/src/legacy/AddressManager.sol) + * L1CrossDomainMessenger: [2.2.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.2.0/packages/contracts-bedrock/src/L1/L1CrossDomainMessenger.sol#L25) + * L1ERC721Bridge: [2.0.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.2.0/packages/contracts-bedrock/src/L1/L1ERC721Bridge.sol#L26) + * L1StandardBridge: [2.0.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.2.0/packages/contracts-bedrock/src/L1/L1StandardBridge.sol#L73) + * L2OutputOracle: [1.7.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.2.0/packages/contracts-bedrock/src/L1/L2OutputOracle.sol#L63) + * OptimismMintableERC20Factory: [1.8.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.2.0/packages/contracts-bedrock/src/universal/OptimismMintableERC20Factory.sol#L35) + * OptimismPortal: [2.4.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.2.0/packages/contracts-bedrock/src/L1/OptimismPortal.sol#L96) + * SystemConfig: [1.11.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.2.0/packages/contracts-bedrock/src/L1/SystemConfig.sol#L67) + * ProtocolVersions: [1.0.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.2.0/packages/contracts-bedrock/src/L1/ProtocolVersions.sol#L39) + + **No change:** + + * AddressManager: Latest (this has no version) +
+ +#### op-contracts/v1.1.0 - ProtocolVersions + +The Protocol Version documents the progression of the total set of canonical +OP Stack specifications. Components of the OP Stack implement the subset of +their respective protocol component domain, up to a given Protocol Version +of the OP Stack. + +The Protocol Version is NOT a hardfork identifier, but rather indicates +software-support for a well-defined set of features introduced in past and +future hardforks, not the activation of said hardforks. + + + The Protocol Version only applies to the Protocol specifications with the + [Superchain Targets](https://specs.optimism.io/protocol/superchain-upgrades.html?utm_source=op-docs&utm_medium=docs#superchain-target) + specified within. This versioning is independent of the Semver versioning + used in OP Stack smart contracts, and the Semver-versioned reference software + of the OP-Stack. This is an optional feature. + + +* [Official ProtocolVersions Release](https://github.com/ethereum-optimism/optimism/releases/tag/op-contracts%2Fv1.1.0) + +
+ **Changelog** + + **Added:** + + * ProtocolVersions: 1.0.0 + + **No change:** + + * AddressManager: [Latest (this has no version)](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.2.0/packages/contracts-bedrock/src/legacy/AddressManager.sol) + * L1CrossDomainMessenger: [1.4.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.0.0/packages/contracts-bedrock/contracts/L1/L1CrossDomainMessenger.sol#L23) + * L1ERC721Bridge: [1.1.1](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.0.0/packages/contracts-bedrock/contracts/L1/L1ERC721Bridge.sol#L23) + * L1StandardBridge: [1.1.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.0.0/packages/contracts-bedrock/contracts/L1/L1StandardBridge.sol#L94) + * L2OutputOracle: [1.3.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.0.0/packages/contracts-bedrock/contracts/L1/L2OutputOracle.sol#L81) + * OptimismMintableERC20Factory: [1.1.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.0.0/packages/contracts-bedrock/contracts/universal/OptimismMintableERC20Factory.sol#L47) + * OptimismPortal: [1.6.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.0.0/packages/contracts-bedrock/contracts/L1/OptimismPortal.sol#L143) + * SystemConfig: [1.3.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.0.0/packages/contracts-bedrock/contracts/L1/SystemConfig.sol#L83) +
+ +#### op-contracts/v1.0.0 - Bedrock + +The Bedrock protocol upgrade was designed to minimize the amount +of code in the OP Stack, pushes it as close as possible to Ethereum-Equivalence, +and most importantly making the stack modular. + +* [Official - Bedrock Release](https://github.com/ethereum-optimism/optimism/releases/tag/op-contracts%2Fv1.0.0) ... +* [Governance post](https://gov.optimism.io/t/final-upgrade-1-bedrock-protocol-upgrade-v2/5548) + +
+ **Changelog** + + **Added:** + + * AddressManager: [Latest (this has no version)](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.2.0/packages/contracts-bedrock/src/legacy/AddressManager.sol) + * L1CrossDomainMessenger: [1.4.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.0.0/packages/contracts-bedrock/contracts/L1/L1CrossDomainMessenger.sol#L23) + * L1ERC721Bridge: [1.1.1](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.0.0/packages/contracts-bedrock/contracts/L1/L1ERC721Bridge.sol#L23) + * L1StandardBridge: [1.1.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.0.0/packages/contracts-bedrock/contracts/L1/L1StandardBridge.sol#L94) + * L2OutputOracle: [1.3.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.0.0/packages/contracts-bedrock/contracts/L1/L2OutputOracle.sol#L81) + * OptimismMintableERC20Factory: [1.1.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.0.0/packages/contracts-bedrock/contracts/universal/OptimismMintableERC20Factory.sol#L47) + * OptimismPortal: [1.6.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.0.0/packages/contracts-bedrock/contracts/L1/OptimismPortal.sol#L143) + * SystemConfig: [1.3.0](https://github.com/ethereum-optimism/optimism/blob/op-contracts/v1.0.0/packages/contracts-bedrock/contracts/L1/SystemConfig.sol#L83) +
+ +### L1 Contract Details + +#### AddressManager + +`AddressManager` is a legacy contract that was used in the old version of the +Optimism system to manage a registry of string names to addresses. We now use a +more standard proxy system for most contracts, but this contract is still used for +the L1CrossDomainMessenger, via ResolvedDelegateProxy + +#### SuperchainConfig + +The `SuperchainConfig` contract is used to manage configuration of global +superchain values. It has the ability to pause and unpause all withdrawals +in the Superchain. + +#### L1CrossDomainMessenger + +The `L1CrossDomainMessenger` is a message passing interface between L1 and L2 +responsible for sending and receiving data on the L1 side. Users are encouraged +to use this interface instead of interacting with lower-level contracts directly. + +#### L1ERC721Bridge + +The `L1ERC721bridge` is a contract which works together with the `L2ERC721Bridge` +to make it possible to transfer ERC721 tokens from Ethereum to OP Mainnet. This +contract acts as an escrow for ERC721 tokens deposited into L2. + +#### L1StandardBridge + + + This contract is not intended to support all variations of ERC20 tokens. Examples + of some token types that may not be properly supported by this contract include, but are + not limited to: tokens with transfer fees, rebasing tokens, and tokens with blocklists. + + +The `L1StandardBridge` is responsible for transferring ETH and ERC20 tokens between L1 and +L2. In the case that an ERC20 token is native to L1, it will be escrowed within this +contract. If the ERC20 token is native to L2, it will be burnt. + +#### OptimismPortal + +The `OptimismPortal` is a low-level contract responsible for passing messages between L1 +and L2. Messages sent directly to the `OptimismPortal` have no form of replayability. +Users are encouraged to use the `L1CrossDomainMessenger` for a higher-level interface. + +#### ProtocolVersions + +The `ProtocolVersions` contract is used to manage Superchain protocol version +information. It exposes a recommended and required version for node operators. +The recommended/required versions are changed with each hard fork. Nodes can +optionally halt if using the wrong version. + +#### SystemConfig + +The `SystemConfig` contract helps manage configuration of an OP Stack +network. Much of the network's configuration is stored on L1 and picked up by +L2 as part of the derivation of the L2 chain. The contract also contains +references to all other contract addresses for the chain. + +#### DisputeGameFactory + +The `DisputeGameFactory` deploys instances of `FaultDisputeGame` and `PermissionedDisputeGame` +to resolve disputes about the OP Stack chain state at specific block numbers. +It serves as the entry point for creating and managing dispute games. +The factory uses the `AnchorStateRegistry` for initialization, +and integrates the `DelayedWETH` contract to manage participant bonds. + +#### FaultDisputeGame + +The `FaultDisputeGame` resolves disputes about the OP Stack chain state by +allowing participants to propose or challenge states. +It is deployed by the `DisputeGameFactory` and includes logic to finalize disputes. +The contract uses the `AnchorStateRegistry` to start from trusted states, +`MIPS` to execute fault proofs, the `PreimageOracle` to validate hash-based claims, +and the `DelayedWETH` contract to handle bonds. + +#### PermissionedDisputeGame + +The `PermissionedDisputeGame` is also deployed by the `DisputeGameFactory`, +and inherits logic and dependencies from `FaultDisputeGame` while adding role-based restrictions. +It restricts participation to specific roles, such as designated proposers or challengers. +It is used when stricter access controls are required, as enforced by the Guardian. + +#### AnchorStateRegistry + +The `AnchorStateRegistry` stores the latest "anchor" state for each dispute game type. +An anchor state is the most recent state proposed on L1 that was not challenged within the challenge period. +These states allow new dispute games to start from a trusted, recent state, reducing offchain computation requirements. + +#### DelayedWETH + +The `DelayedWETH` contract manages bonds posted by participants during disputes. +It delays payouts to allow time for verification, ensuring that funds are distributed correctly. +This mechanism ensures participants are financially committed and disputes are finalized securely. + +#### MIPS + +The `MIPS` contract provides an on-chain implementation of a big-endian MIPS32 R1 virtual machine, +designed to execute fault proofs for disputes by processing a standardized instruction set. +This enables instances of `FaultDisputeGame` and `PermissionedDisputeGame` to resolve disputes +over state transitions accurately and consistently. +The process starts from the trusted anchor state provided by the `AnchorStateRegistry`, +ensuring that the dispute is based on a reliable foundation. +The `PreimageOracle` is then used to retrieve pre-images of hash-based claims, +validating the data used in the computation and ensuring its integrity. + +#### PreimageOracle + +The `PreimageOracle` maps hashes to their corresponding pre-images for secure and permissioned data retrieval. +It validates hash-based claims used in disputes, such as state transitions or computational steps. +This ensures the integrity of fault proofs in `FaultDisputeGame` and `PermissionedDisputeGame` instances. + +#### DEPRECATED - L2OutputOracle + +The `L2OutputOracle` contains an array of L2 state outputs, where each output is a +commitment to the state of the L2 chain. Other contracts like the `OptimismPortal` use +these outputs to verify information about the state of L2. + +## Layer 2 Contracts (Predeploys) + +Predeployed smart contracts exist at predetermined addresses in the genesis +state. They are similar to precompiles but instead run directly in the EVM +instead of running native code outside the EVM. + +Predeploys are used instead of precompiles to make it easier for multiclient +implementations as well as allowing for more integration with hardhat/foundry +network forking. + +### WETH9 + +`WETH9` is the standard implementation of Wrapped Ether. It is a commonly used +contract and is placed as a predeploy so that it is at a deterministic address. + +* **Address:** `0x4200000000000000000000000000000000000006` +* **Introduced:** Legacy +* **Deprecated:** no +* **Proxied:** no + +### L2CrossDomainMessenger + +The `L2CrossDomainMessenger` is a high-level interface for message passing +between L1 and L2 on the L2 side. Users are generally encouraged to use this +contract instead of lower level message passing contracts. + +* **Address:** `0x4200000000000000000000000000000000000007` +* **Introduced:** Legacy +* **Deprecated:** no +* **Proxied:** yes + +### L2StandardBridge + + + This contract is not intended to support all variations of ERC20 tokens. Examples + of some token types that may not be properly supported by this contract include, but are + not limited to: tokens with transfer fees, rebasing tokens, and tokens with blocklists. + + +The `L2StandardBridge` is responsible for transferring ETH and ERC20 tokens between L1 and +L2. In the case that an ERC20 token is native to L2, it will be escrowed within this +contract. If the ERC20 token is native to L1, it will be burnt. + +* **Address:** `0x4200000000000000000000000000000000000010` +* **Introduced:** Legacy +* **Deprecated:** no +* **Proxied:** yes + +### SequencerFeeVault + +The `SequencerFeeVault` is the contract that holds any fees paid to the +Sequencer during transaction processing and block production. + +* **Address:** `0x4200000000000000000000000000000000000011` +* **Introduced:** Legacy +* **Deprecated:** no +* **Proxied:** yes + +### OptimismMintableERC20Factory + +The `OptimismMintableERC20Factory` is responsible for creating ERC20 contracts +on L2 that can be used for depositing native L1 tokens into. These ERC20 +contracts can be created permissionlessly and implement the interface required +by the StandardBridge to just work with deposits and withdrawals. + +Each ERC20 contract that is created by the `OptimismMintableERC20Factory` +allows for the L2StandardBridge to mint and burn tokens, depending on if the +user is depositing from L1 to L2 or withdrawing from L2 to L1. + +* **Address:** `0x4200000000000000000000000000000000000012` +* **Introduced:** Legacy +* **Deprecated:** no +* **Proxied:** yes + +### GasPriceOracle + +The `GasPriceOracle` is no longer a permissioned contract like in the legacy +system. It only exists to preserve the API for offchain gas estimation. The +function `getL1Fee(bytes)` accepts an unsigned RLP transaction and will return +the L1 portion of the fee. This fee pays for using L1 as a data availability +layer and should be added to the L2 portion of the fee, which pays for +execution, to compute the total transaction fee. + +Following the Ecotone upgrade, the values used for L1 fee computation are: + +* `baseFeeScalar` +* `blobBaseFeeScalar` +* `decimals` + +These new scalar values are managed by the `SystemConfig` contract on the L1 by +introducing a backwards compatible versioned encoding scheme of its scalars +storage slot. The decimals remain hardcoded to 6, and the overhead value is +ignored. + +* **Address:** `0x420000000000000000000000000000000000000F` +* **Introduced:** Legacy +* **Deprecated:** no +* **Proxied:** yes + +### GovernanceToken + +The OP token used in governance and supporting voting and delegation. +Implements EIP 2612 allowing signed approvals. Contract is "owned" by a +`MintManager` instance with permission to the `mint` function only, for the +purposes of enforcing the token inflation schedule. + +* **Address:** `0x4200000000000000000000000000000000000042` +* **Introduced:** Legacy +* **Deprecated:** no +* **Proxied:** no + +### L1Block + +The `L1Block` predeploy gives users access to information about the last known +L1 block. Values within this contract are updated once per epoch (every L1 +block) and can only be set by the "depositor" account, a special system +address. Depositor account transactions are created by the protocol whenever we +move to a new epoch. + +* **Address:** `0x4200000000000000000000000000000000000015` +* **Introduced:** Bedrock +* **Deprecated:** no +* **Proxied:** yes + +### L2ToL1MessagePasser + +The `L2ToL1MessagePasser` is a dedicated contract where messages that are being +sent from L2 to L1 can be stored. The storage root of this contract is pulled +up to the top level of the L2 output to reduce the cost of proving the +existence of sent messages. + +* **Address:** `0x4200000000000000000000000000000000000016` +* **Introduced:** Bedrock +* **Deprecated:** no +* **Proxied:** yes + +### L2ERC721Bridge + + + Do not bridge an ERC721 that was originally deployed on Optimism. This + bridge ONLY supports ERC721s originally deployed on Ethereum. Users will need to + wait for the one-week challenge period to elapse before their Optimism-native NFT + can be refunded on L2. + + +The `L2ERC721Bridge` is a contract which works together with the `L1ERC721Bridge` to +make it possible to transfer ERC721 tokens from Ethereum to Optimism. This contract +acts as a minter for new tokens when it hears about deposits into the `L1ERC721Bridge`. +This contract also acts as a burner for tokens being withdrawn. + +* **Address:** `0x4200000000000000000000000000000000000014` +* **Introduced:** Legacy +* **Deprecated:** no +* **Proxied:** yes + +### OptimismMintableERC721Factory + +Factory contract for creating `OptimismMintableERC721` contracts. + +* **Address:** `0x4200000000000000000000000000000000000017` +* **Introduced:** Bedrock +* **Deprecated:** no +* **Proxied:** yes + +### ProxyAdmin + +The `ProxyAdmin` is the owner of all of the proxy contracts set at the +predeploys. It is itself behind a proxy. The owner of the `ProxyAdmin` will +have the ability to upgrade any of the other predeploy contracts. + +* **Address:** `0x4200000000000000000000000000000000000018` +* **Introduced:** Bedrock +* **Deprecated:** no +* **Proxied:** yes + +### BaseFeeVault + +The `BaseFeeVault` predeploy receives the base fees on L2. The base fee is not +burnt on L2 like it is on L1. Once the contract has received a certain amount +of fees, the ETH can be withdrawn to an immutable address on L1. + +* **Address:** `0x4200000000000000000000000000000000000019` +* **Introduced:** Bedrock +* **Deprecated:** no +* **Proxied:** yes + +### L1FeeVault + +The `L1FeeVault` predeploy receives the L1 portion of the transaction fees. +Once the contract has received a certain amount of fees, the ETH can be +withdrawn to an immutable address on L1. + +* **Address:** `0x420000000000000000000000000000000000001a` +* **Introduced:** Bedrock +* **Deprecated:** no +* **Proxied:** yes + +### SchemaRegistry + +The `SchemaRegistry` predeploy implements the global attestation schemas for the Ethereum Attestation Service protocol. + +* **Address:** `0x4200000000000000000000000000000000000020` +* **Introduced:** Bedrock +* **Deprecated:** no +* **Proxied:** yes + +The SchemaRegistry works alongside the Ethereum Attestation Service (EAS) to enable attestations. See [Build Decentralized Identity Apps with Attestations](https://community.optimism.io/identity/about-attestations?utm_source=op-docs&utm_medium=docs) for more details on schemas and usage. + +### EAS (Ethereum Attestation Service) + +The [Ethereum Attestation Service (EAS)](https://attest.sh/) is an open-source public good included as a predeploy in the OP Stack. It allows developers to issue and manage attestations on-chain, supporting use cases such as decentralized identity and other data integrity scenarios. + +The `EAS` predeploy implements the Ethereum Attestation Service protocol. + +* **Address:** `0x4200000000000000000000000000000000000021` +* **Introduced:** Bedrock +* **Deprecated:** no +* **Proxied:** yes + +### Contract addresses + +EAS contracts are deployed on these networks: + +| Network | Attestation Contract | Schema Registry Contract | +| ---------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | +| OP Sepolia | [0x4200000000000000000000000000000000000021](https://sepolia-optimism.etherscan.io/address/0x4200000000000000000000000000000000000021) | [0x4200000000000000000000000000000000000020](https://sepolia-optimism.etherscan.io/address/0x4200000000000000000000000000000000000020) | +| OP Mainnet | [0x4200000000000000000000000000000000000021](https://optimistic.etherscan.io/address/0x4200000000000000000000000000000000000021) | [0x4200000000000000000000000000000000000020](https://optimistic.etherscan.io/address/0x4200000000000000000000000000000000000020) | + +### How to use EAS + +You can interact with the Ethereum Attestation Service in several ways: + +1. **Using the EAS Scan UI:** + * [EAS Scan for OP Mainnet](https://optimism.easscan.org/) + * [EAS Scan for OP Sepolia](https://optimism-sepolia.easscan.org/) + +2. **Using the JavaScript SDK:** + * [EAS SDK Documentation](https://docs.attest.sh/docs/developer-tools/eas-sdk) + +3. **Access Directly Onchain:** + * See the [EAS Smart Contract Implementation](https://github.com/ethereum-attestation-service/eas-contracts/blob/master/contracts/EAS.sol). + +### Indexing Attestations + +Attestations made via EAS can be indexed through the following tools: + +* [GraphQL Endpoint](https://docs.attest.sh/docs/developer-tools/api) +* [Ponder Graph](https://github.com/ethereum-attestation-service/eas-ponder-graph) +* [Open Source Indexer](https://github.com/ethereum-attestation-service/eas-indexing-service) + +For more information on working with attestations, see [Build Decentralized Identity Apps with Attestations](https://community.optimism.io/identity/about-attestations?utm_source=op-docs&utm_medium=docs). + +### BeaconBlockRoot + +The `BeaconBlockRoot` predeploy provides access to the L1 beacon block roots. +This was added during the Ecotone network upgrade and is specified in +[EIP-4788](https://eips.ethereum.org/EIPS/eip-4788). + +* **Address:** `0x000F3df6D732807Ef1319fB7B8bB8522d0Beac02` +* **Introduced:** Ecotone +* **Deprecated:** no +* **Proxied:** no + +### DEPRECATED Contracts + +#### DEPRECATED - LegacyMessagePasser + +The `LegacyMessagePasser` was the low-level mechanism used to send messages +from L2 to L1 before the Bedrock upgrade. + +* **Address:** `0x4200000000000000000000000000000000000000` +* **Introduced:** Legacy +* **Deprecated:** yes +* **Proxied:** yes + +#### DEPRECATED - DeployerWhitelist + +`DeployerWhitelist` is a legacy contract that was originally used to act as a +whitelist of addresses allowed to the Optimism network. The `DeployerWhitelist` +has since been disabled, but the code is kept in state for the sake of full +backwards compatibility. As of the Bedrock upgrade, the `DeployerWhitelist` is +completely unused by the Optimism system and could, in theory, be removed entirely. + +* **Address:** `0x4200000000000000000000000000000000000002` +* **Introduced:** Legacy +* **Deprecated:** yes +* **Proxied:** yes + +#### DEPRECATED - LegacyERC20ETH + +`LegacyERC20ETH` is a legacy contract that held ETH balances before the Bedrock +upgrade. All ETH balances held within this contract were migrated to the state +trie as part of the Bedrock upgrade. Functions within this contract that mutate +state were already disabled as part of the EVM equivalence upgrade. + +* **Address:** `0xDeadDeAddeAddEAddeadDEaDDEAdDeaDDeAD0000` +* **Introduced:** Legacy +* **Deprecated:** yes +* **Proxied:** yes + +#### DEPRECATED - L1BlockNumber + +`L1BlockNumber` is a legacy contract that fills the role of the +`OVM_L1BlockNumber` contract in the old version of the Optimism system. Only +necessary for backwards compatibility. If you want to access the L1 block +number going forward, you should use the `L1Block`contract instead. + +* **Address:** `0x4200000000000000000000000000000000000013` +* **Introduced:** Legacy +* **Deprecated:** yes +* **Proxied:** yes diff --git a/pages/stack/superchain-ops-guide.mdx b/pages/stack/smart-contracts/superchain-ops-guide.mdx similarity index 90% rename from pages/stack/superchain-ops-guide.mdx rename to pages/stack/smart-contracts/superchain-ops-guide.mdx index fb921a997..5410b92ee 100644 --- a/pages/stack/superchain-ops-guide.mdx +++ b/pages/stack/smart-contracts/superchain-ops-guide.mdx @@ -24,6 +24,10 @@ import { Callout } from 'nextra/components' This guide outlines the process for upgrading Optimism chains using the `superchain-ops` repository. It's intended primarily for chains that are part of the Superchain, those with the Foundation or Security Council as signers, and/or chains requiring a highly secure and manual process. +For chains that don't require a secure upgrade process or security council signing, you can instead use [op-deployer](/stack/smart-contracts/op-deployer-upgrade) to upgrade your chain. + +For non-Optimism governed chains, you can use [op-deployer](/stack/smart-contracts/op-deployer-upgrade) and your own tooling to upgrade your chain. + `superchain-ops` is a highly secure service designed for Optimism chains. It provides a structured and security-focused approach to chain upgrades. The process involves creating tasks that use predefined templates to generate the necessary upgrade transactions. ## Who should use `superchain-ops` @@ -124,8 +128,4 @@ This will run through the upgrade process without actually executing the transac For chains within the Superchain, submit a pull request to have your task reviewed. If your chain is not within the Superchain, execute the transaction yourself. -## Using op-deployer to create calldata - -The `upgrade` command in op-deployer allows you to upgrade a chain from one version to another. It consists of several subcommands, one for each upgrade version. Think of it like a database migration: each upgrade command upgrades a chain from exactly one previous version to the next. A chain that is several versions behind can be upgrade to the latest version by running multiple upgrade commands in sequence. -To learn about the `upgrade` command, check out our [devdocs](https://devdocs.optimism.io/op-deployer/user-guide/upgrade.html). diff --git a/pages/stack/smart-contracts/upgrade-op-contracts-1-3-1-8.mdx b/pages/stack/smart-contracts/upgrade-op-contracts-1-3-1-8.mdx new file mode 100644 index 000000000..6c1a6f8ea --- /dev/null +++ b/pages/stack/smart-contracts/upgrade-op-contracts-1-3-1-8.mdx @@ -0,0 +1,230 @@ +--- +title: Upgrading Smart Contracts from v1.3.0 to v1.8.0 +description: Learn about upgrading the smart contracts that make up the OP Stack. +lang: en-US +content_type: guide +topic: smart-contract-upgrades +personas: + - protocol-developer + - chain-operator +categories: + - mainnet + - protocol + - l1-contracts + - contract-upgrades + - architecture + - fault-proofs +is_imported_content: 'false' +--- + +import { Callout } from 'nextra/components' + +# Upgrading Optimism L1 smart contracts from v1.3.0 to v1.8.0 + +This guide provides specific instructions for upgrading the OP Stack's Layer 1 contracts from `op-contracts/v1.3.0` to `op-contracts/v1.8.0`. This upgrade includes important changes to the system configuration and introduces the Fault Proof System. + +## Overview of the Holocene upgrade + +The Holocene upgrade is a protocol upgrade. Learn more about it in the [Holocene notice page](https://docs.optimism.io/notices/holocene-changes). This guide shows you how to take your OP Stack chain from the L2 Output Oracle System to a permissioned Fault Proof System contract version associated with the Holocene upgrade. + +### Formatting config files + +You need your chain's `deployments.json` and `deploy-config.json` + +Ensure both files are correctly formatted, using the exact field names shown in the below examples, with **ALL** values - particularly the relevant ones - updated for **your specific chain**: + +`deployments.json`: + +```json +{ + "AddressManager": "0xEF8115F2733fb2033a7c756402Fc1deaa56550Ef", + "L2OutputOracleProxy": "0x9E6204F750cD866b299594e2aC9eA824E2e5f95c", + "OptimismMintableERC20FactoryProxy": "0xc52BC7344e24e39dF1bf026fe05C4e6E23CfBcFf", + "L1StandardBridgeProxy": "0x3e2Ea9B92B7E48A52296fD261dc26fd995284631", + "ProxyAdmin": "0xD4ef175B9e72cAEe9f1fe7660a6Ec19009903b49", + "L1CrossDomainMessengerProxy": "0xdC40a14d9abd6F410226f1E6de71aE03441ca506", + "L1ERC721BridgeProxy": "0x83A4521A3573Ca87f3a971B169C5A0E1d34481c3", + "OptimismPortalProxy": "0x1a0ad011913A150f69f6A19DF447A0CfD9551054", + "SystemConfigProxy": "0xA3cAB0126d5F504B071b81a3e8A2BBBF17930d86" +} +``` + +`deploy-config.json`: + +```json +{ + "l1StartingBlockTag": "0x10aa183", + "l1ChainID": 1, + "l2ChainID": 7777777, + "l2BlockTime": 2, + "finalizationPeriodSeconds": 604800, + "controller": "0xEe729F57F0111FD0F660867d0F522f983202a5aF", + "baseFeeVaultRecipient": "0xe900b3Edc1BA0430CFa9a204A1027B90825ac951", + "l1FeeVaultRecipient": "0xe900b3Edc1BA0430CFa9a204A1027B90825ac951", + "sequencerFeeVaultRecipient": "0xe900b3Edc1BA0430CFa9a204A1027B90825ac951", + "l2GenesisBlockBaseFeePerGas": "0x3b9aca00", + "governanceTokenOwner": "0xC72aE5c7cc9a332699305E29F68Be66c73b60542", + "governanceTokenSymbol": "OP", + "governanceTokenName": "Optimism", + "maxSequencerDrift": 600, + "sequencerWindowSize": 3600, + "channelTimeout": 300, + "p2pSequencerAddress": "0x3Dc8Dfd0709C835cAd15a6A27e089FF4cF4C9228", + "optimismL2FeeRecipient": "0x63AA492609175d1824dD668BDadF0042E74b0fC8", + "batchInboxAddress": "0x6F54Ca6F6EdE96662024Ffd61BFd18f3f4e34DFf", + "batchSenderAddress": "0x625726c858dBF78c0125436C943Bf4b4bE9d9033", + "l2GenesisRegolithTimeOffset": "0x0", + "l2OutputOracleSubmissionInterval": 180, + "l2OutputOracleStartingTimestamp": -1, + "l2OutputOracleStartingBlockNumber": "0x0", + "l2GenesisBlockGasLimit": "0x1c9c380", + "fundDevAccounts": false, + "gasPriceOracleOverhead": 188, + "gasPriceOracleScalar": 684000, + "eip1559Denominator": 50, + "eip1559Elasticity": 6, + "optimismBaseFeeRecipient": "0xea4591A6e5a31CF0b822A4f563163CeeBeEe4eb1", + "optimismL1FeeRecipient": "0xdD7aCF916c3E3Fb959CA3bB29beFffcAD2e90be6", + "l2CrossDomainMessengerOwner": "0xA53EF9bBec25fdA4b6Da7EF5617565794369A2A5", + "gasPriceOracleOwner": "0x9c3651E0B3CE47A0b17d775077E3d9B712582be0", + +- RELEVANT VALUES + "systemConfigOwner": "0xC72aE5c7cc9a332699305E29F68Be66c73b60542", + "finalSystemOwner": "0xC72aE5c7cc9a332699305E29F68Be66c73b60542", + "superchainConfigGuardian": "0x9BA6e03D8B90dE867373Db8cF1A58d2F7F006b3A", + "portalGuardian": "0xC72aE5c7cc9a332699305E29F68Be66c73b60542", + "l2OutputOracleProposer": "0x48247032092e7b0ecf5dEF611ad89eaf3fC888Dd", + "l2OutputOracleOwner": "0xDA1F62857EA7f10444725c6c435235243D623540", + "proxyAdmin": "0x027860cA56cF779371461C14c3a483c94e1aA8a0", + "proxyAdminOwner": "0xb0cCdbD6fe09D2199171BE19450aF249250518A0", + "l2OutputOracleChallenger": "0xcA4571b1ecBeC86Ea2E660d242c1c29FcB55Dc72", + +- add the below values if not in the config file already, making sure they are correct for your chain + "useFaultProofs": true, + "faultGameMaxDepth": 73, + "faultGameSplitDepth": 30, + "faultGameWithdrawalDelay": 604800, + "faultGameMaxClockDuration": 302400, + "faultGameClockExtension": 10800, + +- You can update this to the latest absolute prestate hash in the Superchain Registry; however, the permissioned Fault Proof System doesn't use this. This comes into play when you upgrade your chain to the permissionless Fault Proof System. + "faultGameAbsolutePrestate": "0x03925193e3e89f87835bbdf3a813f60b2aa818a36bbe71cd5d8fd7e79f52bafe", + +- add the below values if not in the config file already, making sure they are correct for your chain + "faultGameGenesisBlock": 0, + "faultGameGenesisOutputRoot": "0xdead000000000000000000000000000000000000000000000000000000000000", + "respectedGameType": 1, + "preimageOracleMinProposalSize": 126000, + "preimageOracleChallengePeriod": 86400, + "proofMaturityDelaySeconds": 604800, + "disputeGameFinalityDelaySeconds": 302400, + "enableGovernance": false, + "systemConfigStartBlock": 0, + "requiredProtocolVersion": "0x0000000000000000000000000000000000000003000000010000000000000000", + "recommendedProtocolVersion": "0x0000000000000000000000000000000000000003000000010000000000000000", + +- make sure to add the below if not present already, these values won't matter but the script needs them to be present in the config + "sequencerFeeVaultWithdrawalNetwork": 0, + "baseFeeVaultWithdrawalNetwork": 0, + "l1FeeVaultWithdrawalNetwork": 0, + "baseFeeVaultMinimumWithdrawalAmount": "0x8ac7230489e80000", + "l1FeeVaultMinimumWithdrawalAmount": "0x8ac7230489e80000", + "sequencerFeeVaultMinimumWithdrawalAmount": "0x8ac7230489e80000" +} +``` + +Make sure that important addresses (like the `ProxyAdmin`, `ProxyAdminOwner`, all L1 addresses, `L2OO`) are actually up to date by cross checking the Superchain Registry and on-chain (you can do this easily with [`op-fetcher`](https://github.com/ethereum-optimism/optimism/tree/develop/op-fetcher), especially for the `deployments.json`. + +## Step-by-step upgrade process + +### 1. Create your working directory + +Create a working directory: + +```shell +mkdir upgrade-dir +cd upgrade-dir +``` + +And then create an outputs directory: + +```shell +mkdir outputs +``` + +### 2. Copy config files + +Copy your `deployments.json` and `deploy-config.json` into the working directory + +### 3. Configure and deploy environment + +Create and update an `.env` file with the required information: + +```json +############################################## +# ↓ Required ↓ # +############################################## + +# Can be "mainnet" or "sepolia" +NETWORK= + +# Etherscan API key used to verify contract bytecode +ETHERSCAN_API_KEY= + +# RPC URL for the L1 network that matches $NETWORK +ETH_RPC_URL= + +# Private key used to deploy the new contracts for this upgrade +PRIVATE_KEY= + +# Base fee scalar for the SystemConfig +BASE_FEE_SCALAR= + +# Blob base fee scalar for the SystemConfig +BLOB_BASE_FEE_SCALAR= + +# Check if required files and folders exist +if [ ! -f "./deploy_config.json" ]; then + echo "Error: deploy_config.json not found" +fi +if [ ! -f "./deployments.json" ]; then + echo "Error: deployments.json not found" +fi +if [ ! -d "./outputs" ]; then + echo "Error: outputs folder not found" +fi +``` + +### 4. Run the deployment process + +Run the deployment process with the following command: + +```docker + docker run -t + --env-file .env + -v ./deploy_config.json:/deploy_config.json + -v ./deployments.json:/deployments.json + -v ./outputs:/outputs + kfoplabs/upgrade-v1.3.0-v1.8.0-permissioned /deploy_config.json /deployments.json +``` + +### 5. Verify outputs + +The deployment should output four files: + +* `deploy.log` is a log of the deployment process +* `deployments.json` includes the newly deployed contract addresses +* `bundle.json` is the safe transaction bundle +* `transactions.json` is the summary of the executed deployment transactions +* `standard-addresses.json` is the addresses of `SystemConfigImpl`, `OptimismPortal2Impl`, `L1CrossDomainMessengerImpl`, `L1StandardBridgeImpl`, `L1ERC721BridgeImpl`, and `OptimismMintableERC20FactoryImpl` +* `validation.txt` is used for Tenderly state diff validation. Some info needed for the superchain-ops task might be missing from this file, and will instead be generated during the Tenderly simulation. + +### 6. Verify outputs + +Now you have the calldata that can be executed onchain to perform the L1 contract upgrade. You should simulate this upgrade and make sure the changes are expected. You can reference the validation files of previously executed upgrade tasks in the [superchain-ops repo](https://github.com/ethereum-optimism/superchain-ops/blob/main/tasks/eth/022-holocene-fp-upgrade/NestedSignFromJson.s.sol) to see what the expected changes are. Once you're confident the state changes are expected, you can sign and execute the upgrade. + +## Additional Resources + +* [Optimism Documentation](https://community.optimism.io/docs/) +* [superchain-ops Repository](https://github.com/ethereum-optimism/superchain-ops) +* [Optimism Monorepo](https://github.com/ethereum-optimism/optimism) diff --git a/pages/superchain/addresses.mdx b/pages/superchain/addresses.mdx index 3402f0cbf..a00b78eb7 100644 --- a/pages/superchain/addresses.mdx +++ b/pages/superchain/addresses.mdx @@ -22,7 +22,7 @@ import { SuperchainContractTable } from '@/components/SuperchainContractTable' # Contract Addresses This reference guide lists all the contract addresses for OP Stack chains, as found on the [superchain-registry](https://github.com/ethereum-optimism/superchain-registry/tree/main). This doc will periodically be updated with addresses across the Superchain. -See the [Smart Contracts Overview](/stack/smart-contracts) for high-level details and access to the source code. +See the [Smart Contracts Overview](/stack/smart-contracts/smart-contracts) for high-level details and access to the source code. This page is automatically generated from packages in the [superchain-registry](https://github.com/ethereum-optimism/superchain-registry/tree/main) which keeps the content synced and up-to-date. diff --git a/public/_redirects b/public/_redirects index 42b1775d6..826a3dd7d 100644 --- a/public/_redirects +++ b/public/_redirects @@ -168,6 +168,7 @@ # General redirects # ---------------------------------------------------------------------------- +/stack/smart-contracts /stack/smart-contracts/smart-contracts /get-started/design-principles /stack/design-principles /index /