1 个不稳定版本

0.0.1 2022年12月1日

#68 in #spl

Apache-2.0

2KB

Solana 程序库

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

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

部署

仅在 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 管理存储在链外 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-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-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 绑定执行集成测试。有关示例,请参阅 代币程序的 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 区块链协议的代码)。SL 禁止任何此类部署、集成或使用。这包括读者(a)违反美国或任何其他适用司法管辖区出口控制或制裁法律的使用;(b)读者位于或通常居住在受美国外国资产控制办公室(OFAC)管理的全面制裁的国家或地区;(c)读者是或代表特别指定国民(SDN)或受类似封锁或禁止方禁令约束的人。

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

无运行时依赖