1个稳定版本

1.0.0 2021年11月24日

#3#sealevel

Apache-2.0

280KB
7K 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

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

程序包

描述 版本 文档
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 链下梅克尔树中存储的压缩账户管理程序 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 用于链上梅克尔树表示的库 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-账户-压缩 用于账户压缩程序的绑定 npm Docs
@solana/spl-memo 用于备忘录程序的绑定 npm N/A
@solana/spl-名称-服务 用于名称服务程序的绑定 npm N/A
@solana/spl-质押- 用于质押池程序的绑定 npm N/A
@solana/spl-token-借贷 用于 token-lending 程序的绑定 npm N/A
@solana/spl-token-交换 用于 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 代币

$ 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发布界面
  • 点击“创建新发布”,并在“标签版本”框中输入新标签。
  • 将发布标题为“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
~435K SLoC