#pool #solana #programs #token #stake #spl #collection

app spl-single-pool-cli

Solana程序库单验证器抵押池命令行工具

2 个版本 (1 个稳定版)

1.0.0 2023年10月20日
0.0.1 2023年8月21日

#14 in #stake

Apache-2.0

785KB
16K SLoC

Solana程序库

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

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

部署

仅在Solana程序库仓库中的程序子集部署到Solana Mainnet 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 Mainnet 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 绑定进行。请参阅代币程序的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版本发布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名单上的人进行交易。因此,存在风险,即使用此存储库中包含的任何代码或其派生代码的个人可能受到制裁,与这些个人进行的交易将违反美国出口控制和制裁法。

依赖关系

~90MB
~1.5M SLoC