From e7848a1ed6a22275d4d944722321d4a460ef4928 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B6rn=20Assmann?= <101096424+bjoernek@users.noreply.github.com> Date: Mon, 11 Sep 2023 15:32:46 +0200 Subject: [PATCH 1/4] Create README.md --- sns_tokenomics_analyzer/README.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 sns_tokenomics_analyzer/README.md diff --git a/sns_tokenomics_analyzer/README.md b/sns_tokenomics_analyzer/README.md new file mode 100644 index 0000000..56db3ee --- /dev/null +++ b/sns_tokenomics_analyzer/README.md @@ -0,0 +1,30 @@ +# SNS Tokenomics Analyzer + +## Purpose + +- **What It Is**: A tool designed to simplify the setup and analysis of tokenomics for Service Nervous Systems (SNS) on the Internet Computer (IC). +- **Key Features**: + - Parses SNS launch parameters given by SNS init file. + - Offers simulation and visualization features +- **Who It's For**: This tool is primarily aimed at SNS project teams and community members who are reviewing NNS proposals for SNS launches. + +## Disclaimer + +This tool is an initial beta version of the SNS Tokenomics Analyzer. Feedback regarding potential limitations and bugs is highly appreciated. + +## Installation + +- Copy all files from this repo directory to a local directory, in particular + - `sns_tokenomics_analyzer.py`, which contains the code for the tool. + - `sns_init.yaml` which is an example input file. +- Python installation is required. +- Additional Python libraries are also required and are listed at the beginning of the `sns_tokenomics_analyzer.py` file. In order to install these you have the following options + - **Manual Installation**: Manually install the required Python libraries listed in the `sns_tokenomics_analyzer.py` file. + - **Nix Installation**: Alternatively, install Nix and run `nix develop` in the directory where you plan to execute the code. + + +## Running the Tool + +1. Adjust or replace the input `sns_init.yaml` in current directory. +2. Execute `python ./sns_tokenomics_analyzer.py` in your terminal. +2. Open `http://127.0.0.1:8051/` in your local web browser to use the tool. From b54c0addbb3f7632fa20e02b4fd1b6bffc13539a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B6rn=20Assmann?= <101096424+bjoernek@users.noreply.github.com> Date: Mon, 11 Sep 2023 15:36:32 +0200 Subject: [PATCH 2/4] Add files via upload --- sns_tokenomics_analyzer/flake.lock | 60 +++ sns_tokenomics_analyzer/flake.nix | 29 ++ sns_tokenomics_analyzer/sns_init.yaml | 420 ++++++++++++++++++ .../sns_tokenomics_analyzer.py | 367 +++++++++++++++ 4 files changed, 876 insertions(+) create mode 100644 sns_tokenomics_analyzer/flake.lock create mode 100644 sns_tokenomics_analyzer/flake.nix create mode 100644 sns_tokenomics_analyzer/sns_init.yaml create mode 100644 sns_tokenomics_analyzer/sns_tokenomics_analyzer.py diff --git a/sns_tokenomics_analyzer/flake.lock b/sns_tokenomics_analyzer/flake.lock new file mode 100644 index 0000000..9228780 --- /dev/null +++ b/sns_tokenomics_analyzer/flake.lock @@ -0,0 +1,60 @@ +{ + "nodes": { + "flake-utils": { + "inputs": { + "systems": "systems" + }, + "locked": { + "lastModified": 1692799911, + "narHash": "sha256-3eihraek4qL744EvQXsK1Ha6C3CR7nnT8X2qWap4RNk=", + "owner": "numtide", + "repo": "flake-utils", + "rev": "f9e7cf818399d17d347f847525c5a5a8032e4e44", + "type": "github" + }, + "original": { + "owner": "numtide", + "repo": "flake-utils", + "type": "github" + } + }, + "nixpkgs": { + "locked": { + "lastModified": 1693815579, + "narHash": "sha256-fPnIQlr0DoH9Z1C3v7IL3OpzMsvODC3k3oGu69r38+Y=", + "owner": "NixOS", + "repo": "nixpkgs", + "rev": "1e409aeb5a9798a36e1cca227b7f8b8f3176e04d", + "type": "github" + }, + "original": { + "id": "nixpkgs", + "ref": "release-23.05", + "type": "indirect" + } + }, + "root": { + "inputs": { + "flake-utils": "flake-utils", + "nixpkgs": "nixpkgs" + } + }, + "systems": { + "locked": { + "lastModified": 1681028828, + "narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=", + "owner": "nix-systems", + "repo": "default", + "rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e", + "type": "github" + }, + "original": { + "owner": "nix-systems", + "repo": "default", + "type": "github" + } + } + }, + "root": "root", + "version": 7 +} diff --git a/sns_tokenomics_analyzer/flake.nix b/sns_tokenomics_analyzer/flake.nix new file mode 100644 index 0000000..c23a09d --- /dev/null +++ b/sns_tokenomics_analyzer/flake.nix @@ -0,0 +1,29 @@ +{ + description = "SNS Init Analyzer"; + + inputs = { + nixpkgs.url = "nixpkgs/release-23.05"; + flake-utils.url = "github:numtide/flake-utils"; + }; + + outputs = { self, nixpkgs, flake-utils }: + flake-utils.lib.eachSystem [ "aarch64-darwin" "x86_64-darwin" "x86_64-linux" ] (system: + let + pkgs = import nixpkgs { inherit system; }; + + pythonEnv = pkgs.python3.withPackages (ps: [ + ps.pandas + ps.pyyaml + ps.dash + ps.setuptools + ps.plotly + ps.numpy + ]); + in + { + devShells.default = pkgs.mkShell { + packages = [ pythonEnv ]; + }; + } + ); +} diff --git a/sns_tokenomics_analyzer/sns_init.yaml b/sns_tokenomics_analyzer/sns_init.yaml new file mode 100644 index 0000000..3e94b5f --- /dev/null +++ b/sns_tokenomics_analyzer/sns_init.yaml @@ -0,0 +1,420 @@ +# You should make a copy of this file, name it sns_init.yaml, and edit it to +# suit your needs. +# +# All principal IDs should almost certainly be changed. +# +# In this file, 1 year is nominally defined to be 365.25 days. +# +# This gets passed to `sns propose`. See propose_sns.sh. +# +# This follows the second configuration file format developed for the `sns` +# CLI. The first format will be supported for a time, but this format will +# eventually become the standard format. +# ------------------------------------------------------------------------------ + +# Name of the SNS project. This may differ from the name of the associated +# token. Must be a string of max length = 255. +name: Rock Out + +# Description of the SNS project. +# Must be a string of max length = 2,000. +description: > + Revolutionize social discourse with our Web 3 app, a decentralized platform that offers an unparalleled level of user autonomy and content integrity, unlike traditional social media platforms. Say goodbye to data harvesting, censorship, and forced algorithms, and hello to a transparent, community-driven experience that puts control back in your hands. + +# This is currently a placeholder field and must be left empty for now. +Principals: [] + +# Path to the SNS Project logo on the local filesystem. The path is relative +# to the configuration file's location, unless an absolute path is given. +# Must have less than 341,334 bytes. The only supported format is PNG. +logo: logo.png + +# URL to the dapp controlled by the SNS project. +# Must be a string from 10 to 512 bytes. +url: https://forum.dfinity.org/thread-where-this-sns-is-discussed + +# Metadata for the NNS proposal required to create the SNS. This data will be +# shown only in the NNS proposal. +NnsProposal: + # The title of the NNS proposal. Must be a string of 4 to 256 bytes. + title: "NNS Proposal to create an SNS named 'Rock Out'" + + # The HTTPS address of additional content required to evaluate the NNS + # proposal. + url: "https://forum.dfinity.org" + + # The description of the proposal. Must be a string of 10 to 2,000 bytes. + summary: > + Proposal to create an SNS for the project XX. + The SNS will be initialized with the following neurons: + ... + +# If the SNS launch attempt fails, control over the dapp canister(s) is given to +# these principals. In most use cases, this is chosen to be the original set of +# controller(s) of the dapp. +fallback_controller_principals: + # For the actual SNS launch, you should replace this with one or more + # principals of your intended fallback controllers. + # + # For testing, propose_sns.sh will fill this in automatically. + - uts47-wa2j2-xuhf2-er2vb-mbrfc-6xslp-fbhfx-lbcfp-rmqqz-xce7m-sqe + +# The list of dapp canister(s) that will be decentralized if the +# decentralization swap succeeds. These are defined in the form of canister IDs, +# for example, `bnz7o-iuaaa-aaaaa-qaaaa-cai`. For a successful SNS launch, +# these dapp canister(s) must be co-controlled by the NNS Root canister +# (`r7inp-6aaaa-aaaaa-aaabq-cai`) at latest at the time when the NNS proposal to +# create an SNS is adopted (usually this is required even earlier, e.g., to +# convince NNS neurons to vote in favor of your proposal). +dapp_canisters: + # For the actual SNS launch, you should replace this with one or more + # IDs of the canisters comprising your to-be-decentralized dapp. + # + # For testing, propose_sns.sh will fill this in automatically. + - bkyz2-fmaaa-aaaaa-qaaaq-cai + - ufsd4-fmaaa-aaaaa-qaaaq-cai + +# Configuration of SNS tokens in the SNS Ledger canister deployed as part +# of the SNS. +Token: + # The name of the token issued by the SNS ledger. + # Must be a string of 4 to 255 bytes without leading or trailing spaces. + name: Rock Out Token + + # The symbol of the token issued by the SNS Ledger. + # Must be a string of 3 to 10 bytes without leading or trailing spaces. + symbol: ROT + + # SNS ledger transaction fee. + transaction_fee: 10_000 e8s + + # Path to the SNS token logo on your local filesystem. The path is relative + # to the configuration file location, unless an absolute path is given. + # Must have less than 341,334 bytes. The only supported format is PNG. + logo: logo.png + +# Configures SNS proposal-related fields. These fields define the initial values +# for some of the nervous system parameters related to SNS proposals. This will +# not affect all SNS proposals submitted to the newly created SNS. +Proposals: + # The cost of making an SNS proposal that is rejected by the SNS neuron + # holders. + rejection_fee: 100 tokens + + # The initial voting period of an SNS proposal. A proposal's voting period + # may be increased during its lifecycle due to the wait-for-quiet algorithm + # (see details below). + initial_voting_period: 4 days + + # The wait-for-quiet algorithm extends the voting period of a proposal when + # there is a flip in the majority vote during the proposal's voting period. + # + # Without this, there could be an incentive to vote right at the end of a + # proposal's voting period, in order to reduce the chance that people will + # see and have time to react to that. + # + # If this value is set to 1 day, then a change in the majority vote at the + # end of a proposal's original voting period results in an extension of the + # voting period by an additional day. Another change at the end of the + # extended period will cause the voting period to be extended by another + # half-day, etc. + # + # The total extension to the voting period will never be more than twice + # this value. + # + # For more information, please refer to + # https://wiki.internetcomputer.org/wiki/Network_Nervous_System#Proposal_decision_and_wait-for-quiet + maximum_wait_for_quiet_deadline_extension: 1 day + +# Configuration of SNS neurons. These fields have no effect on the NNS proposal, +# but will affect the SNS itself. +Neurons: + # The minimum amount of SNS tokens to stake a neuron. + minimum_creation_stake: 4 tokens + +# Configuration of SNS voting. These fields have no effect on the NNS proposal +# created by this file, but will affect the SNS itself. +Voting: + # The minimum dissolve delay a neuron must have to be able to cast votes on + # proposals. + # + # Dissolve delay incentivizes neurons to vote in the long-term interest of + # an SNS, as they are rewarded for longer-term commitment to that SNS. + # + # Users cannot access the SNS tokens used to stake neurons (until the neuron + # is dissolved). + minimum_dissolve_delay: 1 month + + # Configuration of voting power bonuses that are applied to neurons to + # incentivize alignment with the best interest of the DAO. + MaximumVotingPowerBonuses: + # Users with a higher dissolve delay are incentivized to take the + # long-term interests of the SNS into consideration when voting. To + # reward this long-term commitment, this bonus can be set to a + # percentage greater than zero, which will result in neurons having + # their voting power increased in proportion to their dissolve delay. + # + # If you do not want this bonus to be applied for neurons with higher + # dissolve delay, set `bonus` to `0%` and those neurons will not receive + # higher voting power. + DissolveDelay: + # This parameter sets the maximum dissolve delay a neuron can have. + # When reached, the maximum dissolve delay bonus will be applied. + duration: 1 years + # If a neuron's dissolve delay is `duration`, its voting power will + # be increased by this `bonus` amount. + bonus: 100% + + # Users with neurons staked in the non-dissolving state for a long + # period of time are incentivized to take the long-term interests of + # the SNS into consideration when voting. To reward this long-term + # commitment, this bonus can be set to a percentage (greater than zero), + # which will result in neurons having their voting power increased in + # proportion to their age. + # + # If this bonus should not be applied for older neurons, set the bonus + # to `0%` and older neurons will not receive higher voting power. + Age: + # This parameter sets the duration of time the neuron must be staked + # in the non-dissolving state, in other words its `age`, to reach + # the maximum age bonus. Once this age is reached, the neuron will + # continue to age, but no more bonus will be applied. + duration: 0.5 years + # If a neuron's age is `duration` or older, its voting power will be + # increased by this `bonus` amount. + bonus: 25% + + # Configuration of SNS voting reward parameters. + # + # The voting reward rate controls how quickly the supply of the SNS token + # increases. For example, setting `initial` to `2%` will cause the supply to + # increase by at most `2%` per year. A higher voting reward rate + # incentivizes users to participate in governance, but also results in + # higher inflation. + # + # The initial and final reward rates can be set to have a higher reward rate + # at the launch of the SNS and a lower rate further into the SNS’s lifetime. + # The reward rate falls quadratically from the `initial` rate to the `final` + # rate over the course of `transition_duration`. + # + # Setting both `initial` and `final` to `0%` will result in the system not + # distributing voting rewards at all. + RewardRate: + # The initial reward rate at which the SNS voting rewards will increase + # per year. + initial: 2.5% + + # The final reward rate at which the SNS voting rewards will increase + # per year. This rate is reached after `transition_duration` and remains + # at this level unless changed by an SNS proposal. + final: 2.5% + + # The voting reward rate falls quadratically from `initial` to `final` + # over the time period defined by `transition_duration`. + # + # Values of 0 result in the reward rate always being `final`. + transition_duration: 5 years + +# Configuration of the initial token distribution of the SNS. You can configure +# how SNS tokens are distributed in each of the three groups: +# (1) tokens that are given to the original developers of the dapp, +# (2) treasury tokens that are owned by the SNS governance canister, and +# (3) tokens which are distributed to the decentralization swap participants. +# +# The initial token distribution must satisfy the following preconditions to be +# valid: +# - The sum of all developer tokens in E8s must be less than `u64::MAX`. +# - The Swap's initial balance (see group (3) above) must be greater than 0. +# - The Swap's initial balance (see group (3) above) must be greater than or +# equal to the sum of all developer tokens. +Distribution: + # The initial neurons created when the SNS Governance canister is installed. + # Each element in this list specifies one such neuron, including its stake, + # controlling principal, memo identifying this neuron (every neuron that + # a user has must be identified by a unique memo), dissolve delay, and a + # vesting period. Even though these neurons are distributed at genesis, + # they are locked in a (restricted) pre-initialization mode until the + # decentralization swap is completed. Note that `vesting_period` starts + # right after the SNS creation and thus includes the pre-initialization mode + # period. + Neurons: + # For the actual SNS launch, you should replace this with one or more + # principals of your intended genesis neurons. + # + # For testing, propose_sns.sh will fill this in automatically. + - principal: uts47-wa2j2-xuhf2-er2vb-mbrfc-6xslp-fbhfx-lbcfp-rmqqz-xce7m-sqe + stake: 2_000_000 tokens + memo: 0 + dissolve_delay: 1 month + vesting_period: 0 years + - principal: uts47-wa2j2-xuhf2-er2vb-mbrfc-6xslp-fbhfx-lbcfp-rmqqz-xce7m-sqe + stake: 2_000_000 tokens + memo: 0 + dissolve_delay: 1 month + vesting_period: 1 years + - principal: uts47-wa2j2-xuhf2-er2vb-mbrfc-6xslp-fbhfx-lbcfp-rmqqz-xce7m-sqe + stake: 2_000_000 tokens + memo: 0 + dissolve_delay: 1 month + vesting_period: 2 years + - principal: abcde-wa2j2-xuhf2-er2vb-mbrfc-6xslp-fbhfx-lbcfp-rmqqz-xce7m-sqe + stake: 2_000_000 tokens + memo: 0 + dissolve_delay: 1 month + vesting_period: 0 years + - principal: abcde-wa2j2-xuhf2-er2vb-mbrfc-6xslp-fbhfx-lbcfp-rmqqz-xce7m-sqe + stake: 2_000_000 tokens + memo: 0 + dissolve_delay: 1 month + vesting_period: 1 years + - principal: abcde-wa2j2-xuhf2-er2vb-mbrfc-6xslp-fbhfx-lbcfp-rmqqz-xce7m-sqe + stake: 2_000_000 tokens + memo: 0 + dissolve_delay: 1 month + vesting_period: 2 years + - principal: xxxxx-wa2j2-xuhf2-er2vb-mbrfc-6xslp-fbhfx-lbcfp-rmqqz-xce7m-sqe + stake: 2_000_000 tokens + memo: 0 + dissolve_delay: 1 month + vesting_period: 0 years + - principal: xxxxx-wa2j2-xuhf2-er2vb-mbrfc-6xslp-fbhfx-lbcfp-rmqqz-xce7m-sqe + stake: 2_000_000 tokens + memo: 0 + dissolve_delay: 1 month + vesting_period: 1 years + - principal: xxxxx-wa2j2-xuhf2-er2vb-mbrfc-6xslp-fbhfx-lbcfp-rmqqz-xce7m-sqe + stake: 2_000_000 tokens + memo: 0 + dissolve_delay: 1 month + vesting_period: 2 years + - principal: yyyy-wa2j2-xuhf2-er2vb-mbrfc-6xslp-fbhfx-lbcfp-rmqqz-xce7m-sqe + stake: 5_000_000 tokens + memo: 0 + dissolve_delay: 1 month + vesting_period: 1 years + # The initial SNS token balances of the various canisters of the SNS. + InitialBalances: + # The initial SNS token balance of the SNS Governance canister is known + # as the treasury. This is initialized in a special sub-account, as the + # main account of Governance is the minting account of the SNS Ledger. + governance: 52_000_000 tokens + + # The initial SNS token balance of the Swap canister is what will be + # available for the decentralization swap. These tokens will be swapped + # for ICP. + swap: 25_000_000 tokens + + # Checksum of the total number of tokens distributed in this section. + # 23 million (dev neuron) + # 52 million (governance) + # + 25 million (swap) + # -------------- + total: 100_000_000 tokens + +# Configuration of the decentralization swap parameters. Choose these parameters +# carefully, if a decentralization swap fails, the SNS will restore the dapp +# canister(s) to the fallback controllers (defined in +# `fallback_controller_principals`) and you will need to start over. +Swap: + # The minimum number of participants that must participate for the + # decentralization swap to succeed. If a decentralization swap finishes due + # to the deadline or the maximum target being reached, and if there are less + # than `minimum_participants`, the swap will fail. + minimum_participants: 57 + + # The minimum number of ICP that is required for a decentralization swap to + # succeed. This number divided by the number of SNS tokens being offered + # gives the reserve price of the swap, i.e., the minimum number of ICP per + # SNS token. If this amount is not achieved, the swap will fail. + minimum_icp: 500_000 tokens + + # The maximum number of ICP that is targeted by this decentralization swap. + # If this amount is achieved with sufficient participation, the swap will + # succeed immediately, without waiting for the deadline. This means that + # a participant knows the minimum number of SNS tokens received per invested + # ICP. If this amount is achieved without reaching `minimum_participants`, + # the swap will immediately fail without waiting for the due date. + maximum_icp: 1_000_000 tokens + + # The minimum amount of ICP that each participant must contribute + # to participate. + minimum_participant_icp: 1 tokens + + # The maximum amount of ICP that each participant must contribute + # to participate. + maximum_participant_icp: 100_000 tokens + + # The text that swap participants must confirm before they may participate + # in the swap. + # + # This field is optional. If set, must be within 1 to 1,000 characters and + # at most 8,000 bytes. + # confirmation_text: > + # I confirm my understanding of the responsibilities and risks + # associated with participating in this token swap. + + # A list of countries from which swap participation should not be allowed. + # + # This field is optional. By default, participants from all countries + # are allowed. + # + # Each list element must be an ISO 3166-1 alpha-2 country code. + restricted_countries: + - AQ # Antarctica + + # Configuration of the vesting schedule of the neuron basket, i.e., the SNS + # neurons that a participants will receive from a successful + # decentralization swap. + VestingSchedule: + # The number of events in the vesting schedule. This translates to how + # many neurons will be in each participant's neuron basket. Note that + # the first neuron in each neuron basket will have zero dissolve delay. + # This value should thus be greater than or equal to `2`. + events: 5 + + # The interval at which the schedule will be increased per event. The + # first neuron in the basket will be unlocked with zero dissolve delay. + # Each other neuron in the schedule will have its dissolve delay + # increased by `interval` compared to the previous one. For example, + # if `events` is set to `3` and `interval` is `1 month`, then each + # participant's neuron basket will have three neurons (with equal stake) + # with dissolve delays zero, 1 month, and 2 months. Note that the notion + # of `Distribution.neurons.vesting_period` applies only to developer + # neurons. While neuron basket neurons do not use `vesting_period`, they + # have a vesting schedule. + interval: 3 months + + # Absolute time of day when the decentralization swap is supposed to start. + # + # An algorithm will be applied to allow at least 24 hours between the time + # of execution of the CreateServiceNervousSystem proposal and swap start. + # For example, if start_time is 23:30 UTC and the proposal is adopted and + # executed at 23:20 UTC, then the swap start will be at 23:30 UTC the next + # day (i.e., in 24 hours and 10 min from the proposal execution time). + # + # WARNING: Swap start_time works differently on mainnet and in testing. + # + # On mainnet: + # - Setting start_time to some value (e.g., 23:30 UTC) will allow the swap + # participants to be prepared for the swap in advance, e.g., + # by obtaining ICPs that they would like to participate with. + # - If start_time is not specified, the actual start time of the swap will + # be chosen at random (allowing at least 24 hours and less than 48 hours, + # as described above). + # + # In testing: + # - Setting start_time to some value works the same as explained above. + # - If start_time is not specified, the swap will begin immediately after + # the CreateServiceNervousSystem proposal is executed. This facilitates + # testing in an accelerated manner. + # + # start_time: 23:30 UTC # Intentionally commented out for testing. + + # The duration of the decentralization swap. When `start_time` is calculated + # during CreateServiceNervousSystem proposal execution, this `duration` will + # be added to that absolute time and set as the swap's deadline. + duration: 14 days + + # The amount of ICP that will be contributed to the decentralization swap by + # the Neurons' Fund if the CreateServiceNervousSystem proposal is adopted. + neurons_fund_investment_icp: 330_000 tokens \ No newline at end of file diff --git a/sns_tokenomics_analyzer/sns_tokenomics_analyzer.py b/sns_tokenomics_analyzer/sns_tokenomics_analyzer.py new file mode 100644 index 0000000..860a88c --- /dev/null +++ b/sns_tokenomics_analyzer/sns_tokenomics_analyzer.py @@ -0,0 +1,367 @@ +#!/usr/bin/env python3 +# -*- coding: utf-8 -*- +""" +@author: bjoernassmann +""" + +import pandas as pd +import yaml +import dash +from dash import dcc +from dash import html +from dash.dependencies import Input, Output +import plotly.graph_objs as go +import numpy as np + +############################################################################### +# Define name of input file +input_file = "sns_init.yaml" + + +############################################################################### +# Helper functions for parsing and computing stats + +# Function to convert time span to years +def convert_to_years(time_str): + value, unit = time_str.split(" ") + value = float(value) + unit = unit.lower().rstrip('s') # Remove trailing 's' and convert to lowercase + conversion_factors = { + 'second': 1/(365.25 * 24 * 3600), + 'minute': 1/(365.25 * 24 * 60), + 'hour': 1/(365.25 * 24), + 'day': 1/365.25, + 'month': 1/12, + 'year': 1 + } + return value * conversion_factors.get(unit, 0) + +# Function to convert percentage to absolute value +def convert_to_absolute(value_str): + value = float(value_str.strip('%')) + return value / 100 + +# Function to convert token number from string to numeric value +def convert_tokens(stake_str): + return int(stake_str.replace('_', '').split(' ')[0]) + +def voting_power(dissolve_delay, stake, gov_params): + if dissolve_delay < gov_params['min_dissolve_delay']: + return 0 + + # Calculate the dissolve delay bonus + max_delay = gov_params['max_dissolve_delay'] + max_bonus = gov_params['dissolve_delay_bonus'] + dissolve_delay_capped = min( max_delay,dissolve_delay ) + + dissolve_delay_bonus = 1 + (max_bonus * dissolve_delay_capped/max_delay) + + # Voting power is stake multiplied by the dissolve delay bonus + return stake * dissolve_delay_bonus + +def calculate_relative_swap_voting_power(neuron_basket_count, neuron_basket_interval, gov_params): + vp = 0 + stake = 1/neuron_basket_count + for i in range(neuron_basket_count): + dissolve_delay = i * neuron_basket_interval + vp += voting_power(dissolve_delay, stake, gov_params) + return vp + +def calculate_swap_average_dissolve_delay(neuron_basket_count, neuron_basket_interval): + dd = [] + for i in range(neuron_basket_count): + dd.append(i * neuron_basket_interval) + average_dissolve_delay = sum(dd) / len(dd) if dd else 0 + return average_dissolve_delay + +def parse_gov_params(data): + gov_params = {} + + # Convert time-related fields to years + gov_params['min_dissolve_delay'] = convert_to_years(data['Voting']['minimum_dissolve_delay']) + gov_params['max_dissolve_delay'] = convert_to_years(data['Voting']['MaximumVotingPowerBonuses']['DissolveDelay']['duration']) + gov_params['max_age'] = convert_to_years(data['Voting']['MaximumVotingPowerBonuses']['Age']['duration']) + gov_params['reward_rate_transition_duration'] = convert_to_years(data['Voting']['RewardRate']['transition_duration']) + + # Convert percentage values to absolute values + gov_params['dissolve_delay_bonus'] = convert_to_absolute(data['Voting']['MaximumVotingPowerBonuses']['DissolveDelay']['bonus']) + gov_params['age_bonus'] = convert_to_absolute(data['Voting']['MaximumVotingPowerBonuses']['Age']['bonus']) + gov_params['reward_rate_initial'] = convert_to_absolute(data['Voting']['RewardRate']['initial']) + gov_params['reward_rate_final'] = convert_to_absolute(data['Voting']['RewardRate']['final']) + + return gov_params + +############################################################################### +# Reading the YAML file and parse goverannce paramters +with open(input_file, "r") as file: + data = yaml.safe_load(file) + +gov_params = parse_gov_params(data) +print("gov_params:", gov_params) + + +############################################################################### +# Parse swap data and compute swap stats +no_scenarios = 11 +scenario_indices = list(range(no_scenarios)) + +swap_data = data['Swap'] +dist_data = data['Distribution']['InitialBalances'] + +min_icp, max_icp = map(convert_tokens, [swap_data['minimum_icp'], swap_data['maximum_icp']]) +swap_distribution = convert_tokens(dist_data['swap']) + +collected_icp_scenarios = np.linspace(min_icp, max_icp, no_scenarios).tolist() + +token_price_scenarios = [icp / swap_distribution for icp in collected_icp_scenarios] + + +fund_participation_icp = convert_tokens(swap_data['neurons_fund_investment_icp']) +direct_participation_icp_scenarios = [collected_icp_scenarios[index] - fund_participation_icp for index in scenario_indices] + +fund_participation_scenarios = [fund_participation_icp / price for price in token_price_scenarios] +direct_participation_scenarios = [swap_distribution - fund for fund in fund_participation_scenarios] + +vest_data = swap_data['VestingSchedule'] +neuron_basket_count = vest_data['events'] +neuron_basket_interval = convert_to_years(vest_data['interval']) + +rel_vp = calculate_relative_swap_voting_power(neuron_basket_count, neuron_basket_interval, gov_params) + +vp_fund_scenarios = [rel_vp * value for value in fund_participation_scenarios] +vp_direct_scenarios = [rel_vp * value for value in direct_participation_scenarios] + +swap_avg_dissolve_delay = calculate_swap_average_dissolve_delay(neuron_basket_count, neuron_basket_interval) + + +############################################################################### +# Parse dev neurons +dev_neurons_list = [] + +# Iterate over each neuron in the YAML data +for neuron in data['Distribution']['Neurons']: + neuron_dict = {} + neuron_dict['controller'] = neuron['principal'] + neuron_dict['stake'] = convert_tokens(neuron['stake']) + neuron_dict['dissolve_delay'] = convert_to_years(neuron['dissolve_delay']) + neuron_dict['vesting_period'] = convert_to_years(neuron['vesting_period']) + neuron_dict['memo'] = neuron['memo'] + neuron_dict['voting_power'] = voting_power( neuron_dict['dissolve_delay'], neuron_dict['stake'], gov_params) + dev_neurons_list.append(neuron_dict) + +dev_neurons_df = pd.DataFrame(dev_neurons_list) +print(dev_neurons_df) + +# Calculate the sum of the stakes and the stake-weighted average dissolve delay +total_dev_neurons_stake = dev_neurons_df['stake'].sum() +avg_dissolve_delay_dev_neurons = (dev_neurons_df['stake'] * dev_neurons_df['dissolve_delay']).sum() / total_dev_neurons_stake + + +############################################################################### +# Generate data frame for aggreated data + +def create_token_distribution_df_new(scenario_index): + return pd.DataFrame([ + { + 'type': 'Treasury', + 'tokens': convert_tokens(data['Distribution']['InitialBalances']['governance']), + 'average_dissolve_delay': 0, + 'voting_power': 0 + }, + { + 'type': 'Developer Neurons', + 'tokens': total_dev_neurons_stake, + 'average_dissolve_delay': avg_dissolve_delay_dev_neurons, + 'voting_power': dev_neurons_df['voting_power'].sum() + }, + { + 'type': 'Swap: Direct', + 'tokens': direct_participation_scenarios[scenario_index], + 'average_dissolve_delay': swap_avg_dissolve_delay, + 'voting_power': vp_direct_scenarios[scenario_index] + }, + { + 'type': 'Swap: Fund', + 'tokens': fund_participation_scenarios[scenario_index], + 'average_dissolve_delay': swap_avg_dissolve_delay, + 'voting_power': vp_fund_scenarios[scenario_index] + } + ]) + +token_distribution_scenarios = [create_token_distribution_df_new(index) for index in scenario_indices] + +# Data frames for ICP participation +def create_icp_participaiton_df(scenario_index): + return pd.DataFrame({ + 'Category': ['Swap: Fund', 'Swap: Direct', 'Swap: Remaining Capacity'], + 'Value': [ + fund_participation_icp, + direct_participation_icp_scenarios[scenario_index], + max_icp - collected_icp_scenarios[scenario_index] + ]}) + +icp_participation_scenarios = [create_icp_participaiton_df(index) for index in scenario_indices] + +############################################################################### +# Create a Dash app +app = dash.Dash(__name__) + +# Your data preparation code here + +# Color mapping +color_map = { + 'Treasury': 'blue', + 'Developer Neurons': 'purple', + 'Swap: Fund': 'green', + 'Swap: Direct': 'lightgreen', + 'Swap: Remaining Capacity': 'grey' +} + +# App layout +app = dash.Dash(__name__) + +app.layout = html.Div([ + # Title + html.Div('SNS Tokenomics Analyzer', style={'textAlign': 'center', 'color': 'white', 'fontSize': 36, 'padding': '20px', 'font-family': 'Arial'}), + + # Slider + html.Div([ + html.Label('Select commitment by direct participants', + style={'color': 'white', 'font-family': 'Arial', 'display': 'block', 'textAlign': 'center'}), + html.Div([ + dcc.Slider( + id='slider-scenario', + min=0, # Min index + max=no_scenarios-1, # Max index + value=0, # Default index + marks={i: f"{round(direct_participation_icp_scenarios[i]/1000)}K" for i in range(no_scenarios)}, + step=1 # Increment by 1 + ) + ], style={'margin': 'auto', 'width': '40%'}) + ], style={ + 'textAlign': 'center', + 'marginTop': '50px', + 'backgroundColor': 'black' + }), + + # ICP pie chart and token price chart + html.Div([ + html.Div([ + dcc.Graph(id='pie-icp-participation'), + ], style={'flex': '1'}), + html.Div([ + dcc.Graph(id='linear-function-graph'), + ], style={'flex': '1' }), + ], style={'display': 'flex'}), + + # SNS token pie charts + html.Div([ + dcc.Graph(id='pie-tokens', style={'display': 'inline-block'}), + dcc.Graph(id='pie-voting-power', style={'display': 'inline-block'}) + ], style={ #'marginTop': '350px', + 'width': '1500px', + }) +], style={'backgroundColor': 'black', 'color': 'white'}) + + +# Update charts based on slider selection +@app.callback( + [Output('pie-tokens', 'figure'), + Output('pie-voting-power', 'figure'), + Output('pie-icp-participation', 'figure'), + Output('linear-function-graph', 'figure'), + ], + [Input('slider-scenario', 'value')] +) +def update_charts(selected_scenario): + df = token_distribution_scenarios[selected_scenario] + df_icp = icp_participation_scenarios[selected_scenario] + df = df.sort_values('type') + + # Pie chart for token distribution + fig_tokens = go.Figure(data=[go.Pie( + labels=df['type'], + values=df['tokens'], + hole=0.4, + marker=dict(colors=[color_map[t] for t in df['type']]), + sort=False + )]) + fig_tokens.update_layout(title='Token Distribution', paper_bgcolor='black', font=dict(color='white')) + + # Pie chart for voting power + fig_voting_power = go.Figure(data=[go.Pie( + labels=df['type'], + values=df['voting_power'], + hole=0.4, + marker=dict(colors=[color_map[t] for t in df['type']]), + sort=False + )]) + fig_voting_power.update_layout(title='Voting Power Distribution', paper_bgcolor='black', font=dict(color='white')) + + # Pie chart for ICP Participation + fig_icp = go.Figure(data=[go.Pie( + labels=df_icp['Category'], + values=df_icp['Value'], + hole=0.4, + textinfo='value', + marker=dict(colors=[color_map[t] for t in df_icp['Category']]), + sort=False + )]) + fig_icp.update_layout(title='ICP Swap Commitment', paper_bgcolor='black', font=dict(color='white')) + + # Create the Linear Function Graph for the token price + linear_function_fig = go.Figure(data=[ + go.Scatter( + x=collected_icp_scenarios, + y=token_price_scenarios, + mode='lines', + line=dict(color='blue'), + name='Token Price Curve' + ), + go.Scatter( + x=[collected_icp_scenarios[selected_scenario]], + y=[token_price_scenarios[selected_scenario]], + mode='markers', + marker=dict(color='red', size=10), + name='Selected Scenario' + ) + ]) + + # Update background and font color for linear_function_fig + y_min = min(token_price_scenarios) * 0.95 + y_max = max(token_price_scenarios) * 1.05 + x_min = min(collected_icp_scenarios) * 0.95 + x_max = max(collected_icp_scenarios) * 1.05 + + linear_function_fig.update_layout( + plot_bgcolor='black', + paper_bgcolor='black', + font=dict(color='white'), + title='Token Price vs ICP Swap Commitment', + showlegend=False, + xaxis=dict( + title='ICP Swap Commitment', + showgrid=False, + zeroline=True, + zerolinewidth=2, + zerolinecolor='white', + tickcolor='white', + range=[x_min, x_max] + ), + yaxis=dict( + title='Token Price in ICP', + showgrid=False, + zeroline=True, + zerolinewidth=2, + zerolinecolor='white', + tickcolor='white', + range=[y_min, y_max] + ) + ) + return fig_tokens, fig_voting_power, fig_icp, linear_function_fig + + +# Run the app +if __name__ == '__main__': + app.run_server(debug=True, port=8051) + From ba5c7a8ae9efd2ab66653ce4446d9c04f6bee49a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B6rn=20Assmann?= <101096424+bjoernek@users.noreply.github.com> Date: Mon, 11 Sep 2023 15:37:34 +0200 Subject: [PATCH 3/4] Create .envrc --- sns_tokenomics_analyzer/.envrc | 1 + 1 file changed, 1 insertion(+) create mode 100644 sns_tokenomics_analyzer/.envrc diff --git a/sns_tokenomics_analyzer/.envrc b/sns_tokenomics_analyzer/.envrc new file mode 100644 index 0000000..3550a30 --- /dev/null +++ b/sns_tokenomics_analyzer/.envrc @@ -0,0 +1 @@ +use flake From c1073a61e161243a5da10c5e1983f21fa02ae7de Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B6rn=20Assmann?= <101096424+bjoernek@users.noreply.github.com> Date: Mon, 11 Sep 2023 15:38:41 +0200 Subject: [PATCH 4/4] Update README.md --- sns_tokenomics_analyzer/README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/sns_tokenomics_analyzer/README.md b/sns_tokenomics_analyzer/README.md index 56db3ee..404e999 100644 --- a/sns_tokenomics_analyzer/README.md +++ b/sns_tokenomics_analyzer/README.md @@ -12,6 +12,9 @@ This tool is an initial beta version of the SNS Tokenomics Analyzer. Feedback regarding potential limitations and bugs is highly appreciated. +## Version +Version 0.9. + ## Installation - Copy all files from this repo directory to a local directory, in particular