4 个版本

0.2.0 2024年3月28日
0.1.2 2024年2月5日
0.1.1 2023年9月28日
0.1.0 2023年6月26日

#20 in 神奇豆

Download history 39322/week @ 2024-04-10 33350/week @ 2024-04-17 31333/week @ 2024-04-24 25979/week @ 2024-05-01 28861/week @ 2024-05-08 27618/week @ 2024-05-15 22902/week @ 2024-05-22 29613/week @ 2024-05-29 29483/week @ 2024-06-05 32740/week @ 2024-06-12 29837/week @ 2024-06-19 30019/week @ 2024-06-26 26321/week @ 2024-07-03 27611/week @ 2024-07-10 30479/week @ 2024-07-17 29300/week @ 2024-07-24

119,940 每月下载量
用于 442 个crate(通过 spl-discriminator-derive

Apache-2.0

8KB
128

Solana 程序库

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

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

部署

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

程序 版本
token 3.4.0
关联的token账户 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主网测试版

程序 版本
单池 1.0.1

审计

仅在Solana程序库仓库中的部分程序经过了审计。目前包括

程序 上次审计日期 版本
token 2022-08-04(同行评审) 4fadd55
关联的token账户 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-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 不适用
@solana/spl-账户-压缩 账户压缩程序的绑定 npm Docs
@solana/spl-备注 备忘录程序的绑定 npm 不适用
@solana/spl-名称-服务 名称服务程序的绑定 npm 不适用
@solana/spl-抵押- 抵押池程序的绑定 npm 不适用
@solana/spl-token-借贷 代币借贷程序的绑定 npm 不适用
@solana/spl-token-交换 代币交换程序的绑定 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 令牌

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

可以通过每个项目的 .js 绑定进行集成测试。请参阅 令牌程序的 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 发布 UI
  • 点击 "Draft new release",并在 "Tag version" 框中输入新标签。
  • 将发布标题命名为 "SPL vX.Y.Z",完成描述,并附加 spl_<program>.so 二进制文件
  • 点击 "Publish release"

发布到 Crates.io

导航到程序目录,并运行 cargo package 以测试构建。然后运行 cargo publish

免责声明

本项目中描述的所有主张、内容、设计、算法、估计、路线图、规范和性能测量都是索拉纳实验室公司(以下简称“SL”)尽最大努力完成的。读者自行负责检查和验证其准确性和真实性。此外,本项目中没有任何内容构成投资邀请。

由SL或开发者资源产生的任何内容,仅用于教育和启发目的。SL不鼓励、诱导或批准在违反适用法律或法规的情况下部署、集成或使用任何此类应用(包括包含索拉纳区块链协议的代码)。禁止任何此类部署、集成或使用。这包括读者(a)违反美国或任何其他适用管辖区的出口控制或制裁法律,(b) 如果读者位于或通常居住在美国外国资产管理办公室(OFAC)管理的全面制裁的国家或地区,或(c) 如果读者是或代表特别指定国民(SDN)或受类似封锁或拒绝方禁止的人。

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


lib.rs:

spl-discriminator 库提供的令牌解析和生成库

依赖项

~0.7–1.2MB
~28K SLoC