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

chore: upgrade gnosis dependencies and move to peerDependencies #1785

Merged
merged 8 commits into from
Aug 13, 2023
Merged

chore: upgrade gnosis dependencies and move to peerDependencies #1785

merged 8 commits into from
Aug 13, 2023

Conversation

MeLlamoPablo
Copy link
Contributor

@MeLlamoPablo MeLlamoPablo commented Jun 23, 2023

Description

This PR upgrades @safe-global/safe-apps-sdk (f.k.a. @gnosis.pm/safe-apps-sdk) to 8.0.0 and @safe-global/safe-apps-provider (f.k.a. @gnosis.pm/safe-apps-provider) to 0.17.1.

It also moves them from dependencies to peerDependencies as this Onboard module shouldn't dictate the Safe Apps SDK version a dApp uses. A dApp may want to load the Safe Apps SDK independently of Onboard and thus listing it on dependencies would result in either two different versions being loaded or the dApp being unable to upgrade the Onboard version.

Note that this is a breaking change as the consumers of this package must install @safe-global/safe-apps-sdk and @safe-global/safe-apps-provider independently.

PLEASE NOTE- Checklist must be complete prior to review.

Checklist

  • Increment the version field in package.json of the package you have made changes in following semantic versioning and using alpha release tagging
  • Check the box that allows repo maintainers to update this PR
  • Test locally to make sure this feature/fix works
  • Run yarn check-all to confirm there are not any associated errors
  • Confirm this PR passes Circle CI checks
  • Add or update relevant information in the documentation

Docs Checklist

  • Include a screenshot of any changes (see docs README on running locally)
    Screenshot 2023-06-23 at 13 38 04
  • Add/update the appropriate package README (if applicable) - Not applicable
  • Add/update the related module in the docs demo (if applicable) - Not applicable
  • Add/update the related package in the docs/package.json file (if applicable) - Not applicable

If this PR includes changes to add an injected wallet or SDK wallet module:

Please complete the following using the internal demo package.
To run this demo use the command yarn && yarn dev to get the project running at http://localhost:8080/

Tests with demo app (injected)

  • send transaction
  • switch chains
  • sign message
  • sign typed message
  • disconnect

Tests with demo app (SDK)

Kindly requesting help with this, as I can't get the dev server running without errors

  • send transaction
  • switch chains
  • sign message
  • sign typed message
  • disconnect

@vercel
Copy link

vercel bot commented Jun 23, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
web3-onboard-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 28, 2023 1:05pm

@socket-security
Copy link

socket-security bot commented Jun 23, 2023

👍 Dependency issues cleared. Learn more about Socket for GitHub ↗︎

This PR previously contained dependency changes with security issues that have been resolved, removed, or ignored.

@socket-security
Copy link

socket-security bot commented Jun 23, 2023

New dependencies detected. Learn more about Socket for GitHub ↗︎

Packages Version New capabilities Transitives Size Publisher
@safe-global/safe-apps-provider 0.17.1 None +16 11.6 MB germartinez
@safe-global/safe-apps-sdk 8.0.0 None +14 11.4 MB germartinez

@taylorjdawson
Copy link
Contributor

@MeLlamoPablo Awesome! We'll test the sdk part on our end and if it looks good we'll merge, thanks for the work!

@Adamj1232
Copy link
Member

@MeLlamoPablo are there any build env settings with the latest packages that need to be noted here in the documentation with the new deps?

@yagopv
Copy link

yagopv commented Jul 17, 2023

Hey, this is Yago from Safe. That's okay with us. Would it be difficult for you to update all the "Gnosis" references to "Safe", including the package name? As you probably know, we are now a separate DAO ☺️

You can remove as well the gnosis-safe.io whitelisted domain as it does not exist anymore

@MeLlamoPablo
Copy link
Contributor Author

Hey guys, I'm currently OOO, just letting you know that I'll take a look as soon as I can, thanks for your comments!

@MeLlamoPablo
Copy link
Contributor Author

@MeLlamoPablo are there any build env settings with the latest packages that need to be noted here in the documentation with the new deps?

I don't think so. Looking through the source code for @safe-global/safe-apps-provider and @safe-global/safe-apps-sdk I don't see any reliance on packages not explicitly listed in dependencies, plus their docs don't mention any special installation instructions (sdk, provider).

@MeLlamoPablo
Copy link
Contributor Author

Hey, this is Yago from Safe. That's okay with us. Would it be difficult for you to update all the "Gnosis" references to "Safe", including the package name? As you probably know, we are now a separate DAO ☺️

You can remove as well the gnosis-safe.io whitelisted domain as it does not exist anymore

Removed references to the domain on 4a11e18 and updated docs and examples on 3e1b9bf. Renaming the package itself is something that the Blocknative team should do.

@taylorjdawson
Copy link
Contributor

@MeLlamoPablo Is this ready for another review? thanks!

@MeLlamoPablo
Copy link
Contributor Author

MeLlamoPablo commented Jul 21, 2023 via email

@yagopv
Copy link

yagopv commented Jul 24, 2023

Hey @MeLlamoPablo thanks for the renaming !! ... really appreciate

@Adamj1232
Copy link
Member

@MeLlamoPablo so you want the name of the package to be changed to Safe?
I feel like just changing the likes and implementations is a little confusing.
If so we will need to mark the package as deprecated and create(copy) a new Safe module.
This will require additional overhead and testing but is probably worth it

@MeLlamoPablo
Copy link
Contributor Author

@MeLlamoPablo so you want the name of the package to be changed to Safe? I feel like just changing the likes and implementations is a little confusing. If so we will need to mark the package as deprecated and create(copy) a new Safe module. This will require additional overhead and testing but is probably worth it

I think the package should eventually be renamed to @web3-onboard/safe, but that should be done on another PR.

@yagopv
Copy link

yagopv commented Jul 25, 2023

Opened an issue for you regarding the renaming #1849. Thanks!

@taylorjdawson
Copy link
Contributor

@MeLlamoPablo Once the merge conflicts are resolved this looks good to go 🙌

@MeLlamoPablo
Copy link
Contributor Author

@MeLlamoPablo Once the merge conflicts are resolved this looks good to go 🙌

Solved!

@taylorjdawson taylorjdawson merged commit 46880de into blocknative:develop Aug 13, 2023
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants