Skip to content

Latest commit

 

History

History
61 lines (44 loc) · 4.56 KB

README.md

File metadata and controls

61 lines (44 loc) · 4.56 KB
Raw

Overview

The Blockchain Benchmarking Framework will focus on the development of a user-friendly UI that abstracts the underlying complexities of blockchain technology and allows the user to have a seamless and easy interaction with the framework. The goal of the project is to enable usability for: (a) the demand (i.e., developers, technical teams, managers), (b) the supply (i.e., organizations and companies that provides data and/or services and wish to adopt blockchain technology) and (c) the academic (i.e., researchers, students, educators).

Instructions

To execute the FLASK API you should execute with admin privileges the initialize.sh ( sudo ./initialize.sh ) file under the main folder. In case the css and Js is not working properly please execute in the terminal the following commands:

  1. docker exec -it bbf-gui-apis /bin/bash
  2. cd static
  3. npm install
  4. gulp

The swagger URL is the: i) private- [localhost/swagger] ii) public - [http://bbf-gui.ddns.net/swagger] .

The main page is the: i) private- [localhost/home] ii) public [http://bbf-gui.ddns.net/] .

For each API type the prefered network. The list of the avialable networks can be seen by the "list" API.

Model Architecture

Files description

  • app.py: the main file that operates the flask api and combines all the components
  • defaults.env: enviroment viariables for the Docker/FLASK API (dockerized)
  • docker-compose: The docker-compose file that enables docker-compose command and builds the docker filer
  • static/swagger.json: Swagger is a set of open-source tools built around the OpenAPI Specification that can help design, build, document and consume REST APIs. swagger.json file is required to parameterize the apis and return the outputs.
  • routes/request_api.py: Is responsible for the controller (./control.sh) of the BBF. It executes the basic commands
  • routes/docker_api.py: Contains docker related apis (e.g., uptime, network, memory usage etc)
  • routes/traffic_monitor_apis.py: Contains traffic and node related APIs. It can create traffic, return node's information and account information.
  • templates: All the available pages of the BBF Web application
  • static: Node modules, JS and CSS requirements with Gulp file.
  • initialize.sh: The init point. User has to start this file with the './initialize.sh' in order to deploy & start the BBF Web application
  • entrypoint.sh: This file is running in the docker container and builds the node modules, the gulp file and the flask apis.

Case study workflow of configuring new network on Benchmarking Engine

Contributors

  • Marios Touloupos ( @mtouloup ) - UBRI Fellow Researcher / PhD Candidate, University of Nicosia - Institute for the Future ( UNIC -IFF)
  • George Michoulis ( @gmixoulis ) - Full Stack / Blockchain Developer, University of Nicosia - Institute for the Future ( UNIC -IFF)
  • Evgenia Kapassa ( @ekapassa ) - Researcher / PhD Candidate, University of Nicosia - Institute for the Future ( UNIC -IFF)
  • Dr. Klitos Christodoulou ( @klitoschr ) - Project Lead, University of Nicosia - Institute for the Future ( UNIC -IFF)

Research Team

Acknowledgements

The project is funded by the Ripple’s Impact Fund, an advised fund of Silicon Valley Community Foundation (Grant id: 2018–188546, 2021-244121). The UI module of the project has successfully received funding from the XRP Ledger (XRPL) Developer Program, Wave 2 grants offered by Ripple Labs Inc.

About IFF

IFF is an interdisciplinary research centre, aimed at advancing emerging technologies, contributing to their effective application and evaluating their impact. The general mission at IFF is to educate leaders, develop knowledge and build communities to help society prepare for a future shaped by transformative technologies. The institution has been engaged with the community since 2013 offering the World’s First Massive Open Online Course (MOOC) on blockchain and cryptocurrency for free, supporting the community and bridging the educational gap on blockchains and digital currencies.