Hedera Mirror Node 项目教程
1. 项目的目录结构及介绍
Hedera Mirror Node 项目的目录结构如下:
hedera-mirror-node/
├── .github/
├── .vscode/
├── acceptance-tests/
├── apps/
├── common/
├── config/
├── docs/
├── helm/
├── images/
├── migrations/
├── monitor/
├── packages/
├── scripts/
├── test/
├── tools/
├── .dockerignore
├── .editorconfig
├── .gitignore
├── .prettierrc
├── .yarnrc
├── Dockerfile
├── LICENSE
├── Makefile
├── README.md
├── docker-compose.yml
├── package.json
├── tsconfig.json
└── yarn.lock
目录介绍:
- .github/: 包含 GitHub 相关的配置文件,如 GitHub Actions 的工作流配置。
- .vscode/: 包含 Visual Studio Code 的配置文件。
- acceptance-tests/: 包含项目的验收测试代码。
- apps/: 包含项目的应用程序代码。
- common/: 包含项目中通用的代码和工具。
- config/: 包含项目的配置文件。
- docs/: 包含项目的文档。
- helm/: 包含 Helm 的配置文件,用于 Kubernetes 部署。
- images/: 包含项目的图片资源。
- migrations/: 包含数据库迁移脚本。
- monitor/: 包含监控相关的代码。
- packages/: 包含项目的 npm 包。
- scripts/: 包含项目的脚本文件。
- test/: 包含项目的测试代码。
- tools/: 包含项目的工具代码。
- .dockerignore: Docker 忽略文件。
- .editorconfig: 编辑器配置文件。
- .gitignore: Git 忽略文件。
- .prettierrc: Prettier 配置文件。
- .yarnrc: Yarn 配置文件。
- Dockerfile: Docker 构建文件。
- LICENSE: 项目许可证。
- Makefile: Makefile 文件,包含项目的构建命令。
- README.md: 项目说明文件。
- docker-compose.yml: Docker Compose 配置文件。
- package.json: npm 包配置文件。
- tsconfig.json: TypeScript 配置文件。
- yarn.lock: Yarn 锁定文件。
2. 项目的启动文件介绍
Hedera Mirror Node 项目的启动文件主要位于 apps/
目录下。具体的启动文件可能因项目的不同模块而异。以下是一些常见的启动文件:
- apps/hedera-mirror-node/src/main.ts: 这是 Hedera Mirror Node 的主启动文件,通常用于启动整个应用程序。
- apps/hedera-mirror-node/src/index.ts: 这是应用程序的入口文件,通常用于初始化应用程序并启动服务。
启动文件介绍:
- main.ts: 该文件通常包含应用程序的主逻辑,负责初始化服务、加载配置、启动监听等操作。
- index.ts: 该文件通常是应用程序的入口点,负责调用
main.ts
中的逻辑,并确保应用程序正确启动。
3. 项目的配置文件介绍
Hedera Mirror Node 项目的配置文件主要位于 config/
目录下。以下是一些常见的配置文件:
- config/default.yaml: 默认配置文件,包含项目的默认配置选项。
- config/production.yaml: 生产环境配置文件,包含生产环境下的配置选项。
- config/development.yaml: 开发环境配置文件,包含开发环境下的配置选项。
- config/test.yaml: 测试环境配置文件,包含测试环境下的配置选项。
配置文件介绍:
- default.yaml: 该文件包含项目的默认配置,通常用于定义项目的通用配置选项。
- production.yaml: 该文件包含生产环境下的配置,通常用于覆盖默认配置中的某些选项。
- development.yaml: 该文件包含开发环境下的配置,通常用于覆盖默认配置中的某些选项。
- test.yaml: 该文件包含测试环境下的配置,通常用于覆盖默认配置中的某些选项。
这些配置文件通常会被应用程序在启动时加载,并根据当前环境(如开发、测试、生产)选择合适的配置文件进行应用。