3 个版本 (1 个稳定版本)

1.0.0 2020 年 11 月 19 日
1.0.0-pre22020 年 11 月 16 日

#27 in #spl

每月 25 次下载
spl-feature-proposal-cli 中使用

Apache-2.0

365KB
9K SLoC

Solana 程序库

Solana 程序库 (SPL) 是一组针对 Sealevel 并行运行时 的链上程序。这些程序针对 Solana 的 Sealevel 实现、solana-runtime 进行了测试,其中一些已部署到 Mainnet Beta。随着其他人对 Sealevel 进行实现,我们将慷慨地接受补丁,以确保这里的程序可以在所有实现中通用。

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

部署

仅在 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 用于管理存储在链下默克尔树中的压缩账户的程序 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-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-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-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 Token

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

可以通过每个项目的 .js 绑定执行集成测试。有关示例,请参阅 token 程序的 js 项目

常见问题

以下列出了您可能会遇到的一些问题的解决方案。

  1. 打开失败: ../../部署/spl_<程序-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 <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
  • 点击 "草稿新发布",并在 "标签版本" 框中输入新标签。
  • 将发布标题为 "SPL vX.Y.Z",完成描述,并附加 spl_<program>.so 二进制文件
  • 点击 "发布发布"

发布到 Crates.io

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

免责声明

本项目中描述的所有主张、内容、设计、算法、估计、路线图、规范和性能度量均由 Solana Labs, Inc.(“SL”)尽最大努力完成。读者有责任检查和验证其准确性和真实性。此外,本项目中没有任何内容构成投资招揽。

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

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


lib.rs:

功能提案计划

依赖项

~17-26MB
~438K SLoC