11e207cc85
The stake pool expects pool tokens to be delegated to the withdraw authority before performing a withdrawal. If a user delegates too many tokens to the withdraw authority, anyone else can take the rest of their tokens by doing their own withdrawal. Delegate pool tokens to an ephemeral keypair and sign with that. |
||
|---|---|---|
| .github | ||
| .travis | ||
| associated-token-account/program | ||
| binary-oracle-pair | ||
| ci | ||
| docs | ||
| examples | ||
| feature-proposal | ||
| libraries/math | ||
| memo | ||
| record/program | ||
| shared-memory | ||
| stake-pool | ||
| themis | ||
| token | ||
| token-lending | ||
| token-swap | ||
| utils | ||
| .gitignore | ||
| .mergify.yml | ||
| .travis.yml | ||
| Cargo.lock | ||
| Cargo.toml | ||
| LICENSE | ||
| README.md | ||
| cbindgen.sh | ||
| coverage.sh | ||
| patch.crates-io.sh | ||
| update-solana-dependencies.sh | ||
README.md
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
- Install the latest Rust stable from https://rustup.rs/
- Install Solana v1.6.1 or later from https://docs.solana.com/cli/install-solana-cli-tools
- Install the
libudevdevelopment package for your distribution (libudev-devon Debian-derived distros,libudev-develon Redhat-derived).
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.mdand<program>/src/lib.rs - Run
cargo build-bpf <program>to update relevant C bindings. (Note the location of the generatedspl_<program>.sofor 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>.sobinary - Click "Publish release"
Publish to Crates.io
Navigate to the program directory and run cargo package
to test the build. Then run cargo publish.