Go to file
GroovieGermanikus 2731f00ce5
RPC: allow IPv6 binding
2024-12-05 13:41:50 +01:00
.buildkite ci: run bench test in docker (#33944) 2023-11-17 12:11:25 +08:00
.github v1.18: Re-enable SPL downstream job with last v1.18 commit (#2143) 2024-07-21 19:48:21 -05:00
account-decoder collect all mango rpc optimizations in single commit 2024-08-09 11:36:33 +02:00
accounts-bench Removes unnecessary AccountsDb::new_with_config_for_benches() (#34484) 2023-12-18 06:52:41 -05:00
accounts-cluster-bench Add RPC bench threads to accounts-cluster-bench (#34520) 2024-01-06 13:32:29 +01:00
accounts-db collect all mango rpc optimizations in single commit 2024-08-09 11:36:33 +02:00
banking-bench Use BankForks on tests - Part 3 (#34248) 2023-12-01 13:47:22 -03:00
banks-client Use BankForks on tests - Part 3 (#34248) 2023-12-01 13:47:22 -03:00
banks-interface RPC: Add inner instructions to simulate transaction response (#34313) 2023-12-16 12:49:22 +00:00
banks-server RPC: Add inner instructions to simulate transaction response (#34313) 2023-12-16 12:49:22 +00:00
bench-streamer v1.18: BankingStage Forwarding Filter (backport of #685) (#697) 2024-04-12 06:55:11 +08:00
bench-tps v1.18: deprecate `get_client` and `get_multi_client` (backport of #177) (#182) 2024-03-13 10:21:54 -05:00
bloom ConcurrentBloomInterval (#34486) 2024-01-02 08:21:36 -08:00
bucket_map Fix typos (#34459) 2023-12-21 13:06:00 -07:00
cargo-registry Cleanup cargo registry code (#33879) 2023-10-26 12:58:20 -07:00
cd
ci v1.18: suppress openssl audit (#2263) 2024-07-24 16:06:04 -05:00
clap-utils clap-utils: Forbid multiple values for `--signer` (#34482) 2024-01-05 21:25:50 +01:00
clap-v3-utils v1.18: [clap-v3-utils] Add functions to parse directly from `SignerSource` (backport of #34678) (#35384) 2024-03-02 07:06:13 +09:00
cli v1.18: Deprecate RpcClient::get_stake_activation (backport of #1895) (#1924) 2024-07-10 16:38:33 -05:00
cli-config [docs] updated readme and fix links (#34565) 2024-01-03 09:06:06 -05:00
cli-output fix typo in variable name and error messages (#34463) 2023-12-14 15:29:02 -06:00
client v1.18: cli: use newer blockhashes when deploying large programs (backport of #1070) (#1074) 2024-05-14 14:26:28 +08:00
client-test Use BankForks on tests - Part 3 (#34248) 2023-12-01 13:47:22 -03:00
connection-cache Quic update identity (#33865) 2023-12-08 14:53:19 +08:00
core v1.18: gossip: do not allow duplicate proofs for incorrect shred versions (backport of #1931) (#1940) 2024-07-10 16:38:33 -05:00
cost-model v1.18: add precompile signature metrics to cost tracker (backport of #133) (#143) 2024-03-13 10:23:48 -05:00
docs v1.18: [docs] translation support (backport of #35166) (#35169) 2024-02-09 15:58:07 -05:00
dos v1.18: deprecate `get_client` and `get_multi_client` (backport of #177) (#182) 2024-03-13 10:21:54 -05:00
download-utils Use BankForks on tests - Part 3 (#34248) 2023-12-01 13:47:22 -03:00
entry removes outdated matches crate from dependencies (#33172) 2023-09-07 12:52:57 +00:00
faucet preliminaries for bumping nightly to 2023-08-25 (#33047) 2023-08-29 23:05:35 +00:00
frozen-abi Cargo.toml: Sort dependency and feature lists (#33670) 2023-10-17 01:12:15 -07:00
genesis v1.18: sdk: Rederive Copy on Rent and EpochSchedule (#1744) 2024-06-17 17:14:32 -05:00
genesis-utils Move accounts-db code to its own crate (#32766) 2023-08-09 13:03:36 -07:00
geyser-plugin-interface collect all mango rpc optimizations in single commit 2024-08-09 11:36:33 +02:00
geyser-plugin-manager collect all mango rpc optimizations in single commit 2024-08-09 11:36:33 +02:00
gossip v1.18: gossip: do not allow duplicate proofs for incorrect shred versions (backport of #1931) (#1940) 2024-07-10 16:38:33 -05:00
install Remove solana-install support for channels since it is already broken. 2024-07-21 19:49:25 -05:00
keygen [clap-v3-utils] Deprecate signer source validation (#33802) 2024-01-06 08:19:54 +09:00
ledger v1.18: sdk: Rederive Copy on Rent and EpochSchedule (#1744) 2024-06-17 17:14:32 -05:00
ledger-tool v1.18: ledger-tool: Set initial last full snapshot slot (backport of #2314) (#2342) 2024-08-03 00:36:31 -05:00
local-cluster v1.18: pads last erasure batch with empty data shreds (backport of #639) (#927) 2024-04-26 15:17:21 +08:00
log-analyzer Upgrades Rust to 1.72.0 & nightly-2023-08-25 (#32961) 2023-09-01 07:26:13 +00:00
logger clippy: Removes ineffective open options (#34599) 2023-12-27 22:20:17 -05:00
measure Upgrades Rust to 1.72.0 & nightly-2023-08-25 (#32961) 2023-09-01 07:26:13 +00:00
memory-management Upgrades Rust to 1.72.0 & nightly-2023-08-25 (#32961) 2023-09-01 07:26:13 +00:00
merkle-root-bench Move accounts-db code to its own crate (#32766) 2023-08-09 13:03:36 -07:00
merkle-tree removes outdated matches crate from dependencies (#33172) 2023-09-07 12:52:57 +00:00
metrics Enhancements to Solana's Documentations for Better Clarity (#34386) 2023-12-12 15:26:14 -05:00
multinode-demo use staked connection for bench-tps in net scripts (#34767) 2024-01-13 18:50:27 +01:00
net use staked connection for bench-tps in net scripts (#34767) 2024-01-13 18:50:27 +01:00
net-shaper Upgrades Rust to 1.72.0 & nightly-2023-08-25 (#32961) 2023-09-01 07:26:13 +00:00
net-utils RPC: allow IPv6 binding 2024-12-05 13:41:50 +01:00
notifier chore: workspace inheritance (#29893) 2023-02-23 22:01:54 +08:00
perf Fix typos (#34459) 2023-12-21 13:06:00 -07:00
poh v1.18: Remove stale poh recorder validator id (backport of #700) (#767) 2024-04-26 15:16:42 +08:00
poh-bench Upgrades Rust to 1.72.0 & nightly-2023-08-25 (#32961) 2023-09-01 07:26:13 +00:00
program-runtime v1.18 - Adds error log for replacements in ProgramCache::assign_program(). (#1401) 2024-05-18 13:28:16 +08:00
program-test v1.18: Revert deprecate executable feature (backport of #309) (#337) 2024-03-22 22:54:04 -05:00
programs Bump rbpf version to 0.8.3 (backport of #2515) (#2513) 2024-08-08 19:03:02 -05:00
pubsub-client [docs] updated readme and fix links (#34565) 2024-01-03 09:06:06 -05:00
quic-client v1.18: Limit max concurrent connections (backport of #851) (#926) 2024-04-26 15:18:09 +08:00
rayon-threadlimit chore: workspace inheritance (#29893) 2023-02-23 22:01:54 +08:00
rbpf-cli rbpf-cli: fix deprecation notice (#31743) 2023-05-22 04:47:05 -05:00
remote-wallet [clap-v3-utils] Deprecate signer source validation (#33802) 2024-01-06 08:19:54 +09:00
rpc collect all mango rpc optimizations in single commit 2024-08-09 11:36:33 +02:00
rpc-client Undo deprecation message edit on RpcClient::get_stake_activation (#2171) 2024-07-21 19:48:27 -05:00
rpc-client-api collect all mango rpc optimizations in single commit 2024-08-09 11:36:33 +02:00
rpc-client-nonce-utils chore: workspace inheritance (#29893) 2023-02-23 22:01:54 +08:00
rpc-test clippy: Replaces .get(0) with .first() (#34048) 2023-11-13 17:22:17 -05:00
runtime collect all mango rpc optimizations in single commit 2024-08-09 11:36:33 +02:00
runtime-transaction add requested limits to static meta (#34361) 2023-12-15 18:39:19 -06:00
scripts Update scripts/spl-token-cli-version.sh with latest SPL Token CLI version (#1823) 2024-07-10 16:38:33 -05:00
sdk collect all mango rpc optimizations in single commit 2024-08-09 11:36:33 +02:00
send-transaction-service v1.18: rpc-sts: add config options for stake-weighted qos (backport of #197) (#341) 2024-03-22 22:54:05 -05:00
stake-accounts explicitly sets fee rate to zero for stake-accounts tests (#34848) 2024-01-19 09:17:31 -06:00
storage-bigtable Bigtable: update google proto files and allow configuration of max_message_size (#34740) 2024-01-10 21:20:15 -07:00
storage-proto ledger-tool: read bigtable entries (#34266) 2023-11-30 21:33:04 +00:00
streamer v1.18: Limit max concurrent connections (backport of #851) (#926) 2024-04-26 15:18:09 +08:00
system-test Fix typos (#34459) 2023-12-21 13:06:00 -07:00
test-validator v1.18: sdk: Rederive Copy on Rent and EpochSchedule (#1744) 2024-06-17 17:14:32 -05:00
thin-client Async connection creation in connection cache (#33302) 2023-09-25 18:17:47 -07:00
tokens Documentation Improvements: Typos and Grammar Fixes (#34461) 2023-12-14 16:44:30 +00:00
tpu-client v1.18: Change DEFAULT_TPU_CONNECTION_POOL_SIZE to 1 (backport of #1014) (#1043) 2024-04-26 15:18:16 +08:00
transaction-dos v1.18: cli: Add `--use-rpc` flag to program deploy and write-buffer (backport of #928) (#992) 2024-04-26 15:17:30 +08:00
transaction-status collect all mango rpc optimizations in single commit 2024-08-09 11:36:33 +02:00
turbine v1.18: patches bug in chained Merkle root update (backport of #1689) (#1692) 2024-06-17 17:14:32 -05:00
udp-client Quic update identity (#33865) 2023-12-08 14:53:19 +08:00
unified-scheduler-logic Finish unified scheduler plumbing with min impl (#34300) 2023-12-19 09:50:41 +09:00
unified-scheduler-pool Finish unified scheduler plumbing with min impl (#34300) 2023-12-19 09:50:41 +09:00
upload-perf chore: workspace inheritance (#29893) 2023-02-23 22:01:54 +08:00
validator v1.18: rpc-sts: add config options for stake-weighted qos (backport of #197) (#341) 2024-03-22 22:54:05 -05:00
version ci: test-checks.sh all sbf code & use nightly only (#30602) 2023-03-13 14:28:34 +09:00
vote v1.18: gossip: notify state machine of duplicate proofs (backport of #32963) (#35006) 2024-01-29 19:19:38 +00:00
watchtower docs: fix typo in watchtower/README.md (#33771) 2023-10-19 17:28:04 +02:00
web3.js Add link to new web3.js repo (#30096) 2023-02-27 10:23:54 -06:00
wen-restart We need to publish solana-wen-restart so we can publish 1.18.0 later. (#33662) 2023-10-11 11:27:09 -07:00
zk-keygen [clap-v3-utils] Deprecate signer source validation (#33802) 2024-01-06 08:19:54 +09:00
zk-token-sdk [zk-token-sdk] Restrict a single-bit of 256-bit batched range proof to 128 (#34803) 2024-01-18 14:37:04 +09:00
.clippy.toml
.codecov.yml Add .codecov.yml with checks disabled (#30666) 2023-03-10 20:11:22 +09:00
.gitignore git: ignore all `target/` directories (#34705) 2024-01-09 12:30:11 +01:00
.mergify.yml ci: use larger runner for macos stable clippy (#34745) 2024-01-11 23:51:57 +08:00
.travis.yml chore: remove Explorer build scripts from the Monorepo (#30262) 2023-02-10 17:25:32 -06:00
CHANGELOG.md v1.18: cli: Add `--use-rpc` flag to program deploy and write-buffer (backport of #928) (#992) 2024-04-26 15:17:30 +08:00
CONTRIBUTING.md [docs] updated readme and fix links (#34565) 2024-01-03 09:06:06 -05:00
Cargo.lock collect all mango rpc optimizations in single commit 2024-08-09 11:36:33 +02:00
Cargo.toml Bump rbpf version to 0.8.3 (backport of #2515) (#2513) 2024-08-08 19:03:02 -05:00
LICENSE Correct LICENSE to conform with https://apache.org/licenses/LICENSE-2.0 (#31860) 2023-05-31 03:06:42 +00:00
README.md [docs] updated readme and fix links (#34565) 2024-01-03 09:06:06 -05:00
RELEASE.md CI: add check for explicit spl-token-cli version (#34430) 2023-12-14 10:18:34 -07:00
SECURITY.md Update SECURITY.md (#34800) 2024-01-16 21:07:44 -07:00
cargo
cargo-build-bpf replace ./cargo with cargo in sbf/bpf build scripts (#29371) 2022-12-22 20:17:11 +01:00
cargo-build-sbf replace ./cargo with cargo in sbf/bpf build scripts (#29371) 2022-12-22 20:17:11 +01:00
cargo-test-bpf replace ./cargo with cargo in sbf/bpf build scripts (#29371) 2022-12-22 20:17:11 +01:00
cargo-test-sbf replace ./cargo with cargo in sbf/bpf build scripts (#29371) 2022-12-22 20:17:11 +01:00
fetch-perf-libs.sh
fetch-spl.sh spl: Bump token-2022 and friends (#33453) 2023-09-29 19:12:06 +02:00
nextest.toml ci: move solana-cargo-build-sbf to nextest (#33257) 2023-09-15 14:24:43 +00:00
run.sh [docs] updated readme and fix links (#34565) 2024-01-03 09:06:06 -05:00
rust-toolchain.toml Upgrades Rust to 1.75.0 (#34607) 2023-12-30 05:15:49 +00:00
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

On Fedora:

$ sudo dnf install openssl-devel systemd-devel pkg-config zlib-devel llvm clang cmake make protobuf-devel protobuf-compiler perl-core

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 Labs, Inc. (“SL”) 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 SL or developer resources that SL provides are for educational and inspirational purposes only. SL 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. Accordingly, there is a risk to individuals that other persons using any of the code contained in this repo, or a derivation thereof, may be sanctioned persons and that transactions with such persons would be a violation of U.S. export controls and sanctions law.