# Solana Program Library

These programs are tested against Solana's implementation of Sealevel, solana-runtime, and some are deployed to Mainnet Beta. As others implement Sealevel, we will graciously accept patches to ensure the programs here are portable across all implementations.

For more information, see the SPL documentation and the Token TypeDocs.

### Deployments

Only a subset of programs within the Solana Program Library repo are deployed to the Solana Mainnet Beta. Currently, this includes:

| Program                  | Version |
| ------------------------ | ------- |
| token                    | 3.4.0   |
| associated-token-account | 1.1.0   |
| token-2022               | 1.0.0   |
| governance               | 3.1.0   |
| stake-pool               | 1.0.0   |
| account-compression      | 0.1.3   |
| shared-memory            | 1.0.0   |
| feature-proposal         | 1.0.0   |
| name-service             | 0.3.0   |
| memo                     | 3.0.0   |

In addition, one program is planned for deployment to Solana Mainnet Beta:

| Program     | Version |
| ----------- | ------- |
| single-pool | 1.0.1   |

### Audits

Only a subset of programs within the Solana Program Library repo are audited. Currently, this includes:

| Program                  | Last Audit Date          | Version |
| ------------------------ | ------------------------ | ------- |
| token                    | 2022-08-04 (Peer review) | 4fadd55 |
| associated-token-account | 2022-08-04 (Peer review) | c00194d |
| token-2022               | 2023-11-03               | e924132 |
| stake-pool               | 2023-12-31               | a17fffe |
| account-compression      | 2022-12-05               | 6e81794 |
| shared-memory            | 2021-02-25               | b40e0dd |
| single-pool              | 2024-01-02               | ef44df9 |

All other programs may be updated from time to time. These programs are not audited, so fork and deploy them at your own risk. Here is the full list of unaudited programs:

* binary-option
* binary-oracle-pair
* feature-proposal
* instruction-padding
* managed-token
* memo
* name-service
* record
* stateless-asks
* token-lending
* token-swap
* token-upgrade

More information about the repository's security policy is available at SECURITY.md.

The security-audits repo contains all past and present program audits.

### Program Packages

| Package                      | Description                                                                     | Version   | Docs    |
| ---------------------------- | ------------------------------------------------------------------------------- | --------- | ------- |
| spl-token                    | ERC20-like token program on Solana                                              | Crates.io | Docs.rs |
| spl-token-2022               | Token program compatible with spl-token, with extensions                        | Crates.io | Docs.rs |
| spl-associated-token-account | Stateless protocol defining a canonical "associated" token account for a wallet | Crates.io | Docs.rs |
| spl-governance               | DAO program using tokens for voting                                             | Crates.io | Docs.rs |
| spl-account-compression      | Program for managing compressed accounts stored in an off-chain merkle tree     | Crates.io | Docs.rs |
| spl-feature-proposal         | Program using tokens to vote on enabling Solana network features                | Crates.io | Docs.rs |
| spl-noop                     | Program that does nothing, used for logging instruction data                    | Crates.io | Docs.rs |
| spl-memo                     | Program for logging signed memos on-chain                                       | Crates.io | Docs.rs |
| spl-name-service             | Program for managing ownership of data on-chain                                 | Crates.io | Docs.rs |
| spl-shared-memory            | Program for sharing data between programs                                       | Crates.io | Docs.rs |
| spl-stake-pool               | Program for pooling stake accounts, managed by another entity                   | Crates.io | Docs.rs |
| spl-instruction-padding      | Program for padding to other instructions                                       | Crates.io | Docs.rs |
| spl-concurrent-merkle-tree   | Library for on-chain representation of merkle tree                              | Crates.io | Docs.rs |
| spl-math                     | Library for on-chain math                                                       | Crates.io | Docs.rs |
| spl-token-lending            | Over-collateralized lending program for tokens                                  | Crates.io | Docs.rs |
| spl-token-swap               | AMM for trading tokens                                                          | Crates.io | Docs.rs |
| spl-token-upgrade            | Protocol for burning one token type in exchange for another                     | Crates.io | Docs.rs |

### CLI Packages

| Package                  | Description                                                          | Version   |
| ------------------------ | -------------------------------------------------------------------- | --------- |
| spl-token-cli            | CLI for the token, token-2022, and associated-token-account programs | Crates.io |
| spl-stake-pool-cli       | CLI for the stake-pool program                                       | Crates.io |
| spl-feature-proposal-cli | CLI for the feature-proposal program                                 | Crates.io |
| spl-token-lending-cli    | CLI for the token-lending program                                    | Crates.io |
| spl-token-upgrade-cli    | CLI for the token-upgrade program                                    | Crates.io |

### JavaScript Packages

