Skip to content

Commit e324786

Browse files
committed
update archive doc and snapshot url
1 parent a62809a commit e324786

6 files changed

Lines changed: 52 additions & 137 deletions

File tree

README.md

Lines changed: 8 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -57,52 +57,24 @@ curl https://raw.githubusercontent.com/iotexproject/iotex-bootstrap/v2.3.3/trie.
5757
4. Start from a **baseline snapshot** (rather than sync from the genesis block), run the following commands:
5858

5959
```
60-
curl -L https://t.iotex.me/mainnet-data-snapshot-latest > $IOTEX_HOME/data.tar.gz
60+
curl -L https://storage.iotex.io/mainnet-data-e-20251228-042459-core.tar.gz > $IOTEX_HOME/data.tar.gz
6161
```
6262

63-
or download from another website:
63+
5. Extract the data package:
6464

6565
```
66-
curl -L https://storage.iotex.io/mainnet-data-snapshot-latest.tar.gz > $IOTEX_HOME/data.tar.gz
67-
```
68-
69-
**We will update the baseline snapshot on the 1st of every month**.
70-
71-
5. Download the latest **incremental data** (Optional):
72-
73-
```
74-
curl -L https://storage.iotex.io/mainnet-data-incr-latest.tar.gz > $IOTEX_HOME/incr.tar.gz
75-
```
76-
77-
**We will update the incremental snapshot everyday**.
78-
79-
We also provide incremental packages from the **past 7 days**.
80-
You can choose any day within this period.
81-
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`.
82-
83-
The file named **latest** corresponds to today’s data.
84-
85-
To restore, you only need the full baseline package of the same month and the incremental package of the selected date.
86-
87-
6. Extract the data packages in the correct order.
88-
It is essential to extract the baseline package first, followed by the incremental package.
89-
90-
```
91-
tar -xzf $IOTEX_HOME/data.tar.gz -C $IOTEX_HOME/data/ && tar -xzf $IOTEX_HOME/incr.tar.gz -C $IOTEX_HOME/data/
66+
tar -xzf $IOTEX_HOME/data.tar.gz -C $IOTEX_HOME/data/
9267
```
9368

9469
For advanced users, there are three options to consider:
9570

9671
- Option 1: If you plan to run your node as a [gateway](#gateway), please use the snapshot with index data:
97-
https://t.iotex.me/mainnet-data-with-idx-latest.
98-
99-
or download from another website:
10072
```
101-
curl -L https://storage.iotex.io/mainnet-data-with-idx-latest.tar.gz > $IOTEX_HOME/data.tar.gz
102-
tar -xzf data.tar.gz
73+
curl -L https://storage.iotex.io/mainnet-data-e-20251228-042459-gateway.tar.gz > $IOTEX_HOME/data_index.tar.gz
74+
tar -xzf data_index.tar.gz
10375
```
10476

105-
> mainnet-data-with-idx-latest.tar.gz will be update on Monday every week
77+
If you need to run your node in archive mode to provide full historical data, please go to [Archive Node](./archive-node.md).
10678

10779
- Optional 2: If you only want to sync chain data from 0 height without relaying on legacy delegate election data from Ethereum, you can setup legacy delegate election data with following command:
10880
```bash
@@ -111,7 +83,7 @@ curl -L https://storage.iotex.io/poll.mainnet.tar.gz > $IOTEX_HOME/poll.tar.gz;
11183

11284
- 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.
11385

114-
5. Run the following command to start a node:
86+
6. Run the following command to start a node:
11587

11688
```
11789
docker run -d --restart on-failure --name iotex \
@@ -149,7 +121,7 @@ docker run -d --restart on-failure --name iotex \
149121
-plugin=gateway
150122
```
151123

152-
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:
124+
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:
153125
- `14014` for the IoTeX native gRPC API
154126
- `15014` for the Ethereum JSON API
155127
- `16014` for the Ethereum WebSocket

README_CN.md

Lines changed: 8 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -56,42 +56,24 @@ curl https://raw.githubusercontent.com/iotexproject/iotex-bootstrap/v2.3.3/trie.
5656

5757
4. 下载全量数据快照, 请运行以下命令:
5858
```
59-
curl -L https://t.iotex.me/mainnet-data-snapshot-latest > $IOTEX_HOME/data.tar.gz
59+
curl -L https://storage.iotex.io/mainnet-data-e-20251228-042459-core.tar.gz > $IOTEX_HOME/data.tar.gz
6060
```
61-
或者 请运行以下命令
62-
```
63-
curl -L https://storage.iotex.io/mainnet-data-snapshot-latest.tar.gz > $IOTEX_HOME/data.tar.gz
64-
```
65-
66-
**我们将会在每月一日更新全量数据快照**
67-
68-
5. 下载最新增量数据, 请运行以下命令(可选):
69-
70-
```
71-
curl -L https://storage.iotex.io/mainnet-data-incr-latest.tar.gz > $IOTEX_HOME/incr.tar.gz
72-
```
73-
74-
**我们将会每天更新一次增量数据快照**
7561

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

