Paro/rfq indexer updates suggs

parodime commented 1 month ago

adding dispute events to endpoints - updating some docs/commments

Summary by CodeRabbit

Release Notes

New Features
- Introduced a new endpoint for retrieving active disputes.
- Added functionality to filter and retrieve only active proofs and disputes.
- New query for pending transactions that have exceeded a specified deadline.
Improvements
- Enhanced API documentation for clarity and organization.
- Updated existing queries to include new parameters for improved data retrieval.
Bug Fixes
- Corrected URL paths in API examples.
Types and Schema Updates
- Added new types and interfaces for handling dispute events in the API.

coderabbitai[bot] commented 1 month ago

Walkthrough

The pull request introduces several enhancements to the RFQ Indexer API, including modifications to the README for improved clarity, the addition of new controllers for handling disputes and pending transactions, and updates to existing queries and types. New environment variables are documented, and the database schema is expanded to accommodate dispute events. The changes also include the integration of GraphQL queries and resolvers for better data retrieval related to disputes, alongside updates to routing for new endpoints.

Changes

File Path	Change Summary
`packages/rfq-indexer/api/README.md`	Updated to clarify Swagger documentation, renumber API calls, and added "Env Vars" section.
`packages/rfq-indexer/api/src/controllers/conflictingProofsController.ts`	Modified to filter for active proofs and updated response messages.
`packages/rfq-indexer/api/src/controllers/disputesController.ts`	Introduced new asynchronous function to handle disputes, querying active disputes with structured response.
`packages/rfq-indexer/api/src/controllers/pendingTransactionsController.ts`	Added new controller for missing relay transactions and updated existing queries to filter active transactions.
`packages/rfq-indexer/api/src/controllers/transactionIdController.ts`	Enhanced `getTransactionById` to include dispute data and updated proof handling logic.
`packages/rfq-indexer/api/src/db/index.ts`	Added new event type `BridgeProofDisputedEvents` to the `Database` interface.
`packages/rfq-indexer/api/src/graphql/queries/queries.graphql`	Added new type `DisputedRelay` and new query for pending transactions missing relay.
`packages/rfq-indexer/api/src/graphql/resolvers.ts`	Introduced `qDisputes` query and `disputedRelays` resolver for handling dispute data.
`packages/rfq-indexer/api/src/graphql/types/events.graphql`	Added new event type `BridgeProofDisputedEvent` with relevant fields.
`packages/rfq-indexer/api/src/queries/disputesQueries.ts`	Introduced `qDisputes` function to query disputed events with optional filtering.
`packages/rfq-indexer/api/src/queries/index.ts`	Exported `qDisputes` from the disputesQueries module.
`packages/rfq-indexer/api/src/queries/proofsQueries.ts`	Updated `qProofs` to accept an `activeOnly` parameter and modified query logic.
`packages/rfq-indexer/api/src/routes/disputesRoute.ts`	Added new route for retrieving active disputes with OpenAPI documentation.
`packages/rfq-indexer/api/src/routes/index.ts`	Integrated new disputes route into the existing Express router.
`packages/rfq-indexer/api/src/routes/pendingTransactionsRoute.ts`	Added new endpoint for transactions exceeding a deadline and updated existing routes.
`packages/rfq-indexer/api/src/types/index.ts`	Introduced `BridgeProofDisputedEvents` interface and updated `EventType` to include 'DISPUTE'.

Possibly related PRs

#3167: The refactoring of the RFQ Indexer API and addition of Swagger documentation enhances the API's structure and usability, aligning with the changes made in the main PR regarding the RFQ Indexer API documentation.
#3222: Updates to the RFQ Indexer API documentation provide clarity on the API's functionality, which relates to the changes made in the main PR that also focused on improving the README for the RFQ Indexer API.
#3239: The updates to the database schema for the RFQ Indexer, specifically renaming fields for consistency, are relevant as they align with the overall refactoring and improvements in the RFQ Indexer API discussed in the main PR.

Suggested labels

M-docs, size/m, Sol, Typescript, M-deps

Suggested reviewers

abtestingalpha
bigboydiamonds
trajan0x
Defi-Moses

Poem

In the burrows deep and wide,
Changes hop with joyful pride.
Disputes and transactions dance,
With clarity, they take a chance.
New paths in code, we now explore,
Hopping forward, we’ll code some more! 🐇✨

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.

codecov[bot] commented 1 month ago

Codecov Report

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

Please upload report for BASE (master@5c3686c). Learn more about missing BASE report. Report is 8 commits behind head on master.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## master #3243 +/- ## ============================================ Coverage ? 90.43902% ============================================ Files ? 54 Lines ? 1025 Branches ? 82 ============================================ Hits ? 927 Misses ? 95 Partials ? 3 ``` | [Flag](https://app.codecov.io/gh/synapsecns/sanguine/pull/3243/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/3243/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `90.43902% <ø> (?)` | | 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