qubiccore/bob repository overview

⁠Qubic Bob

Qubic Bob is a high-performance indexer for the Qubic network⁠. It syncs tick data from peers, verifies integrity via quorum & log events, indexes blockchain state, and exposes it through:

• 🔌 JSON-RPC 2.0 API (HTTP & WebSocket) — Ethereum-like, designed for exchanges, dApps, and explorers.
• 🌐 REST API — for tooling that prefers plain HTTP.
• 📡 WebSocket subscriptions — real-time tickStream, newTicks, logs, transfers.

This image ships bob + KeyDB + Kvrocks in a single container — no extra services to install.

⁠🚀 Quick start

⁠One-liner

docker run -d --name qubic-bob \
  -p 21842:21842 \
  -p 40420:40420 \
  -e NODE_SEED=your_55_char_lowercase_seed_a_z_only_padded_to_55chars \
  -v qubic-bob-redis:/data/redis \
  -v qubic-bob-kvrocks:/data/kvrocks \
  -v qubic-bob-data:/data/bob \
  qubiccore/bob:latest

⁠Docker Compose

services:
  qubic-bob:
    image: qubiccore/bob:latest
    container_name: qubic-bob
    restart: unless-stopped
    ports:
      - "21842:21842"     # P2P
      - "40420:40420"     # JSON-RPC / REST / WebSocket
    environment:
      NODE_SEED: your_55_char_lowercase_seed_a_z_only_padded_to_55chars
      NODE_ALIAS: my-bob-node
      # See the full list at docs/DOCKER_ENV.md
    volumes:
      - qubic-bob-redis:/data/redis
      - qubic-bob-kvrocks:/data/kvrocks
      - qubic-bob-data:/data/bob

volumes:
  qubic-bob-redis:
  qubic-bob-kvrocks:
  qubic-bob-data:

⁠Verify it's running

# Wait ~30s after start, then:
curl -s http://localhost:40420/status | jq
curl -s -X POST http://localhost:40420/qubic \
  -H 'Content-Type: application/json' \
  -d '{"jsonrpc":"2.0","method":"qubic_getTickNumber","params":[],"id":1}'

⁠📦 Available tags

See the release notes⁠ for what changed in each version.

⁠🖥️ System requirements

Bob is memory-hungry on busy networks. KeyDB holds recent ticks in RAM before migrating to Kvrocks on disk; if the network throughput exceeds your REDIS_MAXMEMORY, you'll see OOM command not allowed when used memory > maxmemory errors in the log. See Tuning under load⁠ below.

⁠🔌 API endpoints

⁠Common JSON-RPC methods

Full reference: JSON-RPC API Guide⁠ · REST API Guide⁠ · Interactive playground⁠

⁠⚙️ Configuration

Two ways to configure, in order of preference:

1. Environment variables (recommended) — see docs/DOCKER_ENV.md⁠ for the complete reference of all 39 supported vars.
2. Mount a custom bob.json — for advanced cases where env vars aren't enough.

⁠Most-used env vars

⁠Custom bob.json

docker run -d --name qubic-bob \
  -p 21842:21842 -p 40420:40420 \
  -v ./bob.json:/app/bob.json \
  -v qubic-bob-redis:/data/redis \
  -v qubic-bob-kvrocks:/data/kvrocks \
  -v qubic-bob-data:/data/bob \
  qubiccore/bob:latest

⚠️ Do not use :ro on the bob.json mount — the entrypoint patches the file at startup.

Full bob.json reference: docs/CONFIG_FILE.MD⁠.

⁠💾 Volumes

A fresh container with no volumes will start clean every restart — fine for dev, not for guardians or production indexers.

⁠🛠️ Tuning under load

If you see Failed to add log ... OOM command not allowed:

bob logs a KeyDB memory: <used> / <max> (XX%) line roughly once per minute and immediately when usage crosses 85% — this is the cleanest signal for memory pressure.

⁠🔧 Troubleshooting

⁠🧑‍💻 For developers

• Source code: github.com/qubic/core-bob⁠
• Issue tracker: GitHub Issues⁠
• Releases: Release notes⁠ · GitHub Releases⁠
• Build from source: see README on GitHub⁠

⁠Inside the container

# View the effective config
docker exec qubic-bob jq . /app/bob.json
docker exec qubic-bob cat /etc/redis/redis.conf
docker exec qubic-bob cat /etc/kvrocks/kvrocks.conf

# Talk to KeyDB / Kvrocks directly
docker exec qubic-bob redis-cli ping            # KeyDB on 6379
docker exec qubic-bob redis-cli -p 6666 ping    # Kvrocks on 6666

# Tail bob logs
docker logs -f qubic-bob

Built with ❤️ by the Qubic Bob team. Massive thanks to @krypdkat⁠ for the original qubicbob project this is based on.