How to run a full node for Xai chain
Last updated
Last updated
Note: For steps on how to run a Xai Sentry Node (unrelated to running a full node for Xai chain), go .
This how-to provides step-by-step instructions for running a full Xai node on your local machine.
Latest Docker Image: offchainlabs/nitro-node:v2.3.3-6a1c1a7
The parent-chain
argument needs to provide a standard RPC endpoint for an EVM node, whether self-hosted or obtained from a node service provider:
NOTE
rate-limit connections. To avoid hitting a bottleneck, you can run a local node for the parent chain (Arbitrum) or rely on third-party RPC providers.
Xai is the child chain and the required parameters are chain.info-json
and chain.name
--chain.info-json
is a JSON string that contains required information about Xai chain.
An example of chain.info-json
is available in the next section.
--chain.name
is a mandatory flag that needs to match the chain name used in --chain.info-json
:
For Anytrust chains, you need to to add the following flags to the command or configuration:
And:
Or:
Please note: the RPC
/websocket
protocol requires some ports to be enabled, you can use the following flags:
--ws.port=8548
--ws.addr=0.0.0.0
--ws.origins=\*
When running a Docker image, an external volume should be mounted to persist the database across restarts. The mount point inside the Docker image should be /home/user/.arbitrum
Example:
Ensure that /some/local/dir/arbitrum
already exists otherwise the directory might be created with root
as owner, and the Docker container won't be able to write to it
When using the flag --chain.info-json=<Xai Chain's chain info>
, replace <Xai Chain's chain info>
with the specific chain info
JSON string of the Xai chain for which you wish to run the node:
Example:
When shutting down the Docker image, it is important to allow a graceful shutdown so that the current state can be saved to disk. Here is an example of how to do a graceful shutdown of all Docker images currently running
The Docker image is configured to run as non-root UID 1000
. If you are running Linux or macOS and you are getting permission errors when trying to run the Docker image, run this command to allow all users to update the persistent folders:
Nitro nodes can be configured to receive real time ordered transactions from the sequencer feed. If you don't set the feed input url, your node will listen to the parent chain's inbox contract to get the ordered transactions, which will cause your node to be unable to synchronize the latest state.
Set the following configurations to your fullnode to make it can receive the sequencer feed:
After that, your node can synchronize the latest state from the sequencer feed.
(Chain owners only) In order for a node to read the sequencer feed, the chain's sequencer needs to be configured with the following parameters:
We show here a list of the parameters that are most commonly used when running your Xai node. You can also use the flag --help
for a full comprehensive list of the available parameters.
1. chain.info-json
2. chain.name
3. AnyTrust chains
RPC
/http
8547
RPC
/websocket
8548
Sequencer Feed
9642
--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.
--execution.forwarding-target=<RPC>
Defaults to the L2 Sequencer RPC based on provided L1 and L2 chain IDs.
--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. 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 and archive node guide.
--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
.
--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
.
RAM: 16 GB
CPU: 4 core CPU
Storage: 1 TB