Yana Matrosova
3a77eff16b
Add a headless sandbox smoke (src-tauri/examples/sandbox_families_smoke.rs) that exercises the node-families real-IPC layer against the contract deployed to sandbox, via the same validator-client calls the Tauri commands wrap. GUI automation of the real wallet can't run on macOS (tauri-driver is Linux/Windows only; Playwright can't drive the native webview), so this is the runnable equivalent of the manual Tier-3 smoke. - Read smoke (task 4.1): resolves the bundled sandbox families contract address, reads Config from raw state, lists live families/members/pending invites via real IPC. Passes against sandbox (2 families, fee 50 NYM, limits 30/50). - Guarded write journey (task 5.2, `-- --write`): create -> rename -> disband on the funded test account, with on-chain-latency polling and cleanup; refuses to run if the account already owns a family. All three txs confirmed on sandbox. invite/accept/reject/kick/revoke/leave are wired but need a controllable, unaffiliated sandbox node id (5.3 / rest of 5.2 still pending that fixture). The funded account mnemonic is read from .env (TAURI-WALLET-MNEMONIC, gitignored) at runtime and never printed or committed. Run instructions added to e2e/README.md; tasks 4.1/4.2 marked done, 5.2/5.4 partial, 5.3 still blocked on a node fixture. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
The Nym Privacy Platform
The platform is composed of multiple Rust crates. Top-level executable binary crates include:
nym-node- a tool for running a node within the Nym network. Nym Nodes containing functionality such asmixnode,entry-gatewayandexit-gatewayare fundamental components of Nym Mixnet architecture. Nym Nodes are ran by decentralised node operators. Read more aboutnym-nodein Operators Guide documentation. Network functionality ofnym-node(labeled with--modeflag) can be:mixnode- shuffles Sphinx packets together to provide privacy against network-level attackers.gateway- acts sort of like a mailbox for mixnet messages, which removes the need for direct delivery to potentially offline or firewalled devices. Gateways can be further categorized asentry-gatewayandexit-gateway. The latter has an extra embedded IP packet router and Network requester to route data to the internet.
nym-client- an executable which you can build into your own applications. Use it for interacting with Nym nodes.nym-socks5-client- a Socks5 proxy you can run on your machine and use with existing applications.nym-explorer- a (projected) block explorer and (existing) mixnet viewer.nym-wallet- a desktop wallet implemented using the Tauri) framework.nym-cli- a tool for interacting with the network from the CLI.
┌─►mix──┐ mix mix
│ │
Entry │ │ Exit
client ───► Gateway ──┘ mix │ mix ┌─►mix ───► Gateway ───► internet
│ │
│ │
mix └─►mix──┘ mix
This project integrates with the Midnight Network
Building
- Platform build instructions are available on Nym Operators Guide documentation.
- Wallet build instructions are available here.
Developing
References for developers:
Developer chat
You can chat to us in the #dev channel on Matrix or on the Nym Forum.
Tokenomics & Rewards
Nym network economic incentives, operator and validator rewards, and scalability of the network are determined according to the principles laid out in the section 6 of Nym Whitepaper. Initial reward pool is set to 250 million Nym, making the circulating supply 750 million Nym.
Licensing and copyright information
This is a monorepo and components that make up Nym as a system are licensed individually, so for accurate information, please check individual files.
As a general approach, licensing is as follows this pattern:
- applications and binaries are GPLv3
- libraries and components are Apache 2.0 or MIT
- documentation is Apache 2.0 or CC0-1.0
Nym Node Operators and Validators Terms and Conditions can be found here.
Getting Started
Requires Node.js version 24.
pnpm install
pnpm build