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: Optimize RPC requests when predicting safe address #3780

Merged
merged 2 commits into from
Jun 10, 2024

Conversation

usame-algan
Copy link
Member

@usame-algan usame-algan commented May 30, 2024

What it solves

Noticed this when debugging failing e2e tests the other day. This change reduces the number of RPC requests when calling getAvailableSaltNonce from 3 to 1. Calling SafeFactory.create always checks if the factory contract(s) are deployed on the current network which is not necessary when we just want to predict a safe address.

How this PR fixes it

  • Doesn't create a new instance of SafeFactory every time we want to predict the safe address
  • Instead it now calls the utils function that hte protocol-kit provides directly

How to test it

To see the number of RPC requests in the network panel you have to change from passing the BrowserProvider to passing a JsonRPCProvider. Not sure if DevTools offers a way to observe requests coming from a browser extension.

  1. Creating a Safe should still work
  2. Creating a counterfactual safe should still work
  3. The predicted safe address should still be correct and what the user ends up with eventually once its deployed on chain

Checklist

  • I've tested the branch on mobile 📱
  • I've documented how it affects the analytics (if at all) 📊
  • I've written a unit/e2e test for it (if applicable) 🧑‍💻

@usame-algan usame-algan requested a review from schmanu May 30, 2024 14:00
Copy link

github-actions bot commented May 30, 2024

Copy link

github-actions bot commented May 30, 2024

ESLint Summary View Full Report

Annotations are provided inline on the Files Changed tab. You can also see all annotations that were generated on the annotations page.

Type Occurrences Fixable
Errors 0 0
Warnings 0 0
Ignored 0 N/A
  • Result: ✅ success
  • Annotations: 0 total

Report generated by eslint-plus-action

Copy link

github-actions bot commented May 30, 2024

📦 Next.js Bundle Analysis for safe-wallet-web

This analysis was generated by the Next.js Bundle Analysis action. 🤖

⚠️ Global Bundle Size Increased

Page Size (compressed)
global 950.06 KB (🟡 +31 B)
Details

The global bundle is the javascript bundle that loads alongside every page. It is in its own category because its impact is much higher - an increase to its size means that every page on your website loads slower, and a decrease means every page loads faster.

Any third party scripts you have added directly to your app using the <script> tag are not accounted for in this analysis

If you want further insight into what is behind the changes, give @next/bundle-analyzer a try!

One Page Changed Size

The following page changed size from the code in this PR compared to its base branch:

Page Size (compressed) First Load
/new-safe/create 26.68 KB (🟡 +10 B) 976.74 KB
Details

Only the gzipped size is provided here based on an expert tip.

First Load is the size of the global bundle plus the bundle for the individual page. If a user were to show up to your website and land on a given page, the first load size represents the amount of javascript that user would need to download. If next/link is used, subsequent page loads would only need to download that page's bundle (the number in the "Size" column), since the global bundle has already been downloaded.

Any third party scripts you have added directly to your app using the <script> tag are not accounted for in this analysis

Next to the size is how much the size has increased or decreased compared with the base branch of this PR. If this percentage has increased by 20% or more, there will be a red status indicator applied, indicating that special attention should be given to this.

Copy link

github-actions bot commented May 30, 2024

Coverage report

St.
Category Percentage Covered / Total
🟡 Statements 79.47% 11295/14213
🔴 Branches 58.46% 2699/4617
🟡 Functions 66.67% 1822/2733
🟢 Lines 80.85% 10185/12597

Test suite run success

1436 tests passing in 197 suites.

Report generated by 🧪jest coverage report action from 5b390e2

chainId: BigInt(chainId),
safeAccountConfig: props.safeAccountConfig,
safeDeploymentConfig: {
saltNonce: props.saltNonce,
Copy link
Member

@schmanu schmanu May 30, 2024

Choose a reason for hiding this comment

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

If we do not pass in the safeVersion here the SDK will use its current DEFAULT_SAFE_VERSION.
But we store our LATEST_SAFE_VERSION in the local storage.
Updating the protocol-kit or our interface's safe version could lead to a mismatch which would lead to a mismatch of the predicted Safe address.

Copy link
Member Author

Choose a reason for hiding this comment

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

We call this function before a safe is created where we use LATEST_SAFE_VERSION and don't read anything from local storage. Still makes sense to explicitely add LATEST_SAFE_VERSION here in case there is some unexpected change on the protocol-kit side.

Copy link
Member

Choose a reason for hiding this comment

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

But this function is also used when computing the safeAddress which we store in the undeployedSafes store: https://github.com/safe-global/safe-wallet-web/blob/dev/src/components/new-safe/create/steps/ReviewStep/index.tsx#L179C13-L179C24

So it would def. lead to problems once the versions do not match anymore.

@usame-algan usame-algan requested a review from schmanu May 30, 2024 14:44
@francovenica
Copy link
Contributor

LGTM

Created saveral Safes and CF safes, I didn't had any issues

@katspaugh katspaugh merged commit 6bce0ac into dev Jun 10, 2024
14 checks passed
@katspaugh katspaugh deleted the fix-predict-address branch June 10, 2024 12:34
@github-actions github-actions bot locked and limited conversation to collaborators Jun 10, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

None yet

4 participants