Cadence 开源项目使用教程
1. 项目的目录结构及介绍
Cadence 项目的目录结构如下:
cadence/
├── .github/
├── docker/
├── docs/
├── examples/
├── frontend/
├── go.mod
├── go.sum
├── host/
├── LICENSE
├── Makefile
├── README.md
├── schema/
├── scripts/
├── server/
├── tools/
└── worker/
目录介绍
.github/
: 包含 GitHub 相关的配置文件。docker/
: 包含 Docker 镜像构建的相关文件。docs/
: 包含项目的文档。examples/
: 包含示例代码。frontend/
: 前端服务的代码。go.mod
和go.sum
: Go 模块依赖文件。host/
: 包含主机配置和启动脚本。LICENSE
: 项目的许可证。Makefile
: 包含项目的构建和测试命令。README.md
: 项目的主 README 文件。schema/
: 数据库模式和迁移脚本。scripts/
: 包含各种脚本文件。server/
: 服务端代码。tools/
: 包含各种工具。worker/
: 工作节点代码。
2. 项目的启动文件介绍
Cadence 项目的启动文件主要位于 host/
目录下。以下是主要的启动文件:
host/cadence
: 主启动脚本,用于启动 Cadence 服务。host/config/config_template.yaml
: 配置文件模板,用于配置 Cadence 服务。
启动步骤
- 进入
host/
目录:cd host/
- 使用启动脚本启动服务:
./cadence
3. 项目的配置文件介绍
Cadence 的配置文件位于 host/config/config_template.yaml
。以下是配置文件的主要部分:
# 服务端配置
server:
rpc:
port: 7933
bindOnIP: 0.0.0.0
# 数据库配置
persistence:
defaultStore: default
visibilityStore: visibility
dataStores:
default:
sql:
user: cadence
password: cadence
host: 127.0.0.1
port: 3306
database: cadence
visibility:
sql:
user: cadence
password: cadence
host: 127.0.0.1
port: 3306
database: cadence_visibility
# 日志配置
log:
stdout: true
level: info
配置项介绍
server
: 服务端配置,包括 RPC 端口和绑定 IP。persistence
: 数据库配置,包括默认存储和可见性存储的配置。log
: 日志配置,包括是否输出到标准输出和日志级别。
通过修改 config_template.yaml
文件,可以自定义 Cadence 服务的配置。