6个版本

新版本 0.3.0 2024年8月26日
0.2.0 2023年7月26日
0.1.3 2023年2月23日
0.1.2 2022年10月21日
0.1.0 2022年9月13日

9#spl

Download history 1580/week @ 2024-05-06 2021/week @ 2024-05-13 1941/week @ 2024-05-20 1943/week @ 2024-05-27 1592/week @ 2024-06-03 1984/week @ 2024-06-10 1367/week @ 2024-06-17 972/week @ 2024-06-24 674/week @ 2024-07-01 666/week @ 2024-07-08 758/week @ 2024-07-15 914/week @ 2024-07-22 1039/week @ 2024-07-29 972/week @ 2024-08-05 943/week @ 2024-08-12 629/week @ 2024-08-19

3,615 每月下载次数
用于 20 个crate(直接使用4个)

Apache-2.0

33KB
636

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-like代币程序 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 代币、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-token-lending 代币贷款程序的绑定 npm
@solana/spl-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_<程序-name>.so

    更新您的Rust和Cargo到最新版本,然后在相关<程序名>目录中运行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 nightly工具链进行rustup

$ cargo install grcov --version 0.6.1
$ rustup toolchain install nightly-x86_64-apple-darwin

发布流程

SPL程序目前是手动标记和发布的。每个程序都是独立于其他程序进行版本控制的,所有新开发都在master上进行。一旦程序经过测试并认为准备发布

增加版本号

  • 在程序的Cargo.toml中增加版本号
  • 运行cargo build-sbf <程序>来构建二进制文件。注意生成的spl_<程序>.so的位置,以便将其附加到GitHub发布中。
  • 创建一个PR来提交这些版本更改,并在CI通过后合并。

创建GitHub标签

程序标签的形式为<程序>-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_<程序>.so二进制文件
  • 点击“发布版本”

发布到Crates.io

导航到程序目录,并运行cargo package以测试构建。然后运行cargo publish

免责声明

本项目中所描述的所有声明、内容、设计、算法、估计、路线图、规范和性能测量均由Solana Labs,Inc.(“SL”)尽最大努力完成。读者有责任检查和验证其准确性和真实性。此外,本项目中没有任何内容构成投资邀请。

由SL或SL提供的开发资源产生的任何内容,仅用于教育和启发目的。SL不鼓励、诱导或批准在违反适用法律或法规的情况下部署、集成或使用任何此类应用(包括包含在Solana区块链协议中的代码),并在此禁止任何此类部署、集成或使用。这包括读者(a)违反美国或任何其他适用司法管辖区的出口管制或制裁法律,(b)读者位于或通常居住在美国外国资产管理办公室(OFAC)实施的全面制裁的国家或地区,或(c)读者是或代表特别指定国民(SDN)或受类似封锁或禁止方限制的人。

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


lib.rs:

并发Merkle树

本包是Solana优化的并发Merkle树数据结构实现,该结构在这篇白皮书中介绍。

CMT的核心实现可以在[concurrent_merkle_tree]中找到。

依赖关系

~11–20MB
~267K SLoC