This README will guide you through the process of downloading and building Ligetron.

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

brew install cmake gmp mpfr libomp llvm boost

sudo apt-get update && sudo apt-get upgrade -y

sudo apt-get install g++ libgmp-dev libtbb-dev cmake libssl-dev libboost-all-dev -y

sudo apt-get install git -y

sudo apt install libx11-dev libxrandr-dev libxinerama-dev libxcursor-dev libxi-dev
sudo apt install libx11-xcb-dev

# Add the Ubuntu Toolchain PPA
sudo add-apt-repository ppa:ubuntu-toolchain-r/test

# Update package lists
sudo apt update

# Install GCC 13
sudo apt install g++-13

# Configure Alternatives
sudo update-alternatives --install /usr/bin/g++ g++ /usr/bin/g++-13 20
sudo update-alternatives --set g++ "/usr/bin/g++-13"

sudo apt install libvulkan1 vulkan-tools

# Remove old CMake version if installed
sudo apt remove --purge cmake
sudo apt autoremove

# Install required packages
sudo apt install -y software-properties-common lsb-release wget gpg

# Add Kitware's repository and its signing key
wget -O - https://apt.kitware.com/keys/kitware-archive-latest.asc 2>/dev/null | gpg --dearmor - | sudo tee /usr/share/keyrings/kitware-archive-keyring.gpg >/dev/null

# Add the repository to sources list
echo "deb [signed-by=/usr/share/keyrings/kitware-archive-keyring.gpg] https://apt.kitware.com/ubuntu/ $(lsb_release -cs) main" | sudo tee /etc/apt/sources.list.d/kitware.list >/dev/null

# Update package lists
sudo apt update

# Install the latest CMake
sudo apt install cmake

# Verify the installation
cmake --version

sudo apt purge nvidia*
sudo apt install nvidia-driver-535 nvidia-dkms-535 nvidia-utils-535
sudo reboot

sudo apt install mesa-common-dev libgl1-mesa-dev

Instructions

From a convenient location:

git clone https://dawn.googlesource.com/dawn
cd dawn/
git checkout cec4482eccee45696a7c0019e750c77f101ced04
mkdir release && cd release
cmake -DDAWN_FETCH_DEPENDENCIES=ON -DDAWN_BUILD_MONOLITHIC_LIBRARY=STATIC -DDAWN_ENABLE_INSTALL=ON -DCMAKE_BUILD_TYPE=Release ..
make -j
make install

Ligetron also depends on several external libraries:

• WebAssembly Binary Toolkit
• nlohmann json

From a convenient location:

git clone https://github.com/WebAssembly/wabt.git
cd wabt
git submodule update --init
mkdir build && cd build
cmake -DCMAKE_CXX_COMPILER=g++-13 .. # For Ubuntu
cmake -DCMAKE_CXX_COMPILER=clang++ .. # For MacOS
make -j
sudo make install

From a convenient location:

# Get the emsdk repo
git clone https://github.com/emscripten-core/emsdk.git
# Enter that directory
cd emsdk
# Fetch the latest version of the emsdk (not needed the first time you clone)
git pull
# Download and install the latest SDK tools.
./emsdk install latest
# Make the "latest" SDK "active" for the current user. (writes .emscripten file)
./emsdk activate latest
# Activate PATH and other environment variables in the current terminal
source ./emsdk_env.sh

git clone https://github.com/ligeroinc/ligetron.git
cd ligetron

From the root directory:

mkdir build && cd build
cmake -DCMAKE_BUILD_TYPE=Release ..
make -j

From the root directory:

mkdir -p build-web && cd build-web
cmake -DCMAKE_BUILD_TYPE=Web -DCMAKE_PREFIX_PATH=<path-to-dependencies> ..
make -j

Step by step instructions here

From the project root

cd sdk/cpp
mkdir build && cd build
emcmake cmake ..
make -j

From the project root

cd sdk/rust
cargo build --target wasm32-wasip1 --release

To run the the prover follow these steps:

• Navigate to the build directory and run the following command to run the prover:

./webgpu_prover <string of JSON object>

where the single argument is a string produced by JSON.stringify(). Here is the fields of the JSON:

Note: Packing size influences the proof length. This parameter needs to be optimally chosen to minimize proof length.

• Navigate to the build directory and run the following command to run the verifier:

./webgpu_verifier <equivalent JSON argument as for demo, but with obscured private indices>

Note: When in doubt, it's always a good idea to recompile the example again from source in /examples. For example, the latest interface takes a JSON as input which contains more information than the old interface. As a consequence, we no longer need to manually convert the input from string to int or raw hex, all we need now is a simple reinterpret_cast. The old application still works by taking all input as string but it's less efficient.

Navigate to the build directory to run the examples.

Suppose we have edit.wasm either by compiling /examples/edit_distance.cpp or pick from wasm/edit.wasm. The arguments are abcde and bcdef, then:

./webgpu_prover '{"program":"../sdk/build/examples/edit.wasm","shader-path":"../shader","packing":8192,"private-indices":[1],"args":[{"str":"abcdeabcdeabcde"},{"str":"bcdefabcdeabcde"},{"i64":15},{"i64":15}]}'

This will run the Edit Distance program with the given packing size and arguments and verify that the edit distance between the two input strings abcde and bcdef is less than 5. The last two arguments are the length of the two input strings. You can run this code with two strings of arbitrary lengths. If you try to generate a proof with strings whose edit distance >= 5, the verification will fail.

For verification "private" arguments can be "obscured" as long as their input type is still correct and the argument length is the same:

./webgpu_verifier '{"program":"../sdk/build/examples/edit.wasm","shader-path":"../shader","packing":8192,"private-indices":[1],"args":[{"str":"xxxxxxxxxxxxxxx"},{"str":"bcdefabcdeabcde"},{"i64":15},{"i64":15}]}'

Ligetron uses WebGPU (through Dawn or Emscripten) to accelerate the computation both natively and on browsers. Currently, we don't provide a fallback implementation if WebGPU is not available on your system. Technically, every device with the support of DX12/Vulkan/Metal should be able to run with the exception of iOS devices (specifically, iPhones).

On Linux, you might need additional flags to enable WebGPU support on browsers:

google-chrome --enable-unsafe-webgpu --enable-features=Vulkan

Copyright (C) 2023-2025 Ligero, Inc