Go to file
Steven Luscher c971c61dfb
feat: add `maxSupportedTransactionVersion` option to `getBlock` and `getTransaction` (#26726)
2022-07-21 21:02:05 -07:00
.buildkite chore: use sccache (#26376) 2022-07-18 15:39:21 +08:00
.github Adding the `question` tag will now auto-close Issues and direct people to post on the Solana Stack Exchange (#26719) 2022-07-21 19:58:49 -07:00
account-decoder
accounts-bench
accounts-cluster-bench
banking-bench Cleanup from PR #25914 (#26644) 2022-07-20 00:01:35 -05:00
banks-client
banks-interface
banks-server
bench-streamer
bench-tps Create nonce keypair chunks (#26670) 2022-07-21 14:50:23 +02:00
bloom
bucket_map
ci chore: update buildkite agents query rule (#26708) 2022-07-21 12:08:48 +08:00
clap-utils
clap-v3-utils
cli cli: Use CliBalance for `solana balance` output (#26717) 2022-07-22 03:04:05 +00:00
cli-config chore: bump anyhow from 1.0.57 to 1.0.58 (#26724) 2022-07-22 02:45:22 +00:00
cli-output cli-output: Add CliBalance (#26703) 2022-07-21 18:31:38 -05:00
client chore: bump anyhow from 1.0.57 to 1.0.58 (#26724) 2022-07-22 02:45:22 +00:00
client-test
core Add comment for forwarder buffer iteration behavior (#26721) 2022-07-22 01:15:17 +00:00
docs rpc_client: Add get_stake_minimum_delegation_with_commitment() (#26697) 2022-07-20 20:26:47 -05:00
dos
download-utils
entry
explorer chore:(deps): bump terser from 4.8.0 to 4.8.1 in /explorer (#26701) 2022-07-20 17:42:08 +00:00
faucet
frozen-abi chore: bump hashbrown from 0.11.2 to 0.12.1 (#26542) 2022-07-21 03:12:47 +00:00
genesis
genesis-utils
geyser-plugin-interface
geyser-plugin-manager
gossip
install
keygen
ledger Allow ledger tool to automatically detect the shred compaction style (#26182) 2022-07-19 01:19:17 +08:00
ledger-tool Allow ledger tool to automatically detect the shred compaction style (#26182) 2022-07-19 01:19:17 +08:00
local-cluster Revert "core: disable quic servers on mainnet-beta" (#26216) 2022-07-20 20:37:24 +02:00
log-analyzer
logger
measure
merkle-root-bench
merkle-tree
metrics
multinode-demo
net
net-shaper
net-utils
notifier
perf
poh
poh-bench
program-runtime Removes `AccountSharedData` from `SysvarCache`. (#26712) 2022-07-21 18:32:28 +02:00
program-test Fix merge conflict in program-test (#26693) 2022-07-20 14:32:59 +02:00
programs chore: bump anyhow from 1.0.57 to 1.0.58 (#26724) 2022-07-22 02:45:22 +00:00
rayon-threadlimit
rbpf-cli Cap the number of accounts passed to a bpf program ix (#26630) 2022-07-20 14:12:43 +02:00
remote-wallet
rpc Add RPC getStakeMinimumDelegation (#26638) 2022-07-17 18:39:39 +00:00
rpc-test patches flaky test_rpc_slot_updates (#26593) 2022-07-14 12:33:54 +00:00
runtime Separate field_from_stream to get bank/account fields from individual snapshot stream (#26679) 2022-07-21 12:27:31 -05:00
scripts
sdk chore: bump anyhow from 1.0.57 to 1.0.58 (#26724) 2022-07-22 02:45:22 +00:00
send-transaction-service
stake-accounts
storage-bigtable chore: bump anyhow from 1.0.57 to 1.0.58 (#26724) 2022-07-22 02:45:22 +00:00
storage-proto Cap the number of accounts passed to a bpf program ix (#26630) 2022-07-20 14:12:43 +02:00
streamer Remove some unchecked math from the quic chunk handling (#26408) 2022-07-16 17:03:31 +02:00
sys-tuner
system-test chore: update buildkite agents query rule (#26708) 2022-07-21 12:08:48 +08:00
test-validator add found files to debug log 2022-07-20 10:24:20 -07:00
tokens async hash verify on load (#26208) 2022-07-15 14:29:56 -05:00
transaction-dos
transaction-status
upload-perf
validator Revert "core: disable quic servers on mainnet-beta" (#26216) 2022-07-20 20:37:24 +02:00
version
watchtower
web3.js feat: add `maxSupportedTransactionVersion` option to `getBlock` and `getTransaction` (#26726) 2022-07-21 21:02:05 -07:00
zk-token-sdk
.clippy.toml
.codecov.yml
.gitignore
.mergify.yml
.travis.yml
CONTRIBUTING.md
Cargo.lock chore: bump anyhow from 1.0.57 to 1.0.58 (#26724) 2022-07-22 02:45:22 +00:00
Cargo.toml
LICENSE
README.md
RELEASE.md
SECURITY.md Update SECURITY.md 2022-07-20 01:32:31 +09:00
cargo
cargo-build-bpf
cargo-build-sbf
cargo-test-bpf
cargo-test-sbf
fetch-perf-libs.sh
fetch-spl.sh
run.sh
rustfmt.toml
test-abi.sh
vercel.json

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

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

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

  • 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 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 Foundation's ("SF") 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 SF or developer resources that SF provides are for educational and inspirational 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 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. 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.