2026-02-17 10:38:35 +01:00
|
|
|
|
|
|
|
|
// Generated manually and inspired by libwaku.h
|
|
|
|
|
// Header file for Logos Messaging API (LMAPI) library
|
|
|
|
|
#pragma once
|
|
|
|
|
#ifndef __liblogosdelivery__
|
|
|
|
|
#define __liblogosdelivery__
|
|
|
|
|
|
|
|
|
|
#include <stddef.h>
|
|
|
|
|
#include <stdint.h>
|
|
|
|
|
|
|
|
|
|
// The possible returned values for the functions that return int
|
|
|
|
|
#define RET_OK 0
|
|
|
|
|
#define RET_ERR 1
|
|
|
|
|
#define RET_MISSING_CALLBACK 2
|
|
|
|
|
|
|
|
|
|
#ifdef __cplusplus
|
|
|
|
|
extern "C"
|
|
|
|
|
{
|
|
|
|
|
#endif
|
|
|
|
|
|
|
|
|
|
typedef void (*FFICallBack)(int callerRet, const char *msg, size_t len, void *userData);
|
|
|
|
|
|
|
|
|
|
// Creates a new instance of the node from the given configuration JSON.
|
|
|
|
|
// Returns a pointer to the Context needed by the rest of the API functions.
|
2026-03-03 19:17:54 +01:00
|
|
|
// Configuration should be in JSON format using WakuNodeConf field names.
|
|
|
|
|
// Field names match Nim identifiers from WakuNodeConf (camelCase).
|
|
|
|
|
// Example: {"mode": "Core", "clusterId": 42, "relay": true}
|
2026-02-17 10:38:35 +01:00
|
|
|
void *logosdelivery_create_node(
|
|
|
|
|
const char *configJson,
|
|
|
|
|
FFICallBack callback,
|
|
|
|
|
void *userData);
|
|
|
|
|
|
|
|
|
|
// Starts the node.
|
|
|
|
|
int logosdelivery_start_node(void *ctx,
|
|
|
|
|
FFICallBack callback,
|
|
|
|
|
void *userData);
|
|
|
|
|
|
|
|
|
|
// Stops the node.
|
|
|
|
|
int logosdelivery_stop_node(void *ctx,
|
|
|
|
|
FFICallBack callback,
|
|
|
|
|
void *userData);
|
|
|
|
|
|
|
|
|
|
// Destroys an instance of a node created with logosdelivery_create_node
|
|
|
|
|
int logosdelivery_destroy(void *ctx,
|
|
|
|
|
FFICallBack callback,
|
|
|
|
|
void *userData);
|
|
|
|
|
|
|
|
|
|
// Subscribe to a content topic.
|
|
|
|
|
// contentTopic: string representing the content topic (e.g., "/myapp/1/chat/proto")
|
|
|
|
|
int logosdelivery_subscribe(void *ctx,
|
|
|
|
|
FFICallBack callback,
|
|
|
|
|
void *userData,
|
|
|
|
|
const char *contentTopic);
|
|
|
|
|
|
|
|
|
|
// Unsubscribe from a content topic.
|
|
|
|
|
int logosdelivery_unsubscribe(void *ctx,
|
|
|
|
|
FFICallBack callback,
|
|
|
|
|
void *userData,
|
|
|
|
|
const char *contentTopic);
|
|
|
|
|
|
|
|
|
|
// Send a message.
|
|
|
|
|
// messageJson: JSON string with the following structure:
|
|
|
|
|
// {
|
|
|
|
|
// "contentTopic": "/myapp/1/chat/proto",
|
|
|
|
|
// "payload": "base64-encoded-payload",
|
|
|
|
|
// "ephemeral": false
|
|
|
|
|
// }
|
|
|
|
|
// Returns a request ID that can be used to track the message delivery.
|
|
|
|
|
int logosdelivery_send(void *ctx,
|
|
|
|
|
FFICallBack callback,
|
|
|
|
|
void *userData,
|
|
|
|
|
const char *messageJson);
|
|
|
|
|
|
|
|
|
|
// Sets a callback that will be invoked whenever an event occurs.
|
|
|
|
|
// It is crucial that the passed callback is fast, non-blocking and potentially thread-safe.
|
|
|
|
|
void logosdelivery_set_event_callback(void *ctx,
|
|
|
|
|
FFICallBack callback,
|
|
|
|
|
void *userData);
|
|
|
|
|
|
2026-03-03 13:32:45 +01:00
|
|
|
// Retrieves the list of available node info IDs.
|
|
|
|
|
int logosdelivery_get_available_node_info_ids(void *ctx,
|
|
|
|
|
FFICallBack callback,
|
|
|
|
|
void *userData);
|
|
|
|
|
|
|
|
|
|
// Given a node info ID, retrieves the corresponding info.
|
|
|
|
|
int logosdelivery_get_node_info(void *ctx,
|
|
|
|
|
FFICallBack callback,
|
|
|
|
|
void *userData,
|
|
|
|
|
const char *nodeInfoId);
|
|
|
|
|
|
|
|
|
|
// Retrieves the list of available configurations.
|
|
|
|
|
int logosdelivery_get_available_configs(void *ctx,
|
|
|
|
|
FFICallBack callback,
|
|
|
|
|
void *userData);
|
|
|
|
|
|
feat(mix,rln-gifter): LEZ-backed RLN mix + 2-phase gifter protocol (rebased onto PR #3807; plugin via nimble)
Ports commit 14562878 onto PR #3807's logos_delivery/ layout.
Changes vs original 14562878:
- Plugin consumed via nimble dep (no submodule add); the PR #3807 nimble
resolution already provides it.
- mountMix signature carries both PR #3807's disableSpamProtection AND
the patch's useOnchainLEZ parameters (callsite passes both).
- WakuMix.new branches on disableSpamProtection while also setting
useOnchainLEZ on the spam-protection config. Cover-traffic params come
from the plugin config when RLN is enabled, fall back to waku defaults
when disabled.
- start() retains HEAD's split between local-only init and the separate
registerDoSProtectionWithNetwork retry loop. publishGossipsubTrigger is
promoted to a standalone proc instead of inline in an else branch.
- MixProtocol.init uses libp2p_mix's new Opt-wrapped coverTraffic and
the MixRlnSpamProtection.new constructor (not the renamed newMixRlnSpamProtection).
- Makefile reverted to HEAD: PR #3807 dropped the separate mix-librln
archive in favor of a single stateless zerokit, so the patch's
MIX_LIBRLN_* additions are obsolete.
- README/sim helper config files: HEAD's values retained (env-specific
paths from patch author dropped).
Adds:
- logos_delivery/waku/waku_mix/logos_core_client.nim (RLN client layer)
- logos_delivery/waku/waku_mix/coordination handler (via waku_node)
- logos_delivery/waku/waku_rln_relay/rln_gifter/{client,protocol,rpc,rpc_codec}.nim
- 5 new C FFI exports (logosdelivery_set_rln_fetcher, _set_rln_config,
_set_rln_identity, _push_roots, _push_proof)
- --mix-gifter-* CLI flags + MixConf fields + MixConfBuilder methods
- tests/waku_rln_relay/test_rln_gifter.nim
2026-06-15 13:49:57 -06:00
|
|
|
int logosdelivery_init(void);
|
|
|
|
|
|
|
|
|
|
// RLN fetcher: C++ implements this, Nim calls it to get roots/proofs from RLN module.
|
|
|
|
|
typedef int (*RlnFetcherFunc)(const char *method, const char *params,
|
|
|
|
|
FFICallBack callback, void *callbackData, void *fetcherData);
|
|
|
|
|
|
|
|
|
|
void logosdelivery_set_rln_fetcher(void *ctx, RlnFetcherFunc fetcher, void *fetcherData);
|
|
|
|
|
int logosdelivery_set_rln_config(void *ctx, const char *configAccountId, int leafIndex);
|
|
|
|
|
void logosdelivery_set_rln_identity(void *ctx, const char *idSecretHashHex);
|
|
|
|
|
void logosdelivery_push_roots(void *ctx, const char *rootsJson);
|
|
|
|
|
void logosdelivery_push_proof(void *ctx, const char *proofJson);
|
|
|
|
|
|
2026-06-15 13:03:44 +02:00
|
|
|
// NOTE: the low-level kernel API (waku_*) lives in the separate, advanced
|
|
|
|
|
// header liblogosdelivery_kernel.h. It is intentionally not declared here so
|
|
|
|
|
// this header only promises the stable Messaging / Reliable Channels surface.
|
|
|
|
|
|
2026-02-17 10:38:35 +01:00
|
|
|
#ifdef __cplusplus
|
|
|
|
|
}
|
|
|
|
|
#endif
|
|
|
|
|
|
|
|
|
|
#endif /* __liblogosdelivery__ */
|