Skip to content

wangqinghao123/PCNSim

 
 

Repository files navigation

PCNsim: Payment Channel Network Simulator

Documentation Status

This project presents PCNsim, an open-source, modular, and lightweight payment channel network simulator. For more information, you can visit our website or the official PCNsim documentation. PCNsim is designed to support multiple routing algorithms, topologies, and transactions workloads to meet the requirements of PCN researchers.

PCNsim presents a unique simulator that accuratly mimics the behavior of the Lightning Network, such as message formats and message exchange.

Requirements

Our PCN implementation uses Python 3 to implement the topology and workload generators. Furthermore, we use the NetworkX to create the network topology and Click. We assume that you already have Python 3 and pip installed in your computer. To install the necessary requirements, run the following command at the pcnsim directory:

pip install -r requirements.txt

PCNsim also runs over OMNET++ network simulator to deliver an interactive user-friendly interface and a modular architecture. You can find informations on how to install OMNET++ at the official OMNET++ documentation page.

Publications

A demo paper of this project was accepted for publication at the IEEE INFOCOM 2022.

Rebello, G. A. F., Camilo, G. F., Potop-Butucaru, M., Campista, M. E. M., de Amorim, M. D., Costa, L. H. M. K. - "PCNsim: A Flexible and Modular Simulator for Payment Channels Network", in Demos of the IEEE INFOCOM, May 2022, London, United Kingdom.

About

PCNSim is a payment channel network simulator that uses the OMNET++ framework. You can see more information on the official documentation: https://pcnsim.readthedocs.io/en/latest/

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • C++ 93.4%
  • Python 5.1%
  • Makefile 1.3%
  • C 0.2%