1 个不稳定版本

0.0.1 2023年8月21日

#31#stake

Apache-2.0

2KB

Solana 程序库

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

更多信息请参阅 SPL 文档Token TypeDocs

部署

仅将 Solana 程序库仓库中的一部分程序部署到 Solana 主网测试版。目前包括

程序 版本
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 主网测试版

程序 版本
single-pool 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
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-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-account-compression 用于账户压缩程序的绑定 npm Docs
@solana/spl-备注 用于备忘录程序的绑定 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令牌

$ 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 夜间工具链的 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 列表上的个人进行交易。因此,其他人使用本存储库中包含的任何代码或其衍生物可能会受到制裁,与这些人进行的交易将违反美国出口控制和制裁法律。

无运行时依赖