6 个版本

0.2.9 2024年1月22日
0.2.5 2022年3月24日
0.2.4 2022年2月7日
0.1.0 2021年9月9日

#2597 in 魔力豆

每月 25 次下载

Apache-2.0

1MB
18K SLoC

Solana 程序库

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

更多信息请参阅 SPL 文档Token TypeDocs

部署

仅将 Solana 程序库仓库中的一部分程序部署到 Solana Mainnet Beta。目前包括

程序 版本
token 3.4.0
相关代币账户 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 Mainnet Beta

程序 版本
单一池 1.0.1

审计

在 Solana 程序库仓库中,只有一部分程序经过了审计。目前包括:

程序 最后审计日期 版本
token 2022-08-04(同行评审) 4fadd55
相关代币账户 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
单一池 2024-01-02 ef44df9

所有其他程序可能会不时更新。这些程序未经过审计,因此请自行承担分叉和部署它们的风险。以下是未审计程序的全列表:

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

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

程序包

描述 版本 文档
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,token-2022 和 associated-token-account 程序的 CLI Crates.io
spl-stake-pool-cli stake-pool 程序的 CLI Crates.io
spl-feature-proposal-cli feature-proposal 程序的 CLI Crates.io
spl-token-lending-cli token-lending 程序的 CLI Crates.io
spl-token-upgrade-cli token-upgrade 程序的 CLI Crates.io

JavaScript 包

描述 版本 文档
@solana/spl-token token,token-2022 和 associated-token-account 程序的绑定 npm Docs
@solana/spl-governance 治理程序的绑定 npm 不适用
@solana/spl-account-compression account-compression 程序的绑定 npm Docs
@solana/spl-memo memo 程序的绑定 npm 不适用
@solana/spl-name-service name-service 程序的绑定 npm 不适用
@solana/spl-stake-pool stake-pool 程序的绑定 npm 不适用
@solana/spl-token-lending token-lending 程序的绑定 npm 不适用
@solana/spl-token-swap token-swap 程序的绑定 npm 不适用

开发

环境设置

  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 令牌)的测试,请

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

集成测试可以通过项目的 .js 绑定来执行。请参考代币程序的 js 项目以获取示例。

常见问题

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

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

    请更新 Rust 和 Cargo 到最新版本,并在相关的<程序名称>目录中重新运行 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 <程序> 以构建二进制文件。请注意生成的 spl_<程序>.so 文件的位置,以便将其附加到 GitHub 发布中。
  • 创建一个包含这些版本更改的 PR 并在 CI 通过后合并。

创建 GitHub 标签

程序标签的形式为 <程序>-vX.Y.Z。在版本增加提交处创建新标签并推送到 solana-program-library 仓库,例如

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

发布 GitHub 发布

  • 转到GitHub 发布界面
  • 点击 "创建新发布",并在 "标签版本" 框中输入新标签。
  • 将发布标题为 "SPL vX.Y.Z",完成描述,并附加 spl_<程序>.so 二进制文件
  • 点击 "发布发布"

发布到 Crates.io

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

免责声明

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

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

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


lib.rs:

治理聊天程序

依赖项

~16–25MB
~417K SLoC