Go to file
steviez 9076348ef4
Make CostTracker aware of inflight transactions (#437)
When a leader is packing a Bank, transactions costs are added to the
CostTracker and then later updated or removed, depending on if the
tx is committed. However, it is possible for a Bank to be frozen while
there are several tx's in flight.

CostUpdateService submits a metric with cost information almost
immediately after a Bank has been frozen. The result is that we have
observed cost details being submitted before some cost removals take
place, which causes a massive over-reporting of the block cost
compared to actual.

This PR adds a field to track the number of transactions that are
inflight, and adds a simple mechanism to try to allow that value to
settle to zero before submitting the datapoint. The number of inflight
tx's is submitted with the datapoint, so even if the value does not
settle to zero, we can still detect this case and know the metric is
tainted.

Co-authored-by: Andrew Fitzgerald <apfitzge@gmail.com>
2024-03-29 07:34:12 -05:00
.buildkite ci: merge docker images (#35078) 2024-02-07 15:17:33 +08:00
.github ci: add release pipeline (#466) 2024-03-29 11:41:53 +08:00
account-decoder Simd 118: extend EpochRewards sysvar (#428) 2024-03-27 19:24:06 -06:00
accounts-bench SVM: Move `RentCollector` to sdk (#35122) 2024-02-07 16:38:42 -08:00
accounts-cluster-bench accounts-cluster-bench: Break early when a max-accounts limit is reached (#34922) 2024-01-25 19:46:43 +00:00
accounts-db store only removes from read cache if slot is possibly present (#452) 2024-03-28 17:00:48 -05:00
banking-bench Support --block-production-method in banking-bench (#269) 2024-03-22 09:12:21 -07: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 Rename `SanitizedMessage::try_from` to `try_from_legacy_message` (#35338) 2024-02-29 08:25:22 +08:00
bench-streamer Give streamer::receiver() threads unique names (#35369) 2024-03-01 13:36:08 -06:00
bench-tps Add analysis for bench-tps transactions (#92) 2024-03-26 11:47:24 +01: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 [anza migration]: add 'agave=info' to default log level (#223) 2024-03-14 20:35:33 +08:00
cd
ci Update crate check to new crates.io error string (#484) 2024-03-29 00:42:09 -06:00
clap-utils clap-utils: Add more compute unit helpers (#440) 2024-03-28 01:58:20 +01:00
clap-v3-utils clap-utils: Add more compute unit helpers (#440) 2024-03-28 01:58:20 +01:00
cli Add `--with-compute-unit-price` to cli program deploy commands (#364) 2024-03-22 16:48:52 +00:00
cli-config [docs] updated readme and fix links (#34565) 2024-01-03 09:06:06 -05:00
cli-output Cli: improve vote-account vote-authority display (#95) 2024-03-06 07:23:32 +00:00
client client: Timeout resends during `send_and_confirm_in_parallel` (#358) 2024-03-22 12:10:00 +01:00
client-test Use BankForks on tests - Part 3 (#34248) 2023-12-01 13:47:22 -03:00
connection-cache don't sign X.509 certs (#34896) 2024-01-28 16:17:46 -08:00
core Make CostTracker aware of inflight transactions (#437) 2024-03-29 07:34:12 -05:00
cost-model Make CostTracker aware of inflight transactions (#437) 2024-03-29 07:34:12 -05:00
docs Rename AppendVecId to AccountsFileId (#383) 2024-03-22 11:25:30 -07:00
dos switch to `solana-tpu-client` from `solana_client::tpu_client` for `bench-tps`, `dos/`, `LocalCluster`, `gossip/` (#310) 2024-03-21 09:25:54 -07:00
download-utils Use BankForks on tests - Part 3 (#34248) 2023-12-01 13:47:22 -03:00
entry Share the threadpool for tx execution and entry verifification (#216) 2024-03-27 16:33:21 -05:00
faucet [anza migration]: add 'agave=info' to default log level (#223) 2024-03-14 20:35:33 +08:00
frozen-abi frozen-abi-macro: use `log` from `solana_frozen_abi` (#153) 2024-03-23 07:38:57 -05:00
genesis genesis: Skip inserting genesis accounts for Development clusters (#35266) 2024-02-22 14:42:35 -06:00
genesis-utils Move accounts-db code to its own crate (#32766) 2023-08-09 13:03:36 -07:00
geyser-plugin-interface [anza migration] rename crates (#10) 2024-03-03 12:31:24 +08:00
geyser-plugin-manager CI: Add windows clippy job and fix clippy errors (#330) 2024-03-20 13:21:00 +01:00
gossip implements weighted shuffle using N-ary tree (#259) 2024-03-26 05:21:54 +00:00
install CI: Add windows clippy job and fix clippy errors (#330) 2024-03-20 13:21:00 +01:00
keygen [keygen] Remove deprecated functions from `keygen` cli (minus `grind` command) (#438) 2024-03-28 13:31:43 +09:00
ledger Do not purge all bank snapshots after fastboot (#345) 2024-03-28 15:10:50 -04:00
ledger-tool ledger-tool: name rayon threads (#464) 2024-03-29 06:13:01 +11:00
local-cluster Checks if bank snapshot is loadable before fastbooting (#343) 2024-03-28 11:14:23 -04:00
log-analyzer Upgrades Rust to 1.72.0 & nightly-2023-08-25 (#32961) 2023-09-01 07:26:13 +00:00
logger [anza migration]: add 'agave=info' to default log level (#223) 2024-03-14 20:35:33 +08:00
measure Upgrades Rust to 1.72.0 & nightly-2023-08-25 (#32961) 2023-09-01 07:26:13 +00:00
memory-management Moves a clippy attribute (#194) 2024-03-12 07:46:23 -04: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 Remove ability to submit metrics with no fields (#35133) 2024-02-16 11:10:15 -08:00
multinode-demo Net script fix for expected shred version (#280) 2024-03-18 13:54:07 -07:00
net Net script fix for expected shred version (#280) 2024-03-18 13:54:07 -07:00
net-shaper Upgrades Rust to 1.72.0 & nightly-2023-08-25 (#32961) 2023-09-01 07:26:13 +00:00
net-utils Name previously unnamed thread pool threads (#104) 2024-03-06 17:03:02 -06:00
notifier [anza migration] rename crates (#10) 2024-03-03 12:31:24 +08:00
perf frozen-abi: Remove proc_macro_hygiene featurization (#109) 2024-03-06 15:32:05 +01:00
poh Share the threadpool for tx execution and entry verifification (#216) 2024-03-27 16:33:21 -05:00
poh-bench Share the threadpool for tx execution and entry verifification (#216) 2024-03-27 16:33:21 -05:00
program-runtime Fix: deploy program on last slot of epoch during environment change (#101) 2024-03-22 07:43:28 -07:00
program-test clippy: Automated fixes for Rust 1.77.0 (#390) 2024-03-22 13:48:46 -04:00
programs Bump blake3 from v1.5.0 to v1.5.1 (#488) 2024-03-29 15:30:42 +09:00
pubsub-client [anza migration] rename crates (#10) 2024-03-03 12:31:24 +08:00
quic-client Rename and uniquify QUIC thread names (#28) 2024-03-05 12:09:17 -06:00
rayon-threadlimit
rbpf-cli [anza migration] rename crates (#10) 2024-03-03 12:31:24 +08:00
remote-wallet [clap-v3-utils] Deprecate signer source validation (#33802) 2024-01-06 08:19:54 +09:00
rpc clippy: Automated fixes for Rust 1.77.0 (#390) 2024-03-22 13:48:46 -04:00
rpc-client [docs] updated readme and fix links (#34565) 2024-01-03 09:06:06 -05:00
rpc-client-api Rpc: add support for minimum context slot to `getBlocks(WithLimit)` endpoints (#191) 2024-03-11 23:59:18 -06:00
rpc-client-nonce-utils clippy: Automated fixes for Rust 1.77.0 (#390) 2024-03-22 13:48:46 -04:00
rpc-test clippy: Replaces .get(0) with .first() (#34048) 2023-11-13 17:22:17 -05:00
runtime Removes support for loading snapshots with > 1 append vec per slot (#474) 2024-03-28 16:32:17 -04:00
runtime-transaction add requested limits to static meta (#34361) 2023-12-15 18:39:19 -06:00
scripts [anza migration]: add 'agave=info' to default log level (#223) 2024-03-14 20:35:33 +08:00
sdk Simd 118: extend EpochRewards sysvar (#428) 2024-03-27 19:24:06 -06:00
send-transaction-service rpc-sts: add config options for stake-weighted qos (#197) 2024-03-20 11:13:50 -06: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 Make the quic server connection table use an async lock, reducing thrashing (#293) 2024-03-18 12:05:00 -07:00
svm Use loader v3 instead of v2 in the SVM (#454) 2024-03-27 15:47:34 -03:00
system-test [anza migration] rename crates (#10) 2024-03-03 12:31:24 +08:00
test-validator [SVM] Move RuntimeConfig to program-runtime (#96) 2024-03-07 10:16:16 -08:00
thin-client Deprecate `ThinClient` and remove `ThinClient` from `bench-tps` (#35365) 2024-03-01 12:14:52 -08:00
tokens SDK: refactor `Signer` and `Signers` traits (#34984) 2024-03-01 12:34:32 +01:00
tpu-client Async connection creation in connection cache (#33302) 2023-09-25 18:17:47 -07:00
transaction-dos Add `--with-compute-unit-price` to cli program deploy commands (#364) 2024-03-22 16:48:52 +00:00
transaction-status Add `Message::is_maybe_writable` (#35340) 2024-02-29 10:27:33 +08:00
turbine adds api to obtain the parent node in the turbine retransmit tree (#115) 2024-03-07 17:56:40 +00:00
udp-client Quic update identity (#33865) 2023-12-08 14:53:19 +08:00
unified-scheduler-logic Introduce primitive threading in unified scheduler (#34676) 2024-01-24 12:46:16 +09:00
unified-scheduler-pool Remove public visibility of program cache from bank (#279) 2024-03-17 15:29:20 -07:00
upload-perf
validator Fixes help text formatting (#385) 2024-03-22 12:56:54 -04:00
version [anza migration] Sets client id to Agave (#163) 2024-03-12 07:46:41 -04:00
vote gossip: notify state machine of duplicate proofs (#32963) 2024-01-26 07:58:37 -08:00
watchtower [anza migration]: add 'agave=info' to default log level (#223) 2024-03-14 20:35:33 +08:00
web3.js Add link to new web3.js repo (#30096) 2023-02-27 10:23:54 -06:00
wen-restart wen-restart: Find heaviest fork (#183) 2024-03-20 19:38:46 -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] Remove `std::thread` from wasm target (#379) 2024-03-26 19:54:06 +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 [anza migration] ci: fix path (#8) 2024-03-03 12:31:24 +08:00
CHANGELOG.md Health check slot distance (#335) 2024-03-22 00:11:36 -05:00
CONTRIBUTING.md [docs] updated readme and fix links (#34565) 2024-01-03 09:06:06 -05:00
Cargo.lock Bump blake3 from v1.5.0 to v1.5.1 (#488) 2024-03-29 15:30:42 +09:00
Cargo.toml Bump blake3 from v1.5.0 to v1.5.1 (#488) 2024-03-29 15:30:42 +09: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 [anza migration] ci (#5) 2024-03-03 12:31:24 +08:00
RELEASE.md Update RELEASE.md to reflect current release process (#444) 2024-03-28 13:13:27 -05:00
SECURITY.md Update SECURITY.md (#35048) 2024-02-05 11:13:04 -07:00
cargo
cargo-build-bpf
cargo-build-sbf
cargo-test-bpf
cargo-test-sbf
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.76.0 (#35148) 2024-02-09 03:19:56 +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!