web3j / libp2p

libp2p implementation in Kotlin for JVM platforms

Archive Notice

This project is no longer under active development and has been archived. The repository is kept for historical purposes and read-only access. No further updates or pull requests will be considered.

The JVM (Java, Android, Kotlin) implementation of the libp2p Networking Stack.

Background

web3j-libp2p is an implementation of the libp2p modular network stack for the Java virtual machine.

Its goal is to provide a single implementation that meets the needs of Java, Android and Kotlin developers. It is written in Kotlin which was designed with Java and Android interop in mind.

The project was created by Web3 Labs with the support of the Ethereum Community Fund and advisory from members of the libp2p team at Protocol Labs.

Getting started

Versioned releases and regular snapshots will be available shortly for the various libp2p modules. Until that time, please clone the repo and you can build the artifacts yourself:

git clone https://github.com/web3j/libp2p.git
cd libp2p
./gradlew build publishToMavenLocal

Contribute

We welcome contributions from everyone.

We are currently prioritising implementation of the libp2p modules that are required for eth2.0's Serenity release. As it currently stands they are (taken from the following issue):

Library	Module	Available
Multiformat	Multiaddr	✅
	Multihash	✅
General Purpose	Net	✅
	Peer	✅
	Crypto	✅
Protocol Muxer	Multistream(-select)
Stream Muxer	Multiplex
Crypto Channels	SecIO
Transport	TCP	⏳
Network Abstraction	Switch/Swarm
Peerstore	Local database backend (KV store or SQLite)
Protocols	Ping
	Identify
Host Abstraction		✅
NAT traversal
Others	Floodsub/Gossipsub (w/signed message records)
Peer Routing	kad-dht
Discovery	Find_node (or whatever is chosen)

We recommend before starting work on a contribution that you communicate with the libp2p JVM community on the Gitter channel to express your intent to ensure no-one is already working on it.

Additionally, keep an eye on the open Pull Requests and branches to see what others are working on.

Also, please do review the project issues to identify any low hanging fruit you can get started with!

Build instructions

git clone https://github.com/web3j/libp2p.git
cd libp2p
./gradlew build publishToMavenLocal

libp2p's Issues

Missing examples

Do you have any plans regarding add examples to project?

Should we work on master?

Most of the heavy lifting it's happening in the feature/interface-definitions branch. Since no one is depending yet on this project, I wonder if it makes sense to bring activity into master.

The reason is that, at first sight, this repo gives the impression of being inactive, since Github displays the default branch (master). As of today the last commit there is from 1 February.

Remove the lib folder once 3rd party libs are in a maven repo

There are some files that are not in a maven repository, instead these files have been committed alongside the code as a stop-gap measure until they are made publicly available.

These files can be found in the lib folder, at the time of this issue the dependencies are:

1. bcprov-jdk15-on-161b20.jar: There are some classes (e.g.ECParameterSpec) that are only provided in 161-beta; we will revert this once this has been published
2. kotlin-multibase-1.1.0.jar: This doesn't appear to be available in any maven public repo, but is a compile-time dependency for kotlin-multiaddr

Rename to jvm-libp2p

Could we rename this repo to jvm-libp2p to denote that this is a JVM implementation? This also paves the way for pulling it into the libp2p org in the future, as it matures.

Needs LICENSE file

first of all: really great to see this project - very exciting!

But this project really needs a license file for using the project and contributing to it

Please update Bouncy Castle

Please update Bouncy Castle

• https://www.bouncycastle.org/
• https://www.bouncycastle.org/releasenotes.html
• http://www.bouncycastle.org/latest_releases.html
• https://cve.mitre.org/cgi-bin/cvekey.cgi?keyword=bouncy%20castle
• https://cve.mitre.org/cgi-bin/cvekey.cgi?keyword=bouncycastle
• https://www.cvedetails.com/vulnerability-list/vendor_id-7637/Bouncycastle.html

Here:

• https://github.com/web3j/libp2p/blob/master/build.gradle#L9