2 个不稳定版本

0.1.0 2022 年 11 月 28 日
0.0.1 2022 年 9 月 16 日

#33 in #spl

25 每月下载量
用于 spl-token-upgrade-cli

Apache-2.0

1.5MB
29K SLoC

Solana 程序库

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

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

部署

仅在 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 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 和关联令牌账户程序的 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 和关联令牌账户程序的绑定 npm Docs
@solana/spl-治理 治理程序的绑定 npm N/A
@solana/spl-account-compression account-compression 程序的绑定 npm Docs
@solana/spl-备注 memo 程序的绑定 npm N/A
@solana/spl-name-service name-service 程序的绑定 npm N/A
@solana/spl-stake-pool stake-pool 程序的绑定 npm N/A
@solana/spl-token-lending token-lending 程序的绑定 npm N/A
@solana/spl-token-swap 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更新到最新版本,并在相关<程序名称>目录下重新运行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:

从一个程序升级代币到另一个程序的约定

依赖项

~22–31MB
~494K SLoC