RELEASE-NOTES-3.2.0.md
1 # About this release 2 3 [This][this-release] is a maintenance release. 4 It: 5 * Ensures that synchronous jsonrpc calls to asynchronous methods get an "ok" response instead of timing out. 6 * Fine-tunes error handling of slash and settle in the WebSocket channels API. 7 * Automatically configures testnet seed peers and BRI beneficiary accounts based on network_id configuration. 8 * Enables configuring the network in the console by passing `-network_id` argument i.e. `bin/aeternity start -network_id ae_uat`. 9 * Adds public peer key to status API endpoint. 10 * Adds top block height and top key block hash to status API endpoint. 11 12 [this-release]: https://github.com/aeternity/aeternity/releases/tag/v3.2.0 13 14 This release is backward compatible with previous `v3.1.*` and `v3.0.1` releases. 15 16 Please join the mainnet by following the instructions below, and let us know if you have any problems by [opening a ticket](https://github.com/aeternity/aeternity/issues). 17 Troubleshooting of common issues is documented [in the wiki](https://github.com/aeternity/aeternity/wiki/Troubleshooting). 18 19 The instructions below describe: 20 * [How to retrieve the released software for running a node](#retrieve-the-software-for-running-a-node); 21 * [How to install a node](#install-node); 22 * [How to join the mainnet](#join-the-mainnet). 23 * [How to join the testnet](#join-the-testnet). 24 25 ## Retrieve the software for running a node 26 27 You can run a node by either: 28 * Installing the published [release binary][this-release] corresponding to your platform; or 29 * Running the published [Docker image `aeternity/aeternity`][docker]; or 30 * [Building a release binary from source][build]. 31 32 [docker]: https://github.com/aeternity/aeternity/blob/v3.2.0/docs/docker.md 33 [build]: https://github.com/aeternity/aeternity/blob/v3.2.0/docs/build.md 34 35 The instructions for configuring the node using the Docker image are in [the dedicated separate document][docker]. 36 37 The node user API is documented: 38 * HTTP API endpoints are specified [online in swagger.yaml][swagger-yaml]; 39 * 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). 40 * The JSON version can be obtained from a running node using the endpoint `/api`. 41 * An interactive visualization of the same specification is available [online][swagger-ui]. 42 * WebSocket API endpoints are [specified online][api-doc]; 43 * The intended usage of the user API (HTTP and WebSocket) is [documented online][api-doc]. 44 45 [swagger-yaml]: https://github.com/aeternity/aeternity/blob/v3.2.0/config/swagger.yaml 46 [swagger-ui]: https://aeternity.github.io/api-docs/?config=https://raw.githubusercontent.com/aeternity/aeternity/v3.2.0/apps/aehttp/priv/swagger.json 47 [api-doc]: https://github.com/aeternity/protocol/blob/aeternity-node-v3.2.0/node/api/README.md 48 49 ## Install node 50 51 The instructions for installing a node using a release binary are in [the dedicated separate document](../../docs/installation.md). 52 53 For installation of a node using the Docker image, please refer to the [documentation online][docker]. 54 55 ## Join the mainnet 56 57 In order to join the mainnet follow the [operation instructions](../../docs/operation.md) to run the node with default configuration as mainnet is the default network. 58 59 To join the mainnet by using the Docker image, please refer to [docker documentation][docker]. 60 61 ### Mainnet seed nodes 62 63 The release package comes preconfigured with seed nodes. Here is example subset of the seed nodes: 64 65 * aenode://pp_2L8A5vSjnkLtfFNpJNgP9HbmGLD7ZAGFxoof47N8L4yyLAyyMi@18.136.37.63:3015 66 * aenode://pp_2gPZjuPnJnTVEbrB9Qgv7f4MdhM4Jh6PD22mB2iBA1g7FRvHTk@52.220.198.72:3015 67 * aenode://pp_tVdaaX4bX54rkaVEwqE81hCgv6dRGPPwEVsiZk41GXG1A4gBN@3.16.242.93:3015 68 * aenode://pp_2mwr9ikcyUDUWTeTQqdu8WJeQs845nYPPqjafjcGcRWUx4p85P@3.17.30.101:3015 69 * aenode://pp_2CAJwwmM2ZVBHYFB6na1M17roQNuRi98k6WPFcoBMfUXvsezVU@13.58.177.66:3015 70 * aenode://pp_7N7dkCbg39MYzQv3vCrmjVNfy6QkoVmJe3VtiZ3HRncvTWAAX@13.53.114.199:3015 71 * aenode://pp_22FndjTkMMXZ5gunCTUyeMPbgoL53smqpM4m1Jz5fVuJmPXm24@13.53.149.181:3015 72 * aenode://pp_Xgsqi4hYAjXn9BmrU4DXWT7jURy2GoBPmrHfiCoDVd3UPQYcU@13.53.164.121:3015 73 * aenode://pp_vTDXS3HJrwJecqnPqX3iRxKG5RBRz9MdicWGy8p9hSdyhAY4S@13.53.77.98:3015 74 75 ### Inspect the mainnet 76 77 Here are example nodes that can be used to inspect current top block and see information about e.g. height or target: 78 79 * http://18.136.37.63:3013/v2/blocks/top 80 * http://52.220.198.72:3013/v2/blocks/top 81 * http://13.53.114.199:3013/v2/blocks/top 82 * http://13.53.149.181:3013/v2/blocks/top 83 84 ## Join the testnet 85 86 In order to join the testnet change the [Network ID](../../docs/configuration.md#network-id) in node configuration file to `ae_uat`. 87 88 To join the testnet by using the Docker image, please refer to the [docker documentation][docker]. 89 90 ### Testnet seed nodes 91 92 The release package comes preconfigured with testnet seed nodes, this is the list: 93 94 * aenode://pp_QU9CvhAQH56a2kA15tCnWPRJ2srMJW8ZmfbbFTAy7eG4o16Bf@52.10.46.160:3015 95 * aenode://pp_27xmgQ4N1E3QwHyoutLtZsHW5DSW4zneQJ3CxT5JbUejxtFuAu@13.250.162.250:3015 96 * aenode://pp_DMLqy7Zuhoxe2FzpydyQTgwCJ52wouzxtHWsPGo51XDcxc5c8@13.53.161.215:3015 97 98 ### Inspect the testnet 99 100 The core nodes of the public test network are accessible from the Internet. 101 102 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: 103 * http://52.10.46.160:3013/v2/blocks/top 104 * http://13.250.162.250:3013/v2/blocks/top 105 * http://13.53.161.215:3013/v2/blocks/top 106 107 ### Setup your node 108 109 Setting up your node consists of: 110 * Configuring your node - see instructions in [the dedicated separate document](../../docs/configuration.md); 111 * Starting your node and verifying it works as expected - see instructions in [the dedicated separate document](../../docs/operation.md).