besu/docs/Reference/Pantheon-CLI-Syntax.md

description: Pantheon commande line interface reference

Pantheon Command Line

This reference describes the syntax of the Pantheon Command Line Interface (CLI) options and subcommands.

pantheon [OPTIONS] [COMMAND]

Runs the Pantheon Ethereum full node client.

!!!tip Use a configuration file to save the command line options in a file.

Options

accounts-whitelist

--accounts-whitelist[=<hex string of account public key>[,<hex string of account public key>...]...

 --accounts-whitelist=[0xfe3b557e8fb62b89f4916b721be55ceb828dbd73, 0x627306090abaB3A6e1400e9345bC60c78a8BEf57]

Comma separated account public keys for permissioned transactions. You can specify an empty list.

!!!note Permissioning is under development and will be available in v1.0.

banned-nodeids

--banned-nodeids=<bannedNodeId>[,<bannedNodeId>...]...

--banned-nodeids=0xc35c3...d615f,0xf42c13...fc456

banned-nodeids=["0xc35c3...d615f","0xf42c13...fc456"]

List of node IDs with which this node will not peer. The node ID is the public key of the node. You can specify the banned node IDs with or without the 0x prefix.

!!!info This option is only available from v0.8.2.

bootnodes

--bootnodes=<enode://id@host:port>[,<enode://id@host:port>...]...

--bootnodes=enode://c35c3...d615f@1.2.3.4:30303,enode://f42c13...fc456@1.2.3.5:30303

bootnodes=["enode://c35c3...d615f@1.2.3.4:30303","enode://f42c13...fc456@1.2.3.5:30303"]

List of comma-separated enode URLs for P2P discovery bootstrap.

When connecting to mainnet or public testnets, the default is a predefined list of enode URLs. Specify bootnodes when connecting to a private network.

config

--config=<PATH>

--config=/home/me/me_node/config.toml

The path to the TOML configuration file. The default is none.

!!!note This option is not used when running Pantheon from the Docker image or in a configuration file.

datadir

--datadir=<PATH>

--datadir=/home/me/me_node

datadir="/home/me/me_node"

The path to the Pantheon data directory. The default is the /build/distributions/pantheon-<version> directory in the Pantheon installation directory.

!!!note This option is not used when running Pantheon from the Docker image.

dev-mode

--dev-mode

dev-mode=true

Set this option to true to run in development mode. For example, specify this option to perform CPU mining more easily in a private test network. In development mode, a custom genesis configuration specifies the chain ID. When using this option, also set the --network-id option to the network you use for development. Default is false.

!!!note The --dev-mode option overrides the --genesis option. If both are specified, the development mode configuration is used.

genesis

--genesis=<PATH>

--genesis=/home/me/me_node/customGenesisFile.json

genesis="/home/me/me_node/customGenesisFile.json"

The path to the genesis file. The default is the embedded genesis file for the Ethereum mainnet. When using this option, it is recommended to also set the --network-id option.

!!!note This option is not used when running Pantheon from the Docker image.

!!!note The --genesis option is overridden by the --dev-mode option. If both are specified, the specified genesis file is ignored and the development mode configuration used.

goerli

--goerli

goerli=true

Uses the Goerli test network. Default is false.

!!!note This option is only available from v0.8.3.

host-whitelist

--host-whitelist=<hostname>[,<hostname>...]... or * or all

--host-whitelist=medomain.com,meotherdomain.com

host-whitelist=["medomain.com", "meotherdomain.com"]

Comma-separated list of hostnames to allow access to the HTTP JSON-RPC API. Default is localhost.

!!!tip To allow all hostnames, use * or all. We don't recommend allowing all hostnames for production code.

!!!note This option is only available from v0.8.3. Earlier versions allow access by all hostnames.

max-peers

--max-peers=<INTEGER>

--max-peers=42

max-peers=42

Specifies the maximum P2P peer connections that can be established. The default is 25.

max-trailing-peers

--max-trailing-peers=<INTEGER>

--max-trailing-peers=2

max-trailing-peers=2

Specifies the maximum P2P peer connections for peers that are trailing behind the local chain head. The default is unlimited but the number of trailing peers cannot exceed the value specified by --max-peers.

miner-coinbase

--miner-coinbase=<Ethereum account address>

--miner-coinbase=fe3b557e8fb62b89f4916b721be55ceb828dbd73

--miner-coinbase="0xfe3b557e8fb62b89f4916b721be55ceb828dbd73"

Account to which mining rewards are paid. You must specify a valid coinbase when you enable mining using the --miner-enabled option or the miner_start JSON RPC-API method.

!!!note This option is ignored in networks using the Clique Proof-of-Authority (PoA) consensus protocol.

miner-enabled

--miner-enabled

miner-enabled=true

Enables mining when the node is started. Default is false.

miner-extraData

--miner-extraData=<Extra data>

--miner-extraData=0x444F4E27542050414E4943202120484F444C2C20484F444C2C20484F444C2021

miner-extraData="0x444F4E27542050414E4943202120484F444C2C20484F444C2C20484F444C2021"

A hex string representing the 32 bytes to be included in the extra data field of a mined block. The default is 0x.

miner-minTransactionGasPriceWei

--miner-minTransactionGasPriceWei=<minTransactionGasPrice>

--miner-minTransactionGasPriceWei=1337

miner-minTransactionGasPriceWei="1337"

The minimum price that a transaction offers for it to be included in a mined block. The default is 1000.

network-id

--network-id=<INTEGER>

--network-id=8675309

network-id="8675309"

P2P network identifier. The default is set to mainnet with value 1.

no-discovery

--no-discovery

no-discovery=true

Disables P2P peer discovery. The default is false.

node-private-key

--node-private-key=<PATH>

--node-private-key=/home/me/me_node/myPrivateKey

node-private-key="/home/me/me_node/myPrivateKey"

<PATH> is the path of the private key file of the node. The default is the key file in the data directory. If no key file exists, a key file containing the generated private key is created; otherwise, the existing key file specifies the node private key.

!!!attention The private key is not encrypted.

!!!note This option is only available from v0.8.2.

nodes-whitelist

--nodes-whitelist[=<enode://id@host:port>[,<enode://id@host:port>...]...]

--nodes-whitelist=enode://c35c3...d615f@3.14.15.92:30303,enode://f42c13...fc456@65.35.89.79:30303

nodes-whitelist=["enode://c35c3...d615f@3.14.15.92:30303","enode://f42c13...fc456@65.35.89.79:30303"]

Comma-separated enode URLs for permissioned networks. Not intended for use with mainnet or public testnets.

!!!note This option is only available from v0.8.3.

!!!note Permissioning is under development and will be available in v1.0.

ottoman

--ottoman

ottoman=true

Synchronize against the Ottoman test network. This is only useful if you are using an IBFT genesis file. The default is false.

!!!note 🚧 IBFT is not currently supported. Support for IBFT is in active development.

p2p-listen

--p2p-listen=<HOST:PORT>

# to listen on all interfaces on port 1789
--p2p-listen=0.0.0.0:1789

p2p-listen="0.0.0.0:1789"

Specifies the host and port on which P2P peer discovery listens. The default is 127.0.0.1:30303.

!!!note This option is not used when running Pantheon from the Docker image.

rinkeby

--rinkeby

rinkeby=true

Uses the Rinkeby test network. Default is false.

ropsten

--ropsten

ropsten=true

Uses the Ropsten test network. Default is false.

!!!note This option is only available only from v0.8.2. For v0.8.1, refer to Starting Pantheon.

rpc-enabled

--rpc-enabled

rpc-enabled=true

Set to true to enable the JSON-RPC service (RPC over HTTP). The default is false.

rpc-listen

--rpc-listen=<HOST:PORT>

# to listen on all interfaces on port 3435
--rpc-listen=0.0.0.0:3435

rpc-listen="0.0.0.0:3435"

Specifies the host and port on which JSON-RPC listens. The default is 127.0.0.1:8545.

!!!note This option is not used when running Pantheon from the Docker image.

rpc-api

--rpc-api=<api name>[,<api name>...]...

--rpc-api=ETH,NET,WEB3

rpc-api=["ETH","NET","WEB3"]

Comma-separated APIs to enable on the JSON-RPC channel. When you use this option, the --rpc-enabled option must also be specified. The available API options are: ADMIN, ETH, NET, WEB3, CLIQUE, IBFT, DEBUG, and MINER. The default is: ETH, NET, WEB3, CLIQUE, IBFT.

!!!note 🚧 IBFT is not currently supported. Support for IBFT is in active development.

rpc-cors-origins

--rpc-cors-origins=<rpcCorsAllowedOrigins> or all

# You can whitelist one or more domains with a comma-separated list.

--rpc-cors-origins="http://medomain.com","https://meotherdomain.com"

rpc-cors-origins=["http://medomain.com","https://meotherdomain.com"]

# The following allows Remix to interact with your Pantheon node without using MetaMask.

--rpc-cors-origins="http://remix.ethereum.org"

Specifies domain URLs for CORS validation. Domain URLs must be enclosed in double quotes and comma-separated.

Listed domains will be allowed access to node data (whitelisted). If your client interacts with Pantheon using a browser app (such as Remix using a direct connection or a block explorer), you must whitelist the client domains.

The default value is "none". If you don't whitelist any domains, you won't be able to use webapps to interact with your Pantheon node.

!!!note MetaMask runs as native code so does not require CORS validation. If Remix is connecting to the node through MetaMask, it also does not require CORS validation.

!!!tip For development purposes, you can use "all" to accept requests from any domain, but we don't recommend this for production code.

ws-enabled

--ws-enabled

ws-enabled=true

Set to true to enable the WS-RPC (WebSockets) service. The default is false.

ws-api

--ws-api=<api name>[,<api name>...]...

--ws-api=ETH,NET,WEB3

ws-api=["ETH","NET","WEB3"]

Comma-separated APIs to enable on Websockets channel. When you use this option, the --ws-enabled option must also be specified. The available API options are: ETH, NET, WEB3, CLIQUE, IBFT, DEBUG, and MINER. The default is: ETH, NET, WEB3, CLIQUE, IBFT.

!!!note 🚧 IBFT is not currently supported. Support for IBFT is in active development.

ws-listen

--ws-listen=<HOST:PORT>

# to listen on all interfaces on port 6174
--ws-listen=0.0.0.0:6174

ws-listen="0.0.0.0:6174"

Host and port for WS-RPC (Websocket) to listen on. The default is 127.0.0.1:8546.

!!!note This option is not used when running Pantheon from the Docker image.

ws-refresh-delay

--ws-refresh-delay=<refresh delay>

--ws-refresh-delay="10000"

Refresh delay for Websocket synchronizing subscription in milliseconds. The default is 5000.

help

-h, --help

Show the help message and exit.

logging

-l, --logging=<LEVEL>

--logging=DEBUG

logging="DEBUG"

Sets the logging verbosity. Log levels are OFF, FATAL, WARN, INFO, DEBUG, TRACE, ALL. Default is INFO.

version

  -V, --version

Print version information and exit.

Commands

Pantheon subcommands are:

import

$ pantheon import <block-file>

$ pantheon import /home/me/me_project/mainnet.blocks

Imports blocks from the specified file into the blockchain database

export-pub-key

$ pantheon export-pub-key <key-file>

$ pantheon export-pub-key /home/me/me_project/not_precious_pub_key

Exports node public key to the specified file.