1 个稳定版本

1.14.3 2022 年 10 月 15 日

#51 in #安全币

Apache-2.0

715KB
15K SLoC

Safecoin

Safecoin crate Safecoin documentation Build status codecov

构建

1. 安装 rustc、cargo 和 rustfmt。

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

在构建 master 分支时,请确保您正在使用最新稳定的 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

2. 下载源代码。

$ git clone https://github.com/fair-exchange/safecoin.git
$ cd solana

3. 构建。

$ cargo build

测试

运行测试套件

$ cargo test

启动本地测试网

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

访问远程开发集群

  • devnet - 通过 devnet.safecoin.org 可访问的稳定公共集群,用于开发。24/7 运行。了解更多关于 公共集群 的信息

基准测试

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

$ rustup install nightly

运行基准测试

$ cargo +nightly bench

发布流程

此项目的发布流程请参见 此处

代码覆盖率

要生成代码覆盖率统计信息

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

为什么需要覆盖率?虽然大多数人将覆盖率视为代码质量指标,但我们将其视为开发效率指标。当开发者对代码库进行更改时,这通常是对某些问题的解决方案。我们的单元测试套件是我们编码代码库解决的问题集合。运行测试套件应该表明您的更改没有侵犯他人的解决方案。添加测试可以保护您的解决方案免受未来更改的影响。如果您不明白某一行代码的存在原因,可以尝试删除它并运行单元测试。最近的测试失败应该会告诉您该代码解决了什么问题。如果没有测试失败,请提交一个拉取请求,询问“这段代码解决了什么问题?”另一方面,如果您对解决相同问题的方法有更好的想法,包含您解决方案的拉取请求肯定会受到欢迎!同样,如果重写测试可以更好地传达它所保护的代码,请发送给我们这个补丁!

免责声明

本项目中描述的所有主张、内容、设计、算法、估计、路线图、规范和性能测量都是基于Solana基金会(“SF”)的善意努力。读者有责任检查和验证其准确性和真实性。此外,本项目中没有任何内容构成投资要约。

由SF或SF提供的开发者资源所产生的任何内容仅用于教育和启发目的。SF不鼓励、诱导或批准任何违反适用法律或法规的应用程序(包括构成Safecoin区块链协议的代码)的部署、集成或使用。因此,禁止任何此类部署、集成或使用。这包括读者(a)违反美国或任何其他适用司法管辖区出口管制或制裁法律,或(b)位于或通常居住在受美国外国资产管理办公室(OFAC)全面制裁的国家或地区,或(c)是或代表特别指定国民(SDN)或受类似禁止或拒绝方禁令约束的人。

读者应知道,美国出口管制和制裁法律禁止美国公民(以及其他受此类法律约束的人)与某些国家或地区的个人进行交易,或在SDN名单上。作为一个主要基于开源软件的项目,这种被制裁的人可能仍然会规避禁令,获取构成Safecoin区块链协议(或其他项目代码或应用程序)的代码,并部署、集成或以其他方式使用它。因此,存在风险,即使用Safecoin区块链协议的个人可能是被制裁的人,与这些人进行交易可能违反美国出口管制和制裁法律。这种风险适用于直接部署、集成或使用Safecoin区块链协议代码的个人(例如,作为节点运营商)、以及通过轻客户端、第三方接口和/或钱包软件在Safecoin区块链上进行交易的个人。

依赖项

约18-33MB
约565K SLoC