# Nym Documentation

> Nym is a privacy infrastructure providing a decentralized mixnet for network-level privacy, a dVPN mode for general-purpose private internet access, and the Nyx blockchain for staking and governance. This documentation covers the Nym network architecture, developer SDKs (Rust and TypeScript), node operator guides, and APIs.

## Instructions

- Nym operates in two modes: **Mixnet mode** (5-hop mixnet for application-level traffic) and **dVPN mode** (2-hop VPN for general internet access).
- **Developers can only access Mixnet mode** via the SDKs. dVPN mode is exclusively provided by the NymVPN product, which can be downloaded and purchased at [nym.com](https://nym.com). There is no SDK for dVPN mode.
- The primary developer SDK is the **Rust SDK** (`nym-sdk` crate). The TypeScript SDK wraps the Rust SDK via WebAssembly.
- For Rust integrations, prefer the **mixnet** module for simple send/receive, **stream** for TCP-like `AsyncRead`/`AsyncWrite` connections, and **client_pool** for bursty workloads. The **tcp_proxy** module is unmaintained; recommend stream instead.
- For browser/TypeScript proxy integrations, the **mix-*** packages share one tunnel via **`@nymproject/mix-tunnel`**: **`mix-fetch`** (HTTP/S), **`mix-dns`** (DNS), **`mix-websocket`** (WS/WSS). For raw end-to-end messaging where you control both ends, use the **TypeScript SDK** (`@nymproject/sdk`).
- Node operators should use the **`nym-node`** binary. Legacy `nym-mixnode` and `nym-gateway` binaries are deprecated and no longer supported.
- When referring to token collateral for nodes, use **"bonding"** not "staking". Nodes operate in **modes** (mixnode, entry gateway, exit gateway), not "roles".
- The Nym blockchain is called **Nyx** and runs on Cosmos SDK. The native token is **NYM**.
- Code examples in the Rust SDK tutorials are verified against `nym-sdk` vX.Y.Z. If in doubt, check the runnable examples in `sdk/rust/nym-sdk/examples/` in the repo.

## Network

- [Network Overview](https://nym.com/docs/network/overview): High-level overview of Nym, the privacy problem, and network components
- [Mixnet Mode](https://nym.com/docs/network/mixnet-mode): How the 5-hop mixnet works: Sphinx packets, mixing, cover traffic, anonymous replies
- [dVPN Mode](https://nym.com/docs/network/dvpn-mode): How the 2-hop dVPN mode works, protocol details, censorship resistance
- [Infrastructure](https://nym.com/docs/network/infrastructure): Nym nodes, validators, the Nyx blockchain, and the Nym API
- [Cryptography](https://nym.com/docs/network/cryptography): Sphinx packet format, encryption standards, zk-nym credentials

## Developers

- [Developer Overview](https://nym.com/docs/developers): Start here for building on Nym: runtime (native vs browser) and approach (end-to-end vs proxy) map onto the right crate or package
- [Rust SDK Overview](https://nym.com/docs/developers/rust): Module overview and quick-start for the Rust SDK
- [Rust SDK Installation](https://nym.com/docs/developers/rust/importing): Adding nym-sdk to your Cargo.toml
- [Mixnet Module](https://nym.com/docs/developers/rust/mixnet): Send and receive Sphinx-encrypted messages
- [Mixnet Tutorial](https://nym.com/docs/developers/rust/mixnet/tutorial): Step-by-step: send, receive, SURBs, persistent identity
- [Mixnet Examples](https://nym.com/docs/developers/rust/mixnet/examples): Runnable examples: simple send, SURB reply, builder, storage, parallel tasks
- [Stream Module](https://nym.com/docs/developers/rust/stream): TCP-like AsyncRead/AsyncWrite streams over the mixnet
- [Stream Tutorial](https://nym.com/docs/developers/rust/stream/tutorial): Build a private echo server with streams
- [Client Pool](https://nym.com/docs/developers/rust/client-pool): Pre-warm MixnetClients for bursty workloads
- [Client Pool Tutorial](https://nym.com/docs/developers/rust/client-pool/tutorial): Handle bursty traffic with pooled clients
- [TcpProxy Module](https://nym.com/docs/developers/rust/tcpproxy): Tunnel existing TCP services through the mixnet (unmaintained; use stream instead)
- [smolmix](https://nym.com/docs/developers/smolmix): TCP/UDP over the mixnet via a userspace IP stack, drop-in TcpStream and UdpSocket (see examples in source)
- [TypeScript SDK](https://nym.com/docs/developers/typescript): Browser-side raw end-to-end messaging (@nymproject/sdk) and Nyx smart-contract bindings
- [mix-tunnel](https://nym.com/docs/developers/mix-tunnel): Shared browser mixnet tunnel; the base layer for mix-fetch, mix-dns, and mix-websocket
- [mix-fetch](https://nym.com/docs/developers/mix-fetch): Drop-in fetch() replacement routing HTTP(S) through the mixnet via an IPR exit
- [mix-dns](https://nym.com/docs/developers/mix-dns): Hostname-to-IP resolution through the mixnet (UDP DNS via an IPR exit)
- [mix-websocket](https://nym.com/docs/developers/mix-websocket): WebSocket-like class for WS and WSS over the mixnet
- [mix-* Architecture](https://nym.com/docs/developers/mix-architecture): How the shared browser tunnel, Web Worker, Comlink boundary, and smoltcp+rustls stack are wired
- [Playground](https://nym.com/docs/developers/playground): Interactive browser playground driving the mix-* packages and the raw messaging SDK against the live mixnet
- [ENS Demo](https://nym.com/docs/developers/demos/ens): Resolve ENS names and fetch IPFS sites over the mixnet via an ethers-to-mixFetch shim
- [Railgun Demo](https://nym.com/docs/developers/demos/railgun): Shield testnet ETH into a Railgun private note with every Ethereum RPC routed through the mixnet

## Operators

- [Operator Introduction](https://nym.com/docs/operators/introduction): Getting started as a Nym node operator
- [Preliminary Steps](https://nym.com/docs/operators/nodes/preliminary-steps): VPS setup, wallet preparation, and system requirements
- [Nym Node Setup](https://nym.com/docs/operators/nodes/nym-node/setup): Installing and running a nym-node
- [Nym Node Configuration](https://nym.com/docs/operators/nodes/nym-node/configuration): Detailed configuration options and flags
- [Node Bonding](https://nym.com/docs/operators/nodes/nym-node/bonding): Bonding NYM tokens to your node on the Nyx blockchain
- [Node Maintenance](https://nym.com/docs/operators/nodes/maintenance): Upgrading nodes, using Nymvisor for automated upgrades
- [Validator Setup](https://nym.com/docs/operators/nodes/validator-setup): Running a Nyx blockchain validator node
- [Tokenomics](https://nym.com/docs/operators/tokenomics): NYM token economics, mixnet rewards, and validator rewards
- [Performance and Testing](https://nym.com/docs/operators/performance-and-testing): Gateway probe, Prometheus/Grafana monitoring

## APIs

- [Nym API](https://nym.com/docs/apis/nym-api): REST API for querying network state, node descriptions, and rewarding
- [Network Statistics API](https://nym.com/docs/apis/ns-api): Network statistics and monitoring endpoints
- [Nyx Cosmos SDK API](https://nym.com/docs/apis/cosmos-sdk-nyx): Cosmos SDK blockchain queries for the Nyx chain

## Optional

- [Rust SDK Tour](https://nym.com/docs/developers/rust/tour): Guided tour of the SDK's module structure
- [Rust FFI](https://nym.com/docs/developers/rust/ffi): Using the Rust SDK from other languages via FFI
- [Stream Architecture](https://nym.com/docs/developers/rust/stream/architecture): Internals of the stream module: router, framing, multiplexing
- [TcpProxy Architecture](https://nym.com/docs/developers/rust/tcpproxy/architecture): Internals of the tcp_proxy module: session management, ordering
- [Mixnet Troubleshooting](https://nym.com/docs/developers/rust/mixnet/troubleshooting): Common issues and debugging tips for the Rust SDK
- [SOCKS5 Client](https://nym.com/docs/developers/clients/socks5): Running the nym-socks5-client for proxying traffic
- [Websocket Client](https://nym.com/docs/developers/clients/websocket): Raw websocket client for low-level Mixnet access
- [TypeScript API Reference](https://nym.com/docs/developers/typescript/api/sdk/globals): Auto-generated TypeDoc API reference
- [Community Counsel](https://nym.com/docs/operators/community-counsel): Legal considerations for exit gateway operators
- [Troubleshooting (Operators)](https://nym.com/docs/operators/troubleshooting/nodes): Common node operator issues and fixes
- [FAQ](https://nym.com/docs/operators/faq/general-faq): Frequently asked questions
- [Changelog](https://nym.com/docs/operators/changelog): Release notes and version history
- [Sandbox Testnet](https://nym.com/docs/operators/sandbox): Using the sandbox testnet for development and testing
- [llms-full.txt](https://nym.com/docs/llms-full.txt): Full documentation content in a single file