search

synapsecns / sanguine

Synapse Monorepo
MIT License
42 stars 30 forks source link

Feat/fb v2 docs [SLT-476] #3402

Open parodime opened 1 week ago

parodime commented 1 week ago

RFQ Docs refactor

Summary by CodeRabbit

coderabbitai[bot] commented 1 week ago

Walkthrough

This pull request introduces extensive updates to the documentation for the Synapse RFQ system, including new entries for various API endpoints such as "Get open quote requests," "Initiate an Active RFQ," and "Listen for Active RFQs." It also includes modifications to existing documentation, enhancing clarity and detail on the RFQ process, API usage, and the roles of different entities within the system. Additionally, there are updates to the Swagger API documentation reflecting new endpoints and improved descriptions.

Changes

File Path Change Summary
docs/bridge/docs/03-RFQ/10-Quoting/Quoter API/get-open-quote-requests.api.mdx New documentation file for "Get open quote requests" API endpoint, detailing functionality and response formats.
docs/bridge/docs/03-RFQ/10-Quoting/Quoter API/index.md Updated documentation for the Quoter API, including structured sections on Passive and Active Quotes, WebSocket API, and authentication requirements.
docs/bridge/docs/03-RFQ/10-Quoting/Quoter API/initiate-an-active-rfq.api.mdx New documentation for initiating an active RFQ, including request and response details.
docs/bridge/docs/03-RFQ/10-Quoting/Quoter API/listen-for-active-rf-qs.api.mdx New documentation for establishing a WebSocket connection to listen for active RFQs.
docs/bridge/docs/03-RFQ/10-Quoting/Quoter API/sidebar.ts New sidebar configuration for organizing Quoter API documentation.
docs/bridge/docs/03-RFQ/10-Quoting/index.md New document providing an overview of the Quoting functionality within the RFQ system.
docs/bridge/docs/03-RFQ/15-Bridging/index.md New documentation for Bridging functionality within the RFQ framework.
docs/bridge/docs/03-RFQ/15-Bridging/quoteId.md New documentation for the optional quoteId parameter in FastBridgeV2 transactions.
docs/bridge/docs/03-RFQ/15-Bridging/zaps.md New document with reference links related to FastBridge contract interfaces.
docs/bridge/docs/03-RFQ/20-Relaying/index.md New documentation on the relaying process within the RFQ system.
docs/bridge/docs/03-RFQ/20-Relaying/riskFactors.md New document detailing risks associated with being a Relayer.
docs/bridge/docs/03-RFQ/30-Proving/index.md New documentation outlining the proving process in FastBridgeV2.
docs/bridge/docs/03-RFQ/40-Claiming/index.md New documentation on the claiming process within FastBridgeV2.
docs/bridge/docs/03-RFQ/50-Canceling/index.md New documentation for the Canceling functionality within the RFQ system.
docs/bridge/docs/03-RFQ/60-Security/index.md New detailed "Security" section outlining the optimistic cross-chain mechanism.
docs/bridge/docs/03-RFQ/70-CanonicalRelayer/index.md Revised documentation reflecting the rebranding of RFQ Relayer to Canonical RFQ Relayer.
docs/bridge/docs/03-RFQ/90-Misc/index.md New documentation section titled "Miscellaneous" for FastBridge utilities and RFQ load testing tool.
docs/bridge/docs/04-Routers/RFQ/API/index.md Deleted file containing RFQ API documentation.
docs/bridge/docs/04-Routers/RFQ/index.md Deleted file containing RFQ Router documentation.
docs/bridge/docs/05-Contracts/06-RFQ.md Updated to include details about FastBridge Version 2.
docs/bridge/docusaurus.config.ts Updated output directory for generated API documentation files.
packages/rest-api/swagger.json Significant updates to Swagger API documentation, including new endpoints and response schemas.
services/rfq/api/docs/docs.go Modifications to Swagger documentation for RFQ API endpoints.
services/rfq/api/docs/swagger.json Major modifications to Swagger API documentation, including new models and paths.
services/rfq/api/docs/swagger.yaml Updates to descriptions and summaries for the /rfq and /rfq_stream endpoints.
services/rfq/api/rest/server.go Improvements to comments and documentation clarity in the API server code.
cspell.json Added new words "permissionless" and "permissioned" to the configuration file.
docs/bridge/docs/01-About/index.md Updated hyperlink reference for the RFQ section.
docs/bridge/docs/02-Bridge/01-SDK.md Updated SDK documentation to reflect changes in API and usage instructions.
docs/bridge/docs/03-RFQ/75-Exclusivity/index.md New documentation explaining the exclusivity feature in FastBridgeV2.

