Skip to content

README-QBIT.md

Latest commit

 

History

History
107 lines (75 loc) · 3.18 KB

README-QBIT.md

File metadata and controls

107 lines (75 loc) · 3.18 KB
Raw

Qbit Explorer

This Luxor fork adds a QBT profile to btc-rpc-explorer v3. It connects directly to Qbit Core JSON-RPC and does not require a separate explorer database.

Supported Qbit behavior

  • Mainnet, testnet3, testnet4, signet, and regtest network identities
  • QBT, mQBT, µQBT, and bits display units
  • 60-second aggregate block target
  • 210 QBT initial block subsidy
  • Subsidy step-down every 43,200 blocks by 598/625 (regtest uses 150 blocks)
  • P2MR addresses returned by Qbit Core's current RPC shape
  • Block, transaction, mempool, peer, node-status, and RPC views

Select the Qbit profile with:

BTCEXP_COIN=QBT

Run Qbit mainnet and the explorer

The included Compose file starts the Luxor Qbit v1.0.0 image, enables txindex, retains mainnet data in a named volume, and exposes only the explorer HTTP port on localhost:

export QBIT_RPC_PASSWORD="replace-with-a-local-secret"
docker compose -f docker-compose.qbit.yml up --build -d

Open http://127.0.0.1:3002.

Check synchronization:

docker compose -f docker-compose.qbit.yml exec qbit \
  sh -lc 'qbit-cli -rpcuser="$QBIT_RPC_USER" -rpcpassword="$QBIT_RPC_PASSWORD" getblockchaininfo'

Stop services without deleting chain data:

docker compose -f docker-compose.qbit.yml down

Delete the downloaded chain data only when intentional:

docker compose -f docker-compose.qbit.yml down --volumes

The Qbit daemon image currently targets linux/amd64. Docker Desktop can emulate it on Apple Silicon. The explorer image is built for both linux/amd64 and linux/arm64.

Connect to an existing Qbit node

Build the explorer:

docker build -t luxor-qbit-explorer:local .

If the node and explorer share a Docker network named qbit-local:

docker run --rm \
  --name qbit-explorer \
  --network qbit-local \
  -p 127.0.0.1:3002:3002 \
  -e BTCEXP_COIN=QBT \
  -e BTCEXP_HOST=0.0.0.0 \
  -e BTCEXP_BITCOIND_HOST=qbit-mainnet \
  -e BTCEXP_BITCOIND_PORT=8352 \
  -e BTCEXP_BITCOIND_USER=qbitexplorer \
  -e BTCEXP_BITCOIND_PASS="replace-with-your-rpc-password" \
  -e BTCEXP_BITCOIND_RPC_TIMEOUT=30000 \
  -e BTCEXP_NO_RATES=true \
  -e BTCEXP_PRIVACY_MODE=true \
  luxor-qbit-explorer:local

For a host-installed node, point BTCEXP_BITCOIND_HOST at an address reachable from the container. Do not expose Qbit RPC to the public internet.

Required Qbit node settings

The explorer requires RPC access. An archive node with transaction indexing provides the complete experience:

server=1
txindex=1

Qbit mainnet uses RPC port 8352 and P2P port 8355.

Container image

The GitHub workflow publishes to:

ghcr.io/luxorlabs/luxor-qbit-explorer

Pushes to master publish latest and sha-<short-sha>. Tags such as v1.2.0 publish both v1.2.0 and 1.2.0.

Limitations

  • Address transaction history requires a Qbit-compatible Electrum server. Without one, block and transaction exploration still works through Qbit Core and txindex.
  • Bitcoin-specific historical and external exchange-rate integrations are disabled for Qbit.
  • Keep the UI bound to localhost or protect it with BTCEXP_BASIC_AUTH_PASSWORD before exposing it beyond a trusted network.