ci: Solidity gas diff [SLT-259] #3181
Conversation
This reverts commit e7db6e1.
|
Caution Review failedThe pull request is closed. WalkthroughThe pull request introduces changes to the GitHub Actions workflow for Solidity and updates 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
|
Deploying sanguine-fe with
|
| Latest commit: |
35d001e
|
| Status: | ⚡️ Build in progress... |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #3181 +/- ##
===================================================
- Coverage 41.54443% 38.44864% -3.09580%
===================================================
Files 460 424 -36
Lines 25770 24456 -1314
Branches 357 146 -211
===================================================
- Hits 10706 9403 -1303
+ Misses 14326 14315 -11
Partials 738 738
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
![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 and nitpick comments (3)
.github/workflows/solidity.yml (3)
271-281: Improved gas report generationThe new approach to generating gas reports is well-thought-out:
- Excluding tests with "fail" or "revert" in their names helps in getting more accurate gas estimates.
- The semi-deterministic fuzzing approach, using the PR base SHA or current SHA as a seed, balances reproducibility and coverage.
These changes will lead to more consistent and meaningful gas diff reports.
Consider adding a comment in the workflow file explaining the purpose of the FOUNDRY_FUZZ_SEED environment variable for future maintainers.
283-295: Enhanced gas diff visibility in PRsThe addition of steps to compare gas reports and add the results as a sticky comment to PRs is an excellent improvement:
- It leverages the Rubilmax/foundry-gas-diff action for accurate comparisons.
- The sticky comment on PRs improves visibility of gas cost changes during code review.
- Automatic deletion of the comment when there are no gas cost impacts keeps PR discussions clean.
These changes will significantly improve the workflow for reviewing gas cost implications of code changes.
Consider adding a condition to skip the gas diff steps for the 'solidity-devops' package, similar to other steps in this job. This would ensure consistency and potentially save some execution time.
227-227: Minor: Use double quotes in shell commandTo prevent potential issues with word splitting and globbing, consider using double quotes around the
$GITHUB_STEP_SUMMARYvariable:- run: forge coverage --report lcov --report summary >> $GITHUB_STEP_SUMMARY + run: forge coverage --report lcov --report summary >> "$GITHUB_STEP_SUMMARY"This change will make the script more robust against potential edge cases.
🧰 Tools
actionlint
227-227: shellcheck reported issue in this script: SC2086:info:1:50: Double quote to prevent globbing and word splitting
(shellcheck)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (2)
- .github/workflows/solidity.yml (3 hunks)
- packages/contracts-rfq/contracts/FastBridgeV2.sol (4 hunks)
🧰 Additional context used
actionlint
.github/workflows/solidity.yml
227-227: shellcheck reported issue in this script: SC2086:info:1:50: Double quote to prevent globbing and word splitting
(shellcheck)
🔇 Additional comments not posted (9)
.github/workflows/solidity.yml (2)
222-227: Improved test and coverage workflowThe separation of test execution and coverage generation is a good practice. It allows for better visibility into test results and provides a more detailed coverage report. The use of both LCOV and summary reports, with the summary being added to the GitHub step summary, enhances the overall workflow visibility.
🧰 Tools
actionlint
227-227: shellcheck reported issue in this script: SC2086:info:1:50: Double quote to prevent globbing and word splitting
(shellcheck)
243-245: Improved job naming for clarityThe job name change from "snapshot" to "Foundry Gas Diff" more accurately reflects the job's purpose. This improvement in naming convention enhances the workflow's readability and maintainability.
packages/contracts-rfq/contracts/FastBridgeV2.sol (7)
73-75: Approved: Gas optimization withcalldataThe change from
bytes memorytobytes calldatain thegetBridgeTransactionfunction signature is a good optimization. Usingcalldatafor read-only function parameters reduces gas costs, as it avoids unnecessary data copying to memory. This is particularly beneficial for large input data like encoded bridge transactions.
128-130: Approved: Consistent use ofcalldataThe change to
calldatain thisrelayfunction overload is consistent with the optimization applied togetBridgeTransaction. This change will reduce gas costs for callers of this function.Please verify that the internal logic of this function correctly handles the
calldataparameter without attempting to modify it.
214-216: Approved: ConsistentcalldataoptimizationThe change to
calldatain thisclaimfunction overload is consistent with the optimizations applied to other functions. This change will reduce gas costs for callers of this function.Please verify that the internal logic of this function correctly handles the
calldataparameter without attempting to modify it.
263-263: Approved: Consistentcalldataoptimization in refund functionThe change to
calldatain therefundfunction is consistent with the optimizations applied throughout the contract. This change will reduce gas costs for callers of this function. The function's body confirms that therequestparameter is only used for reading (viakeccak256andgetBridgeTransaction), makingcalldataa safe and efficient choice.
Line range hint
1-287: Summary: Consistent gas optimizations across FastBridgeV2The changes in this pull request consistently replace
bytes memorywithbytes calldatafor parameters in public and external functions throughout the FastBridgeV2 contract. This optimization:
- Reduces gas costs for users interacting with the contract.
- Follows best practices for handling read-only byte parameters in Solidity.
- Maintains the existing functionality without introducing apparent vulnerabilities.
These modifications demonstrate a thoughtful approach to gas optimization while preserving the contract's core logic and security.
To ensure these changes don't introduce any regressions:
- Run comprehensive tests focusing on gas consumption before and after these changes.
- Perform a thorough security audit to confirm that the use of
calldatadoesn't introduce any unexpected vulnerabilities.- Update any documentation or interfaces that may reference the old function signatures.
#!/bin/bash # Run gas consumption tests and compare results npm run test:gas # Check for any references to the old function signatures in comments or documentation rg --type solidity "function\s+(getBridgeTransaction|relay|claim|refund)\s*\(\s*bytes\s+memory" ./packages/contracts-rfq/
133-133: Approved:calldataoptimization for public functionThe use of
calldatafor therequestparameter in this publicrelayfunction is a good optimization. It's consistent with the changes in other functions and will reduce gas costs for external calls.Please ensure that:
- This function is not called internally with a
memorybytes array, as it could lead to unnecessary memory-to-calldata copying.- The function's internal logic doesn't attempt to modify the
requestparameter.Run the following script to check for internal calls to this function:
219-219: Approved:calldataoptimization for public claim functionThe use of
calldatafor therequestparameter in this publicclaimfunction is a good optimization. It's consistent with the changes in other functions and will reduce gas costs for external calls.Please ensure that:
- This function is not called internally with a
memorybytes array, as it could lead to unnecessary memory-to-calldata copying.- The function's internal logic doesn't attempt to modify the
requestparameter.Run the following script to check for internal calls to this function:
ChiTimesChi
changed the title
Bundle ReportChanges will decrease total bundle size by 150.12kB (-0.42%) ⬇️. This is within the configured threshold ✅ Detailed changes
ℹ️ *Bundle size includes cached data from a previous commit |
This reverts commit cc35a43.
ChiTimesChi
changed the title
* 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 <abtestingalpha@gmail.com> * Publish - @synapsecns/rest-api@1.0.75 - @synapsecns/synapse-interface@0.38.4 * fix harmony proxy (#3149) Co-authored-by: Trajan0x <trajan0x@users.noreply.github.com> * 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 <trajan0x@users.noreply.github.com> Co-authored-by: abtestingalpha <abtestingalpha@gmail.com> Co-authored-by: parodime <jordan@protochainresearch.com> * Publish - @synapsecns/synapse-interface@0.38.5 - @synapsecns/rfq-indexer-api@1.0.2 - @synapsecns/rfq-indexer@0.0.2 * Adds /destinationTokens route [SLT-204] (#3151) * Adds /destinationTokens route * ZeroAddress & NativeGasAddress * Adds test for native gas tokens * Checksums incoming token address params * Publish - @synapsecns/rest-api@1.0.76 * boba pause (#3150) * boba pause * only boba to txns * Publish - @synapsecns/synapse-interface@0.38.6 * fix(synapse-interface): Reorders validation to check existence first (#3156) * Reorders validation to check existence first * Removes duplicates * Publish - @synapsecns/rest-api@1.0.77 * Fix boba pause (#3158) * Publish - @synapsecns/synapse-interface@0.38.7 * 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/rest-api@1.1.0 - @synapsecns/synapse-interface@0.38.8 - @synapsecns/rfq-indexer-api@1.0.3 - @synapsecns/rfq-indexer@0.0.3 * Pulls version from package json (#3160) * Publish - @synapsecns/rest-api@1.1.1 * Require vs import due to file location (#3161) * Require vs import due to file location * Publish - @synapsecns/rest-api@1.1.2 * Prevent caching of api docs (#3162) * Publish - @synapsecns/rest-api@1.1.3 * 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 <88190723+ChiTimesChi@users.noreply.github.com> * Publish - FastBridge@0.4.0 * 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 <abtestingalpha@gmail.com> * Publish - @synapsecns/rest-api@1.1.4 * 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/rfq-indexer-api@1.0.4 * fix read mes (#3168) * Publish - @synapsecns/contracts-core@1.0.32 - FastBridge@0.4.1 - @synapsecns/solidity-devops@0.4.5 * 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/synapse-interface@0.38.9 * 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 <abtestingalpha@gmail.com> * Publish - @synapsecns/synapse-interface@0.39.0 * fix: formatted bridge fee amount (#3165) * Publish - @synapsecns/rest-api@1.1.5 * 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/contracts-core@1.0.33 - @synapsecns/contracts-rfq@0.5.0 - @synapsecns/solidity-devops@0.4.6 * 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/rest-api@1.2.0 * 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/contracts-rfq@0.5.1 * 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/contracts-rfq@0.5.2 * 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/contracts-core@1.0.34 * feat(rest-api): Adds validateRouteExists validation [SLT-260] (#3180) * Adds validateRouteExists validation * Remove timeouts for 400s * Publish - @synapsecns/rest-api@1.3.0 * add duplicate command warning (#3174) Co-authored-by: Trajan0x <trajan0x@users.noreply.github.com> * reduce solhint warnings on FbV2 (#3189) * reduce solhint warnings on FbV2 * fix whitespace * Publish - @synapsecns/contracts-rfq@0.5.3 * 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/contracts-rfq@0.5.4 * fix(sdk-router): disable ARB airdrop tests (#3195) * Publish - @synapsecns/rest-api@1.3.1 - @synapsecns/sdk-router@0.11.2 - @synapsecns/synapse-interface@0.39.1 - @synapsecns/widget@0.7.2 * Fixing issue for wallet integration [SLT-270] (#3194) * slight modification to graphql call * fixing explorer frontend as well * Publish - @synapsecns/explorer-ui@0.3.3 - @synapsecns/rest-api@1.3.2 * store relayer on relay [SLT-182] (#3170) * store relayer on relay [SLT-182] * +tests, zeroAddr check, fmt * Publish - @synapsecns/contracts-rfq@0.5.5 * Adjust text to trigger build (#3199) * Publish - @synapsecns/synapse-interface@0.39.2 * 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 <82057759+aureliusbtc@users.noreply.github.com> Co-authored-by: ChiTimesChi <88190723+ChiTimesChi@users.noreply.github.com> Co-authored-by: abtestingalpha <abtestingalpha@gmail.com> Co-authored-by: Defi-Moses <Defi-Moses@users.noreply.github.com> Co-authored-by: trajan0x <83933037+trajan0x@users.noreply.github.com> Co-authored-by: Trajan0x <trajan0x@users.noreply.github.com> Co-authored-by: parodime <jordan@protochainresearch.com> Co-authored-by: abtestingalpha <104046418+abtestingalpha@users.noreply.github.com> Co-authored-by: abtestingalpha <abtestingalpha@users.noreply.github.com> Co-authored-by: parodime <parodime@users.noreply.github.com> Co-authored-by: vro <168573323+golangisfun123@users.noreply.github.com> Co-authored-by: ChiTimesChi <ChiTimesChi@users.noreply.github.com> Co-authored-by: bigboydiamonds <57741810+bigboydiamonds@users.noreply.github.com> Co-authored-by: bigboydiamonds <bigboydiamonds@users.noreply.github.com>
Description
Solidity snapshotworkflow with aSolidity Gas Diff, that is supposed to post a PR comment with the gas diffs realted to the contract changes in the PR.Summary by CodeRabbit
Summary by CodeRabbit
New Features
FastBridgeV2contract by updating function parameters to acceptcalldata.Bug Fixes