npm 包 @cennznet/cli 使用教程

阅读时长 6 分钟读完

前言

随着区块链技术的发展,越来越多的开发者开始进入区块链开发领域。而其中最为繁忙的一个领域就是以太坊和 substrate 开发。针对 substrate 开发者,CENNZnet 团队开发了相应的工具和框架,其中 @cennznet/cli 就是其中之一。

本文将会介绍 @cennznet/cli 的基本使用方法,同时配以示例代码,帮助开发者更快更好地掌握该工具的使用。

什么是 @cennznet/cli

@cennznet/cli 是 CENNZnet 团队针对 substrate 区块链开发而开发的一个命令行工具。使用 @cennznet/cli,开发者可以通过命令行创建一个 substrate 项目,同时可以方便地开发、测试以及部署自己的 substrate 应用。

在使用 @cennznet/cli 之前,需要先安装 Node.js 和 npm。另外,如果想要在本地运行 substrate 节点,首先需要安装 substrate 工具链。

安装

全局安装 @cennznet/cli:

@cennznet/cli 的使用

初始化项目

使用 @cennznet/cli 可以方便地初始化一个 substrate 项目,只需要在命令行中输入以下命令:

其中,my-project 是项目名称,可以自行修改。

创建 pallet

Pallet 是 substrate 中用于数据存储和状态转移的模块。 在 substrate 应用中,Pallet 扮演着非常重要的角色。使用 @cennznet/cli 创建一个新的 Pallet,只需要执行以下命令:

其中,my-pallet-name 是模块名称,可以自行修改。

添加 rpc 命令

Substrate 通过 JSON-RPC 与外部服务通信。开发人员可以使用 @cennznet/cli 命令行工具来添加自定义 rpc 命令,从而扩展 Substrate 节点的功能。 使用以下命令来添加自定义 rpc 命令:

其中,my-rpc-command 是自定义 rpc 命令名称,my-pallet-name 是要绑定到命令的 pallet 模块名称,可以根据具体情况进行修改。

编译和运行

当 substrate 项目创建好后,可以使用 @cennznet/cli 的 compile 命令来编译项目:

编译完成之后,可以直接使用 @cennznet/cli 的 run 命令来运行整个项目:

如果需要通过命令行参数或环境变量来配置运行选项,可以使用以下命令:

其中,--ws-port 和--rpc-port 分别指定 WebSocket 和 RPC 端口。

测试

@cennznet/cli 提供了方便的测试框架,可以帮助开发者快速测试自己的 substrate 项目。使用以下命令来运行测试:

生成文档

@cennznet/cli 也可以生成 substrate 项目的文档。使用以下命令来生成文档:

部署

@cennznet/cli 还可以帮助开发者将 substrate 项目部署到云端。使用以下命令来部署项目:

该命令将会把 substrate 项目部署到亚马逊 AWS 上的 us-west-2 区域。

示例代码

下面是一个简单的 substrate 项目示例:

-- -------------------- ---- -------
-- -- --------- ------- --------- --- ------ -------
-- ------------- ----------------

--- ---------------------------- ------------- ----------- ----------
--- ----------------------

------------
--- ------

-- ----
--- ----- ------ ------------- -
    ---- ------ ----------------- - ---------- -- -----------------------
-

-- ----
------------- -
    ----- ----- --- --------- ------ -- -------- -
        -------- ------ ----------- ----
    -
-

-- --
------------
    --- ---- -------- 
    ----- 
        --------- - -- -- --------------------------
    -
        ---------------------- -----
    -
--

-- -- ------
------------ -
    --- ------ --------- ------ --- ---- ---- ----- ------- --------- -
        -------- - -------
        --- -- --------------------- ------- ---- -- ------------------------ -
            --- ------ - -----------------------

            -- --------
            ---------------------------

            -- ----
            ------------------------------------------------- ---------
            ------
        -

        -- ----
        -------- - -------
        --- -- --------------------- -- ------------------------ -
            --- ------- - -----------------------
            --- --------- - ---------------------
            -- --------
            -----------------

            ------
        -
    -
-

总结

@cennznet/cli 是 CENNZnet 团队开发的一个非常实用的 Substrate 命令行工具,可以方便地创建、部署和管理项目。本文通过详细的介绍和示例代码,希望可以帮助开发者更好地了解和掌握 @cennznet/cli 的使用方法。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/103374