[Docs] Tokenomics Documentation #750

Olshansk · 2024-08-21T19:04:23Z

Summary

First iteration of tokenomics documentation.

@bryanchriswhite @red-0ne In addition to review this, please read through and understand it. Hopefully it serves as the foundation for how we tackle this issue but 10x simpler.

Issue

[Tokenomics] MVP of Inflation, Governance, Reimbursement & Docs #732

Type of change

Select one or more:

Testing

Documentation: make docusaurus_start; only needed if you make doc changes

bryanchriswhite

Have to step away for a bit.

docusaurus/docs/protocol/tokenomics/resources.md

docusaurus/docs/protocol/tokenomics/token_logic_modules.md

Co-authored-by: Bryan White <bryanchriswhite@gmail.com>

Olshansk · 2024-08-23T16:02:28Z

@bryanchriswhite @red-0ne In addition to review this, please read through and understand it. Hopefully it serves as the foundation for how we tackle this issue but 10x simpler.

Co-authored-by: Bryan White <bryanchriswhite@gmail.com>

red-0ne

Very informative docs, thanks for putting it together.

docusaurus/docs/protocol/tokenomics/token_logic_modules.md

Olshansk · 2024-08-28T21:40:08Z

@red-0ne @bryanchriswhite This is really shaping up! Thank you for the awesome reviews 🙌

red-0ne

Great improvements on the GMRR section.

LGTM!

proto/poktroll/application/types.proto

docusaurus/docs/protocol/tokenomics/token_logic_modules.md

bryanchriswhite · 2024-08-30T08:01:08Z

Great improvements and additional diagrams @Olshansk! 🙌 😎 🚀 🚀 🚀

bryanchriswhite

Just a couple minor typos but otherwise LGTM! 🚢

docusaurus/docs/protocol/tokenomics/token_logic_modules.md

Co-authored-by: Bryan White <bryanchriswhite@gmail.com>

