feat(rfq-indexer): add `request` column to `BridgeRequested` for refunds

golangisfun123 commented 1 month ago

Description A clear and concise description of the features you're adding in this pull request.

Additional context Add any other context about the problem you're solving.

Metadata

Fixes #[Link to Issue]

Summary by CodeRabbit

New Features
- Added a new field, request, to the deposit events, enhancing the information retrieved for bridge requests.
- Expanded the GraphQL schema to include the request field in the BridgeRequestEvent type.
Bug Fixes
- Ensured type consistency by explicitly converting originChainId and destChainId to numbers in the event data structure.

coderabbitai[bot] commented 1 month ago

Walkthrough

The changes in this pull request involve the addition of a new field, 'BridgeRequestEvents.request', across multiple files related to the qDeposits function and the BridgeRequestEvents structure. This new field enhances the data retrieved for deposit events in the GraphQL resolvers, database queries, and type definitions. The modifications also include updates to the event handling logic for FastBridgeV2 events, ensuring that the new property is captured during event processing. The overall structure and logic of existing functionalities remain unchanged.

Changes

File Path	Change Summary
`.../graphql/resolvers.ts`	Added field `'BridgeRequestEvents.request'` in `qDeposits` function.
`.../queries/depositsQueries.ts`	Added selection field `'BridgeRequestEvents.request'` in `qDeposits` function.
`.../types/index.ts`	Added property `request: ColumnType<string>` in `BridgeRequestEvents` interface.
`.../ponder.schema.ts`	Added field `request: p.string()` in `BridgeRequestEvents` table schema.
`.../index/src/index.ts`	Added property `request` in event handler for `FastBridgeV2:BridgeRequested`.

Possibly related PRs

#3227: This PR introduces the "bridgedispute" event to the indexer, which is directly related to the changes made in the main PR regarding the BridgeRequestEvents and the handling of disputes.
#3239: This PR updates the BridgeProofDisputedEvents table schema and modifies event handling logic, which aligns with the main PR's focus on expanding the BridgeRequestEvents functionality.
#3243: This PR enhances functionality related to dispute events, which is directly relevant to the main PR's changes involving the addition of the request field in the context of bridge events.

Suggested labels

size/m, M-docs

Suggested reviewers

trajan0x
parodime
ChiTimesChi
bigboydiamonds

🐇 In the fields where bridges sway,
A new request has come to play.
With data rich, our queries grow,
In events of bridges, we now know!
So hop along, let’s celebrate,
For changes made, we elevate! 🎉

📜 Recent review details

**Configuration used: .coderabbit.yaml** **Review profile: CHILL**

📥 Commits

Files that changed from the base of the PR and between d84403edd7804a0cba770980297c2318d39d457f and a7145036a629145d562f8e6241a86ecba627fc43.

📒 Files selected for processing (1)

* packages/rfq-indexer/api/src/graphql/types/events.graphql (1 hunks)

🧰 Additional context used

🔇 Additional comments (1)

packages/rfq-indexer/api/src/graphql/types/events.graphql (1)
`20-20`: **New field `request` added to `BridgeRequestEvent`** The addition of the `request: String!` field to the `BridgeRequestEvent` type is consistent with the PR objectives to enhance the functionality for refunds. This non-nullable field will ensure that all bridge request events include this information. Consider the following points: 1. Ensure that all resolvers and data sources are updated to provide this new field. 2. Update any existing queries that fetch `BridgeRequestEvent` to include this new field if necessary. 3. Consider adding a comment or description to the field to clarify its purpose and expected content. To ensure consistency across the codebase, let's verify the usage of this new field:

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

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

🪧 Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

cloudflare-workers-and-pages[bot] commented 1 month ago

Deploying sanguine-fe with Cloudflare Pages

Latest commit:	`a714503`
Status:	✅ Deploy successful!
Preview URL:	https://3feae47d.sanguine-fe.pages.dev
Branch Preview URL:	https://add-request.sanguine-fe.pages.dev

View logs

codecov[bot] commented 1 month ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 35.14833%. Comparing base (8724af9) to head (a714503). Report is 12 commits behind head on feat/explorer-w.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## feat/explorer-w #3287 +/- ## ========================================================== - Coverage 90.44834% 35.14833% -55.30001% ========================================================== Files 54 77 +23 Lines 1026 2663 +1637 Branches 82 82 ========================================================== + Hits 928 936 +8 - Misses 95 1722 +1627 - Partials 3 5 +2 ``` | [Flag](https://app.codecov.io/gh/synapsecns/sanguine/pull/3287/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | Coverage Δ | | |---|---|---| | [packages](https://app.codecov.io/gh/synapsecns/sanguine/pull/3287/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `90.44834% <ø> (ø)` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

synapsecns / sanguine