Go to file
anatoly yakovenko 5ed39de8c5
Dont insert shred payload into rocksdb (#9366)
automerge
2020-04-16 18:20:55 -07:00
.buildkite Remove , 2020-03-23 22:12:16 -07:00
.github
accounts-bench Bump version to 1.2.0 2020-03-28 09:44:13 -07:00
archiver Bump version to 1.2.0 2020-03-28 09:44:13 -07:00
archiver-lib Bump serde_json from 1.0.49 to 1.0.51 2020-04-06 08:40:55 -07:00
archiver-utils Bump version to 1.2.0 2020-03-28 09:44:13 -07:00
banking-bench Bump version to 1.2.0 2020-03-28 09:44:13 -07:00
bench-exchange Bump serde_json from 1.0.49 to 1.0.51 2020-04-06 08:40:55 -07:00
bench-streamer Bump version to 1.2.0 2020-03-28 09:44:13 -07:00
bench-tps Bump serde_json from 1.0.49 to 1.0.51 2020-04-06 08:40:55 -07:00
chacha Bump version to 1.2.0 2020-03-28 09:44:13 -07:00
chacha-cuda Bump version to 1.2.0 2020-03-28 09:44:13 -07:00
chacha-sys Bump version to 1.2.0 2020-03-28 09:44:13 -07:00
ci Don't upload tarballs to buildkite to speed up build 2020-04-16 13:54:36 -07:00
clap-utils Tame overeager wallet manager (#9262) 2020-04-02 15:47:17 -06:00
cli Passing -v/--verbose to `solana confirm` now displays the full transaction 2020-04-16 08:19:30 -07:00
cli-config Assume json_rpc_url can be upgrade to a websocket if no port is supplied 2020-04-13 19:42:13 -07:00
client Passing -v/--verbose to `solana confirm` now displays the full transaction 2020-04-16 08:19:30 -07:00
core Dont insert shred payload into rocksdb (#9366) 2020-04-16 18:20:55 -07:00
crate-features Bump version to 1.2.0 2020-03-28 09:44:13 -07:00
docs Pacify shellcheck 2020-04-15 17:46:19 -07:00
dos Add repair message support to dos tool (#9090) 2020-03-29 14:44:25 -07:00
download-utils Add snapshot compression option (#9276) 2020-04-03 13:13:49 -07:00
faucet Bump serde from 1.0.105 to 1.0.106 2020-04-04 15:13:52 -07:00
genesis Bump serde_json from 1.0.49 to 1.0.51 2020-04-06 08:40:55 -07:00
genesis-programs Revert "Add native loader entry points (#9275)" Breaks genesis_config abi (#9377) 2020-04-08 14:36:18 -07:00
gossip Bump version to 1.2.0 2020-03-28 09:44:13 -07:00
install Bump serde from 1.0.105 to 1.0.106 2020-04-04 15:13:52 -07:00
keygen Improve error message on `solana-keygen new` filesystem permission errors 2020-04-16 10:28:49 -07:00
ledger Dont insert shred payload into rocksdb (#9366) 2020-04-16 18:20:55 -07:00
ledger-tool Dont insert shred payload into rocksdb (#9366) 2020-04-16 18:20:55 -07:00
local-cluster Dont insert shred payload into rocksdb (#9366) 2020-04-16 18:20:55 -07:00
log-analyzer Bump serde_json from 1.0.49 to 1.0.51 2020-04-06 08:40:55 -07:00
logger Bump version to 1.2.0 2020-03-28 09:44:13 -07:00
measure Bump version to 1.2.0 2020-03-28 09:44:13 -07:00
merkle-tree Bump version to 1.2.0 2020-03-28 09:44:13 -07:00
metrics Fix broadcast metrics (#9461) 2020-04-15 15:22:16 -07:00
multinode-demo Update getSignatureStatus: support multiple signatures, include slot in each response item (#9022) 2020-03-23 11:25:39 -06:00
net Fix partition setup (#9386) 2020-04-09 01:57:18 -07:00
net-shaper Fix partition setup (#9386) 2020-04-09 01:57:18 -07:00
net-utils Fix race in multi_bind_in_range (#9493) 2020-04-14 13:34:41 -07:00
perf Bump serde from 1.0.105 to 1.0.106 2020-04-04 15:13:52 -07:00
programs Add native loader entry points (#9486) 2020-04-15 09:41:29 -07:00
rayon-threadlimit Bump version to 1.2.0 2020-03-28 09:44:13 -07:00
remote-wallet More custom error rename (#9227) 2020-04-01 11:13:31 -07:00
runtime Add native loader entry points (#9486) 2020-04-15 09:41:29 -07:00
scripts Write wallet key to explicit file 2020-04-16 13:34:19 -07:00
sdk Add native loader entry points (#9486) 2020-04-15 09:41:29 -07:00
sdk-c Bump libc from 0.2.68 to 0.2.69 2020-04-13 17:30:02 -07:00
stake-accounts Clean up solana-stake-accounts (#9211) 2020-03-31 21:47:43 -06:00
stake-monitor Add 1 SOL grace, to allow for a complaint system account to fund a reasonable number of transactions. (#9359) 2020-04-07 13:43:43 -07:00
streamer Bump libc from 0.2.68 to 0.2.69 2020-04-13 17:30:02 -07:00
sys-tuner Improve sys-tuner error message 2020-04-14 12:21:05 -07:00
system-test Fix automation stake parser (#9403) 2020-04-10 15:42:38 -06:00
transaction-status Passing -v/--verbose to `solana confirm` now displays the full transaction 2020-04-16 08:19:30 -07:00
upload-perf Bump serde_json from 1.0.49 to 1.0.51 2020-04-06 08:40:55 -07:00
validator Decouple accounts hash calculation from snapshot hash (#9507) 2020-04-16 15:12:20 -07:00
vote-signer Bump serde_json from 1.0.49 to 1.0.51 2020-04-06 08:40:55 -07:00
watchtower Bump version to 1.2.0 2020-03-28 09:44:13 -07:00
.clippy.toml
.codecov.yml
.gitbook.yaml Move docs from book/ to docs/ (#8469) 2020-02-26 07:11:38 -08: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 Passing -v/--verbose to `solana confirm` now displays the full transaction 2020-04-16 08:19:30 -07:00
Cargo.toml Add solana-stake-accounts CLI tool (#9164) 2020-03-30 15:04:46 -07:00
LICENSE
README.md Update README.md 2020-04-09 11:06:09 -07:00
RELEASE.md Move docs from book/ to docs/ (#8469) 2020-02-26 07:11:38 -08:00
fetch-perf-libs.sh Cache solana-perf.tgz to speed up CI (#9360) 2020-04-07 13:13:45 -07:00
run.sh Strictly validate the contents of snapshot/genesis (#8959) 2020-03-25 02:46:41 -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

Deploying

They are deployed with the ci/testnet-manager.sh script through a list of scheduled buildkite jobs. Each testnet can be manually manipulated from buildkite as well.

How do I reset the testnet?

Manually trigger the testnet-management pipeline and when prompted select the desired testnet

Scaling the transaction generation rate

Increase the TX rate by increasing the number of cores on the client machine which is running bench-tps or run multiple clients. Decrease by lowering cores or using the rayon env variable RAYON_NUM_THREADS=<xx>

Testing a change on the testnet

Currently, a merged PR is the only way to test a change on the testnet. But you can run your own testnet using the scripts in the net/ directory.

Adjusting the number of clients or validators on the testnet

Edit ci/testnet-manager.sh

Metrics Server Maintenance

Sometimes the dashboard becomes unresponsive. This happens due to glitch in the metrics server. The current solution is to reset the metrics server. Use the following steps.

  1. The server is hosted in a GCP VM instance. Check if the VM instance is down by trying to SSH into it from the GCP console. The name of the VM is metrics-solana-com.
  2. If the VM is inaccessible, reset it from the GCP console.
  3. Once VM is up (or, was already up), the metrics services can be restarted from build automation.
    1. Navigate to https://buildkite.com/solana-labs/metrics-dot-solana-dot-com in your web browser
    2. Click on New Build
    3. This will show a pop up dialog. Click on options drop down.
    4. Type in FORCE_START=true in Environment Variables text box.
    5. Click Create Build
    6. This will restart the metrics services, and the dashboards should be accessible afterwards.

Debugging

Testnet may exhibit different symptoms of failures. Primary statistics to check are

  1. Rise in Confirmation Time
  2. Nodes are not voting
  3. Panics, and OOM notifications

Check the following if there are any signs of failure.

  1. Did testnet deployment fail?
    1. View buildkite logs for the last deployment: https://buildkite.com/solana-labs/testnet-management
    2. Use the relevant branch
    3. If the deployment failed, look at the build logs. The build artifacts for each remote node is uploaded. It's a good first step to triage from these logs.
  2. You may have to log into remote node if the deployment succeeded, but something failed during runtime.
    1. Get the private key for the testnet deployment from metrics-solana-com GCP instance.
    2. SSH into metrics-solana-com using GCP console and do the following.
    sudo bash
    cd ~buildkite-agent/.ssh
    ls
    
    1. Copy the relevant private key to your local machine
    2. Find the public IP address of the AWS instance for the remote node using AWS console
    3. ssh -i <private key file> ubuntu@<ip address of remote node>
    4. The logs are in ~solana\solana folder

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.