deckersu/kmdexplorer repository overview

⁠Repository Overview

⁠What is kmdexplorer?

kmdexplorer is an Insight Explorer for Komodo and assetchains, providing blockchain exploration and transaction tracking capabilities. It enables users to browse blocks, transactions, addresses, and other blockchain data for Komodo (KMD) and its associated assetchains through a web-based interface.

The explorer is built on the Insight API framework and provides:

• Real-time blockchain data visualization
• Transaction history and details
• Address balance and transaction tracking
• Block explorer functionality
• WebSocket support for real-time updates

⁠Source Repository

The source code and installation scripts are available at: https://github.com/DeckerSU/komodo-explorers-install⁠

⁠Docker Hub Image

Pre-built Docker images are available on Docker Hub: https://hub.docker.com/r/deckersu/kmdexplorer⁠

⁠Quick Start with Docker

⁠Prerequisites

• Docker installed on your system
• Basic knowledge of Docker commands

⁠Basic Usage

To start the explorer with Docker using the pre-built image from Docker Hub:

docker pull deckersu/kmdexplorer:latest

docker run -v ${PWD}/.zcash-params:/home/explorer/.zcash-params \
  -v ${PWD}/.komodo:/home/explorer/.komodo \
  -e DAEMON_ARGS="-ac_public=1 -ac_name=KIP0001 -ac_supply=139419284 -ac_staked=10" \
  -e WEB_PORT=3002 \
  -p 127.0.0.1:3002:3002 \
  -it deckersu/kmdexplorer:latest

This will:

• Create .zcash-params and .komodo folders in the current directory
• Automatically populate them with necessary blockchain data
• Start the explorer on port 3002 (accessible at http://localhost:3002⁠)

Note: Currently only assetchains are supported, KMD is untested. Specifying DAEMON_ARGS is mandatory.

⁠Finding Port Numbers

To find out the port numbers (p2pport and rpcport) a coin uses, you can use the komodo-chainparams utility:

docker pull deckersu/komodo-chainparams:latest

docker run --rm deckersu/komodo-chainparams:latest <chain_parameters> | jq .

Example:

docker run --rm deckersu/komodo-chainparams:latest \
  -ac_name=BCZERO \
  -ac_supply=9999999999 \
  -ac_end=1 \
  -ac_public=1 \
  -ac_staked=50 \
  -addnode=65.21.52.182 | jq .

Response:

{
  "chainname": "BCZERO",
  "magic": 163429333,
  "magic_bytes": "d5bbbd09",
  "magic_hex": "09bdbbd5",
  "p2pport": 45833,
  "rpcport": 45834
}

⁠Docker Compose Example

Here's an example docker-compose.yml for running a specific coin:

version: '3.8'

services:
  bczero-explorer:
    image: deckersu/kmdexplorer:latest
    ports:
      - "45833:45833"
      - "3002:3002"
    volumes:
      - ./BCZERO/.zcash-params:/home/explorer/.zcash-params
      - ./BCZERO/.komodo:/home/explorer/.komodo
    environment:
      - WEB_PORT=3002
      - DAEMON_ARGS=-ac_name=BCZERO -ac_supply=9999999999 -ac_end=1 -ac_public=1 -ac_staked=50 -addnode=65.21.52.182
    restart: unless-stopped

⁠Important Notes

• Early Alpha: Docker feature for launching explorers is in early alpha version. Take this into account before usage.
• Assetchains Only: Currently only assetchains are supported, KMD is untested.
• Data Persistence: The .zcash-params and .komodo directories are mounted as volumes to persist blockchain data between container restarts.
• Port Configuration: Make sure to configure the correct ports for your specific assetchain. The web interface port is configurable via WEB_PORT environment variable.

⁠Use Cases

• Blockchain Exploration: Browse and search blocks, transactions, and addresses
• Transaction Tracking: Monitor transaction status and history
• Address Monitoring: Track balances and transaction history for specific addresses
• Network Analysis: Analyze blockchain network activity and statistics
• Development: Test and develop applications that interact with Komodo blockchains

⁠Related Resources

• Join Komodo Discord #developer channel for more information
• Insight API documentation
• Web Socket API documentation