5 个版本

0.1.4 2024年1月22日
0.1.3 2022年12月21日
0.1.2 2022年3月24日
0.1.1 2022年2月4日
0.1.0 2022年2月1日

#2603 in 神奇豆


用于 2 crates

Apache-2.0

365KB
9K SLoC

Solana 程序库

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

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

部署

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

程序 版本
令牌 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主网Beta

程序 版本
单池 1.0.1

审计

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

程序 上次审计日期 版本
令牌 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包含所有过去和现在的程序审计。

程序包

描述 版本 文档
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-2022和关联令牌账户程序的绑定 npm Docs
@solana/spl-治理 治理程序的绑定 npm 不适用
@solana/spl-账户-压缩 账户压缩程序的绑定 npm Docs
@solana/spl-备注 备注程序的绑定 npm 不适用
@solana/spl-名称-服务 命名服务程序的绑定 npm 不适用
@solana/spl-质押- 质押池程序的绑定 npm 不适用
@solana/spl-令牌-贷款 令牌贷款程序的绑定 npm 不适用
@solana/spl-令牌-交换 令牌交换程序的绑定 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_<程序-名称>.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:

治理投票权重插件程序

依赖项

~17-25MB
~435K SLoC