Ivan FB f5153ac5a9
chore: stop cargo fmt from rewriting the generated bindings
The #[path] imports make rustfmt treat the vendor's generated bindings as
crate source, so `cargo fmt` rewrapped ~1400 lines of api.rs/ffi.rs inside
the submodule. The next regen reverts that, so it is pure churn -- and it
shows up as a spurious dirty vendor.

rustfmt.toml `ignore` would be the natural fix, but it is nightly-only and
is silently dropped on stable ("unstable features are only available in
nightly channel"), so the skip attribute goes on the imports instead.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-07-16 18:45:56 +02:00
2023-05-12 15:13:18 +02:00

Waku Rust bindings

Crates.io Documentation Build Status Codecov Status

Rust layer on top of logos-messaging-nim C FFI bindings.

Using the crate

For now this crate is consumed from a local checkout rather than a registry.

  1. Clone the repo and check out the branch you want:

    git clone --recurse-submodules https://github.com/logos-messaging/logos-delivery-rust-bindings
    cd logos-delivery-rust-bindings
    git checkout <branch>
    git submodule update --init --recursive
    
  2. Point your app at it by path:

    # your app's Cargo.toml
    [dependencies]
    waku-bindings = { path = "../logos-delivery-rust-bindings/waku-bindings" }
    

Build prerequisites

waku-bindings builds the underlying Nim library from source the first time, so the toolchain has to be present:

  • Nim and nimble (installed by the vendored make targets, or bring your own on PATH)
  • make and a C/C++ toolchain
  • A Rust toolchain (RLN is built from source)

The first build compiles the whole logos-delivery tree and is slow; subsequent builds are incremental.

What you can call

Everything is driven through LogosDeliveryCtx (re-exported at the crate root). The crate docs group the available operations — node lifecycle, messaging, reliable channels, and the typed event listeners — under Operations; run cargo doc --open -p waku-bindings for the full, linked method list. A minimal end-to-end example lives in examples/basic.

About Waku

Waku is a family of robust and censorship-resistant communication protocols enabling privacy-focused messaging for Web3 applications.

Private. Secure. Runs anywhere.

Read the Waku docs

Description
Rust wrapper over nwaku ffi
Readme
Languages
Rust 99.6%
C 0.4%