3个不稳定版本

0.3.1 2024年7月11日
0.3.0 2023年9月13日
0.2.0 2021年11月16日

#2#sealevel

Download history 76/week @ 2024-05-06 183/week @ 2024-05-13 65/week @ 2024-05-20 64/week @ 2024-05-27 122/week @ 2024-06-03 107/week @ 2024-06-10 95/week @ 2024-06-17 99/week @ 2024-06-24 208/week @ 2024-07-01 418/week @ 2024-07-08 421/week @ 2024-07-15 423/week @ 2024-07-22 359/week @ 2024-07-29 402/week @ 2024-08-05 380/week @ 2024-08-12 275/week @ 2024-08-19

1,421 每月下载量
125 直接) 包中使用

Apache-2.0

29KB
549 代码行

Solana程序库

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

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

部署

Solana程序库仓库中只有一部分程序部署到Solana Mainnet Beta。目前,这包括

程序 版本
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 Mainnet Beta的程序

程序 版本
单池 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 用于token-lending程序的CLI Crates.io
spl-token-upgrade-cli 用于token-upgrade程序的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-贷款 token-lending程序的绑定 npm
@solana/spl-token-交换 token-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 绑定进行。请参考代币程序的 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提供的开发资源产生的任何内容,仅用于教育和启发目的。SL不鼓励、诱导或批准任何此类应用(包括包含Solana区块链协议的代码)的部署、集成或使用,违反适用的法律或法规,并在此禁止此类部署、集成或使用。这包括读者(a)违反美国或任何其他适用司法管辖区的出口管制或制裁法律,(b)读者位于或通常居住在美国财政部外国资产控制办公室(OFAC)管理的全面制裁的国家或地区,或(c)读者是或代表特别指定国民(SDN)或受类似封锁或拒绝方禁令约束的人。

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

依赖项

~16–25MB
~425K SLoC