rec_dlt

• Usage instructions
• Prerequisites
• Installation Steps
  • 1. Fabric Network Setup
  • 2. Organization and Client Api Setup
  • 3. Organization Interface Setup
  • 4. Client Interface Setup
  • 5. CSV data generation
  • 6. Realtime api to send data
• Troubleshooting on starting fabric network
• Architecture
• Components
• API Documentation
• Scenario

This guide covers the installation and setup process for the REC System, including agent configuration and Fabric network deployment.

• Ubuntu version = 22.04

• Node.js version = 20.10

• Docker

• Add docker to sudo group to use docker without using sudo

• Redis server

  • using docker

      docker run --name redis-server -p 6379:6379 -d redis

• Install JQ by running command sudo apt install -y jq

The following steps will set up and configure the Fabric network:

1. Copy the .env.sample file to a new .env file, and update all path variables according to your local setup.

cd service/rec/server
cp .env.sample .env

Do not forget to change the path variables

2. Run installPrerequisite.sh once during the initial server setup to install all necessary dependencies:

cd service/rec
./installPrerequisite.sh

3. Start the Hyperledger Fabric network and deploy the chaincode:

./startNetwork.sh

4. A Redis server must be running either on Docker or localhost using the default port. To start a Redis server using Docker:

docker run --name redis-server -p 6379:6379 -d redis

5. Start the server. This will also start the Fabric Subscriber Service which is connected with the REC Agent (Publisher)

cd service/rec/server
npm run dev

Fabric server will run at PORT 3005

1. Navigate to the agent directory and install dependencies. This SDK includes both REC Agent and Client Agent functionalities.

cd agent
npm install

2. Add the following variables to your .env file:

FABRIC_API='http://localhost:3005'

3. Start an organization api:

npm run org <email> <port>

4. Start a client api:

npm run client <email> <port>

Replace <email> with the actual email of the organization or client, and <port> with the port number on which you want the API to run. Example: npm run org org1@rec.com 5000 or npm run client client1@rec.com 5001

Configure and start the Organization Interface as follows:

1. Add the following variables to your .env file:

FABRIC_API=http://localhost:3005

2. Navigate to the organizationInterface directory, install dependencies, and start the interface server:

cd ../organizationInterface
npm install
npm run dev

Organization Interface server will run on port 3000

• Please open the client and organization interface in a separate window (not a separate tab, same window) or browser for each client and organization at the same time. This may cause a conflict with the local storage data of separate clients or organizations in the browser.

Configure and start the Client API as follows:

1. Add the following variables to your .env file:

JWT=secret
FABRIC_API=http://localhost:3005

2. Navigate to the clientInterface directory, install dependencies, and start the interface server:

cd ../clientInterface
npm install
npm run dev

Client Interface server will run on port 3001

1. Navigate to data directory and install dependencies

cd data
npm install

2. Run this command to generate data

npm run dataGenerate

3. You can view data format in rec2.csv file
4. To understand to process of data generation, view data-gen.js file.

1. Navigate to data directory and install dependencies

cd data
npm install

2. Copy environment data from .env.sample

cp .env.sample .env
npm run repeatedApiCall

3. .env.sample conatins all the variables needed to run the realtime api call. Please carefully set the variables in .env file.
4. To understand to process of realtime api call, view repeatedApiCaller.js file.

If there is an issue with "Peer binary and configuration files not found..", please follow this instructions otherwise leave it.

1. Stop all running docker containers and clear docker images and containers by running docker system prune -a.
2. Clone the fabric sample with fabric version 2.5.2 and fabric-ca-version 1.5.6 in a separate directory.

curl -sSL https://raw.githubusercontent.com/hyperledger/fabric/master/scripts/bootstrap.sh | bash -s -- 2.5.2 1.5.6

2. Copy the bin file from fabric-samples directory and replace rec_dlt/service/bin with it.

• Interface
• Agents
• Fabric API
• Message Broker