NodeJs SDK
1. 概述
NodeJs SDK 是业务端与bubi链交互的通道和工具,提供基础的 API 功能,包括提交交易、账户操作、部署和调用合约、各类查询操作等等。NodeJs SDK 的使用方式简单,且对环境兼容友好,既可集成运行在 Node.js 环境,也可以运行在浏览器、Web 应用等环境,更加的灵活方便。
2. 环境准备
2.1. 环境依赖
- 从 Node.js官网下载并安装 Node.js(版本为6.0或以上,推荐安装v8.17.0)。
# 若已安装,请通过命令查看版本:
node -v
2.2. 下载安装SDK
npm i bubichain-sdk-nodejs
3. 示例代码
此章节提供快速使用SDK实现转账功能的示例代码。
3.1. 转账交易功能
1. 创建区块链账户 2. 激活账户 3. 获取Nonce值 4. 构建操作 5. 序列化交易 6. 签名操作 7. 提交交易4. 接口使用说明
这里介绍接口的详细使用,首先需要配置节点地址并生成SDK实例,然后调用相应模块的接口,其中包括账户模块、资产模块、合约模块、交易模块、区块模块,接口按使用分类分为查询、广播交易相关接口。
模块 | 描述 |
---|---|
transaction | 交易模块 |
token | 资产模块 |
account | 账户模块 |
contract | 合约模块 |
block | 区块模块 |
4.1. 初始化SDK
初始化SDK时的传入参数 options 是一个对象,options 包含如下参数:
参数 | 类型 | 描述 |
---|---|---|
host | String | 区块链节点的 IP和端口 或者主机名,例如:布比体验链:https://seed1-node.bubi.cn |
- 示例
const options = {
host: 'http://seed1-node.bubi.cn',
};
const sdk = new BubiChainSDK(options);