mirror of
https://github.com/logos-messaging/nim-chat-poc.git
synced 2026-07-03 07:00:16 +00:00
Global, restart-based Required/None anonymity mode: route chat messages through the
libp2p mixnet for sender anonymity, on the logos-delivery (efafdfdc2) nwaku stack.
Static RLN spam protection; no on-chain LEZ gifter / dynamic membership.
Delivery (src/chat/delivery/waku_client.nim):
- WakuConfig.mixEnabled/mixNodes/minMixPoolSize; parseMixNodes, waitForMixPool,
getMixPoolSize, mixReady.
- Required mode: sendBytes -> lightpushPublish(mixify=true) over the mix pool,
fail-fast below minMixPoolSize (no relay fallback). None mode: relay publish.
Errors propagate up to chat_send_message.
- Receive via WakuFilter (subscribe to static peers; no relay mounted), refreshed
by a 60s keep-alive.
- Static RLN: pre-populated rln_tree.db + per-peer keystore; nodekey config to adopt
a provisioned identity. No per-send root-convergence wait (static membership).
API / build:
- chat_get_mix_status FFI -> {mixEnabled,mixReady,mixPoolSize,minPoolSize}.
- Reproducible nix build: librln consumed as a cdylib (avoids the two-Rust-staticlib
symbol collision); -d:libp2p_mix_experimental_exit_is_dest.
- vendor/nwaku -> efafdfdc2; vendor/nim-protobuf-serialization -> 38d24eb (0.4.0).
117 lines
4.8 KiB
C
117 lines
4.8 KiB
C
// Generated manually
|
|
#ifndef __liblogoschat__
|
|
#define __liblogoschat__
|
|
|
|
#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);
|
|
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
// Client Lifecycle
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
|
|
// Creates a new instance of the chat client.
|
|
// Sets up the chat client from the given configuration.
|
|
// Returns a pointer to the Context needed by the rest of the API functions.
|
|
// configJson: JSON object with fields:
|
|
// - "name": string - identity name (default: "anonymous")
|
|
// - "port": int - Waku port (optional)
|
|
// - "clusterId": int - Waku cluster ID (optional)
|
|
// - "shardId": int - Waku shard ID (optional)
|
|
// - "staticPeers": array of strings - static peer multiaddrs (optional)
|
|
// - "mixEnabled": bool - enable mix protocol for sender anonymity (default: false)
|
|
// - "mixNodes": array of strings - mix bootstrap nodes as "multiaddr:mixPubKeyHex"
|
|
// - "destPeerAddr": string - lightpush destination peer "multiaddr/p2p/peerId"
|
|
// - "minMixPoolSize": int - minimum mix pool size before sending via mix (default: 4)
|
|
void *chat_new(const char *configJson, FFICallBack callback, void *userData);
|
|
|
|
// Start the chat client and begin listening for messages
|
|
int chat_start(void *ctx, FFICallBack callback, void *userData);
|
|
|
|
// Stop the chat client
|
|
int chat_stop(void *ctx, FFICallBack callback, void *userData);
|
|
|
|
// Destroys an instance of a chat client created with chat_new
|
|
int chat_destroy(void *ctx, FFICallBack callback, void *userData);
|
|
|
|
// Sets a callback that will be invoked whenever an event occurs.
|
|
// Events are JSON objects with "eventType" field:
|
|
// - "new_message":
|
|
// {"eventType":"new_message","conversationId":"...","messageId":"...","content":"hex...","timestamp":...}
|
|
// - "new_conversation":
|
|
// {"eventType":"new_conversation","conversationId":"...","conversationType":"private"}
|
|
// - "delivery_ack":
|
|
// {"eventType":"delivery_ack","conversationId":"...","messageId":"..."}
|
|
void set_event_callback(void *ctx, FFICallBack callback, void *userData);
|
|
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
// Client Info
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
|
|
// Get the client's identifier
|
|
int chat_get_id(void *ctx, FFICallBack callback, void *userData);
|
|
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
// Conversation Operations
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
|
|
// List all conversations as JSON array
|
|
// Returns: JSON array of objects with "id" field
|
|
int chat_list_conversations(void *ctx, FFICallBack callback, void *userData);
|
|
|
|
// Get a specific conversation by ID
|
|
// Returns: JSON object with "id" field
|
|
int chat_get_conversation(void *ctx, FFICallBack callback, void *userData,
|
|
const char *convoId);
|
|
|
|
// Create a new private conversation with the given IntroBundle
|
|
// introBundleStr: Intro bundle ASCII string as returned by chat_create_intro_bundle
|
|
// contentHex: Initial message content as hex-encoded string
|
|
int chat_new_private_conversation(void *ctx, FFICallBack callback,
|
|
void *userData, const char *introBundleStr,
|
|
const char *contentHex);
|
|
|
|
// Send a message to a conversation
|
|
// convoId: Conversation ID string
|
|
// contentHex: Message content as hex-encoded string
|
|
// Returns: Message ID on success
|
|
int chat_send_message(void *ctx, FFICallBack callback, void *userData,
|
|
const char *convoId, const char *contentHex);
|
|
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
// Identity Operations
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
|
|
// Get the client identity
|
|
// Returns JSON: {"name": "..."}
|
|
int chat_get_identity(void *ctx, FFICallBack callback, void *userData);
|
|
|
|
// Create an IntroBundle for initiating private conversations
|
|
// Returns the intro bundle as an ASCII string (format: logos_chatintro_<version>_<base64url payload>)
|
|
int chat_create_intro_bundle(void *ctx, FFICallBack callback, void *userData);
|
|
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
// Mix Protocol Status
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
|
|
// Get mix protocol status
|
|
// Returns JSON: {"mixEnabled":bool,"mixReady":bool,"mixPoolSize":int,"minPoolSize":int}
|
|
int chat_get_mix_status(void *ctx, FFICallBack callback, void *userData);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* __liblogoschat__ */
|