feat(sdk-router)!: add support for FastBridgeRouterV2 #2957
Conversation
BREAKING CHANGE: The `bridgeQuote` and `allBridgeQuotes` functions now accept an options object instead of individual optional parameters.
WalkthroughThe recent changes enhance the Changes
Poem
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 as PR comments)
Additionally, you can add CodeRabbit Configuration File (
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #2957 +/- ##
===================================================
+ Coverage 25.70802% 25.71660% +0.00857%
===================================================
Files 771 771
Lines 55613 55610 -3
Branches 80 82 +2
===================================================
+ Hits 14297 14301 +4
+ Misses 39830 39823 -7
Partials 1486 1486
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
|
Converting this to draft until the |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
PR Summary
Support for the FastBridgeRouterV2 contract has been added, introducing a breaking change by consolidating bridge options into a single object.
- README.md: Updated documentation to reflect the new options object for bridge operations, including
originUserAddress. - src/module/synapseModuleSet.ts: Added
originUserAddressparameter togetBridgeRoutesmethod. - src/operations/bridge.ts: Introduced
BridgeQuoteOptionsinterface consolidating parameters likedeadlineandexcludeCCTP. - src/rfq/fastBridgeRouterSet.ts: Enhanced
getBridgeRoutesandcreateRFQDestQuerymethods to supportoriginUserAddress. - src/sdk.test.ts: Updated tests to accommodate the new options object for
FastBridgeRouterV2.
5 file(s) reviewed, 12 comment(s)
Edit PR Review Bot Settings
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range, codebase verification and nitpick comments (4)
packages/sdk-router/src/module/synapseModuleSet.ts (1)
Update function calls and signatures to match the new parameter
The function
getBridgeRouteshas been updated to include an optional parameteroriginUserAddress. However, not all function calls and signatures have been updated to reflect this change. Please update the following instances:
packages/sdk-router/src/operations/bridge.ts:const routes = await moduleSet.getBridgeRoutes( originChainId, destChainId, tokenIn, tokenOut, amountIn, originUserAddress // Add this parameter );
packages/sdk-router/src/rfq/fastBridgeRouterSet.ts:public async getBridgeRoutes( originChainId: number, destChainId: number, tokenIn: string, tokenOut: string, amountIn: BigintIsh, originUserAddress?: string // Add this parameter ) { // Function implementation }
packages/sdk-router/src/router/routerSet.ts:public async getBridgeRoutes( originChainId: number, destChainId: number, tokenIn: string, tokenOut: string, amountIn: BigintIsh, originUserAddress?: string // Add this parameter ) { // Function implementation }Analysis chain
Line range hint
101-111:
LGTM! But verify the function usage in the codebase.The code changes are approved.
However, ensure that all function calls to
getBridgeRoutesmatch the new signature.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify all function calls to `getBridgeRoutes` match the new signature. # Test: Search for the function usage. Expect: Only occurrences of the new signature. rg --type ts -A 5 $'getBridgeRoutes'Length of output: 2094
Script:
#!/bin/bash # Description: Verify that all calls to `getBridgeRoutes` in specific files match the new signature. # Check in `packages/sdk-router/src/operations/bridge.ts` echo "Checking in packages/sdk-router/src/operations/bridge.ts" rg 'getBridgeRoutes' packages/sdk-router/src/operations/bridge.ts -A 3 # Check in `packages/sdk-router/src/rfq/fastBridgeRouterSet.ts` echo "Checking in packages/sdk-router/src/rfq/fastBridgeRouterSet.ts" rg 'getBridgeRoutes' packages/sdk-router/src/rfq/fastBridgeRouterSet.ts -A 3 # Check in `packages/sdk-router/src/router/routerSet.ts` echo "Checking in packages/sdk-router/src/router/routerSet.ts" rg 'getBridgeRoutes' packages/sdk-router/src/router/routerSet.ts -A 3Length of output: 1033
packages/sdk-router/README.md (1)
93-93: Fix the grammatical issue.Use a hyphen for the compound adjective "third-party."
- third party integration + third-party integrationTools
LanguageTool
[uncategorized] ~93-~93: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ncludes smart wallets (like Safe), or a third party integration (like a bridge aggregator s...(EN_COMPOUND_ADJECTIVE_INTERNAL)
packages/sdk-router/src/rfq/fastBridgeRouterSet.ts (1)
96-97: Ensure all function calls togetBridgeRoutesmatch the new signature.The following instances of
getBridgeRoutesdo not include the new optional parameteroriginUserAddress:
packages/sdk-router/src/operations/bridge.ts: lines 1-5packages/sdk-router/src/router/routerSet.ts: lines 1-5packages/sdk-router/src/module/synapseModuleSet.ts: lines 1-5Please update these function calls to include the new optional parameter where necessary.
Analysis chain
LGTM! But verify the function usage in the codebase.
The code changes are approved.
However, ensure that all function calls to
getBridgeRoutesmatch the new signature.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify all function calls to `getBridgeRoutes` match the new signature. # Test: Search for the function usage. Expect: Only occurrences of the new signature. rg --type ts -A 5 $'getBridgeRoutes'Length of output: 2094
packages/sdk-router/src/operations/bridge.ts (1)
Update
bridgeQuotefunction calls to match the new signatureThe refactored
bridgeQuotefunction now includes anoptionsparameter. Ensure that all calls tobridgeQuoteare updated to include this parameter.
- File:
packages/sdk-router/src/sdk.test.ts
- Lines:
- 105
- 111
- 117
- 123
- 129
- 135
- 141
- 147
- 153
- 159
- 165
- 171
- 177
- 183
- 189
- 195
- 201
Please update these function calls to include the
optionsparameter.Analysis chain
Line range hint
98-110:
LGTM! But verify the function usage in the codebase.The refactor enhances readability and maintainability.
Ensure that all calls to
bridgeQuotematch the new signature.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify all function calls to `bridgeQuote` match the new signature. # Test: Search for the function usage. Expect: Only occurrences of the new signature. rg --type js -A 5 $'bridgeQuote'Length of output: 31
Script:
#!/bin/bash # Description: Verify all function calls to `bridgeQuote` match the new signature. # Test: Search for the function usage in a more comprehensive way, including other possible contexts and aliases. rg --type js 'bridgeQuote' -A 5 rg --type ts 'bridgeQuote' -A 5 ast-grep --lang typescript --pattern '$_.$bridgeQuote($$$)'Length of output: 50575
Script:
#!/bin/bash # Description: Verify that all calls to `bridgeQuote` match the new signature with the `options` parameter. # Test: Search for the function usage and ensure the new signature is used. rg --type js 'synapse\.bridgeQuote\(' -A 5 rg --type ts 'synapse\.bridgeQuote\(' -A 5Length of output: 7012
Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Files selected for processing (5)
- packages/sdk-router/README.md (1 hunks)
- packages/sdk-router/src/module/synapseModuleSet.ts (2 hunks)
- packages/sdk-router/src/operations/bridge.ts (5 hunks)
- packages/sdk-router/src/rfq/fastBridgeRouterSet.ts (3 hunks)
- packages/sdk-router/src/sdk.test.ts (2 hunks)
Additional context used
LanguageTool
packages/sdk-router/README.md
[uncategorized] ~93-~93: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ncludes smart wallets (like Safe), or a third party integration (like a bridge aggregator s...(EN_COMPOUND_ADJECTIVE_INTERNAL)
GitHub Check: codecov/patch
packages/sdk-router/src/rfq/fastBridgeRouterSet.ts
[warning] 322-322: packages/sdk-router/src/rfq/fastBridgeRouterSet.ts#L322
Added line #L322 was not covered by tests
[warning] 325-325: packages/sdk-router/src/rfq/fastBridgeRouterSet.ts#L325
Added line #L325 was not covered by tests
[warning] 330-331: packages/sdk-router/src/rfq/fastBridgeRouterSet.ts#L330-L331
Added lines #L330 - L331 were not covered by tests
Additional comments not posted (7)
packages/sdk-router/README.md (1)
80-89: LGTM!The code changes are approved.
packages/sdk-router/src/rfq/fastBridgeRouterSet.ts (1)
316-332: LGTM! But verify the function usage in the codebase and add tests.The code changes are approved.
However, ensure that all function calls to
createRFQDestQuerymatch the new signature and add tests to cover the new logic.Do you want me to generate the unit testing code or open a GitHub issue to track this task?
Verification successful
LGTM! But verify the function usage in the codebase and add tests.
The code changes are approved.
However, ensure that all function calls to
createRFQDestQuerymatch the new signature and add tests to cover the new logic.Do you want me to generate the unit testing code or open a GitHub issue to track this task?
Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify all function calls to `createRFQDestQuery` match the new signature. # Test: Search for the function usage. Expect: Only occurrences of the new signature. rg --type ts -A 5 $'createRFQDestQuery'Length of output: 1025
Script:
#!/bin/bash # Description: Verify all function calls to `createRFQDestQuery` match the new signature across the entire codebase. # Test: Search for the function usage across the codebase. Expect: Only occurrences of the new signature. rg --type ts -A 5 $'createRFQDestQuery'Length of output: 1025
Tools
GitHub Check: codecov/patch
[warning] 322-322: packages/sdk-router/src/rfq/fastBridgeRouterSet.ts#L322
Added line #L322 was not covered by tests
[warning] 325-325: packages/sdk-router/src/rfq/fastBridgeRouterSet.ts#L325
Added line #L325 was not covered by tests
[warning] 330-331: packages/sdk-router/src/rfq/fastBridgeRouterSet.ts#L330-L331
Added lines #L330 - L331 were not covered by testspackages/sdk-router/src/operations/bridge.ts (3)
66-70: LGTM! Ensure documentation is updated.The
BridgeQuoteOptionsinterface consolidates optional parameters, improving code clarity.
59-65: LGTM!The comments provide clear guidance on the usage of the new options.
Also applies to: 72-89, 118-133
Line range hint
142-170:
LGTM! But verify the function usage in the codebase.The refactor enhances readability and maintainability.
Ensure that all calls to
allBridgeQuotesmatch the new signature.packages/sdk-router/src/sdk.test.ts (2)
525-527: LGTM!The changes enhance clarity and extensibility by moving to a more descriptive object format.
566-568: LGTM!The changes enhance clarity and extensibility by moving to a more descriptive object format.
Deploying sanguine-fe with
|
| Latest commit: |
1813785
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://130e3f1e.sanguine-fe.pages.dev |
| Branch Preview URL: | https://sdk-fb-router-v2.sanguine-fe.pages.dev |
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Files selected for processing (3)
- packages/sdk-router/src/rfq/fastBridgeRouterSet.test.ts (1 hunks)
- packages/sdk-router/src/rfq/fastBridgeRouterSet.ts (3 hunks)
- packages/sdk-router/src/sdk.test.ts (2 hunks)
Files skipped from review as they are similar to previous changes (2)
- packages/sdk-router/src/rfq/fastBridgeRouterSet.ts
- packages/sdk-router/src/sdk.test.ts
Additional comments not posted (2)
packages/sdk-router/src/rfq/fastBridgeRouterSet.test.ts (2)
138-144: Test case forcreateRFQDestQuerywithoutoriginUserAddresslooks good.The test case is well-structured and correctly validates the expected behavior of the function when
originUserAddressis not provided.
146-156: Test case forcreateRFQDestQuerywithoriginUserAddresslooks good.The test case is well-structured and correctly validates the expected behavior of the function when
originUserAddressis provided.
There was a problem hiding this comment.
PR Summary
(updates since last review)
Support for the FastBridgeRouterV2 contract has been added, introducing a breaking change by consolidating bridge options into a single object.
- README.md: Updated documentation to reflect the new requirement for the
originUserAddressparameter. - packages/sdk-router/src/constants/addresses.ts: Updated
FastBridgeRoutercontract address to0xd50042193Db100FE0040005e00D5010000007e45. - packages/sdk-router/src/operations/bridge.ts: Introduced structured parameters for bridge-related functions, emphasizing the
originUserAddressparameter. - packages/sdk-router/src/rfq/fastBridgeRouterSet.test.ts: Added tests for
createRFQDestQuerymethod to handleoriginUserAddress. - packages/sdk-router/src/rfq/fastBridgeRouterSet.ts: Modified
createRFQDestQuerymethod visibility to public static for better accessibility.
6 file(s) reviewed, 11 comment(s)
Edit PR Review Bot Settings
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range, codebase verification and nitpick comments (1)
packages/sdk-router/README.md (1)
93-93: Fix hyphenation in the note.Use a hyphen for "third-party integration" as it is a compound adjective.
- third party integration + third-party integrationTools
LanguageTool
[uncategorized] ~93-~93: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ncludes smart wallets (like Safe), or a third party integration (like a bridge aggregator s...(EN_COMPOUND_ADJECTIVE_INTERNAL)
Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Files selected for processing (3)
- packages/sdk-router/README.md (1 hunks)
- packages/sdk-router/src/constants/addresses.ts (1 hunks)
- packages/sdk-router/src/operations/bridge.ts (5 hunks)
Files skipped from review as they are similar to previous changes (1)
- packages/sdk-router/src/operations/bridge.ts
Additional context used
LanguageTool
packages/sdk-router/README.md
[uncategorized] ~93-~93: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ncludes smart wallets (like Safe), or a third party integration (like a bridge aggregator s...(EN_COMPOUND_ADJECTIVE_INTERNAL)
Additional comments not posted (3)
packages/sdk-router/src/constants/addresses.ts (1)
60-60: LGTM! Address format is correct.The
FAST_BRIDGE_ROUTER_ADDRESShas been updated correctly.packages/sdk-router/README.md (2)
80-89: LGTM! The parameter structure is clear and well-documented.The updated function call to
synapseSDK.allBridgeQuotesnow uses an object for parameters, enhancing clarity and extensibility. The mandatoryoriginUserAddressis correctly highlighted.
93-93: LGTM! The note is clear and correctly formatted.The note correctly emphasizes the necessity of providing the
originUserAddressfor smart contract integrations.Tools
LanguageTool
[uncategorized] ~93-~93: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ncludes smart wallets (like Safe), or a third party integration (like a bridge aggregator s...(EN_COMPOUND_ADJECTIVE_INTERNAL)
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range, codebase verification and nitpick comments (1)
packages/sdk-router/README.md (1)
113-113: Use a hyphen for the compound adjective.To improve readability, use a hyphen in "third-party integration."
- third party integration + third-party integrationTools
LanguageTool
[uncategorized] ~113-~113: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ncludes smart wallets (like Safe), or a third party integration (like a bridge aggregator s...(EN_COMPOUND_ADJECTIVE_INTERNAL)
Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Files selected for processing (1)
- packages/sdk-router/README.md (2 hunks)
Additional context used
LanguageTool
packages/sdk-router/README.md
[uncategorized] ~113-~113: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ncludes smart wallets (like Safe), or a third party integration (like a bridge aggregator s...(EN_COMPOUND_ADJECTIVE_INTERNAL)
Additional comments not posted (2)
packages/sdk-router/README.md (2)
100-109: Ensure correct usage of the new options object.The updated
allBridgeQuotesfunction now requires an object withdeadline,excludedModules, andoriginUserAddress. The example provided is clear and accurately reflects the new structure.
113-113: Clarify the importance oforiginUserAddress.The note correctly highlights the necessity of providing the
originUserAddresswhen a smart contract initiates the bridge operation. Ensure this information is prominently displayed to avoid transaction reverts.Tools
LanguageTool
[uncategorized] ~113-~113: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ncludes smart wallets (like Safe), or a third party integration (like a bridge aggregator s...(EN_COMPOUND_ADJECTIVE_INTERNAL)
|
The typescript tests are expected to pass once the FastBridgeRouterV2 is redeployed and this PR is updated with the correct address |
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range, codebase verification and nitpick comments (1)
packages/sdk-router/README.md (1)
113-113: Emphasize the importance oforiginUserAddressand correct hyphenation.The note effectively highlights the critical requirement for smart contract integrations. Correct the hyphenation for clarity.
- ...a third party integration (like a bridge aggregator smart contract). + ...a third-party integration (like a bridge aggregator smart contract).Tools
LanguageTool
[uncategorized] ~113-~113: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ncludes smart wallets (like Safe), or a third party integration (like a bridge aggregator s...(EN_COMPOUND_ADJECTIVE_INTERNAL)
Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Files selected for processing (2)
- packages/sdk-router/README.md (2 hunks)
- packages/sdk-router/src/constants/addresses.ts (1 hunks)
Files skipped from review as they are similar to previous changes (1)
- packages/sdk-router/src/constants/addresses.ts
Additional context used
LanguageTool
packages/sdk-router/README.md
[uncategorized] ~113-~113: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ncludes smart wallets (like Safe), or a third party integration (like a bridge aggregator s...(EN_COMPOUND_ADJECTIVE_INTERNAL)
Additional comments not posted (1)
packages/sdk-router/README.md (1)
100-109: Improved parameter structure forallBridgeQuotesfunction.The new structured object for options enhances clarity and maintainability. Ensure that the
originUserAddressis correctly populated to avoid transaction reverts when a smart contract initiates the bridge operation.
Bundle ReportChanges will decrease total bundle size by 7.86MB ⬇️
|
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Files selected for processing (1)
- packages/sdk-router/src/operations/bridge.ts (6 hunks)
Files skipped from review as they are similar to previous changes (1)
- packages/sdk-router/src/operations/bridge.ts
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range, codebase verification and nitpick comments (2)
packages/sdk-router/README.md (2)
117-117: Fix grammatical issue.Replace "amount of tokens" with "number of tokens."
- the highest amount of tokens on the destination chain. + the highest number of tokens on the destination chain.Tools
LanguageTool
[uncategorized] ~117-~117: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...th the first quote offering the highest amount of tokens on the destination chain. - A...(AMOUNTOF_TO_NUMBEROF)
102-111: EnsureoriginUserAddressis correctly populated in allallBridgeQuotesfunction calls.The
originUserAddressparameter is crucial for smart contract integrations. Ensure it is correctly populated in all calls toallBridgeQuotesto avoid transaction reverts.
- Files to update:
packages/widget/src/state/slices/bridgeQuote/hooks.tspackages/synapse-interface/pages/state-managed-bridge/index.tsxpackages/rest-api/src/app.tspackages/sdk-router/src/sdk.test.tspackages/sdk-router/src/operations/bridge.tsAnalysis chain
Ensure
originUserAddressis correctly populated.The
originUserAddressparameter is crucial for smart contract integrations. Ensure it is correctly populated to avoid transaction reverts.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify all function calls to `allBridgeQuotes` include the `originUserAddress` parameter. # Test: Search for the function usage. Expect: Occurrences of the new structured object. rg --type ts -A 5 $'allBridgeQuotes'Length of output: 7573
Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Files selected for processing (1)
- packages/sdk-router/README.md (2 hunks)
Additional context used
LanguageTool
packages/sdk-router/README.md
[uncategorized] ~117-~117: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...th the first quote offering the highest amount of tokens on the destination chain. - A...(AMOUNTOF_TO_NUMBEROF)
Additional comments not posted (1)
packages/sdk-router/README.md (1)
115-115: LGTM!The note clearly highlights the importance of providing the
originUserAddressfor smart contract integrations.
There was a problem hiding this comment.
PR Summary
(updates since last review)
Support for the FastBridgeRouterV2 contract has been added, introducing a breaking change by consolidating bridge options into a single object.
- README.md: Updated documentation to reflect the new requirement for the
originUserAddressparameter. - packages/sdk-router/src/constants/addresses.ts: Updated
FastBridgeRoutercontract address to0xd50042193Db100FE0040005e00D5010000007e45. - packages/sdk-router/src/operations/bridge.ts: Introduced structured parameters for bridge-related functions, emphasizing the
originUserAddressparameter. - packages/sdk-router/src/rfq/fastBridgeRouterSet.test.ts: Added tests for
createRFQDestQuerymethod to handleoriginUserAddress. - packages/sdk-router/src/rfq/fastBridgeRouterSet.ts: Modified
createRFQDestQuerymethod visibility to public static for better accessibility.
3 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings
packages/sdk-router/README.md
Outdated
| - **Important:** It is crucial to provide the `originUserAddress` when a smart contract will initiate the bridge operation on behalf of the user. This requirement applies to smart wallets (e.g., Safe) and third-party integrations (such as bridge aggregator smart contracts). | ||
| - For native gas tokens (e.g., ETH on Ethereum/Arbitrum, AVAX on Avalanche, etc.), use the specialized address `0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE` instead of the token address for either input or output tokens. | ||
| - The returned list is sorted by the `maxAmountOut` field in descending order, with the first quote offering the highest amount of tokens on the destination chain. | ||
| - All quotes in the list are provided without any slippage applied. To add slippage to the quotes, use the `applyBridgeSlippage` function. |
There was a problem hiding this comment.
lets change the language to "without any slippage settings applied" saying "without any slippage" doesnt fully communicate the point imo
There was a problem hiding this comment.
Fixed in 1813785
| | SynapseBridge | All[^1] | `0x7E7A0e201FD38d3ADAA9523Da6C109a07118C96a` | | ||
| | SynapseBridge | Blast | `0x0000000000365b1d5B142732CF4d33BcddED21Fc` | | ||
| | SynapseCCTP | All | `0xd5a597d6e7ddf373a92C8f477DAAA673b0902F48` | | ||
| | SynapseRFQ | All | `0x00cD000000003f7F682BE4813200893d4e690000` | |
There was a problem hiding this comment.
are the fastbridge routers all at the same address even though the bridge contract is different on blast and linea?
There was a problem hiding this comment.
Yes, the FastBridgeRouter has the same address regardless of FastBridge address
There was a problem hiding this comment.
PR Summary
(updates since last review)
Support for the FastBridgeRouterV2 contract has been added, introducing a breaking change by consolidating bridge options into a single object.
- README.md: Updated documentation to reflect the new requirement for the
originUserAddressparameter. - packages/sdk-router/src/operations/bridge.ts: Introduced structured parameters for bridge-related functions, emphasizing the
originUserAddressparameter. - packages/sdk-router/src/rfq/fastBridgeRouterSet.ts: Modified
createRFQDestQuerymethod visibility to public static for better accessibility. - packages/sdk-router/src/rfq/fastBridgeRouterSet.test.ts: Added tests for
createRFQDestQuerymethod to handleoriginUserAddress.
2 file(s) reviewed, 4 comment(s)
Edit PR Review Bot Settings
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range, codebase verification and nitpick comments (1)
packages/sdk-router/README.md (1)
117-117: Replace "amount" with "number"."Tokens" is a countable noun, so "number of tokens" is more appropriate than "amount of tokens".
- the highest amount of tokens on the destination chain. + the highest number of tokens on the destination chain.Tools
LanguageTool
[uncategorized] ~117-~117: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...th the first quote offering the highest amount of tokens on the destination chain. - A...(AMOUNTOF_TO_NUMBEROF)
Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Files selected for processing (2)
- packages/sdk-router/README.md (3 hunks)
- packages/sdk-router/src/operations/bridge.ts (6 hunks)
Files skipped from review as they are similar to previous changes (1)
- packages/sdk-router/src/operations/bridge.ts
Additional context used
LanguageTool
packages/sdk-router/README.md
[uncategorized] ~117-~117: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...th the first quote offering the highest amount of tokens on the destination chain. - A...(AMOUNTOF_TO_NUMBEROF)
Additional comments not posted (7)
packages/sdk-router/README.md (7)
7-7: No action required.This line is part of the context and does not require any changes.
49-61: No action required.These lines provide context for the bridging functionality and do not require any changes.
102-111: Updated usage ofallBridgeQuotesfunction looks good.The changes correctly reflect the new structure for passing options to the function. Ensure that
originUserAddressis correctly populated to avoid transaction reverts.
115-120: Important notes onallBridgeQuotesfunction usage look good.The notes correctly emphasize the importance of providing the
originUserAddressand other details about the returned quotes.Tools
LanguageTool
[uncategorized] ~117-~117: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...th the first quote offering the highest amount of tokens on the destination chain. - A...(AMOUNTOF_TO_NUMBEROF)
122-123: No action required.These lines provide useful information about the relationship between the
bridgeQuoteandallBridgeQuotesmethods.
49-70: No action required.These lines provide context for the bridging functionality and do not require any changes.
49-61: No action required.These lines provide context for the bridging functionality and do not require any changes.
Description
Adds support for the updated
FastBridgeRouterV2contract. This is a breaking change for the consumers previously using custom options likedeadlineorexcludeCCTP. A single options object is now used instead:sanguine/packages/sdk-router/src/operations/bridge.ts
Lines 60 to 72 in d458ac1
sanguine/packages/sdk-router/src/operations/bridge.ts
Lines 135 to 143 in f4a762f
sanguine/packages/sdk-router/src/operations/bridge.ts
Lines 91 to 99 in f4a762f
Note: integrations that require a smart contract to work (such as a smart wallet like Safe, or a bridge aggregator contract) MUST provide the
originUserAddressoption, otherwise the origin transaction will revert.Summary by CodeRabbit
Summary by CodeRabbit
New Features
originUserAddressparameter for improved handling of smart contract interactions in bridge operations.Documentation
originUserAddresswhen initiating bridge operations.