87d88bd078
* rename staking instructions * modify DepositStake te to include manager fees and referrer, continue _stake refactor, referral fees WIP * initialize with fees, fee application, checks * inline functions * temporarily substitute u8 for bool until borsh gets it's * straight * set deposit fee * apply deposit and referral fee to liquid deposit_sol too * add set-deposit-fee, unify cli interface * set-referral-fee * full feature set for liquid deposits (?) * add tests/set_referral_fee.rs * fix missing serialization in process_set_referral_fee * remove duplicated test case in tests/set_withdrawal_fee.rs * tests WIP, numbers dont add up after non-zero deposit fee * fix error, fix tests * deposit_sol tests. Requires additional changes to work properly * simplify deposit_sol tests, add referral fee tests for deposit and deposit_sol * add `sol_deposit_authority`. * split deposit_sol() & deposit_sol_with_authority(), cli sol_deposit --from, minor cleanup * cli deposit-sol from argument should take keypair instead * commands: set-sol-deposit-authority, show * cli: pretty print stake pool struct * chore: comments/naming * fmt, clippy * add args for `create-pool` * mistake in the cli * `system_prog` is `read_only`, require sig from `stake_deposit_auth` * change deposit-sol-authority arg to optional acount, rename instruction::withdraw->withdraw_stake, remove unnecesary sys_prog arg for withdraw_stake * resolve simple nits and suggestions * cli: change default referrer to user's token receiver account instead of pool manager * cli: remove show command, add fees to list command, rename pool -> epoch * update tests for removed unnecessary referral fee account owner check and deposit sol * cli changes: create ephemeral account for deposit_sol * specify pool token type for account info name * add check for manager fee acc in deposit_sol * Apply suggestions from code review Co-authored-by: Jon Cinque <jon.cinque@gmail.com> * fix non-rebased bug * SetDepositStakeAuthority * refactor + tests + cli * fmt * clippy * remove unnecessary comment * ASK keyword * unset deposit auth * combine set fee instructions * clippy * applying suggestions * apply out-of-date check only for FeeTypes that need it * add fee + user = new tokens check * Fix test * Unify `SetDepositAuthority` instruction * fmt Co-authored-by: dhy1996 <dhy1996@live.com.sg> Co-authored-by: Jesse Y. Cho <f8122dac91@gmail.com> Co-authored-by: Jon Cinque <jon.cinque@gmail.com> |
||
|---|---|---|
| .github | ||
| .travis | ||
| associated-token-account/program | ||
| binary-option | ||
| binary-oracle-pair | ||
| ci | ||
| docs | ||
| examples | ||
| feature-proposal | ||
| governance | ||
| libraries/math | ||
| memo | ||
| name-service | ||
| 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.
Disclaimer
All claims, content, designs, algorithms, estimates, roadmaps, specifications, and performance measurements described in this project are done with the Solana Foundation's ("SF") 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 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.