Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
39 changes: 30 additions & 9 deletions pages/app-developers/tutorials/supersim/reference/fork.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@ categories:
- mainnet
- testnet
- cli
is_imported_content: 'false'
is_imported_content: "false"
---

import { Callout, Steps } from 'nextra/components'
import { Callout, Steps } from "nextra/components"

# Fork mode

Expand Down Expand Up @@ -68,9 +68,11 @@ OPTIONS:
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, race, tbn, zora]. In order to replace the public rpc endpoint for a
chain, specify the ($SUPERSIM_RPC_URL_<CHAIN>) env variable. i.e
chains to fork in the superchain, mainnet options: [arena-z, automata, base,
bob, cyber, ethernity, funki, hashkeychain, ink, lisk, lyra, metal, mint, mode,
op, orderly, polynomial, race, redstone, shape, soneium, sseed, swan, swell, tbn,
unichain, worldchain, xterio-eth, 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)
Expand All @@ -82,23 +84,45 @@ OPTIONS:
--interop.enabled (default: true) ($SUPERSIM_INTEROP_ENABLED)
enable interop predeploy and functionality

--admin.port value (default: 8420) ($SUPERSIM_ADMIN_PORT)
Listening port for the admin server

--interop.l2tol2cdm.override value ($SUPERSIM_INTEROP_L2TO2CDM_OVERRIDE)
Path to the L2ToL2CrossDomainMessenger build artifact that overrides
the default implementation

--l1.port value (default: 8545) ($SUPERSIM_L1_PORT)
Listening port for the L1 instance. `0` binds to any available port

--l2.count value (default: 2) ($SUPERSIM_L2_COUNT)
Number of L2s. Max of 5

--l2.starting.port value (default: 9545) ($SUPERSIM_L2_STARTING_PORT)
Starting port to increment from for L2 chains. `0` binds each chain to any
available port

--interop.autorelay (default: false) ($SUPERSIM_INTEROP_AUTORELAY)
Automatically relay messages sent to the L2ToL2CrossDomainMessenger using
account 0xa0Ee7A142d267C1f36714E4a8F75612F20a79720

--interop.delay value (default: 0) ($SUPERSIM_INTEROP_DELAY)
Delay before relaying messages sent to the L2ToL2CrossDomainMessenger

--logs.directory value ($SUPERSIM_LOGS_DIRECTORY)
Directory to store logs

--l1.host value (default: "127.0.0.1") ($SUPERSIM_L1_HOST)
Host address for the L1 instance

--l2.host value (default: "127.0.0.1") ($SUPERSIM_L2_HOST)
Host address for L2 instances

--odyssey.enabled (default: false) ($SUPERSIM_ODYSSEY_ENABLED)
Enable odyssey experimental features

--dependency.set value ($SUPERSIM_DEPENDENCY_SET)
Override local chain IDs in the dependency set.(format: '[901,902]' or '[]')

--log.level value (default: INFO) ($SUPERSIM_LOG_LEVEL)
The lowest log level that will be output

Expand All @@ -112,9 +136,6 @@ OPTIONS:
--log.pid (default: false) ($SUPERSIM_LOG_PID)
Show pid in the log

--odyssey.enabled (default: false) ($SUPERSIM_ODYSSEY_ENABLED)
Enable odyssey experimental features

--help, -h (default: false)
show help
```
Expand Down
47 changes: 33 additions & 14 deletions pages/app-developers/tutorials/supersim/reference/vanilla.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ categories:
- supersim
- devnets
- cli
is_imported_content: 'false'
is_imported_content: "false"
---

import { Callout, Steps } from 'nextra/components'
import { Callout, Steps } from "nextra/components"

# Vanilla mode

Expand Down Expand Up @@ -91,24 +91,50 @@ DESCRIPTION:

COMMANDS:
fork Locally fork a network in the superchain registry
docs Display available docs links
help, h Shows a list of commands or help for one command

GLOBAL OPTIONS:

--interop.autorelay (default: false) ($SUPERSIM_INTEROP_AUTORELAY)
Automatically relay messages sent to the L2ToL2CrossDomainMessenger using
account 0xa0Ee7A142d267C1f36714E4a8F75612F20a79720
--admin.port value (default: 8420) ($SUPERSIM_ADMIN_PORT)
Listening port for the admin server

--interop.delay value (default: 0) ($SUPERSIM_INTEROP_DELAY)
Delay before relaying messages sent to the L2ToL2CrossDomainMessenger
--interop.l2tol2cdm.override value ($SUPERSIM_INTEROP_L2TO2CDM_OVERRIDE)
Path to the L2ToL2CrossDomainMessenger build artifact that overrides
the default implementation

--l1.port value (default: 8545) ($SUPERSIM_L1_PORT)
Listening port for the L1 instance. `0` binds to any available port

--l2.count value (default: 2) ($SUPERSIM_L2_COUNT)
Number of L2s. Max of 5

--l2.starting.port value (default: 9545) ($SUPERSIM_L2_STARTING_PORT)
Starting port to increment from for L2 chains. `0` binds each chain to any
available port

--interop.autorelay (default: false) ($SUPERSIM_INTEROP_AUTORELAY)
Automatically relay messages sent to the L2ToL2CrossDomainMessenger using
account 0xa0Ee7A142d267C1f36714E4a8F75612F20a79720

--interop.delay value (default: 0) ($SUPERSIM_INTEROP_DELAY)
Delay before relaying messages sent to the L2ToL2CrossDomainMessenger

--logs.directory value ($SUPERSIM_LOGS_DIRECTORY)
Directory to store logs

--l1.host value (default: "127.0.0.1") ($SUPERSIM_L1_HOST)
Host address for the L1 instance

--l2.host value (default: "127.0.0.1") ($SUPERSIM_L2_HOST)
Host address for L2 instances

--odyssey.enabled (default: false) ($SUPERSIM_ODYSSEY_ENABLED)
Enable odyssey experimental features

--dependency.set value ($SUPERSIM_DEPENDENCY_SET)
Override local chain IDs in the dependency set.(format: '[901,902]' or '[]')

--log.color (default: false) ($SUPERSIM_LOG_COLOR)
Color the log output if in terminal mode

Expand All @@ -122,15 +148,8 @@ GLOBAL OPTIONS:
--log.pid (default: false) ($SUPERSIM_LOG_PID)
Show pid in the log

--logs.directory value ($SUPERSIM_LOGS_DIRECTORY)
Directory to store logs

--odyssey.enabled (default: false) ($SUPERSIM_ODYSSEY_ENABLED)
Enable odyssey experimental features

MISC


--help, -h (default: false)
show help

Expand Down