1 个稳定版本

2.0.6 2022年5月4日

#31#spl

Apache-2.0

6KB
79

Solana程序库

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

更多信息请参阅 SPL文档Token类型文档

部署

仅在Solana程序库仓库中的一部分程序部署到Solana主网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主网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包含所有过去和现在的程序审计。

程序包

描述 版本 文档
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-治理 用于治理程序的绑定 npm N/A
@solana/spl-account-compression 用于账户压缩程序的绑定 npm Docs
@solana/spl-备忘录 用于memo程序的绑定 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 绑定来执行。请参阅令牌程序的 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 提供的开发者资源产生的任何内容,仅供教育和启发之用。SL 不鼓励、诱导或批准将任何此类应用程序(包括包含 Solana 区块链协议的代码)部署、集成或用于违反适用的法律或法规,并在此禁止任何此类部署、集成或使用。这包括读者(a)违反美国或任何其他适用管辖区出口控制或制裁法律的使用;(b)如果读者位于或通常居住在美国外国资产管理办公室(OFAC)管理的全面制裁的国家或地区;(c)如果读者是或代表特别指定国民(SDN)或受类似封锁或拒绝方禁令约束的人。

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


lib.rs:

适用于 Solana 区块链的共享内存程序。

依赖项

~7–15MB
~199K SLoC