| Package                         | Description                                                               | Version | Docs |
| ------------------------------- | ------------------------------------------------------------------------- | ------- | ---- |
| @solana/spl-token               | Bindings for the token, token-2022, and associated-token-account programs | npm     | Docs |
| @solana/spl-governance          | Bindings for the governance program                                       | npm     | N/A  |
| @solana/spl-account-compression | Bindings for the account-compression program                              | npm     | Docs |
| @solana/spl-memo                | Bindings for the memo program                                             | npm     | N/A  |
| @solana/spl-name-service        | Bindings for the name-service program                                     | npm     | N/A  |
| @solana/spl-stake-pool          | Bindings for the stake-pool program                                       | npm     | N/A  |
| @solana/spl-token-lending       | Bindings for the token-lending program                                    | npm     | N/A  |
| @solana/spl-token-swap          | Bindings for the token-swap program                                       | npm     | N/A  |

### Development

#### Environment Setup

* Install the latest Solana tools.
* Install the latest Rust stable. If you already have Rust, run `rustup update` to get the latest version.
* Install the libudev development package for your distribution (libudev-dev on Debian-derived distros, libudev-devel on Redhat-derived).

#### Build

**Build On-Chain Programs**

```bash
bashCopy code# To build all on-chain programs
$ cargo build-sbf

# To build a specific on-chain program
$ cd <program_name>/program
$ cargo build-sbf
```

**Build Clients**

```bash
bashCopy code# To build all clients
$ cargo build

# To build a specific client
$ cd <program_name>/cli
$ cargo build
```

#### Test

Unit tests contained within all projects can be run with:

```bash
bashCopy code$ cargo test      # <-- runs host-based tests
$ cargo test-sbf  # <-- runs BPF program tests
```

To run a specific program's tests, such as SPL Token:

```bash
bashCopy code$ cd token/program
$ cargo test      # <-- runs host-based tests
$ cargo test-sbf  # <-- runs BPF program tests
```

Integration testing may be performed via the per-project `.js` bindings. See the token program's js project for an example.

#### Common Issues

**Failed to open: ../../deploy/spl\_\<program-name>.so**

Update your Rust and Cargo to the latest versions and re-run `cargo build-sbf` in the relevant `<program-name>` directory, or run it at the repository root to rebuild all on-chain programs.

**Error while loading shared libraries. (libssl.so.1.1)**

A working solution was mentioned here. Install libssl.

```bash
bashCopy codewget http://nz2.archive.ubuntu.com/ubuntu/pool/main/o/openssl/libssl1.1_1.1.1l-1ubuntu1.2_amd64.deb
sudo dpkg -i libssl1.1_1.1.1l-1ubuntu1.2_amd64.deb
```

**CPU or Memory usage at 100%**

This is to be expected while building some of the programs in this library. The simplest solution is to add the `--jobs 1` flag to the build commands to limit the number of parallel jobs to 1 and check if that fixes the issue. Although this will mean much longer build times.

#### Clippy

```bash
bashCopy code$ cargo clippy
```

#### Coverage

```bash
bashCopy code$ ./coverage.sh  # Help wanted! Coverage build currently fails on MacOS due to an XCode `grcov` mismatch...
```

#### MacOS

You may need to pin your grcov version, and then rustup with the apple-darwin nightly toolchain:

```bash
bashCopy code$ cargo install grcov --version 0.6.1
$ rustup toolchain install nightly-x86_64-apple-darwin
```

#### Release Process

SPL programs are currently tagged and released manually. Each program is versioned independently of the others, with all new development occurring on master. Once a program is tested and deemed ready for release:

**Bump Version**

Increment the version number in the program's `Cargo.toml`. Run `cargo build-sbf <program>` to build the binary. Note the location of the generated `spl_<program>.so` for attaching to the GitHub release. Open a PR with these version changes and merge after passing CI.

**Create GitHub Tag**

Program tags are of the form `<program>-vX.Y.Z`. Create the new tag at the version-bump commit and push to the `solana-program-library` repository, e.g.:

```bash
bashCopy code$ git tag token-v1.0.0 b24bfe7
$ git push upstream --tags
```

**Publish GitHub Release**

* Go to GitHub Releases UI.
* Click "Draft new release," and enter the new tag in the "Tag version" box.
* Title the release "SPL vX.Y.Z," complete the description, and attach the `spl_<program>.so` binary.
* Click "Publish release."

**Publish to Crates.io**

Navigate to the program directory and run `cargo package` to test the build. Then run `cargo publish`.

#### Disclaimer

All claims, content, designs, algorithms, estimates, roadmaps, specifications, and performance measurements described in this project are done with the Solana Labs, Inc. (“SL”) best 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 inspiration 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 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.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://8bit-1.gitbook.io/solibrary/solana-program-library.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.