Update nym-sdk README module descriptions

- Replace stale stream_wrapper description with ipr_wrapper + mixnet::stream
- Remove TODO comment
This commit is contained in:
mfahampshire
2026-03-30 13:17:44 +01:00
parent 9b0cc9d691
commit 7bed2f30bf
+2 -2
View File
@@ -1,9 +1,9 @@
# Nym Rust SDK
This repo contains several components:
- `mixnet`: exposes Nym Client builders and methods. This is useful if you want to interact directly with the Client, or build transport abstractions.
- `mixnet`: exposes Nym Client builders and methods. This is useful if you want to interact directly with the Client, or build transport abstractions. The `mixnet::stream` submodule provides `MixnetStream` — a TCP-socket-like abstraction over the mixnet with LP Stream framing, sequence numbering, and `AsyncRead`/`AsyncWrite` support.
- `ipr_wrapper`: provides `IpMixStream`, a high-level interface for tunnelling IP packets through Exit Gateways' IpPacketRouter (IPR) over the mixnet. Built on `MixnetStream`, it handles gateway discovery, connect handshakes, and IP packet send/receive. See the [`smolmix`](../../smolmix) crate for a full tunnel implementation using this module.
- `tcp_proxy`: exposes functionality to set up client/server instances that expose a localhost TcpSocket to read/write to like a 'normal' socket connection. `tcp_proxy/bin/` contains standalone `nym-proxy-client` and `nym-proxy-server` binaries.
- `clientpool`: a configurable pool of ephemeral Nym Clients which can be created as a background process and quickly grabbed.
- `stream_wrapper`: made up of two parts: a TCP-Socket-like abstraction (`mixnet_stream_wrapper.rs`) for a Nym Client, and an abstraction built on top of this (`mixnet_stream_wrapper_ipr`) which allows for client-side integrations to send IP packets through Exit Gateways' IpPacketRouter, and use the Mixnet as a proxy. For an example of where this is used, see the `smolmix` crate.
Documentation can be found [here](https://nym.com/docs/developers/rust).