3 个不稳定版本

0.1.1 2024年1月19日
0.1.0 2024年1月5日
0.0.1 2023年10月24日

#2983 in 神奇豆子

每月下载量 30 次

Apache-2.0

1MB
25K SLoC

索拉纳程序库

索拉纳程序库 (SPL) 是一系列针对 Sealevel 并行运行时 的链上程序。这些程序针对 Solana 的 Sealevel 实现、solana-runtime 进行测试,其中一些已部署到主网测试版。随着其他人对 Sealevel 进行实现,我们将乐于接受补丁以确保这些程序能够跨所有实现便携。

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

部署

仅将 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主网Bета的程序

程序 版本
单池 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

包含所有过去和当前程序审计的安全审计存储库

程序包

描述 版本 文档
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

命令行工具包

描述 版本
spl-token-cli 代币、token-2022和关联代币账户程序的命令行界面 Crates.io
spl-stake-pool-cli 抵押池程序的命令行界面 Crates.io
spl-feature-proposal-cli 功能提案程序的命令行界面 Crates.io
spl-token-lending-cli 代币贷款程序的命令行界面 Crates.io
spl-token-upgrade-cli 代币升级程序的命令行界面 Crates.io

JavaScript包

描述 版本 文档
@solana/spl-token 代币、token-2022和关联代币账户程序的绑定 npm Docs
@solana/spl-治理 治理程序的绑定 npm N/A
@solana/spl-account-compression 账户压缩程序的绑定 npm Docs
@solana/spl-备忘录 备忘录程序的绑定 npm N/A
@solana/spl-name-service 命名服务程序的绑定 npm N/A
@solana/spl-stake-pool 抵押池程序的绑定 npm N/A
@solana/spl-token-lending 代币贷款程序的绑定 npm N/A
@solana/spl-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 nightly工具链运行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不鼓励、诱导或批准违反适用法律或法规的任何此类应用的部署、集成或使用。这包括读者(a)违反美国或任何其他适用管辖区的出口管制或制裁法律,(b)读者位于或通常居住在美国财政部外国资产控制办公室(OFAC)管理的全面制裁的国家或地区,或(c)读者是或代表特别指定国民(SDN)或受类似封锁或拒绝方禁止的人。

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

依赖项

~75MB
~1.5M SLoC