#substrate #pallet #blockchain #ink #cli

程序 hookpoint-cli

Hookpoint CLI - Hookpoint Pallet 的 CLI 工具

1 个不稳定版本

0.1.0 2023 年 8 月 13 日

#39 in #ink

Apache-2.0

90KB
1.5K SLoC

Hookpoint CLI

License: Apache 2.0

Hookpoint CLI 是一个强大的工具,旨在简化 Substrate 和 ink! 智能合约中 hook 点的集成。使用此 CLI,开发者可以轻松地将区块链运行时与智能合约开发之间的差距连接起来,确保工作流程的连贯性和效率。

功能

  • 交互式配置:一个逐步配置向导简化了 hookpoints.json 的设置。
  • 自动代码生成:告别手动样板代码!为 Substrate 摆牌和相关的 ink! 合约生成 hook 代码。
  • 类型映射:提供 ink! 和 Substrate 类型之间的无缝映射,确保跨平台的兼容性和类型安全。
  • 模块化:考虑到可扩展性,允许轻松扩展并与其他工具兼容。
  • 与 Hookpoint Pallet 集成:Hookpoint CLI 设计与 hookpoint 摆牌无缝协作。将摆牌集成到您的 Substrate 节点中,以充分发挥 CLI 的潜力。
  • 依赖于 pallet_contracts:基于 Parity 的强大 pallet_contracts 摆牌构建。

安装

# Clone the repository
git clone [repository_url] hookpoint-cli

# Navigate to the directory
cd hookpoint-cli

# Build the project
cargo build --release

## Usage

Configure hookpoints interactively:

```shell
./hookpoint-cli configure --substrate-dir [YOUR_SUBSTRATE_DIRECTORY]

这将创建一个包含您的所有 hook 点定义的 hookpoint.json

如果它是当前目录,则无需提供您的 substrate 目录!

生成钩子

./hookpoint-cli generate --substrate-dir [YOUR_SUBSTRATE_DIRECTORY]

这将在 ./contracts/hooks 下生成三个文件夹

  • 一个 ink! trait,包含您所有的回调函数到 ink! 宇宙
  • 一个 ink! 样板合同,包含所有回调及其默认值,工作单元测试和功能端到端测试。
  • 一个 ink! 测试合同,您可以使用它来测试您的 substrate 代码中的集成
  • 在每个配置了钩子的摆牌中,有一个抽象一切的 hooks.rs,其中包含从 Substrate 内部调用的简单函数。无需字节搏斗,无需解码/编码,无需与 ink/substrate 连接交互。它就是如此简单。

当然,这里从“文档”部分开始的 markdown

文档

通过探索每个源文件中可用的内联文档,深入了解功能和模块。

贡献

欢迎贡献!请查看 CONTRIBUTING.md 以了解如何参与。

许可

基于Apache 2.0许可证授权 - 有关详细信息,请参阅LICENSE文件。

依赖项

~6–15MB
~185K SLoC