Skip to content

Node Daemon Options Guide

Jump to bottom
Enrico Rubboli edited this page Aug 18, 2023 · 1 revision

The node-daemon command offers a variety of options to customize its behavior. This guide provides a brief overview of each option.

Usage

node-daemon testnet [OPTIONS]

Options

  • --clean-data <CLEAN_DATA>: Clean the data directory before starting.

    • Possible values: true, false

  • --blockprod-min-peers-to-produce-blocks <BLOCKPROD_MIN_PEERS_TO_PRODUCE_BLOCKS>: Minimum number of connected peers required to enable block production.

  • --storage-backend <STORAGE_BACKEND>: Specifies the storage backend to use.

  • --node-type <NODE_TYPE>: Specifies the node type.

  • --max-db-commit-attempts <MAX_DB_COMMIT_ATTEMPTS>: Maximum attempts to process a block.

  • --max-orphan-blocks <MAX_ORPHAN_BLOCKS>: Maximum capacity of the orphan blocks pool in blocks.

  • --tx-index-enabled <TX_INDEX_ENABLED>: Maintain a full transaction index.

    • Possible values: true, false

  • --p2p-addr <ADDR>: Address to bind P2P to.

  • --p2p-socks5-proxy <P2P_SOCKS5_PROXY>: Connect through a SOCKS5 proxy.

  • --p2p-boot-node <NODE>: Optional list of boot node addresses to connect to.

  • --p2p-reserved-node <NODE>: Optional list of reserved node addresses to connect to.

  • --p2p-max-inbound-connections <P2P_MAX_INBOUND_CONNECTIONS>: Maximum allowed number of inbound connections.

  • --p2p-ban-threshold <P2P_BAN_THRESHOLD>: The p2p score threshold after which a peer is banned.

  • --p2p-outbound-connection-timeout <P2P_OUTBOUND_CONNECTION_TIMEOUT>: The p2p timeout value in seconds.

  • --p2p-ping-check-period <P2P_PING_CHECK_PERIOD>: How often to send ping requests to peers (in seconds). Set to 0 to disable sending ping requests.

  • --p2p-ping-timeout <P2P_PING_TIMEOUT>: Time after which a peer is detected as dead and is disconnected (in seconds).

  • --p2p-sync-stalling-timeout <P2P_SYNC_STALLING_TIMEOUT>: A timeout after which a peer is disconnected.

  • --p2p-max-clock-diff <P2P_MAX_CLOCK_DIFF>: Maximum acceptable time difference between this node and the remote peer (in seconds). If a large difference is detected, the peer will be disconnected.

  • --max-tip-age <MAX_TIP_AGE>: A maximum tip age in seconds. The initial block download is finished if the difference between the current time and the tip time is less than this value.

  • --http-rpc-addr <ADDR>: Address to bind HTTP RPC to.

  • --http-rpc-enabled <HTTP_RPC_ENABLED>: Enable or disable HTTP RPC.

    • Possible values: true, false

  • --ws-rpc-addr <ADDR>: (DEPRECATED) Address to bind WebSocket RPC to.

  • --ws-rpc-enabled <WS_RPC_ENABLED>: (DEPRECATED) Enable or disable WebSocket RPC.

    • Possible values: true, false

  • --rpc-username <RPC_USERNAME>: Username for RPC HTTP and WebSocket server basic authorization. If not set, the cookie file is created.

  • --rpc-password <RPC_PASSWORD>: Password for RPC HTTP and WebSocket server basic authorization. If not set, the RPC cookie file is created.

  • --rpc-cookie-file <RPC_COOKIE_FILE>: Custom file path for the RPC cookie file. If not set, the cookie file is created in the data directory.

  • -h, --help: Print help information. For a summary, use -h.

Clone this wiki locally