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.

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

feat: create initial README for supersim #50

Merged
merged 5 commits into from
Jul 16, 2024
Merged

feat: create initial README for supersim #50

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
9f22192
feat: create initial README for supersim
tremarkley Jul 15, 2024
3c6c165
Update README.md
tremarkley Jul 16, 2024
5450e57
Update README.md
tremarkley Jul 16, 2024
ec00b3f
Merge branch 'main' into harry/initial_readme
tremarkley Jul 16, 2024
b033614
Update README.md
tremarkley Jul 16, 2024
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
1 change: 1 addition & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
TODO
52 changes: 50 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,50 @@
# supersim
Local Multi-L2 Development Environment
# Supersim
A local development environment for testing against multiple nodes running simultaneously.

## Table of Contents
- [Overview](#overview)
- [Getting started](#getting-started)
- [Installation](#installation)
- [Features](#features)
- [Vanilla mode](#vanilla-mode)
- [Forked mode](#forked-mode)
- [Join Discord](#join-discord)
- [Contributing](#contributing)
- [License](#license)

## Overview
Supersim allows developers to start multiple local evm nodes with one command, and coordinates message passing and asset transfer between these chains, following the Superchain interoperability spec.

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. Each chain is an instance of [anvil](https://book.getfoundry.sh/reference/anvil/), though future versions may support other local testing tools.

## Getting started
### Installation
TODO

tremarkley marked this conversation as resolved.
Show resolved Hide resolved
## Features
### 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.

How to run in vanilla mode:
TODO: insert command

tremarkley marked this conversation as resolved.
Show resolved Hide resolved
### Forked mode
TODO

tremarkley marked this conversation as resolved.
Show resolved Hide resolved
## Examples
TODO

## Join Discord
tremarkley marked this conversation as resolved.
Show resolved Hide resolved
Join our discord [here](https://discord.gg/Scdnrw8d) and reach out to us in the [interop-devex](https://discord.com/channels/1244729134312198194/1255653436079210496) channel.

## Contributing

Contributions are encouraged, but please open an issue before making any major changes to ensure your changes will be accepted.

See [CONTRIBUTING.md](./CONTRIBUTING.md) for contributing information.

## License

Files are licensed under the [MIT license](./LICENSE).

<a href="./LICENSE"><img src="https://user-images.githubusercontent.com/35039927/231030761-66f5ce58-a4e9-4695-b1fe-255b1bceac92.png" alt="License information" width="200" /></a>
Loading