Substrate Telemetry 项目启动与配置教程

1. 项目的目录结构及介绍

Substrate Telemetry 项目的主要目录结构如下：

substrate-telemetry/
├── benches             # 基准测试文件
├── cargo.lock          # Cargo.lock 文件，记录项目的依赖关系
├── Cargo.toml          # Cargo配置文件，定义项目依赖和元数据
├── examples            # 示例代码
├── node                # 节点相关的代码和配置
├── primitives          # 基础组件和工具
├── runtime             # 运行时环境相关的代码
├── script              # 脚本文件
├── src                 # 源代码
├── tests               # 测试代码
├── todos               # 待办事项
└── xtask               # 特殊任务脚本

• benches: 包含项目的基准测试代码。
• Cargo.lock: 记录了项目依赖的精确版本，用于确保构建的一致性。
• Cargo.toml: 包含项目的元数据和依赖信息，是构建和编译项目的重要配置文件。
• examples: 提供了一些使用Substrate Telemetry的示例。
• node: 包含与节点操作相关的代码和配置文件。
• primitives: 提供了一些基础的组件和工具，用于构建Substrate Telemetry。
• runtime: 包含了运行时环境的配置和代码。
• script: 包含了一些辅助脚本，用于执行特定的任务。
• src: 源代码的主要目录，包含了项目的核心逻辑。
• tests: 包含了项目的单元测试和集成测试代码。
• todos: 记录了项目中的待办事项。
• xtask: 包含了一些特殊的构建任务和脚本。

2. 项目的启动文件介绍

Substrate Telemetry 项目的启动文件通常是 src/main.rs。这个文件定义了项目的主要入口点，并设置了运行时配置。以下是一个简化的示例：

fn main() {
    // 初始化日志记录器
    env_logger::init();

    // 创建并启动节点
    let _node = run_node();
}

fn run_node() -> substrate_node::Service {
    // 设置节点配置并启动节点
    let config = NodeConfig::load();
    substrate_node::start_node(config)
}

在这段代码中，首先通过 env_logger::init() 初始化日志记录器，然后通过 run_node() 函数创建并启动节点。run_node 函数加载配置并调用 substrate_node::start_node 来启动节点。

3. 项目的配置文件介绍

Substrate Telemetry 项目的配置文件通常位于 node 目录下，例如 node/config.json。这个文件包含了节点运行所需的各种配置信息，如下所示：

{
  "chain Specifications": {
    "nodeKey": "...");
    "genesis": {
      "rawHeader": {
        ...
      },
      "consensus": {
        ...
      },
      ...
    },
    "bootnodes": [...],
    ...
  },
  "telemetry Endpoints": [
    ...
  ],
  "node Roles": ["full", "authority"],
  ...
}

在这个配置文件中：

• chain Specifications 包含了链的配置，如节点密钥、创世纪信息、引导节点等。
• telemetry Endpoints 定义了遥测数据发送到的端点列表。
• node Roles 定义了节点的角色，可以是全节点或验证人节点。

这些配置项是节点运行时的重要设置，需要根据实际需求进行适当配置。