11 个版本 (2 个稳定版)

2.0.0 2024 年 6 月 27 日
1.0.0 2023 年 12 月 5 日
0.6.4 2022 年 2 月 16 日
0.6.3 2021 年 11 月 3 日
0.4.0 2021 年 7 月 9 日

#1353魔法豆

Download history 46/week @ 2024-04-24 104/week @ 2024-05-01 73/week @ 2024-05-08 105/week @ 2024-05-15 73/week @ 2024-05-22 85/week @ 2024-05-29 68/week @ 2024-06-05 213/week @ 2024-06-12 149/week @ 2024-06-19 462/week @ 2024-06-26 305/week @ 2024-07-03 179/week @ 2024-07-10 400/week @ 2024-07-17 553/week @ 2024-07-24 402/week @ 2024-07-31 268/week @ 2024-08-07

每月下载量 1,637
用于 2 crates

Apache-2.0

2MB
38K SLoC

包含 (ELF 库,695KB) tests/fixtures/mpl_token_metadata.so

Solana 程序库

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

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

部署

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

程序 版本
令牌 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 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-2022和关联令牌账户程序的绑定 npm Docs
@solana/spl-治理 治理程序的绑定 npm 不适用
@solana/spl-account-compression 账户压缩程序的绑定 npm Docs
@solana/spl-备注 备注程序的绑定 npm 不适用
@solana/spl-name-service 名称服务程序的绑定 npm 不适用
@solana/spl-stake-pool 抵押池程序的绑定 npm 不适用
@solana/spl-令牌-lending 代币贷款程序的绑定 npm 不适用
@solana/spl-令牌-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 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 不鼓励、诱导或允许任何违反适用法律或法规的应用程序(包括包含 Solana 区块链协议的代码)的部署、集成或使用。这包括读者(a)违反美国或任何其他适用管辖区的出口控制或制裁法律;(b)读者位于或通常居住在美国财政部外国资产控制办公室(OFAC)管理的全面制裁的国家或地区;(c)读者是特别指定国民(SDN)或受类似封锁或拒绝方禁止的个人。

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


lib.rs:

创建和管理质押池的程序

依赖项

~21–30MB
~489K SLoC