Skip to content

Commit 11d77c0

Browse files
sbvegansbvegan
authored
Merge pull request #1669 from ethereum-optimism/kevin/361-configurable-dependency-set
Add missing commands and help text to supersim docs
2 parents 97a7edd + bfdd6bd commit 11d77c0

File tree

2 files changed

+63
-23
lines changed

2 files changed

+63
-23
lines changed

‎pages/app-developers/tutorials/supersim/reference/fork.mdx‎

Lines changed: 30 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,10 @@ categories:
1212
- mainnet
1313
- testnet
1414
- cli
15-
is_imported_content: 'false'
15+
is_imported_content: "false"
1616
---
1717

18-
import { Callout, Steps } from 'nextra/components'
18+
import { Callout, Steps } from "nextra/components"
1919

2020
# Fork mode
2121

@@ -68,9 +68,11 @@ OPTIONS:
6868
L1 height to fork the superchain (bounds L2 time). `0` for latest
6969
7070
--chains value ($SUPERSIM_CHAINS)
71-
chains to fork in the superchain, mainnet options: [base, lyra, metal, mode, op,
72-
orderly, race, tbn, zora]. In order to replace the public rpc endpoint for a
73-
chain, specify the ($SUPERSIM_RPC_URL_<CHAIN>) env variable. i.e
71+
chains to fork in the superchain, mainnet options: [arena-z, automata, base,
72+
bob, cyber, ethernity, funki, hashkeychain, ink, lisk, lyra, metal, mint, mode,
73+
op, orderly, polynomial, race, redstone, shape, soneium, sseed, swan, swell, tbn,
74+
unichain, worldchain, xterio-eth, zora]. In order to replace the public rpc endpoint
75+
for a chain, specify the ($SUPERSIM_RPC_URL_<CHAIN>) env variable. i.e
7476
SUPERSIM_RPC_URL_OP=http://optimism-mainnet.infura.io/v3/<API-KEY>
7577
7678
--network value (default: "mainnet") ($SUPERSIM_NETWORK)
@@ -82,23 +84,45 @@ OPTIONS:
8284
--interop.enabled (default: true) ($SUPERSIM_INTEROP_ENABLED)
8385
enable interop predeploy and functionality
8486
87+
--admin.port value (default: 8420) ($SUPERSIM_ADMIN_PORT)
88+
Listening port for the admin server
89+
90+
--interop.l2tol2cdm.override value ($SUPERSIM_INTEROP_L2TO2CDM_OVERRIDE)
91+
Path to the L2ToL2CrossDomainMessenger build artifact that overrides
92+
the default implementation
93+
8594
--l1.port value (default: 8545) ($SUPERSIM_L1_PORT)
8695
Listening port for the L1 instance. `0` binds to any available port
8796
97+
--l2.count value (default: 2) ($SUPERSIM_L2_COUNT)
98+
Number of L2s. Max of 5
99+
88100
--l2.starting.port value (default: 9545) ($SUPERSIM_L2_STARTING_PORT)
89101
Starting port to increment from for L2 chains. `0` binds each chain to any
90102
available port
91103
92104
--interop.autorelay (default: false) ($SUPERSIM_INTEROP_AUTORELAY)
93105
Automatically relay messages sent to the L2ToL2CrossDomainMessenger using
94106
account 0xa0Ee7A142d267C1f36714E4a8F75612F20a79720
95-
107+
96108
--interop.delay value (default: 0) ($SUPERSIM_INTEROP_DELAY)
97109
Delay before relaying messages sent to the L2ToL2CrossDomainMessenger
98110
99111
--logs.directory value ($SUPERSIM_LOGS_DIRECTORY)
100112
Directory to store logs
101113
114+
--l1.host value (default: "127.0.0.1") ($SUPERSIM_L1_HOST)
115+
Host address for the L1 instance
116+
117+
--l2.host value (default: "127.0.0.1") ($SUPERSIM_L2_HOST)
118+
Host address for L2 instances
119+
120+
--odyssey.enabled (default: false) ($SUPERSIM_ODYSSEY_ENABLED)
121+
Enable odyssey experimental features
122+
123+
--dependency.set value ($SUPERSIM_DEPENDENCY_SET)
124+
Override local chain IDs in the dependency set.(format: '[901,902]' or '[]')
125+
102126
--log.level value (default: INFO) ($SUPERSIM_LOG_LEVEL)
103127
The lowest log level that will be output
104128
@@ -112,9 +136,6 @@ OPTIONS:
112136
--log.pid (default: false) ($SUPERSIM_LOG_PID)
113137
Show pid in the log
114138
115-
--odyssey.enabled (default: false) ($SUPERSIM_ODYSSEY_ENABLED)
116-
Enable odyssey experimental features
117-
118139
--help, -h (default: false)
119140
show help
120141
```

‎pages/app-developers/tutorials/supersim/reference/vanilla.mdx‎

Lines changed: 33 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@ categories:
1010
- supersim
1111
- devnets
1212
- cli
13-
is_imported_content: 'false'
13+
is_imported_content: "false"
1414
---
1515

16-
import { Callout, Steps } from 'nextra/components'
16+
import { Callout, Steps } from "nextra/components"
1717

1818
# Vanilla mode
1919

@@ -91,24 +91,50 @@ DESCRIPTION:
9191
9292
COMMANDS:
9393
fork Locally fork a network in the superchain registry
94+
docs Display available docs links
9495
help, h Shows a list of commands or help for one command
9596
9697
GLOBAL OPTIONS:
9798
98-
--interop.autorelay (default: false) ($SUPERSIM_INTEROP_AUTORELAY)
99-
Automatically relay messages sent to the L2ToL2CrossDomainMessenger using
100-
account 0xa0Ee7A142d267C1f36714E4a8F75612F20a79720
99+
--admin.port value (default: 8420) ($SUPERSIM_ADMIN_PORT)
100+
Listening port for the admin server
101101
102-
--interop.delay value (default: 0) ($SUPERSIM_INTEROP_DELAY)
103-
Delay before relaying messages sent to the L2ToL2CrossDomainMessenger
102+
--interop.l2tol2cdm.override value ($SUPERSIM_INTEROP_L2TO2CDM_OVERRIDE)
103+
Path to the L2ToL2CrossDomainMessenger build artifact that overrides
104+
the default implementation
104105
105106
--l1.port value (default: 8545) ($SUPERSIM_L1_PORT)
106107
Listening port for the L1 instance. `0` binds to any available port
107108
109+
--l2.count value (default: 2) ($SUPERSIM_L2_COUNT)
110+
Number of L2s. Max of 5
111+
108112
--l2.starting.port value (default: 9545) ($SUPERSIM_L2_STARTING_PORT)
109113
Starting port to increment from for L2 chains. `0` binds each chain to any
110114
available port
111115
116+
--interop.autorelay (default: false) ($SUPERSIM_INTEROP_AUTORELAY)
117+
Automatically relay messages sent to the L2ToL2CrossDomainMessenger using
118+
account 0xa0Ee7A142d267C1f36714E4a8F75612F20a79720
119+
120+
--interop.delay value (default: 0) ($SUPERSIM_INTEROP_DELAY)
121+
Delay before relaying messages sent to the L2ToL2CrossDomainMessenger
122+
123+
--logs.directory value ($SUPERSIM_LOGS_DIRECTORY)
124+
Directory to store logs
125+
126+
--l1.host value (default: "127.0.0.1") ($SUPERSIM_L1_HOST)
127+
Host address for the L1 instance
128+
129+
--l2.host value (default: "127.0.0.1") ($SUPERSIM_L2_HOST)
130+
Host address for L2 instances
131+
132+
--odyssey.enabled (default: false) ($SUPERSIM_ODYSSEY_ENABLED)
133+
Enable odyssey experimental features
134+
135+
--dependency.set value ($SUPERSIM_DEPENDENCY_SET)
136+
Override local chain IDs in the dependency set.(format: '[901,902]' or '[]')
137+
112138
--log.color (default: false) ($SUPERSIM_LOG_COLOR)
113139
Color the log output if in terminal mode
114140
@@ -122,15 +148,8 @@ GLOBAL OPTIONS:
122148
--log.pid (default: false) ($SUPERSIM_LOG_PID)
123149
Show pid in the log
124150
125-
--logs.directory value ($SUPERSIM_LOGS_DIRECTORY)
126-
Directory to store logs
127-
128-
--odyssey.enabled (default: false) ($SUPERSIM_ODYSSEY_ENABLED)
129-
Enable odyssey experimental features
130-
131151
MISC
132152
133-
134153
--help, -h (default: false)
135154
show help
136155

0 commit comments

Comments
 (0)