You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Tommy Verrall a94a9aeaf5
Update README.md
6 hours ago
.github Merge pull request #1521 from nymtech/release/nym-binaries-1.0.2 10 hours ago
.reuse Associating Copyright/ Licensing info through a DEP5 file 2 years ago
.wellknown/wallet Add wellknown validators json file 5 months ago
LICENSES Adding LICENSES directory and add licenses texts 2 years ago
assets nym-wallet: add font files for all weights for wallet as not working in some Linux distros (#1351) 2 months ago
clients Merge pull request #1521 from nymtech/release/nym-binaries-1.0.2 10 hours ago
common Merge pull request #1521 from nymtech/release/nym-binaries-1.0.2 10 hours ago
contracts Bump regex version to fix dependabot (#1488) 1 week ago
docker build(deps): bump protobufjs (#1408) 1 month ago
envs Change for default mainnet and fix typo 1 day ago
explorer Merge pull request #1504 from nymtech/smooth-filter-slider 2 days ago
explorer-api explorer-api: handle SIGTERM (#1482) 1 week ago
gateway Merge pull request #1521 from nymtech/release/nym-binaries-1.0.2 10 hours ago
mixnode Merge pull request #1521 from nymtech/release/nym-binaries-1.0.2 10 hours ago
nym-chitchat Chitchat example (#1464) 1 week ago
nym-connect socks5: remove pub mod not needed anymore (#1517) 1 day ago
nym-wallet update sample env (#1523) 10 hours ago
scripts Generated changelog for 1.0.0 3 months ago
service-providers add service-provider vesioning to match other binaries 2 days ago
testnet-faucet build(deps): bump protobufjs from 6.10.2 to 6.10.3 in /testnet-faucet (#1409) 1 month ago
tools Feature/changing wallet currency types frontend work (#1455) 4 weeks ago
ts-packages Explorer: tweak selection probability categories (#1503) 2 days ago
validator-api Update README.md 6 hours ago
.env.sample-dev adding license and copyright headers 2 years ago
.github_changelog_generator Adding github_changelog_generator config files 8 months ago
.gitignore Add GitHub Action to build `@nymproject/react` storybook and example 5 months ago
.ruby-version Adding github_changelog_generator config files 8 months ago
CHANGELOG.md Update changelog for v1.0.2 -reference 12 hours ago
Cargo.lock Update 1 day ago
Cargo.toml Update 1 day ago
Makefile Stake inflation mitigations (#1480) 2 weeks ago
README.md Merge pull request #1384 from Tonycrypto44/Tonycrypto44-patch-1 1 month ago
SECURITY.md Adding security disclosure instructions 4 months ago
docker-compose.yml Fix validator docker build on other platforms (#1329) 2 months ago
lerna.json Feature/wallet delegation UI squashed (#1326) 2 months ago
package.json typescript validator client: add `denom` argument to constructor (#1458) 4 weeks ago
yarn.lock Feature/bonding refactor (#1481) 3 days ago

README.md

The Nym Privacy Platform

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

  • nym-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.
  • nym-socks5-client - a Socks5 proxy you can run on your machine and use with existing applications.
  • nym-gateway - acts sort of like a mailbox for mixnet messages, which removes the need for direct delivery to potentially offline or firewalled devices.
  • nym-network-monitor - sends packets through the full system to check that they are working as expected, and stores node uptime histories as the basis of a rewards system ("mixmining" or "proof-of-mixing").
  • nym-explorer - a (projected) block explorer and (existing) mixnet viewer.
  • nym-wallet - a desktop wallet implemented using the Tauri framework.

License Build Status

Building

Platform build instructions are available on our docs site. Wallet build instructions are also 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.

For Typescript components, please see ts-packages.

Developer chat

You can chat to us in Keybase. Download their chat app, then click Teams -> Join a team. Type nymtech.friends into the team name and hit continue. For general chat, hang out in the #general channel. Our development takes places in the #dev channel. Node operators should be in the #node-operators channel.

Rewards

Node, node operator and delegator rewards are determined according to the principles laid out in the section 6 of Nym Whitepaper. Below is a TLDR of the variables and formulas involved in calculating the epoch rewards. Initial reward pool is set to 250 million Nym, making the circulating supply 750 million Nym.

Symbol Definition
global share of rewards available, starts at 2% of the reward pool.
node reward for mixnode i.
ratio of total node stake (node bond + all delegations) to the token circulating supply.
ratio of stake operator has pledged to their node to the token circulating supply.
fraction of total effort undertaken by node i, set to 1/k.
number of nodes stakeholders are incentivised to create, set by the validators, a matter of governance. Currently determined by the reward set size, and set to 720 in testnet Sandbox.
Sybil attack resistance parameter - the higher this parameter is set the stronger the reduction in competitivness gets for a Sybil attacker.
declared profit margin of operator i, defaults to 10% in.
uptime of node i, scaled to 0 - 1, for the rewarding epoch
cost of operating node i for the duration of the rewarding epoch, set to 40 NYMT.

Node reward for node i is determined as:

where:

and

Operator of node i is credited with the following amount:

Delegate with stake s recieves:

where s' is stake s scaled over total token circulating supply.

This program is available as open source under the terms of the Apache 2.0 license. However, some elements are being licensed under CC0-1.0 and MIT. For accurate information, please check individual files.