Skip to content

add how to run a sequencer docs #2229

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

Merged
Jason-W123 merged 18 commits into from
May 6, 2025
Merged

add how to run a sequencer docs #2229

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
ef9fa2f
add how to run a sequencer docs
Jason-W123 Apr 15, 2025
6aca27e
add warn for just for test
Jason-W123 Apr 15, 2025
7f49202
remove note
Jason-W123 Apr 15, 2025
6df8036
Update arbitrum-docs/run-arbitrum-node/partials/run-full-node/_option…
Jason-W123 Apr 17, 2025
1901239
Apply suggestions from code review
Jason-W123 Apr 17, 2025
11bde3d
Merge branch 'master' into add-run-sequencer
Jason-W123 Apr 18, 2025
75261be
Merge branch 'master' into add-run-sequencer
Jason-W123 Apr 27, 2025
7198e17
Apply suggestions from code review
Jason-W123 Apr 27, 2025
a2a4af5
Merge branch 'sequencer-docs' into add-run-sequencer
Jason-W123 Apr 29, 2025
4812b8a
format
Jason-W123 Apr 29, 2025
cb972fe
Apply suggestions from code review
Jason-W123 Apr 30, 2025
b50528c
Apply suggestions from code review
Jason-W123 Apr 30, 2025
db28bcf
Apply suggestions from code review
Jason-W123 May 5, 2025
8857bd3
Update arbitrum-docs/run-arbitrum-node/sequencer/04-run-sequencer-nod…
Jason-W123 May 5, 2025
0134600
fix
Jason-W123 May 5, 2025
e990cbe
Merge branch 'add-run-sequencer' of https://github.com/OffchainLabs/a…
Jason-W123 May 5, 2025
bdfb377
Merge branch 'sequencer-docs' into add-run-sequencer
Jason-W123 May 5, 2025
7cf78c4
refactor: rephrase --http.apitracing description field
anegg0 May 5, 2025
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
46 changes: 46 additions & 0 deletions ...ode/partials/run-full-node/_optional-orbit-sequencer-compatible-cli-partial.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
<section class='small-table'>

