Fuel Core项目开发环境搭建与贡献指南

Fuel Core项目开发环境搭建与贡献指南

fuel-core fuel-core - FuelLabs 提供的 Fuel 客户端实现，用于构建和交互去中心化应用程序，涉及区块链和智能合约的开发。 项目地址: https://gitcode.com/gh_mirrors/fu/fuel-core

项目概述

Fuel Core是一个区块链节点实现，主要采用Rust语言开发，同时包含部分C++组件（如RocksDB）。作为Fuel生态系统中的核心组件，它实现了Fuel区块链协议，为开发者提供了构建去中心化应用的基础设施。

开发环境准备

基础工具安装

开始开发前需要准备以下基础工具：

1. 版本控制工具：Git是必备的版本控制系统
2. Rust工具链：通过rustup安装最新稳定版Rust
3. 编译工具链：需要安装clang用于构建系统库（特别是RocksDB依赖）

Rust工具链配置

Fuel Core项目使用了Rust的一些额外组件：

rustup component add clippy  # Rust代码静态分析工具
rustup toolchain install nightly  # 安装nightly工具链
rustup component add rustfmt --toolchain nightly  # 使用nightly版的rustfmt

选择nightly版的rustfmt是因为它提供了更多代码格式化功能，项目中的.rustfmt.toml文件定义了具体的代码风格规则。

项目构建与测试

构建系统

Fuel Core采用了xtask模式来管理自定义构建流程，这是一种替代传统Makefile的现代Rust项目构建方式。

基础构建命令：

cargo xtask build

该命令不仅会执行常规的cargo build，还会将最新的schema文件输出到crates/client/assets/schema.sdl目录中。

代码质量检查

项目使用两种工具进行代码质量检查：

1. 代码格式化：

cargo +nightly fmt --all

2. 静态分析：

cargo clippy --all-targets

测试策略

测试套件遵循Rust cargo标准，GraphQL服务将通过Tower实例化，模拟服务器/客户端结构。

运行测试：

cargo test --all-targets

性能优化构建

为了获得最佳性能，建议使用针对本地CPU优化的构建方式：

RUSTFLAGS="-C target-cpu=native" cargo build --release --bin fuel-core-bin

生成的二进制文件位于./target/release/fuel-core。

构建问题排查

由于依赖外部组件（如RocksDB），构建时间可能较长。为了加快开发迭代速度，可以使用内存数据库（基于hashmap）进行测试：

cargo build -p fuel-core-bin --no-default-features

代码贡献流程

开发工作流

1. 问题讨论：确保你的贡献对应一个已存在的issue，并在其中讨论问题和解决方案
2. 分支创建：从master分支创建新的开发分支
3. 代码实现：编写代码并添加测试用例
4. 测试验证：确保所有测试通过
5. 变更记录：更新CHANGELOG.md，如果是破坏性变更需包含迁移指南
6. 代码审查：提交PR后根据审查意见进行修改

代码标准

项目采用RFC流程维护代码标准，这些标准在专门的RFC仓库中定义。贡献者应熟悉这些标准后再提交代码。

特殊注意事项

1. 长时间运行的测试：如果测试在CI上运行超过5分钟，需要在.config/nextest.toml中增加超时设置
2. 版本发布：每个版本（包括次要版本）都需要更新fuel_core_upgradable_executor::Executor的版本号，且版本号必须连续递增
3. 版本映射：fuel_core_upgradable_executor crate中维护着crate版本与执行器版本的映射关系(CRATE_VERSIONS)，每次发布都需要添加新条目

开发建议

对于新开发者，建议从标记为"Help Wanted"的issue开始。如果是涉及多个组件或改变现有行为的重大修改，务必先创建issue进行讨论。

Fuel Core依赖于多个核心组件，包括燃料虚拟机(fuel-vm)相关的多个crate，这些也是潜在的贡献方向。熟悉这些依赖组件有助于更好地理解Fuel Core的工作原理。

fuel-core fuel-core - FuelLabs 提供的 Fuel 客户端实现，用于构建和交互去中心化应用程序，涉及区块链和智能合约的开发。 项目地址: https://gitcode.com/gh_mirrors/fu/fuel-core