Skip to content

Commit

Permalink
re-word
Browse files Browse the repository at this point in the history
  • Loading branch information
alexandratran committed Oct 3, 2024
1 parent aae3c0e commit d7e3c36
Show file tree
Hide file tree
Showing 6 changed files with 19 additions and 16 deletions.
1 change: 1 addition & 0 deletions wallet-sidebar.js
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,7 @@ const sidebar = {
id: "reference/provider-api",
},
],
collapsed: false,
},
],
};
Expand Down
3 changes: 1 addition & 2 deletions wallet/concepts/convenience-libraries.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,7 @@ contracts, for a variety of API preferences (for example, promises, callbacks, a
The [MetaMask Ethereum provider API](wallet-api.md#ethereum-provider-api) is very simple, and wraps
[Ethereum JSON-RPC](wallet-api.md#json-rpc-api) formatted messages, which is why
some developers use a convenience library for interacting with the provider, such as
[Ethers](https://www.npmjs.com/package/ethers), [web3.js](https://www.npmjs.com/package/web3), and
[Embark](https://framework.embarklabs.io/).
[Ethers](https://www.npmjs.com/package/ethers) or [web3.js](https://www.npmjs.com/package/web3).
You can refer to those tools' documentation to use them.

You can [use MetaMask SDK](../connect/metamask-sdk/index.md), which provides a reliable, secure, and
Expand Down
1 change: 0 additions & 1 deletion wallet/concepts/smart-contracts.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,6 @@ Example libraries include the following:

- [Ethers](https://www.npmjs.com/package/ethers)
- [web3.js](https://www.npmjs.com/package/web3)
- [Embark](https://framework.embarklabs.io/)
- [ethjs](https://www.npmjs.com/package/ethjs)
- [Hardhat](https://hardhat.org/)

Expand Down
16 changes: 9 additions & 7 deletions wallet/connect/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ You can connect your dapp to MetaMask using one of the following methods:
- [MetaMask SDK](metamask-sdk/index.md)
- Third-party libraries with SDK support, such as [Wagmi](3rd-party-libraries/wagmi.md) or
[Web3-Onboard](3rd-party-libraries/web3-onboard.md)
- The MetaMask [Wallet API](wallet-api.md) directly
- The [Wallet API](wallet-api.md) directly

The following table compares the supported features of each connection option:

Expand All @@ -18,12 +18,12 @@ The following table compares the supported features of each connection option:
| Connect from a web dapp to the MetaMask extension ||||
| Connect from a web dapp, desktop, mobile, and gaming dapps to MetaMask Mobile ||| |
| Connect to MetaMask using the [EIP-6963 provider](../concepts/wallet-interoperability.md) ||||
| Connect to other wallets using the [EIP-6963 provider](../concepts/wallet-interoperability.md) | |||
| Compatible with other [EIP-6963](../concepts/wallet-interoperability.md) wallets | |||
| Custom RPC methods such as [`connectAndSign`](../how-to/sign-data/connect-and-sign.md), [custom modals](../how-to/display/display-custom-modals.md), [read-only requests](../how-to/make-read-only-requests.md) using Infura API, and [RPC request batching](../how-to/batch-json-rpc-requests.md) ||| |

## MetaMask SDK

MetaMask SDK ensures a reliable and secure connection to MetaMask Mobile across various platforms. For web dapps, it also enables users to connect via the MetaMask browser extension. You can seamlessly integrate MetaMask SDK into existing projects without modifying underlying Wallet API calls.
MetaMask SDK enables a reliable, secure, and seamless connection between your dapp and the MetaMask browser extension or MetaMask Mobile. You can call any Wallet API method from a dapp with the SDK installed, and you can integrate the SDK into existing projects without modifying existing Wallet API calls.

Key features include:

Expand All @@ -32,15 +32,13 @@ Key features include:
- **EIP-6963 detection** – Automatically detect MetaMask wallets, with or without third-party libraries.
- **RPC request batching** – Improve efficiency by batching multiple requests into a single call.


Get started using [MetaMask SDK](metamask-sdk/index.md).

## Third-party libraries

MetaMask SDK integrates seamlessly with libraries like Wagmi and Web3-Onboard, simplifying wallet connections and supporting multiple wallets. These libraries streamline connection logic and offer additional features for managing wallets.

:::note
Trade-offs when using third-party libraries:
:::note Trade-offs when using third-party libraries:

- Reduced control over specific MetaMask features.
- Potential inconsistencies across different wallets due to multi-wallet support.
Expand All @@ -50,6 +48,10 @@ Get started with [Wagmi](3rd-party-libraries/wagmi.md) or [Web3-Onboard](3rd-par

## Wallet API

For direct integration, you can use the Wallet API to manage Ethereum accounts, sign data, and send transactions without the SDK.
The Wallet API consists of an [Ethereum Provider API](../reference/provider-api.md) and a [JSON-RPC API](/wallet/reference/json-rpc-api),
which allow you to interact with users' Ethereum accounts in MetaMask.
For most dapps, we recommend integrating with MetaMask using the SDK or third-party libraries in
conjunction with the Wallet API, to take advantage of the SDK's benefits.
However, you can also connect to MetaMask directly using the Wallet API.

Get started with the [Wallet API](wallet-api.md).
3 changes: 1 addition & 2 deletions wallet/connect/metamask-sdk/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,7 @@ tags:

# MetaMask SDK

MetaMask SDK provides a reliable, secure, and seamless connection between your dapp and MetaMask (extension and Mobile). It supports multiple platforms, ensuring flexibility for your integration needs.

MetaMask SDK enables a reliable, secure, and seamless connection between your dapp and the MetaMask browser extension or MetaMask Mobile. It provides cross-platform compatibility with a consistent user experience.
Key features include:

- **Multi-platform support** – Connect from web, desktop, mobile, and gaming platforms.
Expand Down
11 changes: 7 additions & 4 deletions wallet/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,23 @@ title: Introduction

# Integrate your dapp with the MetaMask wallet

MetaMask provides powerful tools for connecting dapps to wallets. With **MetaMask SDK**, developers can easily create seamless wallet connections across desktop and mobile platforms. The **Wallet API** offers flexibility in interacting with wallets and blockchain networks using standardized JSON-RPC calls, enabling direct access to key functionalities.
Integrate your dapp with MetaMask using **MetaMask SDK** and the **Wallet API**.
Use MetaMask SDK to create a seamless connection between your dapp and MetaMask across desktop and mobile platforms.
Use the Wallet API to interact with users' Ethereum accounts in MetaMask.

Get started by [connecting to MetaMask](connect/index.md).

## Why use MetaMask SDK?

**MetaMask SDK** allows you to establish a reliable connection between your dapp and the MetaMask browser extension or MetaMask Mobile, providing cross-platform compatibility with a consistent user experience. Key benefits include:
**MetaMask SDK** enables a reliable, secure, and seamless connection between your dapp and the MetaMask browser extension or MetaMask Mobile. It provides cross-platform compatibility with a consistent user experience. Key benefits include:

- **Cross-platform compatibility**Integrate with MetaMask from desktop, iOS, Android, React Native, and more.
- **Multi-platform support**Connect from web, desktop, mobile, and gaming platforms.
- **Seamless connections** – Minimize reconnections and improve user experience, especially on mobile.
- **Mobile-first optimization** – Enable faster wallet interactions with instant deeplinks and advanced features.
- **Enhanced functionality** – Use [RPC request batching](how-to/batch-json-rpc-requests.md), [EIP-6963](/wallet/concepts/wallet-interoperability.md) for wallet discovery, and wallet security enhancements.

For more control, the **Wallet API** allows developers to interact with wallets, manage Ethereum accounts, and call JSON-RPC methods, with or without the SDK.
The **Wallet API** allows you to interact with users' Ethereum accounts, manage blockchain networks, and more, using standardized JSON-RPC calls.
While you can connect to MetaMask directly using just the Wallet API, we recommend using the SDK with the Wallet API to take advantage of the SDK's benefits.

## Where do I start?

Expand Down

0 comments on commit d7e3c36

Please sign in to comment.