Go to file
Kristofer Peterson b7a32f01c0
Multi-version snapshot support (#9980)
* Multi-version snapshot support

* rustfmt

* Remove CLI options and runtime support for selection output snapshot version.
Address some clippy complaints.

* Muzzle clippy type complexity warning.

Despite clippy's suggestion, it is not currently possible to create type aliases
for traits and so everything within the 'Box<...>' cannot be type aliased.

This then leaves creating full blown traits, and either implementing
said traits by closure (somehow) or moving the closures into new structs
implementing said traits which seems a bit of a palaver.

Alternatively it is possible to define and use the type alias 'type ResultBox<T> = Result<Box<T>>'
which does seems rather pointless and not a great reduction in complexity but is enough to keep clippy happy.

In the end I simply went with squelching the clippy warning.

* Remove now unused Serialize/Deserialize trait implementations for AccountStorageEntry and AppendVec

* refactor versioned de/serialisers

* rename serde_utils to serde_snapshot

* move call to accounts_db.generate_index() back down to context_accountsdb_from_stream()

* update version 1.1.1 to 1.2.0
remove nested use of serialize_bytes

* cleanups

* Add back measurement of account storage entry serialization.
Remove construction of Vec and HashMap temporaries during serialization.

* consolidate serialisation test cases into serde_snapshot.
clean up leakage of implementation details in serde_snapshot.

* move short term / legacy snapshot code into child module

* add serialize_iter_as_tuple

* preliminary integration of following commit

commit 6d58b73c47294bfb93465d5a83cd2175660b6e6d
Author: Ryo Onodera <ryoqun@gmail.com>
Date:   Wed May 20 14:02:02 2020 +0900

    Confine snapshot 1.1 relic to versioned codepath

* refactored serde_snapshot, rustfmt
legacy accounts_db format now "owns" both leading u64s, legacy bank_rc format has none

* reduce type complexity (clippy)
2020-05-23 02:54:24 +09:00
.buildkite Remove , 2020-03-23 22:12:16 -07:00
.github Mark PRs stale after 7 days instead of 30 (#7528) 2019-12-17 14:37:35 -07:00
accounts-bench Bump clap from 2.33.0 to 2.33.1 (#9978) 2020-05-11 14:32:50 -07:00
banking-bench Update dalek version 2020-04-28 21:02:47 -06:00
bench-exchange move builtin programs out of bank (#10132) 2020-05-19 19:45:30 -07:00
bench-streamer Advertise node software version in gossip (#9981) 2020-05-11 15:02:01 -07:00
bench-tps Add option to wait for a specific epoch length to bench-tps (#10083) 2020-05-20 16:42:46 -07:00
ci multinode-demo/faucet.sh is no longer required (#10129) 2020-05-19 20:07:30 -07:00
clap-utils Add CommitmentConfig::single() support to the cli (#10114) 2020-05-19 13:45:21 -07:00
cli Bump thiserror from 1.0.18 to 1.0.19 (#10180) 2020-05-21 23:36:04 -07:00
cli-config Bump serde_yaml from 0.8.11 to 0.8.12 (#9966) 2020-05-10 18:11:23 -07:00
client Clean up RPCClient retry handling: only retry on 429, after a little sleep (#10182) 2020-05-22 08:53:53 -07:00
core Multi-version snapshot support (#9980) 2020-05-23 02:54:24 +09:00
crate-features Update dalek version 2020-04-28 21:02:47 -06:00
docs document optimistic confirmation and slashing roadmap (#10164) 2020-05-21 18:15:09 -07:00
dos master: Add nonce to shreds repairs, add shred data size to header (#10109) 2020-05-19 12:38:18 -07:00
download-utils Bump tar from 0.4.26 to 0.4.27 (#10150) 2020-05-20 20:04:22 -07:00
faucet 9951 clippy errors in the test suite (#10030) 2020-05-15 09:35:43 -07:00
genesis 9951 clippy errors in the test suite (#10030) 2020-05-15 09:35:43 -07:00
genesis-programs Remove archiver and storage program (#9992) 2020-05-14 18:22:47 -07:00
gossip Wait 15 seconds for gossip rpc url (#10053) 2020-05-15 13:23:40 -07:00
install Bump tar from 0.4.26 to 0.4.27 (#10150) 2020-05-20 20:04:22 -07:00
keygen Advertise node software version in gossip (#9981) 2020-05-11 15:02:01 -07:00
ledger Multi-version snapshot support (#9980) 2020-05-23 02:54:24 +09:00
ledger-tool Remove folds (#10128) 2020-05-19 18:13:41 -07:00
local-cluster 9951 clippy errors in the test suite (#10030) 2020-05-15 09:35:43 -07:00
log-analyzer Bump byte-unit from 3.0.3 to 3.1.1 (#10098) 2020-05-19 09:03:30 -06:00
logger Upgrade to Rust 1.43.0 (#9754) 2020-04-29 18:02:05 -07:00
measure Only build x86_64-unknown-linux-gnu on docs.rs 2020-04-16 19:06:17 -07:00
merkle-tree 9951 clippy errors in the test suite (#10030) 2020-05-15 09:35:43 -07:00
metrics Add 30s option to metrics. (#10081) 2020-05-16 10:46:17 -07:00
multinode-demo Fetch rpc-url from the gossip entrypoint (#10152) 2020-05-20 14:52:41 -07:00
net multinode-demo/faucet.sh is no longer required (#10129) 2020-05-19 20:07:30 -07:00
net-shaper Bump clap from 2.33.0 to 2.33.1 (#9978) 2020-05-11 14:32:50 -07:00
net-utils Advertise node software version in gossip (#9981) 2020-05-11 15:02:01 -07:00
notifier Remove notifier module duplication (#10051) 2020-05-14 17:32:08 -07:00
perf 9951 clippy errors in the test suite (#10030) 2020-05-15 09:35:43 -07:00
programs Multi-version snapshot support (#9980) 2020-05-23 02:54:24 +09:00
ramp-tps Bump tar from 0.4.26 to 0.4.27 (#10150) 2020-05-20 20:04:22 -07:00
rayon-threadlimit Bump num_cpus from 1.12.0 to 1.13.0 (#9682) 2020-04-23 13:08:06 -07:00
remote-wallet Remove folds (#10128) 2020-05-19 18:13:41 -07:00
runtime Multi-version snapshot support (#9980) 2020-05-23 02:54:24 +09:00
scripts Add stake-o-matic (#10044) 2020-05-20 16:15:03 -07:00
sdk Add option to wait for a specific epoch length to bench-tps (#10083) 2020-05-20 16:42:46 -07:00
stake-accounts Add unique_signers() to SDK (#10105) 2020-05-18 18:31:45 -07:00
stake-monitor Advertise node software version in gossip (#9981) 2020-05-11 15:02:01 -07:00
stake-o-matic Update whitelist.rs (#10183) 2020-05-22 10:10:26 -07:00
streamer 9951 clippy errors in the test suite (#10030) 2020-05-15 09:35:43 -07:00
sys-tuner Bump libc from 0.2.69 to 0.2.70 (#10006) 2020-05-15 06:18:43 -06:00
system-test Remove archiver and storage program (#9992) 2020-05-14 18:22:47 -07:00
tokens Add unique_signers() to SDK (#10105) 2020-05-18 18:31:45 -07:00
transaction-status Bump serde from 1.0.106 to 1.0.110 (#9964) 2020-05-10 16:24:25 -07:00
upload-perf Bump serde_json from 1.0.52 to 1.0.53 (#9957) 2020-05-10 11:46:29 -07:00
validator Bump libc from 0.2.69 to 0.2.70 (#10006) 2020-05-15 06:18:43 -06:00
version 9951 clippy errors in the test suite (#10030) 2020-05-15 09:35:43 -07:00
vote-signer 9951 clippy errors in the test suite (#10030) 2020-05-15 09:35:43 -07:00
watchtower Remove folds (#10128) 2020-05-19 18:13:41 -07:00
.clippy.toml Fix all remaining clippy warnings 2018-07-12 09:40:40 -06:00
.codecov.yml Adjust settings 2018-12-20 12:32:25 -08:00
.gitbook.yaml Clean up wallet URL paths (#9667) 2020-04-22 16:48:21 -07:00
.gitignore Generate CLI usage (#8637) 2020-03-04 17:44:30 -07:00
.mergify.yml Allow v1.0 backports from v1.1 2020-04-06 11:26:39 -07:00
.travis.yml Try enabling windows build again, maybe it's more stable now 2020-03-17 11:14:08 -07:00
CONTRIBUTING.md Move docs from book/ to docs/ (#8469) 2020-02-26 07:11:38 -08:00
Cargo.lock Bump thiserror from 1.0.18 to 1.0.19 (#10180) 2020-05-21 23:36:04 -07:00
Cargo.toml Add stake-o-matic (#10044) 2020-05-20 16:15:03 -07:00
LICENSE Update LICENSE 2018-06-22 22:41:04 -07:00
README.md Update link 2020-04-18 15:11:55 -07:00
RELEASE.md Move docs from book/ to docs/ (#8469) 2020-02-26 07:11:38 -08:00
fetch-perf-libs.sh Re-enable gpu sigverify (#9870) 2020-05-06 15:44:55 -07:00
run.sh Support ad-hoc genesis args in run.sh (#9697) 2020-04-23 22:48:53 -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

If your rustc version is lower than 1.39.0, please update it:

$ 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

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 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.

$ 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 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.