Go to file
Trent Nelson f4f14c42bb
docs: update spl token exchange integration (#19573)
* docs: update spl token exchange integration

* Apply suggestions from code review

Co-authored-by: Michael Vines <mvines@gmail.com>

Co-authored-by: Michael Vines <mvines@gmail.com>
2021-09-02 11:32:08 -06:00
.buildkite Clear release cache for stable-perf (#17287) 2021-05-17 17:28:52 -06:00
.github
.travis
account-decoder chore: bump serde_json from 1.0.66 to 1.0.67 (#19501) 2021-08-31 06:05:25 +00:00
accounts-bench hash calculation adds really old slots to dirty_stores (#19434) 2021-08-26 14:32:43 -05:00
accounts-cluster-bench Deprecate FeeCalculator returning APIs (#19120) 2021-08-13 09:08:20 -07:00
banking-bench Bank::new -> Bank::new_for_benches (#19063) 2021-08-04 17:30:43 -05:00
banks-client Dedupe SendTransactionService(s) (#19354) 2021-08-23 22:32:15 +00:00
banks-interface chore: bump serde from 1.0.129 to 1.0.130 (#19497) 2021-08-30 18:19:34 +00:00
banks-server Add parameter to allow setting max-retries for SendTransaction rpc (#19387) 2021-08-24 22:44:13 -06:00
bench-streamer chore: cargo +nightly clippy --fix -Z unstable-options 2021-06-18 10:42:46 -07:00
bench-tps chore: bump serde_json from 1.0.66 to 1.0.67 (#19501) 2021-08-31 06:05:25 +00:00
book/src/proposals Proposal to handle duplicate blocks (#16127) 2021-07-08 04:36:11 +00:00
ci Remove tar-rs audit ignore (#19344) 2021-08-20 14:34:48 -06:00
clap-utils chore: bump thiserror from 1.0.26 to 1.0.28 (#19494) 2021-08-30 09:35:37 -06:00
cli chore: bump serde_json from 1.0.66 to 1.0.67 (#19501) 2021-08-31 06:05:25 +00:00
cli-config chore: bump serde from 1.0.129 to 1.0.130 (#19497) 2021-08-30 18:19:34 +00:00
cli-output chore: bump serde_json from 1.0.66 to 1.0.67 (#19501) 2021-08-31 06:05:25 +00:00
client chore: bump serde_json from 1.0.66 to 1.0.67 (#19501) 2021-08-31 06:05:25 +00:00
core Accountsdb replication installment 2 (#19325) 2021-09-01 14:10:16 -07:00
crate-features Bump jsonrpc crates and remove old tokio (#18779) 2021-07-26 12:32:17 -06:00
docs docs: update spl token exchange integration (#19573) 2021-09-02 11:32:08 -06:00
dos adds validator flag to allow private ip addresses (#18850) 2021-07-23 15:25:03 +00:00
download-utils change untar to use unpack instead of unpack_in (#19216) 2021-08-18 15:49:02 -05:00
entry chore: bump serde from 1.0.129 to 1.0.130 (#19497) 2021-08-30 18:19:34 +00:00
explorer chore:(deps): bump @solana/spl-token-registry in /explorer (#19574) 2021-09-02 08:09:11 +00:00
faucet chore: bump serde from 1.0.129 to 1.0.130 (#19497) 2021-08-30 18:19:34 +00:00
frozen-abi chore: bump sha2 from 0.9.5 to 0.9.6 (#19511) 2021-08-30 19:58:26 -06:00
genesis chore: bump serde_json from 1.0.66 to 1.0.67 (#19501) 2021-08-31 06:05:25 +00:00
genesis-utils chore: cargo +nightly clippy --fix -Z unstable-options 2021-06-18 10:42:46 -07:00
gossip adds logs when push-vote panics with invalid vote-index (#19485) 2021-08-31 12:15:07 +00:00
install chore: bump serde_json from 1.0.66 to 1.0.67 (#19501) 2021-08-31 06:05:25 +00:00
keygen chore: cargo +nightly clippy --fix -Z unstable-options 2021-06-18 10:42:46 -07:00
ledger Simplify process_blockstore tests (#19553) 2021-09-01 20:13:52 +00:00
ledger-tool Revert "Add LastFullSnapshotSlot to SnapshotConfig (#19341)" (#19529) 2021-08-31 22:03:19 -05:00
local-cluster Accountsdb replication installment 2 (#19325) 2021-09-01 14:10:16 -07:00
log-analyzer chore: bump serde_json from 1.0.66 to 1.0.67 (#19501) 2021-08-31 06:05:25 +00:00
logger chore: bump env_logger from 0.8.4 to 0.9.0 (#18690) 2021-07-15 17:49:59 +00:00
measure Add incremental snapshot utils (#18504) 2021-07-22 14:40:37 -05:00
merkle-root-bench chore: bump log from 0.4.11 to 0.4.14 (#18323) 2021-06-30 18:32:01 +00:00
merkle-tree chore: bump matches from 0.1.8 to 0.1.9 (#19220) 2021-08-13 16:37:45 +00:00
metrics chore: bump env_logger from 0.8.4 to 0.9.0 (#18690) 2021-07-15 17:49:59 +00:00
multinode-demo Preserve pre-existing vote/stake keypairs for bootstrap validator (#19405) 2021-08-24 22:29:55 +00:00
net Preserve pre-existing vote/stake keypairs for bootstrap validator (#19405) 2021-08-24 22:29:55 +00:00
net-shaper chore: bump serde_json from 1.0.66 to 1.0.67 (#19501) 2021-08-31 06:05:25 +00:00
net-utils chore: bump serde from 1.0.129 to 1.0.130 (#19497) 2021-08-30 18:19:34 +00:00
notifier chore: bump reqwest from 0.11.2 to 0.11.4 (#18362) 2021-07-01 09:59:30 -06:00
perf chore: bump serde from 1.0.129 to 1.0.130 (#19497) 2021-08-30 18:19:34 +00:00
poh Store versioned transactions in the ledger, disabled by default (#19139) 2021-08-17 15:17:56 -07:00
poh-bench Move entry/poh to own crate to speed up poh bench build (#18225) 2021-07-14 14:16:29 +02:00
program-runtime Add solana-program-runtime crate (#19438) 2021-08-27 00:30:36 +00:00
program-test chore: bump serde from 1.0.129 to 1.0.130 (#19497) 2021-08-30 18:19:34 +00:00
programs Add executor using the program's id during deploy (#19555) 2021-09-01 17:59:24 -07:00
rayon-threadlimit Bump version to v1.8.0 (#17541) 2021-05-27 08:51:53 -07:00
rbpf-cli chore: bump serde_json from 1.0.66 to 1.0.67 (#19501) 2021-08-31 06:05:25 +00:00
remote-wallet chore: bump parking_lot from 0.10.2 to 0.11.0 (#18421) 2021-07-05 15:11:35 +00:00
replica-lib Accountsdb replication installment 2 (#19325) 2021-09-01 14:10:16 -07:00
replica-node Accountsdb replication installment 2 (#19325) 2021-09-01 14:10:16 -07:00
rpc Accountsdb replication installment 2 (#19325) 2021-09-01 14:10:16 -07:00
runtime tests which assert or panic in other threads now will report an error (#19532) 2021-09-02 11:26:57 -05:00
scripts chore: bump serde from 1.0.129 to 1.0.130 (#19497) 2021-08-30 18:19:34 +00:00
sdk Feature cleanup (#19528) 2021-08-31 14:51:26 -07:00
send-transaction-service Add parameter to allow setting max-retries for SendTransaction rpc (#19387) 2021-08-24 22:44:13 -06:00
stake-accounts Deprecate FeeCalculator returning APIs (#19120) 2021-08-13 09:08:20 -07:00
storage-bigtable chore: bump futures from 0.3.16 to 0.3.17 (#19513) 2021-08-30 22:12:38 -06:00
storage-proto chore: bump serde from 1.0.129 to 1.0.130 (#19497) 2021-08-30 18:19:34 +00:00
streamer chore: bump libc from 0.2.100 to 0.2.101 (#19442) 2021-08-26 12:38:34 -06:00
sys-tuner chore: bump libc from 0.2.100 to 0.2.101 (#19442) 2021-08-26 12:38:34 -06:00
system-test removes redundant allow-private-addr from system tests 2021-08-13 14:20:27 +00:00
tokens Deprecate FeeCalculator returning APIs (#19120) 2021-08-13 09:08:20 -07:00
transaction-status chore: bump serde_json from 1.0.66 to 1.0.67 (#19501) 2021-08-31 06:05:25 +00:00
upload-perf chore: bump serde_json from 1.0.66 to 1.0.67 (#19501) 2021-08-31 06:05:25 +00:00
validator Accountsdb replication installment 2 (#19325) 2021-09-01 14:10:16 -07:00
version chore: bump serde from 1.0.129 to 1.0.130 (#19497) 2021-08-30 18:19:34 +00:00
watchtower Deprecate FeeCalculator returning APIs (#19120) 2021-08-13 09:08:20 -07:00
web3.js chore: bump typedoc from 0.21.6 to 0.21.9 in /web3.js (#19566) 2021-09-01 23:10:10 +00:00
.clippy.toml
.codecov.yml
.gitignore Generate a script to rerun the failed sub-command in cargo-test-bpf (#18582) 2021-07-15 01:02:42 +00:00
.mergify.yml Automatically request review for community PR's (#18737) 2021-07-16 22:07:44 -05:00
.travis.yml Use rustup default profile (#18727) 2021-07-16 19:42:51 +00:00
CONTRIBUTING.md
Cargo.lock add debugging to test (#19563) 2021-09-02 02:52:16 +00:00
Cargo.toml Accountsdb replication installment 2 (#19325) 2021-09-01 14:10:16 -07:00
LICENSE
README.md Update README.md 2021-08-27 09:39:12 -06:00
RELEASE.md
SECURITY.md Clarify bug bounty payment policy (#16488) 2021-04-12 14:53:15 -06:00
cargo Speed up net.sh builds (#16360) 2021-04-07 14:45:03 +08:00
cargo-build-bpf
cargo-test-bpf
fetch-perf-libs.sh
fetch-spl.sh feature: add new token program feature (#18780) 2021-07-21 14:34:25 +02:00
run.sh Skip leader slots until a vote lands (#15607) 2021-03-25 18:54:51 -07:00
test-abi.sh

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

Please make sure you are always using the latest stable rust version by running:

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

On Mac M1s, make sure you set up your terminal & homebrew to use Rosetta. You can install it with:

$ softwareupdate --install-rosetta

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