Terms of use

Terms of Use

The use of this site and the content contained therein is governed by the Terms of Use. When you use this site you acknowledge that you have read the Terms of Use and that you accept and will be bound by the terms hereof and such terms as may be modified from time to time.

All text, graphics, audio, design and other works on the site are the copyrighted works of nasscom unless otherwise indicated. All rights reserved.
Content on the site is for personal use only and may be downloaded provided the material is kept intact and there is no violation of the copyrights, trademarks, and other proprietary rights. Any alteration of the material or use of the material contained in the site for any other purpose is a violation of the copyright of nasscom and / or its affiliates or associates or of its third-party information providers. This material cannot be copied, reproduced, republished, uploaded, posted, transmitted or distributed in any way for non-personal use without obtaining the prior permission from nasscom.
The nasscom Members login is for the reference of only registered nasscom Member Companies.
nasscom reserves the right to modify the terms of use of any service without any liability. nasscom reserves the right to take all measures necessary to prevent access to any service or termination of service if the terms of use are not complied with or are contravened or there is any violation of copyright, trademark or other proprietary right.
From time to time nasscom may supplement these terms of use with additional terms pertaining to specific content (additional terms). Such additional terms are hereby incorporated by reference into these Terms of Use.

Disclaimer

The Company information provided on the nasscom web site is as per data collected by companies. nasscom is not liable on the authenticity of such data.
nasscom has exercised due diligence in checking the correctness and authenticity of the information contained in the site, but nasscom or any of its affiliates or associates or employees shall not be in any way responsible for any loss or damage that may arise to any person from any inadvertent error in the information contained in this site. The information from or through this site is provided "as is" and all warranties express or implied of any kind, regarding any matter pertaining to any service or channel, including without limitation the implied warranties of merchantability, fitness for a particular purpose, and non-infringement are disclaimed. nasscom and its affiliates and associates shall not be liable, at any time, for any failure of performance, error, omission, interruption, deletion, defect, delay in operation or transmission, computer virus, communications line failure, theft or destruction or unauthorised access to, alteration of, or use of information contained on the site. No representations, warranties or guarantees whatsoever are made as to the accuracy, adequacy, reliability, completeness, suitability or applicability of the information to a particular situation.
nasscom or its affiliates or associates or its employees do not provide any judgments or warranty in respect of the authenticity or correctness of the content of other services or sites to which links are provided. A link to another service or site is not an endorsement of any products or services on such site or the site.
The content provided is for information purposes alone and does not substitute for specific advice whether investment, legal, taxation or otherwise. nasscom disclaims all liability for damages caused by use of content on the site.
All responsibility and liability for any damages caused by downloading of any data is disclaimed.
nasscom reserves the right to modify, suspend / cancel, or discontinue any or all sections, or service at any time without notice.

For any grievances under the Information Technology Act 2000, please get in touch with Grievance Officer, Mr. Anirban Mandal at data-query@nasscom.in.

New

See all

No notification found.

Registering Event Listeners In Hyperledger Fabric

DLT Labs

@DLT Labs

October 19, 2021

Blockchain

474

The Hyperledger Fabric platform provides three ways to get the status of a committed transaction on the peer. Those are:

By registering a transaction event
By registering the chaincode event
By registering a block event

In this article, we will see how to get transaction status using ‘chaincode event listener’. With a chaincode event listener, we can get the transaction status from the peer. The advantage of using a chaincode event listener is that we can set custom events in chaincode instead of using the built-in ‘transaction event’ and ‘block event’ listeners. And we can also pass payload in the custom events while committing the transaction on the peer.

For registering chaincode event listener, first set an event in chaincode and then register chaincode event listener, which is responsible to get committed transactions’ statuses from the peer and payloads which are set in events.

Prerequisites

To benefit from this article, the reader should have knowledge of Hyperledger Fabric or follow the below link to learn about it: https://hyperledger-fabric.readthedocs.io/en/release-1.3/
The implementation of my code will be in Node.js®.

Step: 1

In this step, first, we will see how to set events in chaincode. Chaincode is responsible to set events with ‘setEvent’ method on the response to the proposal which is included as part of a transaction. The event will be available in the committed block on the peer within the transaction regardless of the validity of the transaction.

In the below chaincode, we set an event with the ‘setEvent’ method, which assumes two arguments:

First is the event’s name;
Second is the value that you want to set in this event. Make sure the value which you want to set is always in a buffer since that is the type of argument required.

In the below chaincode, we set an event inside invoke() function just before the ‘shim.success’ method call, but the user also can set events in any other function of the chaincode.

