RELEASE-NOTES-2.3.0.md
1 # About this release 2 3 [This][this-release] is a maintenance release. 4 It: 5 * Introduces additional Garbage Collection of transactions, based on new transaction `{origin/account, nonce}` cache. 6 * Adds new metrics to monitor mempool GC - `ae,epoch,aecore,tx_pool,gced` and `ae,epoch,aecore,tx_pool,origin_gced`. 7 * Adds `channels.update.new_contract_from_onchain` method to channel websocket API. 8 * Exposes setting `minimum_depth` in WebSocket connection creation in State 9 Channels WebSocket API 10 * Unifies State Channel's WebSocket API timeouts: `open` fallbacks to `idle`. 11 * Improves the stability of the State Channels WebSocket API. 12 * Deprecates the `log` field in the contract object in the user HTTP API. 13 * Adds beta support for new database backend [leveled](https://github.com/martinsumner/leveled). 14 * Enable by setting the configuration `chain->db_backend` in `aeternity.yaml` to `leveled`. 15 * When first enabling a new database backend you must rename your database folder, or delete it, and resynchronize the chain. 16 17 [this-release]: https://github.com/aeternity/aeternity/releases/tag/v2.3.0 18 19 This release is backward compatible with previous `v2.2.*` releases. 20 21 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). 22 Troubleshooting of common issues is documented [in the wiki](https://github.com/aeternity/aeternity/wiki/Troubleshooting). 23 24 The instructions below describe: 25 * [How to retrieve the released software for running a node](#retrieve-the-software-for-running-a-node); 26 * [How to install a node](#install-node); 27 * [How to join the mainnet](#join-the-mainnet). 28 * [How to join the testnet](#join-the-testnet). 29 30 ## Retrieve the software for running a node 31 32 You can run a node by either: 33 * Installing the published [release binary][this-release] corresponding to your platform; or 34 * Running the published [Docker image `aeternity/aeternity`][docker]; or 35 * [Building a release binary from source][build]. 36 37 [docker]: https://github.com/aeternity/aeternity/blob/v2.3.0/docs/docker.md 38 [build]: https://github.com/aeternity/aeternity/blob/v2.3.0/docs/build.md 39 40 The instructions for configuring the node using the Docker image are in [the dedicated separate document][docker]. 41 42 The node user API is documented: 43 * HTTP API endpoints are specified [online in swagger.yaml][swagger-yaml]; 44 * 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). 45 * The JSON version can be obtained from a running node using the endpoint `/api`. 46 * An interactive visualization of the same specification is available [online][swagger-ui]. 47 * WebSocket API endpoints are [specified online][api-doc]; 48 * The intended usage of the user API (HTTP and WebSocket) is [documented online][api-doc]. 49 50 [swagger-yaml]: https://github.com/aeternity/aeternity/blob/v2.3.0/config/swagger.yaml 51 [swagger-ui]: https://aeternity.github.io/api-docs/?config=https://raw.githubusercontent.com/aeternity/aeternity/v2.3.0/apps/aehttp/priv/swagger.json 52 [api-doc]: https://github.com/aeternity/protocol/blob/aeternity-node-v2.3.0/node/api/README.md 53 54 ## Install node 55 56 The instructions for installing a node using a release binary are in [the dedicated separate document](../../docs/installation.md). 57 58 For installation of a node using the Docker image, please refer to [its documentation online][docker]. 59 60 ## Join the mainnet 61 62 ### Mainnet seed nodes 63 64 The release package comes preconfigured with seed nodes. Here is example subset of the seed nodes: 65 66 * aenode://pp_2L8A5vSjnkLtfFNpJNgP9HbmGLD7ZAGFxoof47N8L4yyLAyyMi@18.136.37.63:3015 67 * aenode://pp_2gPZjuPnJnTVEbrB9Qgv7f4MdhM4Jh6PD22mB2iBA1g7FRvHTk@52.220.198.72:3015 68 * aenode://pp_tVdaaX4bX54rkaVEwqE81hCgv6dRGPPwEVsiZk41GXG1A4gBN@3.16.242.93:3015 69 * aenode://pp_2mwr9ikcyUDUWTeTQqdu8WJeQs845nYPPqjafjcGcRWUx4p85P@3.17.30.101:3015 70 * aenode://pp_2CAJwwmM2ZVBHYFB6na1M17roQNuRi98k6WPFcoBMfUXvsezVU@13.58.177.66:3015 71 * aenode://pp_7N7dkCbg39MYzQv3vCrmjVNfy6QkoVmJe3VtiZ3HRncvTWAAX@13.53.114.199:3015 72 * aenode://pp_22FndjTkMMXZ5gunCTUyeMPbgoL53smqpM4m1Jz5fVuJmPXm24@13.53.149.181:3015 73 * aenode://pp_Xgsqi4hYAjXn9BmrU4DXWT7jURy2GoBPmrHfiCoDVd3UPQYcU@13.53.164.121:3015 74 * aenode://pp_vTDXS3HJrwJecqnPqX3iRxKG5RBRz9MdicWGy8p9hSdyhAY4S@13.53.77.98:3015 75 76 ### Inspect the mainnet 77 78 Here are example nodes that can be used to inspect current top block and see information about e.g. height or target: 79 80 * http://18.136.37.63:3013/v2/blocks/top 81 * http://52.220.198.72:3013/v2/blocks/top 82 * http://13.53.114.199:3013/v2/blocks/top 83 * http://13.53.149.181:3013/v2/blocks/top 84 85 ## Join the testnet 86 87 This section describes how to run a node as part of the testnet - the public test network of nodes - by using the release binary. 88 89 For running a node as part of the testnet by using the Docker image, please consult [its documentation][docker] in addition to this section. 90 91 ### Testnet seed nodes 92 93 In order to join testnet reconfigure seed nodes in the release package: 94 95 * aenode://pp_QU9CvhAQH56a2kA15tCnWPRJ2srMJW8ZmfbbFTAy7eG4o16Bf@52.10.46.160:3015 96 * aenode://pp_27xmgQ4N1E3QwHyoutLtZsHW5DSW4zneQJ3CxT5JbUejxtFuAu@13.250.162.250:3015 97 * aenode://pp_DMLqy7Zuhoxe2FzpydyQTgwCJ52wouzxtHWsPGo51XDcxc5c8@13.53.161.215:3015 98 99 ### Inspect the testnet 100 101 The core nodes of the public test network are accessible from the Internet. 102 103 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: 104 * http://52.10.46.160:3013/v2/blocks/top 105 * http://13.250.162.250:3013/v2/blocks/top 106 * http://13.53.161.215:3013/v2/blocks/top 107 108 ### Setup your node 109 110 Setting up your node consists of: 111 * Configuring your node - see instructions in [the dedicated separate document](../../docs/configuration.md); 112 * Starting your node and verifying it works as expected - see instructions in [the dedicated separate document](../../docs/operation.md).