Horizen Sidechains-SDK 使用教程

Horizen Sidechains-SDK 使用教程

Sidechains-SDK 项目地址: https://gitcode.com/gh_mirrors/si/Sidechains-SDK

1. 项目目录结构及介绍

Horizen Sidechains-SDK 项目的目录结构如下：

Sidechains-SDK/
├── ci/
├── coverage-reports/
├── doc/
├── examples/
├── qa/
├── sdk/
├── tools/
├── .gitignore
├── .travis.yml
├── CHANGELOG.md
├── LICENSE
├── README.md
├── dependabot.yml
├── pom.xml
└── requirements.txt

目录介绍

• ci/: 包含持续集成相关的脚本和配置文件。
• coverage-reports/: 代码覆盖率报告的存放目录。
• doc/: 项目文档的存放目录。
• examples/: 包含示例应用程序的代码。
• qa/: 质量保证相关的脚本和配置文件。
• sdk/: 核心的 Sidechain SDK 代码。
• tools/: 包含项目使用的工具和脚本。
• .gitignore: Git 忽略文件配置。
• .travis.yml: Travis CI 配置文件。
• CHANGELOG.md: 项目变更日志。
• LICENSE: 项目许可证。
• README.md: 项目介绍和使用说明。
• dependabot.yml: Dependabot 配置文件。
• pom.xml: Maven 项目配置文件。
• requirements.txt: Python 依赖配置文件。

2. 项目启动文件介绍

项目的启动文件主要位于 sdk/ 目录下。以下是一些关键的启动文件：

• sdk/src/main/java/io/horizen/examples/SimpleApp.java: 这是一个简单的示例应用程序，用于启动 Sidechain 节点。
• sdk/src/main/resources/application.conf: 配置文件，包含节点的基本配置信息。

启动步骤

1. 进入 sdk/ 目录。
2. 使用 Maven 构建项目：

   mvn clean install
   

3. 启动示例应用程序：

   java -cp target/sidechains-sdk-simpleapp-0.12.0.jar io.horizen.examples.SimpleApp <path_to_config_file>
   

3. 项目的配置文件介绍

配置文件主要位于 sdk/src/main/resources/ 目录下，关键的配置文件是 application.conf。

配置文件示例

dataDir = /tmp/sparkz/data/blockchain
logDir = /tmp/sparkz/data/log

network {
  nodeName = "node name"
  bindAddress = "127.0.0.1:9084"
  declaredAddress = "45.123.0.0:9084"
}

配置项说明

• dataDir: 数据存储目录。
• logDir: 日志存储目录。
• network.nodeName: 节点名称。
• network.bindAddress: 节点绑定的地址和端口。
• network.declaredAddress: 对外声明的地址和端口。

通过以上配置，可以自定义 Sidechain 节点的行为和网络设置。

Sidechains-SDK 项目地址: https://gitcode.com/gh_mirrors/si/Sidechains-SDK