Proof-of-work as a means to rate-limit the network

Table of Contents

• Installing the library
  • From source code
  • From GitHub releases
• Adding the libraries to your CMake project
• API reference
• Contributing

This repo implements a library to perform Proof of Work (PoW) following this TIP.

Installing the library

From source code

git clone https://github.com/EddyTheCo/Qpow-IOTA.git 
 
mkdir build
cd build
qt-cmake -G Ninja -DCMAKE_INSTALL_PREFIX=installDir -DUSE_THREADS=ON -DCMAKE_BUILD_TYPE=Release -DBUILD_TESTING=OFF -DBUILD_DOCS=OFF ../Qpow-IOTA
 
cmake --build . 
 
cmake --install . 

where installDir is the installation path. One can choose to build or not the tests and the documentation with the BUILD_TESTING and BUILD_DOCS variables. The use or not of multithreading is set by the USE_THREADS variable.

From GitHub releases

Download the releases from this repo.

Adding the libraries to your CMake project

include(FetchContent)
FetchContent_Declare(
    QtIotaPow   
    GIT_REPOSITORY https://github.com/EddyTheCo/Qpow-IOTA.git
    GIT_TAG vMAJOR.MINOR.PATCH 
    FIND_PACKAGE_ARGS MAJOR.MINOR CONFIG  
    )
FetchContent_MakeAvailable(QtIotaPow)
target_link_libraries(<target> <PRIVATE|PUBLIC|INTERFACE> QtIotaPow::qpow)

API reference

You can read the API reference, or generate it yourself like

cmake -DBUILD_DOCS=ON ../
cmake --build . --target doxygen_docs

Contributing

We appreciate any contribution!

You can open an issue or request a feature. You can open a PR to the develop branch and the CI/CD will take care of the rest. Make sure to acknowledge your work, and ideas when contributing.