Mark Sinclair
685f26792f
* Remove pnpm-lock.yaml * Add initial documentation * updating packages and disconnecting on mixFetch when unmount * handle the mixFetch error * remove the mixfetch disconexion * using now rc5 version * Update overview * Update installation page * wip startong * Copy edits and improving some of the formatting and styling * Improve naming * Add CosmosKit example * Linting * Update next.js * Remove lock file * More CosmosKit docs * wip * cleaninig a bit * quick fix for wallet error * wip wallet ui * wip wallet ui * more wallet ui * fixing key error * wip * Example code * Add custom style for code blocks to limit their height and scroll * Change bg on darkmode * Add styling to darkmode * Reorg CSS - tbc * Move example code * Ledger support in Cosmos Kit - wip * Change default app to Typescript * Remove static export * Tidy up wallet UI * Set theme colour by hue * Force dark mode theme * some wallet ui * Style buttons sidebar * Sidebar colors * Links styling * Style callouts * Add styling to button, chips, progress motion component * Style agenda * adding loaders * wallet loaders * traffic styles * Fix colours * Add links to methods * Add execute code block * Add traffic codeblock * Add mixfetch codeblock * Add Cosmokit codeblock * Update info on getting started * fixing build * Fix build error * Fix theme * Fix filenames on examples * Add copy to CosmosKit example --------- Co-authored-by: Mark Sinclair <mmsinclair@users.noreply.github.com> Co-authored-by: Gala <calero.vg@gmail.com> Co-authored-by: Lorexia <alexia.lorenza.martinel@protonmail.com>
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.
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
We used to use Keybase for developer chats, but we have since migrated to Matrix and Discord. We no longer check the old nymtech.friends Keybase team.
You can chat to us in two places:
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 competitiveness 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:
and
Operator of node i is credited with the following amount:
Delegate with stake s receives:
where s' is stake s scaled over total token circulating supply.
Licensing and copyright information
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.