110 lines
3.4 KiB
Markdown
110 lines
3.4 KiB
Markdown
<p align="center">
|
|
<a href="https://solana.com">
|
|
<img alt="Solana" src="https://i.imgur.com/OMnvVEz.png" width="250" />
|
|
</a>
|
|
</p>
|
|
|
|
[](https://crates.io/crates/solana-core)
|
|
[](https://docs.rs/solana-core)
|
|
[](https://buildkite.com/solana-labs/solana/builds?branch=master)
|
|
[](https://codecov.io/gh/solana-labs/solana)
|
|
|
|
# Building
|
|
|
|
## **1. Install rustc, cargo and rustfmt.**
|
|
|
|
```bash
|
|
$ curl https://sh.rustup.rs -sSf | sh
|
|
$ source $HOME/.cargo/env
|
|
$ rustup component add rustfmt
|
|
```
|
|
|
|
If your rustc version is lower than 1.39.0, please update it:
|
|
|
|
```bash
|
|
$ rustup update
|
|
```
|
|
|
|
On Linux systems you may need to install libssl-dev, pkg-config, zlib1g-dev, etc. On Ubuntu:
|
|
|
|
```bash
|
|
$ sudo apt-get update
|
|
$ sudo apt-get install libssl-dev libudev-dev pkg-config zlib1g-dev llvm clang
|
|
```
|
|
|
|
## **2. Download the source code.**
|
|
|
|
```bash
|
|
$ git clone https://github.com/solana-labs/solana.git
|
|
$ cd solana
|
|
```
|
|
|
|
## **3. Build.**
|
|
|
|
```bash
|
|
$ cargo build
|
|
```
|
|
|
|
## **4. Run a minimal local cluster.**
|
|
```bash
|
|
$ ./run.sh
|
|
```
|
|
|
|
# Testing
|
|
|
|
**Run the test suite:**
|
|
|
|
```bash
|
|
$ cargo test
|
|
```
|
|
|
|
### Starting a local testnet
|
|
Start your own testnet locally, instructions are in the [online docs](https://docs.solana.com/bench-tps).
|
|
|
|
### Accessing the remote testnet
|
|
* `testnet` - public stable testnet accessible via devnet.solana.com. Runs 24/7
|
|
|
|
# Benchmarking
|
|
|
|
First install the nightly build of rustc. `cargo bench` requires use of the
|
|
unstable features only available in the nightly build.
|
|
|
|
```bash
|
|
$ rustup install nightly
|
|
```
|
|
|
|
Run the benchmarks:
|
|
|
|
```bash
|
|
$ cargo +nightly bench
|
|
```
|
|
|
|
# Release Process
|
|
|
|
The release process for this project is described [here](RELEASE.md).
|
|
|
|
# Code coverage
|
|
|
|
To generate code coverage statistics:
|
|
|
|
```bash
|
|
$ 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 author's best effort. It is up to the reader to check and validate their accuracy and truthfulness. Furthermore nothing in this project constitutes a solicitation for investment.
|