3个不稳定版本

0.3.1 2024年7月11日
0.3.0 2024年3月28日
0.2.0 2023年9月1日

#25 in #spl

Apache-2.0

1MB
24K SLoC

Solana程序库

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

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

部署

仅在Solana程序库仓库中的部分程序部署到Solana Mainnet 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 Mainnet Beta的程序

程序 版本
单一池 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 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 nightly工具链的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 Releases UI
  • 点击“新建草稿发布”,并在“标签版本”框中输入新标签。
  • 将发布标题命名为“SPL vX.Y.Z”,完成描述,并附加spl_<program>.so二进制文件
  • 点击“发布发布”

发布到Crates.io

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

免责声明

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

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

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


lib.rs:

定义存储SPL代币元数据的示例程序的包装

依赖项

~22–30MB
~495K SLoC