Dingo

⚠️ 这是一个工作进度中的项目，目前正在积极开发中

概述

Dingo是一个数据节点，支持通过YAML配置文件（dingo.yaml）和环境变量进行配置，实现网络的数据同步、UTxO跟踪、交易处理等功能。它兼容Ouroboros协议（节点到节点及节点到客户端通信），提供UTxO RPC接口，并支持Prometheus指标监控。

核心功能和特性

网络（Network）

• UTxO RPC
• Ouroboros协议
  • 节点到节点（Node-to-node）
    • ChainSync
    • BlockFetch
    • TxSubmission2
  • 节点到客户端（Node-to-client）
    • ChainSync
    • LocalTxMonitor
    • LocalTxSubmission
    • LocalStateQuery
  • 对等节点管理（Peer governor）
    • 拓扑配置
    • 对等节点更新
    • 账本对等节点
  • 连接管理器
    • 入站连接
      • 基于TCP的节点到客户端
      • 基于UNIX socket的节点到客户端
      • 基于TCP的节点到节点
    • 出站连接
      • 基于TCP的节点到节点

账本（Ledger）

• 区块
  • 区块存储
  • 链选择
• UTxO跟踪
• 协议参数
• 证书
  • 矿池注册
  • 权益注册/委托
  • 治理
• 交易验证
  • 第一阶段验证
    • UTxO规则
    • 见证
    • 区块体
    • 证书
    • 委托/矿池
    • 治理
  • 第二阶段验证
    • 智能合约

内存池（***）

• 接受本地客户端提交的交易
• 向其他节点分发交易
• 添加交易时进行验证
• 消费者跟踪
• 链更新时清理交易

使用场景和适用范围

Dingo适用于以下场景：

• 网络节点部署，实现数据同步与存储
• 提供UTxO RPC接口，支持***状态查询
• 节点到节点通信，参与***网络的交易传播与区块同步
• 节点到客户端通信，支持***-cli等工具连接
• 应用开发，作为数据节点提供底层数据支持

适用于开发者、基础设施运维人员及需要访问数据的应用服务。

使用方法和配置说明

配置方式

Dingo支持通过YAML配置文件（dingo.yaml）和环境变量进行配置。示例配置文件可参考项目提供的dingo.yaml.example，可复制并编辑以适应本地或生产环境。

环境变量配置

以下环境变量可用于修改Dingo行为：

• ***_BIND_ADDR
  • 监听绑定的IP地址（默认：0.0.0.0）
• ***_CONFIG
  • ***节点配置文件的完整路径（默认：./config/***/preview/config.json）
  • 可使用不同网络的自定义配置文件
  • 创世配置文件默认从同一目录读取
• ***_DATABASE_PATH
  • 包含账本数据库文件的目录（默认：.dingo）
  • 用于账本持久化数据存储
• ***_INTERSECT_TIP
  • 忽略之前的链历史，从当前位置开始（默认：false）
  • 实验性功能，可能导致问题，谨慎使用
• ***_METRICS_PORT
  • Prometheus指标监听的TCP端口（默认：***）
• ***_NETWORK
  • 指定的***网络名称（默认：preview）
• ***_PRIVATE_BIND_ADDR
  • Ouroboros NtC监听绑定的IP地址（默认：127.0.0.1）
• ***_PRIVATE_PORT
  • Ouroboros NtC监听的TCP端口（默认：3002）
• ***_RELAY_PORT
  • Ouroboros NtN监听的TCP端口（默认：3001）
• ***_SOCKET_PATH
  • UNIX socket监听路径（默认：dingo.socket）
  • 该socket使用Ouroboros NtC协议，供客户端软件（如***-cli）使用
• ***_TOPOLOGY
  • ***节点拓扑文件的完整路径（默认：空）
• ***_UTXORPC_PORT
  • UTxO RPC监听的TCP端口（默认：9090）
• TLS_CERT_FILE_PATH - SSL证书路径，需与TLS_KEY_FILE_PATH一同使用（默认：空）
• TLS_KEY_FILE_PATH - SSL证书密钥路径（默认：空）

使用示例

直接运行（示例）

在mainnet上运行Dingo：

bash
***_NETWORK=mainnet ***_CONFIG=path/to/***/configs/mainnet/config.json ./dingo

注意：配置文件可从[]

运行后，Dingo会生成dingo.socket文件，可供***-cli、adder、kupo等客户端使用（目前仅经过有限测试，欢迎反馈使用情况）。

Docker部署示例

docker run命令

bash
docker run -d \
  --name dingo \
  -p 3001:3001 \  # NtN端口
  -p 3002:3002 \  # NtC端口
  -p 9090:9090 \   # UTxO RPC端口
  -v /path/to/local/config:/config \  # 挂载配置文件目录
  -v /path/to/database:/data \        # 挂载数据目录（持久化存储）
  -e ***_NETWORK=mainnet \
  -e ***_CONFIG=/config/mainnet/config.json \
  -e ***_DATABASE_PATH=/data \
  blinklabs/dingo:latest

docker-compose配置

yaml
version: '3'
services:
  dingo:
    image: blinklabs/dingo:latest
    container_name: dingo
    ports:
      - "3001:3001"  # NtN端口
      - "3002:3002"  # NtC端口
      - "9090:9090"   # UTxO RPC端口
    volumes:
      - /path/to/local/config:/config
      - /path/to/database:/data
    environment:
      - ***_NETWORK=mainnet
      - ***_CONFIG=/config/mainnet/config.json
      - ***_DATABASE_PATH=/data
      - ***_BIND_ADDR=0.0.0.0
    restart: unless-stopped

注意事项

• Dingo目前处于开发阶段，功能可能不稳定，生产环境使用需谨慎
• 实验性功能（如***_INTERSECT_TIP）可能导致节点异常，建议仅在测试环境使用
• 配置文件需与目标***网络匹配，不同网络（preview、preprod、mainnet等）需使用对应配置