3个不稳定版本
0.2.1 | 2024年7月11日 |
---|---|
0.2.0 | 2024年3月28日 |
0.1.0 | 2023年10月24日 |
#26 in #spl
在 spl-token-collection 中使用
1MB
24K SLoC
Solana程序库
Solana程序库(SPL)是一系列针对 Sealevel并行运行时 的链上程序。这些程序针对Solana的Sealevel实现、solana-runtime进行了测试,其中一些已部署到主网Beta。随着其他人实现Sealevel,我们将愉快地接受补丁以确保这里的程序可以在所有实现之间移植。
部署
仅在Solana程序库仓库中的部分程序部署到Solana主网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主网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 |
其他所有程序可能会不时更新。这些程序未经审计,因此请自行承担分叉和部署的风险。以下是未经审计程序的全列表
- binary-option
- binary-oracle-pair
- 功能提议
- instruction-padding
- managed-token
- 备注
- 命名服务
- record
- stateless-asks
- token-lending
- token-swap
- token-upgrade
有关仓库安全策略的更多信息,请参阅SECURITY.md。
安全审计仓库security-audits repo包含所有过去和现在的程序审计。
程序包
CLI程序包
JavaScript程序包
开发
环境设置
- 安装最新的Solana工具。
- 安装最新的Rust稳定版。如果您已经安装了Rust,请运行
rustup update
以获取最新版本。 - 为您的发行版安装
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项目。
常见问题
这里提到了解决您可能会遇到的一些问题的方法。
-
打开失败: ../../部署/spl_<程序-name>.so
请将您的Rust和Cargo更新到最新版本,并在相关
<program-name>
目录中重新运行cargo build-sbf
,或在仓库根目录中运行以重新构建所有链上程序。 -
有关解决方案,请参阅这里。安装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
-
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不鼓励、诱导或批准任何此类应用的部署、集成或使用(包括包含在索拉纳区块链协议中的代码),如果违反了适用的法律或法规,并在此禁止任何此类部署、集成或使用。这包括读者(a)违反美国或任何其他适用管辖区的出口控制或制裁法律;(b)读者位于或通常居住在美国财政部外国资产控制办公室(OFAC)管理的全面制裁的国家或地区;(c)读者是特别指定国民(SDN)或受到类似封锁或拒绝方禁止的人。
读者应了解,美国的出口控制法和制裁法禁止美国公民(以及受此类法律约束的其他人)与某些国家或地区的个人进行交易,或位于SDN名单上。因此,存在风险,其他人使用此存储库中包含的任何代码或其衍生代码可能受到制裁,与这些人进行的交易可能违反美国出口控制法和制裁法。
lib.rs
:
定义使用SPL Token Group接口创建SPL代币组的示例程序的Crate。
依赖关系
~22–31MB
~495K SLoC