const shim = require(‘fabric-shim’);
const util = require(‘util’);
const uuid = require(‘uuid’);let Chaincode = class { async Init(stub) {
 console.info(‘=========== Instantiated chaincode ===========’);
 return shim.success();
 } async Invoke(stub) {
 let ret = stub.getFunctionAndParameters();
 console.info(ret); let method = this[ret.fcn];
 if (!method) {
 console.error(‘no function of name:’ + ret.fcn + ‘ found’);
 throw new Error(‘Received unknown function ‘ + ret.fcn + ‘ invocation’);
 }
 try {
 let txId = uuid.v4();
 let payload = await method(stub, ret.params);
 
 console.log(“==== SETTING AN EVENT ====”);// HERE I SET UNIQUE ID BUT USER CAN SET ANY DATA ACCORDING TO THEIR REQUIREMENT
 stub.setEvent(“company-event”,Buffer.from(JSON.stringify([txId])));
 console.log(“==== EVENT SUCCESSFULLY SET ====”);
 
 return shim.success(payload);
 } catch (err) {
 console.log(err);
 return shim.error(err);
 }
 }
 
 
 async queryCompany(stub, args) {
 if (args.length != 1) {
 throw new Error(‘Incorrect number of arguments. Expecting ComReg ex: COM01’);
 }
 let comReg = args[0]; let comAsBytes = await stub.getState(comReg); //get the car from chaincode state
 if (!comAsBytes || comAsBytes.toString().length <= 0) {
 throw new Error(comReg + ‘ does not exist: ‘);
 }
 console.log(comAsBytes.toString());
 return comAsBytes;
 }
 
 
 async createCompany(stub, args) {
 console.info(‘============= START : Create Company ===========’);
 if (args.length != 5) {
 throw new Error(‘Incorrect number of arguments. Expecting 5’);
 } var company = {
 docType: ‘Company’,
 comName: args[1],
 address: args[2],
 gst_num: args[3]
 }; await stub.putState(args[0], Buffer.from(JSON.stringify(company)));
 console.info(‘============= END : Create Company ===========’);
 }
 
};shim.start(new Chaincode());

Step: 2

Before registering event listener we need an eventHub object. So first we create the eventHub object. To do this we need some important information like:

Peer URL eg.: “grpc://localhost:7051”
User or Admin credential
Store path where user and admin credential exists.

The below code is responsible to create eventHub object.

const path = require(‘path’);
const Fabric_Client = require(‘fabric-client’);
const Promise = require(‘bluebird’);// channel name where chaincode installed
const channelName = “mychannel”;
// peer URL which emits events
const peerUrl = “grpc://localhost:7051”;
// store path where user’s signing credential exist// user will use own store path
const store_path = “”;prepareEventHubConnection() {
 let eventHub;
 const fabric_client = new Fabric_Client();
 const channel = fabric_client.newChannel(channelName);
 const peer = fabric_client.newPeer(peerUrl);
 return Promise.resolve(store_path)
 .then((store_path)=>{
 return Fabric_Client.newDefaultKeyValueStore({path: store_path});
 })
 .then((state_store) => {
 fabric_client.setStateStore(state_store);
 const crypto_suite = Fabric_Client.newCryptoSuite();
 const crypto_store = Fabric_Client.newCryptoKeyStore({path: store_path});
 crypto_suite.setCryptoKeyStore(crypto_store);
 fabric_client.setCryptoSuite(crypto_suite);
 return fabric_client.getUserContext(‘admin’, true);
 })
 .then((user_from_store) => {
 if (user_from_store && user_from_store.isEnrolled()) {
 eventHub = channel.newChannelEventHub(peer);// ###############################################// ###### HERE EVENTHUB OBJECT IS READY #####// ###############################################
 return eventHub;
 } else {
 console.error(“ERROR :: CARD NOT FOUND”);
 return Promise.reject(“CardNotFound”);
 }
 }).catch((err)=>{
 console.error(“ERROR :: “,err);
 //Handle all error here
 });
 }

Step: 3

Now we register a chaincode event listener with the help of the eventHub object which was created in step 2 and the “registerChaincodeEvent” method. And we need some information like:

Chaincode name
Event name (which is previously set in chaincode)

The below code is responsible to register chaincode event listener.

eventHub.registerChaincodeEvent(chaincode, eventName,(onEvent, block, txHash, status)=>{
 let payloadData = onEvent.payload.toString();
 payloadData = JSON.parse(payloadData);// ###################################################// ###### HERE YOU CAN GET ALL COMMITTED EVENTS ######// ###################################################console.log(“ NEW EVENT ARRIVED WITH PAYLOAD => “,payloadData);
},(err)=>{
 console.error(“ERROR :: “,err);
});eventHub.connect({full_block: true},(err,status)=>{
 if(err) {
 console.error(“ERROR :: “,err);
 }});

