gaspersic/solana
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Expand Rust API docs entry point (#20770) (#20801)

Browse Source 
(cherry picked from commit cc4bb5a451)

Co-authored-by: Brian Anderson <andersrb@gmail.com>
This commit is contained in:
mergify[bot]
2021-10-20 01:53:55 +00:00
committed by GitHub
parent c7e3d4cf79
commit 0759b666ce
1 changed files with 27 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
docs/src/developing/clients/rust-api.md
View File

@ -2,7 +2,30 @@
title: Rust API
---
See [doc.rs](https://docs.rs/releases/search?query=solana-) for documentation of
all crates published by Solana. In particular [solana-sdk](https://docs.rs/solana-sdk)
for working with common data structures and [solana-client](https://docs.rs/solana-client)
for querying the [JSON RPC API](jsonrpc-api).
Solana's Rust crates are [published to crates.io][crates.io] and can be found
[on docs.rs with the "solana-" prefix][docs.rs].
[crates.io]: https://crates.io/search?q=solana-
[docs.rs]: https://docs.rs/releases/search?query=solana-
Some important crates:
- [`solana-program`] &mdash; Imported by programs running on Solana, compiled
to BPF. This crate contains many fundamental data types and is re-exported from
[`solana-sdk`], which cannot be imported from a Solana program.
- [`solana-sdk`] &mdash; The basic off-chain SDK, it re-exports
[`solana-program`] and adds more APIs on top of that. Most Solana programs
that do not run on-chain will import this.
- [`solana-client`] &mdash; For interacting with a Solana node via the
[JSON RPC API](jsonrpc-api).
- [`solana-clap-utils`] &mdash; Routines for setting up a CLI, using [`clap`],
as used by the main Solana CLI.
[`solana-program`]: https://docs.rs/solana-program
[`solana-sdk`]: https://docs.rs/solana-sdk
[`solana-client`]: https://docs.rs/solana-client
[`solana-clap-utils`]: https://docs.rs/solana-clap-utils
[`clap`]: https://docs.rs/clap