1个不稳定版本

0.0.1 2023年5月18日

#28 in #stake

Apache-2.0

2KB

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 主网测试版

程序 版本
single-pool 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
single-pool 2024-01-02 ef44df9

其他所有程序可能会不时更新。这些程序未进行审计,因此请自行承担风险进行分叉和部署。以下是未审计程序的全列表

有关仓库安全策略的更多信息,请参阅 SECURITY.md

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

程序包

描述 版本 文档
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 管理存储在链下默克尔树中的压缩账户的程序 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 用于链上表示默克尔树的库 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、token-2022 和 associated-token-account 程序的 CLI Crates.io
spl-stake-pool-cli 用于 stake-pool 程序的 CLI Crates.io
spl-feature-proposal-cli 用于 feature-proposal 程序的 CLI Crates.io
spl-token-lending-cli 用于 token-lending 程序的 CLI Crates.io
spl-token-upgrade-cli 用于 token-upgrade 程序的 CLI Crates.io

JavaScript 包

描述 版本 文档
@solana/spl-token 用于 token、token-2022 和 associated-token-account 程序的绑定 npm Docs
@solana/spl-治理 用于治理程序的绑定 npm 不适用
@solana/spl-账户-压缩 用于 account-compression 程序的绑定 npm Docs
@solana/spl-备忘录 用于 memo 程序的绑定 npm 不适用
@solana/spl-名称-服务 用于 name-service 程序的绑定 npm 不适用
@solana/spl-质押- 用于 stake-pool 程序的绑定 npm 不适用
@solana/spl-token-借贷 用于 token-lending 程序的绑定 npm 不适用
@solana/spl-token-交换 用于 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 绑定进行集成测试。有关示例,请参阅 token 程序的 js 项目

常见问题

这里提到了解决您可能遇到的一些问题的方法。

  1. 打开失败: ../../部署/spl_<程序-名称>.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 不鼓励、诱导或批准任何此类应用(包括包含 Solana 区块链协议的代码)的部署、集成或使用,如果违反了适用的法律或法规,并禁止此类部署、集成或使用。这包括读者使用此类应用的情况:(a)违反美国或任何其他适用司法管辖区的出口控制或制裁法律;(b)如果读者位于或通常居住在美国外国资产控制办公室(OFAC)管理下的全面制裁的国家或地区;(c)如果读者是或代表特别指定国民(SDN)或受类似封锁或拒绝方禁止的个人。

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

无运行时依赖