项目结构 - OpenZeppelin 文档

项目结构

本文档提供了关于 OpenZeppelin Relayer 项目中每个目录的详细信息。

源码组织

src/ 目录

主要源码目录包含核心实现文件，组织成多个模块：

• api/: 路由和控制器逻辑

// 路由和控制器逻辑

• 管理 HTTP 路由并将传入的请求委托给控制器

// 管理 HTTP 路由并将传入的请求委托给控制器

• bootstrap/: 服务初始化

// 服务初始化

• 引导和初始化应用服务

// 引导和初始化应用服务

• config/: 配置管理

// 配置管理

• 处理系统配置和环境设置

// 处理系统配置和环境设置

• constants/: 全局常量

// 全局常量

• 提供在整个应用程序中使用的静态值

// 提供在整个应用程序中使用的静态值

• domain/: 业务领域逻辑

// 业务领域逻辑

• 封装核心业务规则和特定于领域的功能

// 封装核心业务规则和特定于领域的功能

• jobs/: 异步作业处理

// 异步作业处理

• 管理后台任务的排队和执行

// 管理后台任务的排队和执行

• logging/: 日志记录和文件轮换

// 日志记录和文件轮换

• 实现日志记录功能和日志文件管理

// 实现日志记录功能和日志文件管理

• metrics/: 指标收集

// 指标收集

• 收集和报告应用程序的性能和使用指标

// 收集和报告应用程序的性能和使用指标

• models/: 核心数据模型和类型

// 核心数据模型和类型

• 定义系统的数据结构和类型定义

// 定义系统的数据结构和类型定义

• repositories/: 配置存储

// 配置存储

• 提供用于存储和检索配置数据的接口

// 提供用于存储和检索配置数据的接口

• services/: 业务服务逻辑

// 业务服务逻辑

• 实现核心业务功能和服务操作

// 实现核心业务功能和服务操作

• utils/: 实用函数

// 实用函数

• 为应用程序提供辅助函数和常用 用程序

// 为应用程序提供辅助函数和常用  用程序

文档

docs/ 目录

项目文档：

• 用户指南

• API 文档

• 配置示例

• 架构图

配置

config/ 目录

包含系统配置文件和密钥：

• config.json 配置文件

• 从 config.json 文件引用的密钥库文件

测试

test/ 目录

包含全面的测试套件以确保系统可靠性：

• 模拟真实世界用户场景的端到端测试

脚本

scripts/ 目录

实用脚本。

示例

examples/ 目录

提供实际示例和示例配置，以帮助用户入门：

• 演示各种环境的典型服务配置

• 充当自定义和部署 relayer 的快速入门指南

• 作为配置和部署中最佳实践的参考

开发工具

预提交Hook

位于项目根目录中：

• 代码格式检查

• Linting 规则

• 提交消息验证

构建配置

核心构建文件：

• Cargo.toml: 项目依赖和元数据

• rustfmt.toml: 代码格式化规则

• rust-toolchain.toml: Rust 版本和组件

Docker 支持

该项目包括用于不同环境的 Docker 配置：

• Dockerfile.development: 开发容器设置

• Dockerfile.production: 可用于生产环境的容器

← 网络配置

项目路线图 →

• 原文链接： docs.openzeppelin.com/re...
• 登链社区 AI 助手，为大家转译优秀英文文章，如有翻译不通的地方，还请包涵～