Setup mainnet RPC#
xlayer-erigon is a fork of Erigon, optimized for syncing with the X Layer network.
Minimum System Requirements#
-
128 GB RAM
-
8 core CPU
-
500 GB Storage ( IOPS > 20000 required )
Start RPC Node#
Preparation#
Important: A Golang environment with version 1.24 or above is required.
Build#
# Pull the code from GitHub，
git clone https://github.com/okx/xlayer-erigon.git
# If you are not aware of the latest version, you can use the following Github address to obtain the latest version：
https://github.com/okx/xlayer-erigon/releases
# Enter the xlayer-erigon directory
cd xlayer-erigon
# Then based on https://github.com/okx/xlayer-erigon/releases Switch to the corresponding branch based on the latest version found on
git checkout ${latest_release}
# Build the project. This process takes about 1 minute. After completion, the binary file will be located in the build/bin directory of the project, and the binary file name is: cdk-erigon.
make cdk-erigon
# If you want to generate an image, you can use the following methods：
make build-docker
Modfiy Config#
Create a configuration file named xlayerconfig-mainnet.yaml in the root directory of the project. Then, paste the following content into the file.
Please note: There are two fields that need to be updated:
datadir— specify your desired data directory path.zkevm.l1_rpc_url— provide the correct L1 RPC URL.For production environments, you should request an official RPC endpoint from your organization.
datadir: ${your-data-dir}
chain: xlayer-mainnet
http: true
private.api.addr: localhost:9091
zkevm.l2-chain-id: 196
zkevm.l2-sequencer-rpc-url: https://rpc.xlayer.tech
zkevm.l2-datastreamer-url: stream.xlayer.tech:8800
zkevm.l1-rpc-url: ${your-l1-rpc-url}
zkevm.l1-chain-id: 1
zkevm.address-sequencer: "0xAF9d27ffe4d51eD54AC8eEc78f2785D7E11E5ab1"
zkevm.address-zkevm: "0x2B0ee28D4D51bC9aDde5E58E295873F61F4a0507"
zkevm.address-rollup: "0x5132A183E9F3CB7C848b0AAC5Ae0c4f0491B7aB2"
zkevm.address-ger-manager: "0x580bda1e7A0CFAe92Fa7F6c20A3794F169CE3CFb"
zkevm.l1-rollup-id: 3
zkevm.l1-first-block: 19218658
zkevm.l1-block-range: 2000
zkevm.l1-query-delay: 1000
zkevm.datastream-version: 3
zkevm.increment-tree-always: false
zkevm.rebuild-tree-after: 10000000
zkevm.get-logs-timeout: 86400s
zkevm.get-logs-retries: 72
http.api: [eth, debug, net, trace, web3, erigon, zkevm]
http.addr: 0.0.0.0
http.port: 8545
Start Erigon Node By binary#
To start the node, run the binary located at ./build/bin/cdk-erigon.
Use the --config flag to specify the path to the configuration file you want to use.
./build/bin/cdk-erigon --config="./xlayerconfig-mainnet.yaml"
# If you see the following content in your log, the startup is successful：
INFO[07-26|10:25:05.503] Mapped network port proto=udp extport=30304 intport=30304 interface="UPNP IGDv1-IP1"
INFO[07-26|10:25:13.963] [1/16 L1Syncer] L1 Blocks processed progress (amounts): 64000/3358713 (1%)
INFO[07-26|10:25:23.963] [1/16 L1Syncer] L1 Blocks processed progress (amounts): 140000/3358713 (4%)
INFO[07-26|10:25:33.960] [1/16 L1Syncer] L1 Blocks processed progress (amounts): 222000/3358713 (6%)
Preload the files into the OS page cache#
Preloading the node's data into the OS page cache reduces cold disk I/O during state reads and block execution. By warming frequently accessed files and key ranges in memory, it can improve block synchronization efficiency and execution speed, enhance overall node and RPC performance.
Compile vmtouch#
git clone https://github.com/okx/vmtouch.git
cd vmtouch
make
sudo make install
Map disk files into memory#
vmtouch -vt ${your-data-dir}