Version Build Status

fabric-shim provides the APIs for application developers to implement "Smart Contracts" for the Hyperledger Fabric backend, also known as "Chaincodes". Detailed explanation on the concept and programming model can be found here:


npm install fabric-shim


The chaincode interface contains two methods to be implemented:

const shim = require('fabric-shim');

const Chaincode = class {
    async Init(stub) {
        // use the instantiate input arguments to decide initial chaincode state values

        // save the initial states
        await stub.putState(key, Buffer.from(aStringValue));

        return shim.success(Buffer.from('Initialized Successfully!'));

    async Invoke(stub) {
        // use the invoke input arguments to decide intended changes

        // retrieve existing chaincode states
        let oldValue = await stub.getState(key);

        // calculate new state values and saves them
        let newValue = oldValue + delta;
        await stub.putState(key, Buffer.from(newValue));

        return shim.success(Buffer.from(newValue.toString()));

Start the chaincode process and listen for incoming endorsement requests:

shim.start(new Chaincode());

API Reference

Visit and click on "Classes" link in the navigation bar on the top to view the list of class APIs.


Tested with node.js 8.9.0 (LTS).


This package is distributed under the Apache License, Version 2.0, see LICENSE.txt for more information.