Setup Autonity CLI

How to install and configure the aut command-line tool on your local machine.

The recommended way of interacting with the Autonity network is via Autonity CLI, which provides a command-line interface to Autonity-specific queries and operations, as well as much of the base Ethereum functionality. In general it only needs to be installed on local machines, to connect to the RPC endpoint of an Autonity Go Client (either your own node, or a node providing public RPC access).

For full details and to report any issues, see its repository.

Installation

Prerequisites

A working Python install with the pip tool is required.

The tool can be installed using pipx. To get the latest release run:

pipx install autonity-cli

Once installed, the tool can be invoked with the aut command.

Note

If you are experiencing errors such as:

ImportError: cannot import name 'NodeAddress' from 'autonity.validator'

You are using an earlier version. Please upgrade your Autonity CLI to use the latest release with the installation command:

pipx upgrade autonity-cli

It is highly recommended to also follow the instructions in the repository to set up command-line completion.

Configuration using the .autrc file

As detailed in its repository, some configuration parameters can be set in an .autrc file in the working directory or any parent directory. As a minimal configuration, it is recommended to create an .autrc containing the end-point to use for RPC operations:

Given an RPC_URL from https://chainlist.org/?testnets=true&search=autonity.

[aut]
rpc_endpoint=$RPC_URL

See the list of available networks to determine the correct endpoint to use.

Usage

The tool is intended to be self documenting via aut --help, aut <command> --help etc. Some example commands can be found in its repository.

We suggest trying the following command (which retrieves some basic information about the connected node and network) to confirm that the install and configuration have been successful:

aut node info
{
  "eth_accounts": [],
  "eth_blockNumber": 12803619,
  "eth_gasPrice": 1000000000,
  "eth_syncing": false,
  "eth_chainId": 65100003,
  "net_listening": true,
  "net_peerCount": 19,
  "net_networkId": "65100003",
  "web3_clientVersion": "Autonity/v0.10.0-1183a113-20230118/linux-amd64/go1.19",
  "admin_enode": "enode://d9a7297b2bec3c2f92233dc42f53c0cf98af30528a56765b102d9e28be2a760b7fd3045790246d1a5836af9a8ea5d2dbcc9b56864f6391045ba76391d9db931e@77.86.9.81:30303",
  "admin_id": "8794927d6dda6f8cb45bc7eefd9084dbb3b81ce508ff43e1ccb7fe904ccd2cfc"
}
Note

The output above may vary depending on the version of the Autonity Go Client you are connected to.

Info

Now that you have a working aut installation, you can create and fund and account on the network, and then create and submit a transaction.

If you need help, you can chat to us on Autonity Discord Server!