Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(synapse-interface): max gas estimates #2831

Merged
merged 2 commits into from
Jul 2, 2024
Merged

Conversation

bigboydiamonds
Copy link
Collaborator

@bigboydiamonds bigboydiamonds commented Jul 1, 2024

Summary by CodeRabbit

  • Improvements
    • Updated gas cost calculation to set a consistent upper limit buffer for enhanced stability.
    • Provided default handling for undefined maxFeePerGas to prevent potential issues.

dccfd76: synapse-interface preview link

Copy link
Contributor

coderabbitai bot commented Jul 1, 2024

Walkthrough

The recent updates focus on simplifying the gas cost calculation and estimating tools within the project. Specifically, the upperLimitBuffer in the gas cost calculator has been standardized, and redundant code related to the OPTIMISM chain has been removed. Additionally, the gas estimator now correctly handles cases where maxFeePerGas is undefined, ensuring it gracefully defaults to an empty object.

Changes

Files Change Summaries
packages/synapse-interface/utils/calculateGasCost.ts Always sets upperLimitBuffer to 3 and removes OPTIMISM chain code.
packages/synapse-interface/utils/hooks/useGasEstimator.ts Handles undefined maxFeePerGas by defaulting to an empty object.

Poem

A little rabbit hops with glee,
Simplifying code for you and me.
No more complex gas to tweak,
Just constants firm, no longer weak.
Through ethers, gas fees flow,
With ease and grace, algorithms glow.
🚀✨


Tip

Early access features: enabled

We are currently testing the following features in early access:

  • OpenAI gpt-4o model for code reviews and chat: OpenAI claims that this model is better at understanding and generating code than the previous models. We seek your feedback over the next few weeks before making it generally available.

Note:

  • You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file.
  • Please join our Discord Community to provide feedback and report issues.
  • OSS projects are currently opted into early access features by default.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

Deploying sanguine-fe with  Cloudflare Pages  Cloudflare Pages

Latest commit: ef7cd32
Status: ✅  Deploy successful!
Preview URL: https://4e084863.sanguine-fe.pages.dev
Branch Preview URL: https://fix-max-gas-estimates.sanguine-fe.pages.dev

View logs

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between d0f1508 and ef7cd32.

Files selected for processing (2)
  • packages/synapse-interface/utils/calculateGasCost.ts (3 hunks)
  • packages/synapse-interface/utils/hooks/useGasEstimator.ts (1 hunks)
Additional context used
Biome
packages/synapse-interface/utils/hooks/useGasEstimator.ts

[error] 34-34: Unsafe usage of optional chaining.

If it short-circuits with 'undefined' the evaluation will throw TypeError here:

(lint/correctness/noUnsafeOptionalChaining)

Additional comments not posted (2)
packages/synapse-interface/utils/calculateGasCost.ts (2)

1-1: Remove unused import statement.

The import statement for OPTIMISM has been removed, which is good practice to clean up unused imports.


25-25: LGTM! But verify the function usage in the codebase.

The upperLimitBuffer is now a constant value of 3. This change is approved.

However, ensure that this change does not impact other parts of the codebase where upperLimitBuffer might have been dynamically adjusted based on chainId.

Verification successful

Verification Complete: No Issues Found

The upperLimitBuffer is now a constant value of 3 in calculateGasCost and is not dynamically adjusted based on chainId. This change does not impact other parts of the codebase where upperLimitBuffer might have been dynamically adjusted.

  • calculateGasCost usage in useGasEstimator.ts does not show any dynamic adjustment of upperLimitBuffer based on chainId.
Scripts executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Description: Verify all function calls to `calculateGasCost` and check for any dynamic adjustments based on `chainId`.

# Test: Search for the function usage. Expect: No dynamic adjustments based on `chainId`.
rg --type typescript $'calculateGasCost'

Length of output: 74



Script:

#!/bin/bash
# Description: Verify all function calls to `calculateGasCost` and check for any dynamic adjustments based on `chainId`.

# Test: Search for the function usage. Expect: No dynamic adjustments based on `chainId`.
rg 'calculateGasCost' --type-add 'typescript:*.ts' --type-add 'typescript:*.tsx'

Length of output: 502



Script:

#!/bin/bash
# Extract and review the relevant code snippets from `useGasEstimator.ts` to check for any dynamic adjustments based on `chainId`.

# Display lines around the usages of `calculateGasCost` in `useGasEstimator.ts`
rg 'calculateGasCost' -A 5 -B 5 packages/synapse-interface/utils/hooks/useGasEstimator.ts

Length of output: 1341



Script:

#!/bin/bash
# Display the implementation of `calculateGasCost` in `calculateGasCost.ts` to check if `upperLimitBuffer` was previously adjusted based on `chainId`.

rg 'export const calculateGasCost' -A 20 packages/synapse-interface/utils/calculateGasCost.ts

Length of output: 642

@@ -100,7 +100,7 @@ export const useGasEstimator = () => {
const gasData = (await dispatch(
fetchGasData(fromChainId)
)) as PayloadAction<GasDataState>
const { maxFeePerGas } = gasData?.payload?.gasData.formatted
const { maxFeePerGas } = gasData?.payload?.gasData.formatted || {}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! But ensure safe usage of optional chaining.

The handling of maxFeePerGas has been updated to provide a default empty object if maxFeePerGas is undefined. This change is approved.

However, ensure that optional chaining is used safely to avoid runtime errors.

- const { maxFeePerGas } = gasData?.payload?.gasData.formatted || {}
+ const { maxFeePerGas = {} } = gasData?.payload?.gasData.formatted || {}
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.

Suggested change
const { maxFeePerGas } = gasData?.payload?.gasData.formatted || {}
const { maxFeePerGas = {} } = gasData?.payload?.gasData.formatted || {}

Copy link

codecov bot commented Jul 1, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 25.72293%. Comparing base (d0f1508) to head (ef7cd32).

Additional details and impacted files
@@                 Coverage Diff                 @@
##              master       #2831         +/-   ##
===================================================
- Coverage   25.91575%   25.72293%   -0.19282%     
===================================================
  Files            751         709         -42     
  Lines          53890       52218       -1672     
  Branches          80          80                 
===================================================
- Hits           13966       13432        -534     
+ Misses         38480       37408       -1072     
+ Partials        1444        1378         -66     
Flag Coverage Δ
cctp-relayer ?
packages 90.47619% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@trajan0x trajan0x merged commit 6d5fdfe into master Jul 2, 2024
38 checks passed
@trajan0x trajan0x deleted the fix/max-gas-estimates branch July 2, 2024 16:17
@bigboydiamonds bigboydiamonds restored the fix/max-gas-estimates branch July 12, 2024 19:12
@bigboydiamonds bigboydiamonds deleted the fix/max-gas-estimates branch July 12, 2024 19:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants