快速安装¶

标签：安装Node.js 命令行工具

环境要求¶

Node.js开发环境
- Node.js >= 8.10.0
- npm >= 5.6.0
如果您没有部署过Node.js环境，可以参考下列部署方式：
- 如果您使用Linux或MacOS：
  
  推荐使用nvm快速部署，使用nvm同时也能够避免潜在的导致Node.js SDK部署失败的权限问题。以部署Node.js 8为例，部署步骤如下：
```
# 安装nvm
curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.2/install.sh | bash
# 加载nvm配置
source ~/.$(basename $SHELL)rc
# 安装Node.js 8
nvm install 8
# 使用Node.js 8
nvm use 8
```
- 如果您使用Windows：
  
  请前往Node.js官网下载Windows下的安装包进行安装。
基本开发组件
- Python 2（Windows、Linux及MacOS需要）
- g++（Linux及MacOS需要）
- make（Linux及MacOS需要）
- Git（Windows、Linux及MacOS需要）
- Git bash（仅Windows需要）
- MSBuild构建环境（仅Windows需要）
FISCO BCOS节点：请参考FISCO BCOS安装搭建

部署Node.js SDK¶

拉取源代码¶

git clone https://github.com/FISCO-BCOS/nodejs-sdk.git

使用npm安装依赖项¶

如果您的网络中使用了代理，请先为npm配置代理：

npm config set proxy <your proxy>
npm config set https-proxy <your proxy>

如果您所在的网络不便访问npm官方镜像，请使用其他镜像代替，如淘宝：

npm config set registry https://registry.npm.taobao.org

# 部署过程中请确保能够访问外网以能够安装第三方依赖包
cd nodejs-sdk
npm install
npm run repoclean
npm run bootstrap

Node.js CLI¶

Node.js SDK内嵌CLI工具，供用户在命令行中方便地与区块链进行交互。CLI工具在Node.js SDK提供的API的基础上开发而成，使用方式与结果输出对脚本友好，同时也是一个展示如何调用Node.js API进行二次开发的范例。

快速建链（可选）

若您的系统中已经搭建了FISCO BCOS链，请跳过本节。

# 获取开发部署工具build_chain.sh脚本
curl -#LO https://github.com/FISCO-BCOS/FISCO-BCOS/releases/download/v2.9.1/build_chain.sh && chmod u+x build_chain.sh

注解

如果因为网络问题导致长时间无法下载build_chain.sh脚本，请尝试 curl -#LO https://gitee.com/FISCO-BCOS/FISCO-BCOS/raw/master-2.0/tools/build_chain.sh && chmod u+x build_chain.sh

# 在本地建一个4节点的FISCO BCOS链
bash build_chain.sh -l 127.0.0.1:4 -p 30300,20200,8545 -i
# 启动FISCO BCOS链
bash nodes/127.0.0.1/start_all.sh

配置证书及Channel端口

配置证书

修改配置文件，证书配置位于packages/cli/conf/config.json文件的authentication配置项中。你需要根据您实际使用的证书文件的路径修改该配置项的key、cert及ca配置，其中key为SDK私钥文件的路径，cert为SDK证书文件的路径，ca为链根证书文件的路径，这些文件可以由开发部署工具或运维部署工具自动生成，具体的生成方式及文件位置请参阅上述工具的说明文档。
配置Channel端口

修改配置文件，节点IP及端口配置位于packages/cli/conf/config.json文件的nodes配置项中。您需要根据您要连接FISCO BCOS节点的实际配置修改该配置项的ip及port配置，其中ip为所连节点的IP地址，port为节点目录下的 config.ini 文件中的channel_listen_port配置项的值。如果您使用了快速搭链，可以跳过此步。

配置完成后，即可开始使用CLI工具，CLI工具位于packages/cli/cli.js，所有操作均需要在packages/cli/目录下执行，您需要先切换至该目录：

cd packages/cli

开启自动补全（仅针对bash及zsh用户，可选）

为方便用户使用CLI工具，CLI工具支持在bash或zsh中进行自动补全，此功能需要手动启用，执行命令：

rcfile=~/.$(basename $SHELL)rc && ./cli.js completion >> $rcfile && source $rcfile

便可启用自动补全。使用CLI工具时，按下Tab键（依据系统配置的不同，可能需要按两下）便可弹出候选命令或参数的列表并自动补全。

示例

以下给出几个使用示例：

查看CLI工具的帮助

./cli.js --help

查看CLI工具能够调用的命令及对应的功能

./cli.js list

以下示例中的输入、输出及参数仅供举例

查看所连的FISCO BCOS节点版本

./cli.js getClientVersion

输出如下：

{
  "id": 1,
  "jsonrpc": "2.0",
  "result": {
    "Build Time": "20190705 21:19:13",
    "Build Type": "Linux/g++/RelWithDebInfo",
    "Chain Id": "1",
    "FISCO-BCOS Version": "2.0.0",
    "Git Branch": "master-2.0",
    "Git Commit Hash": "d8605a73e30148cfb9b63807fb85fa211d365014",
    "Supported Version": "2.0.0"
  }
}

获取当前的块高

./cli.js getBlockNumber

输出如下：

{
  "id": 1,
  "jsonrpc": "2.0",
  "result": "0xfa"
}

部署SDK自带的HelloWorld合约

./cli.js deploy HelloWorld

输出如下：

{
  "contractAddress": "0x11b6d7495f2f04bdca45e9685ceadea4d4bd1832"
}

调用HelloWorld合约的set接口，请将合约地址改为实际地址

./cli.js call HelloWorld 0x11b6d7495f2f04bdca45e9685ceadea4d4bd1832 set vita

输出如下：

{
  "transactionHash": "0xa71f136107389348d5a092a345aa6bc72770d98805a7dbab0dbf8fe569ff3f37",
  "status": "0x0"
}

调用HelloWorld合约的get接口，请将合约地址改为实际地址

./cli.js call HelloWorld 0xab09b29dd07e003776d22566ae5c078f2cb2279e get

输出如下：

{
  "status": "0x0",
  "output": {
    "0": "vita"
  }
}

CLI帮助

如果您想知道某一个命令该如何使用，可以使用如下的命令：

./cli.js <command> ?

其中command为一个命令名，使用?作为参数便可获取该命令的使用提示，如：

./cli.js call ?

会得到如下的输出：

cli.js call <contractName> <contractAddress> <function> [parameters...]

Call a contract by a function and parameters

位置：
  contractName     The name of a contract                        [字符串] [必需]
  contractAddress  20 Bytes - The address of a contract          [字符串] [必需]
  function         The function of a contract                    [字符串] [必需]
  parameters       The parameters(splited by a space) of a function
                                                             [数组] [默认值: []]

选项：
  --help     显示帮助信息                                                 [布尔]
  --version  显示版本号                                                   [布尔]