3 个稳定版本

3.0.0 2022 年 6 月 8 日
2.1.0 2021 年 4 月 5 日
2.0.0 2021 年 4 月 1 日

#669神奇豆子

Download history 285/week @ 2024-03-13 339/week @ 2024-03-20 308/week @ 2024-03-27 309/week @ 2024-04-03 338/week @ 2024-04-10 265/week @ 2024-04-17 242/week @ 2024-04-24 191/week @ 2024-05-01 398/week @ 2024-05-08 463/week @ 2024-05-15 327/week @ 2024-05-22 461/week @ 2024-05-29 383/week @ 2024-06-05 243/week @ 2024-06-12 290/week @ 2024-06-19 343/week @ 2024-06-26

1,330 每月下载量
用于 18 个crate(6 个直接使用)

Apache-2.0

1MB
19K SLoC

Solana 程序库

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

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

部署

仅在 Solana 程序库仓库中的程序子集部署到 Solana 主网测试版。目前包括

程序 版本
token 3.4.0
相关令牌账户 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

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

程序 版本
单池 1.0.1

审计

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

程序 上次审计日期 版本
token 2022-08-04(同行评审) 4fadd55
相关令牌账户 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和关联代币账户程序的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、token-2022和关联代币账户程序的绑定 npm Docs
@solana/spl-治理 治理程序的绑定 npm 不适用
@solana/spl-账户-压缩 账户压缩程序的绑定 npm Docs
@solana/spl-备注 备注程序的绑定 npm 不适用
@solana/spl-名称-服务 名称服务程序的绑定 npm 不适用
@solana/spl-抵押- 抵押池程序的绑定 npm 不适用
@solana/spl-token-借贷 代币借贷程序的绑定 npm 不适用
@solana/spl-token-交换 代币交换程序的绑定 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 Token)的测试:

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

可以通过每个项目的 .js 绑定进行集成测试。请参阅 token 程序的 js 项目 以获取示例。

常见问题

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

  1. 打开失败: ../../部署/spl_<程序-名称>.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 不鼓励、诱导或批准违反适用法律或法规的任何此类应用(包括构成 Solana 区块链协议的代码)的部署、集成或使用。这包括读者(a)违反美国或任何其他适用司法管辖区出口管制或制裁法,(b)如果读者位于或通常居住在美国商务部外国资产管理办公室(OFAC)管理的全面制裁的国家或地区,或(c)如果读者是或代表特别指定国民(SDN)或受类似阻止或拒绝方禁令约束的人。

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


lib.rs:

一个类似于 Uniswap 的 Solana 区块链程序。

依赖项

~17–26MB
~440K SLoC