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

Update Wagmi guide #1669

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update Wagmi guide #1669

wants to merge 1 commit into from

Conversation

alexandratran
Copy link
Contributor

@alexandratran alexandratran commented Oct 23, 2024

Description

This PR makes the following corrections to the Wagmi guide:

  • Removes recommendation to use universal links.
    • Reason: In Wagmi, the option useDeepLink has been removed from exposed parameters, and is now enforced to true.
  • Updates dappMetadata example to include name and url.
  • Removes reference to infuraApiKey option and section explaining the benefits of using the Infura API.
    • Reason: Wagmi already manages the default readonly RPC. So, if a dapp needs this option, it's intentional on their part, and it's only to use the wallet's RPC to reduce the consumption of their own RPC (example: Uniswap). If the user doesn't provide any RPC, Wagmi will provide a default RPC for each chain. The Wagmi Metamask connector will internally inject them in the readonlyRPCMap . So there is no need to detail it in the documentation. 99% of dapps don't need this option when using Wagmi.
  • Removes step 3 using usePrepareContractWrite.
    • Reason: usePrepareContractWrite has been removed in Wagmi v2.

Still to do:

  • Explain that the MetaMask SDK provider will replace the default injected one (no need to filter, etc).
  • Explain how to filter / deduplicate the MetaMask provider. We can provide an example of a ready to use filter function / hook.

See Notion doc.

Issue(s) fixed

Fixes #1668

Preview

Checklist

Complete this checklist before merging your PR:

  • If this PR contains a major change to the documentation content, I have added an entry to the top of the "What's new?" page.
  • The proposed changes have been reviewed and approved by a member of the documentation team.

Copy link

vercel bot commented Oct 23, 2024

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

Name Status Preview Comments Updated (UTC)
metamask-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 23, 2024 7:35pm

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.

Improve Wagmi guide
1 participant