Narwhal 项目启动与配置教程

1. 项目目录结构及介绍

Narwhal 项目是一个基于 Rust 语言实现的 BFT（拜占庭容错）共识协议的项目。以下是项目的目录结构及其简要介绍：

narwhal/
├── .github/             # GitHub 工作流文件
├── assets/             # 资源文件，如图片等
├── benchmark/          # 性能测试脚本和配置
├── config/             # 配置文件示例
├── consensus/          # 共识算法相关的模块
├── crypto/             # 加密相关的模块
├── network/            # 网络通信相关的模块
├── node/               # 节点相关的模块
├── primary/            # 主节点相关的模块
├── store/              # 存储模块
├── worker/             # 工作节点相关的模块
├── .gitignore          # Git 忽略文件
├── Cargo.toml          # Rust 项目配置文件
├── LICENSE             # Apache 2.0 许可证文件
├── README.md           # 项目说明文件
└── ...

• .github/：存放 GitHub Actions 工作流文件，用于自动化处理如代码审查、构建等操作。
• assets/：存放项目所需的资源文件。
• benchmark/：包含用于性能测试的 Python 脚本和配置文件。
• config/：包含项目的配置文件示例。
• consensus/：实现共识算法的核心模块。
• crypto/：包含加密相关的代码。
• network/：处理网络通信的部分。
• node/：与节点操作相关的代码。
• primary/：主节点相关的实现。
• store/：数据存储模块。
• worker/：工作节点相关的实现。
• .gitignore：指定 Git 忽略的文件和目录。
• Cargo.toml：Rust 项目的配置文件，包含项目依赖、构建脚本等。
• LICENSE：项目所使用的 Apache 2.0 许可证。
• README.md：项目的说明文档。

2. 项目的启动文件介绍

项目的启动主要通过 benchmark/ 目录中的 fabfile.py 文件进行。这个文件是使用 Python 编写的，并且使用了 Fabric 库来简化在多台机器上运行任务的过程。

启动项目的步骤一般如下：

1. 克隆项目到本地：

   git clone https://github.com/asonnino/narwhal.git
   

2. 进入 benchmark/ 目录，并安装 Python 依赖：

   cd narwhal/benchmark
   pip install -r requirements.txt
   

3. 使用 Fabric 运行本地测试：

   fab local
   

fabfile.py 脚本会根据配置文件和参数设置，启动多个节点，并在本地机器上执行性能测试。

3. 项目的配置文件介绍

项目的配置主要通过 benchmark/ 目录下的 fabfile.py 文件中的配置变量进行。此外，在 config/ 目录下也有一些配置文件的示例，用于不同的测试场景。

以下是一些基本的配置选项：

• Faults：指定容错的节点数量。
• Committee size：指定委员会的大小，即参与共识的节点数量。
• Worker(s) per node：每个节点上工作节点的数量。
• Input rate：输入的交易速率。
• Transaction size：交易的大小。
• Execution time：执行时间。
• Header size：区块头的尺寸。
• Max header delay：最大头部延迟。
• GC depth：垃圾回收的深度。
• Sync retry delay：同步重试的延迟时间。
• Sync retry nodes：同步重试的节点数量。
• batch size：批处理的大小。
• Max batch delay：批处理的最大延迟。

这些配置可以在 fabfile.py 文件中根据需要进行调整，以适应不同的测试需求。