1个不稳定版本

0.0.1 2022年9月21日

#65#spl

Apache-2.0

2KB

Solana程序库

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

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

部署

仅在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-账户-压缩 用于账户压缩程序的绑定 npm Docs
@solana/spl-备注 用于备忘录程序的绑定 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名单上的个人进行交易。因此,存在风险,即使用本存储库中包含的任何代码或其衍生代码的其他人员可能是受制裁的人员,与这样的人进行交易将违反美国的出口管制和制裁法律。

无运行时依赖