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

Enhancement: Remove built in UnstoppableDomain resolution, create unstoppable-resolution package for opt in support #1641

Merged
merged 7 commits into from
Apr 18, 2023

Conversation

Adamj1232
Copy link
Member

@Adamj1232 Adamj1232 commented Apr 13, 2023

Description

This PR removes built in support for Unstoppable Domain resolution in favor of an opt-in Unstoppable Domains Resolution package titles unstoppable-resolution

This will reduce the core package bundle size by 0.4mb and still allows for UD resolution with a simple opt-in package

Bundlephobia package analysis:

import Onboard from '@web3-onboard/core'
import unstoppableResolution from '@web3-onboard/unstoppable-resolution'
const onboard = Onboard({
  // ... other Onboard options
  unstoppableResolution
})

Also, marked disableUDResolution as deprecated.

  /**
   * @deprecated Has no effect unless `@web3-onboard/unstoppable-resolution`
   * package has been added and passed into the web3-onboard initialization
   * In this case remove the `@web3-onboard/unstoppable-resolution` package
   * to remove unstoppableDomain resolution support
   */
  disableUDResolution?: boolean

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)
  • Add/update the appropriate package README (if applicable)
  • Add/update the related module in the docs demo (if applicable)
  • Add/update the related package in the docs/package.json file (if applicable)

@vercel
Copy link

vercel bot commented Apr 13, 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 Apr 18, 2023 5:44pm

Copy link
Contributor

@leightkt leightkt left a comment

Choose a reason for hiding this comment

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

code looks good and I was able to test successfully on the demo app

@Adamj1232 Adamj1232 merged commit c3e10b0 into develop Apr 18, 2023
@Adamj1232 Adamj1232 deleted the enhancement/unstoppable_package branch April 18, 2023 18:11
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.

2 participants