After we have successfully registered chaincode event listener, we get some information in a callback function which is:

Event: which is set by the chaincode
Block Number: committed block number on peer
Transaction Hash: unique transaction Id
Transaction Status: status of the transaction

The payload which is set by the chaincode will be available in the onEvent object.

If the user wants to listen to events from a specific block, they can add options like ‘startBlock’:

eventHub.registerChaincodeEvent(chaincode, eventName,(onEvent, block, txHash, status)=>{console.log(“EVENT”);},(err)=>{console.error(“ERROR :: “,err);},{startBlock : “BLOCK NUMBER FROM WHERE USER WANTS TO LISTEN to THE TRANSACTION”});

I hope you will find this walkthrough helpful the next time you are looking for a more fully featured way to obtain the status of a committed transaction in Hyperledger Fabric.

Hyperledger Fabric is a project hosted by The Linux Foundation® and Hyperledger is its registered trademark. Node.js is a registered trademark of Joyent, Inc.

Author — Ankur Jaiswal, DLT Labs™

#blockchain #blockchaindevelopment #hyperledgerfabric #hyperledger

Disclaimer

That the contents of third-party articles/blogs published here on the website, and the interpretation of all information in the article/blogs such as data, maps, numbers, opinions etc. displayed in the article/blogs and views or the opinions expressed within the content are solely of the author's; and do not reflect the opinions and beliefs of NASSCOM or its affiliates in any manner. NASSCOM does not take any liability w.r.t. content in any manner and will not be liable in any manner whatsoever for any kind of liability arising out of any act, error or omission. The contents of third-party article/blogs published, are provided solely as convenience; and the presence of these articles/blogs should not, under any circumstances, be considered as an endorsement of the contents by NASSCOM in any manner; and if you chose to access these articles/blogs , you do so at your own risk.

DLT Labs

DLT Labs™ is a global leader in the development and delivery of enterprise blockchain technologies and solutions, as well as a pioneer in the creation and implementation of standards for application development. With a deep track record in innovation and one of the world's largest pools of highly experienced blockchain experts, DLT Labs™ enables the transformation and innovation of complex multi-stakeholder processes.

25 Nov 2024

Part 1: From Quantum Supremacy to Q...

Shwetank

Emerging Tech

23 Nov 2024

Why White Label Crypto Exchange Is ...

oliverethan

Blockchain

22 Nov 2024

7 Machine Learning Algorithms I Use...

Harish Kumar Ajjan

Data Science &a..

22 Nov 2024

Hybrid Cloud Computing Solutions: B...

Judge India Solution..

Cloud Computing

20 Nov 2024

How Salesforce Agentforce Leverages...

Intelliswift Softwar..

Mulesoft and Sa..

19 Nov 2024

Blockchain-Powered Crypto MLM Solut...

oliverethan

Blockchain

16 Nov 2024

Best Crypto Exchange – Exploring the World of Cryptocurrency Trading in 2025

CharleenStewa..

@CharleenStewar

02 Nov 2024

Blockchain Analytics Application

In the ever-evolving landscape of cryptocurrency, the demand for secure and user-friendly wallets is on the rise. For businesses aiming to capitalize on this trend, the Exodus Wallet Clone Script emerges as a viable option. But how can you…

New

Registering Event Listeners In Hyperledger Fabric

DLT Labs

Prerequisites

Step: 1

Step: 2

Step: 3

DLT Labs

Best Crypto Exchange – Exploring the World of Cryptocurrency Trading in 2025

oliverethan

Cryptocurrency Exchange: Identity Verification Solutions

oliverethan

The Emergence of Hybrid Crypto Exchange Development

oliverethan

Expert Insights into the White-Label Crypto Exchange Development Process for 2025

oliverethan

Crypto Exchange Development Process - Expert Insights 2024

oliverethan

Is the Exodus Wallet Clone Script Right for Your Business? Key Insights

CharleenStewa..

About Us

Knowledge Center

In the News

Topics In Demand

Notification

New

Registering Event Listeners In Hyperledger Fabric

Prerequisites

Step: 1

Step: 2

Step: 3

Share this blog

Related blogs

CSM Tech

27 Nov 2024

ProHance

27 Nov 2024

Nidhi Dubey

27 Nov 2024

Rayden

26 Nov 2024

moncourt.ananya831

25 Nov 2024

Tata Technologies

25 Nov 2024

Shwetank

23 Nov 2024

oliverethan

22 Nov 2024

Harish Kumar Ajjan

22 Nov 2024

Judge India Solution..

20 Nov 2024

Intelliswift Softwar..

19 Nov 2024

oliverethan

16 Nov 2024

About Us

Knowledge Center

In the News

Newsletter