*** Indexer Docker镜像文档

概述

*** Indexer是一个专为设计的数据索引工具，通过Docker容器化部署，能够高效同步并索引网络的区块、交易、账户余额及智能合约事件等数据。该镜像简化了数据的获取与查询流程，为开发者提供结构化数据访问能力，适用于各类***应用开发与数据分析场景。

核心功能与特性

• 实时数据同步：对接***全节点/轻节点，实时同步区块、交易及智能合约事件数据
• 多维度索引：支持按区块号、交易哈希、账户地址、合约地址等维度建立索引
• 高效查询接口：提供RESTful API/GraphQL接口，支持复杂条件过滤与分页查询
• 灵活存储适配：兼容PostgreSQL、MySQL等关系型数据库及Elasticsearch搜索引擎
• 自定义索引规则：允许通过配置文件定义需索引的字段及智能合约事件
• 容错与恢复机制：支持断点续传，网络中断后可从上次同步位置恢复，保障数据完整性

使用场景与适用范围

• ***数据分析平台：为链上交易趋势、资金流向分析提供结构化数据支撑
• DApp后端服务：作为去中心化应用数据层，提供用户交易历史、账户余额查询服务
• ***浏览器开发：支撑区块浏览、交易详情展示、地址信息查询等核心功能
• 交易监控系统：实时追踪特定地址/合约的交易活动，触发异常交易预警
• 智能合约审计：索引合约交互事件，辅助分析合约调用历史与状态变更记录

使用方法与配置说明

前置条件

• 运行中的***节点（Geth/Besu/Erigon等，需开启JSON-RPC接口）
• 数据库服务（如使用外置数据库）
• Docker Engine 19.03+ 及 Docker Compose 2.0+

快速启动（docker run）

docker run -d \
  --name ***-indexer \
  -p 8080:8080 \
  -e ***_RPC_URL="[***]" \
  -e DB_TYPE="postgres" \
  -e DB_HOST="db-host" \
  -e DB_PORT="5432" \
  -e DB_USER="indexer" \
  -e DB_PASSWORD="SecurePass123" \
  -e DB_NAME="eth_indexer" \
  -e SYNC_START_BLOCK="***" \
  ***/indexer:latest

Docker Compose配置示例

version: '3.8'

services:
  indexer:
    image: ***/indexer:latest
    container_name: eth-indexer
    ports:
      - "8080:8080"
    environment:
      - ***_RPC_URL=[***]
      - DB_TYPE=postgres
      - DB_HOST=postgres
      - DB_PORT=5432
      - DB_USER=indexer
      - DB_PASSWORD=SecurePass123
      - DB_NAME=eth_indexer
      - SYNC_MODE=full
      - SYNC_START_BLOCK=***
      - SYNC_BATCH_SIZE=200
      - API_PORT=8080
      - LOG_LEVEL=info
    depends_on:
      - postgres
    restart: unless-stopped
    volumes:
      - ./indexer-config.json:/app/config/indexer.json  # 自定义索引规则

  postgres:
    image: postgres:14-alpine
    container_name: eth-indexer-db
    environment:
      - POSTGRES_USER=indexer
      - POSTGRES_PASSWORD=SecurePass123
      - POSTGRES_DB=eth_indexer
    volumes:
      - postgres-data:/var/lib/postgresql/data
    restart: unless-stopped

  eth-node:  # 可选：内置***轻节点
    image: ***:latest
    command: --http --http.addr 0.0.0.0 --http.port 8545 --http.api eth,net --light
    ports:
      - "8545:8545"
    volumes:
      - geth-data:/root/.***
    restart: unless-stopped

volumes:
  postgres-data:
  geth-data:

环境变量配置说明

查询API示例

服务启动后可通过以下端点查询数据：

• 获取区块详情：GET /api/v1/blocks/{blockNumber}
• 获取交易详情：GET /api/v1/transactions/{txHash}
• 地址交易历史：GET /api/v1/accounts/{address}/transactions?page=1&limit=20
• 最新区块信息：GET /api/v1/blocks/latest

响应示例（区块信息）：

{
  "blockNumber": ***,
  "hash": "0x5f83a5...",
  "parentHash": "0x8d31b2...",
  "timestamp": ***,
  "transactions": [
    {
      "hash": "0x9e42c1...",
      "from": "0x742d35...",
      "to": "0x1dac...",
      "value": "250000000000000000",
      "gasUsed": 21000,
      "status": true
    }
  ],
  "transactionCount": 128
}

自定义索引配置

通过挂载配置文件自定义索引规则，配置文件路径 /app/config/indexer.json：

{
  "indexRules": {
    "transactions": {
      "includeFields": ["hash", "from", "to", "value", "gasUsed", "input"],
      "excludeFields": ["v", "r", "s"]
    },
    "contractEvents": {
      "includeContracts": ["***"],
      "eventSignatures": ["Transfer(address,address,uint256)"]
    }
  }
}

挂载配置文件启动命令：

docker run -d \
  --name ***-indexer \
  -v $(pwd)/indexer.json:/app/config/indexer.json \
  -e ***_RPC_URL="[***]" \
  ***/indexer:latest