3 个稳定版本

1.2.0 2020 年 12 月 7 日
1.1.0 2020 年 11 月 25 日
1.0.0 2020 年 11 月 19 日

#4#sealevel

Apache-2.0

63KB
1K SLoC

Solana 程序库

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

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

部署

仅在 Solana 程序库仓库中的一部分程序被部署到 Solana Mainnet Beta。目前包括

程序 版本
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 Mainnet Beta

程序 版本
单一池 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
单一池 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

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
@solana/spl-账户-压缩 用于账户压缩程序的绑定 npm Docs
@solana/spl-备忘录 用于memo程序的绑定 npm
@solana/spl-名称-服务 用于名称服务程序的绑定 npm
@solana/spl-抵押- 用于抵押账户池程序的绑定 npm
@solana/spl-token-贷款 用于代币贷款程序的绑定 npm
@solana/spl-token-交换 用于代币交换程序的绑定 npm

开发

环境设置

  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_<程序-名称>.so

    请更新您的Rust和Cargo到最新版本,并在相关目录中重新运行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不鼓励、诱导或批准违反适用法律或法规部署、集成或使用任何此类应用程序(包括包含在Solana区块链协议中的代码),并在此禁止此类部署、集成或使用。这包括读者(a)违反美国或任何其他适用司法管辖区的出口控制或制裁法律,(b) 如果读者位于或通常居住在美国外国资产控制办公室(OFAC)管理的全面制裁的国家或地区,或(c) 如果读者是或代表特别指定国民(SDN)或受类似封锁或禁止方禁令约束的人。

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

依赖项

~75MB
~1.5M SLoC