Jędrzej Stuczyński
085761a9fb
* Unnrolled the loop into separate function * Ugly way of saving rewarding status * Initial way of rewarding next page of delegators * Attribute passing * Promoted transactions to directory * Moved rewarding-related functionalities into separate file * [ci skip] Generate TS types * Better errors on double rewarding attempt * Removed old rewarding call * Test fixes * Some cleanup * Paged mixnode rewarding test + serde fixes * Tests for delegator rewarding * ExecuteMsg for MixDelegatorRewarding * Made validator-api code compliable with bunch of todo!() macros * Removed Option wrapper from params in MixnodeToReward * Calculating uptime for entire epoch * Created shared MIXNODE_DELEGATORS_PAGE_LIMIT constant * Using new rewarding messages in validator API * cargo fmt * Updated wallet state types * Additional test for correct rewarding information * Query for rewarding status * Additional test regarding delegator rewarding * Client methods for obtaining rewarding status * Validator API checking for full rewarding * Removed unused field from validator api config template * Waiting for MINIMUM number of test routes * Waiting initialisation_backoff in the early return case * Fixes crash condition in validator API when calculating last day uptime * Fixed typo * Dealing with the case of rewarding mixnode with 0 uptime * Removed temporary unwrap * Guarding against 0-size rewarded/active sets Co-authored-by: jstuczyn <jstuczyn@users.noreply.github.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, removing the need for directly 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 (currently in development)- a desktop wallet implemented using the Tauri framework.
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.
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 plaged to their node to the token circulating supply. | |
fraction of total effort undertaken by node i, set to 1/k in testnet Milhon. |
|
number of nodes stakeholders are incentivised to create, set by the validators, a matter of governance. Currently determined by the active set size, and set to 5000 in testnet Milhon. |
|
| 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 testnet Milhon. |
|
uptime of node i, scaled to 0 - 1, for the rewarding epoch |
|
cost of operating node i for the duration of the rewarding eopoch, set to 40 Nym for testnet Milhon. |
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.
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.