logos-messaging/logos-delivery-rust-bindings
1
0
Fork 0
mirror of https://github.com/logos-messaging/logos-delivery-rust-bindings.git synced 2026-07-30 06:53:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

refactor: collapse waku-sys into waku-bindings

Browse Source 
waku-sys was a thin -sys crate that only re-exported the generated FFI
sources via #[path] and carried the build. It sat between waku-bindings
and the generated crate for no real benefit -- the generated crate is the
actual -sys equivalent, and its own build.rs cannot build logos-delivery
(bare `nim c`, one link directive). So the wrapper is folded in:

- The build (make liblogosdelivery + the 13 link directives, librln
  discovery, cmd.c) moves into waku-bindings/build.rs.
- waku-bindings pulls the generated ffi/types/api modules directly by
  #[path] into the vendor submodule, which moves from waku-sys/vendor to
  the repo root (vendor/).
- ciborium/flume and the cc build-dep move over; the waku-sys path
  dependency is dropped.

Consumers are unaffected -- they always depended only on waku-bindings.
This is one crate and one layer fewer.

build.rs now also removes a stale build/liblogosdelivery.dylib after the
static build: the generated ffi.rs declares `#[link(name =
"logosdelivery")]` with no kind, so a dylib left by a non-STATIC make
would be linked dynamically over the static archive.

Full suite passes (4 tests + doctest, 1 ignored) and all three examples
build.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This commit is contained in:
Ivan FB 2026-07-16 16:47:10 +02:00
parent 84f7daa0ce
commit 1b25e5c327
No known key found for this signature in database
GPG Key ID: DF0C67A04C543270
14 changed files with 63 additions and 387 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.gitmodules vendored
View File

@ -1,3 +1,3 @@
[submodule "waku-sys/vendor"]
path = waku-sys/vendor
path = vendor
url = https://github.com/logos-messaging/logos-messaging-nim

15
Cargo.lock generated
View File

