From 0941efe48a5077ee3e7dddccde7cb7c3982fb8c8 Mon Sep 17 00:00:00 2001 From: serinko <97586125+serinko@users.noreply.github.com> Date: Wed, 24 Jul 2024 11:12:05 +0200 Subject: [PATCH] nym token key points --- documentation/operators/src/SUMMARY.md | 6 ++--- .../operators/src/tokenomics/fair-mixnet.md | 27 +++++++++++++++++++ .../src/tokenomics/mixnet-rewards.md | 15 ++++++----- documentation/scripts/cmdrun/api_targets.py | 14 +++++++++- 4 files changed, 52 insertions(+), 10 deletions(-) create mode 100644 documentation/operators/src/tokenomics/fair-mixnet.md mode change 100644 => 100755 documentation/scripts/cmdrun/api_targets.py diff --git a/documentation/operators/src/SUMMARY.md b/documentation/operators/src/SUMMARY.md index 85b394583e..2e6eafd80a 100644 --- a/documentation/operators/src/SUMMARY.md +++ b/documentation/operators/src/SUMMARY.md @@ -47,9 +47,9 @@ # Token Economics - - -- [Nyx: Validator Rewards](tokenomics/validator-rewards.md) +- [Fair Mixnet](tokenomics/fair-mixnet.md) + - [Nym: Operators Rewards](tokenomics/mixnet-rewards.md) + - [Nyx: Validator Rewards](tokenomics/validator-rewards.md) # FAQ diff --git a/documentation/operators/src/tokenomics/fair-mixnet.md b/documentation/operators/src/tokenomics/fair-mixnet.md new file mode 100644 index 0000000000..290ba9babf --- /dev/null +++ b/documentation/operators/src/tokenomics/fair-mixnet.md @@ -0,0 +1,27 @@ +# Fair Mixnet + +```admonish info +**The data on this page were last time updated on .** +``` + +Nym Network is composed of two main elements, the Mixnet represented by [Nym Nodes](../nodes/nym-node.md) routing and mixing the data packets, and Nyx blockchain based on [validator set](validator-rewards.md), using smart contracts (based on [cosmwasm]()) to monitor and reward Nym Nodes by querying API endpoints and distributing NYM token to operators from Mixmining pool. + +MENTION WHITEPAPER HERE + +## NYM Token + +Besides the Mixnet itself, Nym Network is based on it's own blockchain Nyx (IBC on Cosmos) with a native token NYM. NYM token key features are: + +* **Incentives:** Distribute rewards to decentralised nodes based on mixing and routing (work). This dynamic ensures that the network is as robust as possible - the nodes are chosen every hour according to their performance. + +* **Network take over defense:** Nodes are chosen to the active set according to their reputation which is done through delegation (stake) where delegators earn proportional percentage of nodes rewards. + +* **Centralisation defense:** Any node can only have a certain stake (called stake saturation) to earn maximum rewards, increasing stake level per node leads to decreasing rewards for the operator and all delegators. This feature makes it more difficult for whales to attract more delegators (stakers) as they would become dis-advantaged. + +To learn more about rewards calculation and distributtion, read the next page [*Nym Operators Rewards*](mixnet-rewards.md). + +### Supply + +NYM token is + + diff --git a/documentation/operators/src/tokenomics/mixnet-rewards.md b/documentation/operators/src/tokenomics/mixnet-rewards.md index 14bcf4d850..1ca204926c 100644 --- a/documentation/operators/src/tokenomics/mixnet-rewards.md +++ b/documentation/operators/src/tokenomics/mixnet-rewards.md @@ -1,17 +1,20 @@ - - - - +# Nym Operators Rewards ```admonish info -All values were last time updated on . +**The data on this page were last time updated on .** ``` ## Supply - + + + + + + + diff --git a/documentation/scripts/cmdrun/api_targets.py b/documentation/scripts/cmdrun/api_targets.py old mode 100644 new mode 100755 index b258f6de84..0053b7f791 --- a/documentation/scripts/cmdrun/api_targets.py +++ b/documentation/scripts/cmdrun/api_targets.py @@ -1,3 +1,5 @@ +#!/usr/bin/python3 + import argparse import os import requests @@ -33,7 +35,16 @@ def subparser_read(args): def print_time_now(args): #now = datetime.now().strftime('%Y-%m-%d %H:%M:%S') #now = time.ctime() - now = strftime("%a, %d %b %Y %X +0000", gmtime()) + day = strftime("%d", gmtime()) + if day == "1" or day == "21" or day == "31": + suffix = "st" + elif day == "2" or day == "22": + suffix = "nd" + elif day == "3" or day == "23": + suffix = "rd" + else: + suffix = "th" + now = strftime(f"%A, %B %d{suffix} %Y, %X UTC", gmtime()) print(now) ############################################ @@ -65,6 +76,7 @@ def display_supply_table(response, args): df['**Item**'] = df['**Item**'].apply(remove_underscore) df['**Amount in NYM**'] = df['**Amount in NYM**'].apply(convert_u_nym) df['**Amount in NYM**'] = df['**Amount in NYM**'].apply(thousand_separator) + df.insert(1, '**Description**', ['foo', 'bar', 'lol', 'go'], True) table = df.to_markdown(index=False) print(table)