From 5b67403fb9a80fa6140ec9c0ca17a51bc39edda2 Mon Sep 17 00:00:00 2001 From: import this <97586125+serinko@users.noreply.github.com> Date: Fri, 6 Jun 2025 09:57:48 +0000 Subject: [PATCH] [DOCs/operators]: Add auto scraping of staking_supply_scale_factor & update api outputs (#5832) --- .../components/operators/snippets/stake-saturation.mdx | 4 ---- .../api-scraping-outputs/circulating-supply.json | 4 ++-- .../nyx-outputs/circulating-supply.md | 2 +- .../nyx-outputs/epoch-reward-budget.md | 2 +- .../nyx-outputs/stake-saturation.md | 2 +- .../nyx-outputs/staking-scale-factor.md | 2 +- .../api-scraping-outputs/nyx-outputs/staking-target.md | 2 +- .../api-scraping-outputs/nyx-outputs/staking_supply.md | 2 +- .../api-scraping-outputs/nyx-outputs/token-table.md | 6 +++--- .../outputs/api-scraping-outputs/reward-params.json | 10 +++++----- .../outputs/api-scraping-outputs/time-now.md | 2 +- documentation/docs/pages/operators/tokenomics.mdx | 8 ++------ documentation/scripts/api-scraping/api_targets.py | 3 ++- 13 files changed, 21 insertions(+), 28 deletions(-) diff --git a/documentation/docs/components/operators/snippets/stake-saturation.mdx b/documentation/docs/components/operators/snippets/stake-saturation.mdx index 8e0435b958..b17b73ac10 100644 --- a/documentation/docs/components/operators/snippets/stake-saturation.mdx +++ b/documentation/docs/components/operators/snippets/stake-saturation.mdx @@ -13,10 +13,6 @@ Stake saturation is a node reputation done in a form of self bond or stakers del > **rewarded_set_size = active_set_size + standby_set_size** -{/* -With current circulating supply of NYM, staking target of NYM, divided by the sum of nodes in the [rewarded set](https://validator.nymtech.net/api/v1/epoch/reward_params), the stake saturation level is NYM per node. -*/} - With current circulating supply of NYM, staking target of NYM, divided by the sum of nodes in the [rewarded set](https://validator.nymtech.net/api/v1/epoch/reward_params), the stake saturation level is NYM per node. Node stake saturation is a value between `0` and `1` following this logic. diff --git a/documentation/docs/components/outputs/api-scraping-outputs/circulating-supply.json b/documentation/docs/components/outputs/api-scraping-outputs/circulating-supply.json index 97f943e158..060eb96030 100644 --- a/documentation/docs/components/outputs/api-scraping-outputs/circulating-supply.json +++ b/documentation/docs/components/outputs/api-scraping-outputs/circulating-supply.json @@ -5,7 +5,7 @@ }, "mixmining_reserve": { "denom": "unym", - "amount": "188691142067690" + "amount": "187227500568584" }, "vesting_tokens": { "denom": "unym", @@ -13,6 +13,6 @@ }, "circulating_supply": { "denom": "unym", - "amount": "811308857932310" + "amount": "812772499431416" } } diff --git a/documentation/docs/components/outputs/api-scraping-outputs/nyx-outputs/circulating-supply.md b/documentation/docs/components/outputs/api-scraping-outputs/nyx-outputs/circulating-supply.md index 988b2034ec..679f542c4e 100644 --- a/documentation/docs/components/outputs/api-scraping-outputs/nyx-outputs/circulating-supply.md +++ b/documentation/docs/components/outputs/api-scraping-outputs/nyx-outputs/circulating-supply.md @@ -1 +1 @@ -811_308_857 +812_772_499 diff --git a/documentation/docs/components/outputs/api-scraping-outputs/nyx-outputs/epoch-reward-budget.md b/documentation/docs/components/outputs/api-scraping-outputs/nyx-outputs/epoch-reward-budget.md index 9fae781574..cb66fed878 100644 --- a/documentation/docs/components/outputs/api-scraping-outputs/nyx-outputs/epoch-reward-budget.md +++ b/documentation/docs/components/outputs/api-scraping-outputs/nyx-outputs/epoch-reward-budget.md @@ -1 +1 @@ -5_241 +5_200 diff --git a/documentation/docs/components/outputs/api-scraping-outputs/nyx-outputs/stake-saturation.md b/documentation/docs/components/outputs/api-scraping-outputs/nyx-outputs/stake-saturation.md index f3b0263af2..f6f11060bd 100644 --- a/documentation/docs/components/outputs/api-scraping-outputs/nyx-outputs/stake-saturation.md +++ b/documentation/docs/components/outputs/api-scraping-outputs/nyx-outputs/stake-saturation.md @@ -1 +1 @@ -1_034_081 +1_037_131 diff --git a/documentation/docs/components/outputs/api-scraping-outputs/nyx-outputs/staking-scale-factor.md b/documentation/docs/components/outputs/api-scraping-outputs/nyx-outputs/staking-scale-factor.md index 602604b10d..efc97dcecc 100644 --- a/documentation/docs/components/outputs/api-scraping-outputs/nyx-outputs/staking-scale-factor.md +++ b/documentation/docs/components/outputs/api-scraping-outputs/nyx-outputs/staking-scale-factor.md @@ -1 +1 @@ -50.0% +30.63% diff --git a/documentation/docs/components/outputs/api-scraping-outputs/nyx-outputs/staking-target.md b/documentation/docs/components/outputs/api-scraping-outputs/nyx-outputs/staking-target.md index b64d58743f..5df8d8b43b 100644 --- a/documentation/docs/components/outputs/api-scraping-outputs/nyx-outputs/staking-target.md +++ b/documentation/docs/components/outputs/api-scraping-outputs/nyx-outputs/staking-target.md @@ -1 +1 @@ -405_654_428 +248_911_577 diff --git a/documentation/docs/components/outputs/api-scraping-outputs/nyx-outputs/staking_supply.md b/documentation/docs/components/outputs/api-scraping-outputs/nyx-outputs/staking_supply.md index 416fde1c57..5df8d8b43b 100644 --- a/documentation/docs/components/outputs/api-scraping-outputs/nyx-outputs/staking_supply.md +++ b/documentation/docs/components/outputs/api-scraping-outputs/nyx-outputs/staking_supply.md @@ -1 +1 @@ -248_179_643 +248_911_577 diff --git a/documentation/docs/components/outputs/api-scraping-outputs/nyx-outputs/token-table.md b/documentation/docs/components/outputs/api-scraping-outputs/nyx-outputs/token-table.md index 2aaa77a0e5..e9ed67ebdc 100644 --- a/documentation/docs/components/outputs/api-scraping-outputs/nyx-outputs/token-table.md +++ b/documentation/docs/components/outputs/api-scraping-outputs/nyx-outputs/token-table.md @@ -1,7 +1,7 @@ | **Item** | **Description** | **Amount in NYM** | |:-------------------|:------------------------------------------------------|--------------------:| | Total Supply | Maximum amount of NYM token in existence | 1_000_000_000 | -| Mixmining Reserve | Tokens releasing for operators rewards | 188_691_142 | +| Mixmining Reserve | Tokens releasing for operators rewards | 187_227_500 | | Vesting Tokens | Tokens locked outside of cicrulation for future claim | 0 | -| Circulating Supply | Amount of unlocked tokens | 811_308_857 | -| Stake Saturation | Optimal size of node self-bond + delegation | 1_034_081 | +| Circulating Supply | Amount of unlocked tokens | 812_772_499 | +| Stake Saturation | Optimal size of node self-bond + delegation | 1_037_131 | diff --git a/documentation/docs/components/outputs/api-scraping-outputs/reward-params.json b/documentation/docs/components/outputs/api-scraping-outputs/reward-params.json index 49e9bdc321..d811dfdbce 100644 --- a/documentation/docs/components/outputs/api-scraping-outputs/reward-params.json +++ b/documentation/docs/components/outputs/api-scraping-outputs/reward-params.json @@ -1,10 +1,10 @@ { "interval": { - "reward_pool": "188691142067690.265566584946684804", - "staking_supply": "248179643769563.241524591796100959", - "staking_supply_scale_factor": "0.5", - "epoch_reward_budget": "5241420612.991396265738470741", - "stake_saturation_point": "1034081849039.84683968579915042", + "reward_pool": "187227500568584.066152911712126276", + "staking_supply": "248911577950871.129740670788161327", + "staking_supply_scale_factor": "0.30625", + "epoch_reward_budget": "5200763904.682890726469769781", + "stake_saturation_point": "1037131574795.296373919461617338", "sybil_resistance": "0.3", "active_set_work_factor": "10", "interval_pool_emission": "0.02" diff --git a/documentation/docs/components/outputs/api-scraping-outputs/time-now.md b/documentation/docs/components/outputs/api-scraping-outputs/time-now.md index 5533879ed6..ac97e28533 100644 --- a/documentation/docs/components/outputs/api-scraping-outputs/time-now.md +++ b/documentation/docs/components/outputs/api-scraping-outputs/time-now.md @@ -1 +1 @@ -Wednesday, May 28th 2025, 11:39:51 UTC +Friday, June 6th 2025, 09:33:10 UTC diff --git a/documentation/docs/pages/operators/tokenomics.mdx b/documentation/docs/pages/operators/tokenomics.mdx index c582a41be0..8247730461 100644 --- a/documentation/docs/pages/operators/tokenomics.mdx +++ b/documentation/docs/pages/operators/tokenomics.mdx @@ -104,6 +104,7 @@ To get a full comprehension of [node operators rewards](tokenomics/mixnet-reward ``` #### Supply +
Circulating supply is NYM. @@ -118,15 +119,10 @@ A number of aimed NYM tokens to be staked in the network. The staking target a i > **staking_target = staking_supply_scale_factor \* circulating_supply** -{/* -Staking supply scale factor is currently it's set to be . +Staking supply scale factor is currently at . The value of this variable can is changed from time to time to optimize the metrics of the network. With a current circulating supply of NYM and staking supply scale factor , the staking target is NYM. -*/} -Staking supply scale factor is currently at 30.5%. - -The value of this variable is changed from time to time to optimize the metrics of the network. With a current circulating supply of NYM and staking supply scale factor 30.5%, the staking target is NYM. #### Stake saturation diff --git a/documentation/scripts/api-scraping/api_targets.py b/documentation/scripts/api-scraping/api_targets.py index c4cab82172..6bf8015047 100644 --- a/documentation/scripts/api-scraping/api_targets.py +++ b/documentation/scripts/api-scraping/api_targets.py @@ -140,6 +140,7 @@ def get_nested_value(response, args): def _return_percent_annotation(value): value = float(value) * 100 + value = round(value, 2) value = f"{value}%" return value @@ -269,7 +270,7 @@ def parser_main(): action="store_true", help="A multiplier of staking supply scale factor and circulating supply" ) - + parser_calculate.add_argument( "-s", "--separator", type=str,