1 个不稳定版本

0.0.1 2024年4月13日

#7#bba

Apache-2.0

3KB

索拉纳程序库

索拉纳程序库(SPL)是一系列针对 Sealevel 并行运行时的链上程序。这些程序与 Solana 对 Sealevel、solana-runtime 的实现进行了测试,其中一些已部署到主网测试版。随着其他人对 Sealevel 的实现,我们将热情地接受补丁,以确保这些程序可以在所有实现中移植。

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

审计

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

程序 上次审计日期 版本
token 2022-08-04 (同行评审) 3.4.0
associated-token-account 2022-08-04 (同行评审) 1.1.0
token-2022 2023-02-10 0.5.0
governance N/A 3.1.0
stake-pool 2023-01-31 1.0.0
account-compression 2022-12-05 0.1.3
shared-memory 2021-02-25 1.0.0
feature-proposal 未审计 1.0.0
name-service 未审计 0.3.0
memo 未审计 3.0.0

其他所有程序可能会不时更新。这些程序未进行审计,因此自行承担分叉和部署的风险。以下是未审计程序的全列表

有关仓库安全策略的更多信息请参阅 SECURITY.md

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

程序包

描述 版本 文档
spl-token 索拉纳上的 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 用于stake-pool程序的CLI Crates.io
spl-feature-proposal-cli 用于feature-proposal程序的CLI Crates.io
spl-token-lending-cli 用于token-lending程序的CLI Crates.io
spl-token-upgrade-cli 用于token-upgrade程序的CLI Crates.io

JavaScript软件包

描述 版本 文档
@solana/spl-token 用于token、token-2022和关联代币账户程序的绑定 npm Docs
@solana/spl-governance 用于治理程序的绑定 npm N/A
@solana/spl-account-compression 用于account-compression程序的绑定 npm Docs
@solana/spl-memo 用于memo程序的绑定 npm N/A
@solana/spl-name-service 用于name-service程序的绑定 npm N/A
@solana/spl-stake-pool 用于stake-pool程序的绑定 npm N/A
@solana/spl-token-lending 用于token-lending程序的绑定 npm N/A
@solana/spl-token-swap 用于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到最新版本,并在相关的<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 <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

免责声明

本项目中描述的所有索赔、内容、设计、算法、估计、路线图、规范和性能测量都是索拉纳实验室公司(“SL”)的最佳努力的结果。读者自行负责检查和验证其准确性和真实性。此外,本项目中没有任何内容构成投资邀请。

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

读者应知悉,美国出口管制和制裁法律禁止美国公民(以及其他受此类法律约束的个人)与某些国家和地区的个人或SDN名单上的人员进行交易。因此,存在风险,即使用本仓库中包含的任何代码或其衍生代码的个人可能是受制裁人员,与这些人进行交易将违反美国的出口管制和制裁法律。

依赖关系

~2MB
~40K SLoC