19 个稳定版本 (3 个主要版本)

4.0.0 2024 年 1 月 22 日
3.1.1 2023 年 6 月 1 日
3.1.0 2022 年 12 月 21 日
2.2.4 2022 年 3 月 24 日
1.0.6 2021 年 7 月 29 日

#1319 in 魔法豆

Download history 89/week @ 2024-04-20 162/week @ 2024-04-27 23/week @ 2024-05-04 59/week @ 2024-05-11 78/week @ 2024-05-18 49/week @ 2024-05-25 82/week @ 2024-06-01 131/week @ 2024-06-08 396/week @ 2024-06-15 182/week @ 2024-06-22 293/week @ 2024-06-29 366/week @ 2024-07-06 226/week @ 2024-07-13 272/week @ 2024-07-20 333/week @ 2024-07-27 128/week @ 2024-08-03

每月 1,059 次下载
9 包中使用 9 个(直接使用 7 个)

Apache-2.0

1MB
18K SLoC

包含 (ELF 库,67KB) solana_bpf_rust_upgradeable.so,(ELF 库,67KB) solana_bpf_rust_upgraded.so

Solana 程序库

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

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

部署

在 Solana 程序库仓库中,只有一部分程序被部署到 Solana 主网测试版。目前包括:

程序 版本
token 3.4.0
associated-token-account 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 主网测试版:

程序 版本
single-pool 1.0.1

审计

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

程序 上次审计日期 版本
token 2022-08-04 (同行评审) 4fadd55
associated-token-account 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
single-pool 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-governance governance 程序的绑定 npm N/A
@solana/spl-account-compression account-compression 程序的绑定 npm Docs
@solana/spl-memo 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 绑定进行集成测试。有关示例,请参阅 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:

Solana 区块链的治理程序。

依赖项

~16–25MB
~420K SLoC