prove w/ tx id [SLT-181] #3169
prove w/ tx id [SLT-181] #3169
Conversation
|
Warning Rate limit exceeded@parodime has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 16 minutes and 47 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. WalkthroughThe changes in this pull request involve modifications to the Changes
Possibly related PRs
Suggested labels
Suggested reviewers
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 using PR comments)
Other keywords and placeholders
Documentation and Community
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #3169 +/- ##
===================================================
- Coverage 41.10994% 38.45493% -2.65502%
===================================================
Files 459 424 -35
Lines 25641 24452 -1189
Branches 342 146 -196
===================================================
- Hits 10541 9403 -1138
+ Misses 14357 14311 -46
+ Partials 743 738 -5
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: |
bcdb258
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://636fc7d8.sanguine-fe.pages.dev |
| Branch Preview URL: | https://feat-fbv2-provewithtxid.sanguine-fe.pages.dev |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Outside diff range and nitpick comments (3)
packages/contracts-rfq/contracts/interfaces/IFastBridgeV2.sol (1)
Line range hint
1-24: Consider broader review to ensure all PR objectives are met.While the changes in this file are consistent with the PR objectives, there might be additional implementations or interface definitions in other files that need to be reviewed. To ensure all PR objectives are met, consider:
- Implementing the additional
provefunction with two parameters(bytes32 transactionId, bytes32 destTxHash)as mentioned in the PR objectives.- Reviewing the implementation of these functions in the concrete contract that implements this interface.
- Updating any related test files to cover the new function signatures.
packages/contracts-rfq/contracts/FastBridgeV2.sol (2)
176-180: LGTM! Consider adding a comment for clarity.The changes align well with the PR objectives. The function now acts as a wrapper, computing the
transactionIdbefore calling the internalprovefunction. This maintains backward compatibility while introducing the new functionality.Consider adding a brief comment explaining the purpose of this wrapper function:
/// @notice Wrapper function to maintain backward compatibility /// @dev Computes transactionId from request before calling the internal prove function function prove(bytes memory request, bytes32 destTxHash) external { bytes32 transactionId = keccak256(request); prove(transactionId, destTxHash, msg.sender); }
184-184: LGTM! Consider updating the function comment.The function signature change aligns perfectly with the PR objectives, accepting
transactionIddirectly. The addition of theonlyRole(RELAYER_ROLE)modifier enhances security by restricting access to authorized relayers only.Consider updating the function comment to reflect the new parameter and the role restriction:
/// @inheritdoc IFastBridgeV2 /// @notice Proves a bridge transaction using the transaction ID /// @dev Only callable by addresses with the RELAYER_ROLE function prove(bytes32 transactionId, bytes32 destTxHash, address relayer) public onlyRole(RELAYER_ROLE) {
Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Files selected for processing (2)
- packages/contracts-rfq/contracts/FastBridgeV2.sol (1 hunks)
- packages/contracts-rfq/contracts/interfaces/IFastBridgeV2.sol (1 hunks)
Additional comments not posted (2)
packages/contracts-rfq/contracts/interfaces/IFastBridgeV2.sol (1)
14-17: LGTM: Function signature and documentation updated correctly.The
provefunction signature has been updated to usebytes32 transactionIdinstead ofbytes memory request, which aligns with the PR objectives. The parameter documentation has also been correctly updated to reflect this change.packages/contracts-rfq/contracts/FastBridgeV2.sol (1)
176-184: Overall assessment: Changes improve functionality and securityThe modifications to the
provefunctions align well with the PR objectives:
- The original
provefunction now acts as a wrapper, maintaining backward compatibility while enabling the use oftransactionIddirectly.- The new
provefunction signature acceptstransactionIddirectly, eliminating the need for on-chain hashing.- The addition of the
onlyRole(RELAYER_ROLE)modifier enhances security by restricting access to authorized relayers.These changes streamline the proving process and improve the contract's overall security and efficiency.
| /// @param destTxHash The destination tx hash proving bridge transaction was relayed | ||
| /// @param relayer The address of the relaying entity which should have control of the origin funds when claimed | ||
| function prove(bytes memory request, bytes32 destTxHash, address relayer) external; | ||
| function prove(bytes32 transactionId, bytes32 destTxHash, address relayer) external; |
There was a problem hiding this comment.
Tip
Codebase Verification
Additional prove function with two parameters not found in IFastBridgeV2.sol.
- The interface
IFastBridgeV2.solonly includes:function prove(bytes32 transactionId, bytes32 destTxHash, address relayer) external;
- The
prove(bytes32 transactionId, bytes32 destTxHash)function mentioned in the PR objectives is missing from the interface.
Analysis chain
Verify implementation of additional functions mentioned in PR objectives.
The PR objectives mention introducing multiple new prove functions, including one with two parameters (bytes32 transactionId, bytes32 destTxHash). However, only one updated function is visible in this interface.
Please confirm if the additional functions mentioned in the PR objectives should be added to this interface. If they are implemented elsewhere, please provide the relevant file locations for review.
Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Search for other prove function implementations
# Test: Search for prove function implementations
rg --type solidity -A 5 'function prove\('
Length of output: 77
Script:
#!/bin/bash
# Description: Search for other prove function implementations in Solidity files
# Search for 'function prove(' within .sol files and include 5 lines of context after each match
rg --glob '*.sol' -A 5 'function prove\('
Length of output: 10212
github-actions
bot
added
needs-go-generate-agents
needs-go-generate-services/rfq
labels
| @@ -173,15 +173,15 @@ contract FastBridgeV2 is Admin, IFastBridgeV2 { | |||
| rebate | |||
| ); | |||
| } | |||
|
|
|||
| } | ||
|
|
||
| /// @inheritdoc IFastBridgeV2 | ||
| function prove(bytes memory request, bytes32 destTxHash, address relayer) public onlyRole(RELAYER_ROLE) { | ||
| bytes32 transactionId = keccak256(request); | ||
| function prove(bytes32 transactionId, bytes32 destTxHash, address relayer) public onlyRole(RELAYER_ROLE) { |
There was a problem hiding this comment.
It seems that we don't currently have coverage for this new function, which explains why tests didn't result in a compilation error. Let's throw in a few cases, could just mirror the existing tests - but focusing on relayer != msg.sender cases for consistent coverage.
There was a problem hiding this comment.
Actionable comments posted: 1
Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Files selected for processing (3)
- packages/contracts-rfq/contracts/FastBridgeV2.sol (1 hunks)
- packages/contracts-rfq/contracts/interfaces/IFastBridgeV2.sol (1 hunks)
- packages/contracts-rfq/test/FastBridgeV2.Src.t.sol (2 hunks)
Files skipped from review as they are similar to previous changes (2)
- packages/contracts-rfq/contracts/FastBridgeV2.sol
- packages/contracts-rfq/contracts/interfaces/IFastBridgeV2.sol
Additional comments not posted (1)
packages/contracts-rfq/test/FastBridgeV2.Src.t.sol (1)
91-94: Newprovefunction overload is correctly implementedThe added
provefunction that acceptstransactionIddirectly is correctly implemented. It properly callsfastBridge.provewith the provided parameters.
| function test_proveOther_revert_callerNotAuthed(address caller) public { | ||
| bytes32 txId = getTxId(tokenTx); | ||
| vm.assume(caller != relayerA && caller != relayerB); | ||
| bridge({caller: userA, msgValue: 0, params: tokenParams}); | ||
| expectUnauthorized(caller, fastBridge.RELAYER_ROLE()); | ||
| prove({caller: caller, transactionId: txId, destTxHash: hex"01", relayer: relayerA}); | ||
| } |
There was a problem hiding this comment.
Ensure test correctly asserts revert for unauthorized caller
In the test_proveOther_revert_callerNotAuthed function, the test aims to verify that unauthorized callers cannot call prove. However, it appears that the test might be missing a vm.expectRevert statement to catch the expected revert. To properly assert that the call reverts as expected, consider adding vm.expectRevert before the prove call.
Apply this diff to fix the test:
function test_proveOther_revert_callerNotAuthed(address caller) public {
bytes32 txId = getTxId(tokenTx);
vm.assume(caller != relayerA && caller != relayerB);
bridge({caller: userA, msgValue: 0, params: tokenParams});
+ vm.expectRevert("Unauthorized");
expectUnauthorized(caller, fastBridge.RELAYER_ROLE());
prove({caller: caller, transactionId: txId, destTxHash: hex"01", relayer: relayerA});
}Committable suggestion was skipped due to low confidence.
Changes to gas cost
🧾 Summary (20% most significant diffs)
Full diff report 👇
|
* update bl * remove global solidity extension settings * use monorepo support in global workspace only * - use Solidity extension for formatting *.sol files - use `forge fmt` as formatter in Solidity extension * REST API Improvements [SLT-179] (#3133) * fix swaptxinfo function * Updates test coverage command * migrating to using token addresses instead of symbols * fix linting errors * fixing swaptxinfocontroller * new tests and new functionality --------- Co-authored-by: abtestingalpha <[email protected]> * Publish - @synapsecns/[email protected] - @synapsecns/[email protected] * fix harmony proxy (#3149) Co-authored-by: Trajan0x <[email protected]> * merging rfq indexer into monorepo [SLT-164] [SLT-176] (#3136) * merging rfq indexer into monorepo * nuke .env * fix commands * fix package name * test coverage script * rough pass at docs and some linting and fixes yarn * Upgrades wagmi & rainbowkit * indxer * Adds invisible but used packages * +recent-invalid-fills [SLT-188] * Moves wagmi to root * new endpoints and clean up linting --------- Co-authored-by: Trajan0x <[email protected]> Co-authored-by: abtestingalpha <[email protected]> Co-authored-by: parodime <[email protected]> * Publish - @synapsecns/[email protected] - @synapsecns/[email protected] - @synapsecns/[email protected] * Adds /destinationTokens route [SLT-204] (#3151) * Adds /destinationTokens route * ZeroAddress & NativeGasAddress * Adds test for native gas tokens * Checksums incoming token address params * Publish - @synapsecns/[email protected] * boba pause (#3150) * boba pause * only boba to txns * Publish - @synapsecns/[email protected] * fix(synapse-interface): Reorders validation to check existence first (#3156) * Reorders validation to check existence first * Removes duplicates * Publish - @synapsecns/[email protected] * Fix boba pause (#3158) * Publish - @synapsecns/[email protected] * update bl * feat(rest-api): Adds Swagger for api docs [SLT-205] (#3159) * Adds Swagger for api docs * Replace prepended verb Get routes with nouns * Adds dev flag for swagger serverUrl * Publish - @synapsecns/[email protected] - @synapsecns/[email protected] - @synapsecns/[email protected] - @synapsecns/[email protected] * Pulls version from package json (#3160) * Publish - @synapsecns/[email protected] * Require vs import due to file location (#3161) * Require vs import due to file location * Publish - @synapsecns/[email protected] * Prevent caching of api docs (#3162) * Publish - @synapsecns/[email protected] * feat(contracts-rfq): relay/prove/claim with different address [SLT-130] (#3138) * init. solidity ^. FbV2 relay/prove/claim overloads * +IFastBridgeV2, explicit address0 cast, func scope & inheritdoc fixes * pragma lock, contract relabel * feat: start scoping V2 tests * test: override relayer role scenarios, no longer enforced by V2 * test: finish the parity test * test: the management methods * test: dst chain scenarios * test: bridge * test: prove * test: claim * test: dispute * test: refund * test: bridge reverts * remove redundant extend. rearrange inherit list * revert 0.8.20 in favor of user (non-ws) setting --------- Co-authored-by: ChiTimesChi <[email protected]> * Publish - [email protected] * fix(promexporter): make spans better (#3164) * move the errors * [goreleaser] * fix v to w * changing native token address standard [SLT-210] (#3157) * changing native token address standard * fixing tests * normalizeNativeTokenAddress middleware, additional tests --------- Co-authored-by: abtestingalpha <[email protected]> * Publish - @synapsecns/[email protected] * Refactoring rfq-indexer API and adding swagger docs [SLT-228] (#3167) * refactoring and adding swagger * remove testing scripts * fix typos and consistency with 404 errors * Publish - @synapsecns/[email protected] * fix read mes (#3168) * Publish - @synapsecns/[email protected] - [email protected] - @synapsecns/[email protected] * fix(opbot): use submitter get tx status [SLT-158] (#3134) * use experimental logger to debug * fix lint * [goreleaser] * use submitter instead of client * [goreleaser] * [goreleaser] * fix(synapse-interface): Additional checks on screen [SLT-166] (#3152) * Additional checks on screen * Adds checks on chain/token changes * Publish - @synapsecns/[email protected] * feat(synapse-interface): confirm new price [SLT-150] (#3084) * add bridge quote history middleware * request user confirm changes when quoted price updates * add conditions for displaying confirm change state * track initial quote initializing confirm change state * specify output delta threshold * callback functions to handle initialize/accept/reset confirm changes flow * quote countdown timer animation to signal refresh * implement automatic refresh intervals * mouse move to refresh automatic intervals * add i8n translations for button text --------- Co-authored-by: abtestingalpha <[email protected]> * Publish - @synapsecns/[email protected] * fix: formatted bridge fee amount (#3165) * Publish - @synapsecns/[email protected] * fix(contracts-rfq): CI workflows [SLT-245] (#3178) * fix: license, files * fix: package name * build: update solhint to latest * build: remove prettier dependencies * fix: solhint workflows * build: update solhint in other packages as well * chore: solhint rules, exceptions * fix: silence linter warnings in tests * chore: forge fmt * add variable to test linter CI * Revert "add variable to test linter CI" This reverts commit 0629309. * Publish - @synapsecns/[email protected] - @synapsecns/[email protected] - @synapsecns/[email protected] * feat(api): bridge limits [SLT-165] (#3179) * adds `/bridgeLimits` route, controller * fetch best sdk quote for min/max origin amounts * add tests * implement middleware to normalize addresses * adds swagger doc * Publish - @synapsecns/[email protected] * fix(contracts-rfq): limit the amount of solhint warnings [SLT-245] (#3182) * ci: limit the amount of solhint warnings * refactor: move the errors into the separate interface * refactor: errors imports in tests * Publish - @synapsecns/[email protected] * ci: Solidity gas diff [SLT-259] (#3181) * ci: run tests w/o coverage first for better visibility * test: malform the test to check the adjusted workflow * Revert "test: malform the test to check the adjusted workflow" This reverts commit e7db6e1. * ci: add gas-diff workflow * try changing the contract to trigger gas diffs * retrigger the workflow * ci: provide the correct report path * ci: run on pull requests only * ci: save gas reports in monorepo root * Revert "ci: run on pull requests only" This reverts commit 0a01d60. * Revert "try changing the contract to trigger gas diffs" This reverts commit 91bc03e. * refactor: wrap if statement * refactor: exclude `solidity-devops` package in a more generic way * ci: run tests w/o coverage for `solidity-devops`, add comments * add generic comment to trigger `solidity-devops` workflows * Revert "add generic comment to trigger `solidity-devops` workflows" This reverts commit cc35a43. * Publish - @synapsecns/[email protected] * fix(contracts-core): set very high gas limit for intensive tests [SLT-259] (#3186) * fix: set very high gas limit for intensive tests * ci: speed up solidity coverage * Publish - @synapsecns/[email protected] * feat(rest-api): Adds validateRouteExists validation [SLT-260] (#3180) * Adds validateRouteExists validation * Remove timeouts for 400s * Publish - @synapsecns/[email protected] * add duplicate command warning (#3174) Co-authored-by: Trajan0x <[email protected]> * reduce solhint warnings on FbV2 (#3189) * reduce solhint warnings on FbV2 * fix whitespace * Publish - @synapsecns/[email protected] * ci: solidity gas diff options [SLT-267] (#3193) * ci: ignore test files in gas diff report * add some changes to the test files * ci: define some options for gas-diff * try changing the contract to trigger gas diffs * Revert "try changing the contract to trigger gas diffs" This reverts commit 4504e3c. * Revert "add some changes to the test files" This reverts commit 7e7d6cb. * prove w/ tx id [SLT-181] (#3169) * prove w/ tx id SLT-181 * +proveOther tests, forge fmt * fmt * fmt * Publish - @synapsecns/[email protected] * fix(sdk-router): disable ARB airdrop tests (#3195) * Publish - @synapsecns/[email protected] - @synapsecns/[email protected] - @synapsecns/[email protected] - @synapsecns/[email protected] * Fixing issue for wallet integration [SLT-270] (#3194) * slight modification to graphql call * fixing explorer frontend as well * Publish - @synapsecns/[email protected] - @synapsecns/[email protected] * store relayer on relay [SLT-182] (#3170) * store relayer on relay [SLT-182] * +tests, zeroAddr check, fmt * Publish - @synapsecns/[email protected] * Adjust text to trigger build (#3199) * Publish - @synapsecns/[email protected] * feat(synapse-interface): refund RFQ transaction [SLT-272] (#3197) * Txn transaction refund tracking * Update store to support tracking * Query FastBridge contract for `bridgeStatuses` to find refund status * Track bridge transaction `bridgeQuote.routerAddress` in store * Fetch FastBridge contract address when only provided router address * add translations --------- Co-authored-by: aureliusbtc <[email protected]> Co-authored-by: ChiTimesChi <[email protected]> Co-authored-by: abtestingalpha <[email protected]> Co-authored-by: Defi-Moses <[email protected]> Co-authored-by: trajan0x <[email protected]> Co-authored-by: Trajan0x <[email protected]> Co-authored-by: parodime <[email protected]> Co-authored-by: abtestingalpha <[email protected]> Co-authored-by: abtestingalpha <[email protected]> Co-authored-by: parodime <[email protected]> Co-authored-by: vro <[email protected]> Co-authored-by: ChiTimesChi <[email protected]> Co-authored-by: bigboydiamonds <[email protected]> Co-authored-by: bigboydiamonds <[email protected]>
Description
Current implementation of
provedoesn’t do anything with the providedbytes request, except for hashing it to derivetransactionId. New functions should taketransactionIddirectly, skipping this step on-chain:prove(bytes32 transactionId, bytes32 destTxHash)prove(bytes memory request, bytes32 desTtxHash)prove(bytes32 transactionId, bytes32 destTxHash, address relayer)prove(bytes memory request, bytes32 desTtxHash, address relayer)prove(bytes memory request, bytes32 desTtxHash, address relayer)(added as per [Different EOA prove/claim](https://www.notion.so/Different-EOA-prove-claim-bf86ed4547174dabba20774a3882f580?pvs=21))Summary by CodeRabbit
New Features
provefunction to enhance clarity and efficiency by changing the input parameter fromrequesttotransactionId.provefunctionality under various conditions, including self-proving and dispute handling.Bug Fixes
provefunction to separate concerns, enhancing overall functionality.