Skip to content

fix(docs): add metadata to protocol overview diagrams #1889

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Osraka wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix(docs): add metadata to protocol overview diagrams #1889

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions docs/base-chain/specs/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ protocol components and the core user flows.

There are three primary actors that interact with Base: users, sequencers, and validators.

```mermaid
```mermaid Network Participants lines wrap expandable
graph TD
EthereumL1(Ethereum L1)

Expand Down Expand Up @@ -86,7 +86,7 @@ Validators can also act as Proposers and/or Challengers who:

The following diagram shows how the major protocol components interact across L1 and L2.

```mermaid
```mermaid High-Level System Diagram lines wrap expandable
graph LR
subgraph "Ethereum L1"
OptimismPortal(<a href="./protocol/bridging/withdrawals.html#the-optimism-portal-contract">OptimismPortal</a>)
Expand Down Expand Up @@ -139,7 +139,7 @@ P2P network to give validators low-latency access before batches land on L1.

[Consensus →](./protocol/consensus/)

```mermaid
```mermaid Consensus Flow lines wrap expandable
graph LR
L1(Ethereum L1)
subgraph "Rollup Node"
Expand Down Expand Up @@ -180,7 +180,7 @@ finalizes the withdrawal on L1 via `OptimismPortal`.

[Bridging →](./protocol/bridging/deposits)

```mermaid
```mermaid Bridging Flow lines wrap expandable
graph LR
subgraph "Deposit Path"
User1(User)
Expand Down Expand Up @@ -217,7 +217,7 @@ any validator to independently reconstruct the L2 chain from L1.

[Batcher →](./protocol/batcher)

```mermaid
```mermaid Batcher Flow lines wrap expandable
graph LR
Sequencer(Sequencer)
Batcher(<a href="./protocol/batcher.html">Batcher</a>)
Expand Down Expand Up @@ -245,7 +245,7 @@ challengers can dispute invalid claims. Valid withdrawals can only be finalized

[Proofs →](./protocol/proofs/)

```mermaid
```mermaid Proofs Flow lines wrap expandable
graph LR
Proposer(Proposer)
DGF(<a href="./protocol/proofs/contracts.html#disputegamefactory">DisputeGameFactory</a>)
Expand All @@ -272,7 +272,7 @@ Users will often begin their L2 journey by depositing ETH from L1.
Once they have ETH to pay fees, they'll start sending transactions on L2.
The following diagram demonstrates this interaction and key Base protocol components.

```mermaid
```mermaid Depositing ETH to Base lines wrap expandable
graph TD
subgraph "Ethereum L1"
OptimismPortal(<a href="./protocol/bridging/withdrawals.html#the-optimism-portal-contract">OptimismPortal</a>)
Expand Down Expand Up @@ -310,7 +310,7 @@ Users may also want to withdraw ETH or ERC20 tokens from Base back to Ethereum.
as standard transactions on L2 but are then completed using transactions on L1. Withdrawals must reference a valid
proof game contract that proposes the state of the L2 at a given point in time.

```mermaid
```mermaid Withdrawing From Base lines wrap expandable
graph LR
subgraph "Ethereum L1"
BatchInbox(<a href="./reference/glossary.html#batcher-transaction">Batch Inbox Address</a>)
Expand Down
Loading