Files
nym/README.md
T
Dave Hrycyszyn c9d632c8b6 Update README.md
2020-01-20 14:59:34 +00:00

1.1 KiB

The Nym Privacy Platform

This repository contains the full Nym platform, written in Rust.

The platform is composed of multiple Rust crates. Top-level executable binary crates include:

  • client - an executable which you can build into your own applications. Use it for interacting with Nym nodes.
  • mixnode - the mixnode crate.
  • 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.

Build Status

Building

Platform build instructions are available on our docs site.

Developing

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.