1个不稳定版本

0.0.1 2022年12月1日

#15#sealevel

Apache-2.0

2KB

Solana程序库

Solana程序库(SPL)是针对 Sealevel并行运行时的一系列链上程序。这些程序与Solana对Sealevel的实现、solana-runtime进行测试,其中一些已部署到主网Beta。随着Sealevel在其他地方的实现,我们将欢迎补丁以确保这里的程序可以在所有实现中通用。

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

部署

在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 包含所有过去和现在的程序审计。

程序包

描述 版本 文档
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 备忘录程序的绑定 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到最新版本,并在相关<程序名称>目录中重新运行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 <程序>来构建二进制文件。注意生成的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提供的开发资源产生的任何内容,仅用于教育和启发目的。SL不鼓励、诱导或批准在任何违反适用法律或法规的情况下部署、集成或使用此类应用程序(包括构成Solana区块链协议的代码),并在此禁止此类部署、集成或使用。这包括读者(a)违反美国或任何其他适用司法管辖区的出口控制或制裁法律、(b)如果读者位于或通常居住在受美国外国资产控制办公室(OFAC)全面制裁的国家或地区,或(c)如果读者是或代表特别指定国民(SDN)或受类似封锁或禁止方禁令约束的人。

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

无运行时依赖