| Flag | Description |
| --------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |
| `--execution.rpc.classic-redirect=<RPC>` | Redirects archive requests for pre-nitro blocks to this RPC of an Arbitrum Classic node with an archive database. Only for Arbitrum One. | ```suggestion |
| `--execution.rpc.classic-redirect=<RPC>` | Redirects the archive requests for pre-nitro blocks to this RPC from an Arbitrum Classic node with an archive database. Only for Arbitrum One. |
| `--http.api` | Which APIs need to be opened over the HTTP-RPC interface. Default: `net,web3,eth,arb`. Add `debug` for tracing. |
| `--http.corsdomain` | Accepts cross origin requests from these comma-separated domains (browser enforced). |
| `--http.vhosts` | Accepts requests from these comma-separated virtual hostnames (server enforced). Default: `localhost`. Accepts `*`. |
| `--http.addr` | Address to bind RPC to. May require `0.0.0.0` for Docker networking. |
| `--execution.caching.archive` | Retains past block state. For archive nodes. |
| `--node.feed.input.url=<feed address>` | Default: `wss://<chainName>.arbitrum.io/feed`. ⚠️ One feed relay per datacenter is advised. See [feed relay guide](/run-arbitrum-node/sequencer/01-run-feed-relay.mdx). |
| `--execution.rpc.evm-timeout` | Default: `5s`. Timeout for `eth_call`. (`0` == no timeout). |
| `--execution.rpc.gas-cap` | Default: `50000000`. Gas cap for `eth_call`/`estimateGas`. (`0` = no cap). |
| `--execution.rpc.tx-fee-cap` | Default: `1`. Transaction fee cap (in ether) for RPC APIs. (`0` = no cap). |
| `--ipc.path` | Filename for IPC socket/pipe within datadir. Not supported on macOS. Note: the path is within the Docker container. |
| `--init.prune` | Prunes database before starting the node. It can be used for "full" or "validator" nodes. |
| `--init.url="<snapshot file>"` | (Non-Orbit Nitro nodes only) URL to download the genesis database from. Required only for the first startup of an Arbitrum One node. Reference to [snapshots](https://snapshot.arbitrum.foundation/index.html) and [archive node guide](/run-arbitrum-node/more-types/01-run-archive-node.mdx). |
| `--init.download-path="/path/to/dir"` | (Non-Orbit Nitro nodes only) Temporarily saves the downloaded database snapshot. Defaults to `/tmp/`. Used with `--init.url`. |
| `--node.batch-poster.post-4844-blobs` | Boolean. Default: `false`. Used to enable or disable the posting of transaction data using Blobs to Ethereum mainnet. If using calldata is more expensive and the parent chain supports `EIP4844` blobs, the batch poster will use blobs when this flag is set to `true`. Can be set to `true` or `false`. |
| `--node.batch-poster.ignore-blob-price` | Boolean. Default: `false`. If the parent chain supports `EIP4844` blobs and `ignore-blob-price` is set to `true`, the batch poster will use `EIP4844` blobs even if using calldata is cheaper. Can be set to `true` or `false`. |
| `--execution.sequencer.enable` | Act as sequencer and post to L1. |
| `--execution.sequencer.enable-profiling` | Enable CPU profiling and tracing. |
| `--execution.sequencer.expected-surplus-hard-threshold` | If the expected surplus is lower than this value, new incoming transactions will be denied (default "default"). |
| `--execution.sequencer.expected-surplus-soft-threshold` | If the expected surplus is lower than this value, warnings are posted (default "default"). |
| `--execution.sequencer.forwarder.connection-timeout` | Total time to wait before cancelling connection (default 30s). |
| `--execution.sequencer.forwarder.idle-connection-timeout` | Time until idle connections are closed (default 1m0s). |
| `--execution.sequencer.forwarder.max-idle-connections` | Maximum number of idle connections to keep open (default `100`). |
| `--execution.sequencer.forwarder.redis-url` | The recommended Redis URL to use as target. |
| `--execution.sequencer.forwarder.retry-interval` | Minimal time between update retries (default 100ms). |
| `--execution.sequencer.forwarder.update-interval` | Forwarding target update interval (default 1s). |
| `--execution.sequencer.max-acceptable-timestamp-delta` | Maximum acceptable time difference between the local time and the latest L1 block's timestamp (default 1h0m0s). |
| `--execution.sequencer.max-block-speed` | Minimum delay between blocks (sets a maximum speed of block production) (default 250ms). |
| `--execution.sequencer.max-revert-gas-reject` | Maximum gas executed in a revert for the sequencer to reject the transaction instead of posting it (anti-DOS). |
| `--execution.sequencer.max-tx-data-size` | Maximum transaction size the sequencer will accept (default `95000`). |
| `--execution.sequencer.nonce-cache-size` | Size of the transaction sender nonce cache (default `1024`). |
| `--execution.sequencer.nonce-failure-cache-expiry` | Maximum time to wait for a predecessor before rejecting a transaction whose nonce is too high (default 1s). |
| `--execution.sequencer.nonce-failure-cache-size` | Number of transactions whose nonce is too high to keep in memory while waiting for their predecessor (default `1024`). |
| `--execution.sequencer.queue-size` | Size of the pending transaction queue (default `1024`). |
| `--execution.sequencer.queue-timeout` | Maximum time a transaction can wait in a queue (default 12s). |
| `--execution.sequencer.sender-whitelist` | Comma-separated allowlist of authorized senders (if empty, every sender is allowed). |
| `--node.delayed-sequencer.finalize-distance` | Number of blocks in the past L1 block for the transaction to be considered final. This value is ignored when using merge finality. Default: `20`. |
| `--node.delayed-sequencer.require-full-finality` | Whether to wait for full finality before sequencing delayed messages. |
| `--node.delayed-sequencer.use-merge-finality` | Whether to use The Merge's notion of finality before sequencing delayed messages (default to `true`). |

</section>
Loading