Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] Tokenomics Documentation #750

Merged
merged 42 commits into from
Aug 30, 2024
Merged

[Docs] Tokenomics Documentation #750

merged 42 commits into from
Aug 30, 2024

Conversation

Olshansk
Copy link
Member

@Olshansk Olshansk commented Aug 21, 2024

Summary

First iteration of tokenomics documentation.

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 but 10x simpler.

Issue

Type of change

Select one or more:

  • New feature, functionality or library
  • Bug fix
  • Code health or cleanup
  • Documentation
  • Other (specify)

Testing

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

@Olshansk Olshansk added the documentation Improvements or additions to documentation label Aug 21, 2024
@Olshansk Olshansk added this to the Shannon Beta TestNet Launch milestone Aug 21, 2024
@Olshansk Olshansk self-assigned this Aug 21, 2024
Copy link
Contributor

@bryanchriswhite bryanchriswhite left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Have to step away for a bit.
image

docusaurus/docs/protocol/tokenomics/resources.md Outdated Show resolved Hide resolved
docusaurus/docs/protocol/tokenomics/resources.md Outdated Show resolved Hide resolved
docusaurus/docs/protocol/tokenomics/resources.md Outdated Show resolved Hide resolved
docusaurus/docs/protocol/tokenomics/token_logic_modules.md Outdated Show resolved Hide resolved
docusaurus/docs/protocol/tokenomics/token_logic_modules.md Outdated Show resolved Hide resolved
docusaurus/docs/protocol/tokenomics/token_logic_modules.md Outdated Show resolved Hide resolved
docusaurus/docs/protocol/tokenomics/token_logic_modules.md Outdated Show resolved Hide resolved
docusaurus/docs/protocol/tokenomics/token_logic_modules.md Outdated Show resolved Hide resolved
docusaurus/docs/protocol/tokenomics/token_logic_modules.md Outdated Show resolved Hide resolved
docusaurus/docs/protocol/tokenomics/token_logic_modules.md Outdated Show resolved Hide resolved
@Olshansk
Copy link
Member Author

@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.

@Olshansk Olshansk requested a review from red-0ne August 23, 2024 16:02
@Olshansk
Copy link
Member Author

Olshansk commented Aug 26, 2024

@bryanchriswhite Please review the changes and lmk if it makes sense.

Appreciate the detailed review!

Copy link
Contributor

@bryanchriswhite bryanchriswhite left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm struggling a bit to understand the end-to-end of the GMRR TLM. 🤔

Copy link
Contributor

@red-0ne red-0ne left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very informative docs, thanks for putting it together.

docusaurus/docs/protocol/tokenomics/token_logic_modules.md Outdated Show resolved Hide resolved
docusaurus/docs/protocol/tokenomics/token_logic_modules.md Outdated Show resolved Hide resolved
docusaurus/docs/protocol/tokenomics/token_logic_modules.md Outdated Show resolved Hide resolved
docusaurus/docs/protocol/tokenomics/token_logic_modules.md Outdated Show resolved Hide resolved
docusaurus/docs/protocol/tokenomics/token_logic_modules.md Outdated Show resolved Hide resolved
docusaurus/docs/protocol/tokenomics/token_logic_modules.md Outdated Show resolved Hide resolved
docusaurus/docs/protocol/tokenomics/token_logic_modules.md Outdated Show resolved Hide resolved
docusaurus/docs/protocol/tokenomics/token_logic_modules.md Outdated Show resolved Hide resolved
docusaurus/docs/protocol/tokenomics/token_logic_modules.md Outdated Show resolved Hide resolved
@Olshansk
Copy link
Member Author

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

Copy link
Contributor

@red-0ne red-0ne left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great improvements on the GMRR section.

LGTM!

@bryanchriswhite
Copy link
Contributor

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

Copy link
Contributor

@bryanchriswhite bryanchriswhite left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a couple minor typos but otherwise LGTM! 🚢

@Olshansk Olshansk merged commit 1fdde42 into main Aug 30, 2024
13 checks passed
@Olshansk Olshansk deleted the tokenomic_docs branch August 30, 2024 21:55
bryanchriswhite added a commit that referenced this pull request Sep 5, 2024
…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)
bryanchriswhite added a commit that referenced this pull request Sep 5, 2024
…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)
bryanchriswhite added a commit that referenced this pull request Sep 5, 2024
…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)
Olshansk added a commit that referenced this pull request Sep 9, 2024
## 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] <[email protected]>
Co-authored-by: Bryan White <[email protected]>
Co-authored-by: Redouane Lakrache <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
red-0ne added a commit that referenced this pull request Oct 28, 2024
## 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 <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

3 participants