RELEASE-NOTES-3.0.1.md
1 # About this release 2 3 [This][this-release] is a backwards-compatible bug fix release for the Fortuna release 3.0.0. 4 It: 5 * Solves an issue with loading old serialization of 6 `channel_force_progress_tx` from the database and updating it to the new serialization format. 7 8 [this-release]: https://github.com/aeternity/aeternity/releases/tag/v3.0.1 9 10 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). 11 Troubleshooting of common issues is documented [in the wiki](https://github.com/aeternity/aeternity/wiki/Troubleshooting). 12 13 The instructions below describe: 14 * [How to retrieve the released software for running a node](#retrieve-the-software-for-running-a-node); 15 * [How to install a node](#install-node); 16 * [How to join the mainnet](#join-the-mainnet). 17 * [How to join the testnet](#join-the-testnet). 18 19 ## Retrieve the software for running a node 20 21 You can run a node by either: 22 * Installing the published [release binary][this-release] corresponding to your platform; or 23 * Running the published [Docker image `aeternity/aeternity`][docker]; or 24 * [Building a release binary from source][build]. 25 26 [docker]: https://github.com/aeternity/aeternity/blob/v3.0.1/docs/docker.md 27 [build]: https://github.com/aeternity/aeternity/blob/v3.0.1/docs/build.md 28 29 The instructions for configuring the node using the Docker image are in [the dedicated separate document][docker]. 30 31 The node user API is documented: 32 * HTTP API endpoints are specified [online in swagger.yaml][swagger-yaml]; 33 * 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). 34 * The JSON version can be obtained from a running node using the endpoint `/api`. 35 * An interactive visualization of the same specification is available [online][swagger-ui]. 36 * WebSocket API endpoints are [specified online][api-doc]; 37 * The intended usage of the user API (HTTP and WebSocket) is [documented online][api-doc]. 38 39 [swagger-yaml]: https://github.com/aeternity/aeternity/blob/v3.0.1/config/swagger.yaml 40 [swagger-ui]: https://aeternity.github.io/api-docs/?config=https://raw.githubusercontent.com/aeternity/aeternity/v3.0.1/apps/aehttp/priv/swagger.json 41 [api-doc]: https://github.com/aeternity/protocol/blob/aeternity-node-v3.0.1/node/api/README.md 42 43 ## Install node 44 45 The instructions for installing a node using a release binary are in [the dedicated separate document](../../docs/installation.md). 46 47 For installation of a node using the Docker image, please refer to [its documentation online][docker]. 48 49 ## Join the mainnet 50 51 ### Mainnet seed nodes 52 53 The release package comes preconfigured with seed nodes. Here is example subset of the seed nodes: 54 55 * aenode://pp_2L8A5vSjnkLtfFNpJNgP9HbmGLD7ZAGFxoof47N8L4yyLAyyMi@18.136.37.63:3015 56 * aenode://pp_2gPZjuPnJnTVEbrB9Qgv7f4MdhM4Jh6PD22mB2iBA1g7FRvHTk@52.220.198.72:3015 57 * aenode://pp_tVdaaX4bX54rkaVEwqE81hCgv6dRGPPwEVsiZk41GXG1A4gBN@3.16.242.93:3015 58 * aenode://pp_2mwr9ikcyUDUWTeTQqdu8WJeQs845nYPPqjafjcGcRWUx4p85P@3.17.30.101:3015 59 * aenode://pp_2CAJwwmM2ZVBHYFB6na1M17roQNuRi98k6WPFcoBMfUXvsezVU@13.58.177.66:3015 60 * aenode://pp_7N7dkCbg39MYzQv3vCrmjVNfy6QkoVmJe3VtiZ3HRncvTWAAX@13.53.114.199:3015 61 * aenode://pp_22FndjTkMMXZ5gunCTUyeMPbgoL53smqpM4m1Jz5fVuJmPXm24@13.53.149.181:3015 62 * aenode://pp_Xgsqi4hYAjXn9BmrU4DXWT7jURy2GoBPmrHfiCoDVd3UPQYcU@13.53.164.121:3015 63 * aenode://pp_vTDXS3HJrwJecqnPqX3iRxKG5RBRz9MdicWGy8p9hSdyhAY4S@13.53.77.98:3015 64 65 ### Inspect the mainnet 66 67 Here are example nodes that can be used to inspect current top block and see information about e.g. height or target: 68 69 * http://18.136.37.63:3013/v2/blocks/top 70 * http://52.220.198.72:3013/v2/blocks/top 71 * http://13.53.114.199:3013/v2/blocks/top 72 * http://13.53.149.181:3013/v2/blocks/top 73 74 ## Join the testnet 75 76 This section describes how to run a node as part of the testnet - the public test network of nodes - by using the release binary. 77 78 For running a node as part of the testnet by using the Docker image, please consult [its documentation][docker] in addition to this section. 79 80 ### Testnet seed nodes 81 82 In order to join testnet reconfigure seed nodes in the release package: 83 84 * aenode://pp_QU9CvhAQH56a2kA15tCnWPRJ2srMJW8ZmfbbFTAy7eG4o16Bf@52.10.46.160:3015 85 * aenode://pp_27xmgQ4N1E3QwHyoutLtZsHW5DSW4zneQJ3CxT5JbUejxtFuAu@13.250.162.250:3015 86 * aenode://pp_DMLqy7Zuhoxe2FzpydyQTgwCJ52wouzxtHWsPGo51XDcxc5c8@13.53.161.215:3015 87 88 ### Inspect the testnet 89 90 The core nodes of the public test network are accessible from the Internet. 91 92 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: 93 * http://52.10.46.160:3013/v2/blocks/top 94 * http://13.250.162.250:3013/v2/blocks/top 95 * http://13.53.161.215:3013/v2/blocks/top 96 97 ### Setup your node 98 99 Setting up your node consists of: 100 * Configuring your node - see instructions in [the dedicated separate document](../../docs/configuration.md); 101 * Starting your node and verifying it works as expected - see instructions in [the dedicated separate document](../../docs/operation.md).