v2.4 is a minor update but not backward compatible with
v2.3.X. This update replaces the current API based communication with WebSockets which means peers on versions before
v2.4.0 will not be able to communicate.
Upgrade time: low - upgrading to
v2.4only requires minimal configuration changes.
Complexity: high - P2P communication was rewritten and
@arkecosystem/cryptoexports were modified.
Risk: high -
v2.4is not backward compatible with
v2.3and includes breaking changes for P2P communication.
Migrating from v2.3 to v2.4
v2.4 is fairly straightforward if you follow the instructions. Even though we try to ensure backward compatibility (BC) as much as possible, sometimes it is not possible or very complicated to avoid it and still create a good solution to a problem.
Upgrading a complex software project always comes at the risk of breaking something, so make sure you have a backup.
After upgrading you should check whether your application still works as expected and no plugins are broken. See the following notes on which changes to consider when upgrading from one version to another.
Be sure to complete all of the following steps before you continue to upgrade with the
ark update command to the latest version.
Step 1. Add
- Locate the
- Add this package addition line before it (see below):
- Save the changes. Your configuration file should look like this:
Step 2. Add
It’s especially important to register this plugin as this is what the Desktop and Mobile wallet will use to communicate with nodes.
Add this package addition line after it (see below):
Save the changes. Your configuration file should look like this:
If you are using default firewall don’t forget to open port
core-wallet-apiaccessible to wallets.
You can check your ufw rules by running
sudo ufw status
Step 3. Update
@arkecosystem/core-p2pentry and replace the block like shown below.
If you have a
whitelistproperty in the
core-p2pentry, make sure to remove this too. Starting with v2.4 this property will filter out any peers that don’t match the whitelist.
Save the changes.
Step 4. Update
@arkecosystem/core-forgerentry and replace the block like shown below.
Save the changes.
Step 5. Update
This only applies if you have the JSON-RPC registered in your
plugins.js file, otherwise skip this section.
Step 6. Running the Update Command via the
Do not run any of the mentioned commands with
sudo unless explicitly stated.
Make sure that all previous steps were successfully completed before running the
ark update command via the cli.
To update to v2.4 run the following command:
This section addresses developers and lists notable changes during this version upgrade. For more details make sure you checkout the CHANGELOG document. The following breaking changes where introduced in v2.4:
The fee statistic are no longer included in the response of the
node/configuration endpoint. They can be retrieved through a new dedicated endpoint instead,
node/fees. More information on that endpoint can be found here.
If you happen to experience any issues please open an issue with a detailed description of the problem, steps to reproduce it and info about your environment.