1 个不稳定版本

0.1.0 2023 年 9 月 1 日

#26#borsh


2 个 crate 中使用(通过 spl-type-length-value

Apache-2.0

6KB
91

Solana 程序库

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

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

部署

仅在 Solana 程序库仓库中的程序子集中部署到 Solana Mainnet 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 Mainnet 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 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 管理存储在链下 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、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、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 代币

$ cd token/program
$ cargo test      # <-- runs host-based tests
$ cargo test-sbf  # <-- runs BPF program tests

集成测试可以通过每个项目的 .js 绑定来执行。请参阅令牌程序的 js 项目以获取示例。

常见问题

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

  1. 无法打开: ../../部署/spl_<程序-name>.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 夜间工具链进行 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提供的开发者资源产生的任何内容,仅用于教育和启发目的。SL不鼓励、诱导或批准任何此类应用程序(包括包含Solana区块链协议的代码)违反适用的法律或法规,并在此禁止任何此类部署、集成或使用。这包括读者(a)违反美国或任何其他适用司法管辖区的出口管制或制裁法律,(b)读者位于或通常居住在受美国外国资产控制办公室(OFAC)全面制裁的国家或地区,或(c)读者是或代表特别指定国民(SDN)或受类似封锁或禁止方禁令约束的人。

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


lib.rs:

定义了一个为基本borsh实现VariableLenPack特质的derive宏的crate。

依赖关系

~295–750KB
~18K SLoC