Skip to content

abbaskiko/solana-program-library

This branch is 10 commits ahead of, 5260 commits behind solana-labs/solana-program-library:master.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

c2d420f · May 23, 2024
Nov 7, 2020
Nov 1, 2020
Nov 7, 2020
Nov 7, 2020
May 23, 2024
Nov 7, 2020
May 23, 2024
Nov 7, 2020
Nov 7, 2020
Nov 7, 2020
Feb 15, 2021
May 23, 2024
Nov 7, 2020
Nov 7, 2020
Nov 2, 2020
Nov 4, 2020
May 23, 2024
Nov 7, 2020
Jun 17, 2020
Nov 7, 2020
Aug 28, 2020
Oct 25, 2020
Jun 17, 2020
Nov 3, 2020
Nov 3, 2020

Repository files navigation

Build status

Solana Program Library

The Solana Program Library (SPL) is a collection of on-chain programs targeting the Sealevel parallel runtime. These programs are tested against Solana's implementation of Sealevel, solana-runtime, and deployed to its mainnet. As others implement Sealevel, we will graciously accept patches to ensure the programs here are portable across all implementations.

Full documentation is available at https://spl.solana.com

Development

Environment Setup

  1. Install the latest Rust stable from https://rustup.rs/
  2. Install Solana v1.4.5 or later from from https://docs.solana.com/cli/install-solana-cli-tools

Build

The normal cargo build is available for building programs against your host machine:

$ cargo build

To build a specific program, such as SPL Token, for the Solana BPF target:

$ cd token/program
$ cargo build-bpf

Test

Unit tests contained within all projects can be run with:

$ cargo test      # <-- runs host-based tests
$ cargo test-bpf  # <-- runs BPF program tests

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

$ cd token/program
$ cargo test      # <-- runs host-based tests
$ cargo test-bpf  # <-- 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.

Clippy

$ cargo clippy

Coverage

$ ./coverage.sh  # Please help! Coverage build currently fails on MacOS due to an XCode `grcov` mismatch...

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
  • Generate a new program ID and replace in <program>/program-id.md and <program>/src/lib.rs
  • Run cargo build <program> to update relevant C bindings. (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, eg:

$ 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. (Currently, programs with generated C bindings fail the final step of verification due to the location of the generated file. Once you are certain the crate is ready, run cargo publish --no-verify to bypass this error.)

About

A collection of Solana-maintained on-chain programs

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Rust 82.4%
  • JavaScript 11.8%
  • C++ 3.5%
  • Shell 1.3%
  • Other 1.0%