Go to file
Tyera Eulberg b7de369992
Bump spl-token to v3.1.1 (#17951)
2021-06-14 23:33:20 -06:00
.buildkite Clear release cache for stable-perf (#17287) 2021-05-17 17:28:52 -06:00
.github
.travis
account-decoder Bump spl-token to v3.1.1 (#17951) 2021-06-14 23:33:20 -06:00
accounts-bench calculate_capitalization uses hash calculation (#17443) 2021-06-14 08:53:07 -05:00
accounts-cluster-bench Bump spl-token to v3.1.1 (#17951) 2021-06-14 23:33:20 -06:00
banking-bench chore: bump rayon from 1.5.0 to 1.5.1 (#17869) 2021-06-10 13:18:47 -06:00
banks-client chore: bump mio from 0.7.6 to 0.7.11 (#17872) 2021-06-10 19:15:34 +00:00
banks-interface chore: bump mio from 0.7.6 to 0.7.11 (#17872) 2021-06-10 19:15:34 +00:00
banks-server chore: bump mio from 0.7.6 to 0.7.11 (#17872) 2021-06-10 19:15:34 +00:00
bench-exchange chore: bump itertools from 0.9.0 to 0.10.1 (#17929) 2021-06-14 18:32:20 +00:00
bench-streamer Don't use pinned memory when unnecessary (#17832) 2021-06-14 16:10:04 +02:00
bench-tps chore: bump rayon from 1.5.0 to 1.5.1 (#17869) 2021-06-10 13:18:47 -06:00
ci Create solana-poh and move remaining rpc modules to solana-rpc (#17698) 2021-06-04 09:23:06 -06:00
clap-utils Bump tempfile from 3.1.0 to 3.2.0 (#17587) 2021-05-31 18:05:07 +00:00
cli chore: bump serde_json from 1.0.62 to 1.0.64 (#17735) 2021-06-04 17:45:26 +00:00
cli-config Bump serde from 1.0.122 to 1.0.126 (#17618) 2021-05-31 22:41:25 +00:00
cli-output chore: bump serde_json from 1.0.62 to 1.0.64 (#17735) 2021-06-04 17:45:26 +00:00
client Handle removing slots during account scans (#17471) 2021-06-14 21:04:01 -07:00
core Handle removing slots during account scans (#17471) 2021-06-14 21:04:01 -07:00
crate-features Bump version to v1.8.0 (#17541) 2021-05-27 08:51:53 -07:00
docs Fix typo in docs (#17920) 2021-06-14 10:33:23 -06:00
dos chore: bump rayon from 1.5.0 to 1.5.1 (#17869) 2021-06-10 13:18:47 -06:00
download-utils chore: bump tar from 0.4.28 to 0.4.35 (#17666) 2021-06-02 14:17:58 -06:00
explorer chore:(deps): bump @solana/spl-token-registry in /explorer (#17925) 2021-06-14 09:21:02 +00:00
faucet Bump serde from 1.0.122 to 1.0.126 (#17618) 2021-05-31 22:41:25 +00:00
frozen-abi chore: bump rustc_version from 0.2.3 to 0.4.0 (#17854) 2021-06-09 16:57:39 +00:00
genesis Remove budget program (#17816) 2021-06-08 01:20:17 +00:00
genesis-utils Bump version to v1.8.0 (#17541) 2021-05-27 08:51:53 -07:00
gossip chore: bump itertools from 0.9.0 to 0.10.1 (#17929) 2021-06-14 18:32:20 +00:00
install chore: bump semver from 0.11.0 to 1.0.3 (#17871) 2021-06-10 13:02:31 -06:00
keygen Don't require non-existent param for keygen new (#17896) 2021-06-11 19:25:03 +00:00
ledger add metrics for startup (#17913) 2021-06-14 17:46:49 -05:00
ledger-tool Handle removing slots during account scans (#17471) 2021-06-14 21:04:01 -07:00
local-cluster chore: bump itertools from 0.9.0 to 0.10.1 (#17929) 2021-06-14 18:32:20 +00:00
log-analyzer chore: bump serde_json from 1.0.62 to 1.0.64 (#17735) 2021-06-04 17:45:26 +00:00
logger Bump version to v1.8.0 (#17541) 2021-05-27 08:51:53 -07:00
measure Bump version to v1.8.0 (#17541) 2021-05-27 08:51:53 -07:00
merkle-root-bench Bump version to v1.8.0 (#17541) 2021-05-27 08:51:53 -07:00
merkle-tree chore: bump hex from 0.4.2 to 0.4.3 (#17829) 2021-06-08 09:34:04 -06:00
metrics chore: bump serial_test from 0.4.0 to 0.5.1 (#17705) 2021-06-03 10:07:56 -06:00
multinode-demo Add automated restart test infrastructure (#17491) 2021-06-04 15:55:16 -07:00
net Update init-metrics.sh (#17952) 2021-06-15 04:31:28 +00:00
net-shaper chore: bump serde_json from 1.0.62 to 1.0.64 (#17735) 2021-06-04 17:45:26 +00:00
net-utils chore: bump nix from 0.19.0 to 0.20.0 (#17853) 2021-06-09 18:01:26 +00:00
notifier Bump version to v1.8.0 (#17541) 2021-05-27 08:51:53 -07:00
perf Don't use pinned memory when unnecessary (#17832) 2021-06-14 16:10:04 +02:00
poh Create solana-poh and move remaining rpc modules to solana-rpc (#17698) 2021-06-04 09:23:06 -06:00
poh-bench chore: bump rayon from 1.5.0 to 1.5.1 (#17869) 2021-06-10 13:18:47 -06:00
program-test chore: bump mio from 0.7.6 to 0.7.11 (#17872) 2021-06-10 19:15:34 +00:00
programs Bump spl-token to v3.1.1 (#17951) 2021-06-14 23:33:20 -06:00
rayon-threadlimit Bump version to v1.8.0 (#17541) 2021-05-27 08:51:53 -07:00
rbpf-cli chore: bump serde_json from 1.0.62 to 1.0.64 (#17735) 2021-06-04 17:45:26 +00:00
remote-wallet chore: bump semver from 0.11.0 to 1.0.3 (#17871) 2021-06-10 13:02:31 -06:00
rpc Bump spl-token to v3.1.1 (#17951) 2021-06-14 23:33:20 -06:00
runtime Handle removing slots during account scans (#17471) 2021-06-14 21:04:01 -07:00
scripts Bump serde from 1.0.122 to 1.0.126 (#17618) 2021-05-31 22:41:25 +00:00
sdk Handle removing slots during account scans (#17471) 2021-06-14 21:04:01 -07:00
stake-accounts Bump version to v1.8.0 (#17541) 2021-05-27 08:51:53 -07:00
stake-monitor Create solana-poh and move remaining rpc modules to solana-rpc (#17698) 2021-06-04 09:23:06 -06:00
storage-bigtable chore: bump indexmap from 1.5.1 to 1.6.2 (#17884) 2021-06-11 09:50:09 -06:00
storage-proto chore: bump indexmap from 1.5.1 to 1.6.2 (#17884) 2021-06-11 09:50:09 -06:00
streamer Don't use pinned memory when unnecessary (#17832) 2021-06-14 16:10:04 +02:00
sys-tuner chore: bump nix from 0.19.0 to 0.20.0 (#17853) 2021-06-09 18:01:26 +00:00
system-test Restart test without supermajority (#17808) 2021-06-10 12:56:31 -07:00
tokens Bump spl-token to v3.1.1 (#17951) 2021-06-14 23:33:20 -06:00
transaction-status Bump spl-token to v3.1.1 (#17951) 2021-06-14 23:33:20 -06:00
upload-perf chore: bump serde_json from 1.0.62 to 1.0.64 (#17735) 2021-06-04 17:45:26 +00:00
validator Make account shrink configurable #17544 (#17778) 2021-06-09 21:21:32 -07:00
version chore: bump rustc_version from 0.2.3 to 0.4.0 (#17854) 2021-06-09 16:57:39 +00:00
watchtower Bump version to v1.8.0 (#17541) 2021-05-27 08:51:53 -07:00
web3.js chore: bump @babel/core from 7.14.3 to 7.14.5 in /web3.js (#17909) 2021-06-12 00:30:51 +00:00
.clippy.toml
.codecov.yml
.gitignore Fix cli usage build 2021-01-29 19:03:10 +00:00
.mergify.yml Add label to community contributions (#17876) 2021-06-10 12:28:37 -07:00
.travis.yml explorer: downgrade nodejs version in travis (#16740) 2021-04-22 22:27:50 +08:00
CONTRIBUTING.md
Cargo.lock Bump spl-token to v3.1.1 (#17951) 2021-06-14 23:33:20 -06:00
Cargo.toml Disable reed-solomon-erasure/simd-accel feature on aarch64 (Apple M1) 2021-06-08 12:09:34 -07:00
LICENSE
README.md Add new logo (#16556) 2021-04-14 19:02:42 -06:00
RELEASE.md
SECURITY.md Clarify bug bounty payment policy (#16488) 2021-04-12 14:53:15 -06:00
cargo Speed up net.sh builds (#16360) 2021-04-07 14:45:03 +08:00
cargo-build-bpf Add cargo-test-bpf 2020-11-05 14:29:17 -08:00
cargo-test-bpf Add cargo-test-bpf 2020-11-05 14:29:17 -08:00
fetch-perf-libs.sh
fetch-spl.sh Load memo v2 into genesis for test validator (#15425) 2021-02-19 15:59:31 +08:00
run.sh Skip leader slots until a vote lands (#15607) 2021-03-25 18:54:51 -07:00
test-abi.sh Update frozen_abi hashes 2020-10-24 08:37:55 -07:00

README.md

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

Please sure you are always using the latest stable rust version by running:

$ rustup update

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

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

On Mac M1s, make sure you set up your terminal & homebrew to use Rosetta. You can install it with:

$ softwareupdate --install-rosetta

2. Download the source code.

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

3. Build.

$ cargo build

4. Run a minimal local cluster.

$ ./run.sh

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

  • devnet - stable public cluster for development accessible via devnet.solana.com. Runs 24/7. Learn more about the public clusters

Benchmarking

First install the nightly build of rustc. cargo bench requires 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 Foundation's ("SF") best 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 SF or developer resources that SF provides, are for educational and inspiration purposes only. SF 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 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. As a project based primarily on open-source software, it is possible that such sanctioned persons may nevertheless bypass prohibitions, obtain the code comprising the Solana blockchain protocol (or other project code or applications) and deploy, integrate, or otherwise use it. Accordingly, there is a risk to individuals that other persons using the Solana blockchain protocol may be sanctioned persons and that transactions with such persons would be a violation of U.S. export controls and sanctions law. This risk applies to individuals, organizations, and other ecosystem participants that deploy, integrate, or use the Solana blockchain protocol code directly (e.g., as a node operator), and individuals that transact on the Solana blockchain through light clients, third party interfaces, and/or wallet software.