QUIC Interop efforts with lean libp2p

[seetadev]

Siddharth: great accomplishment. Please add your detailed instructions, notes and screencast link below.

[bismuth01]

Setting up the libp2p libraries

How to setup py-libp2p: -

1. Make a virtual environment and activate it

python3 -m venv .venv
. .venv/bin/activate

2. Clone py-libp2p repository and install it as a package inside the virtual environment

git clone https://github.com/libp2p/py-libp2p.git
cd py-libp2p
python3 -m pip install -e ".[dev]"
pre-commit install

Now, using this virtual environment, any python file using py-libp2p can be run.

How to setup leanp2p: -

1. You will need GCC 14, cmake and ninja to use the library.
2. Install vcpkg, HOME is set to your profile home directory by default, but can be changed as per preference.

git clone https://github.com/microsoft/vcpkg.git "$HOME/vcpkg"
"$HOME/vcpkg"/bootstrap-vcpkg.sh

3. Add vcpkg to PATH

# If using bash, replace .zshrc with .bashrc
echo 'export VCPKG_ROOT="$HOME/vcpkg"' >> ~/.zshrc
export VCPKG_ROOT="$HOME/vcpkg" # Run this to prevent reloading the shell

This provides you with the initial tools to use leanp2p, however a few more files will be needed.
If you want to start a project from scratch, then copy the following files from https://github.com/bismuth01/libp2p-interop/tree/main/leanp2p : -

• vcpkg.json
• vcpkg-configuration.json
• CMakePresets.json
• vcpkg-overlay
• CMakeLists.txt

Don't forget to edit CMakeLists.txt as per your project.

Running the QUIC ping examples

Clone the interop examples repository

git clone https://github.com/bismuth01/libp2p-interop

The ping interval has been set to 1 and timeout interval to 5 seconds to show the client in action.

Running py-libp2p QUIC ping client

1. Activate the virtual environment with py-libp2p setup.
2. Go to the ping example directory.

cd libp2p-interop/py-libp2p/ping

3. Run ping.py which will give you a connection string

python ping.py

OR, if you have a connection string

python ping.py -d <your-connection-string>

You will be able to see the message received and sent events.

Running leanp2p QUIC ping client

1. Enter the leanp2p directory

cd libp2p-interop/leanp2p

2. Configure and install the dependencies using the given preset.

cmake --preset default

3. Build the project

cmake --build build -j

This will create the executable at build/
4. Run the ping executable which will give you a connection string

./build/ping/ping

OR, if you have a connection string

./build/ping/ping <your-connection-string>

You will not see any logs further than the client has connected due to no direct logging provided in the library (to the best of my knowledge). But if any error occurs, the client will log it or exit with the error.

Screenshots of running client

py-libp2p connects to py-libp2p

leanp2p connects to leanp2p

py-libp2p connects to leanp2p

leanp2p connects to py-libp2p