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/Adding matching property #4930

Merged
merged 4 commits into from
Jan 20, 2025
Merged

Feat/Adding matching property #4930

merged 4 commits into from
Jan 20, 2025

Conversation

kkatusic
Copy link
Collaborator

@kkatusic kkatusic commented Jan 10, 2025

Summary by CodeRabbit

Release Notes

  • New Features

    • Added support for new matching fund calculation strategies
    • Introduced Quadratic Funding (QF) strategy enumeration
  • Improvements

    • Enhanced project and donation data models with additional matching and strategy information
    • Updated calculation methods for estimated matching funds
    • Improved robustness of matching fund calculations across multiple components
  • Technical Updates

    • Extended GraphQL queries and fragments to include new matching and strategy fields

@kkatusic kkatusic self-assigned this Jan 10, 2025
Copy link

vercel bot commented Jan 10, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
giveth-dapps-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 14, 2025 1:15pm

@kkatusic kkatusic marked this pull request as ready for review January 14, 2025 13:10
Copy link
Contributor

coderabbitai bot commented Jan 14, 2025

Walkthrough

This pull request introduces a new matching field and a QfStrategyEnum to enhance the data structures and calculations related to quadratic funding (QF) rounds and project donations. The changes span multiple files, including GraphQL queries, TypeScript interfaces, and components that handle project and donation information. The modifications allow for more detailed tracking and calculation of matching funds, particularly introducing a new strategy type called "Cocm".

Changes

File Change Summary
src/apollo/gql/gqlDonations.ts Added matching field to estimatedMatching in FETCH_QF_ROUND_HISTORY query
src/apollo/gql/gqlProjects.ts Added qfStrategy to qfRounds and matching to estimatedMatching in multiple queries/fragments
src/apollo/types/types.ts Introduced QfStrategyEnum with Cocm and Regular values, updated IQFRound and IEstimatedMatching interfaces
src/components/project-card/ProjectCard.tsx Updated destructuring of estimatedMatching to include matching
src/components/views/donate/DonatePageProjectDescription.tsx Added matching and qfStrategy to calculations
src/components/views/project/projectDonations/ProjectTotalFundCard.tsx Modified matching fund calculations
src/helpers/qf.ts Updated calculateTotalEstimatedMatching function to handle new matching and qfStrategy parameters

Sequence Diagram

sequenceDiagram
    participant Client
    participant GraphQL
    participant QFCalculator
    Client->>GraphQL: Request Project Data
    GraphQL-->>Client: Return Project with estimatedMatching
    Client->>QFCalculator: Calculate Total Estimated Matching
    QFCalculator->>QFCalculator: Check QF Strategy
    alt Strategy is COCM
        QFCalculator-->>Client: Return Matching Value
    else Strategy is Regular
        QFCalculator->>QFCalculator: Perform Standard Calculation
        QFCalculator-->>Client: Return Calculated Matching
    end
Loading

Possibly Related PRs

Poem

🐰 Matching funds, a rabbit's delight,
Cocm and Regular, strategies so bright!
New fields dancing in our code's embrace,
Quadratic funding finds its rightful place
Hop, hop, hooray for data's new might! 🌟

Finishing Touches

  • 📝 Generate Docstrings (Beta)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • 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/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

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.

Actionable comments posted: 0

🧹 Nitpick comments (1)
src/apollo/types/types.ts (1)

492-495: Add documentation for the QF strategy enum values.

Consider adding JSDoc comments to explain what each QF strategy represents and when they should be used.

Apply this diff to add documentation:

 export enum QfStrategyEnum {
+    /** Constrained Optimal Capital Matching strategy */
     Cocm = 'Cocm',
+    /** Regular Quadratic Funding matching strategy */
     Regular = 'Regular',
 }
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1779ade and f79c543.

📒 Files selected for processing (7)
  • src/apollo/gql/gqlDonations.ts (1 hunks)
  • src/apollo/gql/gqlProjects.ts (6 hunks)
  • src/apollo/types/types.ts (3 hunks)
  • src/components/project-card/ProjectCard.tsx (3 hunks)
  • src/components/views/donate/DonatePageProjectDescription.tsx (3 hunks)
  • src/components/views/project/projectDonations/ProjectTotalFundCard.tsx (4 hunks)
  • src/helpers/qf.ts (3 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: build
🔇 Additional comments (15)
src/helpers/qf.ts (2)

35-36: LGTM! Parameters are well-defined.

The new parameters matching and qfStrategy are properly typed and initialized. The default value of 0 for matching prevents potential null/undefined issues.


46-49: LGTM! Clean implementation of COCM strategy.

The early return pattern for the COCM strategy is clean and maintainable. The condition is clear and the logic is straightforward.

src/apollo/gql/gqlDonations.ts (1)

173-173: LGTM! GraphQL query updated correctly.

The matching field is properly added to the estimatedMatching object in the FETCH_QF_ROUND_HISTORY query.

src/components/views/donate/DonatePageProjectDescription.tsx (2)

52-57: LGTM! Clean destructuring of new properties.

The matching field is properly destructured from estimatedMatching along with other existing fields.


155-156: LGTM! Function parameters updated correctly.

The calculateTotalEstimatedMatching call is properly updated with the new matching and qfStrategy parameters.

src/components/views/project/projectDonations/ProjectTotalFundCard.tsx (2)

123-124: LGTM! Function calls updated consistently.

Both instances of calculateTotalEstimatedMatching are properly updated with the new matching and qfStrategy parameters.

Also applies to: 135-136


225-225: LGTM! Good defensive programming.

The null check matchFund || 0 prevents potential runtime errors when formatting the donation amount.

src/apollo/types/types.ts (1)

30-30: LGTM!

The matching property is correctly typed as a required number, consistent with other properties in the interface.

src/apollo/gql/gqlProjects.ts (4)

23-23: LGTM!

The qfStrategy field is correctly added to the PROJECT_CORE_FIELDS fragment, ensuring consistent data fetching across all queries that use this fragment.


55-55: LGTM!

The matching field is correctly added to the PROJECT_CARD_FIELDS fragment, ensuring consistent data fetching across all queries that use this fragment.


185-185: LGTM!

The matching and qfStrategy fields are correctly added to the FETCH_PROJECT_BY_SLUG_DONATION query.

Also applies to: 199-199


283-283: LGTM!

The matching and qfStrategy fields are correctly added to the FETCH_PROJECT_BY_SLUG_SINGLE_PROJECT query.

Also applies to: 296-296

src/components/project-card/ProjectCard.tsx (3)

94-99: LGTM!

The matching property is correctly destructured from estimatedMatching with proper null checking.


108-108: LGTM!

The qfStrategy property is correctly destructured from activeQFRound with proper null checking.


308-309: LGTM!

The matching and qfStrategy parameters are correctly passed to the calculateTotalEstimatedMatching function.

@kkatusic kkatusic merged commit 6283689 into develop Jan 20, 2025
3 checks passed
@kkatusic kkatusic deleted the feat/estimated_matching branch January 20, 2025 12:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: QA
Development

Successfully merging this pull request may close these issues.

2 participants