npm 包 unitedcore-message 使用教程

阅读时长 8 分钟读完

在前端开发中,我们常常会使用到各种各样的 npm 包来完成我们的任务。其中一个常用的 npm 包就是 unitedcore-message。它可以方便地使用 unitedcore 协议在前端中发送和接收消息。接下来,本文将为大家介绍 unitedcore-message 的使用教程。

安装 unitedcore-message

在使用 unitedcore-message 之前,首先需要进行安装。可以使用 npm 命令进行安装:

初始化

在使用 unitedcore-message 之前,需要先进行初始化。可以通过以下方式进行初始化:

在上面的代码中,我们通过 import 引入了 Message 类,并创建了一个 message 实例。在创建实例时,我们可以传入一些配置项。下面我们来看一下常用的配置项。

配置项

network

配置 network,可以设置使用哪个网络,取值可以是 'mainnet' 或者 'testnet'。默认值是 'mainnet'。

apiPrefix

配置 apiPrefix,可以设置 API 前缀。默认值是 'https://api.blockchain.com/v3/btc'。

privateKey

配置 privateKey,可以设置私钥。

address

配置 address,可以设置地址。如果未设置,则会从 privateKey 中生成地址。

feePerByte

配置 feePerByte,可以设置每个字节的手续费。默认值为 10。

至此,配置项的介绍就结束了。接下来我们将介绍 unitedcore-message 主要的功能。

主要功能

发送消息

要发送消息,我们需要调用 message.send 方法。它接受五个参数:

在上面的代码中,我们通过 message.send 方法发送了一条消息。其中 receiver 参数是必须的,它表示接收者的地址。amount 表示付款金额,message 表示要发送的消息,fee 表示手续费,callbackUrl 表示回调 URL。发送成功后,message.send 方法会返回一个 Promise 对象。

下面是一个完整的发送消息示例:

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

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

接收消息

要接收消息,我们需要调用 message.receive 方法。它接受一个回调函数作为参数:

在上面的代码中,我们通过 message.receive 方法注册了一个回调函数,当有新消息到达时,该函数将被调用。回调函数的参数是收到的消息。注意,只有在收到消息后才会调用回调函数,因此,如果没有收到消息,该函数将不会被调用。

下面是一个完整的接收消息示例:

查询余额

要查询余额,我们可以调用 message.getBalance 方法。它返回一个 Promise 对象。

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

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

在上面的代码中,我们通过 message.getBalance 方法查询了余额。查询结果将以聪为单位返回。如果需要将结果转换为比特币,可以将其除以 100000000。

以上就是 unitedcore-message 的主要功能。接下来我们将给出完整的代码示例。

示例代码

发送消息

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

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

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

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

接收消息

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

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

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

查询余额

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

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

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

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

总结

本文为大家介绍了 npm 包 unitedcore-message 的使用教程。我们首先介绍了如何安装 unitedcore-message,然后介绍了初始化和常用配置项。接着,我们详细讲解了 unitedcore-message 的主要功能:发送消息、接收消息和查询余额,并给出了详细的代码示例。希望这篇文章能够对大家进一步学习和使用 unitedcore-message 有所帮助。

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

纠错
反馈