About this release

This is a maintenance release. It includes the following changes:

• Localnet setup (docker-compose) has been improved by adding node API compatibility of the internal endpoints, e.g. /v2/debug is now available without prefix. The /internal prefix is now deprecated.

• Off-chain updates can now still be completed even if one of the Websocket clients is off-line. If the originator manages to get the initial update request co-signed 'out-of-band', the responding FSM will proceed as if it received a successful signing response from the client.

• Localnet (docker-compose) configuration has ben moved out to its own repository https://github.com/aeternity/localnet

This release is backward compatible with previous v4.* releases.

Please join the mainnet by following the instructions below, and let us know if you have any problems by opening a ticket. Troubleshooting of common issues is documented in the wiki.

The instructions below describe:

• How to retrieve the released software for running a node;

• How to install a node;

• How to join the mainnet.

• How to join the testnet.

Retrieve the software for running a node

You can run a node by either:

• Installing the published release binary corresponding to your platform; or

• Running the published Docker image aeternity/aeternity; or

• Building a release binary from source.

The instructions for configuring the node using the Docker image are in the dedicated separate document.

The node user API is documented:

• HTTP API endpoints are specified online in swagger.yaml;

  • A JSON version of the same specification is located in the node at path lib/aehttp-*/priv/swagger.json (you will need to amend the wildcard * placeholder in the path with the version).

  • The JSON version can be obtained from a running node using the endpoint /api.

  • An interactive visualization of the same specification is available online.

• WebSocket API endpoints are specified online;

• The intended usage of the user API (HTTP and WebSocket) is documented online.

Install node

The instructions for installing a node using a release binary are in the dedicated separate document.

For installation of a node using the Docker image, please refer to the documentation online.

Join the mainnet

In order to join the mainnet follow the operation instructions to run the node with default configuration as mainnet is the default network.

To join the mainnet by using the Docker image, please refer to docker documentation.

Mainnet seed nodes

The release package comes preconfigured with seed nodes. Here is example subset of the seed nodes:

• aenode://pp_2L8A5vSjnkLtfFNpJNgP9HbmGLD7ZAGFxoof47N8L4yyLAyyMi@18.136.37.63:3015

• aenode://pp_2gPZjuPnJnTVEbrB9Qgv7f4MdhM4Jh6PD22mB2iBA1g7FRvHTk@52.220.198.72:3015

• aenode://[email protected]:3015

• aenode://pp_2mwr9ikcyUDUWTeTQqdu8WJeQs845nYPPqjafjcGcRWUx4p85P@3.17.30.101:3015

• aenode://pp_2CAJwwmM2ZVBHYFB6na1M17roQNuRi98k6WPFcoBMfUXvsezVU@13.58.177.66:3015

• aenode://pp_7N7dkCbg39MYzQv3vCrmjVNfy6QkoVmJe3VtiZ3HRncvTWAAX@13.53.114.199:3015

• aenode://pp_22FndjTkMMXZ5gunCTUyeMPbgoL53smqpM4m1Jz5fVuJmPXm24@13.53.149.181:3015

• aenode://pp_Xgsqi4hYAjXn9BmrU4DXWT7jURy2GoBPmrHfiCoDVd3UPQYcU@13.53.164.121:3015

• aenode://[email protected]:3015

Inspect the mainnet

Here are example nodes that can be used to inspect current top block and see information about e.g. height or target:

• http://18.136.37.63:3013/v2/blocks/top

• http://52.220.198.72:3013/v2/blocks/top

• http://13.53.114.199:3013/v2/blocks/top

• http://13.53.149.181:3013/v2/blocks/top

Join the testnet

In order to join the testnet change the Network ID in node configuration file to ae_uat.

To join the testnet by using the Docker image, please refer to the docker documentation.

Testnet seed nodes

The release package comes preconfigured with testnet seed nodes, this is the list:

• aenode://pp_QU9CvhAQH56a2kA15tCnWPRJ2srMJW8ZmfbbFTAy7eG4o16Bf@52.10.46.160:3015

• aenode://pp_27xmgQ4N1E3QwHyoutLtZsHW5DSW4zneQJ3CxT5JbUejxtFuAu@13.250.162.250:3015

• aenode://pp_DMLqy7Zuhoxe2FzpydyQTgwCJ52wouzxtHWsPGo51XDcxc5c8@13.53.161.215:3015

Inspect the testnet

The core nodes of the public test network are accessible from the Internet.

Information, e.g. height, of the top block of the longest chain as seen by these core nodes of the testnet can be obtained by opening in the browser any of the following URLs:

• http://52.10.46.160:3013/v2/blocks/top

• http://13.250.162.250:3013/v2/blocks/top

• http://13.53.161.215:3013/v2/blocks/top

Setup your node

Setting up your node consists of:

• Configuring your node - see instructions in the dedicated separate document;

• Starting your node and verifying it works as expected - see instructions in the dedicated separate document.