8064
```
81-
tar -xzf $IOTEX_HOME/data.tar.gz -C $IOTEX_HOME/data/ && tar -xzf $IOTEX_HOME/incr.tar.gz -C $IOTEX_HOME/data/
65+
tar -xzf $IOTEX_HOME/data.tar.gz -C $IOTEX_HOME/data/
8266
```
8367

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

86-
- 选项1:如果计划将节点作为[网关](#gateway)运行,请使用带有索引数据的快照:https://t.iotex.me/mainnet-data-with-idx-latest.
87-
88-
或从另一个站点下载:
70+
- 选项1:如果计划将节点作为[网关](#gateway)运行,还需要额外下载带有索引数据的快照
8971
```
90-
curl -L https://storage.iotex.io/mainnet-data-with-idx-latest.tar.gz > $IOTEX_HOME/data.tar.gz
91-
tar -xzf data.tar.gz
72+
curl -L https://storage.iotex.io/mainnet-data-e-20251228-042459-gateway.tar.gz > $IOTEX_HOME/data_index.tar.gz
73+
tar -xzf data_index.tar.gz
9274
```
9375

94-
> mainnet-data-with-idx-latest.tar.gz 在每周一会打新的压缩包
76+
如果需要以 archive 模式运行提供全量历史数据,请转到 [Archive Node](./archive-node.md)
9577

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

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

103-
7. 运行以下命令以启动节点:
85+
6. 运行以下命令以启动节点:
10486

10587
```
10688
docker run -d --restart on-failure --name iotex \

README_CN_testnet.md

Lines changed: 8 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -53,54 +53,33 @@ curl https://raw.githubusercontent.com/iotexproject/iotex-bootstrap/v2.3.3/genes
5353
3. 编辑 `$IOTEX_HOME/etc/config.yaml`, 查找 `externalHost``producerPrivKey`, 取消注释行并填写您的外部 IP 和私钥。如果`producerPrivKey`放空,你的节点将被分配一个随机密钥。
5454

5555
4. 下载全量数据快照, 请运行以下命令:
56-
```
57-
curl -L https://t.iotex.me/testnet-data-snapshot-latest > $IOTEX_HOME/data.tar.gz
58-
tar -xzf data.tar.gz
59-
```
60-
或者 请运行以下命令
61-
```
62-
curl -L https://storage.iotex.io/testnet-data-snapshot-latest.tar.gz > $IOTEX_HOME/data.tar.gz
63-
tar -xzf data.tar.gz
64-
```
65-
66-
**我们将会在每月一日更新全量数据快照**
67-
68-
5. 下载最新增量数据, 请运行以下命令(可选):
6956

7057
```
71-
curl -L https://storage.iotex.io/testnet-data-incr-latest.tar.gz > $IOTEX_HOME/incr.tar.gz
58+
curl -L https://storage.iotex.io/testnet-data-e-20260105-042459-core.tar.gz > $IOTEX_HOME/data.tar.gz
7259
```
7360

74-
**我们将会每天更新一次增量数据快照**
75-
76-
同时我们提供7日内的增量包下载,你可以选择这期间中任意一天。比如你想使用2025.4.27日的数据, 那么增量包的文件名称为`testnet-data-incr-2025-04-27.tar.gz`, latest为今日的数据。 还原的时候只需当月的全量包 + 当日的增量包即可。
77-
78-
6. 解压数据包, 请注意解压顺序, 必须先解压全量包, 再解压增量包
61+
5. 解压数据包
7962

8063
```
81-
tar -xzf $IOTEX_HOME/data.tar.gz -C $IOTEX_HOME/data/ && tar -xzf $IOTEX_HOME/incr.tar.gz -C $IOTEX_HOME/data/
64+
tar -xzf $IOTEX_HOME/data.tar.gz -C $IOTEX_HOME/data/
8265
```
8366

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

86-
- 选项1:如果计划将节点作为[网关](#gateway)运行,请使用带有索引数据的快照:https://t.iotex.me/testnet-data-with-idx-latest.
87-
88-
或从另一个站点下载:
69+
- 选项1:如果计划将节点作为[网关](#gateway)运行,请额外下载带有索引数据的快照
8970
```
90-
curl -L https://storage.iotex.io/testnet-data-with-idx-latest.tar.gz > $IOTEX_HOME/data.tar.gz
91-
tar -xzf data.tar.gz
71+
curl -L https://storage.iotex.io/testnet-data-e-20260105-042459-gateway.tar.gz > $IOTEX_HOME/data_index.tar.gz
72+
tar -xzf data_index.tar.gz
9273
```
9374

94-
> testnet-data-with-idx-latest.tar.gz 在每周一会打新的压缩包
95-
9675
- 选择2:如果计划从 0 区块高度开始同步链上数据而不使用来自以太坊旧的节点代表数据,执行以下命令设置旧的节点代表数据:
9776
```
9877
curl -L https://storage.iotex.io/poll.testnet.tar.gz > $IOTEX_HOME/poll.tar.gz; tar -xzf $IOTEX_HOME/poll.tar.gz --directory $IOTEX_HOME/data
9978
```
10079

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

103-
5. 运行以下命令以启动节点:
82+
6. 运行以下命令以启动节点:
10483

10584
```
10685
docker run -d --restart on-failure --name iotex \
@@ -135,7 +114,7 @@ docker run -d --restart on-failure --name iotex \
135114
-plugin=gateway
136115
```
137116

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

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

README_testnet.md

Lines changed: 7 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -55,63 +55,32 @@ curl https://raw.githubusercontent.com/iotexproject/iotex-bootstrap/v2.3.3/genes
5555
4. Start from a **baseline snapshot** (rather than sync from the genesis block), run the following commands:
5656

5757
```
58-
curl -L https://t.iotex.me/testnet-data-snapshot-latest > $IOTEX_HOME/data.tar.gz
59-
tar -xzf data.tar.gz
58+
curl -L https://storage.iotex.io/testnet-data-e-20260105-042459-core.tar.gz > $IOTEX_HOME/data.tar.gz
6059
```
6160

62-
or download from another website:
63-
```
64-
curl -L https://storage.iotex.io/testnet-data-snapshot-latest.tar.gz > $IOTEX_HOME/data.tar.gz
65-
tar -xzf data.tar.gz
66-
```
67-
68-
**We will update the baseline snapshot on the 1st of every month**.
69-
70-
5. Download the latest **incremental data** (Optional):
71-
72-
```
73-
curl -L https://storage.iotex.io/testnet-data-incr-latest.tar.gz > $IOTEX_HOME/incr.tar.gz
74-
```
75-
76-
**We will update the incremental snapshot everyday**.
77-
78-
We also provide incremental packages from the **past 7 days**.
79-
You can choose any day within this period.
80-
For example, if you want to use the data from April 27, 2025, the incremental package file name will be `testnet-data-incr-2025-04-27.tar.gz`.
81-
82-
The file named **latest** corresponds to today’s data.
83-
84-
To restore, you only need the full baseline package of the same month and the incremental package of the selected date.
85-
86-
6. Extract the data packages in the correct order.
87-
It is essential to extract the baseline package first, followed by the incremental package.
61+
5. Extract the data package:
8862

8963
```
90-
tar -xzf $IOTEX_HOME/data.tar.gz -C $IOTEX_HOME/data/ && tar -xzf $IOTEX_HOME/incr.tar.gz -C $IOTEX_HOME/data/
64+
tar -xzf $IOTEX_HOME/data.tar.gz -C $IOTEX_HOME/data/
9165
```
9266

9367
For advanced users, there are three options to consider:
9468

9569
- Option 1: If you plan to run your node as a [gateway](#gateway), please use the snapshot with index data:
96-
https://t.iotex.me/testnet-data-with-idx-latest.
97-
98-
or download from another website:
9970

10071
```
101-
curl -L https://storage.iotex.io/testnet-data-with-idx-latest.tar.gz > $IOTEX_HOME/data.tar.gz
102-
tar -xzf data.tar.gz
72+
curl -L https://storage.iotex.io/testnet-data-e-20260105-042459-gateway.tar.gz > $IOTEX_HOME/data_index.tar.gz
73+
tar -xzf data_index.tar.gz
10374
```
10475

105-
> testnet-data-with-idx-latest.tar.gz will be update on Monday every week
106-
10776
- Optional 2: If you only want to sync chain data from 0 height without relaying on legacy delegate election data from Ethereum, you can setup legacy delegate election data with following command:
10877
```bash
10978
curl -L https://storage.iotex.io/poll.testnet.tar.gz > $IOTEX_HOME/poll.tar.gz; tar -xzf $IOTEX_HOME/poll.tar.gz --directory $IOTEX_HOME/data
11079
```
11180

11281
- 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.
11382

114-
5. Run the following command to start a node:
83+
6. Run the following command to start a node:
11584

11685
```
11786
docker run -d --restart on-failure --name iotex \
@@ -148,7 +117,7 @@ docker run -d --restart on-failure --name iotex \
148117
-plugin=gateway
149118
```
150119

151-
6. Make sure TCP ports 4689, 8080 (also 14014 if used) are open on your firewall and load balancer (if any).
120+
7. Make sure TCP ports 4689, 8080 (also 14014 if used) are open on your firewall and load balancer (if any).
152121

153122
## <a name="testnet_native"/>Join Testnet without using Docker
154123
This is not the preferred way to start an IoTeX node

archive-node.md

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,7 @@ time the tx was originally executed.
88

99
This archive node is an **optimized version** with significant performance improvements and storage optimizations. However, please note that:
1010

11-
- **Data files from previous archive node versions are NOT compatible** with this optimized version
12-
- If you are upgrading from a previous archive node setup, you **cannot** reuse existing data files
11+
- **Data files from any previous archive node builds (including earlier test/archive branches) are NOT compatible**, so you **cannot** reuse existing data files
1312
- You **MUST** either:
1413
- **Download the provided snapshot data** (recommended for faster setup)
1514
- Or **perform a complete resync from genesis** (time-consuming but ensures full verification)
@@ -19,9 +18,12 @@ The following instrcutions will guide you through setting up an IoTeX archive no
1918
- [Important Notice - Optimized Archive Node Version](#important-notice---optimized-archive-node-version)
2019
- [System Requirements](#system-requirements)
2120
- [Prepare Home Directory](#prepare-home-directory)
22-
- [Download Data(Optional)](#download-data)
21+
- [Download Data](#download-data)
2322
- [Running Node using Docker](#running-node-using-docker)
2423
- [Running Node using Binary](#running-node-using-binary)
24+
- [Pre-Requisites](#pre-requisites)
25+
- [Build Binary](#build-binary)
26+
- [Start Node](#start-node)
2527

2628

2729
## <a name="system"/>System Requirements
@@ -63,10 +65,16 @@ need to download and uncompress this file.
6365
In the $IOTEX_HOME folder, run the following commands:
6466
```
6567
#download the data files and uncompress it
66-
curl -LO https://storage.iotex.io/mainnet-archive-data-e-20250625.tar.gz
67-
tar -xzf mainnet-archive-data-e-20250625.tar.gz
68+
curl -LO https://storage.iotex.io/mainnet-data-e-20251228-042459-core.tar.gz
69+
tar -xzf mainnet-data-e-20251228-042459-core.tar.gz
70+
71+
curl -LO https://storage.iotex.io/mainnet-data-e-20251228-042459-gateway.tar.gz
72+
tar -xzf mainnet-data-e-20251228-042459-gateway.tar.gz
73+
74+
curl -LO https://storage.iotex.io/mainnet-data-e-20251228-042459-trie-history.tar.gz
75+
tar -xzf mainnet-data-e-20251228-042459-trie-history.tar.gz
6876
```
69-
>Note: the snapshot has a size of 300GB at this moment.
77+
>Note: the snapshot has a size of 450GB at this moment.
7078
Please take measures (for example use `nohup` at the front) to prevent possible interruption of the download process.
7179

7280
After successful download and uncompress operations, the $IOTEX_HOME/data folder
@@ -138,7 +146,7 @@ docker run -d --restart on-failure --name iotex \
138146
-v=$IOTEX_HOME/log:/var/iotex-archive/log:rw \
139147
-v=$IOTEX_HOME/etc/config.yaml:/etc/iotex/config_override.yaml:ro \
140148
-v=$IOTEX_HOME/etc/genesis.yaml:/etc/iotex/genesis.yaml:ro \
141-
iotex/iotex-core:archive \
149+
iotex/iotex-core:v2.3.3 \
142150
iotex-server \
143151
-config-path=/etc/iotex/config_override.yaml \
144152
-genesis-path=/etc/iotex/genesis.yaml \
@@ -181,7 +189,7 @@ git clone https://github.com/iotexproject/iotex-core.git
181189
cd iotex-core
182190
183191
#checkout the code branch for archive node
184-
git checkout origin/archive
192+
git checkout v2.3.3
185193
186194
#build binary
187195
make build

changelog/v2.3.3-release-note.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,14 @@ restart your node with the new v2.3.3 image.
1313
### 1. Archive Mode Support
1414
v2.3.3 officially introduces **Archive Mode**, which stores complete historical state data for all blocks. This mode is essential for applications that need to query historical blockchain states at any point in time.
1515

16+
To enable archive mode, set `chain.historyIndexPath` in `config.yaml` to the directory where historical state files will be stored.
17+
18+
1619
### 2. Prune Mode Support
1720
v2.3.3 introduces **Prune Mode**, which maintains only the most recent 256 blocks of historical state data. This mode significantly reduces storage requirements while still providing recent state access for most operational needs.
1821

22+
To enable prune mode, first enable archive mode, then set `chain.historyBlockRetention` in `config.yaml` to the number of recent blocks whose state you want to retain.
23+
1924
### 3. Block Synchronization Optimization
2025
Significant improvements have been made to the block synchronization mechanism to enhance sync speed, reliability, and network efficiency.
2126

0 commit comments

Comments
 (0)