16个稳定版本 (3个主要版本)

4.0.0 2024年6月25日
3.0.4 2024年7月11日
3.0.2 2024年3月28日
2.3.1 2024年2月9日
1.0.1 2020年11月5日

3#spl 中排名

Download history 36100/week @ 2024-04-28 36559/week @ 2024-05-05 38924/week @ 2024-05-12 33919/week @ 2024-05-19 35180/week @ 2024-05-26 37920/week @ 2024-06-02 37933/week @ 2024-06-09 37523/week @ 2024-06-16 41333/week @ 2024-06-23 34355/week @ 2024-06-30 35843/week @ 2024-07-07 35776/week @ 2024-07-14 41895/week @ 2024-07-21 42491/week @ 2024-07-28 61462/week @ 2024-08-04 43185/week @ 2024-08-11

191,614 每月下载量
595 个crate中使用(直接使用198个)

Apache-2.0

1.5MB
30K SLoC

Solana程序库

Solana程序库(SPL)是一组针对 Sealevel并行运行时 的链上程序。这些程序针对Solana的Sealevel实现(solana-runtime)进行了测试,其中一些已部署到主网Beta。随着其他人实现Sealevel,我们将乐意接受补丁,以确保这里的程序可以在所有实现中移植。

更多信息请参阅SPL文档令牌类型文档

部署

仅在Solana程序库仓库中的部分程序已部署到Solana主网Beta。目前包括

程序 版本
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

此外,还有一个程序计划部署到Solana主网Beta

程序 版本
single-pool 1.0.1

审计

仅在Solana程序库仓库中的部分程序进行了审计。目前包括

程序 上次审计日期 版本
token 2022-08-04(同行评审) 4fadd55
associated-token-account 2022-08-04(同行评审) 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

所有其他程序可能会随时更新。这些程序未经审计,因此自行fork和部署它们存在风险。以下是未经审计程序的全列表

关于仓库安全策略的更多信息,请参阅SECURITY.md

安全审计仓库security-audits repo包含所有过去和现在的程序审计。

程序包

描述 版本 文档
spl-token Solana上的类似于ERC20的代币程序 Crates.io Docs.rs
spl-token-2022 spl-token兼容的代币程序,具有扩展功能 Crates.io Docs.rs
spl-associated-token-account 定义钱包的规范“关联”代币账户的无状态协议 Crates.io Docs.rs
spl-governance 使用代币进行投票的DAO程序 Crates.io Docs.rs
spl-account-compression 管理存储在链下Merkle树中的压缩账户的程序 Crates.io Docs.rs
spl-feature-proposal 使用代币投票启用Solana网络功能的程序 Crates.io Docs.rs
spl-noop 不执行任何操作的程序,用于记录指令数据 Crates.io Docs.rs
spl-memo 在链上记录签名备忘录的程序 Crates.io Docs.rs
spl-name-service 管理链上数据所有权的程序 Crates.io Docs.rs
spl-shared-memory 在程序之间共享数据的程序 Crates.io Docs.rs
spl-stake-pool 由其他实体管理的抵押账户池化程序 Crates.io Docs.rs
spl-instruction-padding 填充到其他指令的程序 Crates.io Docs.rs
spl-concurrent-merkle-tree 用于链上表示Merkle树的库 Crates.io Docs.rs
spl-math 链上数学库 Crates.io Docs.rs
spl-token-lending 代币的过度抵押借贷程序 Crates.io Docs.rs
spl-token-swap 代币交易的AMM Crates.io Docs.rs
spl-token-upgrade 用于兑换一种代币类型以换取另一种类型的协议 Crates.io Docs.rs

CLI包

描述 版本
spl-token-cli 用于代币、token-2022和关联代币账户程序的CLI Crates.io
spl-stake-pool-cli 用于抵押账户池化程序的CLI Crates.io
spl-feature-proposal-cli 用于功能提案程序的CLI Crates.io
spl-token-lending-cli 用于代币借贷程序的CLI Crates.io
spl-token-upgrade-cli 用于代币升级程序的CLI Crates.io

JavaScript包

描述 版本 文档
@solana/spl-token 用于代币、token-2022和关联代币账户程序的绑定 npm Docs
@solana/spl-governance 用于治理程序的绑定 npm N/A
@solana/spl-account-compression 用于账户压缩程序的绑定 npm Docs
@solana/spl-memo 用于备忘录程序的绑定 npm N/A
@solana/spl-name-service 用于名称服务程序的绑定 npm N/A
@solana/spl-stake-pool 用于抵押账户池化程序的绑定 npm N/A
@solana/spl-token-lending 用于代币借贷程序的绑定 npm N/A
@solana/spl-token-swap 用于代币交换程序的绑定 npm N/A

