Sphinx Relay 项目启动与配置教程

1. 项目目录结构及介绍

Sphinx Relay 是一个基于 Sphinx 的去中心化即时消息传递系统。以下是项目的目录结构及其基本介绍：

sphinx-relay/
├── app/                      # 应用程序目录
│   ├── api/                  # API 接口相关
│   ├── bin/                  # 启动脚本
│   ├── cli/                  # 命令行接口
│   ├── common/               # 公共模块
│   ├── db/                   # 数据库相关
│   ├── health/               # 健康检查
│   ├── kernel/               # 核心逻辑
│   ├── lib/                  # 库文件
│   ├── middleware/           # 中间件
│   ├── models/               # 数据模型
│   ├── plugins/              # 插件
│   ├── routes/               # 路由
│   ├── server/               # 服务器模块
│   ├── storage/              # 存储模块
│   ├── test/                 # 测试文件
│   ├── tools/                # 工具模块
│   └── utils/                # 工具类
├── bot/                      # 机器人模块
├── config/                   # 配置文件
├── deployment/               # 部署脚本和配置
├── docs/                     # 文档
├── node_modules/             # 依赖模块
├── package.json              # 项目配置文件
├── package-lock.json         # 依赖锁定文件
├── scripts/                  # 脚本文件
└── spinach/                  # 菜谱（ spinach 是一个内部模块，用于处理交易）

2. 项目启动文件介绍

项目的启动文件位于 app/bin 目录下的 start.js 文件。以下是启动文件的简要介绍：

• start.js：项目的主入口文件，负责初始化日志系统、数据库连接、加载配置文件、启动服务器等。

// 示例代码
const { app } = require('../app');
const { logger } = require('../common');

app.on('ready', () => {
  logger.info('Sphinx Relay started successfully');
});

app.start();

3. 项目配置文件介绍

项目的配置文件位于 config 目录下的 config.json 文件。以下是配置文件的简要介绍：

• config.json：项目的主配置文件，包含数据库连接信息、服务器端口、API 密钥等敏感信息。

{
  "network": "mainnet",
  "node_port": 8080,
  "db": {
    "host": "localhost",
    "port": 3306,
    "user": "root",
    "password": "password",
    "database": "sphinx_relay"
  },
  "api_key": "your_api_key"
}

在启动项目前，请确保正确配置 config.json 文件中的各项参数。