From b0fdd80c74f273eb217a40224e3344d7951b5acb Mon Sep 17 00:00:00 2001 From: Julian Molina Date: Sun, 29 Aug 2021 09:24:55 +0200 Subject: [PATCH] Onboarding Programs --- .../Token-Power-Flows/token-power-flows.json | 74 +++++++++++++++++++ .../Airdrop-Program/airdrop-program.json | 36 +++++++++ .../community-building-programs.json | 20 ++++- .../Github/Github-Program/github-program.json | 40 ++++++++++ .../onboarding-programs.json | 20 ++++- .../Tokens/Tokens-Awarded/tokens-awarded.json | 4 +- .../U/User/User-Profile/user-profile.json | 71 ++---------------- 7 files changed, 194 insertions(+), 71 deletions(-) create mode 100644 Projects/Governance/Schemas/Docs-Concepts/T/Token/Token-Power-Flows/token-power-flows.json create mode 100644 Projects/Governance/Schemas/Docs-Nodes/A/Airdrop/Airdrop-Program/airdrop-program.json create mode 100644 Projects/Governance/Schemas/Docs-Nodes/G/Github/Github-Program/github-program.json diff --git a/Projects/Governance/Schemas/Docs-Concepts/T/Token/Token-Power-Flows/token-power-flows.json b/Projects/Governance/Schemas/Docs-Concepts/T/Token/Token-Power-Flows/token-power-flows.json new file mode 100644 index 000000000..0a93c0f3a --- /dev/null +++ b/Projects/Governance/Schemas/Docs-Concepts/T/Token/Token-Power-Flows/token-power-flows.json @@ -0,0 +1,74 @@ +{ + "type": "Token Power Flows", + "definition": { + "text": "Token Power flows cascading down from the User Profile node to the Token Power Switch node, to its offspring, and so on, following the structure of the hierarchy.", + "updated": 1630215880089 + }, + "paragraphs": [ + { + "style": "Block", + "text": "Content", + "updated": 1630216073912 + }, + { + "style": "Text", + "text": "How Token Power flows depends on the following:" + }, + { + "style": "List", + "text": "By default, Token Power flows in equal proportion to each direct offspring node." + }, + { + "style": "List", + "text": "You may override the defaults by explicitly defining the percentage of the Token Power you wish to allocate to each offspring. If you define less than a total of 100%, then the remaining Token Power is distributed evenly across the offspring for which there is no definition." + }, + { + "style": "Text", + "text": "This is the format of the configuration you may use on each of the programs:" + }, + { + "style": "Json", + "text": "{\n\"percentage\": 50\n}", + "updated": 1630215956488 + }, + { + "style": "Text", + "text": "For example, let's say you have 1,000 Token Power flowing into your Token Power Switch node. Let's say you spawn the Onboarding Programs, Community Building Programs, Votes and Claims Programs, and Financial Programs nodes." + }, + { + "style": "Callout", + "text": "As soon as you deploy these four offspring of the Token Power Switch node, you will see that each of these nodes gets 25% of the Token Power by default." + }, + { + "style": "Text", + "text": "But you wish to limit the Token Power flowing into the Onboarding Programs to zero, as those programs do not require Token Power. To do that, you set up the following in the Onboarding Programs node configuration:" + }, + { + "style": "Json", + "text": "{\n\"percentage\": 0\n}", + "updated": 1630215994714 + }, + { + "style": "Callout", + "text": "Once the configuration is in place, you will notice that the Onboarding Programs node shows 0% and 0 Token Power flowing into the node. You will also notice that the rest of the nodes are getting 33.33% of the Token Power each." + }, + { + "style": "Text", + "text": "Now let's say you wish to use only 10% of your Token Power in the Onboarding Programs. So you set up the following config:" + }, + { + "style": "Json", + "text": "{\n\"percentage\": 10\n}", + "updated": 1630216035853 + }, + { + "style": "Callout", + "text": "As a result, 10% of the Token Power flows into the Onboarding Programs, while the remaining nodes get 45% of the Token Power each." + }, + { + "style": "Success", + "text": "The same logic applies to the flow of Token Power throughout the hierarchy!", + "updated": 1630216063140 + } + ] +} \ No newline at end of file diff --git a/Projects/Governance/Schemas/Docs-Nodes/A/Airdrop/Airdrop-Program/airdrop-program.json b/Projects/Governance/Schemas/Docs-Nodes/A/Airdrop/Airdrop-Program/airdrop-program.json new file mode 100644 index 000000000..aa6a91376 --- /dev/null +++ b/Projects/Governance/Schemas/Docs-Nodes/A/Airdrop/Airdrop-Program/airdrop-program.json @@ -0,0 +1,36 @@ +{ + "type": "Airdrop Program", + "definition": { + "text": "We don't like meaningless airdrops. But what if airdrops bring users a step closer to participating in governance? The Airdrops program incentivizes users to take the first step to participate in governance: creating and submitting a User Profile.", + "updated": 1630221752804 + }, + "paragraphs": [ + { + "style": "Block", + "text": "Content", + "updated": 1630218642448 + }, + { + "style": "Text", + "text": "The Airdrop program distributes the Rewards Pool defined under the Governance Programs > Onboarding Programs section of the Superalgos Pools hierarchy.", + "updated": 1630221764293 + }, + { + "style": "Success", + "text": "Spawning the Airdrop Program and submitting your User Profile is the sole technical requirement to receive the airdropped tokens and is — at the same time — the first step to participate in governance and contribute to the project.", + "updated": 1630218746987 + }, + { + "style": "Callout", + "text": "The program distributes the Rewards Pool evenly to all existing profiles, with a cap of SA 1,000 per profile, on each release!" + }, + { + "style": "Block", + "text": "Configuration" + }, + { + "style": "Title", + "text": "Configuration" + } + ] +} \ No newline at end of file diff --git a/Projects/Governance/Schemas/Docs-Nodes/C/Community/Community-Building-Programs/community-building-programs.json b/Projects/Governance/Schemas/Docs-Nodes/C/Community/Community-Building-Programs/community-building-programs.json index ec260f509..b6b48cdad 100644 --- a/Projects/Governance/Schemas/Docs-Nodes/C/Community/Community-Building-Programs/community-building-programs.json +++ b/Projects/Governance/Schemas/Docs-Nodes/C/Community/Community-Building-Programs/community-building-programs.json @@ -10,10 +10,14 @@ "text": "Content", "updated": 1630165468473 }, + { + "style": "Success", + "text": "Learn more about how Token Power Flows into these programs!", + "updated": 1630218909731 + }, { "style": "Text", - "text": "Each of the Community Building Programs has an associated Rewards Pool and a Bonus Pool under the Governance Programs > Community Building Programs section of the Superalgos Pools hierarchy.", - "updated": 1630168361008 + "text": "Each of the Community Building Programs has an associated Rewards Pool and a Bonus Pool under the Governance Programs > Community Building Programs section of the Superalgos Pools hierarchy." }, { "style": "Note", @@ -52,7 +56,17 @@ { "style": "Json", "text": "Total Incoming Power [*] -> 100% of the pool\n Your Incoming Power [**] -> X% of the pool -> Tokens Rewards\n\nTokens Rewards = Your Incoming Power * 100% / Total Incoming Power\n\n[*] The sum of all Incoming Power (in the given program) in all User Profiles combined.\n[**] Your Incoming Power (in the given program).", - "updated": 1630170860166 + "updated": 1630215178623 + }, + { + "style": "Block", + "text": "Configuration", + "updated": 1630215228441 + }, + { + "style": "Title", + "text": "Configuration", + "updated": 1630215233190 } ] } \ No newline at end of file diff --git a/Projects/Governance/Schemas/Docs-Nodes/G/Github/Github-Program/github-program.json b/Projects/Governance/Schemas/Docs-Nodes/G/Github/Github-Program/github-program.json new file mode 100644 index 000000000..422743b22 --- /dev/null +++ b/Projects/Governance/Schemas/Docs-Nodes/G/Github/Github-Program/github-program.json @@ -0,0 +1,40 @@ +{ + "type": "Github Program", + "definition": { + "text": "This program incentivizes users to fork the Superalgos repository, a necessary step to contribute. It also incentivizes users to give a star and watch the repository, which helps developers find the project when searching on Github.com.", + "updated": 1630221291041 + }, + "paragraphs": [ + { + "style": "Block", + "text": "Content", + "updated": 1630221318391 + }, + { + "style": "Text", + "text": "The Github Program distributes the Rewards Pool defined under the Governance Programs > Onboarding Programs section of the Superalgos Pools hierarchy.", + "updated": 1630221340561 + }, + { + "style": "Success", + "text": "Spawning the Github Program and submitting your User Profile is all you need to do to participate in the program. To maximize your Tokens Awarded, make sure you have a fork, a star, and are watching the repository! The system does automatic checks on Github.com and verifies their existence in real-time." + }, + { + "style": "Callout", + "text": "There is a cap of SA 1,000 for each of these incentives. This means that you may get up to SA 3,000 in Tokens Awarded if you maximize your participation. In case there aren't enough tokens in the Rewards Pool to cover each incentive up to the defined cap for all User Profiles, then each profile gets an equal proportion for each of the applicable incentives.", + "updated": 1630221717446 + }, + { + "style": "Text", + "text": "" + }, + { + "style": "Block", + "text": "Configuration" + }, + { + "style": "Title", + "text": "Configuration" + } + ] +} \ No newline at end of file diff --git a/Projects/Governance/Schemas/Docs-Nodes/O/Onboarding/Onboarding-Programs/onboarding-programs.json b/Projects/Governance/Schemas/Docs-Nodes/O/Onboarding/Onboarding-Programs/onboarding-programs.json index f03ee4b59..d8557d81c 100644 --- a/Projects/Governance/Schemas/Docs-Nodes/O/Onboarding/Onboarding-Programs/onboarding-programs.json +++ b/Projects/Governance/Schemas/Docs-Nodes/O/Onboarding/Onboarding-Programs/onboarding-programs.json @@ -1,13 +1,27 @@ { "type": "Onboarding Programs", "definition": { - "text": "These programs incentivize Superalgos users to take the first couple of steps to participate in governance and start giving back to the project. They make earning the first few tokens a breeze and allow every user to become invested!", - "updated": 1630056526452 + "text": "These programs incentivize Superalgos users to take the first couple of steps to participate in governance and start giving back to the project. They make earning the first few tokens a breeze and allow everyone to become invested in the Superalgos SA Token! We are talking about the Airdrop Program and the Github Program.", + "updated": 1630216446725 }, "paragraphs": [ + { + "style": "Block", + "text": "Content", + "updated": 1630216357301 + }, { "style": "Text", - "text": "Right click and select the pencil button to enter edit mode." + "text": "What these two programs have in common is that they don't require Token Power to function. That is, even if you have zero Superalgos SA Tokens and zero Delegated Power, you may still participate to earn your first few tokens!", + "updated": 1630218079736 + }, + { + "style": "Block", + "text": "Configuration" + }, + { + "style": "Title", + "text": "Configuration" } ] } \ No newline at end of file diff --git a/Projects/Governance/Schemas/Docs-Nodes/T/Tokens/Tokens-Awarded/tokens-awarded.json b/Projects/Governance/Schemas/Docs-Nodes/T/Tokens/Tokens-Awarded/tokens-awarded.json index 03ead3cb0..95b3efd69 100644 --- a/Projects/Governance/Schemas/Docs-Nodes/T/Tokens/Tokens-Awarded/tokens-awarded.json +++ b/Projects/Governance/Schemas/Docs-Nodes/T/Tokens/Tokens-Awarded/tokens-awarded.json @@ -22,8 +22,8 @@ }, { "style": "Text", - "text": "The Community Building Programs node page explains how Tokens Rewards are calculated for these particular program.", - "updated": 1630171164026 + "text": "The Community Building Programs node page explains how Tokens Awarded is calculated for these particular programs.", + "updated": 1630219835777 }, { "style": "Text", diff --git a/Projects/Governance/Schemas/Docs-Nodes/U/User/User-Profile/user-profile.json b/Projects/Governance/Schemas/Docs-Nodes/U/User/User-Profile/user-profile.json index c1453693b..c58116d8c 100644 --- a/Projects/Governance/Schemas/Docs-Nodes/U/User/User-Profile/user-profile.json +++ b/Projects/Governance/Schemas/Docs-Nodes/U/User/User-Profile/user-profile.json @@ -22,73 +22,18 @@ }, { "style": "Title", - "text": "Token Power Flow" + "text": "Token Power Flows", + "updated": 1630216274356 }, { - "style": "Text", - "text": "How Token Power flows depends on the following:" + "style": "Include", + "text": "Governance->Concept->Token Power Flows->Definition", + "updated": 1630216248820 }, { - "style": "List", - "text": "By default, Token Power flows in equal proportion to each direct offspring node.", - "updated": 1630093090611 - }, - { - "style": "List", - "text": "You may override the defaults by explicitly defining the percentage of the Token Power you wish to allocate to each offspring. If you define less than a total of 100%, then the remaining Token Power is distributed evenly across the offspring for which there is no definition.", - "updated": 1630093129825 - }, - { - "style": "Text", - "text": "This is the format of the configuration you may use on each of the programs:" - }, - { - "style": "Json", - "text": "{\n \"percentage\": 50\n}", - "updated": 1624726090541 - }, - { - "style": "Text", - "text": "For example, let's say you have 1,000 Token Power flowing into your Token Power Switch node. Let's say you spawn the Onboarding Programs, Community Building Programs, Votes and Claims Programs, and Financial Programs nodes.", - "updated": 1630094336717 - }, - { - "style": "Callout", - "text": "As soon as you deploy these four offspring of the Token Power Switch node, you will see that each of these nodes gets 25% of the Token Power by default.", - "updated": 1630094063741 - }, - { - "style": "Text", - "text": "But you wish to limit the Token Power flowing into the Onboarding Programs to zero, as those programs do not require Token Power. To do that, you set up the following in the Onboarding Programs node configuration:", - "updated": 1630093868178 - }, - { - "style": "Json", - "text": "{\n \"percentage\": 0\n}", - "updated": 1630093495369 - }, - { - "style": "Callout", - "text": "Once the configuration is in place, you will notice that the Onboarding Programs node shows 0% and 0 Token Power flowing into the node. You will also notice that the rest of the nodes are getting 33.33% of the Token Power each.", - "updated": 1630093693182 - }, - { - "style": "Text", - "text": "Now let's say you wish to use only 10% of your Token Power in the Onboarding Programs. So you set up the following config:" - }, - { - "style": "Json", - "text": "{\n \"percentage\": 10\n}", - "updated": 1630093961107 - }, - { - "style": "Callout", - "text": "As a result, 10% of the Token Power flows into the Onboarding Programs, while the remaining nodes get 45% of the Token Power each.", - "updated": 1630094141031 - }, - { - "style": "Success", - "text": "The same logic applies to the flow of Token Power throughout the hierarchy!" + "style": "Include", + "text": "Governance->Concept->Token Power Flows->Content", + "updated": 1630216256004 }, { "style": "Block",