2个版本

0.1.1 2021年10月25日
0.1.0 2021年10月25日

#9#lending

每月 21次下载

Apache-2.0

590KB
13K SLoC

Solana 程序库

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

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

部署

在 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

安全审计仓库 包含所有过去和现在的程序审计。

程序包

描述 版本 文档
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-账户-压缩 用于账户压缩程序的绑定 npm Docs
@solana/spl-备注 用于备忘录程序的绑定 npm N/A
@solana/spl-名称-服务 用于名称服务程序的绑定 npm N/A
@solana/spl-抵押- 用于抵押账户池化程序的绑定 npm N/A
@solana/spl-token-贷款 用于代币贷款程序的绑定 npm N/A
@solana/spl-token-交换 用于代币交换程序的绑定 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_<程序-名称>.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版本发布UI
  • 点击“草稿新版本”,并在“标签版本”框中输入新标签。
  • 将发布标题设为“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名单的个人进行交易。因此,存在风险,即使用本仓库中包含的任何代码或其衍生代码的个人可能是受制裁的个人,与这些个人进行交易将违反美国的出口管制和制裁法律。

依赖项

~17-26MB
~436K SLoC