Skip to content
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.

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

Create op-supervisor.mdx #1044

Merged
merged 9 commits into from
Oct 31, 2024
Merged
Changes from 1 commit
Commits
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
73 changes: 73 additions & 0 deletions pages/stack/interop/op-supervisor.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
---
title: OP-Supervisor
lang: en-US
description: Learn the basics of OP-Supervisor.
---

import { Callout, Tabs, Steps } from 'nextra/components'

# OP-Supervisor

<Callout>
Interop is currently in active development and not yet ready for production use. The information provided here may change. Check back regularly for the most up-to-date information.
</Callout>

`op-supervisor` is a critical service designed to verify cross-chain messages and manage the safety of interoperability between different chains in the OP Stack. It acts as a hub for indexing data that every `op-node` needs to cross-verify with other chains.

## Features and benefits

* Enables secure cross-chain message passing on the Superchain
* Provides a centralized point for managing interoperability data
cpengilly marked this conversation as resolved.
Show resolved Hide resolved
cpengilly marked this conversation as resolved.
Show resolved Hide resolved
* Reduces the complexity and cost of operating individual nodes
cpengilly marked this conversation as resolved.
Show resolved Hide resolved
* Supports multiple networks simultaneously
* Offers potential for public endpoints to aid in node synchronization

## Major components

### Cross-chain message verification

Verifies messages between different chains in the OP Stack, reducing the risk of invalid or malicious cross-chain interactions.⁠ It centralizes the verification process, which reduces the complexity and cost of operating individual nodes⁠.⁠

* `op-geth`: queries `op-supervisor` during block-building to verify if a message is sufficiently safe to include. This process involves checking each executing message and potentially undoing transactions if conflicts or unknown states are encountered.
cpengilly marked this conversation as resolved.
Show resolved Hide resolved
* `op-node`: queries cross-chain safety information and coordinates safety updates between OP stack nodes and `op-supervisor`. It uses the API provided by `op-supervisor` to perform actions like:
* Updating and retrieving various safety levels
* Checking and returning the `cross-unsafe` head for a given chain
* Attempting to promote a block to `cross-safe` status
* Attempting to finalize an L2 block based on L1 finality

### Safe data indexing and management

Acts as a hub for indexing data that every `op-node` needs to cross-verify with other chains, centralizing the process of managing interoperability data. Maintains the integrity of cross-chain interactions by tracking safety changes⁠ across the Superchain, ensuring consistent application of invalid dependency resolutions. ⁠
cpengilly marked this conversation as resolved.
Show resolved Hide resolved
cpengilly marked this conversation as resolved.
Show resolved Hide resolved

`op-supervisor` indexes two types of cross-chain dependencies:

* Interop messages (events): `op-supervisor`maintains an events-index per L2 chain, which determines message-dependencies to check if blocks are safe
* L1 DA (data availability) batches: `op-supervisor`maintains a DA safety-index per L2 chain, which helps determine how to rewind L2 chains to resolve invalid dependencies
cpengilly marked this conversation as resolved.
Show resolved Hide resolved

### API for cross-chain safety

Provides an interface for `op-node` to query cross-chain safety information and coordinate safety updates between OP stack nodes and `op-supervisor⁠⁠`. OP-Supervisor uses a global read API to determine **message safety** and **block safety,** utilizing both the events index and the safety index (See op-supervisor's [safe data indexing](#safe-data-indexing-and-management)). The API is designed to handle potential L1 reorgs that can affect the validity of cross-chain messages⁠.

Key API methods include:

| Method | Description |
| -------------------- | ---------------------------------------------------------------------------------------- |
| `ExchangeSyncStatus` | Updates and retrieves various safety levels (LocalUnsafe, CrossUnsafe, LocalSafe, etc.)⁠ |
| `TryCrossUnsafe` | Checks and returns the cross-unsafe head for a given chain⁠⁠​ |
| `TryCrossSafe` | Attempts to promote a block to cross-safe status⁠⁠​ |
| `TryFinalize` | Attempts to finalize an L2 block based on L1 finality⁠ |
cpengilly marked this conversation as resolved.
Show resolved Hide resolved

### RPC access to all chains

The `op-supervisor` requires RPC access to all chains in the dependency set. This allows `op-supervisor` to verify cross-chain messages and sync data across multiple networks simultaneously, such as OP Mainnet and Base nodes using the same instance.

Benefits of this approach:
cpengilly marked this conversation as resolved.
Show resolved Hide resolved

* Cost-effective: Running `op-supervisor` is cheaper than running a full node for each chain in the dependency set.
cpengilly marked this conversation as resolved.
Show resolved Hide resolved
* Scalability: As the number of chains in the Superchain grows, `op-supervisor` can handle the increasing complexity of cross-chain interactions.
* Improved reliability: It enables a more redundant setup, which is good for stability in the growing ecosystem.

## Next steps

* Want to learn more? Read our guide on the anatomy of a [cross-chain message](/stack/interop/cross-chain-message) or check out this [interop design video walk-thru](https://www.youtube.com/watch?v=FKc5RgjtGes).
* For more info about how OP Stack interoperability works under the hood, [check out the specs](https://specs.optimism.io/interop/overview.html).
Loading