f648349e82
* Diatixisify! * First pass at Typedoc generation for TS SDK * Remove overview pages * Fix typos and remove codebase references from docs Fix typos across network and developer docs: Quorum, available, cryptosystem, transaction, proportional, Standalone. Remove TODO placeholder from dVPN protocol page. Strip GitHub source links from network docs to decouple documentation from repo structure. * Expand thin landing pages across network and developer docs - Add intro content to network overview, infrastructure, and reference landing pages - Expand developer index with "where to start" guide - Add usage instructions and explanations to all five TS playground pages - Expand WebSocket client page with setup and message format examples * Restructure Rust SDK developer docs - Delete redundant mixnet example, message-helpers, and message-types subpages - Delete client-pool architecture and example subpages (content folded into landing) - Delete tcpproxy troubleshooting (folded into landing page) - Add deprecation notices to TcpProxy pages, pointing to Stream module - Add stream module docs: landing page, architecture, tutorial, and 4 example pages - Add mixnet and client-pool tutorials - Add SDK tour page - Update navigation and landing pages with docs.rs links * Restructure TS SDK developer docs - Merge overview, installation, and getting started into TS SDK landing page - Fold FAQ content into bundling/troubleshooting section - Delete redundant overview, installation, start, and FAQ pages - Update internal links in browsers.mdx and native.mdx - Update navigation and example page imports * Flatten and expand APIs section - Collapse nested API subpages into single pages with inline Redoc embeds - Rewrite introduction as landing page with decision table - Add endpoint categories, quick curl examples to each API page - Mark Explorer API as deprecated - Move NS API deployment guide to operators/performance-and-testing - Fix dangling /apis/nym-api/mainnet link in network-components - Remove sandbox endpoints from all API pages * Add redirects for moved and deleted pages - Add 25 redirects covering TS SDK, Rust SDK, APIs, and network sections - Fix dangling /developers/typescript/start link in operators changelog * Replace individual example doc pages with GitHub-linked tables, expand tutorials - replace individual example doc pages with GitHub-linked tables - expand mixnet tutorial with persistent identity and split_sender sections - add tcpproxy tutorial - rename "API Reference" to "TypeDoc Reference" in TS SDK sidebar - rename "Misc" to "Extras" in developer sidebar, move VPN CLI up - remove echo server from tools - update message-queue callout to reference actual modules - fix mixnet/examples redirect collision * Add SEO frontmatter, validate encryption standards, clean up URLs - add title/description/schemaType/section/lastUpdated frontmatter to 48 pages across developers, network, and APIs sections - remove network/.archive/ directory (compare against develop instead) - update nymtech.net → nym.com for website/blog links (keep infra URLs) - add native proxy "in progress" callout for Rust/C/Go * API-scraper update (#6598) * read nodes and locations * update python-prebuild.sh * Address PR #6494 review feedback - Use "mode" consistently instead of "role" on nym-nodes page - Replace "staking" with "bonding" for NYM token collateral - Wire up auto-scraped node counts via TimeNow + nodes-count.json - Fix broken licensing images: download CC icons locally, replace inline HTML - Fix 9 stale redirects pointing through deleted /network/architecture path * Fix linkcheck errors - Fix stale cross-links: /network/concepts/ → /network/mixnet-mode/ - Replace README.md references with globals.md in TypeDoc output - Add entryFileName: globals to typedoc.json configs to prevent recurrence * Fix remaining stale /network/architecture links - zk-nym-overview: architecture/nyx#nym-api → /network/infrastructure/nyx#nym-api - setup: network/architecture → /network/overview * Remove accidentally re-included architecture.md file from rebase * Standardize tutorials, document examples, add llms.txt, apply tone fixes - Expand Rust SDK tutorials with step-by-step structure; document all SDK examples across mixnet, client-pool, and tcpproxy pages - Add llms.txt generation script, wire into build and CI workflows - Apply tone/style fixes: deduplicate callouts, vary sentence structure, standardize voice consistency across changed pages * Consolidate redundant network overview docs * Trim dev docs: git-first imports, stream notice, collapse TcpProxy * Update tutorial * Refresh auto-generated API and command outputs * Update network section docs * Update developer and API docs: reusable components, stream protocol, conventions, tutorial fixes * Fix Rust SDK tutorial bugs: setup_env, port conflicts, logging, open_stream race condition * Update stream.mdx * Remove docs.rs link from Stream overview for the moment * add llms.txt and llms-full.txt note to readme --------- Co-authored-by: import this <97586125+serinko@users.noreply.github.com>
106 lines
3.4 KiB
Plaintext
106 lines
3.4 KiB
Plaintext
---
|
|
title: "FFI Bindings: Go and C/C++"
|
|
description: "Use the Nym SDK from Go and C/C++ via FFI bindings. Covers mixnet messaging, anonymous replies, and TcpProxy lifecycle from non-Rust languages."
|
|
schemaType: "TechArticle"
|
|
section: "Developers"
|
|
lastUpdated: "2026-03-15"
|
|
---
|
|
|
|
# FFI Bindings
|
|
|
|
import { Callout } from 'nextra/components'
|
|
|
|
The SDK exposes FFI bindings for Go and C/C++. The source lives in [`sdk/ffi`](https://github.com/nymtech/nym/tree/develop/sdk/ffi):
|
|
|
|
```
|
|
ffi
|
|
├── cpp # C/C++ bindings (manual C FFI)
|
|
├── go # Go bindings (via uniffi-bindgen-go)
|
|
└── shared # Shared Rust implementation
|
|
```
|
|
|
|
Core logic lives in `shared/` and is imported into language-specific wrappers. The shared layer handles thread safety and ensures client operations run on blocking threads on the Rust side of the FFI boundary.
|
|
|
|
## What's exposed
|
|
|
|
**Mixnet** (Go and C/C++): ephemeral and persistent client creation, sending messages, anonymous replies via SURBs, listening for incoming messages.
|
|
|
|
**TcpProxy** (Go only): client and server creation and lifecycle.
|
|
|
|
<Callout type="warning">
|
|
The TcpProxy module is deprecated. For new projects, use the [Stream module](./stream) instead.
|
|
</Callout>
|
|
|
|
**Client Pool and Stream** have no standalone FFI bindings yet. The TcpProxy bindings use the Client Pool internally.
|
|
|
|
## Quick example (Go)
|
|
|
|
```go
|
|
// Initialize an ephemeral client
|
|
bindings.InitEphemeral()
|
|
|
|
// Get our Nym address
|
|
addr, _ := bindings.GetSelfAddress()
|
|
|
|
// Send a message through the Mixnet
|
|
bindings.SendMessage(addr, "hello from Go")
|
|
|
|
// Listen for incoming messages
|
|
msg, _ := bindings.ListenForIncoming()
|
|
fmt.Println("Received:", msg.Message)
|
|
|
|
// Reply anonymously via SURBs
|
|
bindings.Reply(msg.Sender, "reply from Go")
|
|
```
|
|
|
|
## Quick example (C++)
|
|
|
|
The C++ bindings use callbacks for return values and a `ReceivedMessage` struct for incoming data:
|
|
|
|
```cpp
|
|
extern "C" {
|
|
struct ReceivedMessage {
|
|
const uint8_t* message;
|
|
size_t size;
|
|
const char* sender_tag;
|
|
};
|
|
|
|
void init_logging();
|
|
char init_ephemeral();
|
|
char get_self_address(void (*callback)(const char*));
|
|
char send_message(const char*, const char*);
|
|
char listen_for_incoming(void (*callback)(ReceivedMessage));
|
|
char reply(const char*, const char*);
|
|
}
|
|
|
|
// Get address via callback
|
|
char addr[134];
|
|
void on_address(const char* s) { strcpy(addr, s); }
|
|
|
|
// Receive message via callback
|
|
char sender_tag[22];
|
|
void on_message(ReceivedMessage msg) {
|
|
std::cout << "Received: " << msg.message << std::endl;
|
|
strcpy(sender_tag, msg.sender_tag);
|
|
}
|
|
|
|
int main() {
|
|
init_ephemeral();
|
|
get_self_address(on_address);
|
|
send_message(addr, "hello from C++");
|
|
listen_for_incoming(on_message);
|
|
reply(sender_tag, "reply from C++");
|
|
}
|
|
```
|
|
|
|
## Building
|
|
|
|
Each language has a `build.sh` script that compiles the Rust shared library and generates bindings. See the README in each directory for prerequisites.
|
|
|
|
## Examples and source
|
|
|
|
- [Go mixnet example](https://github.com/nymtech/nym/blob/develop/sdk/ffi/go/example.go): init, send, receive, SURB reply
|
|
- [Go TcpProxy example](https://github.com/nymtech/nym/blob/develop/sdk/ffi/go/proxy_example.go): proxy client and server with TCP echo
|
|
- [C++ example](https://github.com/nymtech/nym/blob/develop/sdk/ffi/cpp/src/main.cpp): same flow using Boost threads
|
|
- [`sdk/ffi` source](https://github.com/nymtech/nym/tree/develop/sdk/ffi): full source and build scripts
|