#solana #error #programs #spl #token #attributes #collection

spl-program-error-derive

Solana程序错误属性和推导宏的Proc-Macro库

7个不稳定版本 (3个破坏性版本)

0.4.1 2024年4月22日
0.4.0 2024年3月28日
0.3.2 2024年2月5日
0.3.1 2023年9月28日
0.1.0 2023年6月7日

49#spl

Download history 29026/week @ 2024-04-28 29009/week @ 2024-05-05 30698/week @ 2024-05-12 23811/week @ 2024-05-19 26230/week @ 2024-05-26 29671/week @ 2024-06-02 31209/week @ 2024-06-09 29698/week @ 2024-06-16 32520/week @ 2024-06-23 27087/week @ 2024-06-30 29921/week @ 2024-07-07 28579/week @ 2024-07-14 33964/week @ 2024-07-21 35086/week @ 2024-07-28 54420/week @ 2024-08-04 37216/week @ 2024-08-11

162,633 每月下载次数
458 个crate中使用(通过 spl-program-error

Apache-2.0

14KB
254

Solana程序库

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

更多信息请参阅 SPL文档Token类型文档

部署

仅在Solana程序库仓库中的程序子集部署到Solana Mainnet Beta。目前包括

程序 版本
token 3.4.0
关联的token账户 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
关联的token账户 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 管理存储在链外默克尔树中的压缩账户的程序 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-账户-压缩 用于账户压缩程序的绑定 npm Docs
@solana/spl-备注 用于备忘录程序的绑定 npm N/A
@solana/spl-名称-服务 用于名称服务程序的绑定 npm N/A
@solana/spl-质押- 用于质押池程序的绑定 npm N/A
@solana/spl-token-借贷 用于代币借贷程序的绑定 npm N/A
@solana/spl-token-交换 用于代币交换程序的绑定 npm N/A

开发

环境设置

  1. 安装最新的 Solana 工具
  2. 安装最新的 Rust 稳定版。如果您已经有了 Rust,请运行 rustup update 以获取最新版本。
  3. 为您的发行版安装 libudev 开发包(Debian 衍生的发行版为 libudev-dev,Redhat 衍生的为 libudev-devel)。

构建

构建 on-chain 程序

# 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更新到最新版本,然后在相关<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发布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 名单上的个人进行交易。因此,存在风险,即使用此存储库中包含的任何代码或其派生代码的个人可能是受制裁的个人,与这些个人的交易将违反美国的出口管制和制裁法律。


lib.rs:

定义构建 Solana 程序错误的进程宏的存储库

依赖关系

~0.6–1.2MB
~28K SLoC