Feat/fb v2 docs [SLT-476] #3402
Conversation
parodime
requested review from
dwasse,
trajan0x,
aureliusbtc and
Defi-Moses
as code owners
WalkthroughThis pull request introduces extensive documentation updates for the Synapse RFQ (Request-For-Quote) system, including new API endpoints and detailed descriptions of their functionality. Key additions include documentation for the "Get open quote requests," "Initiate an Active RFQ," and "Listen for Active RFQs" endpoints, among others. The changes enhance clarity and usability for developers integrating with the Quoter API, outlining request and response formats, authentication requirements, and operational procedures. Additionally, several existing documentation files have been updated to reflect new features and structural changes in the API. Changes
Possibly related PRs
Suggested reviewers
Warning Rate limit exceeded@trajan0x has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 11 minutes and 44 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
Documentation and Community
|
github-actions
bot
added
go
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #3402 +/- ##
===================================================
+ Coverage 3.10368% 25.09494% +21.99126%
===================================================
Files 44 199 +155
Lines 2932 13166 +10234
Branches 0 82 +82
===================================================
+ Hits 91 3304 +3213
- Misses 2838 9583 +6745
- Partials 3 279 +276
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
Deploying sanguine-fe with
|
| Latest commit: |
21c6c5e
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://f201e6e8.sanguine-fe.pages.dev |
| Branch Preview URL: | https://feat-fbv2-docs.sanguine-fe.pages.dev |
Bundle ReportChanges will decrease total bundle size by 3.16MB (-8.86%) ⬇️. This is within the configured threshold ✅ Detailed changes
ℹ️ *Bundle size includes cached data from a previous commit |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Outside diff range and nitpick comments (44)
docs/bridge/docs/03-RFQ/15-Bridging/quoteId.md (2)
5-35: Consider optimizing reference links management.While the comprehensive list of reference links is valuable, they are currently unused in this document. Consider either:
- Using these links within the content to provide more context about related components, or
- Moving them to a shared reference file if they're meant to be used across multiple documentation files.
🧰 Tools
🪛 Markdownlint
6-6: Unused link or image reference definition: "relay"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
7-7: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
9-9: Unused link or image reference definition: "claim"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
13-13: Unused link or image reference definition: "bridgetransactionv2"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "relaying"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
29-29: Unused link or image reference definition: "user"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
30-30: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "relayer"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
33-33: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
40-40: Fix grammatical issue and consider adding more context.
- The sentence with "however" needs proper punctuation.
- Consider adding examples of quoteId usage and potential future functionality.
Apply this change:
-There is currently no on-chain functionality that utilizes this field, it is simply for record keeping and indexing, however this may change in the future. +There is currently no on-chain functionality that utilizes this field, it is simply for record keeping and indexing. However, this may change in the future.Consider adding:
- Example of a quoteId format
- Use cases for record keeping and indexing
- Potential future on-chain functionality
🧰 Tools
🪛 LanguageTool
[typographical] ~40-~40: The word “however” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence.
Context: ...s simply for record keeping and indexing, however this may change in the future.(HOWEVER_SENTENCE)
docs/bridge/docs/03-RFQ/20-Relaying/Exclusivity.md (1)
36-47: Consider enhancing the documentation with additional detailsThe current content provides a good overview of exclusivity, but could be enhanced with:
- Example scenarios showing how exclusivity works in practice
- Security considerations and potential edge cases
- Implementation details about how relayers can request exclusivity
Consider adding sections like:
### Example Scenario When a relayer is granted exclusivity: 1. Relayer A obtains exclusivity until timestamp T 2. Other relayers see the exclusivityRelayer and exclusivityEndTime 3. After timestamp T, if unfilled, any relayer can complete the relay ### Security Considerations - What happens if the exclusive relayer becomes unavailable - How to prevent abuse of the exclusivity mechanism ### Requesting Exclusivity (Add details about the API or contract calls for requesting exclusivity)docs/bridge/docs/03-RFQ/50-Canceling/index.md (3)
40-40: Add context about relay expiration deadlineThe document mentions "relay expiration deadline" but doesn't explain what it is or how it's determined. Consider adding a link to the relevant documentation or a brief explanation of this concept, as it's crucial for understanding when cancellations can occur.
🧰 Tools
🪛 LanguageTool
[style] ~40-~40: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ... can also execute the [cancel] function prior to the cancellation delay, but only after ...(EN_WORDINESS_PREMIUM_PRIOR_TO)
46-48: Add information about gas costsConsider adding a note about gas costs associated with cancellation. This information would help users make informed decisions about when to cancel a transaction.
50-50: Fix grammar in the closing sentenceAdd a comma before "and" in the compound sentence for better readability.
-No further action is possible with the bridge after a cancellation and it can be considered closed. +No further action is possible with the bridge after a cancellation, and it can be considered closed.🧰 Tools
🪛 LanguageTool
[uncategorized] ~50-~50: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ble with the bridge after a cancellation and it can be considered closed.(COMMA_COMPOUND_SENTENCE)
docs/bridge/docs/03-RFQ/15-Bridging/index.md (3)
5-35: Consider grouping reference links by category.The reference links section is well-structured and provides valuable pointers to contract interfaces and related documentation. To improve maintainability, consider grouping the references into categories with comments:
<!-- Reference Links --> +<!-- Contract Interfaces --> [relay]: ... [prove]: ... [dispute]: ... +<!-- Events --> [BridgeRequested]: ... [BridgeRelayed]: ... +<!-- Related Documentation --> [Quoter API]: ... [Quoting]: ... +<!-- Entity References --> [User]: ... [Quoter]: ...🧰 Tools
🪛 Markdownlint
6-6: Unused link or image reference definition: "relay"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
7-7: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
9-9: Unused link or image reference definition: "claim"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
13-13: Unused link or image reference definition: "bridgetransactionv2"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
30-30: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
33-33: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
37-69: Consider enhancing the documentation structure.While the content is comprehensive, consider these improvements for better clarity:
- Add a "Prerequisites" section before explaining the bridging process:
### Prerequisites - Obtained quote through [Quoting] - Sufficient funds and approvals for the bridge transaction - Understanding of the [User] and [Relayer] roles
- Add a "Transaction Flow" diagram to visualize the process:
### Transaction Flow 1. User initiates bridge transaction 2. Funds transferred to FastBridge contract 3. Relayer observes [BridgeRequested] event 4. Bridge completed through [Claiming] or [Canceling]
52-61: Consider adding security considerations section.The escrow mechanism is mentioned, but it would be valuable to add a dedicated "Security Considerations" section that covers:
- Risks and mitigations during the bridging process
- Timeout mechanisms
- Dispute resolution procedures
- Security best practices for integrators
This would help users better understand the security implications of the bridging process.
docs/bridge/docs/03-RFQ/40-Claiming/index.md (3)
36-39: Add dispute period duration detailsConsider adding information about the typical duration of the dispute period to help Relayers better understand when they can expect to claim their funds.
43-57: Enhance function documentation with examples and security notesConsider adding:
- Code examples showing how to use each function variant
- Security considerations for the permissionless claim function
- Gas efficiency comparison between the two options
66-68: Enhance the Next Steps sectionConsider adding:
- A flowchart or sequence diagram showing the complete bridge cycle
- Links to documentation about initiating a new relay
- Common scenarios or best practices for managing multiple relays
docs/bridge/docs/03-RFQ/90-Misc/index.md (2)
36-64: Improve heading structure and formatting.The content is technically accurate, but there are some formatting inconsistencies:
- Heading levels should increment by only one level at a time
- Remove trailing colons from headings
Apply these changes:
## FastBridge Contract Utilities -### Call from Origin Chain: +### Call from Origin Chain <blockquote> #### [canClaim](...) -##### [bridgeStatuses](...) +#### [bridgeStatuses](...) -##### [bridgeProofs](...) +#### [bridgeProofs](...) -### Call from Destination Chain: +### Call from Destination Chain <blockquote> -##### [bridgeRelays](...) +#### [bridgeRelays](...)🧰 Tools
🪛 Markdownlint
45-45: Expected: h4; Actual: h5
Heading levels should only increment by one level at a time(MD001, heading-increment)
39-39: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
58-58: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
65-67: Enhance the load tester documentation.Consider adding:
- Basic usage examples
- Configuration options
- Use relative branch references instead of hardcoding 'master'
Example enhancement:
## RFQ Load Tester -The [`rfq-loadtest`](https://github.com/synapsecns/sanguine/tree/master/packages/rfq-loadtest) tool can be used to rapidly send ETH bridges for the purpose of load testing. +The [`rfq-loadtest`](https://github.com/synapsecns/sanguine/tree/HEAD/packages/rfq-loadtest) tool can be used to rapidly send ETH bridges for the purpose of load testing. + +### Usage +```bash +# Basic usage example +rfq-loadtest --network <network> --count <number_of_bridges> +``` + +### Configuration +Key parameters: +- `network`: Target network for testing +- `count`: Number of bridge requests to send +- Additional options...docs/bridge/docs/03-RFQ/30-Proving/index.md (4)
36-41: Improve clarity of the process descriptionConsider restructuring the opening paragraph for better readability:
- After [Relaying] successfully and observing that the [relay] transaction has finalized on the destination chain, [prove] transactions are executed by authorized Provers (who are typically also the [Relayer]) + After successful [Relaying] and confirmation that the [relay] transaction has finalized on the destination chain, authorized Provers (typically also the [Relayer]) execute [prove] transactions.
64-68: Enhance the warning message with specific risksConsider expanding the warning to explain the potential consequences:
:::warning - prove should not be called until the Relayer is confident that the relay transaction is finalized and will not be reorganized. + prove should not be called until the Relayer is confident that the relay transaction is finalized and will not be reorganized. Calling prove too early could result in: + - Invalid proofs if the relay transaction is reorganized + - Potential loss of funds during the dispute period + - Unnecessary gas costs for reverting transactions :::
70-72: Add implementation examples for Multicall batchingThe Multicalling section would benefit from concrete examples showing how to batch prove transactions. Consider adding:
- A code example demonstrating the Multicall interface
- Common batching patterns
- Gas optimization tips
77-77: Fix typo in "transaction"- Following the [prove] transation, a [Dispute Period] begins - after which the [Relayer] may proceed to [Claiming] + Following the [prove] transaction, a [Dispute Period] begins - after which the [Relayer] may proceed to [Claiming]docs/bridge/docs/03-RFQ/60-Security/index.md (1)
6-17: Standardize contract documentation URLsThe contract documentation URLs show inconsistency in their patterns. Some use
IFastBridge.solwhile others useIFastBridgeV2.sol. Consider standardizing to V2 interfaces where applicable for better maintainability.🧰 Tools
🪛 Markdownlint
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
docs/bridge/docs/03-RFQ/10-Quoting/index.md (1)
51-51: Fix grammatical issue.Remove the comma before "if" for better readability.
-Active quoting is more complicated to implement and maintain, but allow for more granular & customized quotes that can improve efficiency among other benefits. Quoters who prefer a simpler approach are free to use nothing but Passive Quotes, if they choose. +Active quoting is more complicated to implement and maintain, but allow for more granular & customized quotes that can improve efficiency among other benefits. Quoters who prefer a simpler approach are free to use nothing but Passive Quotes if they choose.🧰 Tools
🪛 LanguageTool
[typographical] ~51-~51: Usually, there’s no comma before “if”.
Context: ...e free to use nothing but Passive Quotes, if they choose. ## :::info To learn mor...(IF_NO_COMMA)
docs/bridge/docs/03-RFQ/20-Relaying/riskFactors.md (1)
47-47: Fix grammatical issues for better readabilitySeveral grammatical issues need to be addressed:
- Line 47: "be come" should be "become"
- Line 69: Add "of" in "fulfillment of a bridge transaction"
- Line 51: Add comma after "quotes"
- Line 73: Add comma after "reimbursed"
-If a bridge transaction occurs that acts upon a quote issued by a particular [Relayer], and that [Relayer] fails to complete the [relay] transaction - the bridge deposit can be come "stuck" if there is no one to complete it. +If a bridge transaction occurs that acts upon a quote issued by a particular [Relayer], and that [Relayer] fails to complete the [relay] transaction - the bridge deposit can become "stuck" if there is no one to complete it. -If a [relay] occurs for an incorrect output amount (or any other incorrect [BridgeTransactionV2] data) and is submitted via [prove] as the fulfillment a bridge transaction, the [proof] will be disputed by a [Guard]. +If a [relay] occurs for an incorrect output amount (or any other incorrect [BridgeTransactionV2] data) and is submitted via [prove] as the fulfillment of a bridge transaction, the [proof] will be disputed by a [Guard]. -All participating Relayers must ensure they are able to complete all bridge transactions that act upon their quotes and will be asked to quickly rectify any shortfalls. +All participating Relayers must ensure they are able to complete all bridge transactions that act upon their quotes, and will be asked to quickly rectify any shortfalls. -The incorrect [relay] in this example cannot be reversed or reimbursed and would effectively be a loss of funds for the [Relayer] who performed it. +The incorrect [relay] in this example cannot be reversed or reimbursed, and would effectively be a loss of funds for the [Relayer] who performed it.Also applies to: 69-69, 51-51, 73-73
🧰 Tools
🪛 LanguageTool
[grammar] ~47-~47: Did you mean “become”?
Context: ...y] transaction - the bridge deposit can be come "stuck" if there is no one to complete ...(BE_COME)
docs/bridge/docs/03-RFQ/20-Relaying/index.md (6)
40-48: Enhance clarity of authorization requirementsThe info block should specify what "explicit authorization" entails. Consider adding:
- Required permissions or roles
- Steps to obtain authorization
- Any prerequisites for becoming a Relayer
52-55: Add technical details for bridge request detectionConsider enhancing this section with:
- Example of the BridgeTransactionV2 struct format
- Sample event data structure
- Code snippet showing how to listen for these events
58-66: Add code examples for relay executionTo improve clarity, consider adding:
- Code snippet for native currency relay
- Code snippet for ERC20 token relay
- Example of checking for sufficient approvals
🧰 Tools
🪛 LanguageTool
[style] ~62-~62: ‘Prior to’ might be wordy. Consider a shorter alternative.
Context: ...stination asset to deliver is an ERC20. Prior to calling [relay], the [Relayer] must hav...(EN_WORDINESS_PREMIUM_PRIOR_TO)
71-83: Use markdown formatting instead of HTMLReplace HTML styling with markdown list formatting:
-<div style={{ marginLeft: '20px' }}> -1) +1. First overload:
98-98: Fix heading hierarchyChange the heading level to maintain proper document structure:
-### Permissions +## Permissions🧰 Tools
🪛 Markdownlint
98-98: Expected: h2; Actual: h3
Heading levels should only increment by one level at a time(MD001, heading-increment)
106-110: Expand the next steps sectionConsider adding:
- Timeline expectations for the proving process
- Links to related proving documentation
- Common issues to watch out for
docs/bridge/docs/03-RFQ/10-Quoting/Quoter API/index.md (7)
6-36: Clean up unused reference linksMany of the reference links defined at the top of the document are not being used in the content. Consider removing unused references to improve maintainability, or document where these references will be used in future content.
🧰 Tools
🪛 Markdownlint
7-7: Unused link or image reference definition: "relay"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
9-9: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "claim"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
13-13: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgetransactionv2"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
18-18: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
28-28: Unused link or image reference definition: "security"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
30-30: Unused link or image reference definition: "user"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
33-33: Unused link or image reference definition: "relayer"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
35-35: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
142-142: Fix grammatical errorAdd the missing preposition "to" in the sentence.
-Likewise, it will be their responsibility review the versions.go file, +Likewise, it will be their responsibility to review the versions.go file,🧰 Tools
🪛 LanguageTool
[uncategorized] ~142-~142: Possible missing preposition found.
Context: ...kewise, it will be their responsibility review the versions.go file, to research & und...(AI_HYDRA_LEO_MISSING_TO)
99-129: Add language specifiers to code blocksAdd language specifiers to the code blocks to enable proper syntax highlighting:
- ``` + ```json { op: string, content: json, success: bool, }
{ data: { origin_chain_id: number, dest_chain_id: number, origin_token_addr: string, dest_token_addr: string, origin_amount_exact: string, expiration_window: number }, }
{ request_id: string, dest_amount: string, }<details> <summary>🧰 Tools</summary> <details> <summary>🪛 Markdownlint</summary> 99-99: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 109-109: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 124-124: null Fenced code blocks should have a language specified (MD040, fenced-code-language) </details> </details> --- `172-173`: **Fix list formatting** The API URLs should be properly formatted as a list without indentation: ```diff - - Mainnet: `api.synapseprotocol.com` - - Testnet: `rfq-api-testnet.omnirpc.io` + - Mainnet: `api.synapseprotocol.com` + - Testnet: `rfq-api-testnet.omnirpc.io`🧰 Tools
🪛 Markdownlint
172-172: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
173-173: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
177-177: Remove duplicate wordRemove the duplicate "the" in the sentence.
-Users and relayers **are not** expected to run their own version of the Quoter API. Rather, they are expected to use a Quoter API that is hosted by the the interface they are quoting for. +Users and relayers **are not** expected to run their own version of the Quoter API. Rather, they are expected to use a Quoter API that is hosted by the interface they are quoting for.🧰 Tools
🪛 LanguageTool
[duplication] ~177-~177: Possible typo: you repeated a word
Context: ...d to use a Quoter API that is hosted by the the interface they are quoting for. For exa...(ENGLISH_WORD_REPEAT_RULE)
199-199: Add missing commaAdd a comma after the conditional clause for better readability.
- - `dsn` - the dsn of your database. If using sqlite, this can be a path, if using mysql please see [here](https://dev.mysql.com/doc/connector-odbc/en/connector-odbc-configuration.html) for more information. + - `dsn` - the dsn of your database. If using sqlite, this can be a path, if using mysql, please see [here](https://dev.mysql.com/doc/connector-odbc/en/connector-odbc-configuration.html) for more information.🧰 Tools
🪛 LanguageTool
[typographical] ~199-~199: It seems that a comma is missing.
Context: ...lite, this can be a path, if using mysql please see [here](https://dev.mysql.com/doc/co...(IF_PLEASE_COMMA)
56-80: Use proper heading structure instead of bold textReplace bold text with proper markdown headings for better document structure and navigation:
-**Endpoints for Quoters** +#### Endpoints for Quoters -**Endpoints for Integrators / Users** +#### Endpoints for Integrators / Users -**Endpoints for Quoters** +#### Endpoints for Quoters -**Endpoints for Integrators / Users** +#### Endpoints for Integrators / Users🧰 Tools
🪛 Markdownlint
56-56: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
63-63: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
75-75: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
80-80: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
docs/bridge/docs/03-RFQ/index.md (5)
7-37: Consider organizing reference linksConsider grouping the reference links into categories (e.g., contract interfaces, events, documentation) and removing any that are truly unused. This will improve maintainability of the documentation.
🧰 Tools
🪛 Markdownlint
13-13: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgetransactionv2"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
18-18: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
28-28: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
29-29: Unused link or image reference definition: "security"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
35-35: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
36-36: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
40-40: Enhance clarity in the intent descriptionConsider rephrasing "typically in very simple terms" to "in straightforward terms" or "in basic terms" for more precise language.
🧰 Tools
🪛 LanguageTool
[style] ~40-~40: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ... Synapse RFQ (Request-For-Quote) is an <abbr title="'Intent' refers to a user authorizing specific actions that they want to achieve, typically in very simple terms, such as a bridge or swap. Actual...(EN_WEAK_ADJECTIVE)
124-124: Remove redundant word "currently"Remove the duplicate word "currently" in these lines:
- Currently, Synapse itself is currently the sole Guard operator of the Synapse RFQ system. + Currently, Synapse itself is the sole Guard operator of the Synapse RFQ system.- Currently, Synapse itself is currently the sole Canceler operator of the Synapse RFQ system. + Currently, Synapse itself is the sole Canceler operator of the Synapse RFQ system.Also applies to: 131-131
145-145: Improve sentence concisenessConsider revising:
-[Synapse FastBridge contracts](/docs/Contracts/RFQ) facilitate and enforce all of the on-chain functionality and security of the system. +[Synapse FastBridge contracts](/docs/Contracts/RFQ) facilitate and enforce all on-chain functionality and security of the system.🧰 Tools
🪛 LanguageTool
[style] ~145-~145: Consider removing “of” to be more concise
Context: ...s/Contracts/RFQ) facilitate and enforce all of the on-chain functionality and security of ...(ALL_OF_THE)
156-158: Fix heading hierarchy and formatting
- Fix heading levels to maintain proper hierarchy:
-## Flow Summary - -#### [Quoting] +## Flow Summary + +### [Quoting]
- Remove extra space after the hash in headings
🧰 Tools
🪛 Markdownlint
158-158: Expected: h3; Actual: h4
Heading levels should only increment by one level at a time(MD001, heading-increment)
156-156: null
Multiple spaces after hash on atx style heading(MD019, no-multiple-space-atx)
docs/bridge/docs/03-RFQ/70-CanonicalRelayer/index.md (5)
5-35: Consider cleaning up unused reference linksSeveral reference links appear to be unused in the current document. Consider either:
- Removing unused references to maintain cleaner documentation
- Adding the missing references in the content where appropriate
- Moving commonly used references to a shared markdown file if they're used across multiple documents
🧰 Tools
🪛 Markdownlint
6-6: Unused link or image reference definition: "relay"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
7-7: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
9-9: Unused link or image reference definition: "claim"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
13-13: Unused link or image reference definition: "bridgetransactionv2"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
29-29: Unused link or image reference definition: "user"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
30-30: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "relayer"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
33-33: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
74-90: Improve state transition documentationThe state transition table would benefit from additional clarity:
- Add transition conditions between states
- Include error states and recovery paths
- Document timeout conditions if any
Consider adding a state transition diagram using Mermaid markdown:
+```mermaid +stateDiagram-v2 + Seen --> WillNotProcess: Invalid event + Seen --> NotEnoughInventory: Insufficient balance + Seen --> CommittedPending: All checks pass + CommittedPending --> CommittedConfirmed: Transaction finalized + CommittedConfirmed --> RelayPending: Conditions met + RelayPending --> RelayComplete: Transaction success + RelayPending --> RelayRaceLost: Another relayer completed + RelayComplete --> ProvePosting: Proof submission + ProvePosting --> ProvePosted: Proof accepted + ProvePosted --> ClaimPending: Dispute period passed + ClaimPending --> ClaimComplete: Claim successful +```
Line range hint
92-130: Add validation checks to rebalancing logicThe rebalancing documentation should include:
- Safety checks and circuit breakers
- Maximum rebalance frequency
- Gas price considerations
- Error handling and recovery procedures
Consider adding a section about monitoring and alerting for rebalancing operations to detect and respond to unusual patterns or failed rebalances.
Line range hint
320-324: Clarify chainGasAmount documentationThe
sendChainGasdocumentation needs more context:
- Explain the purpose and benefits of using
chainGasAmount- Document the implications of setting it to non-zero values
- Add examples of when to use this feature
Add a code example showing the contract interaction:
+Example usage: +```solidity +// Example of initiating a bridge with chainGas +function bridgeWithChainGas( + uint256 amount, + uint256 chainGasAmount +) external { + fastBridgeV2.bridge( + amount, + true, // sendChainGas + chainGasAmount + ); +} +```
Line range hint
132-317: Enhance configuration documentation with validation rulesThe configuration section would benefit from:
- Input validation rules for each parameter
- Default values where applicable
- Dependencies between parameters
- Security considerations for sensitive values
Consider adding a configuration validation script example:
+### Configuration Validation + +Use the following script to validate your configuration: + +```bash +#!/bin/bash +# Validate configuration file +go run main.go validate-config --config /path/to/config.yaml +```
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (15)
docs/bridge/docs/03-RFQ/10-Quoting/Quoter API/index.md(1 hunks)docs/bridge/docs/03-RFQ/10-Quoting/index.md(1 hunks)docs/bridge/docs/03-RFQ/15-Bridging/index.md(1 hunks)docs/bridge/docs/03-RFQ/15-Bridging/quoteId.md(1 hunks)docs/bridge/docs/03-RFQ/15-Bridging/zaps.md(1 hunks)docs/bridge/docs/03-RFQ/20-Relaying/Exclusivity.md(1 hunks)docs/bridge/docs/03-RFQ/20-Relaying/index.md(1 hunks)docs/bridge/docs/03-RFQ/20-Relaying/riskFactors.md(1 hunks)docs/bridge/docs/03-RFQ/30-Proving/index.md(1 hunks)docs/bridge/docs/03-RFQ/40-Claiming/index.md(1 hunks)docs/bridge/docs/03-RFQ/50-Canceling/index.md(1 hunks)docs/bridge/docs/03-RFQ/60-Security/index.md(1 hunks)docs/bridge/docs/03-RFQ/70-CanonicalRelayer/index.md(4 hunks)docs/bridge/docs/03-RFQ/90-Misc/index.md(1 hunks)docs/bridge/docs/03-RFQ/index.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/bridge/docs/03-RFQ/10-Quoting/Quoter API/index.md
[uncategorized] ~142-~142: Possible missing preposition found.
Context: ...kewise, it will be their responsibility review the versions.go file, to research & und...
(AI_HYDRA_LEO_MISSING_TO)
[duplication] ~177-~177: Possible typo: you repeated a word
Context: ...d to use a Quoter API that is hosted by the the interface they are quoting for. For exa...
(ENGLISH_WORD_REPEAT_RULE)
[typographical] ~199-~199: It seems that a comma is missing.
Context: ...lite, this can be a path, if using mysql please see [here](https://dev.mysql.com/doc/co...
(IF_PLEASE_COMMA)
[style] ~214-~214: Consider a more expressive alternative.
Context: ...ter API can also be run with docker. To do this, you will need to build the docker...
(DO_ACHIEVE)
docs/bridge/docs/03-RFQ/10-Quoting/index.md
[typographical] ~51-~51: Usually, there’s no comma before “if”.
Context: ...e free to use nothing but Passive Quotes, if they choose. ## :::info To learn mor...
(IF_NO_COMMA)
docs/bridge/docs/03-RFQ/15-Bridging/quoteId.md
[typographical] ~40-~40: The word “however” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence.
Context: ...s simply for record keeping and indexing, however this may change in the future.
(HOWEVER_SENTENCE)
docs/bridge/docs/03-RFQ/20-Relaying/index.md
[style] ~62-~62: ‘Prior to’ might be wordy. Consider a shorter alternative.
Context: ...stination asset to deliver is an ERC20. Prior to calling [relay], the [Relayer] must hav...
(EN_WORDINESS_PREMIUM_PRIOR_TO)
docs/bridge/docs/03-RFQ/20-Relaying/riskFactors.md
[grammar] ~47-~47: Did you mean “become”?
Context: ...y] transaction - the bridge deposit can be come "stuck" if there is no one to complete ...
(BE_COME)
[grammar] ~49-~49: Do not use an adverb of manner between a verb and its direct object.
Context: ...ds are safe in these instances and will eventually either be cancelled & refunded or compl...
(MD_RB_DT)
[style] ~51-~51: As a shorter alternative for ‘able to’, consider using “can”.
Context: ...participating Relayers must ensure they are able to complete all bridge transactions that a...
(BE_ABLE_TO)
[uncategorized] ~51-~51: Possible missing comma found.
Context: ...bridge transactions that act upon their quotes and will be asked to quickly rectify an...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~69-~69: Possible missing preposition found.
Context: ...ubmitted via [prove] as the fulfillment a bridge transaction, the [proof] will be...
(AI_HYDRA_LEO_MISSING_OF)
[uncategorized] ~73-~73: Possible missing comma found.
Context: ...] in this example cannot be reversed or reimbursed and would effectively be a loss of fund...
(AI_HYDRA_LEO_MISSING_COMMA)
docs/bridge/docs/03-RFQ/30-Proving/index.md
[grammar] ~44-~44: The word ‘prove’ is a verb. Did you mean the noun “proof”?
Context: ...here are two overloaded versions of the prove function in FastBridgeV2. Relayers can ...
(PREPOSITION_VERB)
docs/bridge/docs/03-RFQ/50-Canceling/index.md
[style] ~40-~40: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ... can also execute the [cancel] function prior to the cancellation delay, but only after ...
(EN_WORDINESS_PREMIUM_PRIOR_TO)
[uncategorized] ~50-~50: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ble with the bridge after a cancellation and it can be considered closed.
(COMMA_COMPOUND_SENTENCE)
docs/bridge/docs/03-RFQ/60-Security/index.md
[grammar] ~51-~51: The word ‘prove’ is a verb. Did you mean the noun “proof”?
Context: ..._period) begins. During this time, the prove/proof is eligible to be [disputed](disp...
(PREPOSITION_VERB)
[uncategorized] ~73-~73: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short).
Context: ... a new corrected [prove] to be submitted and the process begins again. If a [relay]...
(COMMA_COMPOUND_SENTENCE_2)
docs/bridge/docs/03-RFQ/index.md
[style] ~40-~40: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ... Synapse RFQ (Request-For-Quote) is an <abbr title="'Intent' refers to a user authorizing specific actions that they want to achieve, typically in very simple terms, such as a bridge or swap. Actual...
(EN_WEAK_ADJECTIVE)
[style] ~145-~145: Consider removing “of” to be more concise
Context: ...s/Contracts/RFQ) facilitate and enforce all of the on-chain functionality and security of ...
(ALL_OF_THE)
🪛 Markdownlint
docs/bridge/docs/03-RFQ/10-Quoting/Quoter API/index.md
172-172: Expected: 0; Actual: 1
Unordered list indentation
(MD007, ul-indent)
173-173: Expected: 0; Actual: 1
Unordered list indentation
(MD007, ul-indent)
175-175: Punctuation: ':'
Trailing punctuation in heading
(MD026, no-trailing-punctuation)
56-56: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
63-63: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
75-75: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
80-80: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
212-212: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
99-99: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
109-109: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
124-124: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
7-7: Unused link or image reference definition: "relay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
9-9: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "claim"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
13-13: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgetransactionv2"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
18-18: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
28-28: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
30-30: Unused link or image reference definition: "user"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
33-33: Unused link or image reference definition: "relayer"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
35-35: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
docs/bridge/docs/03-RFQ/10-Quoting/index.md
6-6: Unused link or image reference definition: "relay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
7-7: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
9-9: Unused link or image reference definition: "claim"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
13-13: Unused link or image reference definition: "bridgetransactionv2"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "relaying"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "relayer"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
33-33: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
docs/bridge/docs/03-RFQ/15-Bridging/index.md
6-6: Unused link or image reference definition: "relay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
7-7: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
9-9: Unused link or image reference definition: "claim"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
13-13: Unused link or image reference definition: "bridgetransactionv2"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
30-30: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
33-33: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
docs/bridge/docs/03-RFQ/15-Bridging/quoteId.md
6-6: Unused link or image reference definition: "relay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
7-7: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
9-9: Unused link or image reference definition: "claim"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
13-13: Unused link or image reference definition: "bridgetransactionv2"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "relaying"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
29-29: Unused link or image reference definition: "user"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
30-30: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "relayer"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
33-33: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
docs/bridge/docs/03-RFQ/15-Bridging/zaps.md
6-6: Unused link or image reference definition: "relay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
7-7: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
9-9: Unused link or image reference definition: "claim"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
13-13: Unused link or image reference definition: "bridgetransactionv2"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "relaying"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
29-29: Unused link or image reference definition: "user"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
30-30: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "relayer"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
33-33: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
docs/bridge/docs/03-RFQ/20-Relaying/Exclusivity.md
7-7: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
9-9: Unused link or image reference definition: "claim"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "relaying"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
29-29: Unused link or image reference definition: "user"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
30-30: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
33-33: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
docs/bridge/docs/03-RFQ/20-Relaying/index.md
98-98: Expected: h2; Actual: h3
Heading levels should only increment by one level at a time
(MD001, heading-increment)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "relaying"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
33-33: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
docs/bridge/docs/03-RFQ/20-Relaying/riskFactors.md
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "relaying"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
30-30: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
docs/bridge/docs/03-RFQ/30-Proving/index.md
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
13-13: Unused link or image reference definition: "bridgetransactionv2"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
29-29: Unused link or image reference definition: "user"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
30-30: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
33-33: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
docs/bridge/docs/03-RFQ/40-Claiming/index.md
7-7: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
13-13: Unused link or image reference definition: "bridgetransactionv2"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "relaying"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
29-29: Unused link or image reference definition: "user"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
30-30: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
33-33: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
docs/bridge/docs/03-RFQ/50-Canceling/index.md
6-6: Unused link or image reference definition: "relay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
7-7: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
9-9: Unused link or image reference definition: "claim"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
13-13: Unused link or image reference definition: "bridgetransactionv2"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "relaying"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
30-30: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "relayer"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
33-33: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
docs/bridge/docs/03-RFQ/60-Security/index.md
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "relaying"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
29-29: Unused link or image reference definition: "user"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
30-30: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
docs/bridge/docs/03-RFQ/70-CanonicalRelayer/index.md
6-6: Unused link or image reference definition: "relay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
7-7: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
9-9: Unused link or image reference definition: "claim"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
13-13: Unused link or image reference definition: "bridgetransactionv2"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
29-29: Unused link or image reference definition: "user"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
30-30: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "relayer"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
33-33: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
docs/bridge/docs/03-RFQ/90-Misc/index.md
45-45: Expected: h4; Actual: h5
Heading levels should only increment by one level at a time
(MD001, heading-increment)
39-39: Punctuation: ':'
Trailing punctuation in heading
(MD026, no-trailing-punctuation)
58-58: Punctuation: ':'
Trailing punctuation in heading
(MD026, no-trailing-punctuation)
6-6: Unused link or image reference definition: "relay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
7-7: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
9-9: Unused link or image reference definition: "claim"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "relaying"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
29-29: Unused link or image reference definition: "user"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
30-30: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "relayer"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
33-33: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
docs/bridge/docs/03-RFQ/index.md
158-158: Expected: h3; Actual: h4
Heading levels should only increment by one level at a time
(MD001, heading-increment)
156-156: null
Multiple spaces after hash on atx style heading
(MD019, no-multiple-space-atx)
13-13: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgetransactionv2"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
18-18: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
28-28: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
29-29: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
35-35: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
36-36: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
🔇 Additional comments (18)
docs/bridge/docs/03-RFQ/15-Bridging/zaps.md (1)
6-17: Review deployment URLs for contract documentation
The contract interface links are pointing to a Vercel deployment (vercel-rfq-docs.vercel.app). Consider:
- Moving these to a more permanent documentation hosting solution
- Ensuring versioning is properly handled
- Adding version numbers to the documentation URLs
🧰 Tools
🪛 Markdownlint
6-6: Unused link or image reference definition: "relay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
7-7: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
9-9: Unused link or image reference definition: "claim"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
13-13: Unused link or image reference definition: "bridgetransactionv2"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
docs/bridge/docs/03-RFQ/15-Bridging/quoteId.md (2)
1-3: LGTM!
The frontmatter is properly formatted and contains an appropriate title.
36-38: LGTM!
The explanation of the quoteId parameter and its purpose is clear and concise.
docs/bridge/docs/03-RFQ/20-Relaying/Exclusivity.md (2)
1-3: LGTM! Document metadata is well-structured.
5-35: Clean up unused reference links
While having comprehensive references is good, many of them are currently unused in the document. Consider removing unused references or adding relevant content that utilizes them to improve maintainability.
Let's verify which references are actually used in the content:
🧰 Tools
🪛 Markdownlint
7-7: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
9-9: Unused link or image reference definition: "claim"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "relaying"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
29-29: Unused link or image reference definition: "user"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
30-30: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
33-33: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
docs/bridge/docs/03-RFQ/50-Canceling/index.md (1)
1-50: Documentation is comprehensive and well-structured
The documentation effectively explains the cancellation process, its security implications, and outcomes. The content is clear, well-organized, and maintains consistency with the broader documentation structure.
🧰 Tools
🪛 LanguageTool
[style] ~40-~40: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ... can also execute the [cancel] function prior to the cancellation delay, but only after ...
(EN_WORDINESS_PREMIUM_PRIOR_TO)
[uncategorized] ~50-~50: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ble with the bridge after a cancellation and it can be considered closed.
(COMMA_COMPOUND_SENTENCE)
🪛 Markdownlint
6-6: Unused link or image reference definition: "relay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
7-7: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
9-9: Unused link or image reference definition: "claim"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
13-13: Unused link or image reference definition: "bridgetransactionv2"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "relaying"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
30-30: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "relayer"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
33-33: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
docs/bridge/docs/03-RFQ/15-Bridging/index.md (1)
1-3: LGTM!
The frontmatter is properly formatted and the title accurately reflects the document's content.
docs/bridge/docs/03-RFQ/90-Misc/index.md (2)
1-3: LGTM! Document metadata is properly structured.
5-35: Verify the usage of reference links across documentation.
The reference links are well-organized, but let's verify their usage across the documentation to ensure they're not orphaned.
✅ Verification successful
All reference links are actively used across the documentation
Based on the verification results, all reference links defined in the file are being actively used throughout the documentation. Each link is referenced in multiple markdown files across different sections of the documentation, showing proper cross-referencing and interconnected documentation structure.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Check if the reference links are used in other documentation files
# Get all markdown files in the docs directory
echo "Searching for reference link usage in documentation files..."
for link in relay prove dispute claim cancel proof bridgerelayed bridgeproofprovided "cancel delay" multicall "quoter api" quoting bridging relaying proving claiming canceling security user quoter prover relayer guard canceler; do
echo "Checking usage of [$link]..."
rg -l "\[$link\]" docs/
done
Length of output: 12193
Script:
#!/bin/bash
# Let's check for the remaining reference links that weren't found in the first search
echo "Checking for BridgeRequested link usage..."
rg -l "\[BridgeRequested\]" docs/
echo "Checking for BridgeTransactionV2 link usage..."
rg -l "\[BridgeTransactionV2\]" docs/
echo "Checking for BridgeRelayed link usage..."
rg -l "\[BridgeRelayed\]" docs/
echo "Checking for BridgeProofProvided link usage..."
rg -l "\[BridgeProofProvided\]" docs/
echo "Checking for Cancel Delay link usage..."
rg -l "\[Cancel Delay\]" docs/
echo "Checking for Multicall link usage..."
rg -l "\[Multicall\]" docs/
echo "Checking for Quoter API link usage..."
rg -l "\[Quoter API\]" docs/
echo "Checking for Dispute Period link usage..."
rg -l "\[Dispute Period\]" docs/
Length of output: 6532
🧰 Tools
🪛 Markdownlint
6-6: Unused link or image reference definition: "relay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
7-7: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
9-9: Unused link or image reference definition: "claim"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "relaying"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
29-29: Unused link or image reference definition: "user"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
30-30: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "relayer"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
33-33: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
docs/bridge/docs/03-RFQ/60-Security/index.md (3)
40-44: Previous comment about terminology consistency remains valid
See previous review comment about clarifying terminology around "prove" transactions.
47-54: Previous comments about dispute period timing remain valid
See previous review comment about adding critical timing information to the dispute period section.
Additionally, fix the grammar in "the prove/proof is eligible" to use consistent terminology.
🧰 Tools
🪛 LanguageTool
[grammar] ~51-~51: The word ‘prove’ is a verb. Did you mean the noun “proof”?
Context: ..._period) begins. During this time, the prove/proof is eligible to be [disputed](disp...
(PREPOSITION_VERB)
56-67: Previous comments about Guard implementation details remain valid
See previous review comment about expanding Guards section with implementation details.
Additionally, consider adding information about how Guards verify transaction finality across different chains, as this is crucial for cross-chain security.
docs/bridge/docs/03-RFQ/10-Quoting/index.md (3)
1-3: LGTM!
The document metadata is correctly formatted and the title appropriately reflects the content.
37-66: LGTM! Clear and comprehensive explanation of quoting methods.
The content effectively explains both Passive and Active quoting methods, their differences, and implementation considerations. The guidance for quoters regarding quote maintenance and fulfillment responsibilities is particularly valuable.
🧰 Tools
🪛 LanguageTool
[typographical] ~51-~51: Usually, there’s no comma before “if”.
Context: ...e free to use nothing but Passive Quotes, if they choose. ## :::info To learn mor...
(IF_NO_COMMA)
5-35: Verify the usage of reference links across documentation.
While many reference links are flagged as unused in this file, they might be utilized in other documentation files. Let's verify their usage to maintain documentation cleanliness.
✅ Verification successful
Reference links are actively used across documentation
Based on the verification results, all reference links defined in the file are actively used throughout the documentation:
- Contract interface links (relay, prove, dispute, etc.) are used extensively to reference specific functions and events
- Internal documentation links (Quoting, Bridging, etc.) are used for cross-referencing between sections
- Entity references (User, Quoter, Prover, etc.) are used consistently to refer to system participants
The reference links section serves as a centralized definition point that enables consistent linking across the entire documentation.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Check for the usage of reference links across all markdown files
# Get all reference link identifiers
echo "Checking reference link usage..."
for link in relay prove dispute claim cancel proof bridgerequested bridgetransactionv2 bridgerelayed bridgeproofprovided "cancel delay" multicall "dispute period" quoting relaying proving claiming canceling security prover relayer guard canceler; do
echo "Checking usage of [$link]..."
rg -l "\[$link\](?!\:)" docs/
done
Length of output: 13759
Script:
#!/bin/bash
# Description: Check for the usage of reference links across all markdown files using simpler regex patterns
# Get all reference link identifiers and check their usage
echo "Checking reference link usage..."
for link in relay prove dispute claim cancel proof bridgerequested bridgetransactionv2 bridgerelayed bridgeproofprovided "cancel delay" multicall "dispute period" quoting relaying proving claiming canceling security prover relayer guard canceler; do
echo "=== Checking usage of [$link] ==="
# Using a simpler pattern that matches markdown links
rg -l "\[$link\][^:]" docs/
done
# Also check for the actual link definitions to compare
echo -e "\nChecking link definitions..."
rg "^\[.*\]:" docs/
Length of output: 58441
Script:
#!/bin/bash
# Description: Search for actual usage of reference links in markdown content
echo "Checking for actual link references in markdown content..."
# Search for some key reference links in actual markdown content
for link in relay prove dispute claim cancel proof bridgerequested bridgetransactionv2 bridgerelayed bridgeproofprovided; do
echo "=== Checking usage of [$link] in content ==="
rg "\[${link}\](?!:)" docs/ -B 2 -A 2
done
# Search for internal documentation links usage
echo -e "\n=== Checking usage of internal documentation links ==="
for link in "Quoter API" "Dispute Period" Quoting Bridging Relaying Proving Claiming Canceling Security; do
echo "=== Checking usage of [$link] in content ==="
rg "\[${link}\](?!:)" docs/ -B 2 -A 2
done
# Search for entity references
echo -e "\n=== Checking usage of entity references ==="
for entity in User Quoter Prover Relayer Guard Canceler; do
echo "=== Checking usage of [$entity] in content ==="
rg "\[${entity}\](?!:)" docs/ -B 2 -A 2
done
Length of output: 12431
Script:
#!/bin/bash
# Description: Search for actual usage of reference links in markdown content using simpler patterns
echo "Checking for actual link references in markdown content..."
# Search for some key reference links in actual markdown content
for link in relay prove dispute claim cancel proof bridgerequested bridgetransactionv2 bridgerelayed bridgeproofprovided; do
echo "=== Checking usage of [$link] ==="
# Using a simpler pattern without look-ahead
rg "\[${link}\]" docs/ --type md -B 2 -A 2 | grep -v "^\[${link}\]:"
done
# Search for internal documentation links usage
echo -e "\n=== Checking usage of internal documentation links ==="
for link in "Quoter API" "Dispute Period" Quoting Bridging Relaying Proving Claiming Canceling Security; do
echo "=== Checking usage of [$link] ==="
rg "\[${link}\]" docs/ --type md -B 2 -A 2 | grep -v "^\[${link}\]:"
done
# Search for entity references
echo -e "\n=== Checking usage of entity references ==="
for entity in User Quoter Prover Relayer Guard Canceler; do
echo "=== Checking usage of [$entity] ==="
rg "\[${entity}\]" docs/ --type md -B 2 -A 2 | grep -v "^\[${entity}\]:"
done
Length of output: 249303
🧰 Tools
🪛 Markdownlint
6-6: Unused link or image reference definition: "relay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
7-7: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
9-9: Unused link or image reference definition: "claim"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
13-13: Unused link or image reference definition: "bridgetransactionv2"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "relaying"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "relayer"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
33-33: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
docs/bridge/docs/03-RFQ/20-Relaying/riskFactors.md (2)
5-35: Add missing reference link for RFQ Indexer
The document references [RFQ Indexer] multiple times (lines 55, 65, 89) but the reference link is not defined in the reference links section.
🧰 Tools
🪛 Markdownlint
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "relaying"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
30-30: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
37-90: Well-structured and comprehensive risk documentation
The document effectively outlines and explains the key risk factors for Relayers. The content is logically organized with clear sections, each providing detailed explanations and practical implications. The warning section appropriately sets expectations about Relayer responsibilities.
🧰 Tools
🪛 LanguageTool
[grammar] ~47-~47: Did you mean “become”?
Context: ...y] transaction - the bridge deposit can be come "stuck" if there is no one to complete ...
(BE_COME)
[grammar] ~49-~49: Do not use an adverb of manner between a verb and its direct object.
Context: ...ds are safe in these instances and will eventually either be cancelled & refunded or compl...
(MD_RB_DT)
[style] ~51-~51: As a shorter alternative for ‘able to’, consider using “can”.
Context: ...participating Relayers must ensure they are able to complete all bridge transactions that a...
(BE_ABLE_TO)
[uncategorized] ~51-~51: Possible missing comma found.
Context: ...bridge transactions that act upon their quotes and will be asked to quickly rectify an...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~69-~69: Possible missing preposition found.
Context: ...ubmitted via [prove] as the fulfillment a bridge transaction, the [proof] will be...
(AI_HYDRA_LEO_MISSING_OF)
[uncategorized] ~73-~73: Possible missing comma found.
Context: ...] in this example cannot be reversed or reimbursed and would effectively be a loss of fund...
(AI_HYDRA_LEO_MISSING_COMMA)
docs/bridge/docs/03-RFQ/10-Quoting/Quoter API/index.md (1)
1-220: Documentation is comprehensive and well-structured
The documentation provides thorough coverage of the Quoter API, including all necessary details for integration, authentication, and configuration. The technical content is accurate and valuable for the target audience.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~142-~142: Possible missing preposition found.
Context: ...kewise, it will be their responsibility review the versions.go file, to research & und...
(AI_HYDRA_LEO_MISSING_TO)
[duplication] ~177-~177: Possible typo: you repeated a word
Context: ...d to use a Quoter API that is hosted by the the interface they are quoting for. For exa...
(ENGLISH_WORD_REPEAT_RULE)
[typographical] ~199-~199: It seems that a comma is missing.
Context: ...lite, this can be a path, if using mysql please see [here](https://dev.mysql.com/doc/co...
(IF_PLEASE_COMMA)
[style] ~214-~214: Consider a more expressive alternative.
Context: ...ter API can also be run with docker. To do this, you will need to build the docker...
(DO_ACHIEVE)
🪛 Markdownlint
172-172: Expected: 0; Actual: 1
Unordered list indentation
(MD007, ul-indent)
173-173: Expected: 0; Actual: 1
Unordered list indentation
(MD007, ul-indent)
175-175: Punctuation: ':'
Trailing punctuation in heading
(MD026, no-trailing-punctuation)
56-56: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
63-63: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
75-75: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
80-80: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
212-212: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
99-99: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
109-109: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
124-124: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
7-7: Unused link or image reference definition: "relay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
9-9: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "claim"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
13-13: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgetransactionv2"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
18-18: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
28-28: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
30-30: Unused link or image reference definition: "user"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
33-33: Unused link or image reference definition: "relayer"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
35-35: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
| --- | ||
| title: Zaps | ||
| --- | ||
|
|
||
| <!-- Reference Links --> | ||
| [relay]: https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridgeV2.sol/interface.IFastBridgeV2.html#relay | ||
| [prove]: https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridgeV2.sol/interface.IFastBridgeV2.html#prove | ||
| [dispute]: https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridge.sol/interface.IFastBridge.html#dispute | ||
| [claim]: https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridgeV2.sol/interface.IFastBridgeV2.html#claim | ||
| [cancel]: https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridgeV2.sol/interface.IFastBridgeV2.html#cancel | ||
| [proof]: https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridgeV2.sol/interface.IFastBridgeV2.html#bridgetxdetails | ||
| [BridgeRequested]: https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridge.sol/interface.IFastBridge.html#bridgerequested | ||
| [BridgeTransactionV2]: https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridgeV2.sol/interface.IFastBridgeV2.html#bridgetransactionv2 | ||
| [BridgeRelayed]: https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridge.sol/interface.IFastBridge.html#bridgerelayed | ||
| [BridgeProofProvided]: https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridge.sol/interface.IFastBridge.html#bridgeproofprovided | ||
| [Cancel Delay]: https://vercel-rfq-docs.vercel.app/contracts/FastBridgeV2.sol/contract.FastBridgeV2.html#refund_delay | ||
| [Multicall]: https://vercel-rfq-docs.vercel.app/contracts/interfaces/IMulticallTarget.sol/interface.IMulticallTarget.html | ||
|
|
||
| [Quoter API]: /docs/RFQ/Quoting/Quoter%20API/ | ||
| [Dispute Period]: /docs/RFQ/Security/#dispute-period | ||
| [Quoting]: /docs/RFQ/Quoting | ||
| [Bridging]: /docs/RFQ/Bridging | ||
| [Relaying]: /docs/RFQ/Relaying | ||
| [Proving]: /docs/RFQ/Proving | ||
| [Claiming]: /docs/RFQ/Claiming | ||
| [Canceling]: /docs/RFQ/Canceling | ||
| [Security]: /docs/RFQ/Security | ||
|
|
||
| [User]: /docs/RFQ/#entities | ||
| [Quoter]: /docs/RFQ/#entities | ||
| [Prover]: /docs/RFQ/#entities | ||
| [Relayer]: /docs/RFQ/#entities | ||
| [Guard]: /docs/RFQ/#entities | ||
| [Canceler]: /docs/RFQ/#entities | ||
|
|
||
| # WIP |
There was a problem hiding this comment.
Document structure needs completion beyond reference links
The document is currently marked as WIP and only contains reference links without any actual content. Consider adding:
- An introduction explaining what "Zaps" are
- The purpose and scope of this documentation
- How these references relate to the FastBridge contract interfaces
- Usage examples or implementation guidelines
Would you like me to help create an outline for the document structure?
🧰 Tools
🪛 Markdownlint
6-6: Unused link or image reference definition: "relay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
7-7: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
9-9: Unused link or image reference definition: "claim"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
13-13: Unused link or image reference definition: "bridgetransactionv2"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "relaying"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
29-29: Unused link or image reference definition: "user"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
30-30: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "relayer"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
33-33: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
| [relay]: https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridgeV2.sol/interface.IFastBridgeV2.html#relay | ||
| [prove]: https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridgeV2.sol/interface.IFastBridgeV2.html#prove | ||
| [dispute]: https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridge.sol/interface.IFastBridge.html#dispute | ||
| [claim]: https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridgeV2.sol/interface.IFastBridgeV2.html#claim | ||
| [cancel]: https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridgeV2.sol/interface.IFastBridgeV2.html#cancel | ||
| [proof]: https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridgeV2.sol/interface.IFastBridgeV2.html#bridgetxdetails | ||
| [BridgeRequested]: https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridge.sol/interface.IFastBridge.html#bridgerequested | ||
| [BridgeTransactionV2]: https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridgeV2.sol/interface.IFastBridgeV2.html#bridgetransactionv2 | ||
| [BridgeRelayed]: https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridge.sol/interface.IFastBridge.html#bridgerelayed | ||
| [BridgeProofProvided]: https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridge.sol/interface.IFastBridge.html#bridgeproofprovided | ||
| [Cancel Delay]: https://vercel-rfq-docs.vercel.app/contracts/FastBridgeV2.sol/contract.FastBridgeV2.html#refund_delay | ||
| [Multicall]: https://vercel-rfq-docs.vercel.app/contracts/interfaces/IMulticallTarget.sol/interface.IMulticallTarget.html | ||
|
|
||
| [Quoter API]: /docs/RFQ/Quoting/Quoter%20API/ | ||
| [Dispute Period]: /docs/RFQ/Security/#dispute-period | ||
| [Quoting]: /docs/RFQ/Quoting | ||
| [Bridging]: /docs/RFQ/Bridging | ||
| [Relaying]: /docs/RFQ/Relaying | ||
| [Proving]: /docs/RFQ/Proving | ||
| [Claiming]: /docs/RFQ/Claiming | ||
| [Canceling]: /docs/RFQ/Canceling | ||
| [Security]: /docs/RFQ/Security | ||
|
|
||
| [User]: /docs/RFQ/#entities | ||
| [Quoter]: /docs/RFQ/#entities | ||
| [Prover]: /docs/RFQ/#entities | ||
| [Relayer]: /docs/RFQ/#entities | ||
| [Guard]: /docs/RFQ/#entities | ||
| [Canceler]: /docs/RFQ/#entities |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Reference links need to be utilized in content
The static analysis shows that none of the defined reference links are currently being used in the document. While having these references is valuable, they should be:
- Integrated into actual documentation content
- Used within explanatory text or examples
- Organized in a way that follows the natural flow of the documentation
Consider this structure for utilizing the references:
# Zaps
## Overview
[Introduction to Zaps and their role in FastBridge]
## Contract Interfaces
### Relay Operation
The relay operation (see [relay]) allows...
### Proof Submission
Provers can submit proofs using the [prove] interface...
[Continue with other sections...]🧰 Tools
🪛 Markdownlint
6-6: Unused link or image reference definition: "relay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
7-7: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
9-9: Unused link or image reference definition: "claim"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
13-13: Unused link or image reference definition: "bridgetransactionv2"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "relaying"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
29-29: Unused link or image reference definition: "user"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
30-30: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "relayer"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
33-33: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
| ### Effects of a [dispute] Transaction | ||
|
|
||
| When a [dispute] is executed, it effectively negates/erases the [proof] which was asserted by the disputed [prove] transaction. | ||
|
|
||
| This allows for a new corrected [prove] to be submitted and the process begins again. | ||
|
|
||
| If a [relay] truly did occur for the disputed [prove], but it was not for the correct bridge parameters, this constitutes an [invalid relay](/docs/RFQ/Relaying%20Risk%20Factors/#invalid-relays). | ||
|
|
||
| Additionally, a [BridgeProofDisputed](https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridge.sol/interface.IFastBridge.html#bridgeproofdisputed) event will be emitted. | ||
|
|
||
| This event can be useful for monitoring / alerting. |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Expand security implications of invalid relays
The documentation should clarify:
- The security implications of invalid relays
- Whether there are penalties for relayers submitting invalid proofs
- How the system prevents spam disputes
🧰 Tools
🪛 LanguageTool
[uncategorized] ~73-~73: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short).
Context: ... a new corrected [prove] to be submitted and the process begins again. If a [relay]...
(COMMA_COMPOUND_SENTENCE_2)
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Outside diff range and nitpick comments (12)
docs/bridge/docs/03-RFQ/60-Security/index.md (6)
5-35: Consider cleaning up unused reference linksSeveral reference links appear to be unused in the current documentation. Consider removing unused references or documenting where they will be used to maintain cleaner documentation.
🧰 Tools
🪛 Markdownlint
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "relaying"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
29-29: Unused link or image reference definition: "user"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
30-30: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
37-38: Enhance introduction with security implicationsConsider adding:
- The rationale behind choosing an optimistic system
- The security trade-offs of this approach
- A brief overview of potential attack vectors
51-51: Fix typo in dispute period sectionThe word "dispuated" should be "disputed".
-During this time, the prove/proof is eligible to be dispuated by [Guard] entities. +During this time, the prove/proof is eligible to be disputed by [Guard] entities.🧰 Tools
🪛 LanguageTool
[grammar] ~51-~51: The word ‘prove’ is a verb. Did you mean the noun “proof”?
Context: ..._period) begins. During this time, the prove/proof is eligible to be dispuated by [G...(PREPOSITION_VERB)
73-73: Fix grammar in compound sentenceAdd a comma before "and" to properly separate independent clauses.
-This allows for a new corrected [prove] to be submitted and the process begins again. +This allows for a new corrected [prove] to be submitted, and the process begins again.🧰 Tools
🪛 LanguageTool
[uncategorized] ~73-~73: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short).
Context: ... a new corrected [prove] to be submitted and the process begins again. If a [relay]...(COMMA_COMPOUND_SENTENCE_2)
77-79: Enhance monitoring/alerting sectionThe monitoring capabilities section could be expanded to include:
- Recommended monitoring tools and configurations
- Critical events that should trigger alerts
- Example monitoring setup
- Response procedures for different types of alerts
1-79: Add security best practices and threat modelConsider enhancing the security documentation with:
- A comprehensive threat model
- Known attack vectors and mitigations
- Security best practices for implementers
- Emergency procedures for critical situations
- Risk assessment guidelines
Would you like assistance in drafting these additional sections?
🧰 Tools
🪛 LanguageTool
[grammar] ~51-~51: The word ‘prove’ is a verb. Did you mean the noun “proof”?
Context: ..._period) begins. During this time, the prove/proof is eligible to be dispuated by [G...(PREPOSITION_VERB)
[uncategorized] ~73-~73: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short).
Context: ... a new corrected [prove] to be submitted and the process begins again. If a [relay]...(COMMA_COMPOUND_SENTENCE_2)
🪛 Markdownlint
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "relaying"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
29-29: Unused link or image reference definition: "user"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
30-30: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
docs/bridge/docs/02-Bridge/01-SDK.md (3)
Line range hint
82-89: Consider enhancing the excludedModules documentationWhile the parameters are well documented, consider adding:
- A brief explanation of each module's purpose (
SynapseBridge,SynapseCCTP,SynapseRFQ)- Common use cases for excluding specific modules
- The impact of excluding each module type
Line range hint
233-235: Enhance the FastBridgeRouter deprecation noticeConsider adding:
- A migration timeline or deadline
- Step-by-step migration instructions
- Any potential impacts on existing integrations
Line range hint
160-178: Fix inconsistency in bridgeQuote exampleThe example includes a
routerAddressparameter that isn't documented in the Parameters section above. Please either:
- Add
routerAddressto the parameters documentation, or- Remove it from the example if it's no longer required
docs/bridge/docs/03-RFQ/70-CanonicalRelayer/index.md (3)
Line range hint
132-151: Improve configuration documentation structureThe configuration section could be better organized:
- Consider using a table for configuration parameters
- Group related parameters together (e.g., all rebalancing configs)
- Use consistent formatting for parameter descriptions
Consider restructuring like this:
-* `submitter_config`: Covered [here](/docs/Services/Submitter#observability). Controls gas parameters for on-chain transactions. -* `database`: Database settings for API backend. Required to store quotes and other information. SQLite with `DSN` set to a `/tmp/` directory is recommended for development. +## Configuration Parameters + +### Core Settings +| Parameter | Description | Required | Default | +|-----------|-------------|----------|---------| +| `submitter_config` | Controls gas parameters for on-chain transactions. See [Submitter docs](/docs/Services/Submitter#observability) | Yes | - | +| `database` | Database settings for API backend | Yes | - |
Line range hint
92-130: Enhance rebalancing documentation with diagramsThe rebalancing section explains complex logic that would benefit from visual aids. Consider adding:
- A flowchart showing the rebalancing decision process
- A diagram illustrating the example scenario
- A table comparing different rebalancing methods
134-135: Address TODO comment regarding documentation generationThe TODO comment indicates that configuration documentation should be auto-generated from code and mix-ins.
Would you like me to help create a script for auto-generating the configuration documentation from code annotations?
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (4)
docs/bridge/docs/01-About/index.md(1 hunks)docs/bridge/docs/02-Bridge/01-SDK.md(1 hunks)docs/bridge/docs/03-RFQ/60-Security/index.md(1 hunks)docs/bridge/docs/03-RFQ/70-CanonicalRelayer/index.md(5 hunks)
✅ Files skipped from review due to trivial changes (1)
- docs/bridge/docs/01-About/index.md
🧰 Additional context used
🪛 LanguageTool
docs/bridge/docs/03-RFQ/60-Security/index.md
[grammar] ~51-~51: The word ‘prove’ is a verb. Did you mean the noun “proof”?
Context: ..._period) begins. During this time, the prove/proof is eligible to be dispuated by [G...
(PREPOSITION_VERB)
[uncategorized] ~73-~73: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short).
Context: ... a new corrected [prove] to be submitted and the process begins again. If a [relay]...
(COMMA_COMPOUND_SENTENCE_2)
🪛 Markdownlint
docs/bridge/docs/03-RFQ/60-Security/index.md
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "relaying"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
29-29: Unused link or image reference definition: "user"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
30-30: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
docs/bridge/docs/03-RFQ/70-CanonicalRelayer/index.md
6-6: Unused link or image reference definition: "relay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
7-7: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
9-9: Unused link or image reference definition: "claim"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
13-13: Unused link or image reference definition: "bridgetransactionv2"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
29-29: Unused link or image reference definition: "user"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
30-30: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "relayer"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
33-33: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
151-151: Expected: dash; Actual: asterisk
Unordered list style
(MD004, ul-style)
🔇 Additional comments (2)
docs/bridge/docs/02-Bridge/01-SDK.md (1)
156-156: LGTM: Clear reference to RFQ documentation
The addition of the RFQ reference enhances the documentation by properly connecting the Bridge SDK with the RFQ functionality.
docs/bridge/docs/03-RFQ/70-CanonicalRelayer/index.md (1)
5-35: Verify reference link validity and usage
The document defines numerous reference links that should be verified to ensure they are:
- Actually used within the document
- Point to valid and accessible URLs
- Reference the correct contract versions (especially for FastBridgeV2)
✅ Verification successful
Reference links are actively used in the documentation
After reviewing the full content of the file, I can confirm that the reference links defined at the top of the document are actively used throughout the content. For example:
- Documentation section links like [Quoting], [Relaying], [Proving], etc. are used in the main content to cross-reference different sections
- Contract interface links are used when referencing specific functions and events
- Entity links are properly referenced when discussing different roles
The external links to vercel-rfq-docs.vercel.app are accessible (HTTP 200 response), and the internal documentation structure appears to be consistent with the referenced paths.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Verify the validity of contract interface links and internal documentation links
# Check if the contract interface links are valid
echo "Checking contract interface links..."
curl -s -o /dev/null -w "%{http_code}" "https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridgeV2.sol/interface.IFastBridgeV2.html"
# Search for usage of reference links in the document
echo "Checking reference link usage..."
rg -l "\[.*?\]\[(?:relay|prove|dispute|claim|cancel|proof|bridgerequested|bridgetransactionv2|bridgerelayed|bridgeproofprovided)\]"
Length of output: 438
Script:
#!/bin/bash
# Let's check for actual usage of these reference links in the content
echo "Checking for reference link usage in the full document content..."
rg "\[.+?\]\[(relay|prove|dispute|claim|cancel|proof|bridgerequested|bridgetransactionv2|bridgerelayed|bridgeproofprovided|User|Quoter|Prover|Relayer|Guard|Canceler|Security|Bridging|Relaying|Proving|Claiming|Canceling)\]" "docs/bridge/docs/03-RFQ/70-CanonicalRelayer/index.md"
# Let's also check if the internal documentation links exist
echo -e "\nChecking for existence of internal documentation files..."
for path in "docs/RFQ/Quoting/Quoter API/" "docs/RFQ/Security/" "docs/RFQ/Quoting" "docs/RFQ/Bridging" "docs/RFQ/Relaying" "docs/RFQ/Proving" "docs/RFQ/Claiming" "docs/RFQ/Canceling" "docs/RFQ/Security"; do
fd -p "${path}*" docs/bridge/
done
Length of output: 2783
Script:
#!/bin/bash
# Let's check the actual content of the file to see if these references are used in a different format
echo "Checking full content of the file..."
cat "docs/bridge/docs/03-RFQ/70-CanonicalRelayer/index.md"
# Also check for the existence of the main RFQ documentation file that contains the entities section
echo -e "\nChecking for main RFQ documentation..."
fd -p "docs/RFQ/index.md" docs/bridge/
Length of output: 18240
🧰 Tools
🪛 Markdownlint
6-6: Unused link or image reference definition: "relay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
7-7: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
9-9: Unused link or image reference definition: "claim"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
13-13: Unused link or image reference definition: "bridgetransactionv2"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
29-29: Unused link or image reference definition: "user"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
30-30: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "relayer"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
33-33: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
| @@ -272,7 +317,7 @@ Clone the Sanguine repository, then run the main.go file along with the path to | |||
|
|
|||
| ## sendChainGas | |||
|
|
|||
| Boolean flag available to Bridge users. When `sendChainGas` is `true`, the amount to send is specified as `chainGasAmount` in the FastBridge contract on the destination chain. | |||
| Boolean flag available to Bridge users. When `sendChainGas` is `true`, the amount to send is specified as `chainGasAmount` in the FastBridgeV2 contract on the destination chain. | |||
There was a problem hiding this comment.
🛠️ Refactor suggestion
Improve sendChainGas documentation
The sendChainGas section needs more context:
- Explain the purpose and impact of this flag
- Provide examples of when to use it
- Document potential implications of ignoring
sendChainGas
There was a problem hiding this comment.
Let's add a Relayer-focused separate section for Zaps. Things to cover:
- Setting up
msg.valueifZapNative != 0- Explaining that in this case the dest token is never
0xEEEE, so there's no need for complex msg.value calculation - Not possible to multicall such txs
- Explaining that in this case the dest token is never
- Explaining that
ZapData != ""leads to a separate call to the recipient contract, and that a Relayer can usedestAmount := originAmountwhen calculating an active quote request.
There was a problem hiding this comment.
planning to take same approach as Exclusivity where zaps get their own section linked to by both Bridging & Relaying sections. will be in future commit
| [Guard]: /docs/RFQ/#entities | ||
| [Canceler]: /docs/RFQ/#entities | ||
|
|
||
| # WIP |
There was a problem hiding this comment.
Things to add here (again, focusing on the user/integration perspective):
- Setting non-zero
ZapNativeto request additional gas on top of the bridged token.- Can be used with recipient EOA.
- Can not be used with
0xEEEEdestination token.
- Utilising non-empty
ZapDatato request a zap action to be performed using the bridged tokens.- Can only be used with smart-contract recipients that follow
IZapRecipientinterface. - Highlight that if the zap action fails, the whole transaction gets reverted (aka no stuck funds in the recipient contract). Can be again attempted for relay by same/different Relayer; or cancelled on the origin chain if no one successfully relays.
- ZapData should be encoded according to the documentation of that specific recipient contract.
- That will typically use the user address to act on behalf of, and the amount of tokens to use.
- When a quote is requested, ZapData must be encoded using
originAmountas amount of tokens to use on the destination chain. - After the quote is received, that quoted amount must be used to regenerate ZapData.
- Can only be used with smart-contract recipients that follow
- Can use non-zero ZapNative with non-empty ZapData, if the smart contract recipient requires both a token + native gas transfer for the zap action.
There was a problem hiding this comment.
Actionable comments posted: 8
🧹 Outside diff range and nitpick comments (42)
docs/bridge/docs/03-RFQ/15-Bridging/quoteId.md (3)
5-36: Consider organizing reference links into logical groupsWhile the reference links are comprehensive, they could be better organized with clear section comments. Consider grouping them as follows:
- Contract interfaces
- Documentation sections
- Entity definitions
<!-- Reference Links --> +<!-- Contract Interface Links --> [relay]: https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridgeV2.sol/interface.IFastBridgeV2.html#relay [prove]: https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridgeV2.sol/interface.IFastBridgeV2.html#prove ... +<!-- Documentation Section Links --> [Quoter API]: /docs/RFQ/Quoting/Quoter%20API/ [Dispute Period]: /docs/RFQ/Security/#dispute-period ... +<!-- Entity Definition Links --> [User]: /docs/RFQ/#entities [Quoter]: /docs/RFQ/#entities ...🧰 Tools
🪛 Markdownlint (0.35.0)
6-6: Unused link or image reference definition: "relay"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
7-7: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
9-9: Unused link or image reference definition: "claim"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
13-13: Unused link or image reference definition: "bridgetransactionv2"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "relaying"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
28-28: Unused link or image reference definition: "exclusivity"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
30-30: Unused link or image reference definition: "user"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
33-33: Unused link or image reference definition: "relayer"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
35-35: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
41-41: Fix grammatical issue with "however" usageThe sentence structure needs improvement.
-There is currently no on-chain functionality that utilizes this field, it is simply for record keeping and indexing, however this may change in the future. +There is currently no on-chain functionality that utilizes this field, it is simply for record keeping and indexing. However, this may change in the future.🧰 Tools
🪛 LanguageTool
[typographical] ~41-~41: The word “however” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence.
Context: ...s simply for record keeping and indexing, however this may change in the future.(HOWEVER_SENTENCE)
37-41: Consider enhancing the documentation with examplesWhile the current content clearly explains the purpose of
quoteId, it would be more helpful to include:
- Example format or structure of a
quoteId- Sample usage in a bridge transaction
- Best practices for generating and managing
quoteIdsWould you like me to help generate example content for these sections?
🧰 Tools
🪛 LanguageTool
[typographical] ~41-~41: The word “however” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence.
Context: ...s simply for record keeping and indexing, however this may change in the future.(HOWEVER_SENTENCE)
docs/bridge/docs/03-RFQ/50-Canceling/index.md (3)
41-41: Improve clarity and conciseness.Consider these improvements:
- Replace "prior to" with "before" for conciseness
- Make the "deadline" reference more descriptive
-A permissioned [Canceler] entity can also execute the [cancel] function prior to the cancellation delay, but only after the relay expiration [deadline](https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridge.sol/interface.IFastBridge.html#bridgeparams) indicated the BridgeParams of the bridge request. +A permissioned [Canceler] entity can also execute the [cancel] function before the cancellation delay, but only after the relay expiration [deadline in BridgeParams](https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridge.sol/interface.IFastBridge.html#bridgeparams) of the bridge request.🧰 Tools
🪛 LanguageTool
[style] ~41-~41: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ... can also execute the [cancel] function prior to the cancellation delay, but only after ...(EN_WORDINESS_PREMIUM_PRIOR_TO)
43-44: Replace abbreviation with full form.Replace "IE" with "i.e." (or preferably "that is") for better readability.
-If there is already a [proof] on file for the transaction, then cancellation will be prevented. (IE: Cannot attempt to [cancel] a transaction which appears to have already been successfully completed) +If there is already a [proof] on file for the transaction, then cancellation will be prevented (that is, cannot attempt to [cancel] a transaction which appears to have already been successfully completed).
51-51: Add comma in compound sentence.Add a comma before "and" as it connects two independent clauses.
-No further action is possible with the bridge after a cancellation and it can be considered closed. +No further action is possible with the bridge after a cancellation, and it can be considered closed.🧰 Tools
🪛 LanguageTool
[uncategorized] ~51-~51: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ble with the bridge after a cancellation and it can be considered closed.(COMMA_COMPOUND_SENTENCE)
docs/bridge/docs/03-RFQ/40-Claiming/index.md (3)
37-40: Add dispute period duration detailsConsider adding information about the typical duration of the dispute period to help Relayers better understand when they can initiate the claim transaction.
54-58: Highlight security implications of permissionless executionThe documentation should emphasize the security considerations of the permissionless claim function. Consider adding a note explaining why this is safe and what validations are performed to ensure funds are sent to the correct relayer.
67-69: Add troubleshooting guidanceConsider adding a troubleshooting section that covers:
- Common issues during claim transactions
- How to verify successful claim completion
- Steps to take if the claim transaction fails
docs/bridge/docs/03-RFQ/90-Misc/index.md (1)
66-68: Enhance the load tester documentation with usage examples.The load tester section would be more helpful with additional details such as:
- Basic usage examples
- Configuration options
- Common test scenarios
Consider adding a code block with a basic usage example:
## RFQ Load Tester The [`rfq-loadtest`](https://github.com/synapsecns/sanguine/tree/master/packages/rfq-loadtest) tool can be used to rapidly send ETH bridges for the purpose of load testing. + +### Basic Usage + +```bash +# Example command to run a load test +rfq-loadtest --bridges 10 --concurrent 2 +``` + +### Configuration + +Key parameters: +- `--bridges`: Number of bridge transactions to send +- `--concurrent`: Number of concurrent transactionsdocs/bridge/docs/03-RFQ/15-Bridging/index.md (2)
38-79: Consider enhancing technical details.While the content flow is clear, consider adding:
- Code examples or snippets demonstrating bridge transaction construction
- Common error scenarios and their resolutions
- Sequence diagram illustrating the bridging process
Would you like me to help generate these additional sections?
🧰 Tools
🪛 LanguageTool
[uncategorized] ~66-~66: The preposition ‘to’ seems more likely in this position.
Context: ... reimbursement for completing the relay on the destination. or - [Canceling] occ...(AI_HYDRA_LEO_REPLACE_ON_TO)
55-55: Improve language and grammar.
- Line 55: Replace "IE:" with "i.e.:" (abbreviation for Latin "id est")
- Line 66: Replace "on the destination" with "to the destination"
-IE: For a temporary period of time, only the relayer chosen and assigned by the integrator will be able to execute the relay. +i.e.: For a temporary period of time, only the relayer chosen and assigned by the integrator will be able to execute the relay. -... reimbursement for completing the relay on the destination. +... reimbursement for completing the relay to the destination.Also applies to: 66-66
docs/bridge/docs/03-RFQ/30-Proving/index.md (5)
37-42: Consider adding authorization details.The process description would benefit from clarifying:
- How Provers obtain authorization
- Any specific requirements or restrictions for becoming an authorized Prover
43-60: Consider adding usage examples.The function options are well-documented, but adding example calls for each overloaded version would make it easier for developers to understand the practical usage.
🧰 Tools
🪛 LanguageTool
[grammar] ~45-~45: The word ‘prove’ is a verb. Did you mean the noun “proof”?
Context: ...here are two overloaded versions of the prove function in FastBridgeV2. Relayers can ...(PREPOSITION_VERB)
61-64: Consider adding event structure details.It would be helpful to include:
- The event parameters and their types
- An example event emission
65-70: Enhance warning with consequences.Consider adding information about:
- What could happen if prove is called too early
- How to determine when a relay transaction is sufficiently finalized
78-78: Fix typo in "transation".-Following the [prove] transation, a [Dispute Period] begins +Following the [prove] transaction, a [Dispute Period] beginsdocs/bridge/docs/03-RFQ/60-Security/index.md (3)
5-36: Consider organizing reference links into logical groupsThe reference links section could be better organized for maintainability:
- Group contract interfaces separately from documentation links
- Add comments to indicate the purpose of each group
- Consider moving unused references to where they're needed
<!-- Reference Links --> +<!-- Contract Interfaces --> [relay]: https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridgeV2.sol/interface.IFastBridgeV2.html#relay [prove]: https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridgeV2.sol/interface.IFastBridgeV2.html#prove ... +<!-- Documentation Links --> [Quoter API]: /docs/RFQ/Quoting/Quoter%20API/ [Dispute Period]: /docs/RFQ/Security/#dispute-period ... +<!-- Entity References --> [User]: /docs/RFQ/#entities [Quoter]: /docs/RFQ/#entities🧰 Tools
🪛 Markdownlint (0.35.0)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "relaying"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
28-28: Unused link or image reference definition: "exclusivity"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
30-30: Unused link or image reference definition: "user"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
35-35: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
52-52: Fix typo in dispute period sectionThe word "dispuated" should be "disputed".
-During this time, the prove/proof is eligible to be dispuated by [Guard] entities. +During this time, the prove/proof is eligible to be disputed by [Guard] entities.🧰 Tools
🪛 LanguageTool
[grammar] ~52-~52: The word ‘prove’ is a verb. Did you mean the noun “proof”?
Context: ..._period) begins. During this time, the prove/proof is eligible to be dispuated by [G...(PREPOSITION_VERB)
78-80: Expand monitoring capabilities documentationThe monitoring section should include:
- Recommended monitoring setup
- Important metrics to track
- Example alert configurations
- Automated response possibilities
- Integration with common monitoring tools
Would you like me to help draft detailed monitoring documentation?
docs/bridge/docs/03-RFQ/10-Quoting/index.md (2)
5-36: Consider cleaning up unused reference definitionsSeveral link references are defined but not used within this document. While they might be used in other files or planned for future use, consider:
- Documenting their purpose in a comment
- Moving shared references to a common file
- Removing truly unused references
🧰 Tools
🪛 Markdownlint (0.35.0)
6-6: Unused link or image reference definition: "relay"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
7-7: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
9-9: Unused link or image reference definition: "claim"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
13-13: Unused link or image reference definition: "bridgetransactionv2"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "relaying"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
28-28: Unused link or image reference definition: "exclusivity"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
33-33: Unused link or image reference definition: "relayer"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
35-35: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
52-52: Fix grammar in the sentenceThe verb "allow" doesn't agree with the subject.
-Active quoting is more complicated to implement and maintain, but allow for more granular & customized quotes that can improve efficiency among other benefits. +Active quoting is more complicated to implement and maintain, but allows for more granular & customized quotes that can improve efficiency among other benefits.🧰 Tools
🪛 LanguageTool
[uncategorized] ~52-~52: This verb does not appear to agree with the subject. Consider using a different form.
Context: ...plicated to implement and maintain, but allow for more granular & customized quotes t...(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)
[typographical] ~52-~52: Usually, there’s no comma before “if”.
Context: ...e free to use nothing but Passive Quotes, if they choose. ## :::info To learn mor...(IF_NO_COMMA)
docs/bridge/docs/03-RFQ/75-Exclusivity/index.md (1)
5-36: Clean up unused reference links.Many of the defined reference links are not used in the document. Consider removing unused references to improve maintainability. Based on the content, only these links appear to be used:
[relay][BridgeParamsV2][BridgeTransactionV2][BridgeRequested][Relayer]<!-- Reference Links --> [relay]: https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridgeV2.sol/interface.IFastBridgeV2.html#relay -[prove]: https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridgeV2.sol/interface.IFastBridgeV2.html#prove -[dispute]: https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridge.sol/interface.IFastBridge.html#dispute -[claim]: https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridgeV2.sol/interface.IFastBridgeV2.html#claim -[cancel]: https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridgeV2.sol/interface.IFastBridgeV2.html#cancel -[proof]: https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridgeV2.sol/interface.IFastBridgeV2.html#bridgetxdetails [BridgeTransactionV2]: https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridgeV2.sol/interface.IFastBridgeV2.html#bridgetransactionv2 [BridgeRequested]: https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridge.sol/interface.IFastBridge.html#bridgerequested -[BridgeRelayed]: https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridge.sol/interface.IFastBridge.html#bridgerelayed # ... (remove other unused references) [Relayer]: /docs/RFQ/#entities🧰 Tools
🪛 Markdownlint (0.35.0)
7-7: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
9-9: Unused link or image reference definition: "claim"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "relaying"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
28-28: Unused link or image reference definition: "exclusivity"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
30-30: Unused link or image reference definition: "user"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
35-35: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
docs/bridge/docs/03-RFQ/20-Relaying/riskFactors.md (4)
48-48: Fix grammatical errorChange "can be come" to "become" for correct grammar.
-If a bridge transaction occurs that acts upon a quote issued by a particular [Relayer], and that [Relayer] fails to complete the [relay] transaction - the bridge deposit can be come "stuck" if there is no one to complete it. +If a bridge transaction occurs that acts upon a quote issued by a particular [Relayer], and that [Relayer] fails to complete the [relay] transaction - the bridge deposit can become "stuck" if there is no one to complete it.🧰 Tools
🪛 LanguageTool
[grammar] ~48-~48: Did you mean “become”?
Context: ...y] transaction - the bridge deposit can be come "stuck" if there is no one to complete ...(BE_COME)
74-74: Consider emphasizing the severity of fund lossThe warning about fund loss could be made more prominent. Consider adding emphasis or moving this critical information into a warning block.
-The incorrect [relay] in this example cannot be reversed or reimbursed and would effectively be a loss of funds for the [Relayer] who performed it. +:::warning +The incorrect [relay] cannot be reversed or reimbursed and will result in a permanent loss of funds for the [Relayer] who performed it. +:::
82-82: Consider adding an example of exploitative bridgesTo make the warning more concrete and actionable, consider adding a simple example of an exploitative bridge attempt.
Similarly, it is important to remember that bridge is a permissionless function. As with any similar system, bad actors *can* and *will* submit exploitative bridges to see if any Relayers make the fatal mistake of filling them. + +For example, a malicious user might submit a bridge request with incorrect token prices or manipulated oracle data, attempting to trick Relayers into accepting unfavorable trades.
88-88: Consider adding specific monitoring recommendationsThe monitoring advice could be more actionable with specific examples of what to monitor.
If you are a participating [Relayer], it is highly recommended that you monitor proofs, disputes, and other critical functions that involve your quotes and transactions. + +Key monitoring points should include: +- Time elapsed since last successful relay +- Proof submission latency +- Dispute events on your transactions +- Gas price fluctuations that might affect profitabilitydocs/bridge/docs/03-RFQ/20-Relaying/index.md (5)
6-17: Consider using relative URLs for contract documentation linksThe current absolute URLs pointing to Vercel (e.g.,
https://vercel-rfq-docs.vercel.app/...) could cause maintenance issues if the documentation hosting changes. Consider using relative paths instead.🧰 Tools
🪛 Markdownlint (0.35.0)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
39-39: Fix minor formatting inconsistencies
- Line 39: Remove extra space before period in "destination chain ."
- Line 45: Consider standardizing hyphenation in "Currently, relaying involves actions which require explicit authorization."
Also applies to: 45-45
107-107: Fix heading hierarchyThe "Permissions" section uses an h3 heading (
###) but should be an h2 heading (##) as it's a top-level section like the others.🧰 Tools
🪛 Markdownlint (0.35.0)
107-107: Expected: h2; Actual: h3
Heading levels should only increment by one level at a time(MD001, heading-increment)
61-62: Add clarification about native currency placeholderConsider adding a brief explanation of why
0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeEis used as a placeholder for native currency, as this might not be immediately obvious to readers new to the system.
103-105: Enhance multicall limitations explanationThe multicall limitations section could benefit from a brief explanation of why native-gas bridges cannot be included in batches. This would help developers better understand the technical constraints.
docs/bridge/docs/03-RFQ/10-Quoting/Quoter API/index.md (5)
6-37: Consider cleaning up unused reference linksThe document defines numerous reference links that appear to be unused within this file. While they might be used in other documentation files, maintaining unused references increases maintenance overhead. Consider moving these references to a shared configuration file or removing unused ones to improve maintainability.
🧰 Tools
🪛 Markdownlint (0.35.0)
7-7: Unused link or image reference definition: "relay"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
9-9: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "claim"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
13-13: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgetransactionv2"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
18-18: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
28-28: Unused link or image reference definition: "security"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
29-29: Unused link or image reference definition: "exclusivity"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "user"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
33-33: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "relayer"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
35-35: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
36-36: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
178-178: Fix typographical errorRemove the duplicate word "the" in the sentence.
-Users and relayers **are not** expected to run their own version of the Quoter API. Rather, they are expected to use a Quoter API that is hosted by the the interface they are quoting for. +Users and relayers **are not** expected to run their own version of the Quoter API. Rather, they are expected to use a Quoter API that is hosted by the interface they are quoting for.🧰 Tools
🪛 LanguageTool
[duplication] ~178-~178: Possible typo: you repeated a word
Context: ...d to use a Quoter API that is hosted by the the interface they are quoting for. For exa...(ENGLISH_WORD_REPEAT_RULE)
100-130: Add language specifiers to code blocksFor better syntax highlighting and documentation clarity, add language specifiers to the code blocks. Based on the content, these appear to be JSON structures.
- ``` + ```json { op: string, content: json, success: bool, }Apply similar changes to the other code blocks in this section.
🧰 Tools
🪛 Markdownlint (0.35.0)
100-100: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
110-110: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
125-125: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
135-144: Consider adding a code example for version change detectionThe version change detection documentation would benefit from a practical example showing how to implement the version check using the "X-Api-Version" header.
Consider adding an example like:
async function checkApiVersion(response: Response) { const apiVersion = response.headers.get('X-Api-Version'); const expectedVersion = 'v1.0.0'; // Your expected version if (apiVersion !== expectedVersion) { console.warn(`API version mismatch. Expected ${expectedVersion}, got ${apiVersion}`); // Implement your version change handling logic } }
221-221: Enhance Docker deployment instructionsThe Docker run command could be more comprehensive, including:
- Volume mounting for configuration
- Environment variables
- Port mapping
- Container naming
Example enhanced command:
docker run -d \ --name rfq-api \ -p 8081:8081 \ -v $(pwd)/config.yaml:/app/config.yaml \ -e DATABASE_DSN=your_dsn \ -e OMNIRPC_URL=your_url \ ghcr.io/synapsecns/sanguine/rfq-api:latest \ --config /app/config.yamldocs/bridge/docs/03-RFQ/index.md (2)
157-159: Fix heading hierarchy for better document structureThe heading levels should only increment by one level at a time. Change the heading level for the "Quoting" section to maintain proper hierarchy:
-## Flow Summary - -#### [Quoting] +## Flow Summary + +### [Quoting]🧰 Tools
🪛 Markdownlint (0.35.0)
159-159: Expected: h3; Actual: h4
Heading levels should only increment by one level at a time(MD001, heading-increment)
157-157: null
Multiple spaces after hash on atx style heading(MD019, no-multiple-space-atx)
125-125: Consider highlighting security implications of centralized Guard roleThe statement "Currently, Synapse itself is the sole Guard operator" implies centralization in the security model. Consider adding a note about future plans for decentralization or the security measures in place to mitigate centralization risks.
docs/bridge/docs/03-RFQ/70-CanonicalRelayer/index.md (3)
59-59: Minor grammatical improvement neededConsider replacing "built in Go" with "built in Go with" for better readability.
-The canonical RFQ Relayer is primarily built in Go with a MySQL backend. +The canonical RFQ Relayer is primarily built with Go with a MySQL backend.🧰 Tools
🪛 LanguageTool
[uncategorized] ~59-~59: The preposition ‘to’ seems more likely in this position.
Context: ...anonical RFQ Relayer is primarily built in Go with a MySQL backend. It also utiliz...(AI_HYDRA_LEO_REPLACE_IN_TO)
152-152: Maintain consistent list style markersFor consistency with other lists in the document, use dash (-) instead of asterisk (*) for unordered lists.
-* `rfq_url`: [Mainnet & Testnet addresses](/docs/RFQ/Quoting/Quoter%20API/#api-urls) +- `rfq_url`: [Mainnet & Testnet addresses](/docs/RFQ/Quoting/Quoter%20API/#api-urls)🧰 Tools
🪛 Markdownlint (0.35.0)
152-152: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
Line range hint
338-341: Add security warning for withdrawal configurationThe withdrawal configuration allows direct access to wallet operations. Consider adding a security warning about:
- Properly securing the API endpoint (e.g., using HTTPS)
- Carefully managing the withdrawal whitelist
- Implementing rate limiting
- Monitoring withdrawal activities
🧰 Tools
🪛 LanguageTool
[uncategorized] ~59-~59: The preposition ‘to’ seems more likely in this position.
Context: ...anonical RFQ Relayer is primarily built in Go with a MySQL backend. It also utiliz...(AI_HYDRA_LEO_REPLACE_IN_TO)
🪛 Markdownlint (0.35.0)
6-6: Unused link or image reference definition: "relay"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
7-7: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
9-9: Unused link or image reference definition: "claim"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
13-13: Unused link or image reference definition: "bridgetransactionv2"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
28-28: Unused link or image reference definition: "exclusivity"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
30-30: Unused link or image reference definition: "user"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
33-33: Unused link or image reference definition: "relayer"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
35-35: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (15)
docs/bridge/docs/03-RFQ/10-Quoting/Quoter API/index.md(1 hunks)docs/bridge/docs/03-RFQ/10-Quoting/index.md(1 hunks)docs/bridge/docs/03-RFQ/15-Bridging/index.md(1 hunks)docs/bridge/docs/03-RFQ/15-Bridging/quoteId.md(1 hunks)docs/bridge/docs/03-RFQ/15-Bridging/zaps.md(1 hunks)docs/bridge/docs/03-RFQ/20-Relaying/index.md(1 hunks)docs/bridge/docs/03-RFQ/20-Relaying/riskFactors.md(1 hunks)docs/bridge/docs/03-RFQ/30-Proving/index.md(1 hunks)docs/bridge/docs/03-RFQ/40-Claiming/index.md(1 hunks)docs/bridge/docs/03-RFQ/50-Canceling/index.md(1 hunks)docs/bridge/docs/03-RFQ/60-Security/index.md(1 hunks)docs/bridge/docs/03-RFQ/70-CanonicalRelayer/index.md(5 hunks)docs/bridge/docs/03-RFQ/75-Exclusivity/index.md(1 hunks)docs/bridge/docs/03-RFQ/90-Misc/index.md(1 hunks)docs/bridge/docs/03-RFQ/index.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/bridge/docs/03-RFQ/10-Quoting/Quoter API/index.md
[duplication] ~178-~178: Possible typo: you repeated a word
Context: ...d to use a Quoter API that is hosted by the the interface they are quoting for. For exa...
(ENGLISH_WORD_REPEAT_RULE)
[typographical] ~200-~200: It seems that a comma is missing.
Context: ...lite, this can be a path, if using mysql please see [here](https://dev.mysql.com/doc/co...
(IF_PLEASE_COMMA)
[style] ~215-~215: Consider a more expressive alternative.
Context: ...ter API can also be run with docker. To do this, you will need to build the docker...
(DO_ACHIEVE)
docs/bridge/docs/03-RFQ/10-Quoting/index.md
[uncategorized] ~52-~52: This verb does not appear to agree with the subject. Consider using a different form.
Context: ...plicated to implement and maintain, but allow for more granular & customized quotes t...
(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)
[typographical] ~52-~52: Usually, there’s no comma before “if”.
Context: ...e free to use nothing but Passive Quotes, if they choose. ## :::info To learn mor...
(IF_NO_COMMA)
docs/bridge/docs/03-RFQ/15-Bridging/index.md
[uncategorized] ~66-~66: The preposition ‘to’ seems more likely in this position.
Context: ... reimbursement for completing the relay on the destination. or - [Canceling] occ...
(AI_HYDRA_LEO_REPLACE_ON_TO)
docs/bridge/docs/03-RFQ/15-Bridging/quoteId.md
[typographical] ~41-~41: The word “however” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence.
Context: ...s simply for record keeping and indexing, however this may change in the future.
(HOWEVER_SENTENCE)
docs/bridge/docs/03-RFQ/20-Relaying/index.md
[style] ~63-~63: ‘Prior to’ might be wordy. Consider a shorter alternative.
Context: ...stination asset to deliver is an ERC20. Prior to calling [relay], the [Relayer] must hav...
(EN_WORDINESS_PREMIUM_PRIOR_TO)
docs/bridge/docs/03-RFQ/20-Relaying/riskFactors.md
[grammar] ~48-~48: Did you mean “become”?
Context: ...y] transaction - the bridge deposit can be come "stuck" if there is no one to complete ...
(BE_COME)
[grammar] ~50-~50: Do not use an adverb of manner between a verb and its direct object.
Context: ...ds are safe in these instances and will eventually either be cancelled & refunded or compl...
(MD_RB_DT)
[style] ~52-~52: As a shorter alternative for ‘able to’, consider using “can”.
Context: ...participating Relayers must ensure they are able to complete all bridge transactions that a...
(BE_ABLE_TO)
docs/bridge/docs/03-RFQ/30-Proving/index.md
[grammar] ~45-~45: The word ‘prove’ is a verb. Did you mean the noun “proof”?
Context: ...here are two overloaded versions of the prove function in FastBridgeV2. Relayers can ...
(PREPOSITION_VERB)
docs/bridge/docs/03-RFQ/50-Canceling/index.md
[style] ~41-~41: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ... can also execute the [cancel] function prior to the cancellation delay, but only after ...
(EN_WORDINESS_PREMIUM_PRIOR_TO)
[uncategorized] ~51-~51: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ble with the bridge after a cancellation and it can be considered closed.
(COMMA_COMPOUND_SENTENCE)
docs/bridge/docs/03-RFQ/60-Security/index.md
[grammar] ~52-~52: The word ‘prove’ is a verb. Did you mean the noun “proof”?
Context: ..._period) begins. During this time, the prove/proof is eligible to be dispuated by [G...
(PREPOSITION_VERB)
[uncategorized] ~74-~74: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short).
Context: ... a new corrected [prove] to be submitted and the process begins again. If a [relay]...
(COMMA_COMPOUND_SENTENCE_2)
docs/bridge/docs/03-RFQ/70-CanonicalRelayer/index.md
[uncategorized] ~59-~59: The preposition ‘to’ seems more likely in this position.
Context: ...anonical RFQ Relayer is primarily built in Go with a MySQL backend. It also utiliz...
(AI_HYDRA_LEO_REPLACE_IN_TO)
docs/bridge/docs/03-RFQ/index.md
[style] ~41-~41: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ... Synapse RFQ (Request-For-Quote) is an <abbr title="'Intent' refers to a user authorizing specific actions that they want to achieve, typically in very simple terms, such as a bridge or swap. Actual...
(EN_WEAK_ADJECTIVE)
[style] ~146-~146: Consider removing “of” to be more concise
Context: ...s/Contracts/RFQ) facilitate and enforce all of the on-chain functionality and security of ...
(ALL_OF_THE)
🪛 Markdownlint (0.35.0)
docs/bridge/docs/03-RFQ/10-Quoting/Quoter API/index.md
173-173: Expected: 0; Actual: 1
Unordered list indentation
(MD007, ul-indent)
174-174: Expected: 0; Actual: 1
Unordered list indentation
(MD007, ul-indent)
176-176: Punctuation: ':'
Trailing punctuation in heading
(MD026, no-trailing-punctuation)
57-57: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
64-64: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
76-76: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
81-81: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
213-213: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
100-100: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
110-110: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
125-125: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
7-7: Unused link or image reference definition: "relay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
9-9: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "claim"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
13-13: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgetransactionv2"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
18-18: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
28-28: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
29-29: Unused link or image reference definition: "exclusivity"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "user"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
33-33: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "relayer"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
35-35: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
36-36: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
docs/bridge/docs/03-RFQ/10-Quoting/index.md
6-6: Unused link or image reference definition: "relay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
7-7: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
9-9: Unused link or image reference definition: "claim"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
13-13: Unused link or image reference definition: "bridgetransactionv2"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "relaying"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
28-28: Unused link or image reference definition: "exclusivity"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
33-33: Unused link or image reference definition: "relayer"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
35-35: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
docs/bridge/docs/03-RFQ/15-Bridging/index.md
6-6: Unused link or image reference definition: "relay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
7-7: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
9-9: Unused link or image reference definition: "claim"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
13-13: Unused link or image reference definition: "bridgetransactionv2"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
35-35: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
docs/bridge/docs/03-RFQ/15-Bridging/quoteId.md
6-6: Unused link or image reference definition: "relay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
7-7: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
9-9: Unused link or image reference definition: "claim"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
13-13: Unused link or image reference definition: "bridgetransactionv2"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "relaying"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
28-28: Unused link or image reference definition: "exclusivity"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
30-30: Unused link or image reference definition: "user"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
33-33: Unused link or image reference definition: "relayer"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
35-35: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
docs/bridge/docs/03-RFQ/15-Bridging/zaps.md
6-6: Unused link or image reference definition: "relay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
7-7: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
9-9: Unused link or image reference definition: "claim"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
13-13: Unused link or image reference definition: "bridgetransactionv2"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "relaying"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
28-28: Unused link or image reference definition: "exclusivity"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
30-30: Unused link or image reference definition: "user"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
33-33: Unused link or image reference definition: "relayer"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
35-35: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
docs/bridge/docs/03-RFQ/20-Relaying/index.md
107-107: Expected: h2; Actual: h3
Heading levels should only increment by one level at a time
(MD001, heading-increment)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "relaying"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
35-35: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
docs/bridge/docs/03-RFQ/20-Relaying/riskFactors.md
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "relaying"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
28-28: Unused link or image reference definition: "exclusivity"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
35-35: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
docs/bridge/docs/03-RFQ/30-Proving/index.md
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
13-13: Unused link or image reference definition: "bridgetransactionv2"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
28-28: Unused link or image reference definition: "exclusivity"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
30-30: Unused link or image reference definition: "user"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
35-35: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
docs/bridge/docs/03-RFQ/40-Claiming/index.md
7-7: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
13-13: Unused link or image reference definition: "bridgetransactionv2"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "relaying"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
28-28: Unused link or image reference definition: "exclusivity"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
30-30: Unused link or image reference definition: "user"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
35-35: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
docs/bridge/docs/03-RFQ/50-Canceling/index.md
6-6: Unused link or image reference definition: "relay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
7-7: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
9-9: Unused link or image reference definition: "claim"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
13-13: Unused link or image reference definition: "bridgetransactionv2"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "relaying"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
28-28: Unused link or image reference definition: "exclusivity"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
33-33: Unused link or image reference definition: "relayer"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
docs/bridge/docs/03-RFQ/60-Security/index.md
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "relaying"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
28-28: Unused link or image reference definition: "exclusivity"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
30-30: Unused link or image reference definition: "user"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
35-35: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
docs/bridge/docs/03-RFQ/70-CanonicalRelayer/index.md
6-6: Unused link or image reference definition: "relay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
7-7: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
9-9: Unused link or image reference definition: "claim"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
13-13: Unused link or image reference definition: "bridgetransactionv2"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
28-28: Unused link or image reference definition: "exclusivity"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
30-30: Unused link or image reference definition: "user"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
33-33: Unused link or image reference definition: "relayer"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
35-35: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
152-152: Expected: dash; Actual: asterisk
Unordered list style
(MD004, ul-style)
docs/bridge/docs/03-RFQ/75-Exclusivity/index.md
7-7: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
9-9: Unused link or image reference definition: "claim"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "relaying"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
28-28: Unused link or image reference definition: "exclusivity"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
30-30: Unused link or image reference definition: "user"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
35-35: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
docs/bridge/docs/03-RFQ/90-Misc/index.md
46-46: Expected: h4; Actual: h5
Heading levels should only increment by one level at a time
(MD001, heading-increment)
40-40: Punctuation: ':'
Trailing punctuation in heading
(MD026, no-trailing-punctuation)
59-59: Punctuation: ':'
Trailing punctuation in heading
(MD026, no-trailing-punctuation)
6-6: Unused link or image reference definition: "relay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
7-7: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
9-9: Unused link or image reference definition: "claim"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "relaying"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
28-28: Unused link or image reference definition: "exclusivity"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
30-30: Unused link or image reference definition: "user"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
33-33: Unused link or image reference definition: "relayer"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
35-35: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
docs/bridge/docs/03-RFQ/index.md
159-159: Expected: h3; Actual: h4
Heading levels should only increment by one level at a time
(MD001, heading-increment)
157-157: null
Multiple spaces after hash on atx style heading
(MD019, no-multiple-space-atx)
13-13: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgetransactionv2"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
18-18: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
28-28: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
29-29: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
30-30: Unused link or image reference definition: "exclusivity"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
33-33: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
36-36: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
37-37: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
🔇 Additional comments (17)
docs/bridge/docs/03-RFQ/15-Bridging/zaps.md (2)
1-3: LGTM! Document structure follows best practices.
5-35: Skip comment as there's an existing review about unused reference links.
🧰 Tools
🪛 Markdownlint (0.35.0)
6-6: Unused link or image reference definition: "relay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
7-7: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
9-9: Unused link or image reference definition: "claim"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
13-13: Unused link or image reference definition: "bridgetransactionv2"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "relaying"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
28-28: Unused link or image reference definition: "exclusivity"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
30-30: Unused link or image reference definition: "user"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
33-33: Unused link or image reference definition: "relayer"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
35-35: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
docs/bridge/docs/03-RFQ/15-Bridging/quoteId.md (1)
1-3: LGTM!
The frontmatter is properly formatted with the appropriate title.
docs/bridge/docs/03-RFQ/50-Canceling/index.md (2)
37-51: LGTM! Documentation is comprehensive and well-structured.
The documentation effectively explains the cancellation process, covering:
- Basic cancellation flow
- Permissioned cancellation rules
- Prevention conditions
- Effects of cancellation
The content is clear, accurate, and aligns well with the PR objectives of improving RFQ documentation.
🧰 Tools
🪛 LanguageTool
[style] ~41-~41: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ... can also execute the [cancel] function prior to the cancellation delay, but only after ...
(EN_WORDINESS_PREMIUM_PRIOR_TO)
[uncategorized] ~51-~51: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ble with the bridge after a cancellation and it can be considered closed.
(COMMA_COMPOUND_SENTENCE)
5-36: LGTM! Consider verifying reference usage.
The reference links are well-organized and properly formatted. While static analysis flags many unused references, these might be used across other documentation files.
Let's verify the usage of these references across the documentation:
✅ Verification successful
All reference links are properly used and documented
The reference links section is well-organized and all links are actively used within the documentation content. The search results confirm that:
- All reference links defined at the top of the file are used within the main content
- References are used appropriately in context (e.g., [User], [cancel], [Cancel Delay], etc.)
- Links follow a consistent format and point to valid documentation paths
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Check for usage of reference links across documentation
# Note: Using grep to search for both [link-text] and [link-text]: patterns
for link in relay prove dispute claim cancel proof BridgeRequested BridgeTransactionV2 BridgeRelayed BridgeProofProvided "Cancel Delay" Multicall "Quoter API" "Dispute Period" Quoting Bridging Relaying Proving Claiming Canceling Security Exclusivity User Quoter Prover Relayer Guard Canceler; do
echo "Checking usage of [$link]:"
rg -l "\[$link\](?!\:)" docs/
echo "---"
done
Length of output: 18225
Script:
#!/bin/bash
# Let's try a simpler approach to find reference usage
# Search for markdown links in all documentation files
echo "Searching for reference usage in docs:"
rg --type md '\[[^\]]+\](?!\()' docs/
Length of output: 356
Script:
#!/bin/bash
# Let's try a simpler approach without negative lookahead
# First, find all markdown files
echo "Searching in markdown files:"
fd -e md -x cat {} \; -X echo "---" docs/
Length of output: 293
Script:
#!/bin/bash
# Let's try a simpler approach with just fd and cat
echo "Listing markdown files:"
fd -e md . docs/
echo -e "\nReading content of markdown files:"
for file in $(fd -e md . docs/); do
echo "=== $file ==="
cat "$file"
echo -e "\n---\n"
done
Length of output: 130494
Script:
#!/bin/bash
# Let's try a simpler approach to find reference usage
# Search for specific references in the content of the file
echo "Checking reference usage in the Canceling documentation:"
rg -p '\[(?:relay|prove|dispute|claim|cancel|proof|BridgeRequested|BridgeTransactionV2|BridgeRelayed|BridgeProofProvided|Cancel Delay|Multicall|Quoter API|Dispute Period|Quoting|Bridging|Relaying|Proving|Claiming|Canceling|Security|Exclusivity|User|Quoter|Prover|Relayer|Guard|Canceler)\]' docs/bridge/docs/03-RFQ/50-Canceling/
Length of output: 3641
🧰 Tools
🪛 Markdownlint (0.35.0)
6-6: Unused link or image reference definition: "relay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
7-7: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
9-9: Unused link or image reference definition: "claim"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
13-13: Unused link or image reference definition: "bridgetransactionv2"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "relaying"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
28-28: Unused link or image reference definition: "exclusivity"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
33-33: Unused link or image reference definition: "relayer"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
docs/bridge/docs/03-RFQ/40-Claiming/index.md (1)
62-65: Previous comment about expanding multicalling documentation is still valid
docs/bridge/docs/03-RFQ/90-Misc/index.md (2)
1-3: LGTM!
The frontmatter follows the standard documentation format.
5-36: Verify the usage of reference links across documentation.
The reference links are well-organized, but let's verify their usage across the documentation to ensure they're not orphaned.
✅ Verification successful
All reference links are actively used across the documentation
Based on the verification results, all reference links defined in docs/bridge/docs/03-RFQ/90-Misc/index.md are being actively used throughout the documentation files. The search results show that:
- Contract interface links (
[relay],[prove],[dispute], etc.) are referenced across multiple documentation sections - Event links (
[BridgeRequested],[BridgeTransactionV2],[BridgeRelayed],[BridgeProofProvided]) are used extensively - Documentation section links (
[Quoting],[Bridging], etc.) and entity links ([User],[Quoter], etc.) from the previous search are also referenced - Special links like
[Cancel Delay]and[Multicall]are properly utilized
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Check for usage of the defined reference links across documentation files
# Get all markdown files in the docs directory
echo "Searching for reference link usage in documentation files..."
for link in relay prove dispute claim cancel proof bridgerelayed bridgeproofprovided "cancel delay" multicall "quoter api" quoting bridging relaying proving claiming canceling security exclusivity user quoter prover relayer guard canceler; do
echo "Checking usage of [$link]..."
rg -l "\[$link\]" docs/
done
Length of output: 12815
Script:
#!/bin/bash
# Check for unused reference links defined in the file
echo "Checking for unused reference links..."
# Extract all defined reference links from the file
echo "Defined reference links:"
rg '^\[.*\]:' docs/bridge/docs/03-RFQ/90-Misc/index.md
# Check for BridgeRequested usage
echo "\nChecking [BridgeRequested] usage:"
rg -l '\[BridgeRequested\]' docs/
# Check for BridgeTransactionV2 usage
echo "\nChecking [BridgeTransactionV2] usage:"
rg -l '\[BridgeTransactionV2\]' docs/
# Check for BridgeRelayed usage
echo "\nChecking [BridgeRelayed] usage:"
rg -l '\[BridgeRelayed\]' docs/
# Check for BridgeProofProvided usage
echo "\nChecking [BridgeProofProvided] usage:"
rg -l '\[BridgeProofProvided\]' docs/
# Check for Cancel Delay usage
echo "\nChecking [Cancel Delay] usage:"
rg -l '\[Cancel Delay\]' docs/
# Check for Multicall usage
echo "\nChecking [Multicall] usage:"
rg -l '\[Multicall\]' docs/
Length of output: 7050
🧰 Tools
🪛 Markdownlint (0.35.0)
6-6: Unused link or image reference definition: "relay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
7-7: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
9-9: Unused link or image reference definition: "claim"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "relaying"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
28-28: Unused link or image reference definition: "exclusivity"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
30-30: Unused link or image reference definition: "user"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
33-33: Unused link or image reference definition: "relayer"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
35-35: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
docs/bridge/docs/03-RFQ/15-Bridging/index.md (2)
1-3: LGTM!
The document structure follows standard Markdown frontmatter conventions.
5-36: Verify reference link usage across documentation.
While many reference links are defined here, let's verify their usage across the documentation to ensure they're not orphaned.
✅ Verification successful
Reference links are actively used across documentation
The verification results show that most of the reference links are actively used throughout the documentation:
- Core action links (
[relay],[prove],[dispute],[claim],[cancel],[proof]) are used extensively across multiple documentation files - Contract/interface links (vercel-rfq-docs.vercel.app/contracts) are referenced in 15+ documentation files
- Some specialized links like
[bridgetransactionv2],[bridgerelayed],[bridgeproofprovided], and[cancel delay]appear to be unused, but they serve as important references to specific contract events and parameters
The reference links section serves its purpose as a centralized collection of links that are actively used throughout the documentation.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Check for usage of defined reference links across documentation
# Get all markdown files in the docs directory
echo "Searching for reference link usage in documentation..."
for link in "relay" "prove" "dispute" "claim" "cancel" "proof" "bridgetransactionv2" "bridgerelayed" "bridgeproofprovided" "cancel delay" "multicall" "quoter api" "dispute period" "bridging" "proving" "security" "quoter" "prover" "guard" "canceler"; do
echo "Checking usage of [$link]..."
rg -l "\[$link\](?!\:)" docs/
done
Length of output: 12063
Script:
#!/bin/bash
# Description: Check for usage of defined reference links across documentation using simpler regex patterns
# Get all markdown files in the docs directory
echo "Searching for reference link usage in documentation..."
for link in "relay" "prove" "dispute" "claim" "cancel" "proof" "bridgetransactionv2" "bridgerelayed" "bridgeproofprovided" "cancel delay" "multicall" "quoter api" "dispute period" "bridging" "proving" "security" "quoter" "prover" "guard" "canceler"; do
echo "Checking usage of [$link]..."
# Using a simpler pattern that matches markdown links
rg -l "\[$link\]" docs/
done
# Also check for the interface/contract links specifically
echo -e "\nChecking interface/contract links..."
rg -l "vercel-rfq-docs\.vercel\.app/contracts" docs/
Length of output: 12215
🧰 Tools
🪛 Markdownlint (0.35.0)
6-6: Unused link or image reference definition: "relay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
7-7: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
9-9: Unused link or image reference definition: "claim"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
13-13: Unused link or image reference definition: "bridgetransactionv2"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
35-35: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
docs/bridge/docs/03-RFQ/30-Proving/index.md (1)
5-36: LGTM! Well-organized reference links section.
The reference links are well-structured and follow a consistent pattern, providing a comprehensive set of links to related documentation.
🧰 Tools
🪛 Markdownlint (0.35.0)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
13-13: Unused link or image reference definition: "bridgetransactionv2"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
28-28: Unused link or image reference definition: "exclusivity"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
30-30: Unused link or image reference definition: "user"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
35-35: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
docs/bridge/docs/03-RFQ/10-Quoting/index.md (2)
48-48: Clarify FastBridge version compatibility
The current wording suggests Active Quoting is exclusive to FastBridgeV2, but it's also compatible with FastBridgeV1.
Consider rephrasing to clarify the compatibility:
-Starting with [Fast Bridge V2](https://vercel-rfq-docs.vercel.app/contracts/FastBridgeV2.sol/contract.FastBridgeV2.html), a new Active Quoting method has been introduced where a [Quoter] can listen and respond to live quote requests individually.
+Active Quoting is a method where a [Quoter] can listen and respond to live quote requests individually, supported by both FastBridge versions.62-67: Well-documented implementation guidance
The section effectively communicates quoter responsibilities and provides clear implementation guidance with practical examples.
docs/bridge/docs/03-RFQ/75-Exclusivity/index.md (1)
1-3: LGTM! Proper frontmatter structure.
The metadata is correctly formatted with the appropriate title for the documentation.
docs/bridge/docs/03-RFQ/20-Relaying/index.md (1)
1-119: Documentation is comprehensive and well-structured
The documentation provides a clear and thorough explanation of the relaying process in the Synapse RFQ System. It effectively covers all key aspects including detection, execution, permissions, and next steps.
🧰 Tools
🪛 LanguageTool
[style] ~63-~63: ‘Prior to’ might be wordy. Consider a shorter alternative.
Context: ...stination asset to deliver is an ERC20. Prior to calling [relay], the [Relayer] must hav...
(EN_WORDINESS_PREMIUM_PRIOR_TO)
🪛 Markdownlint (0.35.0)
107-107: Expected: h2; Actual: h3
Heading levels should only increment by one level at a time
(MD001, heading-increment)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "relaying"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
35-35: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
docs/bridge/docs/03-RFQ/index.md (1)
13-19: Verify the necessity of unused reference links
Several reference links are defined but not used in the document. Please verify if these links are needed:
[proof][BridgeRequested][BridgeTransactionV2][BridgeRelayed][BridgeProofProvided][Cancel Delay][Multicall]
🧰 Tools
🪛 Markdownlint (0.35.0)
13-13: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgetransactionv2"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
18-18: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
docs/bridge/docs/03-RFQ/70-CanonicalRelayer/index.md (1)
321-321: Expand sendChainGas documentation
The current documentation for sendChainGas is minimal. As noted in a previous review, this section would benefit from:
- A clearer explanation of the purpose and impact of this flag
- Examples of when to use it
- Documentation of potential implications of ignoring
sendChainGas
| ## FastBridge Contract Utilities | ||
|
|
||
|
|
||
| ### Call from Origin Chain: | ||
| <blockquote> | ||
| #### [canClaim](https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridge.sol/interface.IFastBridge.html#canclaim) | ||
|
|
||
| Checks if the [Dispute Period] has passed and the funds are now claimable | ||
|
|
||
| ##### [bridgeStatuses](https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridgeV2.sol/interface.IFastBridgeV2.html#bridgestatuses) | ||
|
|
||
| Returns the current [BridgeStatus](https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridgeV2.sol/interface.IFastBridgeV2.html#bridgestatus) of the indicated `transactionId` | ||
|
|
||
| ##### [bridgeProofs](https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridgeV2.sol/interface.IFastBridgeV2.html#bridgeproofs) | ||
|
|
||
| Returns the details of a bridge proof, including the asserted `relayer` | ||
|
|
||
| #### [getBridgeTransaction](https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridgeV2.sol/interface.IFastBridgeV2.html#getbridgetransactionv2) | ||
|
|
||
| Decodes request bytes (such as those emitted from a [BridgeRequested] event) into a [BridgeTransactionV2] struct. | ||
| </blockquote> | ||
|
|
||
| ### Call from Destination Chain: | ||
| <blockquote> | ||
| ##### [bridgeRelays](https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridgeV2.sol/interface.IFastBridgeV2.html#bridgerelays) | ||
|
|
||
| Checks if the indicated `transactionId` has already been relayed | ||
| </blockquote> |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Fix heading hierarchy for better documentation structure.
The heading levels are inconsistent, particularly in the contract utilities section. This affects documentation readability and navigation.
Apply these changes to maintain consistent heading hierarchy:
## FastBridge Contract Utilities
### Call from Origin Chain:
-##### [bridgeStatuses]
+#### [bridgeStatuses]
-##### [bridgeProofs]
+#### [bridgeProofs]
### Call from Destination Chain:
-##### [bridgeRelays]
+#### [bridgeRelays]📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ## FastBridge Contract Utilities | |
| ### Call from Origin Chain: | |
| <blockquote> | |
| #### [canClaim](https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridge.sol/interface.IFastBridge.html#canclaim) | |
| Checks if the [Dispute Period] has passed and the funds are now claimable | |
| ##### [bridgeStatuses](https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridgeV2.sol/interface.IFastBridgeV2.html#bridgestatuses) | |
| Returns the current [BridgeStatus](https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridgeV2.sol/interface.IFastBridgeV2.html#bridgestatus) of the indicated `transactionId` | |
| ##### [bridgeProofs](https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridgeV2.sol/interface.IFastBridgeV2.html#bridgeproofs) | |
| Returns the details of a bridge proof, including the asserted `relayer` | |
| #### [getBridgeTransaction](https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridgeV2.sol/interface.IFastBridgeV2.html#getbridgetransactionv2) | |
| Decodes request bytes (such as those emitted from a [BridgeRequested] event) into a [BridgeTransactionV2] struct. | |
| </blockquote> | |
| ### Call from Destination Chain: | |
| <blockquote> | |
| ##### [bridgeRelays](https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridgeV2.sol/interface.IFastBridgeV2.html#bridgerelays) | |
| Checks if the indicated `transactionId` has already been relayed | |
| </blockquote> | |
| ## FastBridge Contract Utilities | |
| ### Call from Origin Chain: | |
| <blockquote> | |
| #### [canClaim](https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridge.sol/interface.IFastBridge.html#canclaim) | |
| Checks if the [Dispute Period] has passed and the funds are now claimable | |
| #### [bridgeStatuses](https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridgeV2.sol/interface.IFastBridgeV2.html#bridgestatuses) | |
| Returns the current [BridgeStatus](https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridgeV2.sol/interface.IFastBridgeV2.html#bridgestatus) of the indicated `transactionId` | |
| #### [bridgeProofs](https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridgeV2.sol/interface.IFastBridgeV2.html#bridgeproofs) | |
| Returns the details of a bridge proof, including the asserted `relayer` | |
| #### [getBridgeTransaction](https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridgeV2.sol/interface.IFastBridgeV2.html#getbridgetransactionv2) | |
| Decodes request bytes (such as those emitted from a [BridgeRequested] event) into a [BridgeTransactionV2] struct. | |
| </blockquote> | |
| ### Call from Destination Chain: | |
| <blockquote> | |
| #### [bridgeRelays](https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridgeV2.sol/interface.IFastBridgeV2.html#bridgerelays) | |
| Checks if the indicated `transactionId` has already been relayed | |
| </blockquote> |
🧰 Tools
🪛 Markdownlint (0.35.0)
46-46: Expected: h4; Actual: h5
Heading levels should only increment by one level at a time
(MD001, heading-increment)
40-40: Punctuation: ':'
Trailing punctuation in heading
(MD026, no-trailing-punctuation)
59-59: Punctuation: ':'
Trailing punctuation in heading
(MD026, no-trailing-punctuation)
| ```typescript | ||
| import { ecsign, toBuffer, bufferToHex, hashPersonalMessage } from 'ethereumjs-util'; | ||
|
|
||
| async function signMessage(privateKey: string) { | ||
| const message = Math.floor(Date.now() / 1000).toString(); | ||
| const messageHash = hashPersonalMessage(Buffer.from(message)); | ||
| var { v, r, s } = ecsign(messageHash, toBuffer(privateKey)); | ||
|
|
||
| v -= 27 | ||
|
|
||
| const signature = Buffer.concat([r, s, Buffer.from([v])]); | ||
|
|
||
| return `${message}:${bufferToHex(signature)}`; | ||
| } | ||
| ``` |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Update authentication example
The authentication example could be improved in several ways:
- Use modern libraries like
ethers.jsinstead of deprecatedethereumjs-util - Add an example of using the generated signature in an API request
Consider updating the example:
import { ethers } from 'ethers';
async function signMessage(signer: ethers.Signer) {
const message = Math.floor(Date.now() / 1000).toString();
const signature = await signer.signMessage(message);
return `${message}:${signature}`;
}
// Example usage
async function authenticatedRequest(signer: ethers.Signer, endpoint: string) {
const auth = await signMessage(signer);
const response = await fetch(endpoint, {
headers: {
'Authorization': auth
}
});
return response;
}| ```yaml | ||
| database: | ||
| type: mysql # can be other mysql or sqlite | ||
| dsn: root:password@hostname:3306)/database?parseTime=true # should be the dsn of your database. If using sqlite, this can be a path | ||
| omnirpc_url: https://route-to-my-omnirpc # omnirpc route | ||
| bridges: | ||
| 1: '0x00......' # FastBridge address on ethereum (chain id: 1) | ||
| 10: '0x01....' # FastBridge address on op (chain id: 10) | ||
| port: '8081' # port to run your http server on | ||
| ``` |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Enhance configuration security and flexibility
The configuration example shows sensitive database credentials in plain text. Consider:
- Using environment variables for sensitive values
- Adding information about supported environment variables
- Providing a secure configuration example
Example secure configuration:
database:
type: mysql
dsn: ${DATABASE_DSN} # Use environment variable
omnirpc_url: ${OMNIRPC_URL}
bridges:
port: ${PORT:-8081} # Default to 8081 if not set|
|
||
| <b>Cancelers</b> <span style={{color: 'darkgray'}}><i>(Permissioned Role)</i></span> | ||
| <blockquote> | ||
| Able to manually pre-emptively cancel bridge requests which have been deposited, have not yet been relayed, and are past their relay deadline. |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Clarify Canceler role permissions
The description should explicitly state that Cancelers can only cancel requests that have expired with respect to their relay deadline.
- Able to manually pre-emptively cancel bridge requests which have been deposited, have not yet been relayed, and are past their relay deadline.
+ Able to manually cancel bridge requests which have been deposited, have not yet been relayed, and have expired (past their relay deadline).📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| Able to manually pre-emptively cancel bridge requests which have been deposited, have not yet been relayed, and are past their relay deadline. | |
| Able to manually cancel bridge requests which have been deposited, have not yet been relayed, and have expired (past their relay deadline). |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (2)
docs/bridge/docs/03-RFQ/10-Quoting/index.md (2)
52-52: Fix grammar issuesThere are two grammar issues in this sentence:
- Subject-verb agreement: "but allow" should be "but allows"
- Remove the comma before "if"
Apply this diff:
-Active quoting is more complicated to implement and maintain, but allow for more granular & customized quotes that can improve efficiency among other benefits. Quoters who prefer a simpler approach are free to use nothing but Passive Quotes, if they choose. +Active quoting is more complicated to implement and maintain but allows for more granular & customized quotes that can improve efficiency among other benefits. Quoters who prefer a simpler approach are free to use nothing but Passive Quotes if they choose.🧰 Tools
🪛 LanguageTool
[uncategorized] ~52-~52: This verb does not appear to agree with the subject. Consider using a different form.
Context: ...plicated to implement and maintain, but allow for more granular & customized quotes t...(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)
[typographical] ~52-~52: Usually, there’s no comma before “if”.
Context: ...e free to use nothing but Passive Quotes, if they choose. ## :::info To learn mor...(IF_NO_COMMA)
66-66: Consider breaking down the long sentence for better readabilityThe sentence about Quoter responsibilities is quite long and complex. Consider splitting it for better clarity.
Apply this diff:
-Quoters are responsible for keeping their quotes fresh and accurate. Likewise, they are responsible for completing their part of fulfillment for any transactions which act upon their quotes. To these effects, Quoters should push updates as rapidly as possible in reaction to consequential changes in prices, balances, etc. By default, the [Canonical Relayer](/docs/RFQ/CanonicalRelayer/) continuously updates quotes by checking on-chain balances, in-flight requests, and gas prices - custom implementations should take a similar approach. +Quoters are responsible for: +- Keeping their quotes fresh and accurate +- Completing their part of fulfillment for any transactions which act upon their quotes + +To achieve this, Quoters should push updates as rapidly as possible in reaction to consequential changes in prices, balances, etc. By default, the [Canonical Relayer](/docs/RFQ/CanonicalRelayer/) continuously updates quotes by checking: +- On-chain balances +- In-flight requests +- Gas prices + +Custom implementations should take a similar approach.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (1)
docs/bridge/docs/03-RFQ/10-Quoting/index.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/bridge/docs/03-RFQ/10-Quoting/index.md
[uncategorized] ~52-~52: This verb does not appear to agree with the subject. Consider using a different form.
Context: ...plicated to implement and maintain, but allow for more granular & customized quotes t...
(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)
[typographical] ~52-~52: Usually, there’s no comma before “if”.
Context: ...e free to use nothing but Passive Quotes, if they choose. ## :::info To learn mor...
(IF_NO_COMMA)
🪛 Markdownlint (0.35.0)
docs/bridge/docs/03-RFQ/10-Quoting/index.md
6-6: Unused link or image reference definition: "relay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
7-7: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
9-9: Unused link or image reference definition: "claim"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
13-13: Unused link or image reference definition: "bridgetransactionv2"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "relaying"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
28-28: Unused link or image reference definition: "exclusivity"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
33-33: Unused link or image reference definition: "relayer"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
35-35: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
🔇 Additional comments (3)
docs/bridge/docs/03-RFQ/10-Quoting/index.md (3)
38-40: LGTM! Clear and concise introduction
The overview effectively explains the RFQ system's purpose and the role of Quoters in the system.
42-44: LGTM! Clear explanation of Passive Quoting
The order book analogy effectively explains the passive quoting mechanism.
48-48: Update Active Quoting compatibility information
Based on previous discussions, Active Quoting is compatible with FastBridgeV1 as well. Consider rephrasing to avoid implying it's only available in the latest version.
docs/bridge/docs/03-RFQ/index.md
Outdated
| [BridgeTransactionV2]: https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridgeV2.sol/interface.IFastBridgeV2.html#bridgetransactionv2 | ||
| [BridgeRelayed]: https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridge.sol/interface.IFastBridge.html#bridgerelayed | ||
| [BridgeProofProvided]: https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridge.sol/interface.IFastBridge.html#bridgeproofprovided | ||
| [Cancel Delay]: https://vercel-rfq-docs.vercel.app/contracts/FastBridge.sol/contract.FastBridge.html#refund_delay |
There was a problem hiding this comment.
@parodime I think this would be more appropriate:
https://vercel-rfq-docs.vercel.app/contracts/AdminV2.sol/contract.AdminV2.html#canceldelay
There was a problem hiding this comment.
Actionable comments posted: 8
🧹 Outside diff range and nitpick comments (34)
docs/bridge/docs/03-RFQ/15-Bridging/zaps.md (1)
1-3: Consider enhancing front matter with metadataAdd descriptive metadata to improve documentation discoverability and context:
--- title: Zaps +description: Guide to using Zaps functionality in FastBridge +sidebar_position: 1 +tags: ['bridging', 'zaps', 'fastbridge'] ---docs/bridge/docs/03-RFQ/15-Bridging/quoteId.md (3)
5-36: Consider documenting the purpose of reference links or utilizing them in the content.While having a comprehensive set of reference links is valuable for documentation consistency, none of these links are currently used in the content. Consider either:
- Adding references to these links within the content where relevant
- Adding a comment explaining that these are shared references used across multiple documentation files
<!-- Reference Links --> +<!-- These reference links are shared across multiple documentation files for consistency --> [relay]: https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridgeV2.sol/interface.IFastBridgeV2.html#relayv2🧰 Tools
🪛 Markdownlint (0.35.0)
6-6: Unused link or image reference definition: "relay"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
7-7: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
9-9: Unused link or image reference definition: "claim"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
13-13: Unused link or image reference definition: "bridgetransactionv2"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "relaying"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
28-28: Unused link or image reference definition: "exclusivity"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
30-30: Unused link or image reference definition: "user"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
33-33: Unused link or image reference definition: "relayer"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
35-35: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
41-41: Fix grammatical issue with "however" usage.The sentence structure needs improvement.
-There is currently no on-chain functionality that utilizes this field, it is simply for record keeping and indexing, however this may change in the future. +There is currently no on-chain functionality that utilizes this field, it is simply for record keeping and indexing. However, this may change in the future.🧰 Tools
🪛 LanguageTool
[typographical] ~41-~41: The word “however” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence.
Context: ...s simply for record keeping and indexing, however this may change in the future.(HOWEVER_SENTENCE)
37-41: Consider enhancing the documentation with additional details.The current documentation provides basic information about
quoteId, but could be more helpful with:
- Example usage in bridge transactions
- Format requirements or constraints for the
quoteIdvalue- Best practices for generating and managing quote IDs
- Integration examples with off-chain quoting systems
Would you like me to help generate these additional documentation sections?
🧰 Tools
🪛 LanguageTool
[typographical] ~41-~41: The word “however” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence.
Context: ...s simply for record keeping and indexing, however this may change in the future.(HOWEVER_SENTENCE)
docs/bridge/docs/03-RFQ/50-Canceling/index.md (2)
41-41: Consider these style improvements for better readability
- Line 41: Replace "prior to" with "before" for conciseness
- Line 51: Add a comma before "and": "...after a cancellation, and it can be considered closed."
Also applies to: 51-51
🧰 Tools
🪛 LanguageTool
[style] ~41-~41: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ... can also execute the [cancel] function prior to the cancellation delay, but only after ...(EN_WORDINESS_PREMIUM_PRIOR_TO)
47-51: Consider adding information about pending quotesThe effects section should clarify what happens to any pending quotes when a cancellation occurs. Do they automatically become invalid? Should quoters be notified?
🧰 Tools
🪛 LanguageTool
[uncategorized] ~51-~51: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ble with the bridge after a cancellation and it can be considered closed.(COMMA_COMPOUND_SENTENCE)
docs/bridge/docs/03-RFQ/40-Claiming/index.md (2)
42-64: Add usage examples for both claim functionsWhile the function signatures and descriptions are clear, adding code examples would help developers understand how to use each function variant.
Consider adding examples like:
// Example for claimV2 bytes memory request = /* bridge request data */; fastBridgeV2.claimV2(request); // Example for claim bytes memory request = /* bridge request data */; address recipient = /* recipient address */; fastBridgeV2.claim(request, recipient);
71-73: Consider adding a bridge cycle diagramTo better illustrate the complete bridge cycle, consider adding a diagram showing the flow from bridge initiation through claiming. This would help users visualize where claiming fits in the overall process.
docs/bridge/docs/03-RFQ/90-Misc/index.md (3)
1-36: LGTM! Consider grouping reference links by categoryThe reference links are well-structured, but could be better organized with category comments.
Consider adding category comments to improve readability:
<!-- Reference Links --> +<!-- Contract Interface Links --> [relay]: https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridgeV2.sol/interface.IFastBridgeV2.html#relayv2 ... +<!-- Documentation Links --> [Quoter API]: /docs/RFQ/Quoting/Quoter%20API/ ... +<!-- Entity Links --> [User]: /docs/RFQ/#entities🧰 Tools
🪛 Markdownlint (0.35.0)
6-6: Unused link or image reference definition: "relay"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
7-7: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
9-9: Unused link or image reference definition: "claim"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "relaying"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
28-28: Unused link or image reference definition: "exclusivity"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
30-30: Unused link or image reference definition: "user"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
33-33: Unused link or image reference definition: "relayer"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
35-35: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
41-57: Consider using tables or lists instead of blockquotesThe current use of blockquotes for grouping related content could be improved. Tables or lists would provide better structure and readability for API documentation.
Consider this alternative structure:
### Call from Origin Chain | Method | Description | |--------|-------------| | [canClaim](link) | Checks if the [Dispute Period] has passed and the funds are now claimable | | [bridgeStatuses](link) | Returns the current [BridgeStatus] of the indicated `transactionId` | ...Also applies to: 60-64
🧰 Tools
🪛 Markdownlint (0.35.0)
46-46: Expected: h4; Actual: h5
Heading levels should only increment by one level at a time(MD001, heading-increment)
66-68: Enhance load tester documentation with usage examplesThe load testing tool documentation would be more helpful with setup instructions and usage examples.
Consider adding:
- Installation steps
- Configuration options
- Example commands
- Common use cases
- Performance considerations
Would you like me to help draft this additional documentation?
docs/bridge/docs/03-RFQ/15-Bridging/index.md (1)
66-66: Grammar: Improve preposition usageChange "on the destination" to "to the destination" for better clarity.
-[Claiming] occurs, which transfers the funds to the [Relayer] as reimbursement for completing the relay on the destination. +[Claiming] occurs, which transfers the funds to the [Relayer] as reimbursement for completing the relay to the destination.🧰 Tools
🪛 LanguageTool
[uncategorized] ~66-~66: The preposition ‘to’ seems more likely in this position.
Context: ... reimbursement for completing the relay on the destination. or - [Canceling] occ...(AI_HYDRA_LEO_REPLACE_ON_TO)
docs/bridge/docs/03-RFQ/30-Proving/index.md (3)
37-37: Improve sentence structure for better readabilityConsider restructuring the sentence for clarity:
- After [Relaying] successfully and observing that the [relay] transaction has finalized on the destination chain, [prove] transactions are executed by authorized Provers (who are typically also the [Relayer]) + After successful [Relaying] and confirmation that the [relay] transaction has finalized on the destination chain, authorized Provers (typically also the [Relayer]) execute [prove] transactions.
68-72: Enhance warning with specific security considerationsThe warning about transaction finality could be more detailed. Consider adding:
- Recommended number of block confirmations
- Potential consequences of premature proving
- Network-specific considerations (if any)
81-81: Fix typographical error- Following the [prove] transation, a [Dispute Period] begins + Following the [prove] transaction, a [Dispute Period] beginsdocs/bridge/docs/03-RFQ/60-Security/index.md (1)
74-74: Fix grammar in compound sentenceAdd a comma before "and" in the compound sentence.
-This allows for a new corrected [prove] to be submitted and the process begins again. +This allows for a new corrected [prove] to be submitted, and the process begins again.🧰 Tools
🪛 LanguageTool
[uncategorized] ~74-~74: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short).
Context: ... a new corrected [prove] to be submitted and the process begins again. If a [relay]...(COMMA_COMPOUND_SENTENCE_2)
docs/bridge/docs/03-RFQ/10-Quoting/index.md (2)
5-36: Consider documenting or cleaning up unused reference linksMany of the reference links defined in this section are currently unused in the document. While they might be used in other files or planned for future use, it would be helpful to either:
- Document their intended purpose with a comment, or
- Remove unused references to improve maintainability
🧰 Tools
🪛 Markdownlint (0.35.0)
6-6: Unused link or image reference definition: "relay"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
7-7: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
9-9: Unused link or image reference definition: "claim"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
13-13: Unused link or image reference definition: "bridgetransactionv2"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "relaying"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
28-28: Unused link or image reference definition: "exclusivity"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
33-33: Unused link or image reference definition: "relayer"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
35-35: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
52-52: Fix grammatical issueRemove the unnecessary comma before "if".
-Active quoting is more complicated to implement and maintain, but allow for more granular & customized quotes that can improve efficiency among other benefits. Quoters who prefer a simpler approach are free to use nothing but Passive Quotes, if they choose. +Active quoting is more complicated to implement and maintain, but allow for more granular & customized quotes that can improve efficiency among other benefits. Quoters who prefer a simpler approach are free to use nothing but Passive Quotes if they choose.🧰 Tools
🪛 LanguageTool
[typographical] ~52-~52: Usually, there’s no comma before “if”.
Context: ...e free to use nothing but Passive Quotes, if they choose. ## :::info To learn mor...(IF_NO_COMMA)
docs/bridge/docs/03-RFQ/75-Exclusivity/index.md (1)
57-58: Add security considerations for block timestamp usageThe documentation should include a note about potential security implications of using block timestamps:
- Block timestamps can be slightly manipulated by miners/validators
- Network congestion might affect the actual exclusivity duration
- Consider adding recommendations for safe timestamp margin calculations
Also applies to: 69-71
docs/bridge/docs/03-RFQ/20-Relaying/riskFactors.md (2)
48-48: Fix grammatical errorChange "can be come" to "become" for better readability.
-If a bridge transaction occurs that acts upon a quote issued by a particular [Relayer], and that [Relayer] fails to complete the [relay] transaction - the bridge deposit can be come "stuck" if there is no one to complete it. +If a bridge transaction occurs that acts upon a quote issued by a particular [Relayer], and that [Relayer] fails to complete the [relay] transaction - the bridge deposit can become "stuck" if there is no one to complete it.🧰 Tools
🪛 LanguageTool
[grammar] ~48-~48: Did you mean “become”?
Context: ...y] transaction - the bridge deposit can be come "stuck" if there is no one to complete ...(BE_COME)
52-52: Add missing commaAdd a comma before "and" in the compound sentence for better readability.
-All participating Relayers must ensure they are able to complete all bridge transactions that act upon their quotes and will be asked to quickly rectify any shortfalls. +All participating Relayers must ensure they are able to complete all bridge transactions that act upon their quotes, and will be asked to quickly rectify any shortfalls.🧰 Tools
🪛 LanguageTool
[style] ~52-~52: As a shorter alternative for ‘able to’, consider using “can”.
Context: ...participating Relayers must ensure they are able to complete all bridge transactions that a...(BE_ABLE_TO)
[uncategorized] ~52-~52: Possible missing comma found.
Context: ...bridge transactions that act upon their quotes and will be asked to quickly rectify an...(AI_HYDRA_LEO_MISSING_COMMA)
docs/bridge/docs/03-RFQ/20-Relaying/index.md (3)
61-61: Improve clarity of native currency explanationThe explanation of the native currency placeholder could be clearer.
-Additionally , if the `destToken` is the native currency of the chain (indicated by placeholder `0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE`) then that amount must also be set as the `msg.value` +Additionally, if the `destToken` is the native currency of the chain (using the standard placeholder address `0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE`), the transaction must include the exact token amount as `msg.value`
108-108: Add warning about multicall limitationConsider adding a warning box to emphasize this important limitation.
-However, the Multicall implementation is limited to non-payable transactions only, so native-gas bridges cannot be included in batches. +:::warning +The Multicall implementation is limited to non-payable transactions only. This means native-gas bridges cannot be included in batches. +:::
111-113: Add security context for permissionsConsider adding more context about why permissions are required and the security implications of the Prover role.
Add a brief explanation of the security model and why these permissions are necessary. For example:
Although relaying and claiming can be performed permissionlessly, in the current system Relayers will need to also operate a permissioned [Prover] role. + +This requirement ensures the integrity of the bridge system by maintaining a trusted network of provers who can verify the validity of cross-chain transactions.docs/bridge/docs/03-RFQ/10-Quoting/Quoter API/index.md (5)
6-37: Clean up unused reference linksMany reference links are defined but not used in the document. Consider removing unused links to improve maintainability.
🧰 Tools
🪛 Markdownlint (0.35.0)
7-7: Unused link or image reference definition: "relay"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
9-9: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "claim"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
13-13: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgetransactionv2"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
18-18: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
28-28: Unused link or image reference definition: "security"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
29-29: Unused link or image reference definition: "exclusivity"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "user"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
33-33: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "relayer"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
35-35: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
36-36: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
55-84: Consider adding example requests for each endpointWhile the endpoints are well-documented, adding curl commands or code snippets showing example requests would make the documentation more practical.
Example format:
# Example for GET /quotes curl -X GET "https://api.synapseprotocol.com/quotes?chain_id=1" \ -H "Accept: application/json"🧰 Tools
🪛 Markdownlint (0.35.0)
57-57: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
64-64: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
76-76: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
81-81: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
100-106: Add language specifiers to code blocksAdd JSON language specifiers to the code blocks to enable syntax highlighting:
- ``` + ```json { "op": "string", "content": "json", "success": "bool" }Also applies to: 110-121, 125-130
🧰 Tools
🪛 Markdownlint (0.35.0)
100-100: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
178-178: Fix typo in hosting descriptionRemove duplicate word "the":
-hosted by the the interface +hosted by the interface🧰 Tools
🪛 LanguageTool
[duplication] ~178-~178: Possible typo: you repeated a word
Context: ...d to use a Quoter API that is hosted by the the interface they are quoting for. For exa...(ENGLISH_WORD_REPEAT_RULE)
213-221: Enhance Docker setup instructionsConsider adding:
- Volume mounting instructions for the config file
- Environment variable configuration option
- Health check information
Example:
# Mount config file and set environment variables docker run -v $(pwd)/config.yaml:/app/config.yaml \ -e DATABASE_DSN="root:password@tcp(db:3306)/rfq" \ ghcr.io/synapsecns/sanguine/rfq-api:latest --config /app/config.yaml🧰 Tools
🪛 LanguageTool
[style] ~215-~215: Consider a more expressive alternative.
Context: ...ter API can also be run with docker. To do this, you will need to build the docker...(DO_ACHIEVE)
🪛 Markdownlint (0.35.0)
213-213: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
docs/bridge/docs/03-RFQ/index.md (2)
146-148: Improve conciseness in contract descriptionThe sentence could be more concise while maintaining its meaning.
-[Synapse FastBridge contracts](/docs/Contracts/RFQ) facilitate and enforce all of the on-chain functionality and security of the system. +[Synapse FastBridge contracts](/docs/Contracts/RFQ) facilitate and enforce the on-chain functionality and security of the system.🧰 Tools
🪛 LanguageTool
[style] ~146-~146: Consider removing “of” to be more concise
Context: ...s/Contracts/RFQ) facilitate and enforce all of the on-chain functionality and security of ...(ALL_OF_THE)
157-159: Fix heading hierarchyThe heading structure jumps from h2 to h4, which breaks the document hierarchy. Consider using h3 for the flow summary sections.
-## Flow Summary - -#### [Quoting] +## Flow Summary + +### [Quoting]🧰 Tools
🪛 Markdownlint (0.35.0)
159-159: Expected: h3; Actual: h4
Heading levels should only increment by one level at a time(MD001, heading-increment)
157-157: null
Multiple spaces after hash on atx style heading(MD019, no-multiple-space-atx)
docs/bridge/docs/03-RFQ/70-CanonicalRelayer/index.md (3)
47-47: Add a comma after "Synapse"Add a comma to improve readability: "...built and operated by Synapse, which performs..."
-The Canonical RFQ Relayer is the official relayer app built and operated by Synapse which performs all necessary automated functions that are necessary for a Relayer participating in the Synapse RFQ network. +The Canonical RFQ Relayer is the official relayer app built and operated by Synapse, which performs all necessary automated functions that are necessary for a Relayer participating in the Synapse RFQ network.🧰 Tools
🪛 LanguageTool
[uncategorized] ~47-~47: Possible missing comma found.
Context: ...icial relayer app built and operated by Synapse which performs all necessary automated ...(AI_HYDRA_LEO_MISSING_COMMA)
72-72: Implement time parameter for future fund availabilityThe TODO comment suggests adding a
timeparameter to enable quoting of funds that will be available in the future. This could improve liquidity management.Would you like me to help implement this feature or create a GitHub issue to track this enhancement?
136-136: Implement auto-generation for configuration documentationThe TODO comment suggests implementing documentation auto-generation similar to OpenAPI. This would help maintain consistency between code and documentation.
Would you like me to help implement the auto-generation feature or create a GitHub issue to track this enhancement?
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (15)
docs/bridge/docs/03-RFQ/10-Quoting/Quoter API/index.md(1 hunks)docs/bridge/docs/03-RFQ/10-Quoting/index.md(1 hunks)docs/bridge/docs/03-RFQ/15-Bridging/index.md(1 hunks)docs/bridge/docs/03-RFQ/15-Bridging/quoteId.md(1 hunks)docs/bridge/docs/03-RFQ/15-Bridging/zaps.md(1 hunks)docs/bridge/docs/03-RFQ/20-Relaying/index.md(1 hunks)docs/bridge/docs/03-RFQ/20-Relaying/riskFactors.md(1 hunks)docs/bridge/docs/03-RFQ/30-Proving/index.md(1 hunks)docs/bridge/docs/03-RFQ/40-Claiming/index.md(1 hunks)docs/bridge/docs/03-RFQ/50-Canceling/index.md(1 hunks)docs/bridge/docs/03-RFQ/60-Security/index.md(1 hunks)docs/bridge/docs/03-RFQ/70-CanonicalRelayer/index.md(5 hunks)docs/bridge/docs/03-RFQ/75-Exclusivity/index.md(1 hunks)docs/bridge/docs/03-RFQ/90-Misc/index.md(1 hunks)docs/bridge/docs/03-RFQ/index.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/bridge/docs/03-RFQ/10-Quoting/Quoter API/index.md
[duplication] ~178-~178: Possible typo: you repeated a word
Context: ...d to use a Quoter API that is hosted by the the interface they are quoting for. For exa...
(ENGLISH_WORD_REPEAT_RULE)
[typographical] ~200-~200: It seems that a comma is missing.
Context: ...lite, this can be a path, if using mysql please see [here](https://dev.mysql.com/doc/co...
(IF_PLEASE_COMMA)
[style] ~215-~215: Consider a more expressive alternative.
Context: ...ter API can also be run with docker. To do this, you will need to build the docker...
(DO_ACHIEVE)
docs/bridge/docs/03-RFQ/10-Quoting/index.md
[typographical] ~52-~52: Usually, there’s no comma before “if”.
Context: ...e free to use nothing but Passive Quotes, if they choose. ## :::info To learn mor...
(IF_NO_COMMA)
docs/bridge/docs/03-RFQ/15-Bridging/index.md
[uncategorized] ~66-~66: The preposition ‘to’ seems more likely in this position.
Context: ... reimbursement for completing the relay on the destination. or - [Canceling] occ...
(AI_HYDRA_LEO_REPLACE_ON_TO)
docs/bridge/docs/03-RFQ/15-Bridging/quoteId.md
[typographical] ~41-~41: The word “however” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence.
Context: ...s simply for record keeping and indexing, however this may change in the future.
(HOWEVER_SENTENCE)
docs/bridge/docs/03-RFQ/20-Relaying/index.md
[style] ~63-~63: ‘Prior to’ might be wordy. Consider a shorter alternative.
Context: ...stination asset to deliver is an ERC20. Prior to calling [relay], the [Relayer] must hav...
(EN_WORDINESS_PREMIUM_PRIOR_TO)
docs/bridge/docs/03-RFQ/20-Relaying/riskFactors.md
[grammar] ~48-~48: Did you mean “become”?
Context: ...y] transaction - the bridge deposit can be come "stuck" if there is no one to complete ...
(BE_COME)
[grammar] ~50-~50: Do not use an adverb of manner between a verb and its direct object.
Context: ...ds are safe in these instances and will eventually either be cancelled & refunded or compl...
(MD_RB_DT)
[style] ~52-~52: As a shorter alternative for ‘able to’, consider using “can”.
Context: ...participating Relayers must ensure they are able to complete all bridge transactions that a...
(BE_ABLE_TO)
[uncategorized] ~52-~52: Possible missing comma found.
Context: ...bridge transactions that act upon their quotes and will be asked to quickly rectify an...
(AI_HYDRA_LEO_MISSING_COMMA)
docs/bridge/docs/03-RFQ/30-Proving/index.md
[grammar] ~45-~45: The word ‘prove’ is a verb. Did you mean the noun “proof”?
Context: ... Options There are two versions of the prove function in FastBridgeV2. Relayers can ...
(PREPOSITION_VERB)
docs/bridge/docs/03-RFQ/50-Canceling/index.md
[style] ~41-~41: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ... can also execute the [cancel] function prior to the cancellation delay, but only after ...
(EN_WORDINESS_PREMIUM_PRIOR_TO)
[uncategorized] ~51-~51: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ble with the bridge after a cancellation and it can be considered closed.
(COMMA_COMPOUND_SENTENCE)
docs/bridge/docs/03-RFQ/60-Security/index.md
[grammar] ~52-~52: The word ‘prove’ is a verb. Did you mean the noun “proof”?
Context: ..._period) begins. During this time, the prove/proof is eligible to be dispuated by [G...
(PREPOSITION_VERB)
[uncategorized] ~74-~74: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short).
Context: ... a new corrected [prove] to be submitted and the process begins again. If a [relay]...
(COMMA_COMPOUND_SENTENCE_2)
docs/bridge/docs/03-RFQ/70-CanonicalRelayer/index.md
[uncategorized] ~47-~47: Possible missing comma found.
Context: ...icial relayer app built and operated by Synapse which performs all necessary automated ...
(AI_HYDRA_LEO_MISSING_COMMA)
docs/bridge/docs/03-RFQ/index.md
[style] ~41-~41: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ... Synapse RFQ (Request-For-Quote) is an <abbr title="'Intent' refers to a user authorizing specific actions that they want to achieve, typically in very simple terms, such as a bridge or swap. Actual...
(EN_WEAK_ADJECTIVE)
[style] ~146-~146: Consider removing “of” to be more concise
Context: ...s/Contracts/RFQ) facilitate and enforce all of the on-chain functionality and security of ...
(ALL_OF_THE)
🪛 Markdownlint (0.35.0)
docs/bridge/docs/03-RFQ/10-Quoting/Quoter API/index.md
173-173: Expected: 0; Actual: 1
Unordered list indentation
(MD007, ul-indent)
174-174: Expected: 0; Actual: 1
Unordered list indentation
(MD007, ul-indent)
176-176: Punctuation: ':'
Trailing punctuation in heading
(MD026, no-trailing-punctuation)
57-57: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
64-64: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
76-76: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
81-81: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
213-213: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
100-100: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
110-110: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
125-125: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
7-7: Unused link or image reference definition: "relay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
9-9: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "claim"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
13-13: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgetransactionv2"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
18-18: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
28-28: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
29-29: Unused link or image reference definition: "exclusivity"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "user"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
33-33: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "relayer"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
35-35: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
36-36: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
docs/bridge/docs/03-RFQ/10-Quoting/index.md
6-6: Unused link or image reference definition: "relay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
7-7: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
9-9: Unused link or image reference definition: "claim"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
13-13: Unused link or image reference definition: "bridgetransactionv2"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "relaying"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
28-28: Unused link or image reference definition: "exclusivity"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
33-33: Unused link or image reference definition: "relayer"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
35-35: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
docs/bridge/docs/03-RFQ/15-Bridging/index.md
6-6: Unused link or image reference definition: "relay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
7-7: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
9-9: Unused link or image reference definition: "claim"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
13-13: Unused link or image reference definition: "bridgetransactionv2"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
35-35: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
docs/bridge/docs/03-RFQ/15-Bridging/quoteId.md
6-6: Unused link or image reference definition: "relay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
7-7: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
9-9: Unused link or image reference definition: "claim"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
13-13: Unused link or image reference definition: "bridgetransactionv2"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "relaying"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
28-28: Unused link or image reference definition: "exclusivity"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
30-30: Unused link or image reference definition: "user"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
33-33: Unused link or image reference definition: "relayer"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
35-35: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
docs/bridge/docs/03-RFQ/15-Bridging/zaps.md
6-6: Unused link or image reference definition: "relay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
7-7: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
9-9: Unused link or image reference definition: "claim"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
13-13: Unused link or image reference definition: "bridgetransactionv2"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "relaying"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
28-28: Unused link or image reference definition: "exclusivity"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
30-30: Unused link or image reference definition: "user"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
33-33: Unused link or image reference definition: "relayer"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
35-35: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
docs/bridge/docs/03-RFQ/20-Relaying/index.md
110-110: Expected: h2; Actual: h3
Heading levels should only increment by one level at a time
(MD001, heading-increment)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "relaying"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
35-35: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
docs/bridge/docs/03-RFQ/20-Relaying/riskFactors.md
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "relaying"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
28-28: Unused link or image reference definition: "exclusivity"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
35-35: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
docs/bridge/docs/03-RFQ/30-Proving/index.md
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
13-13: Unused link or image reference definition: "bridgetransactionv2"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
28-28: Unused link or image reference definition: "exclusivity"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
30-30: Unused link or image reference definition: "user"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
35-35: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
docs/bridge/docs/03-RFQ/40-Claiming/index.md
7-7: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
13-13: Unused link or image reference definition: "bridgetransactionv2"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "relaying"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
28-28: Unused link or image reference definition: "exclusivity"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
30-30: Unused link or image reference definition: "user"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
35-35: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
docs/bridge/docs/03-RFQ/50-Canceling/index.md
6-6: Unused link or image reference definition: "relay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
7-7: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
9-9: Unused link or image reference definition: "claim"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
13-13: Unused link or image reference definition: "bridgetransactionv2"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "relaying"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
28-28: Unused link or image reference definition: "exclusivity"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
33-33: Unused link or image reference definition: "relayer"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
docs/bridge/docs/03-RFQ/60-Security/index.md
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "relaying"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
28-28: Unused link or image reference definition: "exclusivity"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
30-30: Unused link or image reference definition: "user"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
35-35: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
docs/bridge/docs/03-RFQ/70-CanonicalRelayer/index.md
6-6: Unused link or image reference definition: "relay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
7-7: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
9-9: Unused link or image reference definition: "claim"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
13-13: Unused link or image reference definition: "bridgetransactionv2"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
28-28: Unused link or image reference definition: "exclusivity"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
30-30: Unused link or image reference definition: "user"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
33-33: Unused link or image reference definition: "relayer"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
35-35: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
152-152: Expected: dash; Actual: asterisk
Unordered list style
(MD004, ul-style)
docs/bridge/docs/03-RFQ/75-Exclusivity/index.md
7-7: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
9-9: Unused link or image reference definition: "claim"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "relaying"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
28-28: Unused link or image reference definition: "exclusivity"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
30-30: Unused link or image reference definition: "user"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
35-35: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
docs/bridge/docs/03-RFQ/90-Misc/index.md
46-46: Expected: h4; Actual: h5
Heading levels should only increment by one level at a time
(MD001, heading-increment)
40-40: Punctuation: ':'
Trailing punctuation in heading
(MD026, no-trailing-punctuation)
59-59: Punctuation: ':'
Trailing punctuation in heading
(MD026, no-trailing-punctuation)
6-6: Unused link or image reference definition: "relay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
7-7: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
9-9: Unused link or image reference definition: "claim"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "relaying"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
28-28: Unused link or image reference definition: "exclusivity"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
30-30: Unused link or image reference definition: "user"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
33-33: Unused link or image reference definition: "relayer"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
35-35: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
docs/bridge/docs/03-RFQ/index.md
159-159: Expected: h3; Actual: h4
Heading levels should only increment by one level at a time
(MD001, heading-increment)
157-157: null
Multiple spaces after hash on atx style heading
(MD019, no-multiple-space-atx)
13-13: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgetransactionv2"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
18-18: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
28-28: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
29-29: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
30-30: Unused link or image reference definition: "exclusivity"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
33-33: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
36-36: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
37-37: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
🔇 Additional comments (24)
docs/bridge/docs/03-RFQ/15-Bridging/zaps.md (1)
5-35: Reference links are well-organized but unused
🧰 Tools
🪛 Markdownlint (0.35.0)
6-6: Unused link or image reference definition: "relay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
7-7: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
9-9: Unused link or image reference definition: "claim"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
13-13: Unused link or image reference definition: "bridgetransactionv2"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "relaying"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
28-28: Unused link or image reference definition: "exclusivity"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
30-30: Unused link or image reference definition: "user"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
33-33: Unused link or image reference definition: "relayer"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
35-35: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
docs/bridge/docs/03-RFQ/15-Bridging/quoteId.md (1)
1-3: LGTM!
The frontmatter is properly formatted and the title accurately reflects the content.
docs/bridge/docs/03-RFQ/50-Canceling/index.md (1)
37-51: Documentation accurately describes the cancellation process
The content provides a clear and technically accurate description of:
- Conditions for cancellation
- Role of the Canceler entity
- Security considerations (proof verification)
- Effects of cancellation
🧰 Tools
🪛 LanguageTool
[style] ~41-~41: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ... can also execute the [cancel] function prior to the cancellation delay, but only after ...
(EN_WORDINESS_PREMIUM_PRIOR_TO)
[uncategorized] ~51-~51: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ble with the bridge after a cancellation and it can be considered closed.
(COMMA_COMPOUND_SENTENCE)
docs/bridge/docs/03-RFQ/40-Claiming/index.md (3)
37-40: LGTM! Clear and concise process description
The description effectively explains the claiming process, its timing, and purpose.
66-69: Expand the multicalling documentation
5-36: Verify the validity of reference links
Please verify that all reference links are valid and accessible. Consider removing unused references if they're not needed elsewhere in the documentation.
🧰 Tools
🪛 Markdownlint (0.35.0)
7-7: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
13-13: Unused link or image reference definition: "bridgetransactionv2"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "relaying"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
28-28: Unused link or image reference definition: "exclusivity"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
30-30: Unused link or image reference definition: "user"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
35-35: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
docs/bridge/docs/03-RFQ/15-Bridging/index.md (2)
38-79: LGTM! Well-structured and comprehensive documentation
The documentation is well-organized with clear sections covering:
- Bridge transaction construction process
- Integration options (SDK and REST API)
- Exclusivity feature in FastBridgeV2
- Transaction effects and fund flow
- Next steps for relayers
The technical content is accurate and provides valuable information for integrators.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~66-~66: The preposition ‘to’ seems more likely in this position.
Context: ... reimbursement for completing the relay on the destination. or - [Canceling] occ...
(AI_HYDRA_LEO_REPLACE_ON_TO)
5-36: Verify the necessity of reference links
While many reference links are defined but not directly used in this file, they might be used in other documentation files. Consider:
- Removing truly unused references to maintain documentation cleanliness
- Adding a comment explaining that these links serve as a centralized reference if that's the case
🧰 Tools
🪛 Markdownlint (0.35.0)
6-6: Unused link or image reference definition: "relay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
7-7: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
9-9: Unused link or image reference definition: "claim"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
13-13: Unused link or image reference definition: "bridgetransactionv2"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
35-35: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
docs/bridge/docs/03-RFQ/60-Security/index.md (4)
38-45: Enhance technical documentation of the proof mechanism
Referencing previous review comment requesting enhancement of technical details including:
- Specific technical details about proof validation
- Examples of valid vs invalid proofs
- Cryptographic mechanisms
- Timing constraints
57-68: Expand Guards section with implementation details
Referencing previous review comment requesting additional information about Guards:
- Guard eligibility and permissions
- Technical requirements
- Incentivization model
- Failure handling
76-76: Expand invalid relay documentation
Referencing previous review comment requesting expansion of invalid relay documentation with:
- Security implications
- Penalties for invalid proofs
- Spam prevention mechanisms
5-36: Verify necessity of unused reference links
Several reference links appear to be unused in this document. While they might be used in other files, consider removing unused ones to maintain documentation cleanliness.
✅ Verification successful
All reference links are actively used across documentation
Based on the comprehensive search results, all reference links defined in the Security documentation are actively used throughout the RFQ documentation system. Each link serves a specific purpose:
- Contract interface links (relay, prove, dispute, etc.) are used to reference API documentation
- Event links (BridgeRequested, BridgeRelayed, etc.) are used to document event emissions
- Cross-documentation links (Quoting, Bridging, etc.) are used for navigation between sections
- Entity links (User, Quoter, etc.) are used to reference role definitions
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Check for usage of reference links across documentation
# Get list of potentially unused links
LINKS=("cancel" "bridgerequested" "bridgerelayed" "bridgeproofprovided" "cancel delay" "multicall" "quoter api" "dispute period" "quoting" "bridging" "relaying" "proving" "claiming" "canceling" "security" "exclusivity" "user" "quoter" "prover" "canceler")
# Search for usage of these links in markdown files
for link in "${LINKS[@]}"; do
echo "Checking usage of [$link]..."
rg -l "\[$link\]" "docs/"
done
Length of output: 3627
Script:
#!/bin/bash
# Let's check for usage of the remaining reference links that weren't found in the first search
# These are contract interface links that might be used in the documentation
LINKS=(
"\[relay\]"
"\[prove\]"
"\[dispute\]"
"\[claim\]"
"\[proof\]"
"\[BridgeRequested\]"
"\[BridgeTransactionV2\]"
"\[BridgeRelayed\]"
"\[BridgeProofProvided\]"
"\[Cancel Delay\]"
"\[Multicall\]"
)
for link in "${LINKS[@]}"; do
echo "Checking usage of $link..."
rg "$link" "docs/" || echo "No matches found for $link"
done
Length of output: 48507
🧰 Tools
🪛 Markdownlint (0.35.0)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "relaying"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
28-28: Unused link or image reference definition: "exclusivity"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
30-30: Unused link or image reference definition: "user"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
35-35: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
docs/bridge/docs/03-RFQ/10-Quoting/index.md (1)
38-67: Well-structured and comprehensive documentation
The documentation effectively explains the quoting functionality, different quoting methods, and their implications. The content is clear, informative, and provides good guidance for integrators.
🧰 Tools
🪛 LanguageTool
[typographical] ~52-~52: Usually, there’s no comma before “if”.
Context: ...e free to use nothing but Passive Quotes, if they choose. ## :::info To learn mor...
(IF_NO_COMMA)
docs/bridge/docs/03-RFQ/75-Exclusivity/index.md (2)
1-3: LGTM!
The frontmatter is correctly formatted.
5-35: Consider cleaning up unused reference links
While having a comprehensive set of reference links is good for future use, consider removing unused ones to maintain cleaner documentation. Let's verify which links are actually used in the current documentation.
🧰 Tools
🪛 Markdownlint (0.35.0)
7-7: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
9-9: Unused link or image reference definition: "claim"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "relaying"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
28-28: Unused link or image reference definition: "exclusivity"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
30-30: Unused link or image reference definition: "user"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
35-35: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
docs/bridge/docs/03-RFQ/20-Relaying/riskFactors.md (2)
38-44: LGTM! Clear and effective warning notice
The warning section effectively communicates the importance of understanding risks and responsibilities for Relayers.
56-56: LGTM! Consistent RFQ Indexer references
The documentation consistently references the RFQ Indexer API for monitoring and tracking various aspects of the system, which helps guide users to the appropriate tools.
Also applies to: 66-66, 90-90
docs/bridge/docs/03-RFQ/10-Quoting/Quoter API/index.md (3)
38-51: LGTM! Clear introduction and scope definition
The introduction effectively communicates the target audience and purpose of the documentation.
134-144: LGTM! Clear version change management documentation
The section effectively explains version change detection and user responsibilities.
151-165: Previous review comment about updating authentication example is still valid
docs/bridge/docs/03-RFQ/index.md (1)
39-88: LGTM! Clear and comprehensive flow documentation
The RFQ summary and end-to-end flow explanation is well-structured and provides a clear understanding of the system's operation.
🧰 Tools
🪛 LanguageTool
[style] ~41-~41: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ... Synapse RFQ (Request-For-Quote) is an <abbr title="'Intent' refers to a user authorizing specific actions that they want to achieve, typically in very simple terms, such as a bridge or swap. Actual...
(EN_WEAK_ADJECTIVE)
docs/bridge/docs/03-RFQ/70-CanonicalRelayer/index.md (3)
75-91: Well-documented state machine
The state transitions are clearly documented with comprehensive descriptions for each state.
Line range hint 93-132: Comprehensive rebalancing documentation
The rebalancing logic is well-explained with practical examples and special cases.
321-321: Improve sendChainGas documentation
The previous review comment about improving the sendChainGas documentation is still valid.
| [Guard]: /docs/RFQ/#entities | ||
| [Canceler]: /docs/RFQ/#entities | ||
|
|
||
| # WIP |
There was a problem hiding this comment.
Document requires comprehensive content structure
Based on the PR objectives and previous feedback, please add these essential sections:
-
Overview
# Overview Zaps enable atomic token bridging with additional actions on the destination chain, including gas provisioning and smart contract interactions. -
Core Features
# Core Features ## ZapNative - Request additional gas on destination chain - Compatible with EOA recipients - Restrictions with `0xEEEE` destination token ## ZapData - Smart contract integration via `IZapRecipient` - Atomic execution guarantee - Data encoding requirements
-
Integration Guide
# Integration Guide ## Smart Contract Requirements - Implementing `IZapRecipient` - Handling token amounts - Combined ZapNative and ZapData usage
-
Security Considerations
# Security ## Transaction Safety - Atomic execution guarantees - Fallback mechanisms - Cancellation process
Would you like me to help draft the content for any of these sections?
| After a [prove] transaction is posted and the [proof] data is set, a window of time called the [Dispute Period](https://vercel-rfq-docs.vercel.app/contracts/FastBridgeV2.sol/contract.FastBridgeV2.html#dispute_period) begins. | ||
|
|
||
| During this time, the prove/proof is eligible to be dispuated by [Guard] entities. | ||
|
|
||
| After the [Dispute Period](https://vercel-rfq-docs.vercel.app/contracts/FastBridgeV2.sol/contract.FastBridgeV2.html#dispute_period) has passed without any disputes, the funds in escrow from the original bridge transaction can be released via a [claim] transaction, which will reimburse the rightful [Relayer]. |
There was a problem hiding this comment.
Fix typo and standardize terminology
There are two issues in this section:
- Line 52: "dispuated" should be "disputed"
- Inconsistent use of "prove/proof" terminology
Apply this diff:
-During this time, the prove/proof is eligible to be dispuated by [Guard] entities.
+During this time, the proof is eligible to be disputed by [Guard] entities.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| After a [prove] transaction is posted and the [proof] data is set, a window of time called the [Dispute Period](https://vercel-rfq-docs.vercel.app/contracts/FastBridgeV2.sol/contract.FastBridgeV2.html#dispute_period) begins. | |
| During this time, the prove/proof is eligible to be dispuated by [Guard] entities. | |
| After the [Dispute Period](https://vercel-rfq-docs.vercel.app/contracts/FastBridgeV2.sol/contract.FastBridgeV2.html#dispute_period) has passed without any disputes, the funds in escrow from the original bridge transaction can be released via a [claim] transaction, which will reimburse the rightful [Relayer]. | |
| After a [prove] transaction is posted and the [proof] data is set, a window of time called the [Dispute Period](https://vercel-rfq-docs.vercel.app/contracts/FastBridgeV2.sol/contract.FastBridgeV2.html#dispute_period) begins. | |
| During this time, the proof is eligible to be disputed by [Guard] entities. | |
| After the [Dispute Period](https://vercel-rfq-docs.vercel.app/contracts/FastBridgeV2.sol/contract.FastBridgeV2.html#dispute_period) has passed without any disputes, the funds in escrow from the original bridge transaction can be released via a [claim] transaction, which will reimburse the rightful [Relayer]. |
🧰 Tools
🪛 LanguageTool
[grammar] ~52-~52: The word ‘prove’ is a verb. Did you mean the noun “proof”?
Context: ..._period) begins. During this time, the prove/proof is eligible to be dispuated by [G...
(PREPOSITION_VERB)
|
|
||
| ## [Active Quoting](/docs/RFQ/Quoting/Quoter%20API/#active-quotes) | ||
|
|
||
| In our latest version of the [Quoter API], a new Active Quoting method has been introduced where a [Quoter] can listen and respond to live quote requests individually. |
There was a problem hiding this comment.
Clarify version compatibility for Active Quoting
The current wording might mislead users about version compatibility. Active quoting works with both FastBridgeV1 and V2.
-In our latest version of the [Quoter API], a new Active Quoting method has been introduced where a [Quoter] can listen and respond to live quote requests individually.
+The [Quoter API] supports an Active Quoting method where a [Quoter] can listen and respond to live quote requests individually. This feature is compatible with both FastBridgeV1 and V2.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| In our latest version of the [Quoter API], a new Active Quoting method has been introduced where a [Quoter] can listen and respond to live quote requests individually. | |
| The [Quoter API] supports an Active Quoting method where a [Quoter] can listen and respond to live quote requests individually. This feature is compatible with both FastBridgeV1 and V2. |
| Starting with FastBridgeV2, specific Relayers can optionally be granted temporary exclusive rights to be the first to complete a [relay] for a given bridge. | ||
|
|
||
|
|
||
| ## Benefits of Exclusivity | ||
|
|
||
| Utilizing exclusivity minimizes the wasteful aspects of competing relayers "racing" on the open-market to be the first to fill, allowing them to offer more efficient operations & pricing. | ||
|
|
||
|
|
||
| ## How to Decide Exclusivity | ||
|
|
||
| Exclusivity settings are an optional tool offered to integrators and users - the functionality is available to be used in any way that suits them. For example, exclusivity can be used to implement an off-chain auction system, or to distribute relays to a private liquidity network. | ||
|
|
||
|
|
||
| ## How to Set Exclusivity | ||
|
|
||
| Exclusivity can be activated and configured per bridge. Users and Integrators simply need to determine the following values off-chain and assign them as part of [BridgeParamsV2](https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridgeV2.sol/interface.IFastBridgeV2.html#bridgeparamsv2) when the bridge deposit transaction is constructed. | ||
|
|
||
| | Parameter | Description | | ||
| |----------------------------|-------------------------------------------------------------------------------------------------------| | ||
| | quoteRelayer | The address of the Relayer who will have temporarily exclusive fill rights. | | ||
| | quoteExclusivitySeconds | The duration in seconds for which the `quoteRelayer` will have exclusive fill rights. The countdown begins when the bridge lands on the origin chain and is based on the transaction's block timestamp. | | ||
|
|
||
| Note: The seconds setting can be as granular and fine-tuned as desired. However, for simple implementations, thirty seconds is more than enough time for most relays. | ||
|
|
||
|
|
||
| ## Relaying an Exclusive Fill | ||
|
|
||
| Exclusivity is enforced by the FastBridge contract according to two values that will be on the [BridgeTransactionV2] struct emitted on the [BridgeRequested] event. | ||
|
|
||
| | Parameter | Description | | ||
| |----------------------|-------------------------------------------------------------------------------------------------------| | ||
| | exclusivityRelayer | This will be set to the address of the [Relayer] who has been granted first-fill rights. | | ||
| | exclusivityEndTime | Once the Block timestamp exceeds this value, anyone can complete the relay if it has not yet been completed. | | ||
|
|
||
| Relayers who are *not* the assigned `exclusivityRelayer` can wait until the block timestamp of the destination has surpased the `exclusivityEndTime` and then attempt the relay for themselves, if it was not filled in time by the assignee. |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Enhance documentation with technical implementation details
While the current documentation provides a good overview of the exclusivity feature, it would benefit from additional technical details:
-
Error Handling:
- Document the error cases when non-exclusive relayers attempt to relay during exclusivity
- Include specific error messages or revert reasons
-
Implementation Examples:
- Add code snippets showing how to construct
BridgeParamsV2with exclusivity settings - Include examples of checking exclusivity status
- Add code snippets showing how to construct
-
Gas Considerations:
- Document any gas implications of using exclusivity vs. non-exclusive relaying
Would you like me to help draft these additional sections?
| [relay]: https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridgeV2.sol/interface.IFastBridgeV2.html#relayv2 | ||
| [prove]: https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridgeV2.sol/interface.IFastBridgeV2.html#provev2 |
There was a problem hiding this comment.
Replace temporary Vercel preview URLs with permanent documentation links
The documentation contains references to temporary Vercel preview URLs (e.g., vercel-rfq-docs.vercel.app). These should be updated to use permanent documentation URLs to ensure long-term stability.
|
|
||
| However, the Multicall implementation is limited to non-payable transactions only, so native-gas bridges cannot be included in batches. | ||
|
|
||
| ### Permissions |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Fix heading hierarchy
The "Permissions" section should be an h2 heading to maintain proper document structure.
-### Permissions
+## Permissions📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ### Permissions | |
| ## Permissions |
🧰 Tools
🪛 Markdownlint (0.35.0)
110-110: Expected: h2; Actual: h3
Heading levels should only increment by one level at a time
(MD001, heading-increment)
| [relay]: https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridgeV2.sol/interface.IFastBridgeV2.html#relayv2 | ||
| [prove]: https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridgeV2.sol/interface.IFastBridgeV2.html#provev2 | ||
| [dispute]: https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridge.sol/interface.IFastBridge.html#dispute | ||
| [claim]: https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridgeV2.sol/interface.IFastBridgeV2.html#claimv2 | ||
| [cancel]: https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridgeV2.sol/interface.IFastBridgeV2.html#cancelv2 | ||
| [proof]: https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridgeV2.sol/interface.IFastBridgeV2.html#bridgetxdetails | ||
| [BridgeRequested]: https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridge.sol/interface.IFastBridge.html#bridgerequested | ||
| [BridgeTransactionV2]: https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridgeV2.sol/interface.IFastBridgeV2.html#bridgetransactionv2 | ||
| [BridgeRelayed]: https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridge.sol/interface.IFastBridge.html#bridgerelayed | ||
| [BridgeProofProvided]: https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridge.sol/interface.IFastBridge.html#bridgeproofprovided | ||
| [Cancel Delay]: https://vercel-rfq-docs.vercel.app/contracts/FastBridge.sol/contract.FastBridge.html#refund_delay | ||
| [Multicall]: https://vercel-rfq-docs.vercel.app/contracts/interfaces/IMulticallTarget.sol/interface.IMulticallTarget.html | ||
|
|
There was a problem hiding this comment.
💡 Codebase verification
Replace preview URLs with docs.bridge.synapseprotocol.com
The Vercel preview URLs should be updated to use the official documentation domain docs.bridge.synapseprotocol.com as defined in the Docusaurus configuration. This will ensure long-term reliability of the documentation links.
docs/bridge/docs/03-RFQ/20-Relaying/index.md: Update allvercel-rfq-docs.vercel.appURLs todocs.bridge.synapseprotocol.com- Similar updates needed in 15 other documentation files that use the preview domain
🔗 Analysis chain
Replace preview URLs with permanent documentation links
The Vercel preview URLs (e.g., vercel-rfq-docs.vercel.app) should be replaced with permanent documentation URLs to ensure long-term reliability.
Let me verify if these preview URLs are part of a consistent documentation strategy by checking if there's any configuration file that might define these URLs.
Let me check if there's a permanent documentation URL defined in the repository or if these preview URLs are meant to be replaced during the build process.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Check for other instances of preview URLs in the docs
rg -l "vercel-rfq-docs\.vercel\.app" docs/
Length of output: 770
Script:
#!/bin/bash
# Check for documentation configuration files
fd -e json -e yaml -e yml -e toml . docs/ | xargs cat
# Also check package.json for documentation-related configurations
cat package.json 2>/dev/null || true
Length of output: 5240
Script:
#!/bin/bash
# Check for documentation URL configurations in docusaurus config
fd -e js -e ts docusaurus.config . docs/ | xargs cat
# Check for environment variables that might contain the documentation URL
fd -g "*.env*" . | xargs cat 2>/dev/null || true
Length of output: 19870
🧰 Tools
🪛 Markdownlint (0.35.0)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
docs/bridge/docs/03-RFQ/index.md
Outdated
| [BridgeTransactionV2]: https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridgeV2.sol/interface.IFastBridgeV2.html#bridgetransactionv2 | ||
| [BridgeRelayed]: https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridge.sol/interface.IFastBridge.html#bridgerelayed | ||
| [BridgeProofProvided]: https://vercel-rfq-docs.vercel.app/contracts/interfaces/IFastBridge.sol/interface.IFastBridge.html#bridgeproofprovided | ||
| [Cancel Delay]: https://vercel-rfq-docs.vercel.app/contracts/FastBridge.sol/contract.FastBridge.html#refund_delay |
There was a problem hiding this comment.
Update the Cancel Delay link to point to the correct contract
Based on previous discussions, the Cancel Delay link should point to the AdminV2 contract documentation instead of FastBridge.
Update the link to:
-[Cancel Delay]: https://vercel-rfq-docs.vercel.app/contracts/FastBridge.sol/contract.FastBridge.html#refund_delay
+[Cancel Delay]: https://vercel-rfq-docs.vercel.app/contracts/AdminV2.sol/contract.AdminV2.html#canceldelay📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| [Cancel Delay]: https://vercel-rfq-docs.vercel.app/contracts/FastBridge.sol/contract.FastBridge.html#refund_delay | |
| [Cancel Delay]: https://vercel-rfq-docs.vercel.app/contracts/AdminV2.sol/contract.AdminV2.html#canceldelay |
🧰 Tools
🪛 Markdownlint (0.35.0)
18-18: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (1)
packages/rest-api/swagger.json (1)
2680-2681: Enhance WebSocket documentationWhile the documentation is clear, consider adding more details about:
- Expected WebSocket message format
- Heartbeat/keep-alive mechanism
- Reconnection strategy
- Rate limiting (if any)
- "summary": "Listen for Active RFQs", - "description": "Establish a WebSocket connection to listen for Active Requests-For-Quote.", + "summary": "Listen for Active RFQs via WebSocket", + "description": "Establish a WebSocket connection to listen for Active Requests-For-Quote. The server streams real-time RFQ updates to connected clients. Messages are sent in JSON format and include quote details such as pricing, amounts, and expiration times. Clients should implement heartbeat checks and automatic reconnection for reliability.",
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (3)
docs/bridge/docusaurus.config.ts(1 hunks)packages/rest-api/swagger.json(2 hunks)services/rfq/api/rest/server.go(3 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
- docs/bridge/docusaurus.config.ts
- services/rfq/api/rest/server.go
🔇 Additional comments (1)
packages/rest-api/swagger.json (1)
2641-2644: Documentation looks good!
The summary and description for the /rfq endpoint are clear, concise, and informative. They effectively communicate the endpoint's purpose of initiating an Active RFQ and returning the best available quote.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (1)
docs/bridge/docs/03-RFQ/20-Relaying/index.md (1)
64-65: Improve wording for clarityConsider simplifying the language for better readability.
-Prior to calling [relay], the [Relayer] must have already granted sufficient token approvals to FastBridge to allow transfers of this ERC20. +Before calling [relay], the [Relayer] must grant sufficient token approvals to FastBridge for ERC20 transfers.🧰 Tools
🪛 LanguageTool
[style] ~64-~64: ‘Prior to’ might be wordy. Consider a shorter alternative.
Context: ...stination asset to deliver is an ERC20. Prior to calling [relay], the [Relayer] must hav...(EN_WORDINESS_PREMIUM_PRIOR_TO)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (1)
docs/bridge/docs/03-RFQ/20-Relaying/index.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/bridge/docs/03-RFQ/20-Relaying/index.md
[style] ~64-~64: ‘Prior to’ might be wordy. Consider a shorter alternative.
Context: ...stination asset to deliver is an ERC20. Prior to calling [relay], the [Relayer] must hav...
(EN_WORDINESS_PREMIUM_PRIOR_TO)
🪛 Markdownlint (0.35.0)
docs/bridge/docs/03-RFQ/20-Relaying/index.md
111-111: Expected: h2; Actual: h3
Heading levels should only increment by one level at a time
(MD001, heading-increment)
9-9: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "relaying"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
28-28: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
35-35: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
36-36: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
🔇 Additional comments (2)
docs/bridge/docs/03-RFQ/20-Relaying/index.md (2)
6-18:
Replace preview URLs with permanent documentation links
The documentation currently uses Vercel preview URLs which are temporary and may become inaccessible. These should be updated to use the permanent documentation domain.
Replace all instances of vercel-rfq-docs.vercel.app with the permanent documentation domain.
🧰 Tools
🪛 Markdownlint (0.35.0)
9-9: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
111-111:
Fix heading hierarchy
The "Permissions" section should be an h2 heading to maintain proper document structure.
-### Permissions
+## Permissions🧰 Tools
🪛 Markdownlint (0.35.0)
111-111: Expected: h2; Actual: h3
Heading levels should only increment by one level at a time
(MD001, heading-increment)
There was a problem hiding this comment.
Actionable comments posted: 8
🧹 Outside diff range and nitpick comments (34)
docs/bridge/docs/05-Contracts/06-RFQ.md (1)
Line range hint
15-51: Consider adding version migration guidanceWith two versions of FastBridge now documented, consider adding:
- Clear guidance on which version new integrators should use
- Migration instructions for existing users of V1
- Differences between V1 and V2
docs/bridge/docs/03-RFQ/75-Exclusivity/index.md (2)
52-59: Add example values and recommended rangesWhile the parameters are well explained, consider adding:
- Example values for both parameters
- Recommended ranges for
quoteExclusivitySeconds- Best practices for setting these values
This would help developers better understand the practical implementation.
71-71: Fix typo in explanationCorrect the spelling error:
-Relayers who are *not* the assigned `exclusivityRelayer` can wait until the block timestamp of the destination has surpased the `exclusivityEndTime` +Relayers who are *not* the assigned `exclusivityRelayer` can wait until the block timestamp of the destination has surpassed the `exclusivityEndTime`docs/bridge/docs/03-RFQ/10-Quoting/Quoter API/index.md (2)
100-106: Add language specifiers to code blocksAdd language specifiers to JSON code blocks for proper syntax highlighting:
- ``` + ```json { op: string, content: json, success: bool, }Apply similar changes to other JSON code blocks in this section. Also applies to: 110-121, 125-130 <details> <summary>🧰 Tools</summary> <details> <summary>🪛 Markdownlint (0.35.0)</summary> 100-100: null Fenced code blocks should have a language specified (MD040, fenced-code-language) </details> </details> --- `178-178`: **Fix duplicate word** ```diff -Rather, they are expected to use a Quoter API that is hosted by the the interface they are quoting for. +Rather, they are expected to use a Quoter API that is hosted by the interface they are quoting for.🧰 Tools
🪛 LanguageTool
[duplication] ~178-~178: Possible typo: you repeated a word
Context: ...d to use a Quoter API that is hosted by the the interface they are quoting for. For exa...(ENGLISH_WORD_REPEAT_RULE)
docs/bridge/docs/03-RFQ/10-Quoting/index.md (1)
52-52: Fix grammar: Remove unnecessary commaRemove the comma before "if" for correct grammar.
-Active quoting is more complicated to implement and maintain, but allow for more granular & customized quotes that can improve efficiency among other benefits. Quoters who prefer a simpler approach are free to use nothing but Passive Quotes, if they choose. +Active quoting is more complicated to implement and maintain, but allow for more granular & customized quotes that can improve efficiency among other benefits. Quoters who prefer a simpler approach are free to use nothing but Passive Quotes if they choose.🧰 Tools
🪛 LanguageTool
[typographical] ~52-~52: Usually, there’s no comma before “if”.
Context: ...e free to use nothing but Passive Quotes, if they choose. ## :::info To learn mor...(IF_NO_COMMA)
docs/bridge/docs/03-RFQ/15-Bridging/index.md (4)
5-36: Consider documenting the purpose of reference links and maintain consistent casingWhile these reference links might be used in future documentation, it would be helpful to:
- Add a comment explaining the purpose and intended usage of these reference links
- Use consistent casing in reference names (e.g.,
Cancel DelayvsBridgeRequested)🧰 Tools
🪛 Markdownlint (0.35.0)
6-6: Unused link or image reference definition: "relay"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
7-7: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
9-9: Unused link or image reference definition: "claim"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
13-13: Unused link or image reference definition: "bridgetransactionv2"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
35-35: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
38-49: Enhance integration guidance with version and prerequisite informationConsider adding:
- SDK version compatibility information
- API version details
- Prerequisites or requirements for integration
51-58: Improve clarity and formality in exclusivity section
- Replace "IE:" with "i.e.," for formal documentation
- Consider specifying details about the "temporary period" (e.g., duration, how it's determined)
60-74: Consider adding technical details to effects sectionTo make this section more comprehensive, consider adding:
- Information about gas fees and who bears them
- Potential failure scenarios and their handling
- Any timeout or expiration mechanisms
docs/bridge/docs/03-RFQ/15-Bridging/quoteId.md (2)
41-41: Fix grammatical issue with "however".The sentence structure needs improvement.
-There is currently no on-chain functionality that utilizes this field, it is simply for record keeping and indexing, however this may change in the future. +There is currently no on-chain functionality that utilizes this field, it is simply for record keeping and indexing. However, this may change in the future.🧰 Tools
🪛 LanguageTool
[typographical] ~41-~41: The word “however” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence.
Context: ...s simply for record keeping and indexing, however this may change in the future.(HOWEVER_SENTENCE)
37-41: Consider adding parameter details.The documentation would benefit from additional information about:
- The parameter format (string, number, etc.)
- Any length or character constraints
- Examples of valid
quoteIdvalues- Best practices for generating and using quote IDs
Would you like me to propose a detailed section covering these aspects?
🧰 Tools
🪛 LanguageTool
[typographical] ~41-~41: The word “however” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence.
Context: ...s simply for record keeping and indexing, however this may change in the future.(HOWEVER_SENTENCE)
docs/bridge/docs/03-RFQ/20-Relaying/index.md (2)
5-37: Consider cleaning up unused reference linksSeveral reference links appear to be unused in this document. While they might be used in other files, consider moving shared links to a common file or removing unused ones to maintain cleaner documentation.
🧰 Tools
🪛 Markdownlint (0.35.0)
9-9: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "relaying"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
28-28: Unused link or image reference definition: "security"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
35-35: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
36-36: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
62-65: Enhance clarity around token handlingConsider adding a code example to illustrate the difference between handling native currency and ERC20 tokens. This would make the implementation requirements clearer for developers.
+ For example: + ```solidity + // For native currency + fastBridge.relay{value: amount}(request); + + // For ERC20 + erc20Token.approve(address(fastBridge), amount); + fastBridge.relay(request); + ```🧰 Tools
🪛 LanguageTool
[style] ~64-~64: ‘Prior to’ might be wordy. Consider a shorter alternative.
Context: ...stination asset to deliver is an ERC20. Prior to calling [relay], the [Relayer] must hav...(EN_WORDINESS_PREMIUM_PRIOR_TO)
docs/bridge/docs/03-RFQ/20-Relaying/riskFactors.md (2)
5-36: Consider organizing reference links by categoryThe reference links section would be more maintainable if organized into categories like:
- Contract interfaces
- Documentation pages
- System entities
<!-- Reference Links --> +<!-- Contract Interfaces --> [relay]: https://rfq-contracts.synapseprotocol.com/contracts/interfaces/IFastBridgeV2.sol/interface.IFastBridgeV2.html#relayv2 [prove]: https://rfq-contracts.synapseprotocol.com/contracts/interfaces/IFastBridgeV2.sol/interface.IFastBridgeV2.html#provev2 ... +<!-- Documentation --> [Quoter API]: /docs/RFQ/Quoting/Quoter%20API/ [Dispute Period]: /docs/RFQ/Security/#dispute-period ... +<!-- Entities --> [User]: /docs/RFQ/#entities [Quoter]: /docs/RFQ/#entities🧰 Tools
🪛 Markdownlint (0.35.0)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "relaying"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
28-28: Unused link or image reference definition: "exclusivity"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
35-35: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
48-48: Fix grammatical errorsThere are a few grammatical issues that should be addressed:
- Line 48: "can be come" should be "become"
- Line 70: "fulfillment a bridge" should be "fulfillment of a bridge"
-If a bridge transaction occurs that acts upon a quote issued by a particular [Relayer], and that [Relayer] fails to complete the [relay] transaction - the bridge deposit can be come "stuck" if there is no one to complete it. +If a bridge transaction occurs that acts upon a quote issued by a particular [Relayer], and that [Relayer] fails to complete the [relay] transaction - the bridge deposit can become "stuck" if there is no one to complete it. -If a [relay] occurs for an incorrect output amount (or any other incorrect [BridgeTransactionV2] data) and is submitted via [prove] as the fulfillment a bridge transaction, the [proof] will be disputed by a [Guard]. +If a [relay] occurs for an incorrect output amount (or any other incorrect [BridgeTransactionV2] data) and is submitted via [prove] as the fulfillment of a bridge transaction, the [proof] will be disputed by a [Guard].Also applies to: 70-70
🧰 Tools
🪛 LanguageTool
[grammar] ~48-~48: Did you mean “become”?
Context: ...y] transaction - the bridge deposit can be come "stuck" if there is no one to complete ...(BE_COME)
docs/bridge/docs/03-RFQ/30-Proving/index.md (3)
37-37: Improve readability of the opening sentenceThe current sentence is lengthy and could be clearer. Consider restructuring it:
- After [Relaying] successfully and observing that the [relay] transaction has finalized on the destination chain, [prove] transactions are executed by authorized Provers (who are typically also the [Relayer]) + After a successful [Relaying] process and confirmation that the [relay] transaction has finalized on the destination chain, authorized Provers (typically also the [Relayer]) execute [prove] transactions.
70-70: Enhance the warning message with specific risksThe current warning could be more explicit about the potential consequences:
- prove should not be called until the Relayer is confident that the relay transaction is finalized and will not be reorganized. + prove should not be called until the Relayer is confident that the relay transaction is finalized and will not be reorganized. Calling prove too early could result in invalid proofs if the relay transaction is reorganized, potentially leading to disputes and loss of funds.
81-83: Fix typo and enhance next steps guidanceThere's a typo and the next steps could be more specific:
- Following the [prove] transation, a [Dispute Period] begins - after which the [Relayer] may proceed to [Claiming] + Following the [prove] transaction, a [Dispute Period] begins - after which the [Relayer] may proceed to [Claiming]. + + During the [Dispute Period]: + 1. Monitor for any dispute events + 2. Prepare necessary documentation for the claiming process + 3. Set up alerts for when the dispute period endsdocs/bridge/docs/03-RFQ/40-Claiming/index.md (3)
5-36: Add a comment explaining the purpose of the reference links sectionConsider adding a brief comment explaining that this is a shared reference links section used across multiple documentation files. This will help future maintainers understand why some links might appear unused in this specific file.
--- title: Claiming --- +<!-- This section contains shared reference links used across the RFQ documentation --> <!-- Reference Links --> [relay]: https://rfq-contracts.synapseprotocol.com/contracts/interfaces/IFastBridgeV2.sol/interface.IFastBridgeV2.html#relayv2🧰 Tools
🪛 Markdownlint (0.35.0)
7-7: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
13-13: Unused link or image reference definition: "bridgetransactionv2"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "relaying"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
28-28: Unused link or image reference definition: "exclusivity"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
30-30: Unused link or image reference definition: "user"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
35-35: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
37-40: Add dispute period duration informationConsider adding information about the typical duration of the dispute period to help Relayers better understand when they can expect to claim their funds.
-After [Proving] and waiting for the [Dispute Period] to end, Relayers can then execute a [claim] transaction which will release the funds which have been escrowed since the original bridge. +After [Proving] and waiting for the [Dispute Period] (typically X hours) to end, Relayers can then execute a [claim] transaction which will release the funds which have been escrowed since the original bridge.
71-73: Enhance the next steps sectionConsider adding:
- Links to documentation about starting a new bridge cycle
- A visual diagram showing the complete bridge cycle (Request → Relay → Prove → Claim)
Would you like me to help create a mermaid diagram showing the bridge cycle?
docs/bridge/docs/03-RFQ/50-Canceling/index.md (4)
5-36: Consider organizing reference links more efficientlyThe reference links section is well-structured but could be improved:
- Consider grouping related links into collapsible sections using HTML details tags for better maintainability
- Add brief descriptions for contract interface links to improve clarity
Example structure:
+ <details> + <summary>Contract Interfaces</summary> + [relay]: ... <!-- Handles relay operations for bridge transactions --> [prove]: ... <!-- Manages proof verification for transactions --> + </details>🧰 Tools
🪛 Markdownlint (0.35.0)
6-6: Unused link or image reference definition: "relay"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
7-7: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
9-9: Unused link or image reference definition: "claim"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
13-13: Unused link or image reference definition: "bridgetransactionv2"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "relaying"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
28-28: Unused link or image reference definition: "exclusivity"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
33-33: Unused link or image reference definition: "relayer"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
37-42: Improve clarity of cancellation conditionsThe explanation of cancellation conditions could be enhanced with a visual timeline or example. Consider adding a diagram showing:
- Normal bridge timeline
- Cancel Delay period
- Relay expiration deadline
- Permissioned vs. permissionless cancellation windows
🧰 Tools
🪛 LanguageTool
[style] ~41-~41: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ... can also execute the [cancel] function prior to the cancellation delay, but only after ...(EN_WORDINESS_PREMIUM_PRIOR_TO)
51-51: Fix grammar in closing sentenceAdd a comma before "and" in the compound sentence.
-No further action is possible with the bridge after a cancellation and it can be considered closed. +No further action is possible with the bridge after a cancellation, and it can be considered closed.🧰 Tools
🪛 LanguageTool
[uncategorized] ~51-~51: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ble with the bridge after a cancellation and it can be considered closed.(COMMA_COMPOUND_SENTENCE)
37-51: Consider adding error scenarios and troubleshooting sectionThe documentation would benefit from:
- Common error scenarios and their resolutions
- Troubleshooting steps for failed cancellations
- Integration examples with the FastBridge contract
🧰 Tools
🪛 LanguageTool
[style] ~41-~41: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ... can also execute the [cancel] function prior to the cancellation delay, but only after ...(EN_WORDINESS_PREMIUM_PRIOR_TO)
[uncategorized] ~51-~51: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ble with the bridge after a cancellation and it can be considered closed.(COMMA_COMPOUND_SENTENCE)
docs/bridge/docs/03-RFQ/70-CanonicalRelayer/index.md (3)
59-59: Fix grammar in the stack description.Consider revising the preposition usage for better readability.
-The canonical RFQ Relayer is primarily built in Go with a MySQL backend. +The canonical RFQ Relayer is primarily built in Go to a MySQL backend.🧰 Tools
🪛 LanguageTool
[uncategorized] ~59-~59: The preposition ‘to’ seems more likely in this position.
Context: ...anonical RFQ Relayer is primarily built in Go with a MySQL backend. It also utiliz...(AI_HYDRA_LEO_REPLACE_IN_TO)
80-80: Enhance state description for clarity.The
WillNotProcessstate description could benefit from examples of what makes aBridgeRequestedevent invalid.
136-136: Address TODO comment regarding documentation auto-generation.The comment suggests implementing auto-generation similar to OpenAPI documentation. This could help maintain consistency between code and documentation.
Would you like me to help create a solution for auto-generating this documentation from the code and mix-ins?
docs/bridge/docs/03-RFQ/90-Misc/index.md (3)
5-36: Consider adding a section comment to explain the purpose of reference linksWhile these reference links are well-organized, adding a brief comment explaining that this is a centralized repository of links used across the documentation would help other contributors understand their purpose.
<!-- Reference Links --> +<!-- This section serves as a centralized repository of links used across the RFQ documentation. -->🧰 Tools
🪛 Markdownlint (0.35.0)
6-6: Unused link or image reference definition: "relay"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
7-7: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
9-9: Unused link or image reference definition: "claim"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "relaying"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
28-28: Unused link or image reference definition: "exclusivity"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
30-30: Unused link or image reference definition: "user"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
33-33: Unused link or image reference definition: "relayer"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
35-35: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
66-68: Enhance the RFQ Load Tester documentationThe current documentation provides basic information about the tool's purpose but could be more helpful with additional details about:
- Configuration options
- Usage examples
- Common test scenarios
- Performance metrics
Would you like me to help generate a more detailed documentation template for this section?
41-64: Consider restructuring method descriptionsThe current use of blockquotes for method descriptions is inconsistent and may not be the most effective way to present this information. Consider using a more structured format:
-<blockquote> #### [canClaim](...) Checks if the [Dispute Period] has passed and the funds are now claimable #### [bridgeStatuses](...) -</blockquote>Consider using tables or definition lists to better organize the method information, including parameters, return values, and examples.
🧰 Tools
🪛 Markdownlint (0.35.0)
46-46: Expected: h4; Actual: h5
Heading levels should only increment by one level at a time(MD001, heading-increment)
59-59: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
docs/bridge/docs/03-RFQ/index.md (2)
41-41: Consider more precise wordingConsider revising "very simple terms" to "basic terms" or "fundamental terms" for more concise and professional documentation.
🧰 Tools
🪛 LanguageTool
[style] ~41-~41: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ... Synapse RFQ (Request-For-Quote) is an <abbr title="'Intent' refers to a user authorizing specific actions that they want to achieve, typically in very simple terms, such as a bridge or swap. Actual...(EN_WEAK_ADJECTIVE)
146-146: Improve sentence concisenessConsider revising "all of the on-chain functionality" to "all on-chain functionality" for better readability.
🧰 Tools
🪛 LanguageTool
[style] ~146-~146: Consider removing “of” to be more concise
Context: ...s/Contracts/RFQ) facilitate and enforce all of the on-chain functionality and security of ...(ALL_OF_THE)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (15)
docs/bridge/docs/03-RFQ/10-Quoting/Quoter API/index.md(1 hunks)docs/bridge/docs/03-RFQ/10-Quoting/index.md(1 hunks)docs/bridge/docs/03-RFQ/15-Bridging/index.md(1 hunks)docs/bridge/docs/03-RFQ/15-Bridging/quoteId.md(1 hunks)docs/bridge/docs/03-RFQ/20-Relaying/index.md(1 hunks)docs/bridge/docs/03-RFQ/20-Relaying/riskFactors.md(1 hunks)docs/bridge/docs/03-RFQ/30-Proving/index.md(1 hunks)docs/bridge/docs/03-RFQ/40-Claiming/index.md(1 hunks)docs/bridge/docs/03-RFQ/50-Canceling/index.md(1 hunks)docs/bridge/docs/03-RFQ/60-Security/index.md(1 hunks)docs/bridge/docs/03-RFQ/70-CanonicalRelayer/index.md(5 hunks)docs/bridge/docs/03-RFQ/75-Exclusivity/index.md(1 hunks)docs/bridge/docs/03-RFQ/90-Misc/index.md(1 hunks)docs/bridge/docs/03-RFQ/index.md(1 hunks)docs/bridge/docs/05-Contracts/06-RFQ.md(2 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/bridge/docs/03-RFQ/10-Quoting/Quoter API/index.md
[duplication] ~178-~178: Possible typo: you repeated a word
Context: ...d to use a Quoter API that is hosted by the the interface they are quoting for. For exa...
(ENGLISH_WORD_REPEAT_RULE)
[typographical] ~200-~200: It seems that a comma is missing.
Context: ...lite, this can be a path, if using mysql please see [here](https://dev.mysql.com/doc/co...
(IF_PLEASE_COMMA)
[style] ~215-~215: Consider a more expressive alternative.
Context: ...ter API can also be run with docker. To do this, you will need to build the docker...
(DO_ACHIEVE)
docs/bridge/docs/03-RFQ/10-Quoting/index.md
[typographical] ~52-~52: Usually, there’s no comma before “if”.
Context: ...e free to use nothing but Passive Quotes, if they choose. ## :::info To learn mor...
(IF_NO_COMMA)
docs/bridge/docs/03-RFQ/15-Bridging/quoteId.md
[typographical] ~41-~41: The word “however” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence.
Context: ...s simply for record keeping and indexing, however this may change in the future.
(HOWEVER_SENTENCE)
docs/bridge/docs/03-RFQ/20-Relaying/index.md
[style] ~64-~64: ‘Prior to’ might be wordy. Consider a shorter alternative.
Context: ...stination asset to deliver is an ERC20. Prior to calling [relay], the [Relayer] must hav...
(EN_WORDINESS_PREMIUM_PRIOR_TO)
docs/bridge/docs/03-RFQ/20-Relaying/riskFactors.md
[grammar] ~48-~48: Did you mean “become”?
Context: ...y] transaction - the bridge deposit can be come "stuck" if there is no one to complete ...
(BE_COME)
[grammar] ~50-~50: Do not use an adverb of manner between a verb and its direct object.
Context: ...ds are safe in these instances and will eventually either be cancelled & refunded or compl...
(MD_RB_DT)
[style] ~52-~52: As a shorter alternative for ‘able to’, consider using “can”.
Context: ...participating Relayers must ensure they are able to complete all bridge transactions that a...
(BE_ABLE_TO)
[uncategorized] ~70-~70: Possible missing preposition found.
Context: ...ubmitted via [prove] as the fulfillment a bridge transaction, the [proof] will be...
(AI_HYDRA_LEO_MISSING_OF)
docs/bridge/docs/03-RFQ/30-Proving/index.md
[grammar] ~45-~45: The word ‘prove’ is a verb. Did you mean the noun “proof”?
Context: ... Options There are two versions of the prove function in FastBridgeV2. Relayers can ...
(PREPOSITION_VERB)
docs/bridge/docs/03-RFQ/50-Canceling/index.md
[style] ~41-~41: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ... can also execute the [cancel] function prior to the cancellation delay, but only after ...
(EN_WORDINESS_PREMIUM_PRIOR_TO)
[uncategorized] ~51-~51: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ble with the bridge after a cancellation and it can be considered closed.
(COMMA_COMPOUND_SENTENCE)
docs/bridge/docs/03-RFQ/60-Security/index.md
[grammar] ~52-~52: The word ‘prove’ is a verb. Did you mean the noun “proof”?
Context: ..._period) begins. During this time, the prove/proof is eligible to be dispuated by [G...
(PREPOSITION_VERB)
[uncategorized] ~74-~74: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short).
Context: ... a new corrected [prove] to be submitted and the process begins again. If a [relay]...
(COMMA_COMPOUND_SENTENCE_2)
docs/bridge/docs/03-RFQ/70-CanonicalRelayer/index.md
[uncategorized] ~59-~59: The preposition ‘to’ seems more likely in this position.
Context: ...anonical RFQ Relayer is primarily built in Go with a MySQL backend. It also utiliz...
(AI_HYDRA_LEO_REPLACE_IN_TO)
docs/bridge/docs/03-RFQ/index.md
[style] ~41-~41: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ... Synapse RFQ (Request-For-Quote) is an <abbr title="'Intent' refers to a user authorizing specific actions that they want to achieve, typically in very simple terms, such as a bridge or swap. Actual...
(EN_WEAK_ADJECTIVE)
[style] ~146-~146: Consider removing “of” to be more concise
Context: ...s/Contracts/RFQ) facilitate and enforce all of the on-chain functionality and security of ...
(ALL_OF_THE)
🪛 Markdownlint (0.35.0)
docs/bridge/docs/03-RFQ/10-Quoting/Quoter API/index.md
173-173: Expected: 0; Actual: 1
Unordered list indentation
(MD007, ul-indent)
174-174: Expected: 0; Actual: 1
Unordered list indentation
(MD007, ul-indent)
176-176: Punctuation: ':'
Trailing punctuation in heading
(MD026, no-trailing-punctuation)
57-57: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
64-64: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
76-76: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
81-81: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
213-213: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
100-100: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
110-110: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
125-125: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
7-7: Unused link or image reference definition: "relay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
9-9: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "claim"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
13-13: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgetransactionv2"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
18-18: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
28-28: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
29-29: Unused link or image reference definition: "exclusivity"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "user"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
33-33: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "relayer"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
35-35: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
36-36: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
docs/bridge/docs/03-RFQ/10-Quoting/index.md
6-6: Unused link or image reference definition: "relay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
7-7: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
9-9: Unused link or image reference definition: "claim"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
13-13: Unused link or image reference definition: "bridgetransactionv2"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "relaying"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
28-28: Unused link or image reference definition: "exclusivity"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
33-33: Unused link or image reference definition: "relayer"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
35-35: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
docs/bridge/docs/03-RFQ/15-Bridging/index.md
6-6: Unused link or image reference definition: "relay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
7-7: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
9-9: Unused link or image reference definition: "claim"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
13-13: Unused link or image reference definition: "bridgetransactionv2"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
35-35: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
docs/bridge/docs/03-RFQ/15-Bridging/quoteId.md
6-6: Unused link or image reference definition: "relay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
7-7: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
9-9: Unused link or image reference definition: "claim"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
13-13: Unused link or image reference definition: "bridgetransactionv2"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "relaying"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
28-28: Unused link or image reference definition: "exclusivity"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
30-30: Unused link or image reference definition: "user"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
33-33: Unused link or image reference definition: "relayer"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
35-35: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
docs/bridge/docs/03-RFQ/20-Relaying/index.md
111-111: Expected: h2; Actual: h3
Heading levels should only increment by one level at a time
(MD001, heading-increment)
9-9: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "relaying"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
28-28: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
35-35: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
36-36: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
docs/bridge/docs/03-RFQ/20-Relaying/riskFactors.md
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "relaying"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
28-28: Unused link or image reference definition: "exclusivity"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
35-35: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
docs/bridge/docs/03-RFQ/30-Proving/index.md
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
13-13: Unused link or image reference definition: "bridgetransactionv2"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
28-28: Unused link or image reference definition: "exclusivity"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
30-30: Unused link or image reference definition: "user"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
35-35: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
docs/bridge/docs/03-RFQ/40-Claiming/index.md
7-7: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
13-13: Unused link or image reference definition: "bridgetransactionv2"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "relaying"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
28-28: Unused link or image reference definition: "exclusivity"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
30-30: Unused link or image reference definition: "user"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
35-35: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
docs/bridge/docs/03-RFQ/50-Canceling/index.md
6-6: Unused link or image reference definition: "relay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
7-7: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
9-9: Unused link or image reference definition: "claim"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
13-13: Unused link or image reference definition: "bridgetransactionv2"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "relaying"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
28-28: Unused link or image reference definition: "exclusivity"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
33-33: Unused link or image reference definition: "relayer"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
docs/bridge/docs/03-RFQ/60-Security/index.md
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "relaying"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
28-28: Unused link or image reference definition: "exclusivity"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
30-30: Unused link or image reference definition: "user"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
35-35: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
docs/bridge/docs/03-RFQ/70-CanonicalRelayer/index.md
6-6: Unused link or image reference definition: "relay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
7-7: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
9-9: Unused link or image reference definition: "claim"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
13-13: Unused link or image reference definition: "bridgetransactionv2"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
28-28: Unused link or image reference definition: "exclusivity"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
30-30: Unused link or image reference definition: "user"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
33-33: Unused link or image reference definition: "relayer"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
35-35: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
152-152: Expected: dash; Actual: asterisk
Unordered list style
(MD004, ul-style)
docs/bridge/docs/03-RFQ/75-Exclusivity/index.md
7-7: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
9-9: Unused link or image reference definition: "claim"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "relaying"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
28-28: Unused link or image reference definition: "exclusivity"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
30-30: Unused link or image reference definition: "user"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
35-35: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
docs/bridge/docs/03-RFQ/90-Misc/index.md
46-46: Expected: h4; Actual: h5
Heading levels should only increment by one level at a time
(MD001, heading-increment)
40-40: Punctuation: ':'
Trailing punctuation in heading
(MD026, no-trailing-punctuation)
59-59: Punctuation: ':'
Trailing punctuation in heading
(MD026, no-trailing-punctuation)
6-6: Unused link or image reference definition: "relay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
7-7: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
9-9: Unused link or image reference definition: "claim"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "relaying"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
28-28: Unused link or image reference definition: "exclusivity"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
30-30: Unused link or image reference definition: "user"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
33-33: Unused link or image reference definition: "relayer"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
35-35: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
docs/bridge/docs/03-RFQ/index.md
159-159: Expected: h3; Actual: h4
Heading levels should only increment by one level at a time
(MD001, heading-increment)
157-157: null
Multiple spaces after hash on atx style heading
(MD019, no-multiple-space-atx)
13-13: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgetransactionv2"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
18-18: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
28-28: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
29-29: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
30-30: Unused link or image reference definition: "exclusivity"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
33-33: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
36-36: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
37-37: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
🔇 Additional comments (25)
docs/bridge/docs/05-Contracts/06-RFQ.md (3)
15-20: LGTM! Well-structured documentation section.
The FastBridge V2 section is properly organized with consistent formatting and all necessary reference links.
21-32:
Replace placeholder addresses with actual contract addresses
The FastBridge V2 section contains placeholder addresses (0xAABBCC) for all chains. These need to be replaced with the actual deployed contract addresses before merging.
51-51: Verify the new World chain address
The World chain address has been updated. Please ensure this is the correct deployed contract address.
✅ Verification successful
Based on the verification results, I can now provide a final response. The deployment file and indexer configurations confirm that this is indeed the correct FastBridge contract address on World chain.
FastBridge contract address on World chain is verified
The address 0x05C62156C7C47E76223A560210EA648De5e6B53B is confirmed to be the correct FastBridge contract address on World chain, as evidenced by:
- Official deployment file at
packages/contracts-rfq/deployments/worldchain/FastBridge.json - Contract is indexed by RFQ indexer as shown in
packages/rfq-indexer/indexer/ponder.config.ts - Address is consistently referenced across multiple configuration files in the codebase
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Verify if the new World chain address exists and contains the expected contract code
# Search for any references to this address in the codebase
rg -i "0x05c62156c7c47e76223a560210ea648de5e6b53b"
# Search for any deployment scripts or configurations that might reference this address
fd -e js -e ts -e json | xargs rg -l "FastBridge.*World"
Length of output: 672
Script:
#!/bin/bash
# Let's verify the contract deployment and configuration files more thoroughly
# Check the FastBridge deployment file content
cat packages/contracts-rfq/deployments/worldchain/FastBridge.json
# Look for any configuration files that might contain chain or contract information
fd -e config -e json -e ts | xargs rg -l "FastBridge|World"
# Search for any test files or documentation mentioning World chain addresses
rg -i "worldchain.*address|world.*bridge" --type md --type ts
Length of output: 28225
docs/bridge/docs/03-RFQ/75-Exclusivity/index.md (1)
37-42: LGTM! Clear introduction and benefits explanation
The introduction and benefits section effectively explains the exclusivity feature and its purpose in minimizing inefficiencies in the relayer competition process.
docs/bridge/docs/03-RFQ/10-Quoting/Quoter API/index.md (2)
151-165: Update authentication example to use modern libraries
The current example uses the deprecated 'ethereumjs-util' library. Consider updating to use ethers.js as previously suggested.
185-194: Use environment variables for sensitive configuration
The configuration example shows database credentials in plain text. Consider using environment variables as previously suggested.
docs/bridge/docs/03-RFQ/10-Quoting/index.md (5)
38-40: LGTM! Clear and concise introduction
The introduction effectively explains the RFQ system's purpose and introduces the two quoting methods.
42-44: LGTM! Well-explained Passive Quoting concept
The order book analogy effectively communicates the purpose and behavior of Passive Quoting.
48-48: Update version compatibility information
The current wording might mislead users about version requirements. Active quoting works with both FastBridgeV1 and V2.
-In our latest version of the [Quoter API], a new Active Quoting method has been introduced where a [Quoter] can listen and respond to live quote requests individually.
+The [Quoter API] supports an Active Quoting method where a [Quoter] can listen and respond to live quote requests individually. This feature is compatible with both FastBridgeV1 and V2.62-67: LGTM! Clear explanation of quoter responsibilities
The section effectively outlines the commitments and responsibilities of quoters, including the importance of quote maintenance and fulfillment obligations. The reference to the Canonical Relayer provides a good example implementation.
5-36: Verify the usage of reference links across documentation
Several reference links are defined but not used in this document. Let's verify their usage across the documentation to maintain only the necessary definitions.
✅ Verification successful
All reference links are actively used across the documentation
Based on the comprehensive search results, all reference links defined in the file are actively used throughout the RFQ documentation system:
- Contract interface links (relay, prove, dispute, etc.) are referenced across multiple documentation files
- Event references (BridgeRequested, BridgeTransactionV2, etc.) are used in various sections
- Internal documentation links (Quoting, Relaying, Proving, etc.) are extensively cross-referenced
- Entity references (User, Quoter, Prover, etc.) are utilized across the documentation
The reference links section serves as a central repository of links that are shared across the RFQ documentation, making it easier to maintain consistent references throughout the documentation.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Check for the usage of reference links across documentation files
# Get all markdown files in the docs directory
echo "Searching for reference link usage in documentation..."
for link in "relay" "prove" "dispute" "claim" "cancel" "proof" "bridgerequested" "bridgetransactionv2" "bridgerelayed" "bridgeproofprovided" "cancel delay" "multicall" "dispute period" "quoting" "relaying" "proving" "claiming" "canceling" "security" "exclusivity" "prover" "relayer" "guard" "canceler"; do
echo "Checking usage of [$link]..."
rg -l "\[$link\]" docs/
done
Length of output: 13792
Script:
#!/bin/bash
# Let's check for the usage of the remaining reference links in the documentation
# Specifically focusing on the ones that showed no results in the previous run
echo "Checking for remaining reference links..."
# Check for BridgeRequested event references
rg -l "BridgeRequested" docs/
# Check for BridgeTransactionV2 references
rg -l "BridgeTransactionV2" docs/
# Check for BridgeRelayed references
rg -l "BridgeRelayed" docs/
# Check for BridgeProofProvided references
rg -l "BridgeProofProvided" docs/
# Check for Cancel Delay references
rg -l "Cancel Delay" docs/
# Check for Multicall references
rg -l "Multicall" docs/
# Check for internal documentation links
rg -l "Dispute Period" docs/
rg -l "Quoting" docs/
rg -l "Relaying" docs/
rg -l "Proving" docs/
rg -l "Claiming" docs/
rg -l "Canceling" docs/
rg -l "Security" docs/
rg -l "Exclusivity" docs/
# Check for entity references
rg -l "User" docs/
rg -l "Quoter" docs/
rg -l "Prover" docs/
rg -l "Relayer" docs/
rg -l "Guard" docs/
rg -l "Canceler" docs/
Length of output: 14581
🧰 Tools
🪛 Markdownlint (0.35.0)
6-6: Unused link or image reference definition: "relay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
7-7: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
9-9: Unused link or image reference definition: "claim"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
13-13: Unused link or image reference definition: "bridgetransactionv2"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "relaying"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
28-28: Unused link or image reference definition: "exclusivity"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
33-33: Unused link or image reference definition: "relayer"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
35-35: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
docs/bridge/docs/03-RFQ/15-Bridging/quoteId.md (1)
1-3: LGTM!
The frontmatter follows the standard format and provides a clear title.
docs/bridge/docs/03-RFQ/20-Relaying/index.md (1)
111-111: Fix heading hierarchy
The "Permissions" section should be an h2 heading to maintain proper document structure.
🧰 Tools
🪛 Markdownlint (0.35.0)
111-111: Expected: h2; Actual: h3
Heading levels should only increment by one level at a time
(MD001, heading-increment)
docs/bridge/docs/03-RFQ/20-Relaying/riskFactors.md (2)
38-44: LGTM! Clear and important warning message
The warning effectively communicates the inherent risks and responsibilities of being a Relayer.
46-91: LGTM! Well-structured risk documentation
The risk sections are well-organized and provide clear explanations of:
- Different types of risks
- Their consequences
- Mitigation strategies
- Relevant monitoring tools
Each section effectively guides Relayers in understanding and managing their responsibilities.
🧰 Tools
🪛 LanguageTool
[grammar] ~48-~48: Did you mean “become”?
Context: ...y] transaction - the bridge deposit can be come "stuck" if there is no one to complete ...
(BE_COME)
[grammar] ~50-~50: Do not use an adverb of manner between a verb and its direct object.
Context: ...ds are safe in these instances and will eventually either be cancelled & refunded or compl...
(MD_RB_DT)
[style] ~52-~52: As a shorter alternative for ‘able to’, consider using “can”.
Context: ...participating Relayers must ensure they are able to complete all bridge transactions that a...
(BE_ABLE_TO)
[uncategorized] ~70-~70: Possible missing preposition found.
Context: ...ubmitted via [prove] as the fulfillment a bridge transaction, the [proof] will be...
(AI_HYDRA_LEO_MISSING_OF)
docs/bridge/docs/03-RFQ/30-Proving/index.md (1)
76-76: Complete the Multicall sentence and add explanation
The sentence about Multicall is incomplete and lacks context. Consider expanding it:
- As of FastBridgeV2, it is possible to batch many [prove] transactions together with [Multicall]
+ As of FastBridgeV2, it is possible to batch many [prove] transactions together using [Multicall]. This feature helps reduce gas costs and simplify transaction management when proving multiple relays.docs/bridge/docs/03-RFQ/40-Claiming/index.md (1)
66-69: 🛠️ Refactor suggestion
Expand multicalling documentation
The multicalling section still needs improvement as previously noted.
Consider adding:
- Link to Multicall documentation
- Example of how to batch claim transactions
- Benefits (gas savings, efficiency) and limitations
- Best practices for batching claims
docs/bridge/docs/03-RFQ/60-Security/index.md (4)
41-45: Standardize terminology throughout the documentation
The usage of "prove" and "proof" is inconsistent. Consider standardizing to "proof transaction" for consistency.
48-54: Add critical timing information
The dispute period section should specify:
- The exact duration of the dispute period
- Whether it's measured in blocks or time
- Any network-specific variations
🧰 Tools
🪛 LanguageTool
[grammar] ~52-~52: The word ‘prove’ is a verb. Did you mean the noun “proof”?
Context: ..._period) begins. During this time, the prove/proof is eligible to be dispuated by [G...
(PREPOSITION_VERB)
57-68: Expand Guards section with implementation details
Please provide additional information about Guards:
- Who can become a Guard?
- Are Guards permissioned or permissionless?
- What are the technical requirements?
- How are Guards incentivized?
52-52:
Fix typo and terminology inconsistency
The word "dispuated" is misspelled and the prove/proof terminology is inconsistent.
Apply this diff:
-During this time, the prove/proof is eligible to be dispuated by [Guard] entities.
+During this time, the proof is eligible to be disputed by [Guard] entities.Likely invalid or redundant comment.
🧰 Tools
🪛 LanguageTool
[grammar] ~52-~52: The word ‘prove’ is a verb. Did you mean the noun “proof”?
Context: ..._period) begins. During this time, the prove/proof is eligible to be dispuated by [G...
(PREPOSITION_VERB)
docs/bridge/docs/03-RFQ/70-CanonicalRelayer/index.md (2)
Line range hint 93-133: LGTM! Well-documented rebalancing logic.
The rebalancing section effectively explains the logic with a clear example that demonstrates the maintenance and initial balance percentage calculations.
321-321: Documentation improvement implemented.
The sendChainGas documentation has been enhanced as previously requested, providing better context about the flag and its current state.
docs/bridge/docs/03-RFQ/90-Misc/index.md (1)
37-64: Fix heading hierarchy and remove trailing punctuation
The heading levels are inconsistent, and some headings contain trailing punctuation. This affects documentation readability and navigation.
Apply these changes:
## FastBridge Contract Utilities
-### Call from Origin Chain:
+### Call from Origin Chain
#### [canClaim]
-##### [bridgeStatuses]
+#### [bridgeStatuses]
-##### [bridgeProofs]
+#### [bridgeProofs]
#### [getBridgeTransaction]
-### Call from Destination Chain:
+### Call from Destination Chain
-##### [bridgeRelays]
+#### [bridgeRelays]🧰 Tools
🪛 Markdownlint (0.35.0)
46-46: Expected: h4; Actual: h5
Heading levels should only increment by one level at a time
(MD001, heading-increment)
40-40: Punctuation: ':'
Trailing punctuation in heading
(MD026, no-trailing-punctuation)
59-59: Punctuation: ':'
Trailing punctuation in heading
(MD026, no-trailing-punctuation)
docs/bridge/docs/03-RFQ/index.md (1)
130-130: Clarify Canceler role permissions
The description should explicitly state that Cancelers can only cancel requests that have expired with respect to their relay deadline.
| ## Next steps | ||
|
|
||
| Relayers will observe the bridge transaction via the [BridgeRequested] event and proceed to [Relaying] if it meets all of their criteria. |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Expand next steps with implementation details
Consider enhancing this section with:
- Specific guidance on how to monitor
BridgeRequestedevents - Examples of common criteria that relayers check
- Links to relevant monitoring tools or interfaces
| <!-- Reference Links --> | ||
| [relay]: https://rfq-contracts.synapseprotocol.com/contracts/interfaces/IFastBridgeV2.sol/interface.IFastBridgeV2.html#relayv2 | ||
| [prove]: https://rfq-contracts.synapseprotocol.com/contracts/interfaces/IFastBridgeV2.sol/interface.IFastBridgeV2.html#provev2 | ||
| [dispute]: https://rfq-contracts.synapseprotocol.com/contracts/interfaces/IFastBridge.sol/interface.IFastBridge.html#dispute | ||
| [claim]: https://rfq-contracts.synapseprotocol.com/contracts/interfaces/IFastBridgeV2.sol/interface.IFastBridgeV2.html#claimv2 | ||
| [cancel]: https://rfq-contracts.synapseprotocol.com/contracts/interfaces/IFastBridgeV2.sol/interface.IFastBridgeV2.html#cancelv2 | ||
| [proof]: https://rfq-contracts.synapseprotocol.com/contracts/interfaces/IFastBridgeV2.sol/interface.IFastBridgeV2.html#bridgetxdetails | ||
| [BridgeRequested]: https://rfq-contracts.synapseprotocol.com/contracts/interfaces/IFastBridge.sol/interface.IFastBridge.html#bridgerequested | ||
| [BridgeTransactionV2]: https://rfq-contracts.synapseprotocol.com/contracts/interfaces/IFastBridgeV2.sol/interface.IFastBridgeV2.html#bridgetransactionv2 | ||
| [BridgeRelayed]: https://rfq-contracts.synapseprotocol.com/contracts/interfaces/IFastBridge.sol/interface.IFastBridge.html#bridgerelayed | ||
| [BridgeProofProvided]: https://rfq-contracts.synapseprotocol.com/contracts/interfaces/IFastBridge.sol/interface.IFastBridge.html#bridgeproofprovided | ||
| [Cancel Delay]: https://rfq-contracts.synapseprotocol.com/contracts/FastBridge.sol/contract.FastBridge.html#refund_delay | ||
| [Multicall]: https://rfq-contracts.synapseprotocol.com/contracts/interfaces/IMulticallTarget.sol/interface.IMulticallTarget.html | ||
|
|
||
| [Quoter API]: /docs/RFQ/Quoting/Quoter%20API/ | ||
| [Dispute Period]: /docs/RFQ/Security/#dispute-period | ||
| [Quoting]: /docs/RFQ/Quoting | ||
| [Bridging]: /docs/RFQ/Bridging | ||
| [Relaying]: /docs/RFQ/Relaying | ||
| [Proving]: /docs/RFQ/Proving | ||
| [Claiming]: /docs/RFQ/Claiming | ||
| [Canceling]: /docs/RFQ/Canceling | ||
| [Security]: /docs/RFQ/Security | ||
| [Exclusivity]: /docs/RFQ/Exclusivity | ||
|
|
||
| [User]: /docs/RFQ/#entities | ||
| [Quoter]: /docs/RFQ/#entities | ||
| [Prover]: /docs/RFQ/#entities | ||
| [Relayer]: /docs/RFQ/#entities | ||
| [Guard]: /docs/RFQ/#entities | ||
| [Canceler]: /docs/RFQ/#entities | ||
|
|
There was a problem hiding this comment.
💡 Codebase verification
Remove unused reference links
The reference links defined at the top of the file are not being used in the actual content of quoteId.md. The document only contains a brief explanation about the quoteId field without using any of the defined references. These unused references should be removed to maintain documentation cleanliness.
- Remove all reference link definitions from
docs/bridge/docs/03-RFQ/15-Bridging/quoteId.mdas they are not used in the content.
🔗 Analysis chain
Verify the usage of reference links across documentation.
While having a consistent set of reference links is good practice, let's verify if these links are used in other documentation files to maintain documentation cleanliness.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Check if the reference links are used in other markdown files
# Get all markdown files in the docs directory
fd -e md -e mdx . docs/bridge/docs | while read -r file; do
echo "Checking $file"
# Check for usage of each reference link
rg -l "\[.*\]\[(relay|prove|dispute|claim|cancel|proof|BridgeRequested|BridgeTransactionV2|BridgeRelayed|BridgeProofProvided|Cancel Delay|Multicall|Quoter API|Dispute Period|Quoting|Bridging|Relaying|Proving|Claiming|Canceling|Security|Exclusivity|User|Quoter|Prover|Relayer|Guard|Canceler)\]" "$file"
done
Length of output: 24849
Script:
#!/bin/bash
# Let's try a different approach to search for reference link usage
# First, let's check the specific file for any reference definitions
echo "=== Checking reference definitions in quoteId.md ==="
rg "^\[.*\]:" docs/bridge/docs/03-RFQ/15-Bridging/quoteId.md
echo -e "\n=== Checking for reference link usage in all markdown files ==="
# Search for reference-style link usage patterns more broadly
for link in relay prove dispute claim cancel proof BridgeRequested BridgeTransactionV2 BridgeRelayed BridgeProofProvided "Cancel Delay" Multicall "Quoter API" "Dispute Period" Quoting Bridging Relaying Proving Claiming Canceling Security Exclusivity User Quoter Prover Relayer Guard Canceler; do
echo -e "\nChecking usage of [$link]:"
rg "\[.*\]\[$link\]" docs/bridge/docs/
done
Length of output: 14081
Script:
#!/bin/bash
# Let's check the content of the quoteId.md file to understand its context
# and see if these references might be used in the actual content
echo "=== Content of quoteId.md ==="
cat docs/bridge/docs/03-RFQ/15-Bridging/quoteId.md
# Also check for any markdown files that might be referencing this file
echo -e "\n=== Files referencing quoteId.md ==="
rg -l "quoteId" docs/bridge/docs/
Length of output: 2862
🧰 Tools
🪛 Markdownlint (0.35.0)
6-6: Unused link or image reference definition: "relay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
7-7: Unused link or image reference definition: "prove"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
8-8: Unused link or image reference definition: "dispute"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
9-9: Unused link or image reference definition: "claim"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
10-10: Unused link or image reference definition: "cancel"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
11-11: Unused link or image reference definition: "proof"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
12-12: Unused link or image reference definition: "bridgerequested"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
13-13: Unused link or image reference definition: "bridgetransactionv2"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
14-14: Unused link or image reference definition: "bridgerelayed"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
15-15: Unused link or image reference definition: "bridgeproofprovided"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "cancel delay"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
17-17: Unused link or image reference definition: "multicall"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
19-19: Unused link or image reference definition: "quoter api"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
20-20: Unused link or image reference definition: "dispute period"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
21-21: Unused link or image reference definition: "quoting"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
22-22: Unused link or image reference definition: "bridging"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
23-23: Unused link or image reference definition: "relaying"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
24-24: Unused link or image reference definition: "proving"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
25-25: Unused link or image reference definition: "claiming"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
26-26: Unused link or image reference definition: "canceling"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
27-27: Unused link or image reference definition: "security"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
28-28: Unused link or image reference definition: "exclusivity"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
30-30: Unused link or image reference definition: "user"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
31-31: Unused link or image reference definition: "quoter"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
32-32: Unused link or image reference definition: "prover"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
33-33: Unused link or image reference definition: "relayer"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
34-34: Unused link or image reference definition: "guard"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
35-35: Unused link or image reference definition: "canceler"
Link and image reference definitions should be needed
(MD053, link-image-reference-definitions)
| Although relaying and claiming can be performed permissionlessly, in the current system Relayers will need to also operate a permissioned [Prover] role. | ||
|
|
||
| Note that this allows the use of different EOAs to [relay], [prove], and [claim] - which we recommend doing. | ||
|
|
||
| We also recommend that Relayers operate a [Quoter] to compete on pricing and routes, but this is not a necessity. |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Highlight permission requirements more prominently
The permission requirements for Relayers are crucial security information but are nested deep in the document. Consider moving this to a more prominent position, possibly right after the introduction.
| As of FastBridgeV2, it is possible to batch many [relay] transactions together with [Multicall] | ||
|
|
||
| However, the Multicall implementation is limited to non-payable transactions only, so native-gas bridges cannot be included in batches. | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Emphasize multicall limitations
The limitation regarding native-gas bridges in multicall batches is a critical implementation detail. Consider adding a warning block to make this more prominent:
+ :::warning
+ Multicall batching does not support native-gas bridges. Ensure your implementation handles these transactions separately.
+ :::📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| As of FastBridgeV2, it is possible to batch many [relay] transactions together with [Multicall] | |
| However, the Multicall implementation is limited to non-payable transactions only, so native-gas bridges cannot be included in batches. | |
| As of FastBridgeV2, it is possible to batch many [relay] transactions together with [Multicall] | |
| However, the Multicall implementation is limited to non-payable transactions only, so native-gas bridges cannot be included in batches. | |
| :::warning | |
| Multicall batching does not support native-gas bridges. Ensure your implementation handles these transactions separately. | |
| ::: |
| ### Function Options | ||
|
|
||
| There are two versions of the claim function in FastBridgeV2. Relayers can use whichever best suits their implementation. | ||
|
|
||
| <div style={{ marginLeft: '20px' }}> | ||
| <blockquote> | ||
| ```solidity | ||
| function claimV2(bytes memory request) external; | ||
| ``` | ||
| This version can only be executed by the `relayer` on the proof. Allows an arbitrary `to` address as the recipient of funds. | ||
| </blockquote> | ||
| <br /> | ||
| <blockquote> | ||
| ```solidity | ||
| function claim(bytes memory request, address to) external; | ||
| ``` | ||
|
|
||
|
|
||
| This version can be executed permissionlessly, and will transfer the funds only to the `relayer` address on the proof. | ||
| </blockquote> | ||
| </div> | ||
|
|
||
| Regardless of the method used, a [BridgeDepositClaimed](https://rfq-contracts.synapseprotocol.com/contracts/interfaces/IFastBridge.sol/interface.IFastBridge.html#bridgedepositclaimed) event will be emitted. | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Enhance function documentation with examples and error handling
The function documentation would benefit from:
- Code examples showing how to use each function
- Description of the
requestparameter structure - Information about possible errors and how to handle them
Consider adding sections like:
#### Example Usage
```solidity
// Example for claimV2
bytes memory request = /* ... */;
fastBridgeV2.claimV2(request);
// Example for claim
bytes memory request = /* ... */;
address to = /* recipient address */;
fastBridgeV2.claim(request, to);Request Parameter
The request parameter should contain:
- Field 1: ...
- Field 2: ...
Error Handling
The functions may revert if:
- The dispute period hasn't ended
- Invalid request format
- Unauthorized caller (for claimV2)
<!-- This is an auto-generated comment by CodeRabbit -->
| Synapse RFQ is an optimistic cross-chain system. This means that any ambiguous actions in the system are assumed to be accurate and honest by default unless they are challenged/disputed within a short timeframe. | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Enhance the introduction with specific security details
The introduction should include:
- The specific timeframe for challenges/disputes
- The security guarantees provided by the system
- The economic implications of the optimistic approach
Would you like me to help draft these additional details?
| When a [dispute] is executed, it effectively negates/erases the [proof] which was asserted by the disputed [prove] transaction. | ||
|
|
||
| This allows for a new corrected [prove] to be submitted and the process begins again. | ||
|
|
||
| If a [relay] truly did occur for the disputed [prove], but it was not for the correct bridge parameters, this constitutes an [invalid relay](/docs/RFQ/Relaying/riskFactors#invalid-relays). | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Clarify dispute implications and recovery process
The section should address:
- The impact on the bridge transaction's state
- The process for submitting a corrected proof
- Any penalties for invalid proofs
- The relationship between disputes and invalid relays
Would you like me to help expand this section with these details?
🧰 Tools
🪛 LanguageTool
[uncategorized] ~74-~74: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short).
Context: ... a new corrected [prove] to be submitted and the process begins again. If a [relay]...
(COMMA_COMPOUND_SENTENCE_2)
| ## Flow Summary | ||
|
|
||
| #### [Quoting] |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Maintain consistent heading hierarchy
The heading structure jumps from h2 to h4. Consider using consistent heading levels:
-## Flow Summary
-
-#### [Quoting]
+## Flow Summary
+
+### [Quoting]📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ## Flow Summary | |
| #### [Quoting] | |
| ## Flow Summary | |
| ### [Quoting] |
🧰 Tools
🪛 Markdownlint (0.35.0)
159-159: Expected: h3; Actual: h4
Heading levels should only increment by one level at a time
(MD001, heading-increment)
157-157: null
Multiple spaces after hash on atx style heading
(MD019, no-multiple-space-atx)
RFQ Docs refactor
Summary by CodeRabbit
New Features
Documentation
2ff6cd8: docs preview link
ae3e100: docs preview link
8447bdf: docs preview link
dadfc32: docs preview link
2453491: docs preview link
c34a0be: docs preview link
a85833e: docs preview link
103228b: docs preview link
691f1bd: docs preview link
c93b165: docs preview link