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

fix(rfq-indexer): add missing fields #3308

Closed
wants to merge 3 commits into from

Conversation

golangisfun123
Copy link
Collaborator

@golangisfun123 golangisfun123 commented Oct 17, 2024

??? why diff so big.

Copy link
Contributor

coderabbitai bot commented Oct 17, 2024

Walkthrough

The changes in this pull request involve the addition of two properties, originChainId and originChain, to the BridgeProofDisputedEvents interface in the packages/rfq-indexer/api/src/types/index.ts file. These properties are defined as ColumnType<number> and ColumnType<string>, respectively, thereby expanding the interface to include additional data relevant to bridge proof disputes.

Changes

File Path Change Summary
packages/rfq-indexer/api/src/types/index.ts Added properties originChainId: ColumnType<number> and originChain: ColumnType<string> to the BridgeProofDisputedEvents interface.

Possibly related PRs

  • RFQ-Indexer DB updates #3239: This PR modifies the BridgeProofDisputedEvents table schema, renaming fields to originChainId and originChain, which directly relates to the changes made in the main PR that adds these properties to the BridgeProofDisputedEvents interface.
  • Paro/rfq indexer updates suggs #3243: This PR discusses updates related to dispute events, which may include the new properties added in the main PR, enhancing the functionality related to disputes.
  • feat(rfq-indexer): add request column to BridgeRequested for refunds #3287: Although this PR primarily focuses on adding a request column to the BridgeRequested event, it also involves changes to the BridgeRequestEvents interface, which is relevant to the overall structure of event handling in the RFQ indexer, potentially connecting to the changes in the main PR.

Suggested labels

size/xs, Sol, Typescript

Suggested reviewers

  • trajan0x
  • parodime
  • Defi-Moses

🐇 In the code where changes bloom,
New properties make room,
originChainId and originChain,
Together they’ll help explain,
Disputes in the bridge, oh what a boon!
Hopping forward, we’ll see them soon! 🌟


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

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

🧹 Outside diff range and nitpick comments (1)
packages/rfq-indexer/api/src/types/index.ts (1)

93-94: LGTM! Consider reordering properties for consistency.

The addition of originChainId and originChain to the BridgeProofDisputedEvents interface is appropriate and aligns with the PR objective of adding missing fields. These properties are consistent with other interfaces in the file and provide valuable information about the origin chain in cross-chain operations.

For improved readability and consistency with other interfaces, consider reordering the properties to group related fields together. Here's a suggested order:

export interface BridgeProofDisputedEvents {
  id: ColumnType<string>
  transactionId: ColumnType<string>
  blockNumber: ColumnType<bigint>
  blockTimestamp: ColumnType<number>
  transactionHash: ColumnType<string>
  originChainId: ColumnType<number>
  originChain: ColumnType<string>
  chainId: ColumnType<number>
  chain: ColumnType<string>
}

This order groups the transaction-related fields, followed by origin chain fields, and then the destination chain fields, which is consistent with the structure of other interfaces in this file.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 6b4c78e and b5461c3.

⛔ Files ignored due to path filters (1)
  • package-lock.json is excluded by !**/package-lock.json
📒 Files selected for processing (1)
  • packages/rfq-indexer/api/src/types/index.ts (1 hunks)
🧰 Additional context used

Copy link

cloudflare-workers-and-pages bot commented Oct 17, 2024

Deploying sanguine-fe with  Cloudflare Pages  Cloudflare Pages

Latest commit: b5461c3
Status: ✅  Deploy successful!
Preview URL: https://8465b072.sanguine-fe.pages.dev
Branch Preview URL: https://fix-request.sanguine-fe.pages.dev

View logs

@github-actions github-actions bot deleted the fix-request branch October 17, 2024 21:39
Copy link

codecov bot commented Oct 17, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.44834%. Comparing base (6b4c78e) to head (8c0fd7f).

Additional details and impacted files
@@                 Coverage Diff                 @@
##           feat/explorer-w       #3308   +/-   ##
===================================================
  Coverage         90.44834%   90.44834%           
===================================================
  Files                   54          54           
  Lines                 1026        1026           
  Branches                82          82           
===================================================
  Hits                   928         928           
  Misses                  95          95           
  Partials                 3           3           
Flag Coverage Δ
packages 90.44834% <ø> (ø)

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant