|
| 1 | +# v1.8.4 patch |
| 2 | +In the past 2 weeks certain IoTeX nodes run into an issue of failing to sync with |
| 3 | +most recent blocks. After careful analysis it was root-caused to an incorrect state |
| 4 | +in memory storage, which may occur when a node restarts. |
| 5 | + |
| 6 | +## Impact |
| 7 | +A node could be affected by this issue if it has restarted sometime between Sep 30 |
| 8 | +and Oct 08, 2002. It will get stuck on a certain height if it happens. |
| 9 | + |
| 10 | +## Solution |
| 11 | +This issue has been fixed in the v1.8.4 release. A script tool has been provided |
| 12 | +to download a patch file, which would correctly restore the internal state. |
| 13 | + |
| 14 | +This fix is **not** a hard-fork, and is **only** needed one-time. After applying |
| 15 | +the patch, the node will be able to successfully restart and continue to run. It |
| 16 | +does **not** need to rely on this patch in the future restarts. |
| 17 | + |
| 18 | +Follow steps below to apply the patch and upgrade to v1.8.4. |
| 19 | + |
| 20 | +## Apply the patch |
| 21 | +1. First, stop your IoTeX node and remove the docker container. This is **needed** |
| 22 | +to ensure that the patch fix can be applied correctly and the node can successfully |
| 23 | +restart later. |
| 24 | +2. Download the patch script: |
| 25 | +``` |
| 26 | +curl https://raw.githubusercontent.com/iotexproject/iotex-bootstrap/v1.8.4/184_patch/patch.sh > ./patch.sh |
| 27 | +``` |
| 28 | +3. `chmod a+x ./patch.sh` |
| 29 | +4. Make sure you have the `$IOTEX_HOME` environment variable properly set. It is |
| 30 | +the full-node home directory containing all node settings and data files in the |
| 31 | +`/etc`, `/data`, `/log` sub-directories. By default, it is `/iotex-var`, you can |
| 32 | +check it by `echo $IOTEX_HOME`. If it is not set, when you run the script in the |
| 33 | +next step you will be asked to input it, make sure you enter the right directory |
| 34 | +using absolute path. |
| 35 | +5. Run the script `./patch.sh`, it will download the proper patch file, you will |
| 36 | +see message like: |
| 37 | +``` |
| 38 | +download /iotex-var/data/19901069.patch success, please upgrade to v1.8.4 and restart iotex-server |
| 39 | +``` |
| 40 | + |
| 41 | +## Upgrade to v1.8.4 |
| 42 | +Now with the correct path file in place, it's time to upgrade to v1.8.4. |
| 43 | +``` |
| 44 | +docker pull iotex/iotex-core:v1.8.4 |
| 45 | +``` |
| 46 | +Restart your node as usual, but use `iotex/iotex-core:v1.8.4` image in the docker |
| 47 | +script/commandline. Your node should apply the patch file, and then continue to |
| 48 | +run normally. |
0 commit comments