Package detail

@metamask/sdk

MetaMask1.1m0.33.0

null

readme

MetaMask SDK

MetaMask SDK enables developers to easily connect their dapps with the MetaMask browser extension and MetaMask Mobile.

It supports the following dapp platforms:

Javascript-based apps
Gaming apps
- Unity
- Unreal Engine (coming soon)
Mobile Native apps
- iOS
- Android

Read more about setting up MetaMask SDK and MetaMask SDK concepts.

This repository contains the JavaScript SDK and examples. You can also see the Android SDK repository and the iOS SDK repository.

Features

Session persistence
Multi MetaMask provider (let user choose between browser extension and mobile wallet)
Batch RPC calls (send multiple requests to your wallet at once)
Read-only RPC calls and Infura integration
Wagmi hook integration (alpha)
i18n
Full modal UI customization
Smart contract library (coming soon)

Get started

Install the SDK:

yarn add @metamask/sdk

npm i @metamask/sdk

Web dapps

See the following examples:

Read the documentation for using the SDK with JavaScript for more information.

React Native

We recommend using React Native v0.71.4 or higher to avoid performance issues on Android.

See the React Native example and read the documentation for using the SDK with React Native for more information.

Node.js

See the Node.js example and read the documentation for using the SDK with Node.js for more information.

Electron

See the Electron example and read the documentation for using the SDK with Electron for more information.

SDK options

See the full list of JavaScript SDK options.

Contributing

To contribute to MetaMask SDK, see the contribution guidelines.

Contacts

Fill out this form for a complimentary design optimization workshop.

changelog

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

0.33.0

Added

