Repository files navigation

Key Features •Project Documentation •Getting Started •Contributing •Credits •

This is work in progress, but the code is heavily documented. So far, the DHT ispretty stable with a full implementation of the Kademlia routing table and theKademlia protocol, with several of the optimizations recommended in the paper.

We have detailed guides for setting up an efficient development environment, thedevelopment process, project structure, etc. Take a look at the available guideshere.

In addition to that, specific documentation for the command line parser, itsusage and APIs, are provided in the project GitHub Pages sitehere.

It is strongly recommended that you take some time to browse the projectdocumentation to familiarize yourself with its structure and developmentworkflows.

Make sure you have a C++ compiler with C++-17 capabilities at least. Gnu, Clangand MSVC all can do that with a recent version.

git clone --recurse-submodules -j4 https://github.com/abdes/blocxxi.git

mkdir _build&&cd _build&& cmake ..&& cmake --build.

or just use one of the predefinedCMake presets. Detailed instructions are inthe project documentation, and many useful commands are listedhere.

# Project optionsoption(BUILD_SHARED_LIBS"Build shared instead of static libraries."ON)option(ASAP_BUILD_TESTS"Build tests."OFF)option(ASAP_BUILD_EXAMPLES"Build examples."OFF)option(ASAP_WITH_GOOGLE_ASAN"Instrument code with address sanitizer"OFF)option(ASAP_WITH_GOOGLE_UBSAN"Instrument code with undefined behavior sanitizer"OFF)option(ASAP_WITH_GOOGLE_TSAN"Instrument code with thread sanitizer"OFF)option(ASAP_WITH_VALGRIND"Builds targets with valgrind profilers added"OFF)

If you would like to contribute code you can do so through GitHub by forking therepository and sending a pull request. When submitting code, please make everyeffort to follow existing conventions and style in order to keep the code asreadable as possible.

By contributing your code, you agree to license your contribution under theterms of the BSD-3-Clause or a more permissive license. All files are releasedwith the BSD-3-Clause license.

Read thedeveloper guides.

• For every PR there should be an accompanying issue which the PR solves
• The PR itself should only contain code which is the solution for the givenissue
• If you are a first time contributor check if there is a suitable issue for you

In order to pull and merge updates from the upstream project, make sure to addit to the repo's remotes and disable pulling/merging tags from the upstream. Wewant tags to be limited to those made in this repo, not in the upstream.

git remote add upstream https://github.com/abdes/asap.gitgit config remote.upstream.tagopt --no-tags

• The multitude of other open-source projects used to implement this project orto get inspiration - credits in the source code or the documentation asappropriate