Skip to content

Latest commit

 

History

History
43 lines (26 loc) · 1.47 KB

README.md

File metadata and controls

43 lines (26 loc) · 1.47 KB
Raw

Kademlia Simulator

Overview

This is a Kademlia Simulator that was used in the research project for the new Service Discovery in Ethereum 2.0 (Discv5) (available at: https://github.com/datahop/p2p-service-discovery). The simulator is built on top of PeerSim and it is based on the Kademlia implementation from Daniele Furlan and Maurizio Bonani that can be found here.

Requirements

To run the simulator it is necessary to have Java and Maven installed. For Ubuntu systems just run:

$ sudo apt install maven default-jdk

How to run it

To execut a simulation it is necessary to call the run.sh, with a configuration file as a parameter. For example:

$ ./run.sh config/kademlia.cfg

How to create your own scenario file

Follow PeerSim documentation

Contribution

If you want to contribute:

  • Fork the repo to your repo
  • Write your contribution
  • Rebase your code (here's a tutorial) to make sure the changes introduced into the main repo are take into account in your contribution
  • Create a pull request

Code Documentation

Kademlia draft documentation

Javadoc generated documentation

How to create a protocol on top of Kademlia

TBC