maint(ct): link to external mermaid diagrams in specs

Updates the contracts README to use the mermaid diagrams in specs to avoid duplicated documentation.
ethereum-optimism · Sep 19, 2024 · a9b6ee9 · a9b6ee9
1 parent 08a4369
commit a9b6ee9
Showing 1 changed file with 1 addition and 212 deletions.
diff --git a/packages/contracts-bedrock/README.md b/packages/contracts-bedrock/README.md
@@ -9,11 +9,6 @@ High-level information about these contracts can be found within this README and
 ## Table of Contents
 
 - [Architecture Overview](#architecture-overview)
-  - [Core L1 Smart Contracts](#core-l1-smart-contracts)
-    - [Notes for Core L1 Smart Contracts](#notes-for-core-l1-smart-contracts)
-  - [Core L2 Smart Contracts](#core-l2-smart-contracts)
-    - [Notes for Core L2 Smart Contracts](#notes-for-core-l2-smart-contracts)
-  - [Smart Contract Proxies](#smart-contract-proxies)
 - [External Usage](#external-usage)
   - [Using OP Stack Contracts in Solidity](#using-op-stack-contracts-in-solidity)
   - [Using OP Stack Contracts in JavaScript](#using-op-stack-contracts-in-javascript)
@@ -36,213 +31,7 @@ High-level information about these contracts can be found within this README and
 
 ## Architecture Overview
 
-> **NOTE**: Smart contract names in the architecture diagrams below are links to source code. Click them!
-
-### Core L1 Smart Contracts
-
-Below you'll find an architecture diagram describing the core L1 smart contracts for the OP Stack.
-Smart contracts that are considered "peripheral" and not core to the operation of the OP Stack system are described separately.
-
-```mermaid
-graph LR
-    subgraph "External Contracts"
-        ExternalERC20(External ERC20 Contracts)
-        ExternalERC721(External ERC721 Contracts)
-    end
-
-    subgraph "L1 Smart Contracts"
-        BatchDataEOA(<a href="https://etherscan.io/address/0xff00000000000000000000000000000000000010">Batch Inbox Address</a>)
-        L1StandardBridge(<a href="https://github.com/ethereum-optimism/optimism/tree/develop/packages/contracts-bedrock/src/L1/L1StandardBridge.sol">L1StandardBridge</a>)
-        L1ERC721Bridge(<a href="https://github.com/ethereum-optimism/optimism/tree/develop/packages/contracts-bedrock/src/L1/L1ERC721Bridge.sol">L1ERC721Bridge</a>)
-        L1CrossDomainMessenger(<a href="https://github.com/ethereum-optimism/optimism/tree/develop/packages/contracts-bedrock/src/L1/L1CrossDomainMessenger.sol">L1CrossDomainMessenger</a>)
-        OptimismPortal(<a href="https://github.com/ethereum-optimism/optimism/tree/develop/packages/contracts-bedrock/src/L1/OptimismPortal.sol">OptimismPortal</a>)
-        SuperchainConfig(<a href="https://github.com/ethereum-optimism/optimism/tree/develop/packages/contracts-bedrock/src/L1/SuperchainConfig.sol">SuperchainConfig</a>)
-        SystemConfig(<a href="https://github.com/ethereum-optimism/optimism/tree/develop/packages/contracts-bedrock/src/L1/SystemConfig.sol">SystemConfig</a>)
-        DisputeGameFactory(<a href="https://github.com/ethereum-optimism/optimism/tree/develop/packages/contracts-bedrock/src/dispute/DisputeGameFactory.sol">DisputeGameFactory</a>)
-        FaultDisputeGame(<a href="https://github.com/ethereum-optimism/optimism/tree/develop/packages/contracts-bedrock/src/dispute/FaultDisputeGame.sol">FaultDisputeGame</a>)
-        AnchorStateRegistry(<a href="https://github.com/ethereum-optimism/optimism/tree/develop/packages/contracts-bedrock/src/dispute/AnchorStateRegistry.sol">AnchorStateRegistry</a>)
-        DelayedWETH(<a href="https://github.com/ethereum-optimism/optimism/tree/develop/packages/contracts-bedrock/src/dispute/DelayedWETH.sol">DelayedWETH</a>)
-    end
-
-    subgraph "User Interactions (Permissionless)"
-        Users(Users)
-        Challengers(Challengers)
-    end
-
-    subgraph "System Interactions"
-        Guardian(Guardian)
-        Batcher(Batcher)
-    end
-
-    subgraph "Layer 2 Interactions"
-        L2Nodes(Layer 2 Nodes)
-    end
-
-    L2Nodes -.->|fetch transaction batches| BatchDataEOA
-    L2Nodes -.->|fetch deposit events| OptimismPortal
-
-    Batcher -->|publish transaction batches| BatchDataEOA
-
-    ExternalERC20 <-->|mint/burn/transfer tokens| L1StandardBridge
-    ExternalERC721 <-->|mint/burn/transfer tokens| L1ERC721Bridge
-
-    L1StandardBridge <-->|send/receive messages| L1CrossDomainMessenger
-    L1StandardBridge -.->|query pause state| SuperchainConfig
-
-    L1ERC721Bridge <-->|send/receive messages| L1CrossDomainMessenger
-    L1ERC721Bridge -.->|query pause state| SuperchainConfig
-
-    L1CrossDomainMessenger <-->|send/receive messages| OptimismPortal
-    L1CrossDomainMessenger -.->|query pause state| SuperchainConfig
-
-    OptimismPortal -.->|query pause state| SuperchainConfig
-    OptimismPortal -.->|query config| SystemConfig
-    OptimismPortal -.->|query state proposals| DisputeGameFactory
-
-    DisputeGameFactory -->|generate instances| FaultDisputeGame
-
-    FaultDisputeGame -->|store bonds| DelayedWETH
-    FaultDisputeGame -->|query/update anchor states| AnchorStateRegistry
-
-    Users <-->|deposit/withdraw ETH/ERC20s| L1StandardBridge
-    Users <-->|deposit/withdraw ERC721s| L1ERC721Bridge
-    Users -->|prove/execute withdrawals| OptimismPortal
-
-    Challengers -->|propose output roots| DisputeGameFactory
-    Challengers -->|verify/challenge/defend proposals| FaultDisputeGame
-
-    Guardian -->|pause/unpause| SuperchainConfig
-    Guardian -->|safety net actions| OptimismPortal
-    Guardian -->|safety net actions| DisputeGameFactory
-    Guardian -->|safety net actions| DelayedWETH
-
-    classDef extContracts stroke:#ff9,stroke-width:2px;
-    classDef l1Contracts stroke:#bbf,stroke-width:2px;
-    classDef l1EOA stroke:#bbb,stroke-width:2px;
-    classDef userInt stroke:#f9a,stroke-width:2px;
-    classDef systemUser stroke:#f9a,stroke-width:2px;
-    classDef l2Nodes stroke:#333,stroke-width:2px
-    class ExternalERC20,ExternalERC721 extContracts;
-    class L1StandardBridge,L1ERC721Bridge,L1CrossDomainMessenger,OptimismPortal,SuperchainConfig,SystemConfig,DisputeGameFactory,FaultDisputeGame,DelayedWETH,AnchorStateRegistry l1Contracts;
-    class BatchDataEOA l1EOA;
-    class Users,Challengers userInt;
-    class Batcher,Guardian systemUser;
-    class L2Nodes l2Nodes;
-```
-
-#### Notes for Core L1 Smart Contracts
-
-- The `Batch Data Address` described above (**highlighted in GREY**) is *not* a smart contract and is instead simply an arbitrarily chosen account that is assumed to have no known private key. This account is typically chosen as the account `0xFF0000....<L2 chain ID>` where `<L2 chain ID>` is chain ID of the Layer 2 network for which the data is being posted. For instance, for OP Mainnet, this account is chosen as `0xFF00000000000000000000000000000000000010`. However, this is not a strict requirement and some OP Stack chains may not follow this convention.
-- Smart contracts that sit behind `Proxy` contracts are **highlighted in BLUE**. Refer to the [Smart Contract Proxies](#smart-contract-proxies) section below to understand how these proxies are designed.
-  - The `L1CrossDomainMessenger` contract sits behind the [`ResolvedDelegateProxy`](https://github.com/ethereum-optimism/optimism/tree/develop/packages/contracts-bedrock/src/legacy/ResolvedDelegateProxy.sol) contract, a legacy proxy contract type used within older versions of the OP Stack. This proxy type is used exclusively for the `L1CrossDomainMessenger` to maintain backwards compatibility.
-  - The `L1StandardBridge` contract sits behind the [`L1ChugSplashProxy`](https://github.com/ethereum-optimism/optimism/tree/develop/packages/contracts-bedrock/src/legacy/L1ChugSplashProxy.sol) contract, a legacy proxy contract type used within older versions of the OP Stack. This proxy type is used exclusively for the `L1StandardBridge` contract to maintain backwards compatibility.
-
-### Core L2 Smart Contracts
-
-Here you'll find an architecture diagram describing the core OP Stack smart contracts that exist natively on the L2 chain itself.
-
-```mermaid
-graph LR
-    subgraph "Layer 1 (Ethereum)"
-        L1SmartContracts(L1 Smart Contracts)
-    end
-
-    subgraph "L2 Client"
-        L2Node(L2 Node)
-    end
-
-    subgraph "L2 System Contracts"
-        L1Block(<a href="https://github.com/ethereum-optimism/optimism/tree/develop/packages/contracts-bedrock/src/L2/L1Block.sol">L1Block</a>)
-        GasPriceOracle(<a href="https://github.com/ethereum-optimism/optimism/tree/develop/packages/contracts-bedrock/src/L2/GasPriceOracle.sol">GasPriceOracle</a>)
-        L1FeeVault(<a href="https://github.com/ethereum-optimism/optimism/tree/develop/packages/contracts-bedrock/src/L2/L1FeeVault.sol">L1FeeVault</a>)
-        BaseFeeVault(<a href="https://github.com/ethereum-optimism/optimism/tree/develop/packages/contracts-bedrock/src/L2/BaseFeeVault.sol">BaseFeeVault</a>)
-        SequencerFeeVault(<a href="https://github.com/ethereum-optimism/optimism/tree/develop/packages/contracts-bedrock/src/L2/SequencerFeeVault.sol">SequencerFeeVault</a>)
-    end
-
-    subgraph "L2 Bridge Contracts"
-        L2CrossDomainMessenger(<a href="https://github.com/ethereum-optimism/optimism/tree/develop/packages/contracts-bedrock/src/L2/L2CrossDomainMessenger.sol">L2CrossDomainMessenger</a>)
-        L2ToL1MessagePasser(<a href="https://github.com/ethereum-optimism/optimism/tree/develop/packages/contracts-bedrock/src/L2/L2ToL1MessagePasser.sol">L2ToL1MessagePasser</a>)
-        L2StandardBridge(<a href="https://github.com/ethereum-optimism/optimism/tree/develop/packages/contracts-bedrock/src/L2/L2StandardBridge.sol">L2StandardBridge</a>)
-        L2ERC721Bridge(<a href="https://github.com/ethereum-optimism/optimism/tree/develop/packages/contracts-bedrock/src/L2/L2ERC721Bridge.sol">L2ERC721Bridge</a>)
-    end
-
-    subgraph "Transactions"
-        DepositTransaction(Deposit Transaction)
-        UserTransaction(User Transaction)
-    end
-
-    subgraph "External Contracts"
-        ExternalERC20(External ERC20 Contracts)
-        ExternalERC721(External ERC721 Contracts)
-    end
-
-    subgraph "Remaining L2 Universe"
-        OtherContracts(Any Contracts and Addresses)
-    end
-
-    L2Node -.->|derives chain from| L1SmartContracts
-    L2Node -->|updates| L1Block
-    L2Node -->|distributes fees to| L1FeeVault
-    L2Node -->|distributes fees to| BaseFeeVault
-    L2Node -->|distributes fees to| SequencerFeeVault
-    L2Node -->|derives from deposits| DepositTransaction
-    L2Node -->|derives from chain data| UserTransaction
-
-    UserTransaction -->|can trigger| OtherContracts
-    DepositTransaction -->|maybe triggers| L2CrossDomainMessenger
-    DepositTransaction -->|can trigger| OtherContracts
-
-    ExternalERC20 <-->|mint/burn/transfer| L2StandardBridge
-    ExternalERC721 <-->|mint/burn/transfer| L2ERC721Bridge
-
-    L2StandardBridge <-->|sends/receives messages| L2CrossDomainMessenger
-    L2ERC721Bridge <-->|sends/receives messages| L2CrossDomainMessenger
-    GasPriceOracle -.->|queries| L1Block
-    L2CrossDomainMessenger -->|sends messages| L2ToL1MessagePasser
-
-    classDef extContracts stroke:#ff9,stroke-width:2px;
-    classDef l2Contracts stroke:#bbf,stroke-width:2px;
-    classDef transactions stroke:#fba,stroke-width:2px;
-    classDef l2Node stroke:#f9a,stroke-width:2px;
-
-    class ExternalERC20,ExternalERC721 extContracts;
-    class L2CrossDomainMessenger,L2ToL1MessagePasser,L2StandardBridge,L2ERC721Bridge l2Contracts;
-    class L1Block,L1FeeVault,BaseFeeVault,SequencerFeeVault,GasPriceOracle l2Contracts;
-    class UserTransaction,DepositTransaction transactions;
-    class L2Node l2Node;
-```
-
-#### Notes for Core L2 Smart Contracts
-
-- Contracts highlighted as "L2 System Contracts" are updated or mutated automatically as part of the chain derivation process. Users typically do not mutate these contracts directly, except in the case of the `FeeVault` contracts where any user may trigger a withdrawal of collected fees to the pre-determined withdrawal address.
-- Smart contracts that sit behind `Proxy` contracts are **highlighted in BLUE**. Refer to the [Smart Contract Proxies](#smart-contract-proxies) section below to understand how these proxies are designed.
-- User interactions for the "L2 Bridge Contracts" have been omitted from this diagram but largely follow the same user interactions described in the architecture diagram for the [Core L1 Smart Contracts](#core-l1-smart-contracts).
-
-### Smart Contract Proxies
-
-Most L1 and L2 smart contracts for OP Stack chains today sit behind `Proxy` contracts that themselves are managed by a `ProxyAdmin` contract.
-The `ProxyAdmin` contract is controlled by some `owner` address that can be any EOA or smart contract.
-Below you'll find a diagram that explains the behavior of the typical proxy contract.
-
-```mermaid
-graph LR
-    ProxyAdminOwner(Proxy Admin Owner)
-    ProxyAdmin(<a href="https://github.com/ethereum-optimism/optimism/blob/develop/packages/contracts-bedrock/src/universal/ProxyAdmin.sol">ProxyAdmin</a>)
-
-    subgraph "Logical Smart Contract"
-        Proxy(<a href="https://github.com/ethereum-optimism/optimism/blob/develop/packages/contracts-bedrock/src/universal/Proxy.sol">Proxy</a>)
-        Implementation(Implementation)
-    end
-
-    ProxyAdminOwner -->|manages| ProxyAdmin
-    ProxyAdmin -->|upgrades| Proxy
-    Proxy -->|delegatecall| Implementation
-
-    classDef l1Contracts stroke:#bbf,stroke-width:2px;
-    classDef systemUser stroke:#f9a,stroke-width:2px;
-    class Proxy l1Contracts;
-    class ProxyAdminOwner systemUser;
-```
+Refer to the [Optimism Overview page within the OP Stack Specs](https://specs.optimism.io/protocol/overview.html#architecture-overview) for a detailed architecture overview of core L1 contracts, core L2 contracts, and smart contract proxies.
 
 ## External Usage