Skip to content

Commit

Permalink
Update breaking changes comms (MetaMask#198)
Browse files Browse the repository at this point in the history
* Update breaking changes comms

* fixup! Update breaking changes comms
  • Loading branch information
rekmarks authored Nov 19, 2020
1 parent edfd020 commit 6f6a4c0
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 20 deletions.
5 changes: 3 additions & 2 deletions docs/guide/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,9 @@ Welcome to MetaMask’s Developer Documentation. This documentation is for learn
- For up to the minute news, follow our [Peepeth](https://peepeth.com/MetaMask/), [Twitter](https://twitter.com/metamask_io) or [Medium](https://medium.com/metamask) pages.
- To learn how to contribute to the MetaMask project itself, visit our [Internal Docs](https://github.com/MetaMask/metamask-extension/tree/develop/docs).

::: danger Upcoming Breaking Changes
On **November 16, 2020** (or shortly thereafter), we are introducing changes that may break certain Ethereum web applications.
::: danger Breaking Changes Imminent
We are in the process of shipping changes that will break certain Ethereum web applications.
These changes may ship at any time, and all future major versions of MetaMask on all platforms will be affected.
Please read our [Migration Guide](./provider-migration.html) for more details.

Action is required for Ethereum application developers only.
Expand Down
16 changes: 8 additions & 8 deletions docs/guide/ethereum-provider.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@
We recommend that all web3 site developers read the [Basic Usage](#basic-usage) section.
:::

::: danger Upcoming Breaking Changes
On **November 16, 2020** (or shortly thereafter), we are introducing changes that may break certain web3 sites.
All future versions of MetaMask on all platforms will be affected.
::: danger Breaking Changes Imminent
We are in the process of shipping changes that will break certain Ethereum web applications.
These changes may ship at any time, and all future major versions of MetaMask on all platforms will be affected.
Please see the [Upcoming Breaking Changes](#upcoming-breaking-changes) section for details.

Action is required for Ethereum application developers only.
Expand Down Expand Up @@ -42,18 +42,18 @@ if (provider) {
## Upcoming Breaking Changes

::: danger Important Information
On **November 16, 2020** (or shortly thereafter), we are making changes to our provider API that will be breaking for some web3 sites.
All future versions of MetaMask on all platforms will be affected.
These changes are _upcoming_, but you can already handle them today.
Follow [this GitHub issue](https://github.com/MetaMask/metamask-extension/issues/8077) for updates.
We are in the process of shipping changes that will break certain Ethereum web applications.
All future major versions of MetaMask on all platforms will be affected.
To ensure that your site won't break, you need to handle these changes today.
We will make an announcement on [this GitHub issue](https://github.com/MetaMask/metamask-extension/issues/8077) when the changes ship.

All consumers of MetaMask's provider may be affected by the `eth_chainId` bug (see [next subsection](#window-ethereum-api-changes)).
Other than that, if you are new to using the provider, you do not have to worry about these changes, and can skip ahead [to the next section](#api).
:::

### `window.ethereum` API Changes

At that time, we will:
We will:

- Ensure that chain IDs returned by `eth_chainId` are **not** 0-padded
- For example, instead of `0x01`, we will always return `0x1`, wherever the chain ID is returned or accessible.
Expand Down
8 changes: 6 additions & 2 deletions docs/guide/mobile-best-practices.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,13 @@ If this page doesn't answer your question, please feel free to open an issue [in

## The Provider (window.ethereum)

::: danger Upcoming Breaking Changes
MetaMask Mobile is also affected by the **November 16, 2020** breaking changes.
::: danger Breaking Changes Imminent
MetaMask Mobile is also affected by the breaking changes to our provider, and the removal of `window.web3`.
These changes may ship at any time, and all future major versions of MetaMask on all platforms will be affected.
Please read our [Migration Guide](./provider-migration.html) for more details.

Action is required for Ethereum application developers only.
MetaMask users do not need to do anything.
:::

The [provider API](./ethereum-provider.html) is the same for both MetaMask Mobile and the desktop extension.
Expand Down
15 changes: 7 additions & 8 deletions docs/guide/provider-migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,17 @@ This documentation is for Ethereum application developers.
As a MetaMask user, you don't need to do anything!
:::

::: danger Deadline
All of these changes are shipping on (or shortly after) **November 16, 2020**.
All future versions of MetaMask on all platforms will be affected.
::: danger Deadline Imminent
We are in the process of shipping all of these changes.
These changes may ship at any time, and all future major versions of MetaMask on all platforms will be affected.

If your web3 site relies on any of these features, it may break when these changes are made unless you migrate.
If your website 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.
As noted in the [Ethereum Provider documentation](./ethereum-provider.html#upcoming-breaking-changes), we are in the process of shipping breaking changes to our provider API and removing our injected `window.web3` object.
This guide describes how to migrate to the new provider API, and how to replace our `window.web3`.

All replacement APIs are live, and you can migrate at any time.
If you will be affected by the breaking changes, we recommend that you migrate as soon as possible.
All replacement APIs are live, and we recommend migrating _immediately_.

You can follow [this GitHub issue](https://github.com/MetaMask/metamask-extension/issues/8077) to be notified of the dates of the breaking changes once we announce them.

Expand Down

0 comments on commit 6f6a4c0

Please sign in to comment.