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: Add class diagram for the database schema of the hbar limiter redesign #2884

Merged
merged 3 commits into from
Aug 27, 2024

Conversation

victor-yanev
Copy link
Contributor

Description:

This PR adds a class diagram to the documentation for the database schema of the Hbar Limiter redesign. The diagram provides a visual representation of the classes and their relationships, which are used to manage Hbar spending plans and records.

Changes:

  • docs/design/hbar-limiter.md:
    • Wrapped the current diagram into a "Service Layer" section
    • Added a new "Database Layer" section with a class diagram for the DB entities + repositories

Checklist

  • Documented (Code comments, README, etc.)

…r limiter

Signed-off-by: Victor Yanev <victor.yanev@limechain.tech>
@victor-yanev victor-yanev added documentation Improvements or additions to documentation design Design, pilot and prototyping exploration work labels Aug 27, 2024
@victor-yanev victor-yanev added this to the 0.55.0 milestone Aug 27, 2024
@victor-yanev victor-yanev self-assigned this Aug 27, 2024
@victor-yanev victor-yanev requested a review from a team as a code owner August 27, 2024 08:40
Copy link

github-actions bot commented Aug 27, 2024

Tests

       3 files     209 suites   17s ⏱️
1 057 tests 1 056 ✔️ 1 💤 0
1 069 runs  1 068 ✔️ 1 💤 0

Results for commit 4449ff8.

♻️ This comment has been updated with latest results.

Copy link

github-actions bot commented Aug 27, 2024

Acceptance Tests

  20 files  270 suites   29m 54s ⏱️
598 tests 589 ✔️ 4 💤 5
839 runs  828 ✔️ 4 💤 7

Results for commit 4449ff8.

♻️ This comment has been updated with latest results.

Signed-off-by: Victor Yanev <victor.yanev@limechain.tech>
Signed-off-by: Victor Yanev <victor.yanev@limechain.tech>
Copy link

Copy link
Contributor

@ebadiere ebadiere left a comment

Choose a reason for hiding this comment

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

LG.

Copy link
Contributor

@acuarica acuarica left a comment

Choose a reason for hiding this comment

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

lg

@ebadiere ebadiere merged commit 8fb2493 into main Aug 27, 2024
43 of 45 checks passed
@ebadiere ebadiere deleted the add-UML-diagram-for-the-hbar-limiter-db-design branch August 27, 2024 19:24
Copy link

codecov bot commented Aug 27, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 82.70%. Comparing base (76582fa) to head (4449ff8).
Report is 4 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2884   +/-   ##
=======================================
  Coverage   82.70%   82.70%           
=======================================
  Files          47       47           
  Lines        3457     3457           
  Branches      731      731           
=======================================
  Hits         2859     2859           
  Misses        371      371           
  Partials      227      227           
Flag Coverage Δ
relay 82.78% <ø> (ø)
server 81.22% <ø> (ø)
ws-server 97.87% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
design Design, pilot and prototyping exploration work documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[HBAR Rate Limit Redesign] Extend docs with class diagram for DB schema
3 participants