1 个不稳定版本

0.1.0 2022年9月13日

#24#spl

每月30次下载
用于 2 crates

Apache-2.0

9KB
178

Solana 程序库

Solana 程序库(SPL)是针对 Sealevel 并行运行时 的程序集合。这些程序针对 Solana 的 Sealevel 实现、solana-runtime 进行了测试,其中一些已部署到主网测试版。随着其他程序实现 Sealevel,我们将乐于接受补丁,以确保这里的程序可以在所有实现中通用。

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

部署

Solana 程序库仓库中只有一部分程序部署到了 Solana 主网测试版。目前,这包括

程序 版本
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 主网测试版

程序 版本
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-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-governance 治理程序的绑定 npm N/A
@solana/spl-account-compression 账户压缩程序的绑定 npm Docs
@solana/spl-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令牌)的测试

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

可以通过每个项目的.js绑定进行集成测试。有关示例,请参阅令牌程序的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版本界面
  • 点击“创建新版本”,并在“标签版本”框中输入新标签。
  • 将版本命名为“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 列表中。因此,存在其他人员使用此存储库中包含的任何代码或其衍生代码可能被制裁的风险,与这些人进行交易将违反美国出口管制和制裁法律。

依赖项

~16–25MB
~417K SLoC