Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rtradeltd/libcp2p
A libp2p-like protocol with first class support for embedded systems. End goal is a protocol that can run on anything from your fridge, embedded systems, and anything else. Higher level languages bindings will be done via FFI. Heavy WIP
https://github.com/rtradeltd/libcp2p
c c-lang c-libp2p cid cmake cmocka doxygen embedded-c embedded-systems gcc ipfs ipld libp2p multiaddr multibase multicodec multiformats multihash valgrind
Last synced: 2 months ago
JSON representation
A libp2p-like protocol with first class support for embedded systems. End goal is a protocol that can run on anything from your fridge, embedded systems, and anything else. Higher level languages bindings will be done via FFI. Heavy WIP
- Host: GitHub
- URL: https://github.com/rtradeltd/libcp2p
- Owner: RTradeLtd
- License: agpl-3.0
- Created: 2020-07-12T07:38:12.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-11-12T08:12:54.000Z (about 4 years ago)
- Last Synced: 2024-04-14T22:52:18.765Z (9 months ago)
- Topics: c, c-lang, c-libp2p, cid, cmake, cmocka, doxygen, embedded-c, embedded-systems, gcc, ipfs, ipld, libp2p, multiaddr, multibase, multicodec, multiformats, multihash, valgrind
- Language: C
- Homepage: https://libcp2p.temporal.cloud
- Size: 75.7 MB
- Stars: 26
- Watchers: 5
- Forks: 2
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# libcp2p
[](https://travis-ci.com/RTradeLtd/libcp2p)
> **this is a work in progress**
A libp2p-like protocol written in C with first class support for embedded systems. Goal is to be able to run in your fridge, arduinos, and any embedded system. Higher level languages will be done using FFI.
# difference between libcp2p and libp2p
* Written in C
* Base58 replaced with base32
* Removal of built-in identify protocol
* LibP2P is heavily reliant on the identify protocol and it is not possible to remove it
* Redesigned so that identify is optional
* Protobuf replaced with cbor
* first class support for embedded systems
* higher level languages will use FFI instead of a language specific implementation
# compatability with libp2p
* in theory there will be network level compatability
* a libcp2p node would be able to open a connection to a libp2p node
* this is in no way a design goal, nor a priority
* dht will not be compatible
# features
## multiformats
* multicodec
* full encode/decode support for all codecs except 0xcert-imprint-256
* multiaddr
* full multiaddr functionality
* multihash
* basic multihash functionality, only supports SHAX-XXX, and Blake2B
* multibase
* supports base16, base32, base64
## peerstore
* Adds a peerstore to contain public key and peer identifier information
* Eventually will contain addressing information
## networking
* TCP socket server
* UDP has been tabled until we get a stable implementation of TCP
* Uses the multiaddress standard as the method of addressing other hosts
* Allows specifying two separate execution handlers whenever a new TCP connection is received
* todo:
* enable secure connections
* enable using peerIds
## misc
* cid
* basic support only
* protobuf support
* basic support only
* this will eventually be removed in favor of CBOR
* cryptography
* ecdsa key management
* sha1, sha256, sha512 hashing
* misc other crypto functionality
# installation
## building
```shell
$> make # builds in release mode
$> make build-debug # builds in debug mode
$> make build-analysis # builds in static analysis mode
```
## testing
```shell
$> cd build && ctest # runs regular tests
$> cd build && ctest -T memcheck # runs valgrind
```
## dependencies
* CMake >= 3.0
* GCC with support for C17
* If you want to run static analysis, GCC-10 installed
* CMocka (testing dependency)
* Valgrind (dynamic analysis)
* clang-format (code formatting)
* doxygen (documentation generation)
* pthreads
* tinycbor
* in repo using [this commit](https://github.com/intel/tinycbor/commit/085ca40781f7c39febe6d14fb7e5cba342e1804b)
# development/contribution
For instructions on development and contribution practices please see [CONTRIBUTING.md](CONTRIBUTING.md)
# license
Certain libraries are copy&pasted from other open sources repositories are explicitly licensed under MIT or GPLv3. The code written for this lbirary specifically is licensed under AGPLv3. [According to this stack overflow post](https://opensource.stackexchange.com/questions/5909/is-every-license-that-is-gplv3-compatible-also-agplv3-compatible/6785#6785) this is acceptable. If you think this is not acceptable please open a github issue and we will make ammends