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