solana README

The project's README from github.com/solana-labs/solana. As one markdown file: README.md.

PLEASE READ: This repo is now a public archive

This repo still exists in archived form, feel free to fork any reference implementations it still contains.

See Agave, the Solana validator implementation from Anza: https://github.com/anza-xyz/agave


Solana

Solana crate Solana documentation Build status codecov

Building

1. Install rustc, cargo and rustfmt.

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

When building the master branch, please make sure you are using the latest stable rust version by running:

$ rustup update

When building a specific release branch, you should check the rust version in ci/rust-version.sh and if necessary, install that version by running:

$ rustup install VERSION

Note that if this is not the latest rust version on your machine, cargo commands may require an override in order to use the correct version.

On Linux systems you may need to install libssl-dev, pkg-config, zlib1g-dev, protobuf etc.

On 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

On Fedora:

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

2. Download the source code.

$ git clone https://github.com/solana-labs/solana.git
$ cd solana

3. Build.

$ ./cargo build

Testing

Run the test suite:

$ ./cargo test

Starting a local testnet

Start your own testnet locally, instructions are in the online docs.

Accessing the remote development cluster

Benchmarking

First, install the nightly build of rustc. cargo bench requires the use of the unstable features only available in the nightly build.

$ rustup install nightly

Run the benchmarks:

$ cargo +nightly bench

Release Process

The release process for this project is described here.

Code coverage

To generate code coverage statistics:

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

Why coverage? While most see coverage as a code quality metric, we see it primarily as a developer productivity metric. When a developer makes a change to the codebase, presumably it's a solution to some problem. Our unit-test suite is how we encode the set of problems the codebase solves. Running the test suite should indicate that your change didn't infringe on anyone else's solutions. Adding a test protects your solution from future changes. Say you don't understand why a line of code exists, try deleting it and running the unit-tests. The nearest test failure should tell you what problem was solved by that code. If no test fails, go ahead and submit a Pull Request that asks, "what problem is solved by this code?" On the other hand, if a test does fail and you can think of a better way to solve the same problem, a Pull Request with your solution would most certainly be welcome! Likewise, if rewriting a test can better communicate what code it's protecting, please send us that patch!

Disclaimer

All claims, content, designs, algorithms, estimates, roadmaps, specifications, and performance measurements described in this project are done with the Solana Labs, Inc. (“SL”) good faith efforts. It is up to the reader to check and validate their accuracy and truthfulness. Furthermore, nothing in this project constitutes a solicitation for investment.

Any content produced by SL or developer resources that SL provides are for educational and inspirational purposes only. SL does not encourage, induce or sanction the deployment, integration or use of any such applications (including the code comprising the Solana blockchain protocol) in violation of applicable laws or regulations and hereby prohibits any such deployment, integration or use. This includes the use of any such applications by the reader (a) in violation of export control or sanctions laws of the United States or any other applicable jurisdiction, (b) if the reader is located in or ordinarily resident in a country or territory subject to comprehensive sanctions administered by the U.S. Office of Foreign Assets Control (OFAC), or (c) if the reader is or is working on behalf of a Specially Designated National (SDN) or a person subject to similar blocking or denied party prohibitions.

The reader should be aware that U.S. export control and sanctions laws prohibit U.S. persons (and other persons that are subject to such laws) from transacting with persons in certain countries and territories or that are on the SDN list. Accordingly, there is a risk to individuals that other persons using any of the code contained in this repo, or a derivation thereof, may be sanctioned persons and that transactions with such persons would be a violation of U.S. export controls and sanctions law.

solana (solana-labs/solana)

Searching Database…

15K ·GitHub
archived
这是什么?这是 Solana 区块链验证节点和账本的原始 Rust 实现,Solana 是一种面向大规模网络、高性能的区块链协议,适用于去中心化应用和市场。该仓库现已归档,仅作为历史参考保留。
这是我可以导入的库,还是实际运行的节点软件?这是完整的节点/验证节点及账本代码库,需要你自行构建并运行,而不是可以添加到其他项目中的库。
我该如何构建它?安装 rustc、cargo 和 rustfmt,下载源代码,然后用 cargo 进行构建。另外还有一份在线文档指南,介绍如何启动本地测试网。
构建前需要先安装什么?你需要最新的稳定版 Rust 工具链(rustc、cargo、rustfmt);在 Linux 上,可能还需要 libssl-dev、pkg-config、zlib1g-dev 和 protobuf。
我还能用它来运行正式的验证节点吗?不能。该仓库现已成为公开归档,不再维护。README 建议读者改用 Agave(Anza 公司积极维护的 Solana 验证节点实现)来运行正式节点。
这个项目究竟是为谁准备的?面向构建、测试或运行 Solana 网络的 Rust 开发者和节点运营者,而非基于它开发的应用的终端用户。
什么是 Agave?Agave 是 Anza 公司积极维护的 Solana 验证节点实现,这个已归档的仓库现在将读者引导至此。
我还能 fork 并构建这些代码吗?可以,从本仓库 fork 参考实现是允许的,但它不会再获得更新或技术支持。
devnet 是做什么用的?devnet 是 Solana 的公共开发集群,地址为 devnet.solana.com,全天候(7×24 小时)运行,方便开发者在实时网络上进行测试。
为什么这个项目如此重视代码覆盖率?团队将覆盖率视为衡量开发效率的指标,而不仅仅是质量指标:当你删除一行代码时,附近出现的失败测试会告诉你,这段代码原本是在解决什么问题。
What are similar projects?diem, nuvex, bitcoin, quip-validator, shardeum, gun, solana-classic, anoma
Size
438.3 MB
Stars
15K
Age
8y
Commits · 90 Days