https://github.com/tronprotocol/libp2p
The p2p system implemented in java language
https://github.com/tronprotocol/libp2p
Last synced: 11 months ago
JSON representation
The p2p system implemented in java language
- Host: GitHub
- URL: https://github.com/tronprotocol/libp2p
- Owner: tronprotocol
- Created: 2022-09-13T03:11:42.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2025-04-15T23:11:58.000Z (about 1 year ago)
- Last Synced: 2025-04-22T07:19:52.108Z (about 1 year ago)
- Language: Java
- Size: 776 KB
- Stars: 45
- Watchers: 9
- Forks: 26
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# libp2p
libp2p is a p2p network SDK implemented in java language. The functional modules that have been implemented so far include
* node discovery by p2p, include ipv4 and ipv6,
* tcp connection management,
* publish nodes on dns domain and node discovery by dns,
* support compressed message transmission among nodes
# Note
Starting from version 2.2.6, `libp2p` has removed the logback component and adopted the logger facade. If logging is required, you need to introduce a logging framework manually.
Here’s how to include logback in your project using Gradle:
1. Add the following dependencies to your build.gradle file
```
dependencies {
implementation group: 'ch.qos.logback', name: 'logback-classic', version: 'x.x.xx'
}
```
2. Create or edit logback.xml in src/main/resources to configure logging. Here is an example of logback.xml:
```xml
%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n
```
# Build
Building libp2p requires `git` and `Oracle JDK 1.8` to be installed, other JDK versions are not supported yet. Make sure you operate on `Linux` and `MacOS` operating systems.
Clone the repo and switch to the `main` branch
```bash
$ git clone https://github.com/tronprotocol/libp2p.git
$ cd libp2p
$ git checkout -t origin/main
```
Then, run the following command to build libp2p, the `libp2p.jar` file can be found in `libp2p/build/libs/` after being built successfully.
```bash
$ ./gradlew clean build -x test
```
# Usage
libp2p can run independently or be imported into other projects.
## Run independently
Running libp2p requires Oracle JDK 1.8 to be installed, other JDK versions are not supported yet. Make sure you operate on Linux and MacOS operating systems.
then run the following command to start the node:
```bash
$ nohup java -jar libp2p.jar [options] >> start.log 2>&1 &
```
See the manual for details on [options](https://github.com/tronprotocol/libp2p/tree/develop/src/main/java/org/tron/p2p/example/README.md)
## How to include the dependency
### Gradle Setting
Add repo setting:
```bash
repositories {
...
mavenCentral()
}
```
Then add the required packages as dependencies. Please add dependencies locally.
```bash
dependencies {
implementation group: 'io.github.tronprotocol', name: 'libp2p', version: '2.2.6'
}
```
Or if you are using the jar files as your dependencies:
```bash
dependencies {
implementation fileTree(dir:'libs', include: 'libp2p.jar')
}
```
### Maven Setting
```bash
central-repos
Central Repository
https://repo.maven.apache.org/maven2
io.github.tronprotocol
libp2p
2.2.6
```
## Example
For some examples please check our [example package](https://github.com/tronprotocol/libp2p/tree/develop/src/main/java/org/tron/p2p/example).
# Integrity Check
* After February 21, 2023， releases are signed the gpg key:
```
pub: 1254 F859 D2B1 BD9F 66E7 107D F859 BCB4 4A28 290B
uid: build@tron.network
```