rust-libp2p

(โ˜… 5,606)

The Rust Implementation of the libp2p networking stack.

  • .dockerignore
  • .editorconfig
  • .git-blame-ignore-revs
  • .gitignore
  • Cargo.lock
  • Cargo.toml
  • CHANGELOG.md
  • clippy.toml
  • CONTRIBUTING.md
  • deny.toml
  • FUNDING.json
  • LICENSE
  • README.md
  • ROADMAP.md
  • rustfmt.toml
  • SECURITY.md

๐Ÿš€ Installation Guide

1. Get the code
git clone https://github.com/libp2p/rust-libp2p

Downloads the entire project code from GitHub to your computer.

cd rust-libp2p

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker compose -f examples/autonatv2/docker-compose.yml up -d --build

Runs the command against the services defined in the compose file.

โœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. Go

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Go The Go compiler and toolchain.
cd wasm-tests/webtransport-tests/echo-server

This project's files live in a subfolder, so move into it first.

go build ./...

Compiles the Go program into an executable.

go run .

Runs the Go program directly without a separate build step.

โœ… If the build finishes without errors, it worked. If you used go run ., check the terminal output.

4. Rust

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Rust (rustup) Installing via rustup also installs cargo.
cargo build --release

Compiles the Rust project.

cargo run

Builds and then immediately runs the program.

โœ… If cargo build finishes without errors, it worked. The executable is created under target/.
// repository documentation