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

feat: token model v2 #356

Merged
merged 2 commits into from
Dec 5, 2023
Merged

feat: token model v2 #356

merged 2 commits into from
Dec 5, 2023

Conversation

ccamel
Copy link
Member

@ccamel ccamel commented Dec 4, 2023

Specification of the token model v2 for the OKP4 protocol by @tpelliet.

image

Summary by CodeRabbit

  • Documentation

    • Updated the token model documentation for enhanced clarity and accuracy.
    • Renamed "OKP4 Token Model" to "KNOW Token Model" and refined the description of objectives.
  • Refactor

    • Improved the calculation logic and data structure for the token model's visualization.
  • Style

    • Adjusted the caption and data source presentation in the visualization component.

Copy link
Contributor

coderabbitai bot commented Dec 4, 2023

Walkthrough

The recent updates involve a comprehensive overhaul of the token model's documentation and visualization code. The changes include renaming modules and data structures, refining the token model's description, and altering the calculation logic to reflect a new inflation formula and its impact on the token economy.

Changes

File Path Change Summary
.../token-model.mdx Renamed module, updated captions and data sources in components, and refined content for clarity.
.../token-model.tsx Removed and added constants, renamed and updated functions, and modified data structures for new logic.

🐇✨
In the code where tokens dance,
A rabbit tweaked the finance stance.
With a hop and a skip, the model's new,
Inflation's tale, freshly brewed. 🌱📈


Tips

Chat with CodeRabbit Bot (@coderabbitai)

  • If you reply to a review comment from CodeRabbit, the bot will automatically respond.
  • To engage with CodeRabbit bot directly around the specific lines of code in the PR, mention @coderabbitai in your review comment
  • Note: Review comments are made on code diffs or files, not on the PR overview.
  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Note: For conversation with the bot, please use the review comments on code diffs or files.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

@ccamel ccamel force-pushed the feat/token-model-v2 branch from 0cb0ca9 to 0532c27 Compare December 4, 2023 09:11
Copy link
Member

@bot-anik bot-anik left a comment

Choose a reason for hiding this comment

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

Device URL
desktop http://localhost:3000/

Device URL
mobile http://localhost:3000/

Not what you expected? Are your scores flaky? GitHub runners could be the cause.
Try running on Foo instead

@ccamel ccamel force-pushed the feat/token-model-v2 branch from 0532c27 to 668b672 Compare December 4, 2023 09:19
@ccamel ccamel self-assigned this Dec 4, 2023
@ccamel ccamel force-pushed the feat/token-model-v2 branch from 668b672 to 17de574 Compare December 4, 2023 13:27
@ccamel ccamel marked this pull request as ready for review December 4, 2023 13:32
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 1

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 6737f9e and 17de574.
Files selected for processing (2)
  • docs/whitepaper/token-model.mdx (2 hunks)
  • docs/whitepaper/token-model.tsx (2 hunks)
Additional comments: 6
docs/whitepaper/token-model.mdx (2)
  • 5-5: The import statement should be updated to reflect the new module name as per the PR objectives and summary.
- import { inflationRateData, srdyPercentData, LinePlot } from './token-model'
+ import { inflationRateData, srdyPercentData, LinePlot } from './inflationRateData'
  • 19-73: The updates to the documentation in this hunk are consistent with the PR objectives and the summary provided, reflecting the new "KNOW Token Model" and its mechanisms.
docs/whitepaper/token-model.tsx (4)
  • 5-5: The introduction of the new constant c is in line with the PR objectives and the summary provided.

  • 9-14: The inflationPoints generator function has been correctly implemented to reflect the new calculation logic for the inflation rate.

  • 17-23: The inflationRateData data structure has been updated to use the new inflationPoints function, which is consistent with the PR objectives and the summary.

  • 81-81: The use of the constant c as a marker value in the LinePlot component is consistent with the changes made to the token model.

docs/whitepaper/token-model.tsx Show resolved Hide resolved
Copy link
Member

@MdechampG MdechampG left a comment

Choose a reason for hiding this comment

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

👍🏻

Copy link
Member

@tpelliet tpelliet left a comment

Choose a reason for hiding this comment

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

👌

Copy link
Member

@amimart amimart left a comment

Choose a reason for hiding this comment

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

LGTM 😉

@ccamel ccamel merged commit c88ec26 into main Dec 5, 2023
12 checks passed
@ccamel ccamel deleted the feat/token-model-v2 branch December 5, 2023 13:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants