0.1.0 2021年12月20日

#13 in #sealevel

Apache-2.0

9.5MB
4K SLoC

Solana 程序库

Solana 程序库(SPL)是一组针对 Sealevel 并行运行时 的链上程序。这些程序针对 Solana 的 Sealevel 实现、solana-runtime 进行测试,其中一些已部署到主网测试版。随着其他人实现 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

安全审计仓库 包含所有过去和现在的程序审计。

程序包

描述 版本 文档
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 代币、token-2022和关联代币账户程序的绑定 npm Docs
@solana/spl-governance 治理程序的绑定 npm N/A
@solana/spl-账户-压缩 账户压缩程序的绑定 npm Docs
@solana/spl-memo 备忘录程序的绑定 npm N/A
@solana/spl-名称-服务 名称服务程序的绑定 npm N/A
@solana/spl-抵押- 抵押账户池程序的绑定 npm N/A
@solana/spl-token-借贷 代币借贷程序的绑定 npm N/A
@solana/spl-token-交换 代币交换程序的绑定 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_<程序-名称>.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 发布界面
  • 点击 "创建新发布",并在 "标签版本" 框中输入新标签。
  • 将发布标题为 "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名单上的个人进行交易。因此,存在风险,即使用此存储库中包含的任何代码或其衍生代码的个人可能受到制裁,与这些个人进行交易将违反美国出口管制和制裁法律。

依赖项

~7–18MB
~241K SLoC