Skip to content

Commit

Permalink
Update provider documentation with deprecation dates (MetaMask#163)
Browse files Browse the repository at this point in the history
* update provider documentation with dates

Co-authored-by: Mark Stacey <[email protected]>
  • Loading branch information
rekmarks and Gudahtt authored Aug 14, 2020
1 parent bef5bee commit 0cd9c7d
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 6 deletions.
14 changes: 9 additions & 5 deletions docs/guide/ethereum-provider.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,12 @@
# Ethereum Provider API

::: tip Recommended Reading
We recommend that all web3 site developers read the [Upcoming Breaking Changes](#upcoming-breaking-changes) and [Basic Usage](#basic-usage) sections.
We recommend that all web3 site developers read the [Basic Usage](#basic-usage) section.
:::

::: warning Upcoming Breaking Changes
On **November 16, 2020**, we are introducing changes that may break certain web3 sites.
Please see the [Upcoming Breaking Changes](#upcoming-breaking-changes) section for details.
:::

MetaMask injects a global API into websites visited by its users at `window.ethereum`.
Expand Down Expand Up @@ -33,7 +38,7 @@ if (provider) {
## Upcoming Breaking Changes

::: warning Important Information
In the near future, we are making changes to our provider API that will be breaking for some web3 sites.
On **November 16, 2020**, we are making changes to our provider API that will be breaking for some web3 sites.
These changes are _upcoming_, but you can prepare for them today.
Follow [this GitHub issue](https://github.com/MetaMask/metamask-extension/issues/8077) for updates.

Expand All @@ -43,9 +48,6 @@ Other than that, if you are new to using the provider, you do not have to worry

### `window.ethereum` API Changes

In the near future, we are introducing some breaking changes to this API, which we encourage you to
[read more about here](https://medium.com/metamask/breaking-changes-to-the-metamask-inpage-provider-b4dde069dd0a).

At that time, we will:

- Ensure that chain IDs returned by `eth_chainId` are **not** 0-padded
Expand All @@ -66,6 +68,8 @@ Please read our [Migration Guide](./provider-migration.html) for more details.

::: tip
If you do not use the `window.web3` object injected by MetaMask, you will not be affected by these changes.

To understand why we're removing `window.web3`, please see [this GitHub issue](https://github.com/MetaMask/metamask-extension/issues/7163).
:::

In the near future, we will:
Expand Down
8 changes: 7 additions & 1 deletion docs/guide/provider-migration.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
# Provider Migration Guide

As noted in the [Ethereum Provider documentation](./ethereum-provider.html#upcoming-breaking-changes), we are going to make breaking changes to our provider API and remove our injected `window.web3`.
::: danger Deadline
All of these changes are shipping on **November 16, 2020**.

If your web3 site relies on any of these features, it may break when these changes are made unless you migrate.
:::

As noted in the [Ethereum Provider documentation](./ethereum-provider.html#upcoming-breaking-changes), on **November 16, 2020**, we are shipping breaking changes to our provider API and removing our injected `window.web3`.
This guide describes how to migrate to the new provider API, and how to replace our `window.web3` object.

All replacement APIs are live, and you can migrate at any time.
Expand Down

0 comments on commit 0cd9c7d

Please sign in to comment.