@metamask/providers - npm Package Compare versions

Comparing version 16.0.0 to 16.1.0

CHANGELOG.md

@@ -10,2 +10,12 @@ # Changelog
 
+## [16.1.0]
+
+### Added
+
+- Restore deprecated properties, networkChanged event, and offline send() net_version support ([#312](https://github.com/MetaMask/providers/pull/312))
+- Bump MetaMask dependencies ([#310](https://github.com/MetaMask/providers/pull/310))
+- Bump @metamask/safe-event-emitter from 3.0.0 to 3.1.1 ([#309](https://github.com/MetaMask/providers/pull/309))
+- Bump @metamask/utils from 8.3.0 to 8.4.0 ([#311](https://github.com/MetaMask/providers/pull/311))
+- Bump tar from 6.1.13 to 6.2.1 ([#314](https://github.com/MetaMask/providers/pull/314))
+
 ## [16.0.0]
@@ -386,3 +396,4 @@
 
-[Unreleased]: https://github.com/MetaMask/providers/compare/v16.0.0...HEAD
+[Unreleased]: https://github.com/MetaMask/providers/compare/v16.1.0...HEAD
+[16.1.0]: https://github.com/MetaMask/providers/compare/v16.0.0...v16.1.0
 [16.0.0]: https://github.com/MetaMask/providers/compare/v15.0.0...v16.0.0
@@ -389,0 +400,0 @@ [15.0.0]: https://github.com/MetaMask/providers/compare/v14.0.2...v15.0.0

dist/BaseProvider.js

 "use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
-var _chunk3SH27QO5js = require('./chunk-3SH27QO5.js');
-require('./chunk-HIKGM7AJ.js');
-require('./chunk-2POZE5AW.js');
+var _chunkA3W22U42js = require('./chunk-A3W22U42.js');
+require('./chunk-O5ECOCX2.js');
+require('./chunk-6QNVTE4W.js');
 require('./chunk-ZOFGBGOM.js');
-require('./chunk-ALI4B7QI.js');
+require('./chunk-4EQNSGSR.js');
 require('./chunk-3W5G4CYI.js');
 
 
-exports.BaseProvider = _chunk3SH27QO5js.BaseProvider;
+exports.BaseProvider = _chunkA3W22U42js.BaseProvider;
 //# sourceMappingURL=BaseProvider.js.map

dist/extension-provider/createExternalExtensionProvider.js

 "use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
-var _chunkDDGZV54Ajs = require('../chunk-DDGZV54A.js');
-require('../chunk-TFQXBZWT.js');
-require('../chunk-4WPMRSOH.js');
-require('../chunk-732OO7W6.js');
-require('../chunk-3SH27QO5.js');
-require('../chunk-HIKGM7AJ.js');
-require('../chunk-2POZE5AW.js');
+var _chunkKUKZKOBUjs = require('../chunk-KUKZKOBU.js');
+require('../chunk-HP7EYLLY.js');
+require('../chunk-Q4DN6VYN.js');
+require('../chunk-DWR5HIZK.js');
+require('../chunk-A3W22U42.js');
+require('../chunk-O5ECOCX2.js');
+require('../chunk-6QNVTE4W.js');
 require('../chunk-ZOFGBGOM.js');
-require('../chunk-ALI4B7QI.js');
+require('../chunk-4EQNSGSR.js');
 require('../chunk-3W5G4CYI.js');
 
 
-exports.createExternalExtensionProvider = _chunkDDGZV54Ajs.createExternalExtensionProvider;
+exports.createExternalExtensionProvider = _chunkKUKZKOBUjs.createExternalExtensionProvider;
 //# sourceMappingURL=createExternalExtensionProvider.js.map

dist/index.js

 "use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
-var _chunkDDGZV54Ajs = require('./chunk-DDGZV54A.js');
+var _chunkKUKZKOBUjs = require('./chunk-KUKZKOBU.js');
 
 
 
-var _chunk3KACCYSBjs = require('./chunk-3KACCYSB.js');
+var _chunkIZY7ABOLjs = require('./chunk-IZY7ABOL.js');
 
@@ -18,14 +18,14 @@
 
-var _chunkTFQXBZWTjs = require('./chunk-TFQXBZWT.js');
-require('./chunk-4WPMRSOH.js');
+var _chunkHP7EYLLYjs = require('./chunk-HP7EYLLY.js');
+require('./chunk-Q4DN6VYN.js');
 
 
-var _chunk732OO7W6js = require('./chunk-732OO7W6.js');
+var _chunkDWR5HIZKjs = require('./chunk-DWR5HIZK.js');
 
 
-var _chunk3SH27QO5js = require('./chunk-3SH27QO5.js');
-require('./chunk-HIKGM7AJ.js');
-require('./chunk-2POZE5AW.js');
+var _chunkA3W22U42js = require('./chunk-A3W22U42.js');
+require('./chunk-O5ECOCX2.js');
+require('./chunk-6QNVTE4W.js');
 require('./chunk-ZOFGBGOM.js');
-require('./chunk-ALI4B7QI.js');
+require('./chunk-4EQNSGSR.js');
 require('./chunk-3W5G4CYI.js');
@@ -43,3 +43,3 @@
 
-exports.BaseProvider = _chunk3SH27QO5js.BaseProvider; exports.MetaMaskInpageProvider = _chunkTFQXBZWTjs.MetaMaskInpageProvider; exports.MetaMaskInpageProviderStreamName = _chunkTFQXBZWTjs.MetaMaskInpageProviderStreamName; exports.StreamProvider = _chunk732OO7W6js.StreamProvider; exports.createExternalExtensionProvider = _chunkDDGZV54Ajs.createExternalExtensionProvider; exports.eip6963AnnounceProvider = _chunkWBB62AKCjs.announceProvider; exports.eip6963RequestProvider = _chunkWBB62AKCjs.requestProvider; exports.initializeProvider = _chunk3KACCYSBjs.initializeProvider; exports.setGlobalProvider = _chunk3KACCYSBjs.setGlobalProvider; exports.shimWeb3 = _chunkDD6YP3BVjs.shimWeb3;
+exports.BaseProvider = _chunkA3W22U42js.BaseProvider; exports.MetaMaskInpageProvider = _chunkHP7EYLLYjs.MetaMaskInpageProvider; exports.MetaMaskInpageProviderStreamName = _chunkHP7EYLLYjs.MetaMaskInpageProviderStreamName; exports.StreamProvider = _chunkDWR5HIZKjs.StreamProvider; exports.createExternalExtensionProvider = _chunkKUKZKOBUjs.createExternalExtensionProvider; exports.eip6963AnnounceProvider = _chunkWBB62AKCjs.announceProvider; exports.eip6963RequestProvider = _chunkWBB62AKCjs.requestProvider; exports.initializeProvider = _chunkIZY7ABOLjs.initializeProvider; exports.setGlobalProvider = _chunkIZY7ABOLjs.setGlobalProvider; exports.shimWeb3 = _chunkDD6YP3BVjs.shimWeb3;
 //# sourceMappingURL=index.js.map

dist/initializeInpageProvider.js

 "use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
 
-var _chunk3KACCYSBjs = require('./chunk-3KACCYSB.js');
+var _chunkIZY7ABOLjs = require('./chunk-IZY7ABOL.js');
 require('./chunk-DD6YP3BV.js');
 require('./chunk-WBB62AKC.js');
-require('./chunk-TFQXBZWT.js');
-require('./chunk-4WPMRSOH.js');
-require('./chunk-732OO7W6.js');
-require('./chunk-3SH27QO5.js');
-require('./chunk-HIKGM7AJ.js');
-require('./chunk-2POZE5AW.js');
+require('./chunk-HP7EYLLY.js');
+require('./chunk-Q4DN6VYN.js');
+require('./chunk-DWR5HIZK.js');
+require('./chunk-A3W22U42.js');
+require('./chunk-O5ECOCX2.js');
+require('./chunk-6QNVTE4W.js');
 require('./chunk-ZOFGBGOM.js');
-require('./chunk-ALI4B7QI.js');
+require('./chunk-4EQNSGSR.js');
 require('./chunk-3W5G4CYI.js');
@@ -19,3 +19,3 @@
 
-exports.initializeProvider = _chunk3KACCYSBjs.initializeProvider; exports.setGlobalProvider = _chunk3KACCYSBjs.setGlobalProvider;
+exports.initializeProvider = _chunkIZY7ABOLjs.initializeProvider; exports.setGlobalProvider = _chunkIZY7ABOLjs.setGlobalProvider;
 //# sourceMappingURL=initializeInpageProvider.js.map

dist/messages.js

 "use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
-var _chunkALI4B7QIjs = require('./chunk-ALI4B7QI.js');
+var _chunk4EQNSGSRjs = require('./chunk-4EQNSGSR.js');
 require('./chunk-3W5G4CYI.js');
 
 
-exports.default = _chunkALI4B7QIjs.messages_default;
+exports.default = _chunk4EQNSGSRjs.messages_default;
 //# sourceMappingURL=messages.js.map

dist/MetaMaskInpageProvider.js

 "use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
 
-var _chunkTFQXBZWTjs = require('./chunk-TFQXBZWT.js');
-require('./chunk-4WPMRSOH.js');
-require('./chunk-732OO7W6.js');
-require('./chunk-3SH27QO5.js');
-require('./chunk-HIKGM7AJ.js');
-require('./chunk-2POZE5AW.js');
+var _chunkHP7EYLLYjs = require('./chunk-HP7EYLLY.js');
+require('./chunk-Q4DN6VYN.js');
+require('./chunk-DWR5HIZK.js');
+require('./chunk-A3W22U42.js');
+require('./chunk-O5ECOCX2.js');
+require('./chunk-6QNVTE4W.js');
 require('./chunk-ZOFGBGOM.js');
-require('./chunk-ALI4B7QI.js');
+require('./chunk-4EQNSGSR.js');
 require('./chunk-3W5G4CYI.js');
@@ -16,3 +16,3 @@
 
-exports.MetaMaskInpageProvider = _chunkTFQXBZWTjs.MetaMaskInpageProvider; exports.MetaMaskInpageProviderStreamName = _chunkTFQXBZWTjs.MetaMaskInpageProviderStreamName;
+exports.MetaMaskInpageProvider = _chunkHP7EYLLYjs.MetaMaskInpageProvider; exports.MetaMaskInpageProviderStreamName = _chunkHP7EYLLYjs.MetaMaskInpageProviderStreamName;
 //# sourceMappingURL=MetaMaskInpageProvider.js.map

dist/middleware/createRpcWarningMiddleware.js

 "use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
-var _chunk2POZE5AWjs = require('../chunk-2POZE5AW.js');
+var _chunk6QNVTE4Wjs = require('../chunk-6QNVTE4W.js');
 require('../chunk-ZOFGBGOM.js');
-require('../chunk-ALI4B7QI.js');
+require('../chunk-4EQNSGSR.js');
 require('../chunk-3W5G4CYI.js');
 
 
-exports.createRpcWarningMiddleware = _chunk2POZE5AWjs.createRpcWarningMiddleware;
+exports.createRpcWarningMiddleware = _chunk6QNVTE4Wjs.createRpcWarningMiddleware;
 //# sourceMappingURL=createRpcWarningMiddleware.js.map

dist/siteMetadata.js

 "use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
-var _chunk4WPMRSOHjs = require('./chunk-4WPMRSOH.js');
-require('./chunk-HIKGM7AJ.js');
-require('./chunk-2POZE5AW.js');
+var _chunkQ4DN6VYNjs = require('./chunk-Q4DN6VYN.js');
+require('./chunk-O5ECOCX2.js');
+require('./chunk-6QNVTE4W.js');
 require('./chunk-ZOFGBGOM.js');
-require('./chunk-ALI4B7QI.js');
+require('./chunk-4EQNSGSR.js');
 require('./chunk-3W5G4CYI.js');
 
 
-exports.sendSiteMetadata = _chunk4WPMRSOHjs.sendSiteMetadata;
+exports.sendSiteMetadata = _chunkQ4DN6VYNjs.sendSiteMetadata;
 //# sourceMappingURL=siteMetadata.js.map

dist/StreamProvider.js

 "use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
 
-var _chunk732OO7W6js = require('./chunk-732OO7W6.js');
-require('./chunk-3SH27QO5.js');
-require('./chunk-HIKGM7AJ.js');
-require('./chunk-2POZE5AW.js');
+var _chunkDWR5HIZKjs = require('./chunk-DWR5HIZK.js');
+require('./chunk-A3W22U42.js');
+require('./chunk-O5ECOCX2.js');
+require('./chunk-6QNVTE4W.js');
 require('./chunk-ZOFGBGOM.js');
-require('./chunk-ALI4B7QI.js');
+require('./chunk-4EQNSGSR.js');
 require('./chunk-3W5G4CYI.js');
@@ -14,3 +14,3 @@
 
-exports.AbstractStreamProvider = _chunk732OO7W6js.AbstractStreamProvider; exports.StreamProvider = _chunk732OO7W6js.StreamProvider;
+exports.AbstractStreamProvider = _chunkDWR5HIZKjs.AbstractStreamProvider; exports.StreamProvider = _chunkDWR5HIZKjs.StreamProvider;
 //# sourceMappingURL=StreamProvider.js.map

dist/types/BaseProvider.d.ts

@@ -91,2 +91,5 @@ import type { JsonRpcMiddleware } from '@metamask/json-rpc-engine';
      *
+     * Permits the `networkVersion` field in the parameter object for
+     * compatibility with child classes that use this value.
+     *
      * @param initialState - The provider's initial state.
@@ -96,2 +99,3 @@ * @param initialState.accounts - The user's accounts.
      * @param initialState.isUnlocked - Whether the user has unlocked MetaMask.
+     * @param initialState.networkVersion - The network version.
      * @fires BaseProvider#_initialized - If `initialState` is defined.
@@ -104,2 +108,3 @@ * @fires BaseProvider#connect - If `initialState` is defined.
         isUnlocked: boolean;
+        networkVersion?: string;
     }): void;
@@ -130,6 +135,7 @@ /**
      *
+     * @param isRecoverable - Whether the disconnection is recoverable.
      * @param errorMessage - A custom error message.
-     * @fires BaseProvider#disconnect
+     * @fires BaseProvider#disconnect - If the disconnection is not recoverable.
      */
-    protected _handleDisconnect(errorMessage?: string): void;
+    protected _handleDisconnect(isRecoverable: boolean, errorMessage?: string): void;
     /**
@@ -140,2 +146,5 @@ * Upon receipt of a new `chainId`, emits the corresponding event and sets
      *
+     * Permits the `networkVersion` field in the parameter object for
+     * compatibility with child classes that use this value.
+     *
      * @fires BaseProvider#chainChanged
@@ -147,2 +156,3 @@ * @param networkInfo - An object with network info.
         chainId?: string | undefined;
+        networkVersion?: string | undefined;
     } | undefined): void;
@@ -149,0 +159,0 @@ /**

dist/types/messages.d.ts

 declare const messages: {
     errors: {
+        disconnected: () => string;
         permanentlyDisconnected: () => string;
@@ -13,5 +14,2 @@ sendSiteMetadata: () => string;
         invalidLoggerMethod: (method: string) => string;
-        invalidPropertyChainId: () => string;
-        invalidPropertyNetworkVersion: () => string;
-        invalidPropertySelectedAddress: () => string;
     };
@@ -22,2 +20,5 @@ info: {
     warnings: {
+        chainIdDeprecation: string;
+        networkVersionDeprecation: string;
+        selectedAddressDeprecation: string;
         enableDeprecation: string;
@@ -28,2 +29,3 @@ sendDeprecation: string;
             data: string;
+            networkChanged: string;
             notification: string;
@@ -30,0 +32,0 @@ };

dist/types/MetaMaskInpageProvider.d.ts

@@ -8,3 +8,3 @@ /// <reference types="node" />
 export declare type SendSyncJsonRpcRequest = {
-    method: 'eth_accounts' | 'eth_coinbase' | 'eth_uninstallFilter';
+    method: 'eth_accounts' | 'eth_coinbase' | 'eth_uninstallFilter' | 'net_version';
 } & JsonRpcRequest;
@@ -19,2 +19,5 @@ export declare type MetaMaskInpageProviderOptions = {
 declare type SentWarningsState = {
+    chainId: boolean;
+    networkVersion: boolean;
+    selectedAddress: boolean;
     enable: boolean;
@@ -26,2 +29,3 @@ experimentalMethods: boolean;
         data: boolean;
+        networkChanged: boolean;
         notification: boolean;
@@ -35,2 +39,3 @@ };
 export declare class MetaMaskInpageProvider extends AbstractStreamProvider {
+    #private;
     protected _sentWarnings: SentWarningsState;
@@ -80,2 +85,14 @@ /**
     /**
+     * When the provider becomes disconnected, updates internal state and emits
+     * required events. Idempotent with respect to the isRecoverable parameter.
+     *
+     * Error codes per the CloseEvent status codes as required by EIP-1193:
+     * https://developer.mozilla.org/en-US/docs/Web/API/CloseEvent#Status_codes.
+     *
+     * @param isRecoverable - Whether the disconnection is recoverable.
+     * @param errorMessage - A custom error message.
+     * @fires BaseProvider#disconnect - If the disconnection is not recoverable.
+     */
+    protected _handleDisconnect(isRecoverable: boolean, errorMessage?: string): void;
+    /**
      * Warns of deprecation for the given event, if applicable.
@@ -155,4 +172,18 @@ *
     };
+    /**
+     * Upon receipt of a new chainId and networkVersion, emits corresponding
+     * events and sets relevant public state. Does nothing if neither the chainId
+     * nor the networkVersion are different from existing values.
+     *
+     * @fires MetamaskInpageProvider#networkChanged
+     * @param networkInfo - An object with network info.
+     * @param networkInfo.chainId - The latest chain ID.
+     * @param networkInfo.networkVersion - The latest network ID.
+     */
+    protected _handleChainChanged({ chainId, networkVersion, }?: {
+        chainId?: string;
+        networkVersion?: string;
+    }): void;
 }
 export {};
 //# sourceMappingURL=MetaMaskInpageProvider.d.ts.map

dist/types/StreamProvider.d.ts

@@ -58,4 +58,9 @@ /// <reference types="node" />
     /**
-     * Upon receipt of a new chainId, emits corresponding
-     * events and sets relevant public state.
+     * Upon receipt of a new chainId and networkVersion, emits corresponding
+     * events and sets relevant public state. This class does not have a
+     * `networkVersion` property, but we rely on receiving a `networkVersion`
+     * with the value of `loading` to detect when the network is changing and
+     * a recoverable `disconnect` even has occurred. Child classes that use the
+     * `networkVersion` for other purposes must implement additional handling
+     * therefore.
      *
@@ -65,5 +70,7 @@ * @fires BaseProvider#chainChanged
      * @param networkInfo.chainId - The latest chain ID.
+     * @param networkInfo.networkVersion - The latest network ID.
      */
-    protected _handleChainChanged({ chainId, }?: {
+    protected _handleChainChanged({ chainId, networkVersion, }?: {
         chainId?: string | undefined;
+        networkVersion?: string | undefined;
     }): void;
@@ -70,0 +77,0 @@ }

dist/types/utils.d.ts

@@ -23,3 +23,11 @@ import type { JsonRpcMiddleware } from '@metamask/json-rpc-engine';
 export declare const isValidChainId: (chainId: unknown) => chainId is string;
+/**
+ * Checks whether the given network version is valid, meaning if it is non-empty
+ * string.
+ *
+ * @param networkVersion - The network version to validate.
+ * @returns Whether the given network version is valid.
+ */
+export declare const isValidNetworkVersion: (networkVersion: unknown) => networkVersion is string;
 export declare const NOOP: () => undefined;
 //# sourceMappingURL=utils.d.ts.map

dist/utils.js

@@ -7,6 +7,7 @@ "use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
-var _chunkHIKGM7AJjs = require('./chunk-HIKGM7AJ.js');
-require('./chunk-2POZE5AW.js');
+
+var _chunkO5ECOCX2js = require('./chunk-O5ECOCX2.js');
+require('./chunk-6QNVTE4W.js');
 require('./chunk-ZOFGBGOM.js');
-require('./chunk-ALI4B7QI.js');
+require('./chunk-4EQNSGSR.js');
 require('./chunk-3W5G4CYI.js');
@@ -19,3 +20,4 @@
 
-exports.EMITTED_NOTIFICATIONS = _chunkHIKGM7AJjs.EMITTED_NOTIFICATIONS; exports.NOOP = _chunkHIKGM7AJjs.NOOP; exports.getDefaultExternalMiddleware = _chunkHIKGM7AJjs.getDefaultExternalMiddleware; exports.getRpcPromiseCallback = _chunkHIKGM7AJjs.getRpcPromiseCallback; exports.isValidChainId = _chunkHIKGM7AJjs.isValidChainId;
+
+exports.EMITTED_NOTIFICATIONS = _chunkO5ECOCX2js.EMITTED_NOTIFICATIONS; exports.NOOP = _chunkO5ECOCX2js.NOOP; exports.getDefaultExternalMiddleware = _chunkO5ECOCX2js.getDefaultExternalMiddleware; exports.getRpcPromiseCallback = _chunkO5ECOCX2js.getRpcPromiseCallback; exports.isValidChainId = _chunkO5ECOCX2js.isValidChainId; exports.isValidNetworkVersion = _chunkO5ECOCX2js.isValidNetworkVersion;
 //# sourceMappingURL=utils.js.map

package.json

 {
   "name": "@metamask/providers",
-  "version": "16.0.0",
+  "version": "16.1.0",
   "description": "A JavaScript Ethereum provider that connects to the wallet over a stream",
@@ -60,7 +60,7 @@ "keywords": [
   "dependencies": {
-    "@metamask/json-rpc-engine": "^7.3.2",
-    "@metamask/json-rpc-middleware-stream": "^6.0.2",
+    "@metamask/json-rpc-engine": "^8.0.1",
+    "@metamask/json-rpc-middleware-stream": "^7.0.1",
     "@metamask/object-multiplex": "^2.0.0",
     "@metamask/rpc-errors": "^6.2.1",
-    "@metamask/safe-event-emitter": "^3.0.0",
+    "@metamask/safe-event-emitter": "^3.1.1",
     "@metamask/utils": "^8.3.0",
@@ -67,0 +67,0 @@ "detect-browser": "^5.2.0",

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

358162

increased by8.19%

Lines of code

3612

increased by8.24%

Dependency changes

• + Added@metamask/json-rpc-engine@8.0.2(transitive)

• + Added@metamask/json-rpc-middleware-stream@7.0.2(transitive)

• - Removed@metamask/json-rpc-engine@7.3.3(transitive)

• - Removed@metamask/json-rpc-middleware-stream@6.0.2(transitive)

• Updated@metamask/json-rpc-engine@^8.0.1

• Updated@metamask/json-rpc-middleware-stream@^7.0.1

• Updated@metamask/safe-event-emitter@^3.1.1