Topics In Demand
Cloud Computing | Cyber Security & Privacy | Data Science & AI | Digital Transformation | Diversity And Inclusion | Engineering Research & Design | ESG & Sustainability | Future Of Work | Product/Startups |
Notification
New
See all

No notification found.

Registering Event Listeners In Hyperledger Fabric
Registering Event Listeners In Hyperledger Fabric
images
DLT Labs
@DLT Labs

October 19, 2021

Blockchain

465

0

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

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:

  1. First is the event’s name;
  2. 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

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.


images
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.

Related blogs
See all
images

Empowering Indian Healthcare with A...

Dhiraj Sharma

11

Digital Transfo..
24 Sep 2024
images

Enhancing Security in Generative AI...

Xoriant

4

Cyber Security ..
24 Sep 2024
images

The Strategic Role of Prompt Engine...

Movate

9

AI Inside
24 Sep 2024
images

The Role of Digital Twins in Optimi...

Aeologic Technologie..

39

AI Inside
20 Sep 2024
images

Net Zero Emissions for IT companies...

Centaur Digital Pvt ..

40

AI
20 Sep 2024
images

Future Trends in Cloud Computing: W...

dilipguddappa

8

Cloud Computing
19 Sep 2024
images

AI-driven vulnerability scanning: A...

Opcito Technologies

15

Cyber Security ..
17 Sep 2024
images

From Diagnostics to Digital Care: H...

Dhiraj Sharma

40

Digital Transfo..
15 Sep 2024
images

Article: Forging resilient supply c...

Sigmoid

8

Data Science &a..
13 Sep 2024
images

AI for Legal Research: Use Cases, B...

Maruti Techlabs

24

Data Science &a..
13 Sep 2024
images

How Energy and Utilities Businesses...

Intelliswift Softwar..

59

Energy &amp; Ut..
09 Sep 2024
images

How to choose the right vulnerabili...

Opcito Technologies

10

Cyber Security ..
09 Sep 2024
images
Transforming Supply Chain Industry: The Impact Of Blockchain Revolution
images
Matt Murdock
@Matt_Murdock

06 Jan 2024

Blockchain

Blockchain technology offers several advantages that can significantly improve the efficiency, transparency, and security of the supply chain industry. Here are some ways in which blockchain enhances the supply chain: Transparency and Traceability…

Read More

images
The Future of Metaverse Development: What to Expect in 2024
images
Pooja Negi
@poojanegi

05 Jan 2024

Blockchain

  Let's begin this blog with an impressive quote from Dave Waters he said, 'The future of collaboration is the metaverse'.  The incidents happening around us are making this quote true in many aspects.  Tech giant Mark Zuckerberg rebranded his…

Read More

images
Understanding the role of Subgraphs in gaming application development
images
Zeeve
@Zeeve

28 Dec 2023

Blockchain

  Having access to specific and adequate amounts of data is vital for game application development. Data makes a game more functional, improves its design, identifies difficulties, and ultimately increases the user base. Subgraphs, powered by the…

Read More

images
How to scale your dApp with the power of zkRollups?
images
Zeeve
@Zeeve

27 Dec 2023

Blockchain

  Leveling blockchains as  the next big technology revolution with the innate capability of adding trust, transparency  and security for enterprise applications wouldn’t be an understatement. But to make this possible, we may need to come out of…

Read More

images
CDK Validium vs Polygon zkEVM Deployment– Differences explained
images
Zeeve
@Zeeve

26 Dec 2023

Blockchain

  CDK validium is currently the most interesting and highly feasible upgrade on the Polygon ecosystem. Validium is designed to enhance the existing scalability, security, and privacy capabilities of Polygon CDK. However, as a new concept, there’s a…

Read More

images
Avalanche Subnets vs Layer2 scaling solution— Key considerations for choosing one
images
Zeeve
@Zeeve

21 Dec 2023

Blockchain

  Scalability has always been a big concern for blockchain protocols. However, a range of powerful solutions have emerged to tackle the scalability issues of blockchain protocols. Layer-2 solutions and Avalanche Subnets are the widely popular…

Read More

About Us
Knowledge Center
In the News

© Copyright nasscom. All Rights Reserved.