1 个不稳定版本

0.0.1 2022年12月1日

#12#sealevel

Apache-2.0

2KB

Solana 程序库

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

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

部署

仅在 Solana 程序库仓库中的程序子集中部署到 Solana 主网 Beta。目前包括

程序 版本
令牌 3.4.0
相关令牌账户 1.1.0
令牌-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 程序库仓库中的程序子集进行了审计。目前包括

程序 上次审计日期 版本
令牌 2022-08-04(同行评审) 4fadd55
相关令牌账户 2022-08-04(同行评审) c00194d
令牌-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

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-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-令牌-lending 用于代币借贷程序的绑定 npm N/A
@solana/spl-令牌-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. 无法打开: ../../deploy/spl_<program-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 <程序> 来构建二进制文件。注意生成的 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 不鼓励、诱导或批准在违反适用的法律或法规的情况下部署、集成或使用此类应用程序(包括包含 Solana 区块链协议的代码),并在此禁止此类部署、集成或使用。这包括读者(a)违反美国或任何其他适用管辖区的出口控制或制裁法律,(b)读者位于或通常居住在美国海外资产控制办公室(OFAC)管理的全面制裁的国家或地区,或(c)读者是或代表特别指定国民(SDN)或受到类似阻止或拒绝方禁令约束的人。

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

无运行时依赖