Repository files navigation

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-gateway andexit-gateway are fundamental components of Nym Mixnet architecture. Nym Nodes are ran by decentralised node operators. Read more aboutnym-node inOperators Guide documentation. Network functionality ofnym-node (labeled with--mode flag) can be:
  • mixnode - shufflesSphinx 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-gateway andexit-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 theTauri) framework.
• nym-cli - a tool for interacting with the network from the CLI.

                      ┌─►mix──┐  mix     mix                      │       │            Entry     │       │                   Exitclient ───► Gateway ──┘  mix  │  mix  ┌─►mix ───► Gateway ───► internet                              │       │                              │       │                         mix  └─►mix──┘  mix

• Platform build instructions are available on NymOperators Guide documentation.
• Wallet build instructions are availablehere.

References for developers:

• Dev Docs
• SDKs
• Network Docs
• Release Cycle - git flow

You can chat to us in the #dev channel onMatrix or on theNym Forum.

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 ofNym Whitepaper.Initial reward pool is set to 250 million Nym, making the circulating supply 750 million Nym.

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 foundhere.

yarn install

yarn build