-
Notifications
You must be signed in to change notification settings - Fork 264
supersim explainer #978
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
Merged
Merged
supersim explainer #978
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
97de8b3
supersim explainer
cpengilly 25bcb57
Update pages/stack/protocol/interop/supersim.mdx
cpengilly 63d0fe0
updates per review
cpengilly e9248cd
lint fixes
cpengilly c2bf12a
address review feedback
cpengilly 0b3016d
Apply suggestions from code review
cpengilly 8c92df7
Update pages/stack/protocol/interop/supersim.mdx
cpengilly File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
--- | ||
--- | ||
|
||
import Supersim from '@/pages/stack/protocol/interop/supersim.mdx' | ||
|
||
<Supersim /> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,5 @@ | ||
{ | ||
"explainer": "Interop Explainer", | ||
"cross-chain-message": "Anatomy of Cross-Chain Message" | ||
"cross-chain-message": "Anatomy of Cross-Chain Message", | ||
"supersim": "Supersim Multichain Development Environment" | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
--- | ||
title: Supersim Multichain Development Environment | ||
lang: en-US | ||
description: Learn how to use the Supersim local dev environment tool designed to simulate the Optimism Superchain. | ||
--- | ||
|
||
import { Callout } from 'nextra/components' | ||
|
||
# Supersim multichain development environment | ||
|
||
<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> | ||
|
||
[Supersim](https://github.com/ethereum-optimism/Supersim) is a local development environment tool designed to simulate the Optimism Superchain for developers building multi-chain applications. It provides a simplified way to test and develop applications that interact with multiple chains within the Superchain ecosystem. | ||
|
||
## Supersim workflow | ||
|
||
```mermaid | ||
graph LR | ||
A[Write Smart Contracts] --> B[Deploy on Supersim] | ||
B --> C[Test Cross-Chain Interactions] | ||
C --> D[Debug and Refine] | ||
D --> B | ||
C --> E[Ready for Production] | ||
``` | ||
|
||
This diagram illustrates the typical workflow for developers using Supersim, from writing smart contracts to testing and refining cross-chain interactions. | ||
|
||
## Features and benefits | ||
|
||
* Simulates multiple OP Stack chains locally (e.g., chain 901, 902) | ||
* Supports testing of cross-chain messaging and interactions | ||
* Includes pre-deployed interoperability contracts | ||
* Offers a CLI interface for starting and managing Supersim instances | ||
* Provides local JSON-RPC endpoints for each simulated chain | ||
* Allows for custom configuration of chain parameters | ||
* Facilitates testing of Superchain-specific features like SuperchainERC20 tokens | ||
* Easy to use with common Ethereum development tools | ||
* Supports chain forking | ||
|
||
cpengilly marked this conversation as resolved.
Show resolved
Hide resolved
|
||
## Supersim CLI Interaction | ||
|
||
```mermaid | ||
graph TD | ||
cpengilly marked this conversation as resolved.
Show resolved
Hide resolved
|
||
A[Developer] --> B[Supersim CLI] | ||
B --> C[Chain 901] | ||
B --> D[Chain 902] | ||
B --> E[...] | ||
C --> F[JSON-RPC Endpoint] | ||
D --> G[JSON-RPC Endpoint] | ||
E --> H[JSON-RPC Endpoint] | ||
``` | ||
|
||
This diagram illustrates how developers interact with Supersim through the CLI, which simulates OP Stack specific features (specifically interop) on locally run chains, each with its own JSON-RPC endpoint and pre-deployed interoperability contracts. | ||
cpengilly marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
## Next steps | ||
|
||
* Check out the dedicated [Supersim docs](https://Supersim.pages.dev/) for tutorials and specific use cases. | ||
* Questions about Interop? Check out the FAQ section in the [Superchain Interop Explainer](/stack/protocol/interop/explainer#faqs) or check out this [Superchain interop design video walk-thru](https://www.youtube.com/watch?v=FKc5RgjtGes). | ||
* For more info about how Superchain interoperability works under the hood, [check out the specs](https://specs.optimism.io/interop/overview.html). |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.