1个不稳定版本

0.0.1 2023年8月21日

#31 in #stake

Apache-2.0

2KB

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 Token

$ 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夜间工具链运行rustup

$ cargo install grcov --version 0.6.1
$ rustup toolchain install nightly-x86_64-apple-darwin

发布流程

SPL程序目前是手动标记和发布的。每个程序都是独立于其他程序进行版本控制的,所有新开发都在master上进行。一旦程序经过测试并认为准备发布

增加版本

  • 在程序的Cargo.toml中增加版本号
  • 运行 cargo build-sbf <程序> 来构建二进制文件。注意生成的 spl_<程序>.so 的位置,以便将其附加到GitHub发布中。
  • 提交包含这些版本更改的PR,并通过CI后合并。

创建GitHub标签

程序标签的格式为 <程序>-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_<程序>.so 二进制文件
  • 点击“发布版本”

发布到Crates.io

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

免责声明

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

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

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

无运行时依赖