@ -3047,8 +3047,11 @@ version = "1.0.0"
dependencies = [
"aes-gcm",
"base64 0.21.0",
"cc",
"chrono",
"ciborium",
"enr",
"flume",
"futures",
"hex",
"libc",
@ -3067,18 +3070,6 @@ dependencies = [
"tokio",
"url",
"uuid",
"waku-sys",
]
[[package]]
name = "waku-sys"
version = "1.0.0"
dependencies = [
"cc",
"ciborium",
"flume",
"serde",
"tokio",
]
[[package]]

1
Cargo.toml
View File

@ -2,6 +2,5 @@
members = [
"waku-bindings",
"waku-sys",
"examples/basic"
]

15
examples/Cargo.lock generated
View File

@ -4934,8 +4934,11 @@ version = "1.0.0"
dependencies = [
"aes-gcm",
"base64 0.21.7",
"cc",
"chrono",
"ciborium",
"enr",
"flume",
"hex",
"libc",
"multiaddr",
@ -4952,18 +4955,6 @@ dependencies = [
"tokio",
"url",
"uuid",
"waku-sys",
]
[[package]]
name = "waku-sys"
version = "1.0.0"
dependencies = [
"cc",
"ciborium",
"flume",
"serde",
"tokio",
]
[[package]]

0
waku-sys/vendor → vendor
View File

8
waku-bindings/Cargo.toml
View File

@ -28,7 +28,6 @@ serde_json = "1.0"
sscanf = "0.4"
smart-default = "0.6"
url = "2.3"
waku-sys = { version = "1.0.0", path = "../waku-sys" }
libc = "0.2"
serde-aux = "4.3.1"
rln = "0.3.4"
@ -36,6 +35,13 @@ tokio = { version = "1", features = ["full"] }
regex = "1"
chrono = "0.4"
uuid = { version = "1.3", features = ["v4"] }
# Runtime deps of the generated FFI bindings (formerly waku-sys), now consumed
# directly from the vendor submodule.
ciborium = "0.2"
flume = { version = "0.11", default-features = false, features = ["async"] }
[build-dependencies]
cc = "1.0.73"
[dev-dependencies]
futures = "0.3.25"

52
waku-sys/build.rs → waku-bindings/build.rs
View File

@ -5,7 +5,7 @@ use std::process::Command;
extern crate cc;
fn submodules_init(project_dir: &Path) {
fn submodules_init(vendor_dir: &Path) {
let mark_file_path = ".submodules-initialized";
// Check if the mark file exists
@ -22,9 +22,8 @@ fn submodules_init(project_dir: &Path) {
.expect("Failed to execute 'git submodule update --recursive'")
.success()
{
// Now, inside nwaku folder, run 'make update' to get nwaku's vendors
let nwaku_path = project_dir.join("vendor");
set_current_dir(nwaku_path).expect("Moving to vendor dir");
// Now, inside the vendor folder, run 'make update' to get its vendors.
set_current_dir(vendor_dir).expect("Moving to vendor dir");
if Command::new("make")
.args(["update"])
@ -34,10 +33,11 @@ fn submodules_init(project_dir: &Path) {
{
std::fs::File::create(mark_file_path).expect("Failed to create mark file");
} else {
panic!("Failed to run 'make update' within nwaku folder.");
panic!("Failed to run 'make update' within vendor folder.");
}
set_current_dir(project_dir).expect("Going back to project dir");
set_current_dir(env::var("CARGO_MANIFEST_DIR").unwrap())
.expect("Going back to manifest dir");
println!("Git submodules initialized and updated successfully.");
} else {
@ -48,9 +48,8 @@ fn submodules_init(project_dir: &Path) {
}
}
fn build_nwaku_lib(project_dir: &Path) {
let nwaku_path = project_dir.join("vendor");
set_current_dir(nwaku_path).expect("Moving to vendor dir");
fn build_nwaku_lib(vendor_dir: &Path) {
set_current_dir(vendor_dir).expect("Moving to vendor dir");
let mut cmd = Command::new("make");
cmd.arg("liblogosdelivery").arg("STATIC=1");
@ -65,7 +64,19 @@ fn build_nwaku_lib(project_dir: &Path) {
panic!("'make liblogosdelivery STATIC=1' failed with {status}");
}
set_current_dir(project_dir).expect("Going back to project dir");
// The generated ffi.rs declares `#[link(name = "logosdelivery")]` with no
// kind, so a stray liblogosdelivery.dylib in build/ (left by a non-STATIC
// `make liblogosdelivery`) would be linked dynamically over the static .a we
// want. Remove it so the static archive is the only candidate.
for stale in ["build/liblogosdelivery.dylib", "build/liblogosdelivery.dylib.dSYM"] {
let path = vendor_dir.join(stale);
if path.exists() {
let _ = std::fs::remove_dir_all(&path).or_else(|_| std::fs::remove_file(&path));
}
}
set_current_dir(env::var("CARGO_MANIFEST_DIR").unwrap())
.expect("Going back to manifest dir");
}
/// Resolves a package directory under the vendor's `nimbledeps/pkgs2`, whose
@ -112,9 +123,7 @@ fn find_librln(nwaku_path: &Path) -> String {
})
}
fn emit_link_flags(project_dir: &Path) {
let nwaku_path = project_dir.join("vendor");
fn emit_link_flags(nwaku_path: &Path) {
// The FFI surface is generated by the vendor's genBindings() rather than
// bindgen, so the sources it emits are what invalidates this crate.
println!(
@ -140,7 +149,7 @@ fn emit_link_flags(project_dir: &Path) {
// nat_traversal moved from a git submodule under vendor/ to a nimble
// dependency, and builds its NAT archives inside its own package dir.
let nat_traversal = nimble_pkg_dir(&nwaku_path, "nat_traversal");
let nat_traversal = nimble_pkg_dir(nwaku_path, "nat_traversal");
println!(
"cargo:rustc-link-search={}",
@ -168,7 +177,7 @@ fn emit_link_flags(project_dir: &Path) {
// The vendor's Makefile fetches librln into its root, naming it after the
// RLN version it pins, so the archive is discovered rather than hardcoded.
let librln = find_librln(&nwaku_path);
let librln = find_librln(nwaku_path);
println!("cargo:rustc-link-search={}", nwaku_path.display());
println!("cargo:rustc-link-lib=static={librln}");
@ -182,9 +191,14 @@ fn emit_link_flags(project_dir: &Path) {
#[cfg(not(doc))]
fn main() {
let project_dir = PathBuf::from(env::var("CARGO_MANIFEST_DIR").unwrap());
let manifest_dir = PathBuf::from(env::var("CARGO_MANIFEST_DIR").unwrap());
// The vendor submodule lives at the repo root, one level up from this crate.
let vendor_dir = manifest_dir
.parent()
.expect("crate has a parent directory")
.join("vendor");
submodules_init(&project_dir);
build_nwaku_lib(&project_dir);
emit_link_flags(&project_dir);
submodules_init(&vendor_dir);
build_nwaku_lib(&vendor_dir);
emit_link_flags(&vendor_dir);
}

0
waku-sys/src/cmd.c → waku-bindings/src/cmd.c
View File

17
waku-bindings/src/lib.rs
View File

@ -70,11 +70,26 @@
pub mod general;
pub mod node;
// The generated FFI surface, consumed in place from the vendor submodule so
// regenerating it flows through directly. `api` resolves its siblings through
// `super::`, so the three stay crate-root sibling modules. build.rs compiles
// and links the underlying Nim library.
#[allow(clippy::all)]
#[path = "../../vendor/library/rust_bindings/src/ffi.rs"]
mod ffi;
#[allow(clippy::all)]
#[path = "../../vendor/library/rust_bindings/src/types.rs"]
mod types;
#[allow(clippy::all)]
#[path = "../../vendor/library/rust_bindings/src/api.rs"]
mod api;
// The full generated FFI surface: LogosDeliveryCtx and its methods, the request
// types (SendRequest, ChannelSendRequest), and one payload type per event. See
// the Operations section above for the map; browse `LogosDeliveryCtx` in the
// docs for the complete method list.
pub use waku_sys::*;
pub use api::*;
pub use types::*;
// Required so functions inside libwaku can call RLN functions even if we
// use it within the bindings functions

42
waku-sys/Cargo.toml
View File

@ -1,42 +0,0 @@
[package]
name = "waku-sys"
version = "1.0.0"
edition = "2021"
authors = [
"Daniel Sanchez Quiros <danielsq@status.im>",
"Richard Ramos <richard@waku.org>",
"Ivan Folgueira Bande <ivansete@status.im>"
]
description = "Waku networking library generated bindings"
license = "MIT OR Apache-2.0"
repository = "https://github.com/logos-messaging/logos-messaging-rust-bindings"
keywords = ["waku", "peer-to-peer", "libp2p", "networking"]
categories = ["network-programming"]
exclude = [
"vendor/examples/*",
"vendor/docs/*",
"vendor/coverage/*",
"vendor/pkg/*",
"vendor/tests/*",
"vendor/ci/*",
"vendor/cmd/*",
"**/*.md",
"**/*.lock",
"**/*.nix",
"**/Dockerfile",
]
[lib]
crate-type = ["rlib"]
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
# Mirrors the Cargo.toml the vendor's genBindings() emits alongside the sources.
[dependencies]
serde = { version = "1", features = ["derive"] }
ciborium = "0.2"
flume = { version = "0.11", default-features = false, features = ["async"] }
tokio = { version = "1", features = ["sync", "time"] }
[build-dependencies]
cc = "1.0.73"

205
waku-sys/LICENSE-APACHEv2
View File

@ -1,205 +0,0 @@
waku-sys is licensed under the Apache License version 2
Copyright (c) 2018 Status Research & Development GmbH
-----------------------------------------------------
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright 2018 Status Research & Development GmbH
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

25
waku-sys/LICENSE-MIT
View File

@ -1,25 +0,0 @@
waku-sys is licensed under the MIT License
Copyright (c) 2018 Status Research & Development GmbH
-----------------------------------------------------
The MIT License (MIT)
Copyright (c) 2018 Status Research & Development GmbH
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

51
waku-sys/README.md
View File

@ -1,51 +0,0 @@
# Waku rust bindgen bindings
[<img alt="github" src="https://img.shields.io/badge/github-Github-red?style=for-the-badge&labelColor=555555&logo=github" height="20">](https://github.com/logos-messaging/logos-messaging-rust-bindings)
[<img alt="crates.io" src="https://img.shields.io/crates/v/waku-bindings.svg?style=for-the-badge&color=fc8d62&logo=rust" height="20">](https://crates.io/crates/waku-sys)
[<img alt="docs.rs" src="https://img.shields.io/badge/doc/waku-bindings-66c2a5?style=for-the-badge&labelColor=555555&logo=docs.rs" height="20">](https://docs.rs/waku-sys)
[<img alt="build status" src="https://img.shields.io/github/actions/workflow/status/logos-messaging/logos-messaging-rust-bindings/main.yml?branch=master" height="20">](https://github.com/logos-messaging/logos-messaging-rust-bindings/actions/workflows/main.yml?query=branch%3Amaster)
Rust layer on top of [`go-waku`](https://github.com/status-im/go-waku) [c ffi bindings](https://github.com/status-im/go-waku/blob/v0.2.2/library/README.md).
## Usage
These are autogenerated, if you are looking for a proper Rust API version check on [`waku-bindings`](https://crates.io/crates/waku-bindings)
Add this to your `Cargo.toml`:
```toml
[dependencies]
waku-sys = "0.1.0"
```
## About [Waku](https://waku.org/)
Waku is the communication layer for Web3. Decentralized communication that scales.
Private. Secure. Runs anywhere.
### What is Waku?
Waku is a suite of privacy-preserving, peer-to-peer messaging protocols.
Waku removes centralized third parties from messaging, enabling private, secure, censorship-free communication with no single point of failure.
Waku provides privacy-preserving capabilities, such as sender anonymity,metadata protection and unlinkability to personally identifiable information.
Waku is designed for generalized messaging, enabling human-to-human, machine-to-machine or hybrid communication.
Waku runs everywhere: desktop, server, including resource-restricted devices, such as mobile devices and browsers.
How does it work?
The first version of Waku had its origins in the Whisper protocol, with optimizations for scalability and usability. Waku v2 is a complete rewrite. Its relay protocol implements pub/sub over libp2p, and also introduces additional capabilities:
1. Retrieving historical messages for mostly-offline devices.
2. Adaptive nodes, allowing for heterogeneous nodes to contribute.
3. Bandwidth preservation for light nodes.
This makes it ideal for running a p2p protocol on mobile, or in other similarly resource-restricted environments.
Read the [Waku docs](https://docs.wakuconnect.dev/)

17
waku-sys/src/lib.rs
View File

@ -1,17 +0,0 @@
//! Bindings to liblogosdelivery, generated by nim-ffi's `genBindings()` from the
//! vendor's `library/liblogosdelivery.nim`.
//!
//! The generated sources are consumed in place rather than copied, so
//! regenerating them in the vendor flows through here directly. `api.rs`
//! resolves its siblings through `super::`, so the three have to stay sibling
//! modules of this root.
#[path = "../vendor/library/rust_bindings/src/ffi.rs"]
mod ffi;
#[path = "../vendor/library/rust_bindings/src/types.rs"]
mod types;
#[path = "../vendor/library/rust_bindings/src/api.rs"]
mod api;
pub use api::*;
pub use types::*;