From 1959d823bdcfb4914aafc6b6da8ceedf02fbbf56 Mon Sep 17 00:00:00 2001 From: Alejandro Date: Fri, 17 Jan 2025 14:19:33 +0100 Subject: [PATCH 1/4] docs(metaMask): enhance documentation for MetaMask Connector features and usage - Added a description of the MetaMask Connector's capabilities, including wallet connection management, support for multiple chains, and compatibility with browser and mobile environments. - Clarified the distinction between the MetaMask Connector and the Injected Connector. - Included a link to the MetaMask SDK documentation for further reference. --- site/shared/connectors/metaMask.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/site/shared/connectors/metaMask.md b/site/shared/connectors/metaMask.md index 91cdb74147..68ebec03de 100644 --- a/site/shared/connectors/metaMask.md +++ b/site/shared/connectors/metaMask.md @@ -8,6 +8,8 @@ const connectorsPackageName = 'wagmi/connectors' Connector for [MetaMask SDK](https://github.com/MetaMask/metamask-sdk). +The MetaMask Connector helps you manage wallet connections in your React applications. It supports essential features like connecting, disconnecting, and handling multiple chains, while maintaining compatibility with browser and mobile environments. You can choose between the MetaMask Connector and the Injected Connector—but keep in mind that using the Injected Connector limits your app to the MetaMask browser extension only. + ## Import ```ts-vue @@ -41,8 +43,6 @@ Check out the [MetaMask SDK docs](https://docs.metamask.io/wallet/connect/3rd-pa ### dappMetadata -`DappMetadata | undefined` - Metadata is used to fill details for the UX on confirmation screens in MetaMask, including the following fields: - `name`: `string` - The name of the dapp. @@ -63,8 +63,6 @@ const connector = metaMask({ ### logging -`SDKLoggingOptions | undefined` - Enables SDK-side logging to provide visibility into: - RPC methods being called. @@ -92,8 +90,6 @@ const connector = metaMask({ ### headless -`boolean | undefined` - - Enables headless mode, disabling MetaMask's built-in modal. - Allows developers to create their own modal, such as for displaying a QR code. @@ -120,3 +116,7 @@ EIP-6963 defines a standard way for dapps to interact with multiple wallets simu When MetaMask SDK detects an EIP-6963-compliant provider (such as MetaMask itself), the connector will automatically replace the default injected provider (like `window.ethereum`) with the one provided by MetaMask SDK. See the [`rdns` property](https://wagmi.sh/dev/creating-connectors#properties) for more information. + +## MetaMask SDK Docs + +Check out the [MetaMask SDK docs](https://docs.metamask.io/wallet/connect/metamask-sdk/javascript/react/) for more information. From b53cc2273181b4b263c3e779b2c065052ba87b8c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alejandro=20Jos=C3=A9=20Mena?= <96505286+cxalem@users.noreply.github.com> Date: Thu, 6 Feb 2025 09:38:23 +0100 Subject: [PATCH 2/4] Update site/shared/connectors/metaMask.md Co-authored-by: awkweb --- site/shared/connectors/metaMask.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/site/shared/connectors/metaMask.md b/site/shared/connectors/metaMask.md index 68ebec03de..764ea5f82b 100644 --- a/site/shared/connectors/metaMask.md +++ b/site/shared/connectors/metaMask.md @@ -8,7 +8,7 @@ const connectorsPackageName = 'wagmi/connectors' Connector for [MetaMask SDK](https://github.com/MetaMask/metamask-sdk). -The MetaMask Connector helps you manage wallet connections in your React applications. It supports essential features like connecting, disconnecting, and handling multiple chains, while maintaining compatibility with browser and mobile environments. You can choose between the MetaMask Connector and the Injected Connector—but keep in mind that using the Injected Connector limits your app to the MetaMask browser extension only. +Check out the [MetaMask SDK docs](https://docs.metamask.io/wallet/connect/metamask-sdk/javascript) for more information. ## Import From 74346bfff143cdff551a00790b975fd10f412602 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alejandro=20Jos=C3=A9=20Mena?= <96505286+cxalem@users.noreply.github.com> Date: Thu, 6 Feb 2025 09:38:35 +0100 Subject: [PATCH 3/4] Update site/shared/connectors/metaMask.md Co-authored-by: awkweb --- site/shared/connectors/metaMask.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/site/shared/connectors/metaMask.md b/site/shared/connectors/metaMask.md index 764ea5f82b..c9e7787271 100644 --- a/site/shared/connectors/metaMask.md +++ b/site/shared/connectors/metaMask.md @@ -116,7 +116,3 @@ EIP-6963 defines a standard way for dapps to interact with multiple wallets simu When MetaMask SDK detects an EIP-6963-compliant provider (such as MetaMask itself), the connector will automatically replace the default injected provider (like `window.ethereum`) with the one provided by MetaMask SDK. See the [`rdns` property](https://wagmi.sh/dev/creating-connectors#properties) for more information. - -## MetaMask SDK Docs - -Check out the [MetaMask SDK docs](https://docs.metamask.io/wallet/connect/metamask-sdk/javascript/react/) for more information. From 74025229bfb03dd4353ae6d9e95d379d3fbaa70c Mon Sep 17 00:00:00 2001 From: Alejandro Date: Thu, 6 Feb 2025 12:23:05 +0100 Subject: [PATCH 4/4] docs: add type and description for MetaMask connector options --- site/shared/connectors/metaMask.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/site/shared/connectors/metaMask.md b/site/shared/connectors/metaMask.md index c9e7787271..08a6f4f9cd 100644 --- a/site/shared/connectors/metaMask.md +++ b/site/shared/connectors/metaMask.md @@ -43,6 +43,8 @@ Check out the [MetaMask SDK docs](https://docs.metamask.io/wallet/connect/3rd-pa ### dappMetadata +`DappMetadata | undefined` + Metadata is used to fill details for the UX on confirmation screens in MetaMask, including the following fields: - `name`: `string` - The name of the dapp. @@ -63,6 +65,8 @@ const connector = metaMask({ ### logging +`SDKLoggingOptions | undefined` + Enables SDK-side logging to provide visibility into: - RPC methods being called. @@ -90,6 +94,8 @@ const connector = metaMask({ ### headless +`boolean | undefined` + - Enables headless mode, disabling MetaMask's built-in modal. - Allows developers to create their own modal, such as for displaying a QR code.