feat: @coinbase/wallet-sdk upgrade #3784

nateReiners · 2024-04-03T04:27:19Z

Description

What changes are made in this PR? Is it a feature or a bug fix?

This is just a draft to show what changes are needed in order to upgrade and get the ball rolling
Upgrade @coinbase/wallet-sdk from v3 to v4
v4 is almost ready and includes Coinbase smart wallets!

Additional Information

Bundle size has been cut in half!

https://bundlephobia.com/package/@coinbase/wallet-sdk@4.0.0

Before submitting this issue, please make sure you do the following.

Read the contributing guide
Added documentation related to the changes made.
Added or updated tests (and snapshots) related to the changes made.

changeset-bot · 2024-04-03T04:27:23Z

⚠️ No Changeset found

Latest commit: c50c593

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

vercel · 2024-04-03T04:27:24Z

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

Name	Status	Preview	Comments	Updated (UTC)
wagmi	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	May 14, 2024 4:25am

nateReiners · 2024-04-03T04:31:03Z

packages/connectors/package.json

@@ -45,7 +45,7 @@
    }
  },
  "dependencies": {
-    "@coinbase/wallet-sdk": "3.9.1",
+    "@coinbase/wallet-sdk": "4.0.0-beta.2",


TODO: upgrade to v4 latest when published

jxom · 2024-04-03T04:32:03Z

What are the breaking changes in v4?

tmm · 2024-04-03T04:50:12Z

packages/connectors/src/coinbaseWallet.ts

-  const reloadOnDisconnect = false
-
-  type Provider = CoinbaseWalletProvider
+export function coinbaseWallet(parameters: CoinbaseWalletSDKOptions) {


Let's keep CoinbaseWalletParameters around, even if it just proxies CoinbaseWalletSDKOptions. Gives us more control over the connector's public API.

nateReiners · 2024-04-09T22:57:41Z

What are the breaking changes in v4?

Hey @jxom , For most apps there won't be any necessary code changes other than a version bump. However we did remove a bunch of optional SDK options so apps that were passing in any of those will need to remove them. Details here

arein · 2024-04-10T03:22:31Z

We need a disableSmartWallet option please - also can you please provide a bundle size comparison @nateReiners ? we have thousands of apps using web3modal and we serve your SDK

glitch-txs · 2024-04-10T03:26:39Z

hi @nateReiners we are also using enableMobileWalletLink in Web3Modal, do you know if this would cause some sort of error or conflict in the SDK? It would be a bit tricky for us since Wagmi is just a peer dependency and we cannot control which version devs are using.

nateReiners · 2024-04-10T21:33:24Z

hi @nateReiners we are also using enableMobileWalletLink in Web3Modal, do you know if this would cause some sort of error or conflict in the SDK? It would be a bit tricky for us since Wagmi is just a peer dependency and we cannot control which version devs are using.

Hey @glitch-txs enableMobileWalletLink is gone, but the ability to connect via mobile is enabled by default in v4. When the SDK receives an eth_requestAccounts request, it will open a popup that allows the user to choose between connecting via smart wallet or Coinbase Wallet mobile. You can test out the UX for smart wallet or mobile wallet link here: https://www.smart-wallet.xyz/ Feedback welcome

To remove the option to connect via mobile, dapps can pass in smartWalletOnly: true as an optional SDK option

wilsoncusack · 2024-04-10T21:40:25Z

We need a disableSmartWallet option please - also can you please provide a bundle size comparison @nateReiners ? we have thousands of apps using web3modal and we serve your SDK

Hey Derek can you say more why the disable option is needed?

glitch-txs · 2024-04-10T22:11:59Z

@nateReiners thanks for the quick response! My question is if the SDK will throw an error if I pass it down the enableMobileWalletLink option in v4. In which case it would break Web3Modal if the dev is using an "old" version.

nateReiners · 2024-04-10T22:43:39Z

also can you please provide a bundle size comparison

@arein Yep, just added it to the PR description. gzipped size was reduced by ~20 KB 🎉

jxom · 2024-04-10T22:46:13Z

We need a disableSmartWallet option please - also can you please provide a bundle size comparison @nateReiners ? we have thousands of apps using web3modal and we serve your SDK

Curious why you'd want to disable smart wallets? Shouldn't Web3Modal be agnostic in this sense? I see iOS Coinbase Wallet via Web3Modal the same as what Coinbase Smart Wallet via Web3Modal would be.

nateReiners · 2024-04-10T22:55:59Z

@nateReiners thanks for the quick response! My question is if the SDK will throw an error if I pass it down the enableMobileWalletLink option in v4. In which case it would break Web3Modal if the dev is using an "old" version.

No the SDK wont throw an error. All deprecated options including enableMobileWalletLink are just ignored in v4. It would just be a Typescript issue.

arein · 2024-04-12T04:01:50Z

@jxom @wilsoncusack I can imagine some dapps not wanting this so I think it makes sense to allow them to configure. What rationale went into the option to exclusively use the smart wallet.

nateReiners · 2024-04-24T19:55:07Z

Hey just wanted to drop an update here since I know this has been sitting for some time. We have been making some SDK interface tweaks and I wanted to wait until all of those decisions are solidified before cleaning up this PR.

We are adding the ability to disable smart wallet as part of these tweaks via an 'eoaOnly' option cc: @arein

socket-security · 2024-05-14T00:50:52Z

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

Package	New capabilities	Transitives	Size	Publisher
npm/@coinbase/wallet-sdk@4.0.0	None	`0`	0 B

View full report↗︎

packages/connectors/src/coinbaseWallet.ts

bangtoven

nit: to minimize diff

bangtoven · 2024-05-14T01:20:20Z

packages/connectors/src/coinbaseWallet.ts

-     * @default false
-     */
-    reloadOnDisconnect?: boolean | undefined
+  Mutable<Omit<ConstructorParameters<typeof CoinbaseWalletSDK>[0], "appChainIds">> & {


Suggested change

Mutable<Omit<ConstructorParameters<typeof CoinbaseWalletSDK>[0], "appChainIds">> & {

Mutable<

Omit<

ConstructorParameters<typeof CoinbaseWalletSDK>[0],

'appChainIds' // remove property and use `config.chains`

>

> & {

tmm

Docs will need updating too

https://wagmi.sh/react/api/connectors/coinbaseWallet

tmm · 2024-05-14T03:32:57Z

packages/connectors/src/coinbaseWallet.ts

-  }
+      'appChainIds' // set via wagmi config
+    > & {
+      preference?: Preference


Let's inline Preference

Suggested change

preference?: Preference

preference?: Parameters<CoinbaseWalletSDK['makeWeb3Provider']>[0] | undefined

tmm · 2024-05-14T03:33:11Z

packages/connectors/src/coinbaseWallet.ts

+type Preference = Parameters<CoinbaseWalletSDK['makeWeb3Provider']>[0]
+


Suggested change

type Preference = Parameters<CoinbaseWalletSDK['makeWeb3Provider']>[0]

nateReiners · 2024-05-14T18:17:50Z

Closing in favor of #3928

vercel bot had a problem deploying to Preview – wagmi April 3, 2024 04:28 Failure

nateReiners commented Apr 3, 2024

View reviewed changes

tmm reviewed Apr 3, 2024

View reviewed changes

nateReiners changed the title ~~cb wallet sdk upgrade~~ feat: cb wallet sdk upgrade Apr 9, 2024

imaksp mentioned this pull request Apr 19, 2024

Coinbase Wallet enableMobileWalletLinking showing Coinbase Wallet open app website #3801

Closed

1 task

tmm force-pushed the main branch 2 times, most recently from 4e2d00e to 72a25ee Compare April 25, 2024 19:56

jxom mentioned this pull request Apr 26, 2024

chore: replace wagmi coinbaseWallet with custom connector rainbow-me/rainbowkit#1945

Merged

nateReiners added 4 commits April 30, 2024 10:40

upgrade to v4

b0a6b3d

coinbaseWallet updates

27fbf22

beta 6

ef6402f

upgrade to rc

94b5543

nateReiners force-pushed the nate/cbWalletSdkUpgrade branch from 8c21357 to 94b5543 Compare April 30, 2024 17:41

vercel bot deployed to Preview – wagmi April 30, 2024 17:45 View deployment

bump to rc.2

3c7de35

vercel bot had a problem deploying to Preview – wagmi April 30, 2024 19:39 Failure

nateReiners added 2 commits May 13, 2024 14:14

resolve merge conflicts

29af779

lockfile update

89bf85e

vercel bot deployed to Preview – wagmi May 13, 2024 21:23 View deployment

nateReiners added 3 commits May 13, 2024 17:44

rmv comment

1a40491

undo playground changes

9161318

rmv uneeded change

880a8d0

bangtoven reviewed May 14, 2024

View reviewed changes

packages/connectors/src/coinbaseWallet.ts Outdated Show resolved Hide resolved

packages/connectors/src/coinbaseWallet.ts Show resolved Hide resolved

packages/connectors/src/coinbaseWallet.ts Outdated Show resolved Hide resolved

vercel bot deployed to Preview – wagmi May 14, 2024 01:03 View deployment

rmv unecessary ts and add close backward compatibility

886fb51

vercel bot deployed to Preview – wagmi May 14, 2024 01:12 View deployment

bangtoven reviewed May 14, 2024

View reviewed changes

nateReiners added 3 commits May 13, 2024 18:23

cleanup

0aef28a

formatting

21d9eb1

lint

a19f109

vercel bot deployed to Preview – wagmi May 14, 2024 01:37 View deployment

better Preference type

c6d566c

nateReiners marked this pull request as ready for review May 14, 2024 01:49

nateReiners changed the title ~~feat: cb wallet sdk upgrade~~ feat: @coinbase/wallet-sdk upgrade May 14, 2024

vercel bot deployed to Preview – wagmi May 14, 2024 01:53 View deployment

cleaner

552deea

vercel bot deployed to Preview – wagmi May 14, 2024 02:05 View deployment

tmm reviewed May 14, 2024

View reviewed changes

jxom added 2 commits May 14, 2024 13:40

Merge branch 'main' into nate/cbWalletSdkUpgrade

4632080

chore: tweaks

c50c593

vercel bot deployed to Preview – wagmi May 14, 2024 04:25 View deployment

tmm mentioned this pull request May 14, 2024

feat(connectors): coinbaseWallet v4 #3928

Merged

nateReiners closed this May 14, 2024

bangtoven mentioned this pull request May 14, 2024

#trivial Export constructor parameter types coinbase/coinbase-wallet-sdk#1291

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: @coinbase/wallet-sdk upgrade #3784

feat: @coinbase/wallet-sdk upgrade #3784

nateReiners commented Apr 3, 2024 •

edited

changeset-bot bot commented Apr 3, 2024 •

edited

vercel bot commented Apr 3, 2024 •

edited

nateReiners Apr 3, 2024

jxom commented Apr 3, 2024

tmm Apr 3, 2024

nateReiners commented Apr 9, 2024

arein commented Apr 10, 2024

glitch-txs commented Apr 10, 2024

nateReiners commented Apr 10, 2024

wilsoncusack commented Apr 10, 2024

glitch-txs commented Apr 10, 2024

nateReiners commented Apr 10, 2024

jxom commented Apr 10, 2024 •

edited

nateReiners commented Apr 10, 2024

arein commented Apr 12, 2024

nateReiners commented Apr 24, 2024

socket-security bot commented May 14, 2024 •

edited

bangtoven left a comment

bangtoven May 14, 2024

tmm left a comment

tmm May 14, 2024

tmm May 14, 2024

nateReiners commented May 14, 2024

	preference?: Preference
	preference?: Parameters<CoinbaseWalletSDK['makeWeb3Provider']>[0] \| undefined

		type Preference = Parameters<CoinbaseWalletSDK['makeWeb3Provider']>[0]

feat: @coinbase/wallet-sdk upgrade #3784

feat: @coinbase/wallet-sdk upgrade #3784

Conversation

nateReiners commented Apr 3, 2024 • edited

Description

Additional Information

Bundle size has been cut in half!

changeset-bot bot commented Apr 3, 2024 • edited

⚠️ No Changeset found

vercel bot commented Apr 3, 2024 • edited

nateReiners Apr 3, 2024

Choose a reason for hiding this comment

jxom commented Apr 3, 2024

tmm Apr 3, 2024

Choose a reason for hiding this comment

nateReiners commented Apr 9, 2024

arein commented Apr 10, 2024

glitch-txs commented Apr 10, 2024

nateReiners commented Apr 10, 2024

wilsoncusack commented Apr 10, 2024

glitch-txs commented Apr 10, 2024

nateReiners commented Apr 10, 2024

jxom commented Apr 10, 2024 • edited

nateReiners commented Apr 10, 2024

arein commented Apr 12, 2024

nateReiners commented Apr 24, 2024

socket-security bot commented May 14, 2024 • edited

bangtoven left a comment

Choose a reason for hiding this comment

bangtoven May 14, 2024

Choose a reason for hiding this comment

tmm left a comment

Choose a reason for hiding this comment

tmm May 14, 2024

Choose a reason for hiding this comment

tmm May 14, 2024

Choose a reason for hiding this comment

nateReiners commented May 14, 2024

nateReiners commented Apr 3, 2024 •

edited

changeset-bot bot commented Apr 3, 2024 •

edited

vercel bot commented Apr 3, 2024 •

edited

jxom commented Apr 10, 2024 •

edited

socket-security bot commented May 14, 2024 •

edited