mirror of https://github.com/hyperledger/besu
An enterprise-grade Java-based, Apache 2.0 licensed Ethereum client https://wiki.hyperledger.org/display/besu
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
1144 lines
29 KiB
1144 lines
29 KiB
description: Pantheon command line interface reference
|
|
<!--- END of page meta data -->
|
|
|
|
# Pantheon Command Line
|
|
|
|
!!! important "Breaking Changes in v0.9"
|
|
In v0.9, the command line changed to improve usability. These are breaking changes; that is,
|
|
in many cases the v0.8 command line options no longer work.
|
|
This reference and the rest of the documentation has been updated to reflect these changes. The [release notes](https://github.com/PegaSysEng/pantheon/blob/master/CHANGELOG.md)
|
|
include a mapping of the previous command line options to the new options.
|
|
|
|
This reference describes the syntax of the Pantheon Command Line Interface (CLI) options and subcommands.
|
|
|
|
```bash
|
|
pantheon [OPTIONS] [COMMAND]
|
|
```
|
|
|
|
Runs the Pantheon Ethereum full node client.
|
|
|
|
!!!tip
|
|
Use a [configuration file](../Configuring-Pantheon/Using-Configuration-File.md) to save the command line options in a file.
|
|
|
|
## Options
|
|
|
|
### banned-node-ids
|
|
|
|
```bash tab="Syntax"
|
|
--banned-node-ids=<bannedNodeId>[,<bannedNodeId>...]...
|
|
```
|
|
|
|
```bash tab="Example Command Line"
|
|
--banned-nodeids=0xc35c3...d615f,0xf42c13...fc456
|
|
```
|
|
|
|
```bash tab="Example Configuration File"
|
|
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.
|
|
|
|
!!!tip
|
|
The singular `--banned-node-id` and plural `--banned-node-ids` are available and are two
|
|
names for the same option.
|
|
|
|
### bootnodes
|
|
|
|
```bash tab="Syntax"
|
|
--bootnodes[=<enode://id@host:port>[,<enode://id@host:port>...]...]
|
|
```
|
|
|
|
```bash tab="Example Command Line"
|
|
--bootnodes=enode://c35c3...d615f@1.2.3.4:30303,enode://f42c13...fc456@1.2.3.5:30303
|
|
```
|
|
|
|
```bash tab="Example Configuration File"
|
|
bootnodes=["enode://c35c3...d615f@1.2.3.4:30303","enode://f42c13...fc456@1.2.3.5:30303"]
|
|
```
|
|
|
|
```bash tab="Example Node Acting as Bootnode"
|
|
--bootnodes
|
|
```
|
|
|
|
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.
|
|
|
|
On custom networks defined by [`--genesis-file`](#genesis-file) option,
|
|
an empty list of bootnodes is defined by default unless you define custom bootnodes as described in
|
|
[private network documentation](../Configuring-Pantheon/Bootnodes.md#bootnodes).
|
|
|
|
!!! note
|
|
Specifying that a node is a [bootnode](../Configuring-Pantheon/Bootnodes.md#bootnodes)
|
|
must be done on the command line using [`--bootnodes`](#bootnodes) option without value,
|
|
not in a [configuration file](../Configuring-Pantheon/Using-Configuration-File.md).
|
|
|
|
### config-file
|
|
|
|
```bash tab="Syntax"
|
|
--config-file=<FILE>
|
|
```
|
|
|
|
```bash tab="Example Command Line"
|
|
--config-file=/home/me/me_node/config.toml
|
|
```
|
|
|
|
The path to the [TOML configuration file](../Configuring-Pantheon/Using-Configuration-File.md).
|
|
The default is `none`.
|
|
|
|
!!!note
|
|
This option is not used when running Pantheon from the [Docker image](../Getting-Started/Run-Docker-Image.md#custom-configuration-file) or in a [configuration file](../Configuring-Pantheon/Using-Configuration-File.md).
|
|
|
|
### data-path
|
|
|
|
```bash tab="Syntax"
|
|
--data-path=<PATH>
|
|
```
|
|
|
|
```bash tab="Example Command Line"
|
|
--data-path=/home/me/me_node
|
|
```
|
|
|
|
```bash tab="Example Configuration File"
|
|
data-path="/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](../Getting-Started/Run-Docker-Image.md#data-directory).
|
|
|
|
### discovery-enabled
|
|
|
|
```bash tab="Syntax"
|
|
--discovery-enabled=false
|
|
```
|
|
|
|
```bash tab="Example Configuration File"
|
|
discovery-enabled=false
|
|
```
|
|
|
|
Enables or disables P2P peer discovery.
|
|
The default is `true`.
|
|
|
|
### genesis-file
|
|
|
|
Genesis file is used to create a custom network.
|
|
|
|
!!!tip
|
|
To use a public Ethereum network such as Rinkeby, use the [`--network`](#network) option.
|
|
The network option defines the genesis file for public networks.
|
|
|
|
```bash tab="Syntax"
|
|
--genesis-file=<FILE>
|
|
```
|
|
|
|
```bash tab="Example Command Line"
|
|
--genesis-file=/home/me/me_node/customGenesisFile.json
|
|
```
|
|
|
|
```bash tab="Example Configuration File"
|
|
genesis-file="/home/me/me_node/customGenesisFile.json"
|
|
```
|
|
|
|
The path to the genesis file.
|
|
|
|
!!!important
|
|
The [`--genesis-file`](#genesis-file) and [`--network`](#network) option can't be used at the same time.
|
|
|
|
!!!note
|
|
This option is not used when running Pantheon from the [Docker image](../Getting-Started/Run-Docker-Image.md#custom-genesis-file).
|
|
|
|
### host-whitelist
|
|
|
|
```bash tab="Syntax"
|
|
--host-whitelist=<hostname>[,<hostname>...]... or * or all
|
|
```
|
|
|
|
```bash tab="Example Command Line"
|
|
--host-whitelist=medomain.com,meotherdomain.com
|
|
```
|
|
|
|
```bash tab="Example Configuration File"
|
|
host-whitelist=["medomain.com", "meotherdomain.com"]
|
|
```
|
|
|
|
Comma-separated list of hostnames to allow [access to the JSON-RPC API](../JSON-RPC-API/Using-JSON-RPC-API.md#host-whitelist).
|
|
By default, access from `localhost` and `127.0.0.1` is accepted.
|
|
|
|
!!!tip
|
|
To allow all hostnames, use `*` or `all`. We don't recommend allowing all hostnames for production code.
|
|
|
|
### max-peers
|
|
|
|
```bash tab="Syntax"
|
|
--max-peers=<INTEGER>
|
|
```
|
|
|
|
```bash tab="Example Command Line"
|
|
--max-peers=42
|
|
```
|
|
|
|
```bash tab="Example Configuration File"
|
|
max-peers=42
|
|
```
|
|
|
|
Specifies the maximum P2P peer connections that can be established.
|
|
The default is 25.
|
|
|
|
### metrics-category
|
|
|
|
```bash tab="Syntax"
|
|
--metrics-category=<metrics-category>[,metrics-category...]...
|
|
```
|
|
|
|
```bash tab="Example Command Line"
|
|
--metrics-category=BLOCKCHAIN,PEERS,PROCESS
|
|
```
|
|
|
|
```bash tab="Example Configuration File"
|
|
metrics-category=["BLOCKCHAIN","PEERS","PROCESS"]
|
|
```
|
|
|
|
Comma separated list of categories for which to track metrics. The default is all categories:
|
|
`BIG_QUEUE`, `BLOCKCHAIN`, `EXECUTORS`, `JVM`, `NETWORK`, `PEERS`, `PROCESS`, `ROCKSDB`, `RPC`, `SYNCHRONIZER`.
|
|
|
|
### metrics-enabled
|
|
|
|
```bash tab="Syntax"
|
|
--metrics-enabled
|
|
```
|
|
|
|
```bash tab="Example Configuration File"
|
|
metrics-enabled=true
|
|
```
|
|
|
|
Set to `true` to enable the [metrics exporter](../Using-Pantheon/Debugging.md#monitor-node-performance-using-prometheus).
|
|
The default is `false`.
|
|
|
|
`--metrics-enabled` cannot be specified with `--metrics-push-enabled`. That is, either Prometheus polling or Prometheus
|
|
push gateway support can be enabled but not both at once.
|
|
|
|
### metrics-host
|
|
|
|
```bash tab="Syntax"
|
|
--metrics-host=<HOST>
|
|
```
|
|
|
|
```bash tab="Example Command Line"
|
|
--metrics-host=127.0.0.1
|
|
```
|
|
|
|
```bash tab="Example Configuration File"
|
|
metrics-host="127.0.0.1"
|
|
```
|
|
|
|
Specifies the host on which [Prometheus](https://prometheus.io/) accesses [Pantheon metrics](../Using-Pantheon/Debugging.md#monitor-node-performance-using-prometheus).
|
|
The metrics server respects the [`--host-whitelist` option](#host-whitelist).
|
|
|
|
The default is `127.0.0.1`.
|
|
|
|
### metrics-port
|
|
|
|
```bash tab="Syntax"
|
|
--metrics-port=<PORT>
|
|
```
|
|
|
|
```bash tab="Example Command Line"
|
|
--metrics-port=6174
|
|
```
|
|
|
|
```bash tab="Example Configuration File"
|
|
metrics-port="6174"
|
|
```
|
|
|
|
Specifies the port (TCP) on which [Prometheus](https://prometheus.io/) accesses [Pantheon metrics](../Using-Pantheon/Debugging.md#monitor-node-performance-using-prometheus).
|
|
The default is `9545`. Ports must be [exposed appropriately](../Configuring-Pantheon/Networking.md#port-configuration).
|
|
|
|
### metrics-push-enabled
|
|
|
|
```bash tab="Syntax"
|
|
--metrics-push-enabled[=<true|false>]
|
|
```
|
|
|
|
```bash tab="Example Command Line"
|
|
--metrics-push-enabled
|
|
```
|
|
|
|
```bash tab="Example Configuration File"
|
|
metrics-push-enabled="true"
|
|
```
|
|
|
|
Set to `true` to start the [push gateway integration](../Using-Pantheon/Debugging.md#running-prometheus-with-pantheon-in-push-mode).
|
|
|
|
`--metrics-push-enabled` cannot be specified with `--metrics-enabled`. That is, either Prometheus polling or Prometheus
|
|
push gateway support can be enabled but not both at once.
|
|
|
|
### metrics-push-host
|
|
|
|
```bash tab="Syntax"
|
|
--metrics-push-host=<HOST>
|
|
```
|
|
|
|
```bash tab="Example Command Line"
|
|
--metrics-push-host=127.0.0.1
|
|
```
|
|
|
|
```bash tab="Example Configuration File"
|
|
metrics-push-host="127.0.0.1"
|
|
```
|
|
|
|
Host of the [Prometheus Push Gateway](https://github.com/prometheus/pushgateway).
|
|
The default is `127.0.0.1`.
|
|
The metrics server respects the [`--host-whitelist` option](#host-whitelist).
|
|
|
|
!!! note
|
|
When pushing metrics, ensure `--metrics-push-host` is set to the machine on which the push gateway is.
|
|
Generally, this will be a different machine to the machine on which Pantheon is running.
|
|
|
|
### metrics-push-interval
|
|
|
|
```bash tab="Syntax"
|
|
--metrics-push-interval=<INTEGER>
|
|
```
|
|
|
|
```bash tab="Example Command Line"
|
|
--metrics-push-interval=30
|
|
```
|
|
|
|
```bash tab="Example Configuration File"
|
|
metrics-push-interval=30
|
|
```
|
|
|
|
Interval in seconds to push metrics when in `push` mode. The default is 15.
|
|
|
|
### metrics-push-port
|
|
|
|
```bash tab="Syntax"
|
|
--metrics-push-port=<PORT>
|
|
```
|
|
|
|
```bash tab="Example Command Line"
|
|
--metrics-push-port=6174
|
|
```
|
|
|
|
```bash tab="Example Configuration File"
|
|
metrics-push-port="6174"
|
|
```
|
|
|
|
Port (TCP) of the [Prometheus Push Gateway](https://github.com/prometheus/pushgateway).
|
|
The default is `9001`. Ports must be [exposed appropriately](../Configuring-Pantheon/Networking.md#port-configuration).
|
|
|
|
### metrics-push-prometheus-job
|
|
|
|
```bash tab="Syntax"
|
|
--metrics-prometheus-job=<metricsPrometheusJob>
|
|
```
|
|
|
|
```bash tab="Example Command Line"
|
|
--metrics-prometheus-job="my-custom-job"
|
|
```
|
|
|
|
```bash tab="Example Configuration File"
|
|
metrics-prometheus-job="my-custom-job"
|
|
```
|
|
|
|
Job name when in `push` mode. The default is `pantheon-client`.
|
|
|
|
### miner-coinbase
|
|
|
|
```bash tab="Syntax"
|
|
--miner-coinbase=<Ethereum account address>
|
|
```
|
|
|
|
```bash tab="Example Command Line"
|
|
--miner-coinbase=fe3b557e8fb62b89f4916b721be55ceb828dbd73
|
|
```
|
|
|
|
```bash tab="Example Configuration File"
|
|
--miner-coinbase="0xfe3b557e8fb62b89f4916b721be55ceb828dbd73"
|
|
```
|
|
|
|
Account to which mining rewards are paid.
|
|
You must specify a valid coinbase when you enable mining using the [`--miner-enabled`](#miner-enabled)
|
|
option or the [`miner_start`](JSON-RPC-API-Methods.md#miner_start) JSON RPC-API method.
|
|
|
|
!!!note
|
|
This option is ignored in networks using [Clique](../Consensus-Protocols/Clique.md) and [IBFT 2.0](../Consensus-Protocols/IBFT.md) consensus protocols.
|
|
|
|
### miner-enabled
|
|
|
|
```bash tab="Syntax"
|
|
--miner-enabled
|
|
```
|
|
|
|
```bash tab="Example Configuration File"
|
|
miner-enabled=true
|
|
```
|
|
|
|
Enables mining when the node is started.
|
|
Default is `false`.
|
|
|
|
### miner-extra-data
|
|
|
|
```bash tab="Syntax"
|
|
--miner-extra-data=<Extra data>
|
|
```
|
|
|
|
```bash tab="Example Command Line"
|
|
--miner-extra-data=0x444F4E27542050414E4943202120484F444C2C20484F444C2C20484F444C2021
|
|
```
|
|
|
|
```bash tab="Example Configuration File"
|
|
miner-extra-data="0x444F4E27542050414E4943202120484F444C2C20484F444C2C20484F444C2021"
|
|
```
|
|
|
|
A hex string representing the 32 bytes to be included in the extra data field of a mined block.
|
|
The default is 0x.
|
|
|
|
### min-gas-price
|
|
|
|
```bash tab="Syntax"
|
|
--min-gas-price=<minTransactionGasPrice>
|
|
```
|
|
|
|
```bash tab="Example Command Line"
|
|
--min-gas-price=1337
|
|
```
|
|
|
|
```bash tab="Example Configuration File"
|
|
min-gas-price="1337"
|
|
```
|
|
|
|
The minimum price that a transaction offers for it to be included in a mined block.
|
|
The default is 1000.
|
|
|
|
### network
|
|
|
|
```bash tab="Syntax"
|
|
--network=<NETWORK>
|
|
```
|
|
|
|
```bash tab="Example Command Line"
|
|
--network=rinkeby
|
|
```
|
|
|
|
```bash tab="Example Configuration File"
|
|
network="rinkeby"
|
|
```
|
|
|
|
Predefined network configuration.
|
|
The default is `mainnet`.
|
|
|
|
Possible values are :
|
|
|
|
`mainnet`
|
|
: Main Ethereum network
|
|
|
|
`ropsten`
|
|
: PoW test network similar to current main Ethereum network.
|
|
|
|
`rinkeby`
|
|
: PoA test network using Clique.
|
|
|
|
`goerli`
|
|
: PoA test network using Clique.
|
|
|
|
`dev`
|
|
: PoW development network with a very low difficulty to enable local CPU mining.
|
|
|
|
!!!note
|
|
Values are case insensitive, so either `mainnet` or `MAINNET` works.
|
|
|
|
!!!important
|
|
The [`--network`](#network) and [`--genesis-file`](#genesis-file) option cannot be used at the same time.
|
|
|
|
### network-id
|
|
|
|
```bash tab="Syntax"
|
|
--network-id=<INTEGER>
|
|
```
|
|
|
|
```bash tab="Example Command Line"
|
|
--network-id=8675309
|
|
```
|
|
|
|
```bash tab="Example Configuration File"
|
|
network-id="8675309"
|
|
```
|
|
|
|
[P2P network identifier](../Configuring-Pantheon/NetworkID-And-ChainID.md).
|
|
|
|
This option can be used to override the default network ID.
|
|
The default value is the network chain ID defined in the genesis file.
|
|
|
|
### node-private-key-file
|
|
|
|
```bash tab="Syntax"
|
|
--node-private-key-file=<FILE>
|
|
```
|
|
|
|
```bash tab="Example Command Line"
|
|
--node-private-key-file=/home/me/me_node/myPrivateKey
|
|
```
|
|
|
|
```bash tab="Example Configuration File"
|
|
node-private-key-file="/home/me/me_node/myPrivateKey"
|
|
```
|
|
|
|
`<FILE>` 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 not used when running Pantheon from the [Docker image](../Getting-Started/Run-Docker-Image.md).
|
|
|
|
### p2p-enabled
|
|
|
|
```bash tab="Syntax"
|
|
--p2p-enabled=<true|false>
|
|
```
|
|
|
|
```bash tab="Command line"
|
|
--p2p-enabled=false
|
|
```
|
|
|
|
```bash tab="Example Configuration File"
|
|
p2p-enabled=false
|
|
```
|
|
|
|
Enables or disables all p2p communication.
|
|
The default is true.
|
|
|
|
### p2p-host
|
|
|
|
```bash tab="Syntax"
|
|
--p2p-host=<HOST>
|
|
```
|
|
|
|
```bash tab="Example Command Line"
|
|
# to listen on all interfaces
|
|
--p2p-host=0.0.0.0
|
|
```
|
|
|
|
```bash tab="Example Configuration File"
|
|
p2p-host="0.0.0.0"
|
|
```
|
|
|
|
Specifies the host on which P2P listens.
|
|
The default is 127.0.0.1.
|
|
|
|
!!!note
|
|
This option is not used when running Pantheon from the [Docker image](../Getting-Started/Run-Docker-Image.md#exposing-ports).
|
|
|
|
### p2p-port
|
|
|
|
```bash tab="Syntax"
|
|
--p2p-port=<PORT>
|
|
```
|
|
|
|
```bash tab="Example Command Line"
|
|
# to listen on port 1789
|
|
--p2p-port=1789
|
|
```
|
|
|
|
```bash tab="Example Configuration File"
|
|
p2p-port="1789"
|
|
```
|
|
|
|
Specifies the P2P listening ports (UDP and TCP).
|
|
The default is 30303. Ports must be [exposed appropriately](../Configuring-Pantheon/Networking.md#port-configuration).
|
|
|
|
!!!note
|
|
This option is not used when running Pantheon from the [Docker image](../Getting-Started/Run-Docker-Image.md#exposing-ports).
|
|
|
|
### permissions-accounts-enabled
|
|
|
|
```bash tab="Syntax"
|
|
--permissions-accounts-enabled[=<true|false>]
|
|
```
|
|
|
|
```bash tab="Example Command Line"
|
|
--permissions-accounts-enabled
|
|
```
|
|
|
|
```bash tab="Example Configuration File"
|
|
permissions-accounts-enabled=true
|
|
```
|
|
|
|
Set to enable account level permissions.
|
|
|
|
The default is `false`.
|
|
|
|
### permissions-config-file
|
|
|
|
```bash tab="Syntax"
|
|
--permissions-config-file=<FILE>
|
|
```
|
|
|
|
```bash tab="Example Command Line"
|
|
--permissions-config-file=/home/me/me_configFiles/myPermissionsFile
|
|
```
|
|
|
|
```bash tab="Example Configuration File"
|
|
permissions-config-file="/home/me/me_configFiles/myPermissionsFile"
|
|
```
|
|
|
|
Path to the [permissions configuration file](../Permissions/Permissioning.md#permissions-configuration-file).
|
|
The default is the `permissions_config.toml` file in the [data directory](#data-path).
|
|
|
|
!!!note
|
|
This option is not used when running Pantheon from the [Docker image](../Getting-Started/Run-Docker-Image.md#permissions-configuration-file).
|
|
|
|
### permissions-nodes-enabled
|
|
|
|
```bash tab="Syntax"
|
|
--permissions-nodes-enabled[=<true|false>]
|
|
```
|
|
|
|
```bash tab="Example Command Line"
|
|
--permissions-nodes-enabled
|
|
```
|
|
|
|
```bash tab="Example Configuration File"
|
|
permissions-nodes-enabled=true
|
|
```
|
|
|
|
Set to enable node level permissions.
|
|
The default is `false`.
|
|
|
|
### privacy-enabled
|
|
|
|
```bash tab="Syntax"
|
|
--privacy-enabled[=<true|false>]
|
|
```
|
|
|
|
```bash tab="Example Command Line"
|
|
--privacy-enabled=false
|
|
```
|
|
|
|
```bash tab="Example Configuration File"
|
|
privacy-enabled=false
|
|
```
|
|
|
|
Set to enable private transactions.
|
|
The default is false.
|
|
|
|
!!!note
|
|
Privacy is under development and will be available in v1.1.
|
|
|
|
### privacy-precompiled-address
|
|
|
|
```bash tab="Syntax"
|
|
--privacy-precompiled-address=<privacyPrecompiledAddress>
|
|
```
|
|
|
|
Address to which the privacy pre-compiled contract is mapped.
|
|
The default is 126.
|
|
|
|
!!!note
|
|
Privacy is under development and will be available in v1.1.
|
|
|
|
### privacy-public-key-file
|
|
|
|
```bash tab="Syntax"
|
|
--privacy-public-key-file=<privacyPublicKeyFile>
|
|
```
|
|
|
|
Path to the public key for the enclave.
|
|
|
|
!!!note
|
|
Privacy is under development and will be available in v1.1.
|
|
|
|
!!!note
|
|
This option is not used when running Pantheon from the [Docker image](../Getting-Started/Run-Docker-Image.md#privacy-public-key-file).
|
|
|
|
### privacy-url
|
|
|
|
```bash tab="Syntax"
|
|
--privacy-url=<privacyUrl>
|
|
```
|
|
|
|
URL on which enclave is running.
|
|
|
|
!!!note
|
|
Privacy is under development and will be available in v1.1.
|
|
|
|
### rpc-http-api
|
|
|
|
```bash tab="Syntax"
|
|
--rpc-http-api=<api name>[,<api name>...]...
|
|
```
|
|
|
|
```bash tab="Example Command Line"
|
|
--rpc-http-api=ETH,NET,WEB3
|
|
```
|
|
|
|
```bash tab="Example Configuration File"
|
|
rpc-http-api=["ETH","NET","WEB3"]
|
|
```
|
|
|
|
Comma-separated APIs to enable on the HTTP JSON-RPC channel.
|
|
When you use this option, the `--rpc-http-enabled` option must also be specified.
|
|
The available API options are: `ADMIN`, `ETH`, `NET`, `WEB3`, `CLIQUE`, `IBFT`, `PERM`, `DEBUG`, `MINER`, `EEA`, and `TXPOOL`.
|
|
The default is: `ETH`, `NET`, `WEB3`.
|
|
|
|
!!!note
|
|
EEA methods are for privacy features. Privacy features are under development and will be available in v1.1.
|
|
|
|
!!!tip
|
|
The singular `--rpc-http-api` and plural `--rpc-http-apis` are available and are two
|
|
names for the same option.
|
|
|
|
### rpc-http-authentication-credentials-file
|
|
|
|
```bash tab="Syntax"
|
|
--rpc-http-authentication-credentials-file=<FILE>
|
|
```
|
|
|
|
```bash tab="Example Command Line"
|
|
--rpc-http-authentication-credentials-file=/home/me/me_node/auth.toml
|
|
```
|
|
|
|
```bash tab="Example Configuration File"
|
|
rpc-http-authentication-credentials-file="/home/me/me_node/auth.toml"
|
|
```
|
|
|
|
[Credentials file](../JSON-RPC-API/Authentication.md#credentials-file) for JSON-RPC API [authentication](../JSON-RPC-API/Authentication.md).
|
|
|
|
!!!note
|
|
This option is not used when running Pantheon from the [Docker image](../Getting-Started/Run-Docker-Image.md#credentials-files).
|
|
|
|
### rpc-http-authentication-enabled
|
|
|
|
```bash tab="Syntax"
|
|
--rpc-http-authentication-enabled
|
|
```
|
|
|
|
```bash tab="Example Command Line"
|
|
--rpc-http-authentication-enabled
|
|
```
|
|
|
|
```bash tab="Example Configuration File"
|
|
rpc-http-authentication-enabled=true
|
|
```
|
|
|
|
Set to `true` to require [authentication](../JSON-RPC-API/Authentication.md) for the HTTP JSON-RPC service.
|
|
|
|
### rpc-http-cors-origins
|
|
|
|
```bash tab="Syntax"
|
|
--rpc-http-cors-origins=<url>[,<url>...]... or all or *
|
|
```
|
|
|
|
```bash tab="Example Command Line"
|
|
# You can whitelist one or more domains with a comma-separated list.
|
|
|
|
--rpc-http-cors-origins="http://medomain.com","https://meotherdomain.com"
|
|
```
|
|
|
|
```bash tab="Example Configuration File"
|
|
rpc-http-cors-origins=["http://medomain.com","https://meotherdomain.com"]
|
|
```
|
|
|
|
```bash tab="Remix IDE domain example"
|
|
# The following allows Remix to interact with your Pantheon node.
|
|
|
|
--rpc-http-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 can access the node using JSON-RPC.
|
|
If your client interacts with Pantheon using a browser app (such as Remix or a block explorer),
|
|
you must whitelist the client domains.
|
|
|
|
The default value is `"none"`.
|
|
If you don't whitelist any domains, browser apps cannot interact with your Pantheon node.
|
|
|
|
!!!note
|
|
To run a local Pantheon node as a backend for MetaMask and use MetaMask anywhere, set `--rpc-http-cors-origins` to `"all"` or `"*"`.
|
|
To allow a specific domain to use MetaMask with the Pantheon node, set `--rpc-http-cors-origins` to the client domain.
|
|
|
|
!!!tip
|
|
For development purposes, you can use `"all"` or `"*"` to accept requests from any domain,
|
|
but we don't recommend this for production code.
|
|
|
|
### rpc-http-enabled
|
|
|
|
```bash tab="Syntax"
|
|
--rpc-http-enabled
|
|
```
|
|
|
|
```bash tab="Example Configuration File"
|
|
rpc-http-enabled=true
|
|
```
|
|
|
|
Set to `true` to enable the HTTP JSON-RPC service.
|
|
The default is `false`.
|
|
|
|
### rpc-http-host
|
|
|
|
```bash tab="Syntax"
|
|
--rpc-http-host=<HOST>
|
|
```
|
|
|
|
```bash tab="Example Command Line"
|
|
# to listen on all interfaces
|
|
--rpc-http-host=0.0.0.0
|
|
```
|
|
|
|
```bash tab="Example Configuration File"
|
|
rpc-http-host="0.0.0.0"
|
|
```
|
|
|
|
Specifies the host on which HTTP JSON-RPC listens.
|
|
The default is 127.0.0.1.
|
|
|
|
To allow remote connections, set to `0.0.0.0`
|
|
|
|
!!! caution
|
|
Setting the host to 0.0.0.0 exposes the RPC connection on your node to any remote connection. In a
|
|
production environment, ensure you are using a firewall to avoid exposing your node to the internet.
|
|
|
|
!!!note
|
|
This option is not used when running Pantheon from the [Docker image](../Getting-Started/Run-Docker-Image.md#exposing-ports).
|
|
|
|
### rpc-http-port
|
|
|
|
```bash tab="Syntax"
|
|
--rpc-http-port=<PORT>
|
|
```
|
|
|
|
```bash tab="Example Command Line"
|
|
# to listen on port 3435
|
|
--rpc-http-port=3435
|
|
```
|
|
|
|
```bash tab="Example Configuration File"
|
|
rpc-http-port="3435"
|
|
```
|
|
|
|
Specifies HTTP JSON-RPC listening port (TCP).
|
|
The default is 8545. Ports must be [exposed appropriately](../Configuring-Pantheon/Networking.md#port-configuration).
|
|
|
|
!!!note
|
|
This option is not used when running Pantheon from the [Docker image](../Getting-Started/Run-Docker-Image.md#exposing-ports).
|
|
|
|
### rpc-ws-api
|
|
|
|
```bash tab="Syntax"
|
|
--rpc-ws-api=<api name>[,<api name>...]...
|
|
```
|
|
|
|
```bash tab="Example Command Line"
|
|
--rpc-ws-api=ETH,NET,WEB3
|
|
```
|
|
|
|
```bash tab="Example Configuration File"
|
|
rpc-ws-api=["ETH","NET","WEB3"]
|
|
```
|
|
|
|
Comma-separated APIs to enable on WebSockets channel.
|
|
When you use this option, the `--rpc-ws-enabled` option must also be specified.
|
|
The available API options are: `ADMIN`,`ETH`, `NET`, `WEB3`, `CLIQUE`, `IBFT`, `PERM', DEBUG`, `MINER`, `EEA`, and `TXPOOL`.
|
|
The default is: `ETH`, `NET`, `WEB3`.
|
|
|
|
!!!note
|
|
EEA methods are for privacy features. Privacy features are under development and will be available in v1.1.
|
|
|
|
!!!tip
|
|
The singular `--rpc-ws-api` and plural `--rpc-ws-apis` are available and are just two
|
|
names for the same option.
|
|
|
|
### rpc-ws-authentication-credentials-file
|
|
|
|
```bash tab="Syntax"
|
|
--rpc-ws-authentication-credentials-file=<FILE>
|
|
```
|
|
|
|
```bash tab="Example Command Line"
|
|
--rpc-ws-authentication-credentials-file=/home/me/me_node/auth.toml
|
|
```
|
|
|
|
```bash tab="Example Configuration File"
|
|
rpc-ws-authentication-credentials-file="/home/me/me_node/auth.toml"
|
|
```
|
|
|
|
[Credentials file](../JSON-RPC-API/Authentication.md#credentials-file) for JSON-RPC API [authentication](../JSON-RPC-API/Authentication.md).
|
|
|
|
!!!note
|
|
This option is not used when running Pantheon from the [Docker image](../Getting-Started/Run-Docker-Image.md#credentials-files).
|
|
|
|
### rpc-ws-authentication-enabled
|
|
|
|
```bash tab="Syntax"
|
|
--rpc-ws-authentication-enabled
|
|
```
|
|
|
|
```bash tab="Example Command Line"
|
|
--rpc-ws-authentication-enabled
|
|
```
|
|
|
|
```bash tab="Example Configuration File"
|
|
rpc-ws-authentication-enabled=true
|
|
```
|
|
|
|
Set to `true` to require [authentication](../JSON-RPC-API/Authentication.md) for the WebSockets JSON-RPC service.
|
|
|
|
!!! note
|
|
`wscat` does not support headers. [Authentication](../JSON-RPC-API/Authentication.md) requires an authentication token to be passed in the
|
|
request header. To use authentication with WebSockets, an app that supports headers is required.
|
|
|
|
### rpc-ws-enabled
|
|
|
|
```bash tab="Syntax"
|
|
--rpc-ws-enabled
|
|
```
|
|
|
|
```bash tab="Example Configuration File"
|
|
rpc-ws-enabled=true
|
|
```
|
|
|
|
Set to `true` to enable the WebSockets JSON-RPC service.
|
|
The default is `false`.
|
|
|
|
### rpc-ws-host
|
|
|
|
```bash tab="Syntax"
|
|
--rpc-ws-host=<HOST>
|
|
```
|
|
|
|
```bash tab="Example Command Line"
|
|
# to listen on all interfaces
|
|
--rpc-ws-host=0.0.0.0
|
|
```
|
|
|
|
```bash tab="Example Configuration File"
|
|
rpc-ws-host="0.0.0.0"
|
|
```
|
|
|
|
Host for Websocket WS-RPC to listen on.
|
|
The default is 127.0.0.1.
|
|
|
|
To allow remote connections, set to `0.0.0.0`
|
|
|
|
!!!note
|
|
This option is not used when running Pantheon from the [Docker image](../Getting-Started/Run-Docker-Image.md#exposing-ports).
|
|
|
|
### rpc-ws-port
|
|
|
|
```bash tab="Syntax"
|
|
--rpc-ws-port=<PORT>
|
|
```
|
|
|
|
```bash tab="Example Command Line"
|
|
# to listen on port 6174
|
|
--rpc-ws-port=6174
|
|
```
|
|
|
|
```bash tab="Example Configuration File"
|
|
rpc-ws-port="6174"
|
|
```
|
|
|
|
Specifies Websockets JSON-RPC listening port (TCP).
|
|
The default is 8546. Ports must be [exposed appropriately](../Configuring-Pantheon/Networking.md#port-configuration).
|
|
|
|
!!!note
|
|
This option is not used when running Pantheon from the [Docker image](../Getting-Started/Run-Docker-Image.md#exposing-ports).
|
|
|
|
### tx-pool-max-size
|
|
|
|
```bash tab="Syntax"
|
|
--tx-pool-max-size=<INTEGER>
|
|
```
|
|
|
|
```bash tab="Example Command Line"
|
|
--tx-pool-max-size=2000
|
|
```
|
|
|
|
```bash tab="Example Configuration File"
|
|
tx-pool-max-size="2000"
|
|
```
|
|
|
|
Maximum number of transactions kept in the transaction pool. Default is 4096.
|
|
|
|
### help
|
|
|
|
```bash tab="Syntax"
|
|
-h, --help
|
|
```
|
|
|
|
Show the help message and exit.
|
|
|
|
### logging
|
|
|
|
```bash tab="Syntax"
|
|
-l, --logging=<LEVEL>
|
|
```
|
|
|
|
```bash tab="Example Command Line"
|
|
--logging=DEBUG
|
|
```
|
|
|
|
```bash tab="Example Configration File"
|
|
logging="DEBUG"
|
|
```
|
|
|
|
Sets the logging verbosity.
|
|
Log levels are `OFF`, `FATAL`, `WARN`, `INFO`, `DEBUG`, `TRACE`, `ALL`.
|
|
Default is `INFO`.
|
|
|
|
### version
|
|
|
|
```bash tab="Syntax"
|
|
-V, --version
|
|
```
|
|
|
|
Print version information and exit.
|
|
|
|
## Commands
|
|
|
|
Pantheon subcommands are:
|
|
|
|
### blocks
|
|
|
|
This command provides blocks related actions.
|
|
|
|
#### import
|
|
|
|
```bash tab="Syntax"
|
|
$ pantheon blocks import --from=<block-file>
|
|
```
|
|
|
|
```bash tab="Example"
|
|
$ pantheon blocks import --from=/home/me/me_project/mainnet.blocks
|
|
```
|
|
|
|
Imports blocks from the specified file into the blockchain database
|
|
|
|
### public-key
|
|
|
|
This command provides node public key related actions.
|
|
|
|
#### export
|
|
|
|
```bash tab="Syntax"
|
|
$ pantheon public-key export [--to=<key-file>]
|
|
```
|
|
|
|
```bash tab="Example (to standard output)"
|
|
$ pantheon --data-path=<node data path> public-key export
|
|
```
|
|
|
|
```bash tab="Example (to file)"
|
|
$ pantheon --data-path=<node data path> public-key export --to=/home/me/me_project/not_precious_pub_key
|
|
```
|
|
|
|
Outputs the node public key to standard output or writes it to the specified file if
|
|
`--to=<key-file>` is specified.
|
|
|
|
#### export-address
|
|
|
|
```bash tab="Syntax"
|
|
$ pantheon public-key export-address [--to=<address-file>]
|
|
```
|
|
|
|
```bash tab="Example (to standard output)"
|
|
$ pantheon --data-path=<node data path> public-key export-address
|
|
```
|
|
|
|
```bash tab="Example (to file)"
|
|
$ pantheon --data-path=<node data path> public-key export-address --to=/home/me/me_project/me_node_address
|
|
```
|
|
|
|
Outputs the node public key address to standard output or writes it to the specified file if
|
|
`--to=<key-file>` is specified.
|
|
|
|
### password
|
|
|
|
This command provides password related actions.
|
|
|
|
#### hash
|
|
|
|
This command generates the hash of a given password. Include the hash in the [credentials file](../JSON-RPC-API/Authentication.md#credentials-file)
|
|
for JSON-RPC API [authentication](../JSON-RPC-API/Authentication.md).
|
|
|
|
```bash tab="Syntax"
|
|
$ pantheon password hash --password=<my-password>
|
|
```
|
|
|
|
```bash tab="Example"
|
|
$ pantheon password hash --password=myPassword123
|
|
```
|
|
|
|
### rlp
|
|
|
|
This command provides RLP related actions.
|
|
|
|
#### encode
|
|
|
|
This command encodes a typed JSON value from a file or from the standard input into an RLP hexadecimal string.
|
|
|
|
```bash tab="Syntax"
|
|
$ pantheon rlp encode [--from=<FILE>] [--to=<FILE>] [--type=<type>]
|
|
```
|
|
|
|
```bash tab="File Example"
|
|
$ pantheon rlp encode --from=ibft_extra_data.json --to=extra_data_for_ibft_genesis.txt --type=IBFT_EXTRA_DATA
|
|
```
|
|
|
|
```bash tab="Standart Input/Output Example"
|
|
$ cat extra_data.json | pantheon rlp encode > rlp.txt
|
|
```
|
|
|
|
The `IBFT_EXTRA_DATA` type is the only type supported for RLP encoding.
|
|
This data is included in the [IBFT 2.0 genesis file](../Consensus-Protocols/IBFT.md#genesis-file).
|
|
|
|
???+ summary "IBFT 2.0 Extra Data"
|
|
To generate the RLP encoded `extraData` string, specify a JSON input that is array of validator addresses
|
|
in ascending order.
|
|
|
|
??? tip "JSON Schema for IBFT_EXTRA_DATA"
|
|
The following JSON Schema can be used to validate that your JSON data is well formed. You can use an online validation tool
|
|
such as https://www.jsonschemavalidator.net/ to validate your JSON content.
|
|
|
|
```json
|
|
{
|
|
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
"$id": "http://tech.pegasys.pantheon/cli_rlp_ibft_extra_data.json",
|
|
"type": "array",
|
|
"definitions": {},
|
|
"title": "IBFT extra data",
|
|
"description":"JSON format used as input to generate an IBFT extra data RLP string",
|
|
"items": {
|
|
"$id": "#/address",
|
|
"type": "string",
|
|
"title": "Validator address",
|
|
"description":"The validator node address",
|
|
"default": "",
|
|
"examples": [
|
|
"be068f726a13c8d46c44be6ce9d275600e1735a4",
|
|
"5ff6f4b66a46a2b2310a6f3a93aaddc0d9a1c193"
|
|
],
|
|
"pattern":"^([0-9a-f]{40})$"
|
|
}
|
|
}
|
|
```
|
|
|
|
!!!example "Example IBFT_EXTRA_DATA encoding"
|
|
```json tab="JSON Input"
|
|
[
|
|
"be068f726a13c8d46c44be6ce9d275600e1735a4",
|
|
"5ff6f4b66a46a2b2310a6f3a93aaddc0d9a1c193"
|
|
]
|
|
```
|
|
|
|
``` tab="RLP Output"
|
|
0xf853a00000000000000000000000000000000000000000000000000000000000000000ea94be068f726a13c8d46c44be6ce9d275600e1735a4945ff6f4b66a46a2b2310a6f3a93aaddc0d9a1c193808400000000c0
|
|
``` |