About this release
Last updated
Was this helpful?
Last updated
Was this helpful?
is a maintenance release. It contains feature refinements, in addition to renaming of the canonical location and name of the software. Please refer to the notes below for details and backward compatibility.
Regarding renaming, this release:
Deprecates Docker Hub repository aeternity/epoch
in favor of aeternity/aeternity
. Older images have been migrated to aeternity/aeternity
. The latest
tag of aeternity/epoch
will always point to 1.3.0
until the repository is deleted in the future.
Users fetching the Docker image must fetch it from the new Docker Hub repo aeternity/aeternity
.
Changes Docker images username (and home path) to aeternity.
Users specifying for the Docker image a custom user configuration or persisting the chain data must update how they use the image. Please refer to the dedicated for details.
Updates package names to use aeternity
prefix e.g. aeternity-1.3.0-ubuntu-x86_64.tar.gz
instead of epoch-1.3.0-ubuntu-x86_64.tar.gz
.
Users retrieving the published release binaries for this release and following must update their scripts.
Renames OSX/macOS package name to use macos-x86_64
suffix e.g. aeternity-1.3.0-macos-x86_64.tar.gz
instead of epoch-1.3.0-osx-10.13.6.tar.gz
.
Users retrieving the published macOS release binaries for this release and following must update their scripts.
Deprecates the bin/epoch
binary for operating the node in favor of bin/aeternity
. The bin/epoch
binary prints a deprecation warning to standard error then redirects the invocation to the bin/aeternity
one until aeternity/epoch
is deleted at the next major version.
Deprecates GitHub repository aeternity/epoch
in favor of aeternity/aeternity
. Traffic is from aeternity/epoch
to aeternity/aeternity
.
Regarding feature refinements, this release:
Disables internal debug API endpoints by default. To enable setup epoch.yaml http > internal > debug_endpoints
to true
.
Marks http > endpoints > debug
and http > debug
configuration params as deprecated.
Introduces new configuration parameter sync
> upnp_enabled
, which (if true) starts UPnP/NAT-PMP service to handle UPnP/NAT-PMP discovery and automatic port mappings.
This release is backward compatible with v1.2.*
, v1.1.*
and v1.0.*
.
The instructions below describe:
You can run a node by either:
The node user API is documented:
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).
The JSON version can be obtained from a running node using the endpoint /api
.
The release package comes preconfigured with seed nodes. Here is example subset of the seed nodes:
aenode://pp_5mmzrsoPh9owYMfKhZSkUihufDTB6TuayD173Ng464ukVm9xU@35.178.61.73:3015
aenode://pp_2KWhoNRdythXAmgCbM6QxFo95WM4XXGq2pjcbKitXFpUHnPQc3@35.177.192.219:3015
aenode://pp_2L8A5vSjnkLtfFNpJNgP9HbmGLD7ZAGFxoof47N8L4yyLAyyMi@18.136.37.63:3015
aenode://pp_2gPZjuPnJnTVEbrB9Qgv7f4MdhM4Jh6PD22mB2iBA1g7FRvHTk@52.220.198.72:3015
aenode://pp_frAKABjDnM3QZCUygbkaFvbd8yhv6xdufazDFLgJRc4fnGy3s@52.56.252.75:3015
aenode://[email protected]:3015
aenode://pp_2mwr9ikcyUDUWTeTQqdu8WJeQs845nYPPqjafjcGcRWUx4p85P@3.17.30.101:3015
aenode://pp_FLpSUrKwgBAu5uVRnB2iWKtwGAHZckxvtCbjVPeeCA3j33t3J@52.56.66.124:3015
aenode://pp_2CAJwwmM2ZVBHYFB6na1M17roQNuRi98k6WPFcoBMfUXvsezVU@13.58.177.66:3015
Here are example nodes that can be used to inspect current top block and see information about e.g. height or target:
http://35.178.61.73:3013/v2/blocks/top
http://35.177.192.219:3013/v2/blocks/top
http://18.136.37.63:3013/v2/blocks/top
http://52.220.198.72:3013/v2/blocks/top
This section describes how to run a node as part of the testnet - the public test network of nodes - by using the release binary.
In order to join testnet reconfigure seed nodes in the release package:
aenode://pp_QU9CvhAQH56a2kA15tCnWPRJ2srMJW8ZmfbbFTAy7eG4o16Bf@52.10.46.160:3015
aenode://pp_27xmgQ4N1E3QwHyoutLtZsHW5DSW4zneQJ3CxT5JbUejxtFuAu@13.250.162.250:3015
aenode://pp_nt5N7fwae3DW8Mqk4kxkGAnbykRDpEZq9dzzianiMMPo4fJV7@18.130.148.7:3015
The core nodes of the public test network are accessible from the Internet.
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:
http://52.10.46.160:3013/v2/blocks/top
http://13.250.162.250:3013/v2/blocks/top
http://18.130.148.7:3013/v2/blocks/top
Setting up your node consists of:
Please join the Roma network by following the instructions below, and let us know if you have any problems by . Troubleshooting of common issues is documented .
;
;
.
.
Installing the published corresponding to your platform; or
Running the published ; or
.
The user configuration is documented in the . For specifying configuration using the Docker image, please refer to .
HTTP API endpoints are specified ;
An interactive visualization of the same specification is available .
WebSocket API endpoints are ;
The intended usage of the user API (HTTP and WebSocket) is .
The instructions for installing a node using a release binary are in .
For installation of a node using the Docker image, please refer to .
For running a node as part of the testnet by using the Docker image, please consult in addition to this section.
Configuring your node - see instructions in ;
Starting your node and verifying it works as expected - see instructions in .