Package detail

@metamask/sdk-communication-layer

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)
Refactor: backwards compatible originator info (#1292)
Integrate sdk-analytics with SDK (#1289)

Fixed

Updates and Fixes to Analytics (#1294)

0.32.0

Uncategorized

fix(rndemos): update metro config to support eciesjs crypto imports (#1147)
feat: add turborepo for improved monorepo development experience (#1195)

0.31.0

Uncategorized

chore: improve build tooling and modernize dependencies (#1128)

0.30.2

Added

fix: potential security issue with secp256k1 (#1111)

0.30.0

Added

fix: rpc protocol resetting after refresh (#1079)
Release 97.0.0 (#1077)

0.29.2

Uncategorized

chore: bump .change files to 0.29.2 (#1071)

0.29.1

Uncategorized

feat: bump versions for publishing (#1068)

0.29.0

Added

feat: event alignment with async protocol (#1054)
feat: auto activate deeplink protocol when wallet supports it (#1056)
feat: default web url metadata (#1043)
feat: ping to retrieve pending messages from server (#1049)
feat: server events and dappid recovery (#1044)

0.29.0-wallet

Added

feat: async termination of connection (using ack from server) (#1022)
feat: handle connection reject event (#1020)

0.28.2

Added

feat: socket reconnection optimization (#994)

0.28.1

Added

feat: full deeplink protocol (#992)

0.28.0

Added

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

feat: adds connector analytical property (#947)

0.26.4

Added

chore: update SDK dependencies to resolve version conflicts (#921)

0.26.2

Added

feat: cleanup leaking console logs (#907)

0.26.0

Added

feat: add script to align version before publishing (#902)
feat: update dev rn / expo and empty dappid (#897)
feat: prevent empty dappid (#891)
chore: improve unit tests coverage (#888)

0.20.5

Added

fix: ref crossfetch (#871)

0.20.4

Added

chore: update prepare-preview-builds CI job (#869)
fix: crossfetch version not matching comm layer (#860)

0.20.2

Added

skip version because of publishing issue

0.20.1

Added

feat: trigger new version (#840)
Revert "Release 63.0.0" (#839)
Release 62.0.0 (#838)
Revert "feat: release 62.0.0" (#837)
feat: release 62.0.0 (#836)

0.20.0

Added

feat: align version (#835)

0.19.0

Added

feat: full sdk persistence (#823)
feat: update the 'expo-demo' example dapp (#824)

0.18.5

Added

fix: preferDesktop and onboarding (#807)

0.18.4

Added

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

0.18.2

Added

feat: sdk done event on dapp side (#789)

0.18.1

Added

fix: add correct param to sdk_rpc_request_received (#781)
feat: add rpc received event (#780)
feat: store account between refresh (#779)

0.18.0

Added

feat: update prod socket server url (#774)

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)
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)
chore: reduce the bundle size (#725)
feat: sdk bundle size opt methodology (#722)
chore: use the 'debug' package as the new logger (#716)

0.15.0

Added

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

0.14.3

Added

feat: new socket code (#609)

0.14.2

Added

feat: change the 'enableDebug' option to 'enableAnalytics' (#604)

0.14.1

Added

feat: graceful warning instead of throwing keyexchange (#571)

0.14.0

Added

feat: expo keyexchange status and track last rpc id (#554)

0.13.0

Added

Align version with sdk

0.12.3

Added

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: metamask/sdk-ui initial setup (#487)

0.12.0

Added

feat: set minimum required coverage to 50/100 (#473)
feat: socket handling optimization and devnext ui (#468)
feat: expose rpc history tracker (#462)
feat: allow editing otherpublickey for faster connection recovery (#466)
feat: disable favicon in dappmetadata (#467)

0.11.1

Added

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

0.11.0

Added

build: optimize rollup output by env (#450)
fix: socket io event handler not initializing properly (#446)
feat: rename metamask_chainRPCs to metamask_batch and add unit tests (#440)

0.10.1

Added

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

0.10.0

Added

feat: connection recovery edge case (#411)

0.9.0

Added

fix typos (#401)

0.8.0

Added

feat: adds contact form to npm packages (#382)

0.7.1

Added

fix: sdk connection request event (#364)

0.7.0

Added

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 MetaMaskSDK class (#319)

0.6.1

Added

feat: align versions (#323)

0.6.0

Added

feat: improved event tracking (#298)
feat: add unit tests to the SocketService class (#294)
feat: refactor SocketService class for enhanced modularity and testability (#292)
feat: refactor RemoteCommunication class for enhanced modularity and testability (#282)

0.5.3

Added

feat: remove webrtc references (#227)
refactor: simplify connection flow (#226)
feat: cleanup obsolete walletconnect references (#223)
fix: initial connection promise potentially dangling with browser extension (#218)