构建

1. 安装 rustc, cargo 和 rustfmt。

$ curl https://sh.rustup.rs -sSf | sh
$ source $HOME/.cargo/env
$ rustup component add rustfmt

在构建主分支时，请确保您正在使用最新的稳定版rust，通过运行

$ rustup update

在构建特定版本分支时，您应检查 ci/rust-version.sh 中的 rust 版本，并在必要时通过运行来安装该版本

$ rustup install VERSION

请注意，如果这不是您机器上的最新 rust 版本，则 cargo 命令可能需要通过 覆盖 来使用正确的版本。

在Linux系统上，您可能需要安装 libssl-dev, pkg-config, zlib1g-dev, protobuf等。

在Ubuntu上

$ sudo apt-get update
$ sudo apt-get install libssl-dev libudev-dev pkg-config zlib1g-dev llvm clang cmake make libprotobuf-dev protobuf-compiler

在Fedora上

$ sudo dnf install openssl-devel systemd-devel pkg-config zlib-devel llvm clang cmake make protobuf-devel protobuf-compiler perl-core

2. 下载源代码。

$ git clone https://github.com/anza-xyz/agave.git
$ cd agave

3. 构建。

$ ./cargo build

测试

运行测试套件

$ ./cargo test

启动本地测试网

在本地启动自己的测试网，说明请参考在线文档。

访问远程开发集群

• devnet - 稳定的公共集群，可通过devnet.solana.com访问，24/7运行。了解更多关于公共集群的信息。

基准测试

首先安装 rustc 的夜间构建版本。 cargo bench 需要使用仅夜间构建中可用的不稳定功能。

$ rustup install nightly

运行基准测试

$ cargo +nightly bench

发布流程

本项目的发布流程请参阅此处。

代码覆盖率

生成代码覆盖率统计

$ scripts/coverage.sh
$ open target/cov/lcov-local/index.html

为什么需要覆盖率？虽然大多数人将覆盖率视为代码质量指标，但我们主要将其视为开发者生产力指标。当开发者对代码库进行修改时，这通常是对某些问题的解决方案。我们的单元测试套件是我们如何编码代码库解决的问题集合。运行测试套件应表明您的更改没有侵犯他人的解决方案。添加测试可以保护您的解决方案免受未来的更改。比如说您不了解为什么存在某行代码，可以尝试删除它并运行单元测试。最近的测试失败应该会告诉您该代码解决了什么问题。如果没有测试失败，您可以提交一个包含“这段代码解决了什么问题？”的Pull Request。另一方面，如果测试失败并且您认为有更好的方法解决相同的问题，那么包含您解决方案的PullRequest将非常受欢迎！同样，如果重写测试可以更好地传达代码所保护的代码，请发送给我们这个补丁！