-
Notifications
You must be signed in to change notification settings - Fork 70
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: create initial README for supersim
- Loading branch information
1 parent
d341956
commit 9844668
Showing
1 changed file
with
27 additions
and
2 deletions.
There are no files selected for viewing
This file contains 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,2 +1,27 @@ | ||
# supersim | ||
Local Multi-L2 Development Environment | ||
# Supersim | ||
Supersim is a local Multi-L2 Development Environment. | ||
|
||
## Overview | ||
Supersim allows developers to start multiple local Layer 2 chains with one command, and coordinates message passing and asset transfer between these chains. | ||
|
||
Supersim is a lightweight tool that simulates an interoperable Superchain environment locally. It does not require a complicated devnet setup and is run using cli commands with configuration options that fall back to sensible defaults if they are not specified. | ||
|
||
## Getting Started | ||
|
||
### Installation | ||
TODO | ||
|
||
## Modes | ||
|
||
Each L2 chain is an instance of [anvil](https://book.getfoundry.sh/reference/anvil/). | ||
|
||
### Vanilla Mode | ||
Brings up one L1 chain and 2 L2 chains with the appropriate OP Stack contracts already deployed, allowing you to locally test against the latest OP Stack features. | ||
|
||
To run vanilla mode simply run: | ||
TODO: insert command | ||
|
||
### Forked Mode | ||
|
||
## Examples | ||
TODO |