Developers
Rust SDK

Rust SDK

All modules share a common MixnetClient that manages gateway connections, Sphinx packet encryption, routing, and cover traffic.

Full API reference: docs.rs/nym-sdk (opens in a new tab)

⚠️
Crate publication is paused. The crates.io release (v1.20.4) doesn't include the Stream module or other recent work. Publication resumes with the Lewes Protocol. Import from Git for now — see Installation.

For an overview of what the SDK can do, see the Tour. For setup instructions, see Installation.

Modules

  • Stream: multiplexed AsyncRead + AsyncWrite byte streams over the Mixnet. If you're used to TCP sockets, start here.

  • Mixnet: raw message payloads, independently routed, no connections or ordering. Use this when you want full control over the communication model.

  • Client Pool: keeps ready-to-use MixnetClient instances warm for bursty workloads.

  • TcpProxy (deprecated): TCP socket proxying with session management and message ordering. Use Stream for new projects.

  • FFI: Go and C/C++ bindings.

Nym Client Message Queue and Cover TrafficTour