#token #programs #upgrade #solana #spl #collection #labs

app spl-token-upgrade-cli

SPL令牌升级命令行工具

2个不稳定版本

0.1.0 2022年11月28日
0.0.1 2022年9月16日

#35 in #spl

Apache-2.0

1.5MB
35K SLoC

索拉纳程序库

索拉纳程序库(SPL)是一系列针对 Sealevel并行运行时 的链上程序。这些程序针对索拉纳的Sealevel实现、solana-runtime进行测试,其中一些部署到主网Beta。随着其他程序实现Sealevel,我们将欣然接受补丁,以确保这里的程序可以在所有实现中通用。

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

部署

索拉纳程序库仓库中只有一部分程序部署到索拉纳主网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

此外,还有一个程序计划部署到索拉纳主网Beta

程序 版本
single-pool 1.0.1

审计

索拉纳程序库仓库中只有一部分程序进行了审计。目前包括

程序 最后审计日期 版本
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

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更新到最新版本,并在相关<程序名称>目录中运行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 <程序>构建二进制文件。注意生成的spl_<程序>.so的位置,以便将其附加到GitHub发布中。
  • 提交一个包含这些版本更改的PR,并通过CI后进行合并。

创建Github标签

程序标签的格式为<程序>-vX.Y.Z。在版本升级提交处创建新标签,并将其推送到solana-program-library仓库,例如

$ git tag token-v1.0.0 b24bfe7
$ git push upstream --tags

发布Github发布

  • 转到GitHub发布界面
  • 点击“创建新发布”,并在“标签版本”框中输入新标签。
  • 将发布标题定为“SPL vX.Y.Z”,完成描述,并附加spl_<程序>.so二进制文件
  • 点击“发布发布”

发布到Crates.io

导航到程序目录,并运行cargo package以测试构建。然后运行cargo publish

免责声明

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

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

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

依赖项

~88MB
~1.5M SLoC