BlockCompass is a benchmarking performance tool for blockchain platforms. Currently Hyperledger Fabric, Hyperledger Sawtooth and Ethereum are supported. BlockCompass supports multiple performance indicators including resource consumption (CPU, Memory, Network Input and Network Output), latency, transmission rate, throughput and error rate. It also provides a real time chart and the possibility to export a detailed report.

Ethereum Clique: https://youtu.be/R91RybpXbVA

Hyperledger Fabric: https://youtu.be/Jgzrq-yXcj4

User manual: https://drive.google.com/file/d/1sVX8OzQ6ShL_ftaTozEth3tf3ZkX_oCs/view?usp=sharing

OS => Ubuntu 18.04

CPU => 2 vCPUs

Memory => 8GB RAM

Disk Space => 25 GB (Might need more for Ethereum Proof Of Work)

sudo apt update 
sudo apt install apt-transport-https ca-certificates 
curl software-properties-common
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu bionic stable"
sudo apt update
sudo apt install docker-ce  

sudo usermod -aG docker ${USER}
su - ${USER}

sudo curl -L https://github.com/docker/compose/releases/download/1.21.2/docker-compose-`uname -s`-`uname -m` -o /usr/local/bin/docker-compose
sudo chmod +x /usr/local/bin/docker-compose

 cd ~
curl -sL https://deb.nodesource.com/setup_10.x -o nodesource_setup.sh
sudo bash nodesource_setup.sh
sudo apt install nodejs
sudo apt install build-essential

sudo apt update
sudo apt -y upgrade

sudo apt install -y python3-pip
sudo apt install libssl-dev libffi-dev python3-dev 
sudo apt install -y python3-venv

sudo apt install mongodb-clients

git clone https://github.com/polytechnique-ease/blockcompass

cd blockcompass
python3 -m venv env
source env/bin/activate
pip install -r requirements.txt

sudo apt install mongodb-clients

   curl -sSL https://bit.ly/2ysbOFE | bash -s -- 2.2.2 1.4.9

sudo nano ~/.profile
  
## At the end of the file, add this line:
export PATH=<path to fabric-sample location>/bin:$PATH
  
source ~/.profile

cd ~
curl -O https://dl.google.com/go/go1.17.linux-amd64.tar.gz
tar xvf go1.17.linux-amd64.tar.gz
sudo chown -R root:root ./go
sudo mv go /usr/local
sudo nano ~/.profile
  
## At the end of the file, add this line:
export PATH=$PATH:/usr/local/go/bin
  
source ~/.profile

sudo nano ~/.profile
  
## At the end of the file, add this line:
export FABRIC_CFG_PATH=<Absolute PATH to iot-docker-mongoDB folder>/networks/fabric-v2.2/config

source ~/.profile

• Backend: Server implementation using Express.js in JavaScript.

• /configuration: Holds the main configuration file and the contractABI for Ethereum.

• /eth-client-js: Ethereum client adapter, an Express.js server implemented in JavaScript. Uses raw JSON RPC for Ethereum transactions. Requires unlocked accounts.
• /eth-web3-client: Another Ethereum client adapter using Web3.js. This implementation is still under development but does not require an unlocked account.

• /front: Frontend client folder built with Angular 10.

• /monitor: Resource monitor that runs a Python script to call docker stats every 10 seconds.
  • /logs: Contains output and error logs.

• /networks: Sample networks folder.
• /contracts: Contract implementations for Ethereum and Hyperledger Fabric.
  • /ethereum-clique: Sample for Ethereum Clique (PoA) network.
    • /bootnode: Dockerfile for bootnode.
    • /miner: Genesis and Dockerfile for miner.
    • /docker-compose.yml: Docker-compose file for a 5-node Ethereum clique network.

• /fabric-v2.2: Hyperledger Fabric Network sample.
  • /docker: Docker-compose files for each peer.
• /services:
  • /enrollAdmin.js: Script to enroll admin.
  • /block-server.js: Script to register a user to org 1.
  • /txn-server.js: Hyperledger Fabric client adapter, an ExpressJS server.

• /sawtooth_v1_2: Hyperledger Sawtooth Network sample.
  • /kvstoreprocess: KVSTORE transaction family.
  • /rest_api: Hyperledger Sawtooth Fabric adapter.
  • /docker-compose-pbft.yaml: Docker-compose for 5-node network with PBFT consensus.
  • /docker-compose-poet.yaml: Docker-compose for 5-node network with PEoT consensus.
  • /docker-compose-raft.yaml: Docker-compose for 5-node network with Raft consensus.

• /workload: Workload client implementation.
  • /dockers:
    • /IoT: Contains workload logic and user management.
    • /web: NGINX server for transactions.
  • /IoT: Configuration for workload clients.

• Clean.sh: Bash script to clean up containers and services.
• Docker-compose-mongo-replicaset.yml: Docker-compose file for MongoDB replica set with three members.
• Launcher.py: Python script to start the experiment.
• replicaset.sh: Bash script to initialize the MongoDB replica set.

replicaSet:

chmod +x replicaset.sh

You can cite the following papers for this project:
1- Rasolroveicy, M., & Fokaefs, M. (2020, November). Dynamic reconfiguration of consensus protocol for IoT data registry on blockchain. In Proceedings of the 30th Annual International Conference on Computer Science and Software Engineering (pp. 227-236).

2- Rasolroveicy, Mohammadreza, Wejdene Haouari, and Marios Fokaefs. "Public or private? a techno-economic analysis of blockchain." Proceedings of the 31st Annual International Conference on Computer Science and Software Engineering. 2021

References:
Ramprasad, B., Fokaefs, M., Mukherjee, J., & Litoiu, M. (2019, June). EMU-IoT-A Virtual Internet of Things Lab. In 2019 IEEE International Conference on Autonomic Computing (ICAC) (pp. 73-83). IEEE.