1个不稳定版本

0.1.0 2023年10月25日

#36#spl

Apache-2.0

1MB
24K SLoC

Solana程序库

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

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

部署

Solana程序库仓库中只有一部分程序部署到了Solana主网Beta。目前包括以下程序

程序 版本
token 3.4.0
associated-token-account 1.1.0
token-2022 1.0.0
governance 3.1.0
stake-pool 1.0.0
account-compression 0.1.3
shared-memory 1.0.0
feature-proposal 1.0.0
name-service 0.3.0
memo 3.0.0

此外,还有一个程序计划部署到Solana主网Beta

程序 版本
single-pool 1.0.1

审计

Solana程序库仓库中只有一部分程序进行了审计。目前包括

程序 上次审计日期 版本
token 2022-08-04(同行评审) 4fadd55
associated-token-account 2022-08-04(同行评审) c00194d
token-2022 2023-11-03 e924132
stake-pool 2023-12-31 a17fffe
account-compression 2022-12-05 6e81794
shared-memory 2021-02-25 b40e0dd
single-pool 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-governance 治理程序的绑定 npm N/A
@solana/spl-account-compression 账户压缩程序的绑定 npm Docs
@solana/spl-memo 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 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版本发布界面
  • 点击“草稿新版本”,并在“标签版本”框中输入新标签。
  • 将版本标题为“SPL vX.Y.Z”,完成描述,并附加spl_<program>.so二进制文件
  • 点击“发布版本”

发布到Crates.io

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

免责声明

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

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

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


lib.rs:

定义了实现 SPL Token Group 接口的 Token Collection 程序的库。

依赖项

~22–30MB
~491K SLoC