xmtp/node-go

XMTP Node (Go) 镜像文档

镜像概述

本镜像提供了基于Go语言实现的XMTP (Extensible Message Transport Protocol) 节点软件，用于部署和运行XMTP网络中的节点实例。XMTP是一种去中心化消息传输协议，节点作为网络基础设施，负责消息的路由、存储和验证，支持跨平台、安全的端到端消息通信。

核心功能与特性

• Go语言实现：采用Go语言开发，具备高性能、低资源占用和良好的跨平台兼容性
• 协议兼容：完全兼容XMTP协议规范，支持最新协议版本
• 节点管理：提供节点身份管理、网络连接维护和状态监控功能
• 可配置性：支持通过环境变量和配置文件自定义节点参数
• 安全传输：内置加密机制，保障消息传输的安全性和完整性

使用场景

• 开发者搭建本地XMTP测试网络节点
• 企业部署生产环境XMTP节点，提供去中心化消息服务
• 研究XMTP协议及去中心化消息传输技术
• 构建基于XMTP协议的去中心化应用(DApp)基础设施

使用方法

基本运行

通过以下命令快速启动XMTP节点容器：

bash
docker run -d --name xmtp-node -p 8080:8080 docker.xuanyuan.run/xmtp/node-go:latest

自定义配置

环境变量配置

支持通过环境变量调整节点参数：

示例：指定网络和端口运行

bash
docker run -d --name xmtp-node \
  -e NETWORK=mainnet \
  -e PORT=9000 \
  -p 9000:9000 \
  docker.xuanyuan.run/xmtp/node-go:latest

配置文件挂载

如需更复杂的配置，可通过挂载配置文件实现：

bash
docker run -d --name xmtp-node \
  -v /path/to/your/config.yaml:/config/config.yaml \
  -p 8080:8080 \
  docker.xuanyuan.run/xmtp/node-go:latest --config /config/config.yaml

配置文件示例（config.yaml）：

yaml
node:
  id: "my-node-123"
  port: 8080
  dataDir: "/data"
network:
  bootnodes:
    - "/ip4/1.2.3.4/tcp/8080/p2p/QmXYZ..."
    - "/ip4/5.6.7.8/tcp/8080/p2p/QmABC..."
logging:
  level: "info"
  output: "stdout"

Docker Compose 部署

创建docker-compose.yml文件：

yaml
version: '3'
services:
  xmtp-node:
    image: docker.xuanyuan.run/xmtp/node-go:latest
    container_name: xmtp-node
    ports:
      - "8080:8080"
    environment:
      - NETWORK=testnet
      - NODE_ID=my-test-node
    volumes:
      - xmtp-data:/data
    restart: unless-stopped

volumes:
  xmtp-data:

启动服务：

bash
docker-compose up -d

数据持久化

为确保节点数据不丢失，建议挂载数据卷：

bash
docker run -d --name xmtp-node \
  -v xmtp-node-data:/data \
  -p 8080:8080 \
  docker.xuanyuan.run/xmtp/node-go:latest

日志查看

查看节点运行日志：

bash
docker logs -f xmtp-node

常见问题

• 节点无法连接到网络：检查网络环境，确保引导节点地址正确且可访问
• 数据目录权限问题：确保挂载的目录具有正确的读写权限
• 端口冲突：使用-p参数映射未被占用的主机端口