From 9f221929ad93507338296f19063c55abb6098056 Mon Sep 17 00:00:00 2001 From: tre Date: Mon, 15 Jul 2024 16:46:40 -0700 Subject: [PATCH 1/4] feat: create initial README for supersim --- CONTRIBUTING.md | 1 + README.md | 52 +++++++++++++++++++++++++++++++++++++++++++++++-- 2 files changed, 51 insertions(+), 2 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..30404ce4 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1 @@ +TODO \ No newline at end of file diff --git a/README.md b/README.md index b2017d90..31df190d 100644 --- a/README.md +++ b/README.md @@ -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 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. Each chain is an instance of [anvil](https://book.getfoundry.sh/reference/anvil/). + +## Getting started +### Installation +TODO + +## 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 + +### Forked mode +TODO + +## Examples +TODO + +## Join Discord +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). + + \ No newline at end of file From 3c6c1658004b6e3a473996e6441e8419d7f04450 Mon Sep 17 00:00:00 2001 From: tre Date: Tue, 16 Jul 2024 10:12:26 -0700 Subject: [PATCH 2/4] Update README.md Co-authored-by: Faina Shalts --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 31df190d..fa829de1 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ A local development environment for testing against multiple nodes running simul - [License](#license) ## 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 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/). From 5450e57efba756d6bf62b34ae20c3dc5ea09e9f7 Mon Sep 17 00:00:00 2001 From: tre Date: Tue, 16 Jul 2024 10:12:44 -0700 Subject: [PATCH 3/4] Update README.md Co-authored-by: Faina Shalts --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index fa829de1..7ed82ca6 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ A local development environment for testing against multiple nodes running simul ## 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/). +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 From b0336148b161aa284225651d3350645606b274ab Mon Sep 17 00:00:00 2001 From: tre Date: Tue, 16 Jul 2024 10:24:37 -0700 Subject: [PATCH 4/4] Update README.md Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 7ed82ca6..c8549c99 100644 --- a/README.md +++ b/README.md @@ -47,4 +47,4 @@ See [CONTRIBUTING.md](./CONTRIBUTING.md) for contributing information. Files are licensed under the [MIT license](./LICENSE). - \ No newline at end of file +License information \ No newline at end of file