https://github.com/nymtech/nym

Nym provides strong network-level privacy against sophisticated end-to-end attackers, and anonymous transactions using blinded, re-randomizable, decentralized credentials.
https://github.com/nymtech/nym

decentralized mixnet mixnets rust rust-lang zero-knowledge

Last synced: 5 days ago
JSON representation

Nym provides strong network-level privacy against sophisticated end-to-end attackers, and anonymous transactions using blinded, re-randomizable, decentralized credentials.

• Host: GitHub
• URL: https://github.com/nymtech/nym
• Owner: nymtech
• Created: 2020-01-07T11:42:53.000Z (about 5 years ago)
• Default Branch: develop
• Last Pushed: 2024-12-30T22:59:35.000Z (13 days ago)
• Last Synced: 2024-12-30T23:18:06.676Z (13 days ago)
• Topics: decentralized, mixnet, mixnets, rust, rust-lang, zero-knowledge
• Language: Rust
• Homepage: https://nymtech.net
• Size: 259 MB
• Stars: 1,308
• Watchers: 48
• Forks: 236
• Open Issues: 150
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSES/Apache-2.0.txt
  • Codeowners: .github/CODEOWNERS
  • Security: SECURITY.md

Awesome Lists containing this project

• awesome-ccamel - nymtech/nym - Nym provides strong network-level privacy against sophisticated end-to-end attackers, and anonymous transactions using blinded, re-randomizable, decentralized credentials. (Rust)
• awesome-blockchain-rust - NYM
• popular-dependents-lists - nymtech/nym - 🌟 583 (Rambda / nymtech/nym)

README

        


## 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 as `mixnode`, `entry-gateway` and `exit-gateway` are fundamental components of Nym Mixnet architecture. Nym Nodes are ran by decentralised node operators. Read more about `nym-node` in [Operators Guide documentation](https://nymtech.net/operators/nodes/nym-node.html). Network functionality of `nym-node` (labeled with `--mode` flag) can be:

	- `mixnode` - shuffles [Sphinx](https://github.com/nymtech/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 as `entry-gateway` and `exit-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](https://tauri.studio/en/docs/about/intro) framework.

* `nym-cli` - a tool for interacting with the network from the CLI. 

```ascii

                      ┌─►mix──┐  mix     mix

                      │       │

            Entry     │       │                   Exit

client ───► Gateway ──┘  mix  │  mix  ┌─►mix ───► Gateway ───► internet

                              │       │

                              │       │

                         mix  └─►mix──┘  mix

```

[![Build Status](https://img.shields.io/github/actions/workflow/status/nymtech/nym/build.yml?branch=develop&style=for-the-badge&logo=github-actions)](https://github.com/nymtech/nym/actions?query=branch%3Adevelop)

### Building

* Platform build instructions are available on Nym [Operators Guide documentation](https://nymtech.net/operators/binaries/building-nym.html).

* Wallet build instructions are available [here](https://github.com/nymtech/nym/tree/master/nym-wallet#installation-prerequisites---linux--mac).

### Developing

References for developers:

* [Dev Docs](https://nymtech.net/docs/developers)

* [SDKs](https://nymtech.net/docs/developers/rust)

* [Network Docs](https://nymtech.net/docs/network)

* [Release Cycle - git flow](https://nymtech.net/docs/operators/release-cycle)

### Developer chat

You can chat to us in the #dev channel on [Matrix](https://matrix.to/#/#dev:nymtech.chat) or on the [Nym Forum](https://forum.nymtech.net).

### 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](https://nymtech.net/nym-whitepaper.pdf).

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 Temrs and Conditions can be found [here](https://nymtech.net/terms-and-conditions/operators/v1.0.0).