RELEASE-NOTES-4.1.0.md
1 # About this release 2 3 [This][this-release] is a maintenance release. 4 It: 5 * Makes State Channel FSM more robust to timeouts. 6 If one of the peers refuses signing the closing transaction while the channel is not active then the request may timeout without killing the FSM. 7 * Improves State Channel FSM to compute transaction fees in a dynamic manner. 8 This will usually result in smaller fees being paid by participants. 9 * Enhances the State Channel user experience adding info regarding timeouts. 10 The process that handles the state for the State Channel client in the node 11 has a list of different timeouts. They define different time frames for 12 certain events to be completed. Running out of time is a violation of the 13 off-chain protocol so if it happens - the connection is closed and it is up 14 to the State Channel client how to proceed next. This enhances user 15 experience adding a new info message for the timeouts. 16 * Enables State Channels Websocket clients to reconnect and to re-attach to the FSM, using a special signed offchain transaction. While the client is disconnected, the corresponding FSM will reject requests that require signatures. 17 18 [this-release]: https://github.com/aeternity/aeternity/releases/tag/v4.1.0 19 20 This release is backward compatible with previous `v4.*` releases. 21 22 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). 23 Troubleshooting of common issues is documented [in the wiki](https://github.com/aeternity/aeternity/wiki/Troubleshooting). 24 25 The instructions below describe: 26 * [How to retrieve the released software for running a node](#retrieve-the-software-for-running-a-node); 27 * [How to install a node](#install-node); 28 * [How to join the mainnet](#join-the-mainnet). 29 * [How to join the testnet](#join-the-testnet). 30 31 ## Retrieve the software for running a node 32 33 You can run a node by either: 34 * Installing the published [release binary][this-release] corresponding to your platform; or 35 * Running the published [Docker image `aeternity/aeternity`][docker]; or 36 * [Building a release binary from source][build]. 37 38 [docker]: https://github.com/aeternity/aeternity/blob/v4.1.0/docs/docker.md 39 [build]: https://github.com/aeternity/aeternity/blob/v4.1.0/docs/build.md 40 41 The instructions for configuring the node using the Docker image are in [the dedicated separate document][docker]. 42 43 The node user API is documented: 44 * HTTP API endpoints are specified [online in swagger.yaml][swagger-yaml]; 45 * 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). 46 * The JSON version can be obtained from a running node using the endpoint `/api`. 47 * An interactive visualization of the same specification is available [online][swagger-ui]. 48 * WebSocket API endpoints are [specified online][api-doc]; 49 * The intended usage of the user API (HTTP and WebSocket) is [documented online][api-doc]. 50 51 [swagger-yaml]: https://github.com/aeternity/aeternity/blob/v4.1.0/config/swagger.yaml 52 [swagger-ui]: https://aeternity.github.io/api-docs/?config=https://raw.githubusercontent.com/aeternity/aeternity/v4.1.0/apps/aehttp/priv/swagger.json 53 [api-doc]: https://github.com/aeternity/protocol/blob/aeternity-node-v4.1.0/node/api/README.md 54 55 ## Install node 56 57 The instructions for installing a node using a release binary are in [the dedicated separate document](../../docs/installation.md). 58 59 For installation of a node using the Docker image, please refer to the [documentation online][docker]. 60 61 ## Join the mainnet 62 63 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. 64 65 To join the mainnet by using the Docker image, please refer to [docker documentation][docker]. 66 67 ### Mainnet seed nodes 68 69 The release package comes preconfigured with seed nodes. Here is example subset of the seed nodes: 70 71 * aenode://pp_2L8A5vSjnkLtfFNpJNgP9HbmGLD7ZAGFxoof47N8L4yyLAyyMi@18.136.37.63:3015 72 * aenode://pp_2gPZjuPnJnTVEbrB9Qgv7f4MdhM4Jh6PD22mB2iBA1g7FRvHTk@52.220.198.72:3015 73 * aenode://pp_tVdaaX4bX54rkaVEwqE81hCgv6dRGPPwEVsiZk41GXG1A4gBN@3.16.242.93:3015 74 * aenode://pp_2mwr9ikcyUDUWTeTQqdu8WJeQs845nYPPqjafjcGcRWUx4p85P@3.17.30.101:3015 75 * aenode://pp_2CAJwwmM2ZVBHYFB6na1M17roQNuRi98k6WPFcoBMfUXvsezVU@13.58.177.66:3015 76 * aenode://pp_7N7dkCbg39MYzQv3vCrmjVNfy6QkoVmJe3VtiZ3HRncvTWAAX@13.53.114.199:3015 77 * aenode://pp_22FndjTkMMXZ5gunCTUyeMPbgoL53smqpM4m1Jz5fVuJmPXm24@13.53.149.181:3015 78 * aenode://pp_Xgsqi4hYAjXn9BmrU4DXWT7jURy2GoBPmrHfiCoDVd3UPQYcU@13.53.164.121:3015 79 * aenode://pp_vTDXS3HJrwJecqnPqX3iRxKG5RBRz9MdicWGy8p9hSdyhAY4S@13.53.77.98:3015 80 81 ### Inspect the mainnet 82 83 Here are example nodes that can be used to inspect current top block and see information about e.g. height or target: 84 85 * http://18.136.37.63:3013/v2/blocks/top 86 * http://52.220.198.72:3013/v2/blocks/top 87 * http://13.53.114.199:3013/v2/blocks/top 88 * http://13.53.149.181:3013/v2/blocks/top 89 90 ## Join the testnet 91 92 In order to join the testnet change the [Network ID](../../docs/configuration.md#network-id) in node configuration file to `ae_uat`. 93 94 To join the testnet by using the Docker image, please refer to the [docker documentation][docker]. 95 96 ### Testnet seed nodes 97 98 The release package comes preconfigured with testnet seed nodes, this is the list: 99 100 * aenode://pp_QU9CvhAQH56a2kA15tCnWPRJ2srMJW8ZmfbbFTAy7eG4o16Bf@52.10.46.160:3015 101 * aenode://pp_27xmgQ4N1E3QwHyoutLtZsHW5DSW4zneQJ3CxT5JbUejxtFuAu@13.250.162.250:3015 102 * aenode://pp_DMLqy7Zuhoxe2FzpydyQTgwCJ52wouzxtHWsPGo51XDcxc5c8@13.53.161.215:3015 103 104 ### Inspect the testnet 105 106 The core nodes of the public test network are accessible from the Internet. 107 108 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: 109 * http://52.10.46.160:3013/v2/blocks/top 110 * http://13.250.162.250:3013/v2/blocks/top 111 * http://13.53.161.215:3013/v2/blocks/top 112 113 ### Setup your node 114 115 Setting up your node consists of: 116 * Configuring your node - see instructions in [the dedicated separate document](../../docs/configuration.md); 117 * Starting your node and verifying it works as expected - see instructions in [the dedicated separate document](../../docs/operation.md).