This repository contains the full Nym platform, written in Rust.
The platform is composed of multiple Rust crates. Top-level executable binary crates include:
- mixnode - shuffles Sphinx packets together to provide privacy against network-level attackers.
- nym-client - an executable which you can build into your own applications. Use it for interacting with Nym nodes.
- sfw-provider - a store-and-forward service provider. The provider acts sort of like a mailbox for mixnet messages.
- validator - currently just starting development. Handles consensus ordering of transactions, mixmining, and coconut credential generation and validation.
Platform build instructions are available on our docs site.
There's a .env.sample-dev file provided which you can rename to .env if you want convenient logging, backtrace, or other environment variables pre-set. The .env file is ignored so you don't need to worry about checking it in.