User Tools

Site Tools

The Hyperledger Fabric SDK for Node.js prvides a powerful API to interact with a Hyperledger Fabric v1.0 blockchain. The SDK is designed to be used in the Node.js JavaScript runtime.

Hyperledger Fabric中的Node.js SDK提供了强大的API接口用于同Hyperledger Fabric v1.0 blockchain进行交互。该SDK被设计用于Node.js JavaScript的运行。


Hyperledger Fabric is the operating system of an enterprise-strength permissioned blockchain network. For a high-level overview of the fabric, visit

Hyperledger Fabric是企业级许可的区块链网络的操作系统。对于高等级fabric的概述,请访问

Applications can be developed to interact with the blockchain network on behalf of the users. APIs are available to:


  • 创建通道(create channels)
  • 请求节点加入通道(ask peer nodes to join the channel)
  • 在节点中安装链码(install chaincodes in peers)
  • 在通道中实现链码实例化(instantiate chaincodes in a channel)
  • 通过调用链码来调用事务(invoke transactions by calling the chaincode)
  • 查询事务或区块的账本(query the ledger for transactions or blocks)


The Transaction Flow document provides an excellent description of the application/SDK, peers, and orderers working together to process transactions and producing blocks.


Security on the Fabric is enforced with digital signatures. All requests made to the fabric must be signed by users with appropriate enrollment certificates. For a user's enrollment certificate to be considered valid on the Fabric, it must be signed by a trusted Certificate Authority (CA). Fabric supports any standard CAs. In addition, Fabric provides a CA server. See this overview.


Node.js SDK功能

The Hyperledger Fabric SDK for Node.js is designed in an Object-Oriented programming style. Its modular construction enables application developers to plug in alternative implementations of key functions such as crypto suites, the state persistence store, and logging utility.

Hyperledger Fabric中的Node.js SDK是根据面向对象的程序风格进行设计的。该模块化的结构是应用程序开发人员能够可选择的插入关键函数的实现,比如加密套件,持久性状态存储,日志记录等等。

The SDK's list of features include:


· fabric-client:

  • 创建一个新的通道(create a new channel)
  • 将通道信息发送给节点用于节点加入(send channel information to a peer to join)
  • 在节点上安装链码(install chaincode on a peer)
  • 在通道中进行链码实例化,其中包括两步:提议交易(instantiate chaincode in a channel, which involves two steps: propose and transact)
  • 提交交易,其中包括两步:提议交易(submitting a transaction, which also involves two steps: propose and transact)
  • 查询链码的最新状态(query a chaincode for the latest application state)
  • 多种查询功能(various query capabilities):

  • 监控事件(monitoring events):

    • 连接一个节点的事件流(connect to a peer's event stream)
    • 监听一个区块的事件(listen on block events)
    • 监听交易时间并且确定交易是否成功提交进行标记(listen on transactions events and find out if the transaction was successfully committed to the ledger or marked invalid)
    • 监听由链码产生的自定义事件(listen on custom events produced by chaincodes)
  • 序列化用户对象及其签名功能(serializable User object with signing capabilities)

  • 多层覆盖式的分层配置设置(hierarchical configuration settings with multiple layers of overrides):文件(files), 环境变量(environment variable),程序参数(program arguments), 内存设置(in-memory settings)

  • 使用内置的记录器(winston)进行日志记录并且被多种流行的日志记录器进行覆盖,包括 log4js 和 bunyan等等。logging utility with a built-in logger (winston) and can be overriden with a number of popular loggers including log4js and bunyan

  • 可插式CryptoSuite 界面描述了与Fabric进行成功交互时需要的加密操作。其中包括两种实现:pluggable CryptoSuite interface describe the cryptographic operations required for successful interactions with the Fabric. Two implementations are provided out of box:

  • 可插式状态存储界面,用于持续性状态缓存,比如用户。pluggable State Store interface for persisting state caches such as users

  • 自定义的密钥存储用于所有基于软件的加密套件实现。customizable Crypto Key Store for any software-based cryptographic suite implementation

  • 同时支持TLS和非TLS链接到peer和orderer,请参阅peer和orderer的超类。 supports both TLS (grpcs://) or non-TLS (grpc://) connections to peers and orderers, see Remote which is the superclass for peers and orderers

· fabric-ca-client:

  • 注册新用户(register a new user)
  • 登记用户同时获得由Fabric CA签署的注册证书(enroll a user to obtain the enrollment certificate signed by the Fabric CA)
  • 通过注册ID废除已有用户或废除特定证书(evoke an existing user by enrollment ID or revoke a specific certificate)
  • 自定义的持久储存(customizable persistence store)


The SDK is made up of 3 top-level modules that can be accessed through the navigation menu Modules:


  • api:可插式API,用于应用程序开发人员来通过SDK来提供有选择性关键界面的替代。对于每个接口,都有内置的默认实现。api: pluggable APIs for application developers to supply alternative implementations of key interfaces used by the SDK. For each interface there are built-in default implementations.

  • fabric-client: 该模块提供API来进行同基于Hypreledger Fabric的区块链网络的交互,也就是同peer,orderer和事件流。fabric-client: this module provides APIs to interact with the core components of a Hypreledger Fabric-based blockchain network, namely the peers, orderers and event streams.

  • fabric-ca-client:该模块提供能与包含成员管理资格的服务的可选组件(fabric-ca)进行交互的API。该工作具有Commons Attribution 4.0 International License。fabric-ca-client: this module provides APIs to interact with the optional component, fabric-ca, that contains services for membership management. Creative Commons License This work is licensed under a Creative Commons Attribution 4.0 International License.

groups/twgc/fabric-doc/ · Last modified: 2017/09/07 13:12 by Dinghao Liu