…ke-transfer * pokt/main: [Relay Mining] Use per-service difficulty in the relayer (#745) [Tilt] Enable rest service by default in Tilt (#793) [Docs] Minor doc updates across the board (#792) build(deps): bump webpack from 5.89.0 to 5.94.0 in /docusaurus (#775) [Docs] Tokenomics Documentation (#750) fix: ensure stable_marshaler_all option on all proto files (#772) build(deps): bump micromatch from 4.0.5 to 4.0.8 in /docusaurus (#774) [Tooling] Add `protocheck` CLI tool (#770) Update `adding_params.md` to use `ignite` (#764) [Docs] Cleanup & Deprecation (#766)

…actor/transfer-msg_period-param * issues/657/feat/app-stake-transfer: chore: regenerate protobufs [Relay Mining] Use per-service difficulty in the relayer (#745) [Tilt] Enable rest service by default in Tilt (#793) [Docs] Minor doc updates across the board (#792) build(deps): bump webpack from 5.89.0 to 5.94.0 in /docusaurus (#775) [Docs] Tokenomics Documentation (#750) fix: ensure stable_marshaler_all option on all proto files (#772) build(deps): bump micromatch from 4.0.5 to 4.0.8 in /docusaurus (#774) [Tooling] Add `protocheck` CLI tool (#770) Update `adding_params.md` to use `ignite` (#764) [Docs] Cleanup & Deprecation (#766)

…ues/657/chore/app-transfer-period * issues/657/refactor/transfer-msg_period-param: chore: regenerate protobufs chore: regenerate protobufs fix: failing test chore: regenerate protobufs Revert "refactor: rename param to application_transfer_and_unboding_period_sessions" [Relay Mining] Use per-service difficulty in the relayer (#745) [Tilt] Enable rest service by default in Tilt (#793) [Docs] Minor doc updates across the board (#792) build(deps): bump webpack from 5.89.0 to 5.94.0 in /docusaurus (#775) [Docs] Tokenomics Documentation (#750) fix: ensure stable_marshaler_all option on all proto files (#772) build(deps): bump micromatch from 4.0.5 to 4.0.8 in /docusaurus (#774) [Tooling] Add `protocheck` CLI tool (#770) Update `adding_params.md` to use `ignite` (#764) [Docs] Cleanup & Deprecation (#766)

## Summary Implement "max claimable amount" in preparation for "global mint reimbursement request". Specific changes: - Added lots of `TODO_BETA` in preparation for beta testnet - Added a lot more comments and explanation in the TLM processors ## Issue - #732 - Related to #750 - Superceed #740 --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: Bryan White <bryanchriswhite@gmail.com> Co-authored-by: Redouane Lakrache <r3d0ne@gmail.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

## Summary This PR enforces staking `Application`s to have a single service, updates the tests and add documentation about the reasoning behind this enforcement. Note that the `Application.ServiceConfigs` remains a slice, reducing the codebase diff and allowing future multi-service `Applications` ## Issue Having `MaxClaimableAmount = Application.Stake * numSessionSuppliers` could allow `Application`s to over-service by making `Supplier`s of different session claim from the same stake. ![image](https://github.com/user-attachments/assets/f1396ea5-5788-4185-8a3c-4c8afc3429ef) - #750 (comment) ## Type of change Select one or more from the following: - [x] New feature, functionality or library - [x] Documentation ## Testing - [x] **Documentation**: `make docusaurus_start`; only needed if you make doc changes - [x] **Unit Tests**: `make go_develop_and_test` - [x] **LocalNet E2E Tests**: `make test_e2e` - [ ] **DevNet E2E Tests**: Add the `devnet-test-e2e` label to the PR. ## Sanity Checklist - [x] I have tested my changes using the available tooling - [x] I have commented my code - [x] I have performed a self-review of my own code; both comments & source code - [ ] I create and reference any new tickets, if applicable - [ ] I have left TODOs throughout the codebase, if applicable --------- Co-authored-by: Dmitry K <okdas@pm.me>

@bryanchriswhite

First iteration of tokenomics documentation. [Token Logic Modules _ Poktroll.pdf](https://github.com/user-attachments/files/16697554/Token.Logic.Modules._.Poktroll.pdf) @bryanchriswhite @red-0ne In addition to review this, please read through and understand it. Hopefully it serves as the foundation for how we tackle [this issue](https://www.notion.so/buildwithgrove/Off-chain-Application-Stake-Tracking-6a8bebb107db4f7f9dc62cbe7ba555f7?pvs=4) but 10x simpler. --------- Co-authored-by: Bryan White <bryanchriswhite@gmail.com>

## Summary Implement "max claimable amount" in preparation for "global mint reimbursement request". Specific changes: - Added lots of `TODO_BETA` in preparation for beta testnet - Added a lot more comments and explanation in the TLM processors ## Issue - #732 - Related to #750 - Superceed #740 --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: Bryan White <bryanchriswhite@gmail.com> Co-authored-by: Redouane Lakrache <r3d0ne@gmail.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

## Summary This PR enforces staking `Application`s to have a single service, updates the tests and add documentation about the reasoning behind this enforcement. Note that the `Application.ServiceConfigs` remains a slice, reducing the codebase diff and allowing future multi-service `Applications` ## Issue Having `MaxClaimableAmount = Application.Stake * numSessionSuppliers` could allow `Application`s to over-service by making `Supplier`s of different session claim from the same stake. ![image](https://github.com/user-attachments/assets/f1396ea5-5788-4185-8a3c-4c8afc3429ef) - #750 (comment) ## Type of change Select one or more from the following: - [x] New feature, functionality or library - [x] Documentation ## Testing - [x] **Documentation**: `make docusaurus_start`; only needed if you make doc changes - [x] **Unit Tests**: `make go_develop_and_test` - [x] **LocalNet E2E Tests**: `make test_e2e` - [ ] **DevNet E2E Tests**: Add the `devnet-test-e2e` label to the PR. ## Sanity Checklist - [x] I have tested my changes using the available tooling - [x] I have commented my code - [x] I have performed a self-review of my own code; both comments & source code - [ ] I create and reference any new tickets, if applicable - [ ] I have left TODOs throughout the codebase, if applicable --------- Co-authored-by: Dmitry K <okdas@pm.me>

Olshansk added 6 commits August 15, 2024 21:39

WIP

6738d21

Merge branch 'main' into inflation

3e6a146

Checkpoint

c3a235a

Finished first version of the documentation

846bc1d

Merge branch 'main' into inflation

40c56a5

Reverse code changes

341f7f8

Olshansk added the documentation Improvements or additions to documentation label Aug 21, 2024

Olshansk added this to the Shannon Beta TestNet Launch milestone Aug 21, 2024

Olshansk requested a review from bryanchriswhite August 21, 2024 19:04

Olshansk self-assigned this Aug 21, 2024

Olshansk mentioned this pull request Aug 21, 2024

[WIP][Tokenomics] Preparation for Global Mint Reimbursement Request #751

Closed

13 tasks

bryanchriswhite requested changes Aug 21, 2024

View reviewed changes

This was referenced Aug 22, 2024

[Tokenomics] Preparation for Global Mint Reimbursement Request #755

Merged

[WIP][Tokenomics] Application Reimbursement Request #756

Closed

Olshansk and others added 7 commits August 23, 2024 11:55

Merge branch 'main' into tokenomic_docs

9946d0d

Update docusaurus/docs/protocol/tokenomics/resources.md

248c436

Co-authored-by: Bryan White <bryanchriswhite@gmail.com>

Update docusaurus/docs/protocol/tokenomics/resources.md

9d9bec7

Co-authored-by: Bryan White <bryanchriswhite@gmail.com>

Update docusaurus/docs/protocol/tokenomics/token_logic_modules.md

0fa5e9d

Co-authored-by: Bryan White <bryanchriswhite@gmail.com>

Update docusaurus/docs/protocol/tokenomics/token_logic_modules.md

1b95661

Co-authored-by: Bryan White <bryanchriswhite@gmail.com>

Update docusaurus/docs/protocol/tokenomics/token_logic_modules.md

72fbe76

Co-authored-by: Bryan White <bryanchriswhite@gmail.com>

Update docusaurus/docs/protocol/tokenomics/token_logic_modules.md

8f7ce2a

Co-authored-by: Bryan White <bryanchriswhite@gmail.com>

Olshansk requested a review from bryanchriswhite August 23, 2024 16:01

Olshansk requested a review from red-0ne August 23, 2024 16:02

Olshansk and others added 6 commits August 23, 2024 12:03

Minor pull conflict

b4835bc

Update docusaurus/docs/protocol/tokenomics/token_logic_modules.md

b113fe6

Co-authored-by: Bryan White <bryanchriswhite@gmail.com>

Apply suggestions from code review

015a217

Co-authored-by: Bryan White <bryanchriswhite@gmail.com>

Update docusaurus/docs/protocol/tokenomics/token_logic_modules.md

78de6b2

Co-authored-by: Bryan White <bryanchriswhite@gmail.com>

Update diagram

b1b07fa

Update TLM

c8df845

Merge branch 'main' into tokenomic_docs

3a458be

red-0ne requested changes Aug 28, 2024

View reviewed changes

Olshansk added 3 commits August 28, 2024 16:28

Reply to on-chain & off-chain feedback

5f5f0ff

Replied to some more comments

775d5d5

Replied to more comments

68e221a

Olshansk requested review from red-0ne and bryanchriswhite August 28, 2024 21:39

red-0ne approved these changes Aug 29, 2024

View reviewed changes

proto/poktroll/application/types.proto Show resolved Hide resolved

docusaurus/docs/protocol/tokenomics/token_logic_modules.md Show resolved Hide resolved

docusaurus/docs/protocol/tokenomics/token_logic_modules.md Show resolved Hide resolved

bryanchriswhite requested changes Aug 30, 2024

View reviewed changes

Olshansk added 4 commits August 30, 2024 16:03

Merge with main

ce2c89a

Updated the FAQ

02091ea

Formatting fix

29b59b2

Merge branch 'main' into tokenomic_docs

f4547a5

Olshansk requested a review from bryanchriswhite August 30, 2024 21:01

bryanchriswhite approved these changes Aug 30, 2024

View reviewed changes

docusaurus/docs/protocol/tokenomics/token_logic_modules.md Outdated Show resolved Hide resolved

docusaurus/docs/protocol/tokenomics/token_logic_modules.md Show resolved Hide resolved

docusaurus/docs/protocol/tokenomics/token_logic_modules.md Outdated Show resolved Hide resolved

Olshansk and others added 2 commits August 30, 2024 17:33

Update docusaurus/docs/protocol/tokenomics/token_logic_modules.md

5863173

Co-authored-by: Bryan White <bryanchriswhite@gmail.com>

Update docusaurus/docs/protocol/tokenomics/token_logic_modules.md

9467bcf

Co-authored-by: Bryan White <bryanchriswhite@gmail.com>

Olshansk merged commit 1fdde42 into main Aug 30, 2024
13 checks passed

Olshansk deleted the tokenomic_docs branch August 30, 2024 21:55

red-0ne mentioned this pull request Oct 17, 2024

[Application] Single Service Applications #886

Merged

11 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Docs] Tokenomics Documentation #750

[Docs] Tokenomics Documentation #750

Olshansk commented Aug 21, 2024 •

edited

Loading

bryanchriswhite left a comment

Olshansk commented Aug 23, 2024

red-0ne left a comment

Olshansk commented Aug 28, 2024

red-0ne left a comment

bryanchriswhite commented Aug 30, 2024

bryanchriswhite left a comment •

edited

Loading

[Docs] Tokenomics Documentation #750

[Docs] Tokenomics Documentation #750

Conversation

Olshansk commented Aug 21, 2024 • edited Loading

Summary

Issue

Type of change

Testing

bryanchriswhite left a comment

Choose a reason for hiding this comment

Olshansk commented Aug 23, 2024

red-0ne left a comment

Choose a reason for hiding this comment

Olshansk commented Aug 28, 2024

red-0ne left a comment

Choose a reason for hiding this comment

bryanchriswhite commented Aug 30, 2024

bryanchriswhite left a comment • edited Loading

Choose a reason for hiding this comment

Olshansk commented Aug 21, 2024 •

edited

Loading

bryanchriswhite left a comment •

edited

Loading