Skip to content

Commit 9475247

Browse files
authored
docs: deprecate MetaMask SDK in READMEs; point to MetaMask Connect (#1388)
docs: mark MetaMask SDK packages deprecated in READMEs Add deprecation notices pointing consumers to MetaMask Connect (@metamask/connect-evm, @metamask/connect-multichain), connect-monorepo, and migration docs at docs.metamask.io/metamask-connect.
1 parent 338a07a commit 9475247

10 files changed

Lines changed: 130 additions & 10 deletions

File tree

README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,19 @@
1-
# MetaMask SDK
1+
# MetaMask SDK (Deprecated)
2+
3+
> **⚠️ DEPRECATED**
4+
>
5+
> This repository is deprecated and no longer actively maintained. MetaMask SDK has been superseded by **MetaMask Connect**, a ground-up rewrite with a streamlined API, direct wallet communication (no relay server), and multichain support out of the box.
6+
>
7+
> **Migrate to:**
8+
>
9+
> - [`@metamask/connect-evm`](https://www.npmjs.com/package/@metamask/connect-evm) — drop-in EVM dapp integration (browser, Node.js, React Native)
10+
> - [`@metamask/connect-multichain`](https://www.npmjs.com/package/@metamask/connect-multichain) — multichain dapp integration (EVM + non-EVM)
11+
>
12+
> **Migration guide & docs:** <https://docs.metamask.io/metamask-connect>
13+
>
14+
> **New repo:** <https://github.com/MetaMask/connect-monorepo>
15+
16+
---
217

318
[![codecov](https://codecov.io/gh/MetaMask/metamask-sdk/graph/badge.svg?token=6B3Z3724OO)](https://codecov.io/gh/MetaMask/metamask-sdk)
419

packages/sdk-analytics/README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,12 @@
1-
# MetaMask SDK Analytics
1+
# MetaMask SDK Analytics (Deprecated)
2+
3+
> **⚠️ DEPRECATED**
4+
>
5+
> `@metamask/sdk-analytics` is deprecated and no longer actively maintained. Analytics functionality is now provided by [`@metamask/connect-analytics`](https://github.com/MetaMask/connect-monorepo/tree/main/packages/analytics) in the MetaMask Connect monorepo.
6+
>
7+
> **Migration guide & docs:** <https://docs.metamask.io/metamask-connect>
8+
9+
---
210

311
## Overview
412

packages/sdk-communication-layer/README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,17 @@
1-
# MetaMask SDK Communication Layer
1+
# MetaMask SDK Communication Layer (Deprecated)
2+
3+
> **⚠️ DEPRECATED**
4+
>
5+
> `@metamask/sdk-communication-layer` is deprecated and no longer actively maintained. MetaMask Connect replaces the socket-based relay architecture with direct wallet communication via the Mobile Wallet Protocol, eliminating the need for a separate communication layer.
6+
>
7+
> **Migrate to:**
8+
>
9+
> - [`@metamask/connect-evm`](https://www.npmjs.com/package/@metamask/connect-evm) — drop-in EVM dapp integration
10+
> - [`@metamask/connect-multichain`](https://www.npmjs.com/package/@metamask/connect-multichain) — multichain dapp integration
11+
>
12+
> **Migration guide & docs:** <https://docs.metamask.io/metamask-connect>
13+
14+
---
215

316
## Installation
417

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,12 @@
1-
# sdk-install-modal-web
1+
# SDK Install Modal Web (Deprecated)
2+
3+
> **⚠️ DEPRECATED**
4+
>
5+
> This package is deprecated and no longer actively maintained. It has been superseded by the MetaMask Connect packages.
6+
>
7+
> **Migrate to:**
8+
>
9+
> - [`@metamask/connect-evm`](https://www.npmjs.com/package/@metamask/connect-evm) — drop-in EVM dapp integration
10+
> - [`@metamask/connect-multichain`](https://www.npmjs.com/package/@metamask/connect-multichain) — multichain dapp integration
11+
>
12+
> **Migration guide & docs:** <https://docs.metamask.io/metamask-connect>

packages/sdk-multichain-ui/README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,12 @@
1-
# sdk-install-modal-web
1+
# SDK Multichain UI (Deprecated)
2+
3+
> **⚠️ DEPRECATED**
4+
>
5+
> This package is deprecated and no longer actively maintained. It has been superseded by [`@metamask/multichain-ui`](https://github.com/MetaMask/connect-monorepo/tree/main/packages/multichain-ui) in the MetaMask Connect monorepo.
6+
>
7+
> **Migration guide & docs:** <https://docs.metamask.io/metamask-connect>
8+
9+
---
210

311
Install modal web package for multichain, renders and uses the new mobile wallet protocol ConnectionRequest QRCodes.
412

packages/sdk-multichain/README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,17 @@
1-
# MetaMask SDK Multichain
1+
# MetaMask SDK Multichain (Deprecated)
2+
3+
> **⚠️ DEPRECATED**
4+
>
5+
> `@metamask/sdk-multichain` is deprecated and no longer actively maintained. Its functionality has been superseded by **MetaMask Connect**, which provides a cleaner multichain API, direct wallet communication (no relay server), and improved protocol support.
6+
>
7+
> **Migrate to:**
8+
>
9+
> - [`@metamask/connect-multichain`](https://www.npmjs.com/package/@metamask/connect-multichain) — the direct successor for multichain dapp integration
10+
> - [`@metamask/connect-evm`](https://www.npmjs.com/package/@metamask/connect-evm) — if you only need EVM chain support
11+
>
12+
> **Migration guide & docs:** <https://docs.metamask.io/metamask-connect>
13+
14+
---
215

316
The MetaMask SDK Multichain is a protocol-based, domain-driven SDK that enables seamless integration with MetaMask wallets across multiple blockchain networks and platforms.
417

packages/sdk-react-native/README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,17 @@
1-
# MetaMask SDK React Native
1+
# MetaMask SDK React Native (Deprecated)
2+
3+
> **⚠️ DEPRECATED**
4+
>
5+
> `@metamask/sdk-react-native` is deprecated and no longer actively maintained. It has been superseded by **MetaMask Connect**, which offers a streamlined API, direct wallet communication (no relay server), and first-class multichain support.
6+
>
7+
> **Migrate to:**
8+
>
9+
> - [`@metamask/connect-evm`](https://www.npmjs.com/package/@metamask/connect-evm) — drop-in EVM dapp integration (browser, Node.js, React Native)
10+
> - [`@metamask/connect-multichain`](https://www.npmjs.com/package/@metamask/connect-multichain) — multichain dapp integration (EVM + non-EVM)
11+
>
12+
> **Migration guide & docs:** <https://docs.metamask.io/metamask-connect>
13+
14+
---
215

316
The MetaMask SDK React Native allows developers to integrate MetaMask seamlessly into React Native applications.
417

packages/sdk-react-ui/README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,17 @@
1-
# MetaMask SDK React
1+
# MetaMask SDK React UI (Deprecated)
2+
3+
> **⚠️ DEPRECATED**
4+
>
5+
> `@metamask/sdk-react-ui` is deprecated and no longer actively maintained. It has been superseded by **MetaMask Connect**, which offers a streamlined API, direct wallet communication (no relay server), and first-class multichain support.
6+
>
7+
> **Migrate to:**
8+
>
9+
> - [`@metamask/connect-evm`](https://www.npmjs.com/package/@metamask/connect-evm) — drop-in EVM dapp integration (browser, Node.js, React Native)
10+
> - [`@metamask/connect-multichain`](https://www.npmjs.com/package/@metamask/connect-multichain) — multichain dapp integration (EVM + non-EVM)
11+
>
12+
> **Migration guide & docs:** <https://docs.metamask.io/metamask-connect>
13+
14+
---
215

316
The MetaMask SDK React UI allows developer an easier integration to the MetaMask SDK on React-based apps.
417
On top of exporting the hooks from `@metamask/sdk-react`, it also provides wrapper around wagmi hooks and a basic UI button component to connect to MetaMask.

packages/sdk-react/README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,17 @@
1-
# MetaMask SDK React
1+
# MetaMask SDK React (Deprecated)
2+
3+
> **⚠️ DEPRECATED**
4+
>
5+
> `@metamask/sdk-react` is deprecated and no longer actively maintained. It has been superseded by **MetaMask Connect**, which offers a streamlined API, direct wallet communication (no relay server), and first-class multichain support.
6+
>
7+
> **Migrate to:**
8+
>
9+
> - [`@metamask/connect-evm`](https://www.npmjs.com/package/@metamask/connect-evm) — drop-in EVM dapp integration (browser, Node.js, React Native)
10+
> - [`@metamask/connect-multichain`](https://www.npmjs.com/package/@metamask/connect-multichain) — multichain dapp integration (EVM + non-EVM)
11+
>
12+
> **Migration guide & docs:** <https://docs.metamask.io/metamask-connect>
13+
14+
---
215

316
The MetaMask SDK React allows developer an easier integration to the MetaMask SDK on React-based apps.
417

packages/sdk/README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,17 @@
1-
# MetaMask SDK
1+
# MetaMask SDK (Deprecated)
2+
3+
> **⚠️ DEPRECATED**
4+
>
5+
> `@metamask/sdk` is deprecated and no longer actively maintained. It has been superseded by **MetaMask Connect**, which offers a streamlined API, direct wallet communication (no relay server), and first-class multichain support.
6+
>
7+
> **Migrate to:**
8+
>
9+
> - [`@metamask/connect-evm`](https://www.npmjs.com/package/@metamask/connect-evm) — drop-in EVM dapp integration (browser, Node.js, React Native)
10+
> - [`@metamask/connect-multichain`](https://www.npmjs.com/package/@metamask/connect-multichain) — multichain dapp integration (EVM + non-EVM)
11+
>
12+
> **Migration guide & docs:** <https://docs.metamask.io/metamask-connect>
13+
14+
---
215

316
The MetaMask SDK enables developers to easily connect their dapps with a MetaMask wallet (Extension or Mobile) no matter the dapp environment or platform.
417

0 commit comments

Comments
 (0)