status-im
/
nim-libp2p
mirror of https://github.com/status-im/nim-libp2p.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
libp2p implementation in Nim https://status-im.github.io/nim-libp2p/docs/
935 Commits 148 Branches 6 Tags 126 MiB
Nim 99.8%
Shell 0.1%
Go to file
Giovanni Petrantoni 05e789a34f
Gossipsub refactor (#490) 
* refactor peerStats, re-enable scores for testing

* remove gossip 1.0

* cleanup

* codecov matrix fixes

* restore previous score on onNewPeer

* fix coverage n checks

* unsubscribeAll gossipsub fixes

* refactor unsub/sub

* refactor onNewPeer and fix score flow

* disable scores by default (change in tests later)

* fix tests, enable scores in tests

* fix wrongly merged test

* ensure topic removal from topics table

* small typo fix

* testinterop fixes
 		2020-12-19 15:43:32 +01:00
.github/workflows Gossipsub refactor (#490) 2020-12-19 15:43:32 +01:00
docs replace nim-beacon-chain URLs with nimbus-eth2 URLs (#396) 2020-10-09 18:02:03 +02:00
examples Gossip one one (#240) 2020-09-21 11:16:29 +02:00
libp2p Gossipsub refactor (#490) 2020-12-19 15:43:32 +01:00
scripts Gossip one one (#240) 2020-09-21 11:16:29 +02:00
tests Gossipsub refactor (#490) 2020-12-19 15:43:32 +01:00
tools Add `libp2p_dump` and `libp2p_dump_dir` compiler time options. (#359) 2020-09-15 11:16:43 +02:00
.appveyor.yml Gossip one one (#240) 2020-09-21 11:16:29 +02:00
.gitignore Gossip one one (#240) 2020-09-21 11:16:29 +02:00
.travis_deactivated.yml Rm bearssl + Deactivate Travis completely (#477) 2020-12-10 14:19:27 +01:00
LICENSE Initial commit 2018-11-19 03:58:31 +02:00
LICENSE-APACHEv2 Initialize travis and licenses. 2018-11-19 04:04:47 +02:00
LICENSE-MIT Initialize travis and licenses. 2018-11-19 04:04:47 +02:00
README.md fix invalid README hyperlink by adding https prefix (#492) 2020-12-19 09:31:35 +01:00
azure-pipelines.yml defaultMsgIdProvider alternative/test anonymize (#379) 2020-09-28 09:11:18 +02:00
codecov.yml Gossipsub refactor (#490) 2020-12-19 15:43:32 +01:00
libp2p.nim Fixes and tweaks related to the beacon node integration 2019-12-08 23:58:43 +02:00
libp2p.nimble Gossipsub refactor (#490) 2020-12-19 15:43:32 +01:00

README.md

libp2p hex logo

The Nim implementation of the libp2p Networking Stack.

Introduction

An implementation of libp2p in Nim. Also provides a Nim wrapper of the Libp2p Go daemon.

Project Status

The current native Nim libp2p implementation support is experimental and shouldn't be relied on for production use. It is under active development and contributions are highly welcomed. :)

Check our examples folder to get started!

Table of Contents

Background

libp2p is a networking stack and library modularized out of The IPFS Project, and bundled separately for other tools to use.

libp2p is the product of a long and arduous quest of understanding; a deep dive into the internet's network stack and the peer-to-peer protocols from the past. Building large scale peer-to-peer systems has been complex and difficult in the last 15 years and libp2p is a way to fix that. It is a "network stack", a suite of networking protocols that cleanly separates concerns and enables sophisticated applications to only use the protocols they absolutely need, without giving up interoperability and upgradeability.

libp2p grew out of IPFS, but it is built so that lots of people can use it, for lots of different projects.

  • Learn more about libp2p at libp2p.io and follow our evolving documentation efforts at docs.libp2p.io.
  • Here is an overview of libp2p and its implementations in other programming languages.

Install

nimble install libp2p

Prerequisite

Usage

API

The specification is available in the docs/api folder.

Getting Started

Please read the GETTING_STARTED.md guide.

Tutorials and Examples

Example code can be found in the examples folder.

Direct Chat Tutorial

  • Part I: Set up the main function and use multi-thread for processing IO.
  • Part II: Dial remote peer and allow customized user input commands.
  • Part III: Configure and establish a libp2p node.

Using the Go Daemon

Please find the installation and usage intructions in daemonapi.md.

Examples can be found in the examples/go-daemon folder;

Development

Clone and Install dependencies:

git clone https://github.com/status-im/nim-libp2p
cd nim-libp2p
nimble install

Tests

Prerequisite

Run unit tests

# run all the unit tests
nimble test

Packages

List of packages currently in existence for nim-libp2p:

Libp2p

Transports

Secure Channels

Stream Multiplexers

Utilities

Data Types

Pubsub

Packages that exist in the original libp2p specs and are under active development:

  • libp2p-daemon
  • libp2p-webrtc-direct
  • libp2p-webrtc-star
  • libp2p-websockets
  • libp2p-spdy
  • libp2p-bootstrap
  • libp2p-kad-dht
  • libp2p-mdns
  • libp2p-webrtc-star
  • libp2p-delegated-content-routing
  • libp2p-delegated-peer-routing
  • libp2p-nat-mgnr
  • libp2p-utils

** Note that the current stack reflects the minimal requirements for the upcoming Eth2 implementation.

Tips and tricks

  • enable expensive metrics:
nim c -d:libp2p_expensive_metrics some_file.nim

Contribute

The libp2p implementation in Nim is a work in progress. We welcome contributors to help out! Specifically, you can:

  • Go through the modules and check out existing issues. This would be especially useful for modules in active development. Some knowledge of IPFS/libp2p may be required, as well as the infrastructure behind it.
  • Perform code reviews. Feel free to let us know if you found anything that can a) speed up the project development b) ensure better quality and c) reduce possible future bugs.
  • Add tests. Help nim-libp2p to be more robust by adding more tests to the tests folder.

Core Developers

@cheatfate, Dmitriy Ryajov, Giovanni Petrantoni, Zahary Karadjov

License

Licensed and distributed under either of

or

at your option. These files may not be copied, modified, or distributed except according to those terms.