README.md

⛔ [DEPRECATED] Active at https://github.com/UniversityOfNicosia/blockchain-benchmarking-framework-1

Blockchain Benchmarking Framework

Backbone scripts and configuration for Blockchain Benchmarking Framework.

Add a non-existing repo

*prepare_network_plugin.sh* prepares the files for the testnet plugin.
It adds the testnet as submodule to the existing repository and checks it out to the correct branch/tag.
Usage : prepare_network_plugin.sh <preparation type> <name>
Actions:
  network    <network-name> --git-url|-u <giturl> --git-branch|-b <gitbranch>
       Sets up the network plugin. --git-url and --git-branch are optional for external networks plugins. 
  traffic_generator  <name> --git-url <giturl>  --git-branch|-b <gitbranch>
       Sets up the traffic generator plugin. --git-url and --git-branch are optional for external traffic generator plugins. 
  scenario  <name> --git-url <giturl>  --git-branch|-b <gitbranch>
       Sets up the scenario plugin. --git-url and --git-branch are optional for external scenario plugins. 
  monitoring_stack  <name> --git-url <giturl>  --git-branch|-b <gitbranch>
       Sets up the monitoring_stack plugin. --git-url and --git-branch are optional for external monitoring_stack plugins. 
  show_known_networks
  show_known_traffic_generators
  show_known_monitoring_stacks
  show_known_scenarios
       Displays a list of known networks/traffic_generators/monitoring_stacks/scenarios

Using the framework

control.sh script is used to control the networks.

control.sh is the main control script for the Blockchain Benchmarking Framework.
Usage : control.sh <network-type> <action> <arguments>

Network types:
  --list-network-types|-list
       Prints a list of the supported  network types
  --all|-a
       Runs the action for the  network of each supported type for the given arguments
  <network-type>
       Runs the action for the given network type. If there is no such type, it exits with error.
  --start-monitoring-stack|-mon
       Starts the monitoring stack
Actions:
  start     --val-num|-n <num of validators>
       Starts a network with <num_validators> 
  configure --val-num|-n <num of validators>
       configures a network with <num_validators> 
  stop
       Stops the running networks
  clean
       Cleans up the configuration directories of the networks
  status
       Prints the status of the networks

Authors/Contributors

• Antonios Inglezakis (@antiggl) [ [email protected] ]
• Marios Touloupou (@mtouloup) [ [email protected] ]

Research Team

• Marios Touloupou (@mtouloup) [ [email protected] ]
• Antonios Inglezakis (@antiggl) [ [email protected] ]
• Klitos Christodoulou [ [email protected] ]
• Elias Iosif [ [email protected] ]

UBRI Funding

This work is funded by the Ripple’s Impact Fund, an advised fund of Silicon Valley Community Foundation (Grant id: 2018–188546). Link: University Blockchain Research Initiative