Possibly related PRs

Suggested labels

size/xs

Suggested reviewers

🐰 In the land of code and docs so bright,
New APIs bloom, a wondrous sight!
With quotes and bridges, we now can see,
A clearer path for you and me.
So hop along, let’s integrate,
The RFQ magic awaits, don’t be late! 🌟

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://docs.coderabbit.ai) 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 week ago

Codecov Report

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

Project coverage is 25.14811%. Comparing base (fd8ad75) to head (7fdf0ef). Report is 37 commits behind head on master.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #3402 +/- ## =================================================== - Coverage 33.16732% 25.14811% -8.01921% =================================================== Files 544 199 -345 Lines 34736 13166 -21570 Branches 82 82 =================================================== - Hits 11521 3311 -8210 + Misses 22197 9578 -12619 + Partials 1018 277 -741 ``` | [Flag](https://app.codecov.io/gh/synapsecns/sanguine/pull/3402/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | Coverage Δ | | |---|---|---| | [cctp-relayer](https://app.codecov.io/gh/synapsecns/sanguine/pull/3402/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `?` | | | [core](https://app.codecov.io/gh/synapsecns/sanguine/pull/3402/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `?` | | | [ethergo](https://app.codecov.io/gh/synapsecns/sanguine/pull/3402/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `?` | | | [git-changes-action](https://app.codecov.io/gh/synapsecns/sanguine/pull/3402/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `?` | | | [omnirpc](https://app.codecov.io/gh/synapsecns/sanguine/pull/3402/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `?` | | | [opbot](https://app.codecov.io/gh/synapsecns/sanguine/pull/3402/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `0.18282% <ø> (-0.00055%)` | :arrow_down: | | [promexporter](https://app.codecov.io/gh/synapsecns/sanguine/pull/3402/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `6.81642% <ø> (ø)` | | | [screener-api](https://app.codecov.io/gh/synapsecns/sanguine/pull/3402/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `?` | | | [scribe](https://app.codecov.io/gh/synapsecns/sanguine/pull/3402/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `?` | | | [tools](https://app.codecov.io/gh/synapsecns/sanguine/pull/3402/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `?` | | 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.

🚨 Try these New Features:

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

Deploying sanguine-fe with  Cloudflare Pages  Cloudflare Pages

Latest commit: 7fdf0ef
Status: ✅  Deploy successful!
Preview URL: https://de9d5938.sanguine-fe.pages.dev
Branch Preview URL: https://feat-fbv2-docs.sanguine-fe.pages.dev

View logs

codecov[bot] commented 1 week ago

Bundle Report

Changes will decrease total bundle size by 2.75MB (-7.71%) :arrow_down:. This is within the configured threshold :white_check_mark:

Detailed changes | Bundle name | Size | Change | | ----------- | ---- | ------ | | sdk-router-@synapsecns/sdk-router-esm* | 255.26kB | 609 bytes (0.24%) :arrow_up: | | sdk-router-@synapsecns/sdk-router-cjs* | 527.39kB | 410.15kB (349.84%) :arrow_up: | | explorer-ui-server-cjs* | 724.74kB | 141.33kB (-16.32%) :arrow_down: | | explorer-ui-client-array-push* | 2.17MB | 146.44kB (-6.33%) :arrow_down: | | synapse-interface-client-array-push* | 7.41MB | 132.29kB (1.82%) :arrow_up: | | synapse-interface-server-cjs* | 1.65MB | 160.29kB (10.72%) :arrow_up: | | widget-cjs-esm* | 271.27kB | 2.03kB (-0.74%) :arrow_down: | | docs-bridge-client-array-push | 7.46MB | 437.74kB (-5.54%) :arrow_down: | | docs-bridge-server-cjs | 11.8MB | 3.07MB (-20.65%) :arrow_down: | | synapse-constants-esm-cjs* | 174.63kB | 174.63kB (100%) :arrow_up: | | synapse-constants-cjs-esm* | 174.18kB | 174.18kB (100%) :arrow_up: |

ℹ️ *Bundle size includes cached data from a previous commit