Add rpc ingore list to analytics (#1293)
Integrate sdk-analytics with SDK (#1289)

Fixed

Updates and Fixes to Analytics (#1294)

0.32.1

Fixed

fix: Fix analytics for unwanted events when using extension (#1219)

0.32.0

Added

feat(sdk): rollback @metamask/providers to 16.1.0 due to Next.js compatibility issues (#1207)
feat(sdk): upgrade @metamask/providers to ^18.3.1 (#1199)
feat: implement message size validation to prevent excessive payloads (#1197)
feat: add turborepo for improved monorepo development experience (#1195)

Fixed

fix: user rejection bug (#1202)

0.31.5

Added

feat: improves the react connected hook when using extension & emit terminate when using extension (#1186)
chore: add analytics to install modal (#1189)
feat: add MetaMask Flask provider support for EIP-6963 (#1192)
chore: call getPermissions on accountsChanged when using extension (#1185)

Fixed

Fix nextjs localstorage issue (#1193)
fix(MetaMaskInstaller): replace delete with assignment to undefined for window.ethereum (#1162)

0.31.4

Fixed

refactor(sdk): always send RPC requests via network and deeplink (#1181)

0.31.3

Fixed

fix(analytics): improve dapp details tracking and SDK RPC request analytics (#1179)

0.31.2

Fixed

fix: nextjs build fix pr (#1163)
Set initial modal tab based on preferDesktop option (#1158)

0.31.1

Changed

fix: Tell webpack about dynamic import + fixed polyfills (#1151)
chore: removes sdk terminate when accountsChanged comes in empty (#1148)

0.31.0

Changed

refactor(sdk-install-modal-web): migrate from i18next to custom SimpleI18n implementation (#1141)
refactor(sdk-install-modal-web): migrate to StencilJS + Lazy Loading (#1139)
refactor: replace qr-code-styling with smaller library (#1129)

0.30.3

Changed

refactor(sdk): modernize wallet provider detection with EIP-6963 (#1126)

0.30.2

Added

fix: potential security issue with secp256k1 (#1111)
chore: remove the alert of 'SDK Connection has been terminated' (#1095)
fix: chainId for sepolia in infura rpc map (#1105)

0.30.1

Added

feat: deprecate getUniversalLink in favor or display_uri (#1089)
feat: cleanup sdk dependencies (#1088)

0.30.0

Added

feat: wallet_requestpermissions update local provider accounts (#1081)
fix: connectAndSign send as hexString (#1082)
feat: sdk integration improvements (#1080)
feat: fake metamask wallet detection (#1074)
fix: rpc protocol resetting after refresh (#1079)

0.29.3

Added

fix: display_uri event malformed (#1076)

0.29.2

Added

feat: default options for pure js and useDeeplink default to true (#1070)

0.29.1

Added

feat: emit connectWithResponse event (#1067)
feat: always re-emit display uri event (#1066)
fix: improper implementation of handleBatchMethod + more robust tests (#1065)

0.29.0

Added

feat: event alignment with async protocol (#1054)
feat: auto activate deeplink protocol when wallet supports it (#1056)
fix: connectWith potnetially returning incorrect response (#1053)
fix: unit tests (#1055)
feat: default web url metadata (#1043)
feat: missing extension analytics event for personal_sign (#1048)
feat: server events and dappid recovery (#1044)
feat: handle connection reject event (#1020)

0.28.4

Added

fix: update the initializeMobileProvider function to ensure it returns all connected accounts on mobile (#1031)

0.28.3

Added

fix: invalid display_uri event emitted

0.28.2

Added

fix: sdk-react for react-native (#1011)

0.28.1

Added

fix: sdk _selectedAddress not always initialized and rn setup (#1008)

0.28.0

Added

fix: adds a unique id to RPC events for extension (#996)
feat: connectwith working with async key exchange (#1004)
feat: socket reconnection optimization (#994)
feat: full deeplink protocol (#992)
feat: experimental deeplink protocoll (#990)
feat: revert socket server changes (#985)
feat: change the default value for 'dappId' to 'N/A' instead of an empty string (#972)

0.27.0

Added

fix: adds extensionOnly default to true to SDK initialization (#962)
feat: sets extensionOnly default to true (#956)
chore: bump .change files (#957)
feat: improve open deeplink on IOS Chrome (#948)

0.26.5

Added

chore: update the '@metamask/providers' package to version '16.1.0'

0.26.4

Added

chore: removes the 'defaultReadOnlyChainId' option from the SDK options (#919)
chore: update SDK dependencies to resolve version conflicts (#921)
chore: update the 'request' method in the 'wrapExtensionProvider' to throw an error when RPC calls fail (#917)

0.26.3

Added

fix: update the 'request' method wrapper logic in 'wrapExtensionProvider' to handle connectAndSign issues (#913)

0.26.2

Added

chore: terminate on 'ACCOUNTS_CHANGED' event when accounts are zero (#909)

0.26.1

Added

feat: wallet_revokePermissions on terminate (#907)

0.26.0

Added

feat: add script to align version before publishing (#902)
feat: close modal with error 4001 (#898)
feat: emit url event (#901)
chore: improve unit tests coverage (#888)

0.20.5

Added

fix: extension events (#877)
feat: set default sdk source (#875)

0.20.4

Added

feat: create a new SDK for React Native (#859)

0.20.3

Added

feat: re-enable jscc web (#845)

0.20.2

Added

skip version because of publishing issue

0.20.1

Added

skip version because of publishing issue

0.20.0

Added

feat: track done event on extension analytics (#834)

0.19.0

Added

feat: remove rn dependencies (#830)
feat: storage manager (#829)
feat: full sdk persistence (#823)

0.18.6

Added

fix: improve the validation of 'dappId' param in the 'setupAnalytics' function (#817)

0.18.5

Added

fix: preferDesktop and onboarding (#807)
fix: inpage provider support (#806)

0.18.4

Added

fix: prefer desktop (#800)
feat: logging initialization (#799)

0.18.3

Added

fix: issue preventing opting out of analytics (#794)

0.18.2

Added

fix: update the EIP_6369 provider info (#788)

0.18.1

Added

feat: store account between refresh (#779)

0.18.0

Added

feat: update prod socket server url (#774)

0.17.2

Added

feat: separately handle extension connectWith (#767)
fix: normalize uppercase account addresses in SDKProvider, to resolve MaxListenersExceededWarning (#766)

0.17.1

Added

fix: adapt the "devreactnative" DApp for compatibility with new "metaMask/providers" version (#757)
fix: invalid provider state to undefined instead of null (#758)

0.17.0

Added

feat: update the "@metamask/providers" package to version 15.0.0 (#752)
feat: restrict rpc method analytics (#755)
feat: rpc event tracking (#745)
refactor(sdk): update blockedDomainCheck to remove regex (#740)
chore: disable logs when running unit tests in CI (#727)

0.16.0

Added

feat: activate sourcemap support in all packages and resolve issues (#730)
feat: add sdkVersion to analytics (#726)
chore: reduce the bundle size (#725)
feat: sdk bundle size opt methodology (#722)
chore: use the 'debug' package as the new logger (#716)
feat: add support for personal_ecRecover (#707)
feat: expose channel id via hook + expose wallet status via sdk instance (#704)
feat: automated github pages publication (#599)

0.15.0

Added

chore: sourcemaps (#687)
Revert "Release 48.0.0" (#686)
Release 48.0.0 (#684)
feat: disable sourcemaps (#678)
feat: allow connect with request_permissions (#685)
feat: permission system flow (#675)

0.14.3

Added

feat: Conditionally Invoke getMobileProvider in setupExtensionPreferences Based on if Mobile Provider is Availabile (#663)
feat: add dAppTitle to Infura Header for Enhanced dApp Identification (#666)

0.14.2

Added

feat: change the 'enableDebug' option to 'enableAnalytics' (#604)
feat: create an auto-translate script for the internationalization files (#595)
chore: add expo demo app (#577)

0.14.1

Added

feat: ui quick swap and new rpc call metamask_open (#572)
fix: connect with not redirecting (#561)

0.14.0

Added

feat: new rpc call metamask_connectwith (#558)
chore: change favicon from base64 format to url (#550)

0.13.0

Added

feat: add sdk instance to window scope to prevent double init (#546)
fix: transfer the extracted favicon to base64 format in setupDappMetadata (#536)

0.12.4

Added

sdk ui release version

0.12.3

Added

fix: regex in setupDappMetadata function (#528)
feat: add the option to add dapp icon in base64 format (#521)

0.12.2

Added

feat: add the option to add iconUrl to the dappMetadata (#511)
feat: optimize rollup builds (#496)

0.12.1

Added

feat: propagate extension events (#493)
feat: metamask/sdk-ui initial setup (#487)
feat: add backward v3 json compatibility on i18n (#483)

0.12.0

Added

feat: update onboard package (#475)
feat: expose sdk version (#474)
feat: set minimum required coverage to 50/100 (#473)
feat: installmodal deeplink compatibility (#471)
feat: socket handling optimization and devnext ui (#468)
feat: expose rpc history tracker (#462)
refactor: rewrite ios browser version detection for improved readibility (#465)
feat: qrcode deeplinks (#463)
feat: sdk option openDeepLink with dynamic url (#464)

0.11.2

Added

align version with sdk-react* packages

0.11.1

Added

build: improve sdk bundle to work with nodejs strictmode (#457)

0.11.0

Added

feat: enable wagmi config as option (#447)
fix: socket io event handler not initializing properly (#446)
feat: detect qrcode origin on wallet (#443)
feat: rename metamask_chainRPCs to metamask_batch and add unit tests (#440)
fix: add metadata to the sdk_extension_utilized analytics event (#433)
feat: chaining of rpc calls (#434)

0.10.1

Added

feat: send sdk_extension_utilized analytics event when extension is selected from cached choice. (#425)

0.10.0

Added

feat: connectAndSign feature (#410)

0.9.0

Added

feat: add sdk version and change modal order (#405)
feat: implementing internationalization via i18next package (#403)
feat: alias terminate to disconnect on sdk (#399)
fix typos (#401)
fix: modal cleanup and otp selection (#402)

0.8.0

Added

feat: remove npm dependency warnings for peers packages
feat: enable infura http headers for analytics (#387)
feat: cache selected account and selected chain (#385)
feat: adds contact form to npm packages (#382)
feat: updates documentation links and platform status (#378)

0.7.1

Added

feat: allow all react-native peer deps (#366)
fix: sdk connection request event (#364)
feat: wrap eth_accounts when disconnected to allow read only / offline calls (#363)

0.7.0

Added

feat: rpc read only calls and infura provider (#353)
feat: extend the time we resume the session without showing OTP (#348)
feat: add codecov to CI (#343)

0.6.2

Added

feat: add unit tests to the RemoteCommunicationPostMessageStream class (#337)
feat: refactor the RemoteCommunicationPostMessage stream class (#336)
feat: add unit tests to the MobilePortStream class (#335)
feat: add unit tests to the PlatformManager class (#333)
feat: refactor the PlatformManager class (#332)
fix: edge case when modal not fully resetting after termination (#339)
fix: initialize state in _initializeStateAsync to address uninitialized properties issue (#331)
feat: add unit tests to the MetaMaskInstaller class (#326)
feat: refactor the MetaMaskInstaller class (#325)
feat: refactor the SDKProvider class for enhanced modularity and testability (#321)
feat: add unit tests to uncovered parts of the sdk package (#320)
feat: add unit tests to the MetaMaskSDK class (#319)

0.6.1

Added

feat: refactor MetaMaskSDK class for enhanced modularity and testability (#309)

0.6.0

Added

feat: improved event tracking (#298)
feat: reinitialize sdk on termination (#296)
feat: remove invalid connect event (should contain chainId) (#287)
feat: add sideEffects field to sdk package (#286)
feat: refactor the RemoteConnection class (#258)
feat: enable commit hooks and video examples (#252)
feat: restrict autoconnect desktopweb (#248)

0.5.6

Added

feat: force provider connect state (#245)
feat: optimize provider initialization (#243)

0.5.5

Added

fix: install modal unmount (#241)

0.5.4

Added

feat: monorepo examples integration (#239)
feat: check init before connect (+dynamic platform import) (#238)
fix: sdk hook connector error with strictmode (#234)
fix: autoconnection setting (#235)
fix: invalid types during build pipeline (#233)

0.5.3

Added

feat: persist extension provider preferences
feat: remove webrtc references (#227)
refactor: simplify connection flow (#226)
feat: cleanup obsolete walletconnect references (#223)
feat: options to use metamask browser extension only (skip modal) (#220)
fix: initial connection promise potentially dangling with browser extension (#218)

0.5.2

Added

fix: invalid modal state (#213)

0.5.1

Added

Revert "Release 12.0.0" (#210)
Release 12.0.0 (#208)
feat: optimize modal rendering and re-use existing node (#206)

0.5.0

Added

feat: improved event tracking for extension and inappbrowser (#200)
feat: autoextract favicon on web platforms (#196)
feat: default to enable session persistence (#197)
feat: sdk async init (#191)
feat: switch between extension and mobile provider (#189)