https://github.com/libp2p/jvm-libp2p
a libp2p implementation for the JVM, written in Kotlin 🔥
https://github.com/libp2p/jvm-libp2p
Last synced: 8 months ago
JSON representation
a libp2p implementation for the JVM, written in Kotlin 🔥
- Host: GitHub
- URL: https://github.com/libp2p/jvm-libp2p
- Owner: libp2p
- License: apache-2.0
- Created: 2019-05-29T20:28:05.000Z (over 6 years ago)
- Default Branch: develop
- Last Pushed: 2025-05-01T07:31:17.000Z (8 months ago)
- Last Synced: 2025-05-01T08:29:12.383Z (8 months ago)
- Language: Kotlin
- Homepage: https://libp2p.io
- Size: 2.68 MB
- Stars: 298
- Watchers: 23
- Forks: 78
- Open Issues: 35
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
Awesome Lists containing this project
- awesome-java - JVM Libp2p
README
# jvm-libp2p
[](https://libp2p.io/)
[](https://gitter.im/jvm-libp2p/community)
[](http://webchat.freenode.net/?channels=%23libp2p)
[](https://discuss.libp2p.io)
[Libp2p](https://libp2p.io/) implementation for the JVM, written in Kotlin 🔥
## Components
List of components in the Libp2p spec and their JVM implementation status
| | Component | Status |
|--------------------------|-------------------------------------------------------------------------------------------------|:----------------:|
| **Transport** | tcp | :green_apple: |
| | [quic](https://github.com/libp2p/specs/tree/master/quic) | :tomato: |
| | websocket | :lemon: |
| | [webtransport](https://github.com/libp2p/specs/tree/master/webtransport) | |
| | [webrtc-browser-to-server](https://github.com/libp2p/specs/blob/master/webrtc/webrtc-direct.md) | |
| | [webrtc-private-to-private](https://github.com/libp2p/specs/blob/master/webrtc/webrtc.md) | |
| **Secure Communication** | [noise](https://github.com/libp2p/specs/blob/master/noise/) | :green_apple: |
| | [tls](https://github.com/libp2p/specs/blob/master/tls/tls.md) | :lemon: |
| | [plaintext](https://github.com/libp2p/specs/blob/master/plaintext/README.md) | :lemon: |
| | [secio](https://github.com/libp2p/specs/blob/master/secio/README.md) **(deprecated)** | :green_apple: |
| **Protocol Select** | [multistream](https://github.com/multiformats/multistream-select) | :green_apple: |
| **Stream Multiplexing** | [yamux](https://github.com/libp2p/specs/blob/master/yamux/README.md) | :lemon: |
| | [mplex](https://github.com/libp2p/specs/blob/master/mplex/README.md) | :green_apple: |
| **NAT Traversal** | [circuit-relay-v2](https://github.com/libp2p/specs/blob/master/relay/circuit-v2.md) | :lemon: |
| | [autonat](https://github.com/libp2p/specs/tree/master/autonat) | :lemon: |
| | [hole-punching](https://github.com/libp2p/specs/blob/master/connections/hole-punching.md) | |
| **Discovery** | [bootstrap](https://github.com/libp2p/specs/blob/master/kad-dht/README.md#bootstrap-process) | |
| | random-walk | |
| | [mdns-discovery](https://github.com/libp2p/specs/blob/master/discovery/mdns.md) | :lemon: |
| | [rendezvous](https://github.com/libp2p/specs/blob/master/rendezvous/README.md) | |
| **Peer Routing** | [kad-dht](https://github.com/libp2p/specs/blob/master/kad-dht/README.md) | |
| **Publish/Subscribe** | floodsub | :lemon: |
| | [gossipsub](https://github.com/libp2p/specs/tree/master/pubsub/gossipsub) | :green_apple: |
| **Storage** | record | |
| **Other protocols** | [ping](https://github.com/libp2p/specs/blob/master/ping/ping.md) | :green_apple: |
| | [identify](https://github.com/libp2p/specs/blob/master/identify/README.md) | :green_apple: |
Legend:
- :green_apple: - tested in production
- :lemon: - prototype or beta, not tested in production
- :tomato: - in progress
## Gossip simulator
Deterministic Gossip simulator which may simulate networks as large as 10000 of peers
Please check the Simulator [README](tools/simulator/README.md) for more details
## Android support
The library is basically being developed with Android compatibility in mind.
However we are not aware of anyone using it in production.
The `examples/android-chatter` module contains working sample Android application. This module is ignored by the Gradle
build when no Android SDK is installed.
To include the Android module define a valid SDK location with an `ANDROID_HOME` environment variable
or by setting the `sdk.dir` path in your project's local properties file local.properties.
Importing the project into Android Studio should work out of the box.
## Adding as a dependency to your project
Hosting of artefacts is graciously provided by [Cloudsmith](https://cloudsmith.com).
[](https://cloudsmith.io/~libp2p/repos/jvm-libp2p/packages/detail/maven/jvm-libp2p/latest/a=noarch;xg=io.libp2p/)
As an alternative, artefacts are also available on [JitPack](https://jitpack.io/).
[](https://jitpack.io/#libp2p/jvm-libp2p)
### Using Gradle
Add the required repositories to the `repositories` section of your Gradle file.
```groovy
repositories {
// ...
maven { url "https://dl.cloudsmith.io/public/libp2p/jvm-libp2p/maven/" }
maven { url "https://jitpack.io" }
maven { url "https://artifacts.consensys.net/public/maven/maven/" }
}
```
Add the library to the `implementation` part of your Gradle file.
```groovy
dependencies {
// ...
implementation 'io.libp2p:jvm-libp2p:X.Y.Z-RELEASE'
}
```
### Using Maven
Add the required repositories to the `dependencyManagement` section of the pom file:
```xml
libp2p-jvm-libp2p
https://dl.cloudsmith.io/public/libp2p/jvm-libp2p/maven/
JitPack
https://jitpack.io
Consensys
https://artifacts.consensys.net/public/maven/maven/
```
Add the library to the `dependencies` section of the pom file:
``` xml
io.libp2p
jvm-libp2p
X.Y.Z-RELEASE
```
## Building the project
To build the library you will need just
- JDK (Java Development Kit) of version 11 or higher
For building a stable release version clone the `master` branch:
```bash
git clone https://github.com/libp2p/jvm-libp2p -b master
```
For building a version with the latest updates clone the `develop` (default) branch:
```bash
git clone https://github.com/libp2p/jvm-libp2p
```
To build the library from the `jvm-libp2p` folder, run:
```bash
./gradlew build
```
After the build is complete you may find the library `.jar` file here: `jvm-libp2p/build/libs/jvm-libp2p-X.Y.Z-RELEASE.jar`
## Notable users
- [Teku](https://github.com/Consensys/teku) - Ethereum Consensus Layer client
- [Nabu](https://github.com/peergos/nabu) - minimal Java implementation of IPFS
- [Peergos](https://github.com/peergos/peergos) - peer-to-peer encrypted global filesystem
(Please open a pull request if you want your project to be added here)
## License
Dual-licensed under MIT and ASLv2, by way of the [Permissive License
Stack](https://protocol.ai/blog/announcing-the-permissive-license-stack/).