-
Notifications
You must be signed in to change notification settings - Fork 428
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.
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
Merged
Changes from 3 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 6aca27e
add warn for just for test
Jason-W123 7f49202
remove note
Jason-W123 6df8036
Update arbitrum-docs/run-arbitrum-node/partials/run-full-node/_option…
Jason-W123 1901239
Apply suggestions from code review
Jason-W123 11bde3d
Merge branch 'master' into add-run-sequencer
Jason-W123 75261be
Merge branch 'master' into add-run-sequencer
Jason-W123 7198e17
Apply suggestions from code review
Jason-W123 a2a4af5
Merge branch 'sequencer-docs' into add-run-sequencer
Jason-W123 4812b8a
format
Jason-W123 cb972fe
Apply suggestions from code review
Jason-W123 b50528c
Apply suggestions from code review
Jason-W123 db28bcf
Apply suggestions from code review
Jason-W123 8857bd3
Update arbitrum-docs/run-arbitrum-node/sequencer/04-run-sequencer-nod…
Jason-W123 0134600
fix
Jason-W123 e990cbe
Merge branch 'add-run-sequencer' of https://github.com/OffchainLabs/a…
Jason-W123 bdfb377
Merge branch 'sequencer-docs' into add-run-sequencer
Jason-W123 7cf78c4
refactor: rephrase --http.apitracing description field
anegg0 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
45 changes: 45 additions & 0 deletions
45
...ode/partials/run-full-node/_optional-orbit-sequencer-compatible-cli-partial.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| <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 archive database. Only for Arbitrum One. | | ||
| | `--http.api` | Offered APIs 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. | | ||
Jason-W123 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| | `--init.prune` | Prunes database before starting the node. Can be "full" or "validator". | | ||
| | `--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 L1 Ethereum. If using calldata is more expensive and if the parent chain supports EIP4844 blobs, the batch poster will use blobs when this flag is set to `true`. Can be `true` or `false`. | | ||
Jason-W123 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| | `--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 `true` or `false`. | | ||
Jason-W123 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| | `--execution.sequencer.enable` | Act and post to L1 as sequencer. | | ||
Jason-W123 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| | `--execution.sequencer.enable-profiling` | Enable CPU profiling and tracing. | | ||
| | `--execution.sequencer.expected-surplus-hard-threshold` | If expected surplus is lower than this value, new incoming transactions will be denied (default "default"). | | ||
Jason-W123 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| | `--execution.sequencer.expected-surplus-soft-threshold` | If expected surplus is lower than this value, warnings are posted (default "default"). | | ||
Jason-W123 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| | `--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 Redis URL to recommend target via. | | ||
|
||
| | `--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 tx sender nonce cache (default 1024). | | ||
Jason-W123 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| | `--execution.sequencer.nonce-failure-cache-expiry` | Maximum amount of time to wait for a predecessor before rejecting a tx with nonce too high (default 1s). | | ||
Jason-W123 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| | `--execution.sequencer.nonce-failure-cache-size` | Number of transactions with too high of a nonce to keep in memory while waiting for their predecessor (default 1024). | | ||
| | `--execution.sequencer.queue-size` | Size of the pending tx queue (default 1024). | | ||
Jason-W123 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| | `--execution.sequencer.queue-timeout` | Maximum amount of time transaction can wait in queue (default 12s). | | ||
Jason-W123 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| | `--execution.sequencer.sender-whitelist` | Comma separated whitelist of authorized senders (if empty, everyone is allowed). | | ||
Jason-W123 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| | `--node.delayed-sequencer.finalize-distance` | How many blocks in the past L1 block is considered final (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 true). | | ||
Jason-W123 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| </section> | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.