Expand description
HOPR daemon application providing a higher level interface for creating a HOPRd with or without a dedicated REST API.
When the Rest API is enabled, the node serves a Swagger UI to inspect and test the Rest API v3 at: http://localhost:3001/scalar or http://localhost:3001/swagger-ui
NOTE: Hostname and port can be different, since they depend on the settings --apiHost and --apiPort.
§Usage
See hoprd --help for full list.
$ hoprd --help
Contains the main entry point of HOPR daemon applicatio
Usage: hoprd [OPTIONS]
Options:
--network <NETWORK>
ID of the network the node will attempt to connect to [env: HOPRD_NETWORK=]
--identity <IDENTITY>
The path to the identity file [env: HOPRD_IDENTITY=]
--data <DATA>
Specifies the directory to hold all the data [env: HOPRD_DATA=]
--host <HOST>
Host to listen on for P2P connections [env: HOPRD_HOST=]
--announce
Announce the node on chain with a public address [env: HOPRD_ANNOUNCE=]
--api
Expose the API on localhost:3001 [env: HOPRD_API=]
--apiHost <HOST>
Set host IP to which the API server will bind [env: HOPRD_API_HOST=]
--apiPort <PORT>
Set port to which the API server will bind [env: HOPRD_API_PORT=]
--apiToken <TOKEN>
A REST API token and for user authentication [env: HOPRD_API_TOKEN=]
--password <PASSWORD>
A password to encrypt your keys [env: HOPRD_PASSWORD=]
--disableUnrealizedBalanceCheck
Disables checking of unrealized balance before validating unacknowledged tickets. [env: HOPRD_DISABLE_UNREALIZED_BALANCE_CHECK=]
--provider <PROVIDER>
A custom RPC provider to be used for the node to connect to blockchain [env: HOPRD_PROVIDER=]
--init
initialize a database if it doesn't already exist [env: HOPRD_INIT=]
--forceInit
initialize a database, even if it already exists [env: HOPRD_FORCE_INIT=]
--inbox-capacity <INBOX_CAPACITY>
Set maximum capacity of the HOPRd inbox [env: HOPRD_INBOX_CAPACITY=]
--testAnnounceLocalAddresses
For testing local testnets. Announce local addresses [env: HOPRD_TEST_ANNOUNCE_LOCAL_ADDRESSES=]
--heartbeatInterval <MILLISECONDS>
Interval in milliseconds in which the availability of other nodes get measured [env: HOPRD_HEARTBEAT_INTERVAL=]
--heartbeatThreshold <MILLISECONDS>
Timeframe in milliseconds after which a heartbeat to another peer is performed, if it hasn't been seen since [env: HOPRD_HEARTBEAT_THRESHOLD=]
--heartbeatVariance <MILLISECONDS>
Upper bound for variance applied to heartbeat interval in milliseconds [env: HOPRD_HEARTBEAT_VARIANCE=]
--networkQualityThreshold <THRESHOLD>
Minimum quality of a peer connection to be considered usable [env: HOPRD_NETWORK_QUALITY_THRESHOLD=]
--configurationFilePath <CONFIG_FILE_PATH>
Path to a file containing the entire HOPRd configuration [env: HOPRD_CONFIGURATION_FILE_PATH=]
--safeTransactionServiceProvider <HOPRD_SAFE_TX_SERVICE_PROVIDER>
Base URL for safe transaction service [env: HOPRD_SAFE_TRANSACTION_SERVICE_PROVIDER=]
--safeAddress <HOPRD_SAFE_ADDR>
Address of Safe that safeguards tokens [env: HOPRD_SAFE_ADDRESS=]
--moduleAddress <HOPRD_MODULE_ADDR>
Address of the node mangement module [env: HOPRD_MODULE_ADDRESS=]
--protocolConfig <HOPRD_PROTOCOL_CONFIG_PATH>
Path to the protocol-config.json file [env: HOPRD_PROTOCOL_CONFIG_PATH=]
-h, --help
Print help
-V, --version
Print version