Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
47 changes: 14 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@

Here are the software versions we use:

- MainNet: v2.3.2
- MainNet: v2.3.3

## <a name="testnet"/>Join TestNet
To start and run a testnet node, please click [**Join Testnet**](https://github.com/iotexproject/iotex-bootstrap/blob/master/README_testnet.md)
Expand All @@ -32,7 +32,7 @@ This is the recommended way to start an IoTeX node
1. Pull the docker image:

```
docker pull iotex/iotex-core:v2.3.2
docker pull iotex/iotex-core:v2.3.3
```

2. Set the environment with the following commands:
Expand All @@ -47,9 +47,9 @@ mkdir -p $IOTEX_HOME/data
mkdir -p $IOTEX_HOME/log
mkdir -p $IOTEX_HOME/etc

curl https://raw.githubusercontent.com/iotexproject/iotex-bootstrap/v2.3.2/config_mainnet.yaml > $IOTEX_HOME/etc/config.yaml
curl https://raw.githubusercontent.com/iotexproject/iotex-bootstrap/v2.3.2/genesis_mainnet.yaml > $IOTEX_HOME/etc/genesis.yaml
curl https://raw.githubusercontent.com/iotexproject/iotex-bootstrap/v2.3.2/trie.db.patch > $IOTEX_HOME/data/trie.db.patch
curl https://raw.githubusercontent.com/iotexproject/iotex-bootstrap/v2.3.3/config_mainnet.yaml > $IOTEX_HOME/etc/config.yaml
curl https://raw.githubusercontent.com/iotexproject/iotex-bootstrap/v2.3.3/genesis_mainnet.yaml > $IOTEX_HOME/etc/genesis.yaml
curl https://raw.githubusercontent.com/iotexproject/iotex-bootstrap/v2.3.3/trie.db.patch > $IOTEX_HOME/data/trie.db.patch
```

3. Edit `$IOTEX_HOME/etc/config.yaml`, look for `externalHost` and `producerPrivKey`, uncomment the lines and fill in your external IP and private key. If you leave `producerPrivKey` empty, your node will be assgined with a random key.
Expand All @@ -66,29 +66,10 @@ or download from another website:
curl -L https://storage.iotex.io/mainnet-data-snapshot-latest.tar.gz > $IOTEX_HOME/data.tar.gz
```

**We will update the baseline snapshot on the 1st of every month**.

5. Download the latest **incremental data** (Optional):

```
curl -L https://storage.iotex.io/mainnet-data-incr-latest.tar.gz > $IOTEX_HOME/incr.tar.gz
```

**We will update the incremental snapshot everyday**.

We also provide incremental packages from the **past 7 days**.
You can choose any day within this period.
For example, if you want to use the data from April 27, 2025, the incremental package file name will be `mainnet-data-incr-2025-04-27.tar.gz`.

The file named **latest** corresponds to today’s data.

To restore, you only need the full baseline package of the same month and the incremental package of the selected date.

6. Extract the data packages in the correct order.
It is essential to extract the baseline package first, followed by the incremental package.
5. Extract the data package:

```
tar -xzf $IOTEX_HOME/data.tar.gz -C $IOTEX_HOME/data/ && tar -xzf $IOTEX_HOME/incr.tar.gz -C $IOTEX_HOME/data/
tar -xzf $IOTEX_HOME/data.tar.gz -C $IOTEX_HOME/data/
```

For advanced users, there are three options to consider:
Expand All @@ -98,8 +79,8 @@ https://t.iotex.me/mainnet-data-with-idx-latest.

or download from another website:
```
curl -L https://storage.iotex.io/mainnet-data-with-idx-latest.tar.gz > $IOTEX_HOME/data.tar.gz
tar -xzf data.tar.gz
curl -L https://storage.iotex.io/mainnet-data-with-idx-latest.tar.gz > $IOTEX_HOME/data_index.tar.gz
tar -xzf data_index.tar.gz
```

> mainnet-data-with-idx-latest.tar.gz will be update on Monday every week
Expand All @@ -111,7 +92,7 @@ curl -L https://storage.iotex.io/poll.mainnet.tar.gz > $IOTEX_HOME/poll.tar.gz;

- Optional 3: If you want to sync the chain from 0 height and also fetching legacy delegate election data from Ethereum, please change the `gravityChainAPIs` in config.yaml to use your infura key with Ethereum archive mode supported or change the API endpoint to an Ethereum archive node which you can access.

5. Run the following command to start a node:
6. Run the following command to start a node:

```
docker run -d --restart on-failure --name iotex \
Expand All @@ -121,7 +102,7 @@ docker run -d --restart on-failure --name iotex \
-v=$IOTEX_HOME/log:/var/log:rw \
-v=$IOTEX_HOME/etc/config.yaml:/etc/iotex/config_override.yaml:ro \
-v=$IOTEX_HOME/etc/genesis.yaml:/etc/iotex/genesis.yaml:ro \
iotex/iotex-core:v2.3.2 \
iotex/iotex-core:v2.3.3 \
iotex-server \
-config-path=/etc/iotex/config_override.yaml \
-genesis-path=/etc/iotex/genesis.yaml
Expand All @@ -142,14 +123,14 @@ docker run -d --restart on-failure --name iotex \
-v=$IOTEX_HOME/log:/var/log:rw \
-v=$IOTEX_HOME/etc/config.yaml:/etc/iotex/config_override.yaml:ro \
-v=$IOTEX_HOME/etc/genesis.yaml:/etc/iotex/genesis.yaml:ro \
iotex/iotex-core:v2.3.2 \
iotex/iotex-core:v2.3.3 \
iotex-server \
-config-path=/etc/iotex/config_override.yaml \
-genesis-path=/etc/iotex/genesis.yaml \
-plugin=gateway
```

6. Ensure that TCP ports `4689` and `8080` are open on your firewall and load balancer (if applicable). Additionally, if you intend to use the node as a gateway, make sure the following ports are open:
7. Ensure that TCP ports `4689` and `8080` are open on your firewall and load balancer (if applicable). Additionally, if you intend to use the node as a gateway, make sure the following ports are open:
- `14014` for the IoTeX native gRPC API
- `15014` for the Ethereum JSON API
- `16014` for the Ethereum WebSocket
Expand All @@ -166,7 +147,7 @@ Same as [Join MainNet](#mainnet) step 2
```
git clone https://github.com/iotexproject/iotex-core.git
cd iotex-core
git checkout v2.3.2
git checkout v2.3.3

// optional
export GOPROXY=https://goproxy.io
Expand Down
43 changes: 17 additions & 26 deletions README_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

以下是当前我们使用的软件版本:

- 主网:v2.3.2
- 主网:v2.3.3

## <a name="testnet"/>加入测试网
如果你要启动节点加入测试网,请点击[**加入测试网**](https://github.com/iotexproject/iotex-bootstrap/blob/master/README_CN_testnet.md)
Expand All @@ -32,7 +32,7 @@
1. 提取(pull) docker镜像

```
docker pull iotex/iotex-core:v2.3.2
docker pull iotex/iotex-core:v2.3.3
```

2. 使用以下命令设置运行环境
Expand All @@ -47,9 +47,9 @@ mkdir -p $IOTEX_HOME/data
mkdir -p $IOTEX_HOME/log
mkdir -p $IOTEX_HOME/etc

curl https://raw.githubusercontent.com/iotexproject/iotex-bootstrap/v2.3.2/config_mainnet.yaml > $IOTEX_HOME/etc/config.yaml
curl https://raw.githubusercontent.com/iotexproject/iotex-bootstrap/v2.3.2/genesis_mainnet.yaml > $IOTEX_HOME/etc/genesis.yaml
curl https://raw.githubusercontent.com/iotexproject/iotex-bootstrap/v2.3.2/trie.db.patch > $IOTEX_HOME/data/trie.db.patch
curl https://raw.githubusercontent.com/iotexproject/iotex-bootstrap/v2.3.3/config_mainnet.yaml > $IOTEX_HOME/etc/config.yaml
curl https://raw.githubusercontent.com/iotexproject/iotex-bootstrap/v2.3.3/genesis_mainnet.yaml > $IOTEX_HOME/etc/genesis.yaml
curl https://raw.githubusercontent.com/iotexproject/iotex-bootstrap/v2.3.3/trie.db.patch > $IOTEX_HOME/data/trie.db.patch
```

3. 编辑 `$IOTEX_HOME/etc/config.yaml`, 查找 `externalHost` 和 `producerPrivKey`, 取消注释行并填写您的外部 IP 和私钥。如果`producerPrivKey`放空,你的节点将被分配一个随机密钥。
Expand All @@ -63,44 +63,35 @@ curl -L https://t.iotex.me/mainnet-data-snapshot-latest > $IOTEX_HOME/data.tar.g
curl -L https://storage.iotex.io/mainnet-data-snapshot-latest.tar.gz > $IOTEX_HOME/data.tar.gz
```

**我们将会在每月一日更新全量数据快照**。

5. 下载最新增量数据, 请运行以下命令(可选):
5. 解压数据包

```
curl -L https://storage.iotex.io/mainnet-data-incr-latest.tar.gz > $IOTEX_HOME/incr.tar.gz
```

**我们将会每天更新一次增量数据快照**。

同时我们提供7日内的增量包下载,你可以选择这期间中任意一天。比如你想使用2025.4.27日的数据, 那么增量包的文件名称为`mainnet-data-incr-2025-04-27.tar.gz`, latest为今日的数据。 还原的时候只需当月的全量包 + 当日的增量包即可。

6. 解压数据包, 请注意解压顺序, 必须先解压全量包, 再解压增量包

```
tar -xzf $IOTEX_HOME/data.tar.gz -C $IOTEX_HOME/data/ && tar -xzf $IOTEX_HOME/incr.tar.gz -C $IOTEX_HOME/data/
tar -xzf $IOTEX_HOME/data.tar.gz -C $IOTEX_HOME/data/
```

对于高级用户,可以考虑以下三个选项:

- 选项1:如果计划将节点作为[网关](#gateway)运行,请使用带有索引数据的快照:https://t.iotex.me/mainnet-data-with-idx-latest.
- 选项1:如果计划将节点作为[网关](#gateway)运行,还需要额外下载带有索引数据的快照:https://t.iotex.me/mainnet-data-with-idx-latest.

或从另一个站点下载:
```
curl -L https://storage.iotex.io/mainnet-data-with-idx-latest.tar.gz > $IOTEX_HOME/data.tar.gz
tar -xzf data.tar.gz
curl -L https://storage.iotex.io/mainnet-data-with-idx-latest.tar.gz > $IOTEX_HOME/data_index.tar.gz
tar -xzf data_index.tar.gz
```

> mainnet-data-with-idx-latest.tar.gz 在每周一会打新的压缩包


如果需要以 archive 模式运行提供全量历史数据,请转到 [Archive Node](./archive-node.md)

- 选择2:如果计划从 0 区块高度开始同步链上数据而不使用来自以太坊旧的节点代表数据,执行以下命令设置旧的节点代表数据:
```
curl -L https://storage.iotex.io/poll.mainnet.tar.gz > $IOTEX_HOME/poll.tar.gz; tar -xzf $IOTEX_HOME/poll.tar.gz --directory $IOTEX_HOME/data
```

- 选择3:如果计划从 0 区块高度开始同步链并从以太坊获取旧的节点代表数据,请更改 config.yaml 中的 `gravityChainAPIs`并在支持以太坊存档模式的情况下使用您的 infura 密钥,或将 API 端点更改为您有权限访问的以太坊存档节点。

7. 运行以下命令以启动节点:
6. 运行以下命令以启动节点:

```
docker run -d --restart on-failure --name iotex \
Expand All @@ -110,7 +101,7 @@ docker run -d --restart on-failure --name iotex \
-v=$IOTEX_HOME/log:/var/log:rw \
-v=$IOTEX_HOME/etc/config.yaml:/etc/iotex/config_override.yaml:ro \
-v=$IOTEX_HOME/etc/genesis.yaml:/etc/iotex/genesis.yaml:ro \
iotex/iotex-core:v2.3.2 \
iotex/iotex-core:v2.3.3 \
iotex-server \
-config-path=/etc/iotex/config_override.yaml \
-genesis-path=/etc/iotex/genesis.yaml
Expand All @@ -128,7 +119,7 @@ docker run -d --restart on-failure --name iotex \
-v=$IOTEX_HOME/log:/var/log:rw \
-v=$IOTEX_HOME/etc/config.yaml:/etc/iotex/config_override.yaml:ro \
-v=$IOTEX_HOME/etc/genesis.yaml:/etc/iotex/genesis.yaml:ro \
iotex/iotex-core:v2.3.2 \
iotex/iotex-core:v2.3.3 \
iotex-server \
-config-path=/etc/iotex/config_override.yaml \
-genesis-path=/etc/iotex/genesis.yaml \
Expand All @@ -148,7 +139,7 @@ docker run -d --restart on-failure --name iotex \
```
git clone https://github.com/iotexproject/iotex-core.git
cd iotex-core
git checkout v2.3.2
git checkout v2.3.3

// optional
export GOPROXY=https://goproxy.io
Expand Down
36 changes: 11 additions & 25 deletions README_CN_testnet.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

以下是当前我们使用的软件版本:

- 测试网:v2.3.2
- 测试网:v2.3.3

**Note**
如果你要启动节点加入主网,请点击[**加入主网**](https://github.com/iotexproject/iotex-bootstrap/blob/master/README_CN.md)
Expand All @@ -31,7 +31,7 @@
1. 提取(pull) docker镜像

```
docker pull iotex/iotex-core:v2.3.2
docker pull iotex/iotex-core:v2.3.3
```

2. 使用以下命令设置运行环境
Expand All @@ -46,39 +46,25 @@ mkdir -p $IOTEX_HOME/data
mkdir -p $IOTEX_HOME/log
mkdir -p $IOTEX_HOME/etc

curl https://raw.githubusercontent.com/iotexproject/iotex-bootstrap/v2.3.2/config_testnet.yaml > $IOTEX_HOME/etc/config.yaml
curl https://raw.githubusercontent.com/iotexproject/iotex-bootstrap/v2.3.2/genesis_testnet.yaml > $IOTEX_HOME/etc/genesis.yaml
curl https://raw.githubusercontent.com/iotexproject/iotex-bootstrap/v2.3.3/config_testnet.yaml > $IOTEX_HOME/etc/config.yaml
curl https://raw.githubusercontent.com/iotexproject/iotex-bootstrap/v2.3.3/genesis_testnet.yaml > $IOTEX_HOME/etc/genesis.yaml
```

3. 编辑 `$IOTEX_HOME/etc/config.yaml`, 查找 `externalHost` 和 `producerPrivKey`, 取消注释行并填写您的外部 IP 和私钥。如果`producerPrivKey`放空,你的节点将被分配一个随机密钥。

4. 下载全量数据快照, 请运行以下命令:
```
curl -L https://t.iotex.me/testnet-data-snapshot-latest > $IOTEX_HOME/data.tar.gz
tar -xzf data.tar.gz
```
或者 请运行以下命令
```
curl -L https://storage.iotex.io/testnet-data-snapshot-latest.tar.gz > $IOTEX_HOME/data.tar.gz
tar -xzf data.tar.gz
```

**我们将会在每月一日更新全量数据快照**。

5. 下载最新增量数据, 请运行以下命令(可选):
5. 解压数据包

```
curl -L https://storage.iotex.io/testnet-data-incr-latest.tar.gz > $IOTEX_HOME/incr.tar.gz
```

**我们将会每天更新一次增量数据快照**。

同时我们提供7日内的增量包下载,你可以选择这期间中任意一天。比如你想使用2025.4.27日的数据, 那么增量包的文件名称为`testnet-data-incr-2025-04-27.tar.gz`, latest为今日的数据。 还原的时候只需当月的全量包 + 当日的增量包即可。

6. 解压数据包, 请注意解压顺序, 必须先解压全量包, 再解压增量包

```
tar -xzf $IOTEX_HOME/data.tar.gz -C $IOTEX_HOME/data/ && tar -xzf $IOTEX_HOME/incr.tar.gz -C $IOTEX_HOME/data/
tar -xzf $IOTEX_HOME/data.tar.gz -C $IOTEX_HOME/data/
```

对于高级用户,可以考虑以下三个选项:
Expand All @@ -100,7 +86,7 @@ curl -L https://storage.iotex.io/poll.testnet.tar.gz > $IOTEX_HOME/poll.tar.gz;

- 选择3:如果计划从 0 区块高度开始同步链并从以太坊获取旧的节点代表数据,请更改 config.yaml 中的 `gravityChainAPIs`并在支持以太坊存档模式的情况下使用您的 infura 密钥,或将 API 端点更改为您有权限访问的以太坊存档节点。

5. 运行以下命令以启动节点:
6. 运行以下命令以启动节点:

```
docker run -d --restart on-failure --name iotex \
Expand All @@ -110,7 +96,7 @@ docker run -d --restart on-failure --name iotex \
-v=$IOTEX_HOME/log:/var/log:rw \
-v=$IOTEX_HOME/etc/config.yaml:/etc/iotex/config_override.yaml:ro \
-v=$IOTEX_HOME/etc/genesis.yaml:/etc/iotex/genesis.yaml:ro \
iotex/iotex-core:v2.3.2 \
iotex/iotex-core:v2.3.3 \
iotex-server \
-config-path=/etc/iotex/config_override.yaml \
-genesis-path=/etc/iotex/genesis.yaml
Expand All @@ -128,14 +114,14 @@ docker run -d --restart on-failure --name iotex \
-v=$IOTEX_HOME/log:/var/log:rw \
-v=$IOTEX_HOME/etc/config.yaml:/etc/iotex/config_override.yaml:ro \
-v=$IOTEX_HOME/etc/genesis.yaml:/etc/iotex/genesis.yaml:ro \
iotex/iotex-core:v2.3.2 \
iotex/iotex-core:v2.3.3 \
iotex-server \
-config-path=/etc/iotex/config_override.yaml \
-genesis-path=/etc/iotex/genesis.yaml \
-plugin=gateway
```

6. 确保您的防火墙和负载均衡器(如果有)上的TCP端口4689, 8080(14014如果节点启用了网关)已打开。
7. 确保您的防火墙和负载均衡器(如果有)上的TCP端口4689, 8080(14014如果节点启用了网关)已打开。

## <a name="testnet_native"/>不使用Docker加入测试网

Expand All @@ -148,7 +134,7 @@ docker run -d --restart on-failure --name iotex \
```
git clone https://github.com/iotexproject/iotex-core.git
cd iotex-core
git checkout v2.3.2
git checkout v2.3.3

// optional
export GOPROXY=https://goproxy.io
Expand Down
Loading