开发

环境设置

  1. 安装最新的Solana工具
  2. 安装最新的Rust稳定版。如果您已经安装了Rust,运行rustup update以获取最新版本。
  3. 安装适用于您发行版的libudev开发包(Debian衍生发行版为libudev-dev,Redhat衍生发行版为libudev-devel)。

构建

构建链上程序

# To build all on-chain programs
$ cargo build-sbf

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

构建客户端

# To build all clients
$ cargo build

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

测试

所有项目中的单元测试可以通过以下方式运行

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

要运行特定程序(如SPL Token)的测试

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

可以通过每个项目的.js绑定执行集成测试。有关示例,请参阅token程序js项目

常见问题

以下提到了一些可能遇到的问题的解决方案。

  1. 打开失败: ../../部署/spl_<程序-name>.so

    请更新您的Rust和Cargo到最新版本,并在相关<program-name>目录中重新运行cargo build-sbf,或在仓库根目录运行以重新构建所有链上程序。

  2. 加载共享库时出错。 (libssl.so.1.1)

    一个可行的解决方案已在这里提及。安装libssl。

    wget 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
    
  3. CPU或内存使用率为100%

    在构建此库中的一些程序时可能会出现这种情况。最简单的解决方案是在构建命令中添加--jobs 1标志,将并行作业的数量限制为1,并检查是否解决了问题。尽管这将意味着更长的构建时间。

Clippy

$ cargo clippy

覆盖率

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

MacOS

您可能需要固定grcov版本,然后使用apple-darwin夜间工具链运行rustup

$ cargo install grcov --version 0.6.1
$ rustup toolchain install nightly-x86_64-apple-darwin

发布流程

目前,SPL程序是手动标记和发布的。每个程序都是独立于其他程序进行版本管理的,所有新开发都在master上。一旦程序经过测试并被认为准备发布

增加版本

  • 在程序的Cargo.toml中增加版本号
  • 运行cargo build-sbf <program>以构建二进制文件。注意生成的spl_<program>.so的位置,以便将其附加到GitHub发布中。
  • 创建一个包含这些版本更改的PR,并在通过CI后进行合并。

创建GitHub标签

程序标签的格式为<program>-vX.Y.Z。在版本升级提交中创建新标签,并将其推送到solana-program-library仓库,例如

$ git tag token-v1.0.0 b24bfe7
$ git push upstream --tags

发布GitHub发布

  • 转到GitHub发布UI
  • 点击“草稿新发布”,并在“标签版本”框中输入新标签。
  • 将发布标题为“SPL vX.Y.Z”,完成描述,并附加spl_<program>.so二进制文件
  • 点击“发布发布”

发布到Crates.io

导航到程序目录,并运行cargo package以测试构建。然后运行cargo publish

免责声明

本项目中描述的所有主张、内容、设计、算法、估计、路线图、规范和性能测量均由Solana Labs, Inc.(“SL”)尽最大努力完成。读者应自行检查和验证其准确性和真实性。此外,本项目中没有任何内容构成投资邀请。

由SL或开发者资源产生的任何内容仅用于教育和启发目的。SL不鼓励、诱导或批准任何此类应用(包括包含在索拉纳区块链协议中的代码)的部署、集成或使用,如果违反了适用的法律或法规,并在此禁止此类部署、集成或使用。这包括读者使用此类应用(a)违反美国或任何其他适用司法管辖区的出口控制或制裁法律;(b)如果读者位于或通常居住在美国财政部外国资产管理办公室(OFAC)管理的全面制裁的国家或地区;(c)如果读者是或代表特别指定国民(SDN)或受类似封锁或拒绝方禁令约束的人。

读者应知道,美国的出口控制法和制裁法禁止美国公民(以及其他受此类法律约束的人)与某些国家和地区的个人或SDN名单上的人进行交易。因此,使用本存储库中包含的任何代码或其衍生的个人存在风险,其他人可能被制裁,与这些人进行的交易可能违反美国的出口控制和制裁法。


lib.rs:

将令牌账户与用户钱包关联的约定

依赖项

~16–25MB
~347K SLoC