Configuration

Provide network, wallet, and storage settings for ROS 2 nodes through environment variables or YAML.

The packages read configuration from either environment variables or a YAML file referenced in launch parameters. Use whichever is easier for your deployment and keep sensitive data (wallet passwords, managed IPFS JWTs) outside of version control.

Environment Variables

# Network and confirmation mode
export PEAQ_ROBOT_NETWORK=agung
export PEAQ_ROBOT_CONFIRMATION_MODE=FAST  # no effect: the core node submits every write in FAST mode

# Wallet keystore
export PEAQ_ROBOT_KEYSTORE=$HOME/.peaq_robot/wallet.json
export PEAQ_ROBOT_KEY_PASSWORD="super-secret"

# Event forwarding and logging
export PEAQ_ROBOT_EVENTS_ENABLED=true
export PEAQ_ROBOT_LOG_LEVEL=INFO
export PEAQ_ROBOT_LOG_FORMAT=human

If the keystore was written while PEAQ_ROBOT_KEY_PASSWORD was set, every process that opens it (core node, storage bridge, scripts, PeaqRobot()) needs the same password in its environment. When the keystore cannot be decrypted, the SDK creates a new wallet and overwrites the keystore file, and the old key is lost. Back up the keystore file before you start, and export the password in every terminal and service unit that runs a node.

core_node reads these variables through the shared configuration module. Precedence is YAML file, then launch parameters, then environment variables: a value in the YAML overrides the same launch parameter, and environment variables only fill in what neither sets. PEAQ_ROBOT_NETWORK and PEAQ_ROBOT_LOG_LEVEL only take effect through core.launch.py; when you start core_node with ros2 run or your own launch file, set network and log_level as parameters or in the YAML. storage_bridge_node has its own parameters and reads its YAML from config.yaml_path or PEAQ_ROS2_BRIDGE_YAML.

YAML Configuration

Create a copy of the example file and fill in required fields:

cp peaq_ros2_examples/config/peaq_robot.example.yaml \
   peaq_ros2_examples/config/peaq_robot.yaml

Example snippet:

network: agung  # for mainnet use wss://peaq.api.onfinality.io/public-ws (the "peaq" alias points to a retired host)

wallet:
  path: /work/peaq_wallet.json
  auto_generate: true

default_confirmation_mode: FAST

events:
  enabled: true

storage_bridge:
  storage:
    mode: pinata
    pinata:
      jwt: "<PINATA_JWT>"
      gateway_url: "https://YOUR-GATEWAY.mypinata.cloud/ipfs"
      pin: true      # both pin: true and mode: upload are needed for Pinata uploads
      mode: upload

core_node loads this file from its config.yaml_path parameter or PEAQ_ROS2_CONFIG_YAML; the storage bridge reads config.yaml_path or PEAQ_ROS2_BRIDGE_YAML. The SDK creates and saves a new wallet whenever the keystore at wallet.path is missing or cannot be read, whatever auto_generate says, so check the path before the first launch and back the file up.

Secret Management

• Keep PEAQ_ROBOT_KEY_PASSWORD in an .env file or secret manager and source it before launching nodes.
• Do not commit the populated peaq_robot.yaml to version control. Copy it per environment instead.
• Rotate managed gateway credentials regularly and store them in the same secure channel as other secrets.

Proceed to launch the core services once configuration is in place.