13 个版本 (重大更新)

0.11.0 2024年6月25日
0.10.0 2024年4月25日
0.9.2 2024年3月28日
0.8.0 2023年12月12日
0.0.1 2022年1月13日

#1#spl-token

Download history 837/week @ 2024-05-06 797/week @ 2024-05-13 886/week @ 2024-05-20 793/week @ 2024-05-27 706/week @ 2024-06-03 674/week @ 2024-06-10 639/week @ 2024-06-17 1077/week @ 2024-06-24 616/week @ 2024-07-01 983/week @ 2024-07-08 561/week @ 2024-07-15 551/week @ 2024-07-22 776/week @ 2024-07-29 640/week @ 2024-08-05 609/week @ 2024-08-12 601/week @ 2024-08-19

2,674 每月下载量
用于 9 个crate

Apache-2.0

1.5MB
36K SLoC

索拉纳程序库

索拉纳程序库 (SPL) 是一系列针对 Sealevel 并行运行时 的链上程序集合。这些程序针对 Solana 的 Sealevel 实现、solana-runtime 进行了测试,其中一些已部署到主网 Beta。随着其他人对 Sealevel 的实现,我们将欢迎修复以确保这些程序可在所有实现中移植。

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

部署

仅将 Solana 程序库仓库中的部分程序部署到索拉纳主网 Beta。目前,包括以下程序

程序 版本
token 3.4.0
关联的token账户 1.1.0
token-2022 1.0.0
治理 3.1.0
股份池 1.0.0
账户压缩 0.1.3
共享内存 1.0.0
功能提案 1.0.0
名称服务 0.3.0
备忘录 3.0.0

此外,还计划部署一个程序到索拉纳主网 Beta

程序 版本
单池 1.0.1

审计

仅在 Solana 程序库仓库中的部分程序经过审计。目前包括

程序 上次审计日期 版本
token 2022-08-04 (同行评审) 4fadd55
关联的token账户 2022-08-04 (同行评审) c00194d
token-2022 2023-11-03 e924132
股份池 2023-12-31 a17fffe
账户压缩 2022-12-05 6e81794
共享内存 2021-02-25 b40e0dd
单池 2024-01-02 ef44df9

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

有关仓库安全策略的更多信息请参阅 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、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-治理 治理程序的绑定 npm N/A
@solana/spl-account-compression account-compression 程序的绑定 npm Docs
@solana/spl-备忘录 memo 程序的绑定 npm N/A
@solana/spl-name-service name-service 程序的绑定 npm N/A
@solana/spl-stake-pool stake-pool 程序的绑定 npm N/A
@solana/spl-token-lending token-lending 程序的绑定 npm N/A
@solana/spl-token-swap 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 绑定来执行。请参考令牌程序的 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 nightly 工具链的 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
  • 点击 "Draft new release",并在 "Tag version" 框中输入新标签。
  • 将发布标题为 "SPL vX.Y.Z",完成描述,并附加 spl_<program>.so 二进制文件
  • 点击 "Publish release"

发布到 Crates.io

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

免责声明

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

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

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

依赖关系

~90MB
~1.5M SLoC