A local development environment for testing against multiple nodes running simultaneously.
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, though future versions may support other local testing tools.
- build the binary by running:
go build cmd/main.go
- start supersim in vanilla mode by running:
./main
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
Locally fork any of the available chains in a superchain network of the superchain registry, default mainnet. The fork height is determined by L1 block height (default latest), which determines the maximum timestamp for the forked L2 state of each chain to create some level of consistency.
Help Text:
NAME:
supersim fork - Locally fork a network in the superchain registry
USAGE:
supersim fork [command options] [arguments...]
OPTIONS:
--l1.fork.height value (default: 0) ($SUPERSIM_L1_FORK_HEIGHT)
L1 height to fork the superchain (bounds L2 time). `0` for latest
--chains value ($SUPERSIM_CHAINS)
chains to fork in the superchain, mainnet options: [base, lyra, metal, mode, op,
orderly, pgn, superlumio, zora]. In order to replace the public rpc endpoint for
a chain, specify the ($SUPERSIM_RPC_URL_<CHAIN>) env variable. i.e SUPERSIM_RPC_URL_OP=http://optimism-mainnet.infura.io/v3/<API-KEY>
--network value (default: "mainnet") ($SUPERSIM_NETWORK)
superchain network. options: mainnet, sepolia, sepolia-dev-0. In order to
replace the public rpc endpoint for the network, specify the
($SUPERSIM_RPC_URL_<NETWORK>) env variable. i.e SUPERSIM_RPC_URL_MAINNET=http://mainnet.infura.io/v3/<API-KEY>
TODO
Join our discord here and reach out to us in the interop-devex channel.
Contributions are encouraged, but please open an issue before making any major changes to ensure your changes will be accepted.
See CONTRIBUTING.md for contributing information.
Files are licensed under the MIT license.
