Autonity Go Client Command-line
Command-line options and facilities of the Autonity Go Client
Command-line options
Autonity supports all Geth command-line options with the following exceptions:
| Command | Exception |
|---|---|
| COMMANDS: | |
dumpgenesis |
The command is removed and has been replaced by an Autonity Protocol contract [config](/reference/api/aut/#config) method to return the genesis block configuration |
init |
The command is deprecated and has been replaced by a --genesis command option to give the path to the genesis configuration file genesis.json. For example: --genesis ./genesis.json |
clique |
The Clique Proof of Authority consensus functionality has been removed |
wallet |
The command for managing Ethereum presale wallets has been removed |
attach and console |
The Geth JavaScript console is deprecated in favour of the Autonity Utility Tool aut |
makecache and makedag |
The commands are removed. They are specific to ethash Proof of Work consensus and not required by Autonity’s Tendermint consensus |
| ETHEREUM OPTIONS: | |
piccadilly and bakerloo |
Options for connecting to the Autonity test networks ‘Piccadilly’ and Bakerloo are added (Options for connecting to the Ethereum test networks are removed) |
genOwnershipProof |
An option to generate an enode proof required for validator registration is added |
genAutonityKeys |
Autonity implements separate channels for transaction and consensus gossiping and so has two keys at the P2P layer. An option to generate an Autonity keys file containing the transaction and consensus gossiping private keys is added |
| NETWORKING OPTIONS: | |
--netrestrict |
Netrestrict functionality is modified in the client to allow for dynamic trusted peers. Netrestrict now supports a dynamic validator set and sentry node architecture: trusted but netrestricted nodes can connect, enabling a sentry node architecture for trusted consensus committee validator enode urls |
--nodekey and --nodekeyhex |
The P2P node key flags are renamed to --autonitykeys and --autonitykeyshex. Autonity implements separate channels for transaction and consensus gossiping and so has two keys at the P2P layer - a consensus key and a transaction gossiping key. An Autonity keys file containing the private keys is generated by running the sub command genAutonityKeys |
--oraclekey |
An option for the Autonity Oracle Server account key file is added. Validator nodes on an Autonity network must run the oracle binary to participate in the oracle network. |
--oraclekeyhex |
An option for the Autonity Oracle Server account key as hex (for testing) is added |
--consensus.port |
An option for the network listening port for the consensus channel is added (default: 20203) |
--consensus.nat |
An option for the NAT port mapping mechanism for the consensus channel is added (“any”, “none”, “upnp”, “pmp”, “extip: |
--nogossip |
An option to disable consensus message gossip (for testing) is added |
| MINER OPTIONS: | |
miner.etherbase |
The option for setting the address for receiving block mining rewards is removed. Autonity implements a protocol mechanism for distributing staking rewards |
miner.gasprice |
The default value for the minimum gas price for mining a transaction is changed from ‘1000000000’ to ‘500000000’ |
miner.gaslimit |
The default value for Ethereum’s native gas block limit voting mechanism is changed from ‘8000000’ to ‘20000000’ |
| LIGHT CLIENT OPTIONS: | All options are removed |
| DEVELOPER CHAIN OPTIONS: | All options are removed. Autonity doesn’t support clique Proof of Authority consensus. Developer mode options for a proof-of-stake developer mode are added to MISC OPTIONS beneath |
| ETHASH OPTIONS: | All options are removed. Autonity doesn’t support Proof of Work consensus |
| LOGGING AND DEBUGGING OPTIONS: | |
fakepow |
The option is removed. Autonity doesn’t support Proof of Work consensus |
| ALIASED (deprecated) OPTIONS: | |
--miner.gastarget and --nousb |
The options are deprecated and will be removed in the future |
| MISC OPTIONS: | |
--writeaddress |
An option to write out the node’s public key on stdout is added |
--dev |
A developer mode option to create an ephemeral proof-of-stake network with a pre-funded developer account, mining enabled |
--dev.gaslimit |
An option to set the initial block gas limit (default: 30000000) for the developer mode network |
--dev.etherbase |
An option to set the public address of the external account to be used for developer mode (default: “0”) |
Usage
Run autonity --help to view the options:
Info
Autonity is a Geth fork and command-line options are inherited from Geth. The Geth docs Command-line Options are kept in synch with the current stable version of Geth. The Command-line Options inherited from Geth reflect the Geth version from which Autonity is forked. For Autonity’s Geth base version see Reference Codebase.
NAME:
autonity - the autonity command line interface
Copyright 2013-2021 The go-ethereum Authors
USAGE:
autonity [options] [command] [command options] [arguments...]
VERSION:
0.14.0-internal-a09e8d99-20240605
COMMANDS:
account Manage accounts
attach Start an interactive JavaScript environment (connect to node)
console Start an interactive JavaScript environment
db Low level database operations
dump Dump a specific block from storage
dumpconfig Show configuration values
export Export blockchain into file
export-preimages Export the preimage database into an RLP stream
genAutonityKeys Generate autonity keys
genOwnershipProof Generate enode proof
import Import a blockchain file
import-preimages Import the preimage database from an RLP stream
js Execute the specified JavaScript files
license Display license information
removedb Remove blockchain and state databases
show-deprecated-flags Show flags that have been deprecated
snapshot A set of commands based on the snapshot
version Print version numbers
help, h Shows a list of commands or help for one command
ETHEREUM OPTIONS:
--config value TOML configuration file
--genesis value Path to the genesis json file, the genesis file contains
configuration that defines the first (aka genesis) block of the chain
and also controls how the client behaves. This flag must be provided
the first time a node is run so that the node can initialise its
database with the provided config. Subsequent to the first run, if the
flag is not set, the node will load all configuration from its
database, otherwise the node will verify that the config for the
genesis block exactly matches the genesis block it has in its database
and then see if the configuration that controls client behaviour is
compatible with the configuration in the database. If so the client will
update the configuration that controls client behaviour. This is the
mechanism is used for handling forks.
--datadir value Data directory for the databases and keystore (default: "~/.autonity")
--datadir.ancient value Data directory for ancient chain segments (default = inside chaindata)
--datadir.minfreedisk value Minimum free disk space in MB, once reached triggers auto shut down (default = --cache.gc converted to MB, 0 = disabled)
--keystore value Directory for the keystore (default = inside the datadir)
--usb Enable monitoring and management of USB hardware wallets
--pcscdpath value Path to the smartcard daemon (pcscd) socket file (default: "/run/pcscd/pcscd.comm")
--networkid value Explicitly set network id (integer)(For testnets: use --piccadilly instead) (default: 65000000)
--syncmode value Blockchain sync mode ("snap", "full" or "light") (default: snap)
--exitwhensynced Exits after block synchronisation completes
--gcmode value Blockchain garbage collection mode ("full", "archive") (default: "full")
--piccadilly Piccadilly network: pre-configured Autonity test network
--bakerloo Bakerloo network: pre-configured Autonity test network
--txlookuplimit value Number of recent blocks to maintain transactions index for (default = about one year, 0 = entire chain) (default: 2350000)
--ethstats value Reporting URL of a ethstats service (nodename:secret@host:port)
--identity value Custom node name
--lightkdf Reduce key-derivation RAM & CPU usage at some expense of KDF strength
--eth.requiredblocks value Comma separated block number-to-hash mappings to enforce (<number>=<hash>)
TRANSACTION POOL OPTIONS:
--txpool.locals value Comma separated accounts to treat as locals (no flush, priority inclusion)
--txpool.nolocals Disables price exemptions for locally submitted transactions
--txpool.journal value Disk journal for local transaction to survive node restarts (default: "transactions.rlp")
--txpool.rejournal value Time interval to regenerate the local transaction journal (default: 1h0m0s)
--txpool.pricelimit value Minimum gas price limit to enforce for acceptance into the pool (default: 1)
--txpool.pricebump value Price bump percentage to replace an already existing transaction (default: 10)
--txpool.accountslots value Minimum number of executable transaction slots guaranteed per account (default: 16)
--txpool.globalslots value Maximum number of executable transaction slots for all accounts (default: 5120)
--txpool.accountqueue value Maximum number of non-executable transaction slots permitted per account (default: 64)
--txpool.globalqueue value Maximum number of non-executable transaction slots for all accounts (default: 1024)
--txpool.lifetime value Maximum amount of time non-executable transaction are queued (default: 3h0m0s)
PERFORMANCE TUNING OPTIONS:
--cache value Megabytes of memory allocated to internal caching (default = 4096 mainnet full node, 128 light mode) (default: 1024)
--cache.database value Percentage of cache memory allowance to use for database io (default: 50)
--cache.trie value Percentage of cache memory allowance to use for trie caching (default = 15% full mode, 30% archive mode) (default: 15)
--cache.trie.journal value Disk journal directory for trie cache to survive node restarts (default: "triecache")
--cache.trie.rejournal value Time interval to regenerate the trie cache journal (default: 1h0m0s)
--cache.gc value Percentage of cache memory allowance to use for trie pruning (default = 25% full mode, 0% archive mode) (default: 25)
--cache.snapshot value Percentage of cache memory allowance to use for snapshot caching (default = 10% full mode, 20% archive mode) (default: 10)
--cache.noprefetch Disable heuristic state prefetch during block import (less CPU and disk IO, more time waiting for data)
--cache.preimages Enable recording the SHA3/keccak preimages of trie keys
ACCOUNT OPTIONS:
--unlock value Comma separated list of accounts to unlock
--password value Password file to use for non-interactive password input
--signer value External signer (url or path to ipc file)
--allow-insecure-unlock Allow insecure account unlocking when account-related RPCs are exposed by http
API AND CONSOLE OPTIONS:
--ipcdisable Disable the IPC-RPC server
--ipcpath value Filename for IPC socket/pipe within the datadir (explicit paths escape it)
--http Enable the HTTP-RPC server
--http.addr value HTTP-RPC server listening interface (default: "localhost")
--http.port value HTTP-RPC server listening port (default: 8545)
--http.api value API's offered over the HTTP-RPC interface
--http.rpcprefix value HTTP path path prefix on which JSON-RPC is served. Use '/' to serve on all paths.
--http.corsdomain value Comma separated list of domains from which to accept cross origin requests (browser enforced)
--http.vhosts value Comma separated list of virtual hostnames from which to accept requests (server enforced). Accepts '*' wildcard. (default: "localhost")
--ws Enable the WS-RPC server
--ws.addr value WS-RPC server listening interface (default: "localhost")
--ws.port value WS-RPC server listening port (default: 8546)
--ws.api value API's offered over the WS-RPC interface
--ws.rpcprefix value HTTP path prefix on which JSON-RPC is served. Use '/' to serve on all paths.
--ws.origins value Origins from which to accept websockets requests
--graphql Enable GraphQL on the HTTP-RPC server. Note that GraphQL can only be started if an HTTP server is started as well.
--graphql.corsdomain value Comma separated list of domains from which to accept cross origin requests (browser enforced)
--graphql.vhosts value Comma separated list of virtual hostnames from which to accept requests (server enforced). Accepts '*' wildcard. (default: "localhost")
--rpc.gascap value Sets a cap on gas that can be used in eth_call/estimateGas (0=infinite) (default: 50000000)
--rpc.evmtimeout value Sets a timeout used for eth_call (0=infinite) (default: 5s)
--rpc.txfeecap value Sets a cap on transaction fee (in auton) that can be sent via the RPC APIs (0 = no cap) (default: 1)
--rpc.allow-unprotected-txs Allow for unprotected (non EIP155 signed) transactions to be submitted via RPC
--jspath loadScript JavaScript root path for loadScript (default: ".")
--exec value Execute JavaScript statement
--preload value Comma separated list of JavaScript files to preload into the console
NETWORKING OPTIONS:
--bootnodes value Comma separated enode URLs for P2P discovery bootstrap
--discovery.dns value Sets DNS discovery entry points (use "" to disable DNS)
--port value Network listening port for execution channel (default: 30303)
--maxpeers value Maximum number of network peers (network disabled if set to 0) (default: 50)
--maxpendpeers value Maximum number of pending connection attempts (defaults used if set to 0) (default: 0)
--nat value NAT port mapping mechanism for execution channel (any|none|upnp|pmp|extip:<IP>) (default: "any")
--nodiscover Disables the peer discovery mechanism (manual peer addition)
--v5disc Enables the experimental RLPx V5 (Topic Discovery) mechanism
--netrestrict value Restricts network communication to the given IP networks (CIDR masks)
--autonitykeys value Autonity keys file generated by sub command genAutonityKeys
--autonitykeyshex value Autonity keys as hex (for testing)
--oraclekey value oracle account key file
--oraclekeyhex value oracle account key as hex (for testing)
--consensus.port value Network listening port for consensus channel (default: 20203)
--consensus.nat value NAT port mapping mechanism for consensus channel (any|none|upnp|pmp|extip:<IP>) (default: "any")
--nogossip disable consensus message gossip
MINER OPTIONS:
--mine Enable mining. Will bypass the chain sync check.
--miner.threads value Number of CPU threads to use for mining (default: 0)
--miner.notify value Comma separated HTTP URL list to notify of new work packages
--miner.notify.full Notify with pending block headers instead of work packages
--miner.gasprice value Minimum gas price for mining a transaction (default: 500000000)
--miner.gaslimit value Target gas ceiling for mined blocks (default: 20000000)
--miner.extradata value Block extra data set by the miner (default = client version)
--miner.recommit value Time interval to recreate the block being mined (default: 3s)
--miner.noverify Disable remote sealing verification
GAS PRICE ORACLE OPTIONS:
--gpo.blocks value Number of recent blocks to check for gas prices (default: 20)
--gpo.percentile value Suggested gas price is the given percentile of a set of recent transaction gas prices (default: 60)
--gpo.maxprice value Maximum transaction priority fee (or gasprice before London fork) to be recommended by gpo (default: 500000000000)
--gpo.ignoreprice value Gas price below which gpo will ignore transactions (default: 2)
VIRTUAL MACHINE OPTIONS:
--vmdebug Record information useful for VM and contract debugging
LOGGING AND DEBUGGING OPTIONS:
--nocompaction Disables db compaction after import
--verbosity value Logging verbosity: 0=silent, 1=error, 2=warn, 3=info, 4=debug, 5=detail (default: 3)
--vmodule value Per-module verbosity: comma-separated list of <pattern>=<level> (e.g. eth/*=5,p2p=4)
--log.json Format logs with JSON
--log.backtrace value Request a stack trace at a specific logging statement (e.g. "block.go:271")
--log.debug Prepends log messages with call-site location (file and line number)
--pprof Enable the pprof HTTP server
--pprof.addr value pprof HTTP server listening interface (default: "127.0.0.1")
--pprof.port value pprof HTTP server listening port (default: 6060)
--pprof.memprofilerate value Turn on memory profiling with the given rate (default: 524288)
--pprof.blockprofilerate value Turn on block profiling with the given rate (default: 0)
--pprof.cpuprofile value Write CPU profile to the given file
--trace value Write execution trace to the given file
METRICS AND STATS OPTIONS:
--metrics Enable metrics collection and reporting
--metrics.expensive Enable expensive metrics collection and reporting
--metrics.addr value Enable stand-alone metrics HTTP server listening interface (default: "127.0.0.1")
--metrics.port value Metrics HTTP server listening port (default: 6060)
--metrics.influxdb Enable metrics export/push to an external InfluxDB database
--metrics.influxdb.endpoint value InfluxDB API endpoint to report metrics to (default: "http://localhost:8086")
--metrics.influxdb.database value InfluxDB database name to push reported metrics to (default: "autonity")
--metrics.influxdb.username value Username to authorize access to the database (default: "test")
--metrics.influxdb.password value Password to authorize access to the database (default: "test")
--metrics.influxdb.tags value Comma-separated InfluxDB tags (key/values) attached to all measurements (default: "host=localhost")
--metrics.influxdbv2 Enable metrics export/push to an external InfluxDB v2 database
--metrics.influxdb.token value Token to authorize access to the database (v2 only) (default: "test")
--metrics.influxdb.bucket value InfluxDB bucket name to push reported metrics to (v2 only) (default: "autonity")
--metrics.influxdb.organization value InfluxDB organization name (v2 only) (default: "autonity")
ALIASED (deprecated) OPTIONS:
--nousb Disables monitoring for and managing USB hardware wallets (deprecated)
MISC OPTIONS:
--snapshot Enables snapshot-database mode (default = enable)
--bloomfilter.size value Megabytes of memory allocated to bloom-filter for pruning (default: 2048)
--help, -h show help
--writeaddress writes out the node's public key on stdout
--dev Ephemeral proof-of-stake network with a pre-funded developer account, mining enabled
--dev.gaslimit value Initial block gas limit (default: 30000000)
--dev.etherbase value Public address of external account to be used for developer mode (default: "0")
COPYRIGHT:
Copyright 2013-2022 The go-ethereum Authors