https://github.com/abdes/blocxxi
Implementation of Kademlia based DHT and a blockchain in C++
https://github.com/abdes/blocxxi
blockchain cplusplus dht imgui kademlia kademlia-dht network-programming p2p p2p-network
Last synced: about 1 year ago
JSON representation
Implementation of Kademlia based DHT and a blockchain in C++
- Host: GitHub
- URL: https://github.com/abdes/blocxxi
- Owner: abdes
- License: bsd-3-clause
- Created: 2018-06-17T14:07:51.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2023-04-09T14:01:27.000Z (about 3 years ago)
- Last Synced: 2025-03-30T10:51:12.626Z (about 1 year ago)
- Topics: blockchain, cplusplus, dht, imgui, kademlia, kademlia-dht, network-programming, p2p, p2p-network
- Language: C++
- Homepage:
- Size: 26.9 MB
- Stars: 24
- Watchers: 6
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# An implementation of Kademlia DHT and Blockchain in C++
-+- Build Status -+-
_develop_
[![Build status - develop][build-status-develop-badge]][build-matrix]
_master_
[![Build status - master][build-status-master-badge]][build-matrix]
-+-
[![Latest release][release-badge]][latest-release]
[![Commits][last-commit-badge]][commits]
[![Linux][linux-badge]][latest-release]
[![Windows][windows-badge]][latest-release]
[![Mac OS][macos-badge]][latest-release]
[![License][license-badge]][license]
[![CII Best Practices][openssf-badge]][openssf-project]
Key Features •
Project Documentation •
Getting Started •
Contributing •
Credits •
## Key Features
This is work in progress, but the code is heavily documented. So far, the DHT is
pretty stable with a full implementation of the Kademlia routing table and the
Kademlia protocol, with several of the optimizations recommended in the paper.
## Project Documentation
We have detailed guides for setting up an efficient development environment, the
development process, project structure, etc. Take a look at the available guides
[here](https://abdes.github.io/asap/asap_master/html/).
In addition to that, specific documentation for the command line parser, its
usage and APIs, are provided in the project GitHub Pages site
[here](https://abdes.github.io/blocxxi/blocxxi_master/html/).
## Getting Started
It is strongly recommended that you take some time to browse the project
documentation to familiarize yourself with its structure and development
workflows.
Make sure you have a C++ compiler with C++-17 capabilities at least. Gnu, Clang
and MSVC all can do that with a recent version.
```bash
git clone --recurse-submodules -j4 https://github.com/abdes/blocxxi.git
```
```bash
mkdir _build && cd _build && cmake .. && cmake --build .
```
or just use one of the predefined `CMake` presets. Detailed instructions are in
the project documentation, and many useful commands are listed
[here](https://abdes.github.io/asap/asap_master/html/getting-started/useful-commands.html).
## CMake configurable build options
```cmake
# Project options
option(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)
```
## Contributing
If you would like to contribute code you can do so through GitHub by forking the
repository and sending a pull request. When submitting code, please make every
effort to follow existing conventions and style in order to keep the code as
readable as possible.
By contributing your code, you agree to license your contribution under the
terms of the BSD-3-Clause or a more permissive license. All files are released
with the BSD-3-Clause license.
Read the [developer guides](https://abdes.github.io/asap/asap_master/html/).
### Submitting a PR
- 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 given
issue
- If you are a first time contributor check if there is a suitable issue for you
## Getting updates from upstream [`asap`](https://github.com/abdes/asap)
In order to pull and merge updates from the upstream project, make sure to add
it to the repo's remotes and disable pulling/merging tags from the upstream. We
want tags to be limited to those made in this repo, not in the upstream.
```bash
git remote add upstream https://github.com/abdes/asap.git
git config remote.upstream.tagopt --no-tags
```
## Credits
- The multitude of other open-source projects used to implement this project or
to get inspiration - credits in the source code or the documentation as
appropriate
[build-matrix]: https://github.com/abdes/blocxxi/actions/workflows/cmake-build.yml?branch=develop
[build-status-develop-badge]: https://github.com/abdes/blocxxi/actions/workflows/cmake-build.yml/badge.svg?branch=develop
[build-status-master-badge]: https://github.com/abdes/blocxxi/actions/workflows/cmake-build.yml/badge.svg?branch=master
[commits]: https://github.com/abdes/blocxxi/commits
[last-commit-badge]: https://img.shields.io/github/last-commit/abdes/blocxxi
[latest-release]: https://github.com/abdes/blocxxi/releases/latest
[license-badge]: https://img.shields.io/github/license/abdes/blocxxi
[license]: https://opensource.org/licenses/BSD-3-Clause
[linux-badge]: https://img.shields.io/badge/OS-linux-blue
[macos-badge]: https://img.shields.io/badge/OS-macOS-blue
[openssf-badge]: https://bestpractices.coreinfrastructure.org/projects/6500/badge
[openssf-project]: https://bestpractices.coreinfrastructure.org/projects/6500
[release-badge]: https://img.shields.io/github/v/release/abdes/blocxxi
[windows-badge]: https://img.shields.io/badge/OS-windows-blue