# ethereum/l2-interop architecture

> Architecture diagram of the GitHub repository ethereum/l2-interop, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-06-15). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/ethereum/l2-interop
- Repository: https://github.com/ethereum/l2-interop

## Overview

##### Project type and purpose
- This repository is not a running application but an open-source “meta-project” for Ethereum-wide L2 interoperability.
- It holds two main areas:
- docs/ – high-level, user-friendly guides, roadmaps, meeting notes, use cases
- specs/ – rigorous, technical protocol definitions and standard proposals

##### File structure
- Top level:
- PROPERTIES.md – the canonical list of system properties driving the design
- docs/ – subdivided by topic (addresses, assets, intents, message-passing, shared bridges)
- specs/ – matching subfolders with detailed specs for each area (e.g., cross-chain addresses)
- .github/ and CONTRIBUTING.md hold issue templates and contribution guidelines
- NOMENCLATURE.md ensures consistent terminology

##### README for additional insights
- Emphasizes collaboration outputs: prototypes, reference implementations, EIP/RIP/ERC/CAIP contributions
- Highlights the flow: Properties → docs → specs → proposals/implementations

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph "Foundational"
        Properties["Core Properties Module"]:::foundation
    end

    subgraph "Documentation Layer"
        DocsOverview["Overview"]:::docs
        DocsAddr["Addresses"]:::docs
        DocsAssets["Assets"]:::docs
        DocsIntents["Intents"]:::docs
        DocsMsg["Message-Passing"]:::docs
        DocsBridges["Shared Bridges"]:::docs
    end

    subgraph "Specification Layer"
        SpecsOverview(("Overview")):::specs
        SpecsAddr(("Addresses Specs")):::specs
        SpecsAssets(("Assets Specs")):::specs
        SpecsIntents(("Intents Specs")):::specs
        SpecsMsg(("Message-Passing Specs")):::specs
        SpecsBridges(("Shared Bridges Specs")):::specs
    end

    subgraph "Community Collaboration"
        Issues["Issue Templates"]:::community
        Guidelines["Contribution Guidelines"]:::community
        Nomenclature["Nomenclature"]:::community
    end

    Standards["Standards Bodies (EIP/ERC/etc)"]:::standards
    Impl["Implementations & Prototypes"]:::implement

    Properties -->|drives| DocsOverview
    Properties -->|drives| SpecsOverview

    DocsOverview -->|includes| DocsAddr
    DocsOverview -->|includes| DocsAssets
    DocsOverview -->|includes| DocsIntents
    DocsOverview -->|includes| DocsMsg
    DocsOverview -->|includes| DocsBridges

    SpecsOverview -->|comprises| SpecsAddr
    SpecsOverview -->|comprises| SpecsAssets
    SpecsOverview -->|comprises| SpecsIntents
    SpecsOverview -->|comprises| SpecsMsg
    SpecsOverview -->|comprises| SpecsBridges

    DocsOverview -->|onboarding guide| Issues
    DocsOverview -->|onboarding guide| Guidelines

    SpecsOverview -->|feeds formal proposals| Standards
    SpecsOverview -->|feeds prototypes| Impl

    Issues -->|feedback| DocsOverview
    Issues -->|feedback| SpecsOverview
    Guidelines -->|feedback| DocsOverview
    Guidelines -->|feedback| SpecsOverview
    Nomenclature -->|ensures consistency| DocsOverview
    Nomenclature -->|ensures consistency| SpecsOverview

    click Properties "https://github.com/ethereum/l2-interop/blob/main/PROPERTIES.md"
    click DocsOverview "https://github.com/ethereum/l2-interop/blob/main/docs/README.md"
    click DocsAddr "https://github.com/ethereum/l2-interop/tree/main/docs/addresses/"
    click DocsAssets "https://github.com/ethereum/l2-interop/tree/main/docs/assets/"
    click DocsIntents "https://github.com/ethereum/l2-interop/tree/main/docs/intents/"
    click DocsMsg "https://github.com/ethereum/l2-interop/tree/main/docs/message-passing/"
    click DocsBridges "https://github.com/ethereum/l2-interop/blob/main/docs/shared-bridges.md"
    click SpecsOverview "https://github.com/ethereum/l2-interop/blob/main/specs/README.md"
    click SpecsAddr "https://github.com/ethereum/l2-interop/tree/main/specs/addresses/"
    click Issues "https://github.com/ethereum/l2-interop/blob/main/.github/ISSUE_TEMPLATE/project-task.md"
    click Guidelines "https://github.com/ethereum/l2-interop/blob/main/CONTRIBUTING.md"
    click Nomenclature "https://github.com/ethereum/l2-interop/blob/main/NOMENCLATURE.md"

    classDef foundation fill:#cce5ff,stroke:#004085,color:#004085
    classDef docs fill:#d4edda,stroke:#155724,color:#155724
    classDef specs fill:#fff3cd,stroke:#856404,color:#856404
    classDef community fill:#e2e3e5,stroke:#6c757d,color:#6c757d
    classDef standards fill:#f5c6cb,stroke:#721c24,color:#721c24
    classDef implement fill:#d1ecf1,stroke:#0c5460,color:#0c5460
```
