Skip to content
This repository has been archived by the owner on Apr 22, 2024. It is now read-only.

chore: Add deprecation notice #469

Merged
merged 9 commits into from
Mar 28, 2024
32 changes: 31 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,37 @@

Web3 ProviderEngine is a tool for composing your own [web3 providers](https://github.com/ethereum/wiki/wiki/JavaScript-API#web3).

<table><tr><td><p align="center"><b>⚠️ PLEASE READ ⚠️</b></p><div align="center">This package was originally created for MetaMask and is being phased out in favor of <a href="https://www.npmjs.com/package/@metamask/json-rpc-engine"><code>@metamask/json-rpc-engine</code></a> and <a href="https://www.npmjs.com/package/@metamask/eth-json-rpc-middleware"><code>@metamask/eth-json-rpc-middleware</code></a>. As such, we will no longer be accepting changes to this package except those which address security issues.</div></td></tr></table>
> [!CAUTION]
> This package has been deprecated.
>
> This package was originally created for MetaMask, but has been replaced by `@metamask/json-rpc-engine`, `@metamask/eth-json-rpc-middleware`, and `@metamask/eth-json-rpc-provider`.
Gudahtt marked this conversation as resolved.
Show resolved Hide resolved
>
> Here is an example of how to create a provider using those packages:
>
> ```javascript
> import { providerFromMiddleware } from '@metamask/eth-json-rpc-provider';
> import { createFetchMiddleware } from '@metamask/eth-json-rpc-middleware';
>
> const rpcUrl = '[insert RPC URL here]';
>
> const fetchMiddleware = createFetchMiddleware({ rpcUrl });
> const provider = providerFromMiddleware(fetchMiddleware);
>
> provider.sendAsync(
> { id: 1, jsonrpc: '2.0', method: 'eth_chainId' },
> (error, response) => {
> if (error) {
> console.error(error);
> } else {
> console.log(response.result);
> }
> }
> );
> ```
>
> This example was written with v12.1.0 of `@metamask/eth-json-rpc-middleware` and v3.0.1 of `@metamask/eth-json-rpc-provider`.
>


### Composable

Expand Down
Loading