Skip to content

Commit 27b8cbc

Browse files
shanejonasrekmarks
andauthoredMay 6, 2021
rename package to @metamask/providers (#168)
* rename package to @metamask/providers fixes #166 * Update CHANGELOG.md Co-authored-by: Erik Marks <25517051+rekmarks@users.noreply.github.com>
1 parent 8818fa4 commit 27b8cbc

File tree

3 files changed

+63
-63
lines changed

3 files changed

+63
-63
lines changed
 

‎CHANGELOG.md

+54-54
Original file line numberDiff line numberDiff line change
@@ -11,67 +11,67 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1111

1212
### Added
1313

14-
- `BaseProvider`, implementing EIP-1193 without any legacy features ([#144](https://github.com/MetaMask/inpage-provider/pull/144))
15-
- `createExternalExtensionProvider`, from the [extension-provider](https://github.com/MetaMask/extension-provider/) package ([#152](https://github.com/MetaMask/inpage-provider/pull/152))
14+
- `BaseProvider`, implementing EIP-1193 without any legacy features ([#144](https://github.com/MetaMask/providers/pull/144))
15+
- `createExternalExtensionProvider`, from the [extension-provider](https://github.com/MetaMask/extension-provider/) package ([#152](https://github.com/MetaMask/providers/pull/152))
1616

1717
## [8.0.4] - 2021-02-04
1818

1919
### Fixed
2020

21-
- Fix warning on second `currentProvider` access ([#138](https://github.com/MetaMask/inpage-provider/pull/138))
21+
- Fix warning on second `currentProvider` access ([#138](https://github.com/MetaMask/providers/pull/138))
2222

2323
## [8.0.3] - 2021-01-20
2424

2525
### Fixed
2626

27-
- Restore 'data' provider event ([#135](https://github.com/MetaMask/inpage-provider/pull/135))
27+
- Restore 'data' provider event ([#135](https://github.com/MetaMask/providers/pull/135))
2828

2929
## [8.0.2] - 2021-01-12
3030

3131
### Changed
3232

33-
- Reduce `window.web3` shim console noise ([#133](https://github.com/MetaMask/inpage-provider/pull/133))
33+
- Reduce `window.web3` shim console noise ([#133](https://github.com/MetaMask/providers/pull/133))
3434

3535
## [8.0.1] - 2020-12-08
3636

3737
### Fixed
3838

39-
- Fix `8.0.0` types ([#127](https://github.com/MetaMask/inpage-provider/pull/127))
39+
- Fix `8.0.0` types ([#127](https://github.com/MetaMask/providers/pull/127))
4040

4141
## [8.0.0] - 2020-12-07
4242

4343
### Added
4444

45-
- Add `logger` parameter to `initializeProvider` ([#116](https://github.com/MetaMask/inpage-provider/pull/116))
46-
- Add `window.web3` shim, `shimWeb3` export ([#113](https://github.com/MetaMask/inpage-provider/pull/113), [#115](https://github.com/MetaMask/inpage-provider/pull/115))
45+
- Add `logger` parameter to `initializeProvider` ([#116](https://github.com/MetaMask/providers/pull/116))
46+
- Add `window.web3` shim, `shimWeb3` export ([#113](https://github.com/MetaMask/providers/pull/113), [#115](https://github.com/MetaMask/providers/pull/115))
4747
- This is to maintain `window.web3.currentProvider` once MetaMask stops injecting `window.web3` (very soon), and to log attempts to access any properties on the shim other than `currentProvider`.
4848
- `initializeWeb3` now has a `shouldShimWeb3` argument, which causes the shim to be set as `window.web3` if `true`.
4949

5050
### Changed
5151

52-
- **(BREAKING)** Rename `initProvider` export to `initializeProvider` ([#114](https://github.com/MetaMask/inpage-provider/pull/114))
53-
- **(BREAKING)** Replace `ethereum.publicConfigStore` with new set of JSON-RPC notifications ([#109](https://github.com/MetaMask/inpage-provider/pull/109))
52+
- **(BREAKING)** Rename `initProvider` export to `initializeProvider` ([#114](https://github.com/MetaMask/providers/pull/114))
53+
- **(BREAKING)** Replace `ethereum.publicConfigStore` with new set of JSON-RPC notifications ([#109](https://github.com/MetaMask/providers/pull/109))
5454

5555
### Fixed
5656

57-
- Correctly implement `connect` and `disconnect` events ([#120](https://github.com/MetaMask/inpage-provider/pull/120))
57+
- Correctly implement `connect` and `disconnect` events ([#120](https://github.com/MetaMask/providers/pull/120))
5858
- See [EIP-1193](https://eips.ethereum.org/EIPS/eip-1193#connect) for the specification of these events.
5959
- `disconnect` emits with an RPC error. Like all such errors emitted by this module, they have a `code` property with a `number` value. There are currently two codes:
6060
- `1013` indicates that MetaMask is attempting to reestablish the connection
6161
- `1011` indicates that a page reload is required
62-
- Send page metadata even if page is already loaded ([#119](https://github.com/MetaMask/inpage-provider/pull/119))
63-
- Convert `MetaMaskInpageProvider` `logger` to instance variable ([#118](https://github.com/MetaMask/inpage-provider/pull/118))
62+
- Send page metadata even if page is already loaded ([#119](https://github.com/MetaMask/providers/pull/119))
63+
- Convert `MetaMaskInpageProvider` `logger` to instance variable ([#118](https://github.com/MetaMask/providers/pull/118))
6464
- Previously, it was erroneously a singleton across all class instances.
65-
- Stop emitting state change events on initialization ([#117](https://github.com/MetaMask/inpage-provider/pull/117))
65+
- Stop emitting state change events on initialization ([#117](https://github.com/MetaMask/providers/pull/117))
6666
- Includes `accountsChanged`, `chainChanged`, and `networkChanged`.
6767
- This prevents sites that handle any of these events by reloading the page from entering into a reload loop.
6868

6969
### Removed
7070

71-
- **(BREAKING)** Remove `_metamask.isEnabled` and `_metamask.isApproved` ([#112](https://github.com/MetaMask/inpage-provider/pull/112))
72-
- **(BREAKING)** Remove the `chainIdChanged` event ([#111](https://github.com/MetaMask/inpage-provider/pull/111))
73-
- **(BREAKING)** Remove `ethereum.publicConfigStore` ([#109](https://github.com/MetaMask/inpage-provider/pull/109))
74-
- **(BREAKING)** Remove `web3.js`-related functionality ([#106](https://github.com/MetaMask/inpage-provider/pull/106))
71+
- **(BREAKING)** Remove `_metamask.isEnabled` and `_metamask.isApproved` ([#112](https://github.com/MetaMask/providers/pull/112))
72+
- **(BREAKING)** Remove the `chainIdChanged` event ([#111](https://github.com/MetaMask/providers/pull/111))
73+
- **(BREAKING)** Remove `ethereum.publicConfigStore` ([#109](https://github.com/MetaMask/providers/pull/109))
74+
- **(BREAKING)** Remove `web3.js`-related functionality ([#106](https://github.com/MetaMask/providers/pull/106))
7575
- This functionality caused the page to reload if there was a `web3.js` instance at `window.web3`, and kept `web3.eth.defaultAccount` in sync with `ethereum.selectedAddress`.
7676
- This functionality is replicated in [@metamask/legacy-web3](https://www.npmjs.com/package/@metamask/legacy-web3).
7777

@@ -112,19 +112,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
112112
### Changed
113113

114114
- Only emit `data` event for notifications present in `^4.0.0`
115-
([#73](https://github.com/MetaMask/inpage-provider/pull/73))
115+
([#73](https://github.com/MetaMask/providers/pull/73))
116116
- Some consumers make assumptions about the shape of the object emitted with the event that do not hold for all notifications in `^6.0.0`.
117117
- Select icon using `rel~="icon"` when retrieving site metadata
118-
([#76](https://github.com/MetaMask/inpage-provider/pull/76))
118+
([#76](https://github.com/MetaMask/providers/pull/76))
119119
- This is instead of defaulting to `rel="shortcut icon"`.
120120

121121
### Fixed
122122

123123
- Emit `accountsChanged` event _after_ all related state has been updated
124-
([#72](https://github.com/MetaMask/inpage-provider/pull/72))
124+
([#72](https://github.com/MetaMask/providers/pull/72))
125125
- For example, `ethereum.selectedAddress` will now have been updated by the time the event is emitted.
126126
- Enable retrieval of site icons _not_ hosted on the same origin
127-
([#78](https://github.com/MetaMask/inpage-provider/pull/78))
127+
([#78](https://github.com/MetaMask/providers/pull/78))
128128
- For example, icons hosted on `assets.foo.com` that are used on `foo.com` will now be retrieved successfully.
129129

130130
## [6.0.1] - 2020-07-15
@@ -201,43 +201,43 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
201201

202202
### Added
203203

204-
- The [most recent EIP 1193 API](https://github.com/ethereum/EIPs/blob/89e373d5d3a62a28f2646830247579f323ef6b40/EIPS/eip-1193.md) ([#30](https://github.com/MetaMask/inpage-provider/pull/30))
204+
- The [most recent EIP 1193 API](https://github.com/ethereum/EIPs/blob/89e373d5d3a62a28f2646830247579f323ef6b40/EIPS/eip-1193.md) ([#30](https://github.com/MetaMask/providers/pull/30))
205205
- The method `request`
206206
- The events `disconnect` and `message`
207207
- A global initialization event, `ethereum#initialized`, for
208-
asynchronous injection ([#31](https://github.com/MetaMask/inpage-provider/pull/31))
209-
- Helper methods for initializing the provider ([#31](https://github.com/MetaMask/inpage-provider/pull/31))
208+
asynchronous injection ([#31](https://github.com/MetaMask/providers/pull/31))
209+
- Helper methods for initializing the provider ([#31](https://github.com/MetaMask/providers/pull/31))
210210

211211
### Changed
212212

213-
- **(BREAKING)** Use named instead of default exports ([#31](https://github.com/MetaMask/inpage-provider/pull/31))
213+
- **(BREAKING)** Use named instead of default exports ([#31](https://github.com/MetaMask/providers/pull/31))
214214
- **(BREAKING)** `MetaMaskInpage` constructor now takes a `connectionStream` and an
215-
options object ([#31](https://github.com/MetaMask/inpage-provider/pull/31))
216-
- **(BREAKING)** `_metamask.sendBatch` -> `_metamask.requestBatch` ([#30](https://github.com/MetaMask/inpage-provider/pull/30))
217-
- **(BREAKING)** Revert `send` to match provider in v7.7.8 of `metamask-extension` ([#29](https://github.com/MetaMask/inpage-provider/pull/29))
218-
- The `connect` event now emits with a `ProviderConnectInfo` object per EIP 1193 ([#30](https://github.com/MetaMask/inpage-provider/pull/30))
219-
- Deprecated the `send` method ([#30](https://github.com/MetaMask/inpage-provider/pull/30))
215+
options object ([#31](https://github.com/MetaMask/providers/pull/31))
216+
- **(BREAKING)** `_metamask.sendBatch` -> `_metamask.requestBatch` ([#30](https://github.com/MetaMask/providers/pull/30))
217+
- **(BREAKING)** Revert `send` to match provider in v7.7.8 of `metamask-extension` ([#29](https://github.com/MetaMask/providers/pull/29))
218+
- The `connect` event now emits with a `ProviderConnectInfo` object per EIP 1193 ([#30](https://github.com/MetaMask/providers/pull/30))
219+
- Deprecated the `send` method ([#30](https://github.com/MetaMask/providers/pull/30))
220220
- Deprecated the events `close`, `networkChanged`, and `notification`, and
221-
added deprecation warnings for them ([#30](https://github.com/MetaMask/inpage-provider/pull/30))
222-
- Un-deprecated `sendAsync` ([#29](https://github.com/MetaMask/inpage-provider/pull/29))
223-
224-
[unreleased]: https://github.com/MetaMask/inpage-provider/compare/v8.1.0...HEAD
225-
[8.1.0]: https://github.com/MetaMask/inpage-provider/compare/v8.0.4...v8.1.0
226-
[8.0.4]: https://github.com/MetaMask/inpage-provider/compare/v8.0.3...v8.0.4
227-
[8.0.3]: https://github.com/MetaMask/inpage-provider/compare/v8.0.2...v8.0.3
228-
[8.0.2]: https://github.com/MetaMask/inpage-provider/compare/v8.0.1...v8.0.2
229-
[8.0.1]: https://github.com/MetaMask/inpage-provider/compare/v8.0.0...v8.0.1
230-
[8.0.0]: https://github.com/MetaMask/inpage-provider/compare/v7.0.0...v8.0.0
231-
[7.0.0]: https://github.com/MetaMask/inpage-provider/compare/v6.3.0...v7.0.0
232-
[6.3.0]: https://github.com/MetaMask/inpage-provider/compare/v6.2.0...v6.3.0
233-
[6.2.0]: https://github.com/MetaMask/inpage-provider/compare/v6.1.1...v6.2.0
234-
[6.1.1]: https://github.com/MetaMask/inpage-provider/compare/v6.1.0...v6.1.1
235-
[6.1.0]: https://github.com/MetaMask/inpage-provider/compare/v6.0.1...v6.1.0
236-
[6.0.1]: https://github.com/MetaMask/inpage-provider/compare/v6.0.0...v6.0.1
237-
[6.0.0]: https://github.com/MetaMask/inpage-provider/compare/v5.2.1...v6.0.0
238-
[5.2.1]: https://github.com/MetaMask/inpage-provider/compare/v5.2.0...v5.2.1
239-
[5.2.0]: https://github.com/MetaMask/inpage-provider/compare/v5.1.0...v5.2.0
240-
[5.1.0]: https://github.com/MetaMask/inpage-provider/compare/v5.0.2...v5.1.0
241-
[5.0.2]: https://github.com/MetaMask/inpage-provider/compare/v5.0.1...v5.0.2
242-
[5.0.1]: https://github.com/MetaMask/inpage-provider/compare/v5.0.0...v5.0.1
243-
[5.0.0]: https://github.com/MetaMask/inpage-provider/compare/v4.1.2...v5.0.0
221+
added deprecation warnings for them ([#30](https://github.com/MetaMask/providers/pull/30))
222+
- Un-deprecated `sendAsync` ([#29](https://github.com/MetaMask/providers/pull/29))
223+
224+
[unreleased]: https://github.com/MetaMask/providers/compare/v8.1.0...HEAD
225+
[8.1.0]: https://github.com/MetaMask/providers/compare/v8.0.4...v8.1.0
226+
[8.0.4]: https://github.com/MetaMask/providers/compare/v8.0.3...v8.0.4
227+
[8.0.3]: https://github.com/MetaMask/providers/compare/v8.0.2...v8.0.3
228+
[8.0.2]: https://github.com/MetaMask/providers/compare/v8.0.1...v8.0.2
229+
[8.0.1]: https://github.com/MetaMask/providers/compare/v8.0.0...v8.0.1
230+
[8.0.0]: https://github.com/MetaMask/providers/compare/v7.0.0...v8.0.0
231+
[7.0.0]: https://github.com/MetaMask/providers/compare/v6.3.0...v7.0.0
232+
[6.3.0]: https://github.com/MetaMask/providers/compare/v6.2.0...v6.3.0
233+
[6.2.0]: https://github.com/MetaMask/providers/compare/v6.1.1...v6.2.0
234+
[6.1.1]: https://github.com/MetaMask/providers/compare/v6.1.0...v6.1.1
235+
[6.1.0]: https://github.com/MetaMask/providers/compare/v6.0.1...v6.1.0
236+
[6.0.1]: https://github.com/MetaMask/providers/compare/v6.0.0...v6.0.1
237+
[6.0.0]: https://github.com/MetaMask/providers/compare/v5.2.1...v6.0.0
238+
[5.2.1]: https://github.com/MetaMask/providers/compare/v5.2.0...v5.2.1
239+
[5.2.0]: https://github.com/MetaMask/providers/compare/v5.1.0...v5.2.0
240+
[5.1.0]: https://github.com/MetaMask/providers/compare/v5.0.2...v5.1.0
241+
[5.0.2]: https://github.com/MetaMask/providers/compare/v5.0.1...v5.0.2
242+
[5.0.1]: https://github.com/MetaMask/providers/compare/v5.0.0...v5.0.1
243+
[5.0.0]: https://github.com/MetaMask/providers/compare/v4.1.2...v5.0.0

‎README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
1-
# MetaMask Inpage Provider
1+
# MetaMask Providers
22

3-
The inpage Ethereum provider object injected by MetaMask into web pages.
3+
The Ethereum provider object injected by MetaMask into various environments.
44
Contains a lot of implementation details specific to MetaMask, and is probably
55
not suitable for out-of-the-box use with other wallets.
66

7-
Implements the Ethereum JavaScript provider specification, [EIP-1193](https://eips.ethereum.org/EIPS/eip-1193).
7+
The `BaseProvider` implements the Ethereum JavaScript provider specification, [EIP-1193](https://eips.ethereum.org/EIPS/eip-1193). `MetamaskInpageProvider` implements [EIP-1193](https://eips.ethereum.org/EIPS/eip-1193) and legacy interfaces.
88

99
## Installation
1010

11-
`yarn add @metamask/inpage-provider`
11+
`yarn add @metamask/providers`
1212

1313
## Usage
1414

1515
```javascript
16-
import { initializeProvider } from '@metamask/inpage-provider';
16+
import { initializeProvider } from '@metamask/providers';
1717

1818
// Create a stream to a remote provider:
1919
const metamaskStream = new LocalMessageDuplexStream({

‎package.json

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "@metamask/inpage-provider",
2+
"name": "@metamask/providers",
33
"version": "8.1.0",
44
"description": "A JavaScript Ethereum provider that connects to the wallet over a stream.",
55
"main": "dist/index.js",
@@ -22,17 +22,17 @@
2222
"license": "MIT",
2323
"repository": {
2424
"type": "git",
25-
"url": "git+ssh://git@github.com/MetaMask/inpage-provider.git"
25+
"url": "git+ssh://git@github.com/MetaMask/providers.git"
2626
},
2727
"keywords": [
2828
"MetaMask",
2929
"Ethereum",
3030
"Provider"
3131
],
3232
"bugs": {
33-
"url": "https://github.com/MetaMask/inpage-provider/issues"
33+
"url": "https://github.com/MetaMask/providers/issues"
3434
},
35-
"homepage": "https://github.com/MetaMask/inpage-provider#readme",
35+
"homepage": "https://github.com/MetaMask/providers#readme",
3636
"files": [
3737
"dist/"
3838
],

0 commit comments

Comments
 (0)
Please sign in to comment.