Hyperledger Fabric SDK for Node.js

The Hyperledger Fabric SDK for Node.js provides 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 is the operating system of an enterprise-strength permissioned blockchain network. For a high-level overview of the fabric, visit http://hyperledger-fabric.readthedocs.io/en/latest/.

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

How Different Components of the Fabric Work Together

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.

Features of the SDK for Node.js

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.

The SDK’s list of features include: * fabric-client: * [create a new channel]{@link Client#createChannel} * [send channel information to a peer to join]{@link Chain#joinChannel} * [install chaincode on a peer]{@link Client#installChaincode} * instantiate chaincode in a channel, which involves two steps: [propose]{@link Chain#sendInstantiateProposal} and [transact]{@link Chain#sendTransaction} * submitting a transaction, which also involves two steps: [propose]{@link Chain#sendTransactionProposal} and [transact]{@link Chain#sendTransaction} * [query a chaincode for the latest application state]{@link Chain#queryByChaincode} * various query capabilities: * [chain height]{@link Chain#queryInfo} * [block-by-number]{@link Chain#queryBlock}, [block-by-hash]{@link Chain#queryBlockByHash} * [all channels that a peer is part of]{@link Client#queryChannels} * [all installed chaincodes in a peer]{@link Client#queryInstalledChaincodes} * [all instantiated chaincodes in a channel]{@link Chain#queryInstantiatedChaincodes} * [transaction-by-id]{@link Chain#queryTransaction} * [channel configuration data]{@link Chain#getChannelConfig} * monitoring events: * [connect to a peer’s event stream]{@link EventHub#connect} * listen on [block events]{@link EventHub#registerBlockEvent} * listen on [transactions events]{@link EventHub#registerTxEvent} and find out if the transaction was successfully committed to the ledger or marked invalid * listen on [custom events]{@link EventHub#registerChaincodeEvent} produced by chaincodes * serializable [User]{@link User} object with signing capabilities * [hierarchical configuration]{@link Client.getConfigSetting} settings with multiple layers of overrides: files, environment variable, program arguments, in-memory settings * [logging utility]{@link Client.setLogger} with a built-in logger (winston) and can be overriden with a number of popular loggers including log4js and bunyan * pluggable [CryptoSuite]{@link api.CryptoSuite} interface describe the cryptographic operations required for successful interactions with the Fabric. Two implementations are provided out of box: * [Software-based ECDSA]{@link CryptoSuite_ECDSA_AES} * [PKCS#11-compliant ECDSA]{@link CryptoSuite_PKCS11} * pluggable [State Store]{@link api.KeyValueStore} interface for persisting state caches such as users * [File-based store]{@link FileKeyValueStore} * [CouchDB-base store]{@link CouchDBKeyValueStore} which works with both CouchDB database and IBM Cloudant * customizable [Crypto Key Store]{@link CryptoKeyStore} for any software-based cryptographic suite implementation * supports both TLS (grpcs://) or non-TLS (grpc://) connections to peers and orderers, see {@link Remote} which is the superclass for [peers]{@link Peer} and [orderers]{@link Orderer}

  • fabric-ca-client:
  • [register]{@link FabricCAServices#register} a new user
  • [enroll]{@link FabricCAServices#enroll} a user to obtain the enrollment certificate signed by the Fabric CA
  • [revoke]{@link FabricCAServices#revoke} an existing user by enrollment ID or revoke a specific certificate
  • [customizable persistence store]{@link FabricCAServices}

API Reference

The SDK is made up of 3 top-level modules that can be accessed through the navigation menu Modules: 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: 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: this module provides APIs to interact with the optional component, fabric-ca, that contains services for membership management.