diff --git a/README.md b/README.md index 3dd56db0f..a5a388ebb 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,19 @@ -# MetaMask SDK +# MetaMask SDK (Deprecated) + +> **⚠️ DEPRECATED** +> +> 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. +> +> **Migrate to:** +> +> - [`@metamask/connect-evm`](https://www.npmjs.com/package/@metamask/connect-evm) — drop-in EVM dapp integration (browser, Node.js, React Native) +> - [`@metamask/connect-multichain`](https://www.npmjs.com/package/@metamask/connect-multichain) — multichain dapp integration (EVM + non-EVM) +> +> **Migration guide & docs:** +> +> **New repo:** + +--- [![codecov](https://codecov.io/gh/MetaMask/metamask-sdk/graph/badge.svg?token=6B3Z3724OO)](https://codecov.io/gh/MetaMask/metamask-sdk) diff --git a/packages/sdk-analytics/README.md b/packages/sdk-analytics/README.md index 1bb9503d4..cca78a869 100644 --- a/packages/sdk-analytics/README.md +++ b/packages/sdk-analytics/README.md @@ -1,4 +1,12 @@ -# MetaMask SDK Analytics +# MetaMask SDK Analytics (Deprecated) + +> **⚠️ DEPRECATED** +> +> `@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. +> +> **Migration guide & docs:** + +--- ## Overview diff --git a/packages/sdk-communication-layer/README.md b/packages/sdk-communication-layer/README.md index 86bc3c3a3..389fa412a 100644 --- a/packages/sdk-communication-layer/README.md +++ b/packages/sdk-communication-layer/README.md @@ -1,4 +1,17 @@ -# MetaMask SDK Communication Layer +# MetaMask SDK Communication Layer (Deprecated) + +> **⚠️ DEPRECATED** +> +> `@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. +> +> **Migrate to:** +> +> - [`@metamask/connect-evm`](https://www.npmjs.com/package/@metamask/connect-evm) — drop-in EVM dapp integration +> - [`@metamask/connect-multichain`](https://www.npmjs.com/package/@metamask/connect-multichain) — multichain dapp integration +> +> **Migration guide & docs:** + +--- ## Installation diff --git a/packages/sdk-install-modal-web/README.md b/packages/sdk-install-modal-web/README.md index 6ff73c155..028f359e4 100644 --- a/packages/sdk-install-modal-web/README.md +++ b/packages/sdk-install-modal-web/README.md @@ -1 +1,12 @@ -# sdk-install-modal-web +# SDK Install Modal Web (Deprecated) + +> **⚠️ DEPRECATED** +> +> This package is deprecated and no longer actively maintained. It has been superseded by the MetaMask Connect packages. +> +> **Migrate to:** +> +> - [`@metamask/connect-evm`](https://www.npmjs.com/package/@metamask/connect-evm) — drop-in EVM dapp integration +> - [`@metamask/connect-multichain`](https://www.npmjs.com/package/@metamask/connect-multichain) — multichain dapp integration +> +> **Migration guide & docs:** diff --git a/packages/sdk-multichain-ui/README.md b/packages/sdk-multichain-ui/README.md index a11f0c470..d830bda17 100644 --- a/packages/sdk-multichain-ui/README.md +++ b/packages/sdk-multichain-ui/README.md @@ -1,4 +1,12 @@ -# sdk-install-modal-web +# SDK Multichain UI (Deprecated) + +> **⚠️ DEPRECATED** +> +> 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. +> +> **Migration guide & docs:** + +--- Install modal web package for multichain, renders and uses the new mobile wallet protocol ConnectionRequest QRCodes. diff --git a/packages/sdk-multichain/README.md b/packages/sdk-multichain/README.md index 6fd37f637..49a774e00 100644 --- a/packages/sdk-multichain/README.md +++ b/packages/sdk-multichain/README.md @@ -1,4 +1,17 @@ -# MetaMask SDK Multichain +# MetaMask SDK Multichain (Deprecated) + +> **⚠️ DEPRECATED** +> +> `@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. +> +> **Migrate to:** +> +> - [`@metamask/connect-multichain`](https://www.npmjs.com/package/@metamask/connect-multichain) — the direct successor for multichain dapp integration +> - [`@metamask/connect-evm`](https://www.npmjs.com/package/@metamask/connect-evm) — if you only need EVM chain support +> +> **Migration guide & docs:** + +--- The MetaMask SDK Multichain is a protocol-based, domain-driven SDK that enables seamless integration with MetaMask wallets across multiple blockchain networks and platforms. diff --git a/packages/sdk-react-native/README.md b/packages/sdk-react-native/README.md index a6ab89b8a..4a5e2ce07 100644 --- a/packages/sdk-react-native/README.md +++ b/packages/sdk-react-native/README.md @@ -1,4 +1,17 @@ -# MetaMask SDK React Native +# MetaMask SDK React Native (Deprecated) + +> **⚠️ DEPRECATED** +> +> `@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. +> +> **Migrate to:** +> +> - [`@metamask/connect-evm`](https://www.npmjs.com/package/@metamask/connect-evm) — drop-in EVM dapp integration (browser, Node.js, React Native) +> - [`@metamask/connect-multichain`](https://www.npmjs.com/package/@metamask/connect-multichain) — multichain dapp integration (EVM + non-EVM) +> +> **Migration guide & docs:** + +--- The MetaMask SDK React Native allows developers to integrate MetaMask seamlessly into React Native applications. diff --git a/packages/sdk-react-ui/README.md b/packages/sdk-react-ui/README.md index a57ec94fd..e0f93632c 100644 --- a/packages/sdk-react-ui/README.md +++ b/packages/sdk-react-ui/README.md @@ -1,4 +1,17 @@ -# MetaMask SDK React +# MetaMask SDK React UI (Deprecated) + +> **⚠️ DEPRECATED** +> +> `@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. +> +> **Migrate to:** +> +> - [`@metamask/connect-evm`](https://www.npmjs.com/package/@metamask/connect-evm) — drop-in EVM dapp integration (browser, Node.js, React Native) +> - [`@metamask/connect-multichain`](https://www.npmjs.com/package/@metamask/connect-multichain) — multichain dapp integration (EVM + non-EVM) +> +> **Migration guide & docs:** + +--- The MetaMask SDK React UI allows developer an easier integration to the MetaMask SDK on React-based apps. 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. diff --git a/packages/sdk-react/README.md b/packages/sdk-react/README.md index 57235f7e2..5f72f2cfa 100644 --- a/packages/sdk-react/README.md +++ b/packages/sdk-react/README.md @@ -1,4 +1,17 @@ -# MetaMask SDK React +# MetaMask SDK React (Deprecated) + +> **⚠️ DEPRECATED** +> +> `@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. +> +> **Migrate to:** +> +> - [`@metamask/connect-evm`](https://www.npmjs.com/package/@metamask/connect-evm) — drop-in EVM dapp integration (browser, Node.js, React Native) +> - [`@metamask/connect-multichain`](https://www.npmjs.com/package/@metamask/connect-multichain) — multichain dapp integration (EVM + non-EVM) +> +> **Migration guide & docs:** + +--- The MetaMask SDK React allows developer an easier integration to the MetaMask SDK on React-based apps. diff --git a/packages/sdk/README.md b/packages/sdk/README.md index d85131554..dd49be30f 100644 --- a/packages/sdk/README.md +++ b/packages/sdk/README.md @@ -1,4 +1,17 @@ -# MetaMask SDK +# MetaMask SDK (Deprecated) + +> **⚠️ DEPRECATED** +> +> `@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. +> +> **Migrate to:** +> +> - [`@metamask/connect-evm`](https://www.npmjs.com/package/@metamask/connect-evm) — drop-in EVM dapp integration (browser, Node.js, React Native) +> - [`@metamask/connect-multichain`](https://www.npmjs.com/package/@metamask/connect-multichain) — multichain dapp integration (EVM + non-EVM) +> +> **Migration guide & docs:** + +--- The MetaMask SDK enables developers to easily connect their dapps with a MetaMask wallet (Extension or Mobile) no matter the dapp environment or platform.