1 个不稳定版本

0.0.1 2023年10月17日

#40 in #gate

Apache-2.0

2KB

Solana 程序库

Solana 程序库 (SPL) 是一系列针对 Sealevel 并行运行时 的链上程序集合。这些程序针对 Solana 的 Sealevel 实现进行测试,solana-runtime,其中一些已部署到主网 Beta。随着其他实现 Sealevel,我们将乐意接受补丁以确保这里的程序可以在所有实现之间移植。

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

部署

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

程序包

描述 版本 文档
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

命令行界面包

描述 版本
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到最新版本,并在相关的<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

免责声明

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

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

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

无运行时依赖项