@metamask/snaps-rpc-methods 11.2.0 → 11.4.0

package/CHANGELOG.md

@@ -7,6 +7,29 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [11.4.0]
+
+### Added
+
+- Add `snap_experimentalProviderRequest` JSON-RPC method ([#2773](https://github.com/MetaMask/snaps/pull/2773))
+  - This method is experimental and will likely be removed in a future release.
+
+### Changed
+
+- Allow updating interface context ([#2809](https://github.com/MetaMask/snaps/pull/2809))
+  - `snap_updateInterface` now accepts a `context` parameter to update the
+    context of an interface.
+
+### Fixed
+
+- Use `BigInt` to parse chain IDs ([#2781](https://github.com/MetaMask/snaps/pull/2781))
+
+## [11.3.0]
+
+### Added
+
+- Add `snap_getCurrencyRate` JSON-RPC method ([#2763](https://github.com/MetaMask/snaps/pull/2763))
+
 ## [11.2.0]
 
 ### Added
@@ -291,7 +314,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - The version of the package no longer needs to match the version of all other
     MetaMask Snaps packages.
 
-[Unreleased]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-rpc-methods@11.2.0...HEAD
+[Unreleased]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-rpc-methods@11.4.0...HEAD
+[11.4.0]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-rpc-methods@11.3.0...@metamask/snaps-rpc-methods@11.4.0
+[11.3.0]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-rpc-methods@11.2.0...@metamask/snaps-rpc-methods@11.3.0
 [11.2.0]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-rpc-methods@11.1.1...@metamask/snaps-rpc-methods@11.2.0
 [11.1.1]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-rpc-methods@11.1.0...@metamask/snaps-rpc-methods@11.1.1
 [11.1.0]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-rpc-methods@11.0.0...@metamask/snaps-rpc-methods@11.1.0

package/dist/permitted/createInterface.d.cts

@@ -96,6 +96,7 @@ declare const CreateInterfaceParametersStruct: import("@metamask/superstruct").S
         }, "Radio">>;
     }, "RadioGroup"> | import("@metamask/snaps-sdk/jsx").SnapElement<{
         children: import("@metamask/snaps-sdk/jsx").StringElement;
+        size?: "md" | "lg" | undefined;
     }, "Heading">;
     context?: Record<string, import("@metamask/snaps-sdk").Json> | undefined;
 }, {
@@ -185,6 +186,7 @@ declare const CreateInterfaceParametersStruct: import("@metamask/superstruct").S
         }, "Radio">>;
     }, "RadioGroup"> | import("@metamask/snaps-sdk/jsx").SnapElement<{
         children: import("@metamask/snaps-sdk/jsx").StringElement;
+        size?: "md" | "lg" | undefined;
     }, "Heading">, null>;
     context: import("@metamask/superstruct").Struct<Record<string, import("@metamask/snaps-sdk").Json> | undefined, null>;
 }>;

package/dist/permitted/createInterface.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"createInterface.d.cts","sourceRoot":"","sources":["../../src/permitted/createInterface.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,sBAAsB,EAAE,wCAAwC;AAE9E,OAAO,KAAK,EACV,qBAAqB,EACrB,qBAAqB,EAErB,kBAAkB,EAClB,gBAAgB,EACjB,4BAA4B;AAK7B,OAAO,EAAE,KAAK,aAAa,EAAE,8BAA8B;AAU3D,MAAM,MAAM,0BAA0B,GAAG;IACvC;;;OAGG;IACH,eAAe,EAAE,CACf,EAAE,EAAE,kBAAkB,EACtB,OAAO,CAAC,EAAE,gBAAgB,KACvB,OAAO,CAAC,MAAM,CAAC,CAAC;CACtB,CAAC;AAEF,eAAO,MAAM,sBAAsB,EAAE,sBAAsB,CACzD,0BAA0B,EAC1B,yBAAyB,EACzB,qBAAqB,CAKtB,CAAC;AAEF,QAAA,MAAM,+BAA+B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;uBA4CrC;;;;;;WAMG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;uBANH;;;;;;WAMG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA/CD,CAAC;AAEH,MAAM,MAAM,yBAAyB,GAAG,aAAa,CACnD,OAAO,+BAA+B,EACtC,qBAAqB,CACtB,CAAC"}
+{"version":3,"file":"createInterface.d.cts","sourceRoot":"","sources":["../../src/permitted/createInterface.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,sBAAsB,EAAE,wCAAwC;AAE9E,OAAO,KAAK,EACV,qBAAqB,EACrB,qBAAqB,EAErB,kBAAkB,EAClB,gBAAgB,EACjB,4BAA4B;AAK7B,OAAO,EAAE,KAAK,aAAa,EAAE,8BAA8B;AAU3D,MAAM,MAAM,0BAA0B,GAAG;IACvC;;;OAGG;IACH,eAAe,EAAE,CACf,EAAE,EAAE,kBAAkB,EACtB,OAAO,CAAC,EAAE,gBAAgB,KACvB,OAAO,CAAC,MAAM,CAAC,CAAC;CACtB,CAAC;AAEF,eAAO,MAAM,sBAAsB,EAAE,sBAAsB,CACzD,0BAA0B,EAC1B,yBAAyB,EACzB,qBAAqB,CAKtB,CAAC;AAEF,QAAA,MAAM,+BAA+B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;uBA4CrC;;;;;;WAMG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;uBANH;;;;;;WAMG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA/CD,CAAC;AAEH,MAAM,MAAM,yBAAyB,GAAG,aAAa,CACnD,OAAO,+BAA+B,EACtC,qBAAqB,CACtB,CAAC"}

package/dist/permitted/createInterface.d.mts

@@ -96,6 +96,7 @@ declare const CreateInterfaceParametersStruct: import("@metamask/superstruct").S
         }, "Radio">>;
     }, "RadioGroup"> | import("@metamask/snaps-sdk/jsx").SnapElement<{
         children: import("@metamask/snaps-sdk/jsx").StringElement;
+        size?: "md" | "lg" | undefined;
     }, "Heading">;
     context?: Record<string, import("@metamask/snaps-sdk").Json> | undefined;
 }, {
@@ -185,6 +186,7 @@ declare const CreateInterfaceParametersStruct: import("@metamask/superstruct").S
         }, "Radio">>;
     }, "RadioGroup"> | import("@metamask/snaps-sdk/jsx").SnapElement<{
         children: import("@metamask/snaps-sdk/jsx").StringElement;
+        size?: "md" | "lg" | undefined;
     }, "Heading">, null>;
     context: import("@metamask/superstruct").Struct<Record<string, import("@metamask/snaps-sdk").Json> | undefined, null>;
 }>;

package/dist/permitted/createInterface.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"createInterface.d.mts","sourceRoot":"","sources":["../../src/permitted/createInterface.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,sBAAsB,EAAE,wCAAwC;AAE9E,OAAO,KAAK,EACV,qBAAqB,EACrB,qBAAqB,EAErB,kBAAkB,EAClB,gBAAgB,EACjB,4BAA4B;AAK7B,OAAO,EAAE,KAAK,aAAa,EAAE,8BAA8B;AAU3D,MAAM,MAAM,0BAA0B,GAAG;IACvC;;;OAGG;IACH,eAAe,EAAE,CACf,EAAE,EAAE,kBAAkB,EACtB,OAAO,CAAC,EAAE,gBAAgB,KACvB,OAAO,CAAC,MAAM,CAAC,CAAC;CACtB,CAAC;AAEF,eAAO,MAAM,sBAAsB,EAAE,sBAAsB,CACzD,0BAA0B,EAC1B,yBAAyB,EACzB,qBAAqB,CAKtB,CAAC;AAEF,QAAA,MAAM,+BAA+B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;uBA4CrC;;;;;;WAMG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;uBANH;;;;;;WAMG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA/CD,CAAC;AAEH,MAAM,MAAM,yBAAyB,GAAG,aAAa,CACnD,OAAO,+BAA+B,EACtC,qBAAqB,CACtB,CAAC"}
+{"version":3,"file":"createInterface.d.mts","sourceRoot":"","sources":["../../src/permitted/createInterface.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,sBAAsB,EAAE,wCAAwC;AAE9E,OAAO,KAAK,EACV,qBAAqB,EACrB,qBAAqB,EAErB,kBAAkB,EAClB,gBAAgB,EACjB,4BAA4B;AAK7B,OAAO,EAAE,KAAK,aAAa,EAAE,8BAA8B;AAU3D,MAAM,MAAM,0BAA0B,GAAG;IACvC;;;OAGG;IACH,eAAe,EAAE,CACf,EAAE,EAAE,kBAAkB,EACtB,OAAO,CAAC,EAAE,gBAAgB,KACvB,OAAO,CAAC,MAAM,CAAC,CAAC;CACtB,CAAC;AAEF,eAAO,MAAM,sBAAsB,EAAE,sBAAsB,CACzD,0BAA0B,EAC1B,yBAAyB,EACzB,qBAAqB,CAKtB,CAAC;AAEF,QAAA,MAAM,+BAA+B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;uBA4CrC;;;;;;WAMG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;uBANH;;;;;;WAMG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA/CD,CAAC;AAEH,MAAM,MAAM,yBAAyB,GAAG,aAAa,CACnD,OAAO,+BAA+B,EACtC,qBAAqB,CACtB,CAAC"}

package/dist/permitted/experimentalProviderRequest.cjs

@@ -0,0 +1,146 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.providerRequestHandler = void 0;
+const rpc_errors_1 = require("@metamask/rpc-errors");
+const superstruct_1 = require("@metamask/superstruct");
+const utils_1 = require("@metamask/utils");
+const endowments_1 = require("../endowments/index.cjs");
+// Read-only methods that are currently allowed for this RPC method.
+const METHOD_ALLOWLIST = Object.freeze([
+    'eth_blockNumber',
+    'eth_call',
+    'eth_chainId',
+    'eth_coinbase',
+    'eth_estimateGas',
+    'eth_feeHistory',
+    'eth_gasPrice',
+    'eth_getBalance',
+    'eth_getBlockByHash',
+    'eth_getBlockByNumber',
+    'eth_getBlockTransactionCountByHash',
+    'eth_getBlockTransactionCountByNumber',
+    'eth_getCode',
+    'eth_getFilterChanges',
+    'eth_getFilterLogs',
+    'eth_getLogs',
+    'eth_getProof',
+    'eth_getStorageAt',
+    'eth_getTransactionByBlockHashAndIndex',
+    'eth_getTransactionByBlockNumberAndIndex',
+    'eth_getTransactionByHash',
+    'eth_getTransactionCount',
+    'eth_getTransactionReceipt',
+    'eth_getUncleByBlockHashAndIndex',
+    'eth_getUncleByBlockNumberAndIndex',
+    'eth_getUncleCountByBlockHash',
+    'eth_getUncleCountByBlockNumber',
+    'eth_getWork',
+    'eth_hashrate',
+    'eth_mining',
+    'eth_newBlockFilter',
+    'eth_newFilter',
+    'eth_newPendingTransactionFilter',
+    'eth_protocolVersion',
+    'eth_sendRawTransaction',
+    'eth_submitHashrate',
+    'eth_submitWork',
+    'eth_syncing',
+    'eth_uninstallFilter',
+    'net_listening',
+    'net_peerCount',
+    'net_version',
+    'web3_clientVersion',
+    'web3_sha3',
+]);
+const hookNames = {
+    hasPermission: true,
+    getNetworkConfigurationByChainId: true,
+    getNetworkClientById: true,
+};
+exports.providerRequestHandler = {
+    methodNames: ['snap_experimentalProviderRequest'],
+    implementation: providerRequestImplementation,
+    hookNames,
+};
+const ProviderRequestParametersStruct = (0, superstruct_1.object)({
+    chainId: utils_1.CaipChainIdStruct,
+    request: (0, superstruct_1.type)({
+        method: (0, superstruct_1.string)(),
+        params: (0, superstruct_1.optional)(utils_1.JsonRpcParamsStruct),
+    }),
+});
+/**
+ * The `snap_experimentalProviderRequest` method implementation.
+ *
+ * This RPC method lets Snaps make requests to MetaMask networks that are not currently selected in the UI.
+ *
+ * The RPC method requires the caller to have the endowment:ethereum-provider permission.
+ *
+ * NOTE: This implementation is experimental and may be removed or changed without warning.
+ *
+ * @param req - The JSON-RPC request object.
+ * @param res - The JSON-RPC response object.
+ * @param _next - The `json-rpc-engine` "next" callback. Not used by this
+ * function.
+ * @param end - The `json-rpc-engine` "end" callback.
+ * @param hooks - The RPC method hooks.
+ * @param hooks.hasPermission - Checks whether a given origin has a given permission.
+ * @param hooks.getNetworkConfigurationByChainId - Get a network configuration for a given chain ID.
+ * @param hooks.getNetworkClientById - Get a network client for a given ID.
+ * @returns Nothing.
+ */
+async function providerRequestImplementation(req, res, _next, end, { hasPermission, getNetworkConfigurationByChainId, getNetworkClientById, }) {
+    if (!hasPermission(endowments_1.SnapEndowments.EthereumProvider)) {
+        return end(rpc_errors_1.rpcErrors.methodNotFound());
+    }
+    const { params } = req;
+    try {
+        const { chainId, request } = getValidatedParams(params);
+        if (!METHOD_ALLOWLIST.includes(request.method)) {
+            return end(rpc_errors_1.rpcErrors.methodNotFound());
+        }
+        const parsedChainId = (0, utils_1.parseCaipChainId)(chainId);
+        if (parsedChainId.namespace !== 'eip155') {
+            return end(rpc_errors_1.rpcErrors.invalidParams({
+                message: 'Only EVM networks are currently supported.',
+            }));
+        }
+        const numericalChainId = BigInt(parsedChainId.reference);
+        const networkConfiguration = getNetworkConfigurationByChainId((0, utils_1.bigIntToHex)(numericalChainId));
+        if (!networkConfiguration) {
+            return end(rpc_errors_1.rpcErrors.invalidParams({
+                message: 'The requested network is not available.',
+            }));
+        }
+        const rpc = networkConfiguration.rpcEndpoints[networkConfiguration.defaultRpcEndpointIndex];
+        const networkClient = getNetworkClientById(rpc.networkClientId);
+        const { provider } = networkClient;
+        res.result = await provider.request(request);
+    }
+    catch (error) {
+        return end(error);
+    }
+    return end();
+}
+/**
+ * Validate the method `params` and returns them cast to the correct
+ * type. Throws if validation fails.
+ *
+ * @param params - The unvalidated params object from the method request.
+ * @returns The validated updateInterface method parameter object.
+ */
+function getValidatedParams(params) {
+    try {
+        return (0, superstruct_1.create)(params, ProviderRequestParametersStruct);
+    }
+    catch (error) {
+        if (error instanceof superstruct_1.StructError) {
+            throw rpc_errors_1.rpcErrors.invalidParams({
+                message: `Invalid params: ${error.message}.`,
+            });
+        }
+        /* istanbul ignore next */
+        throw rpc_errors_1.rpcErrors.internal();
+    }
+}
+//# sourceMappingURL=experimentalProviderRequest.cjs.map

package/dist/permitted/experimentalProviderRequest.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"experimentalProviderRequest.cjs","sourceRoot":"","sources":["../../src/permitted/experimentalProviderRequest.ts"],"names":[],"mappings":";;;AAEA,qDAAiD;AAOjD,uDAO+B;AAC/B,2CAOyB;AAEzB,wDAA+C;AAG/C,oEAAoE;AACpE,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,CAAC;IACrC,iBAAiB;IACjB,UAAU;IACV,aAAa;IACb,cAAc;IACd,iBAAiB;IACjB,gBAAgB;IAChB,cAAc;IACd,gBAAgB;IAChB,oBAAoB;IACpB,sBAAsB;IACtB,oCAAoC;IACpC,sCAAsC;IACtC,aAAa;IACb,sBAAsB;IACtB,mBAAmB;IACnB,aAAa;IACb,cAAc;IACd,kBAAkB;IAClB,uCAAuC;IACvC,yCAAyC;IACzC,0BAA0B;IAC1B,yBAAyB;IACzB,2BAA2B;IAC3B,iCAAiC;IACjC,mCAAmC;IACnC,8BAA8B;IAC9B,gCAAgC;IAChC,aAAa;IACb,cAAc;IACd,YAAY;IACZ,oBAAoB;IACpB,eAAe;IACf,iCAAiC;IACjC,qBAAqB;IACrB,wBAAwB;IACxB,oBAAoB;IACpB,gBAAgB;IAChB,aAAa;IACb,qBAAqB;IACrB,eAAe;IACf,eAAe;IACf,aAAa;IACb,oBAAoB;IACpB,WAAW;CACZ,CAAC,CAAC;AAEH,MAAM,SAAS,GAAkD;IAC/D,aAAa,EAAE,IAAI;IACnB,gCAAgC,EAAE,IAAI;IACtC,oBAAoB,EAAE,IAAI;CAC3B,CAAC;AAmBW,QAAA,sBAAsB,GAI/B;IACF,WAAW,EAAE,CAAC,kCAAkC,CAAC;IACjD,cAAc,EAAE,6BAA6B;IAC7C,SAAS;CACV,CAAC;AAEF,MAAM,+BAA+B,GAAG,IAAA,oBAAM,EAAC;IAC7C,OAAO,EAAE,yBAAiB;IAC1B,OAAO,EAAE,IAAA,kBAAI,EAAC;QACZ,MAAM,EAAE,IAAA,oBAAM,GAAE;QAChB,MAAM,EAAE,IAAA,sBAAQ,EAAC,2BAAmB,CAAC;KACtC,CAAC;CACH,CAAC,CAAC;AAOH;;;;;;;;;;;;;;;;;;;GAmBG;AACH,KAAK,UAAU,6BAA6B,CAC1C,GAA0C,EAC1C,GAAkD,EAClD,KAAc,EACd,GAA6B,EAC7B,EACE,aAAa,EACb,gCAAgC,EAChC,oBAAoB,GACO;IAE7B,IAAI,CAAC,aAAa,CAAC,2BAAc,CAAC,gBAAgB,CAAC,EAAE,CAAC;QACpD,OAAO,GAAG,CAAC,sBAAS,CAAC,cAAc,EAAE,CAAC,CAAC;IACzC,CAAC;IAED,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;IAEvB,IAAI,CAAC;QACH,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QAExD,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YAC/C,OAAO,GAAG,CAAC,sBAAS,CAAC,cAAc,EAAE,CAAC,CAAC;QACzC,CAAC;QAED,MAAM,aAAa,GAAG,IAAA,wBAAgB,EAAC,OAAO,CAAC,CAAC;QAEhD,IAAI,aAAa,CAAC,SAAS,KAAK,QAAQ,EAAE,CAAC;YACzC,OAAO,GAAG,CACR,sBAAS,CAAC,aAAa,CAAC;gBACtB,OAAO,EAAE,4CAA4C;aACtD,CAAC,CACH,CAAC;QACJ,CAAC;QAED,MAAM,gBAAgB,GAAG,MAAM,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;QAEzD,MAAM,oBAAoB,GAAG,gCAAgC,CAC3D,IAAA,mBAAW,EAAC,gBAAgB,CAAC,CAC9B,CAAC;QAEF,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAC1B,OAAO,GAAG,CACR,sBAAS,CAAC,aAAa,CAAC;gBACtB,OAAO,EAAE,yCAAyC;aACnD,CAAC,CACH,CAAC;QACJ,CAAC;QAED,MAAM,GAAG,GACP,oBAAoB,CAAC,YAAY,CAC/B,oBAAoB,CAAC,uBAAuB,CAC7C,CAAC;QAEJ,MAAM,aAAa,GAAG,oBAAoB,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;QAEhE,MAAM,EAAE,QAAQ,EAAE,GAAG,aAAa,CAAC;QAEnC,GAAG,CAAC,MAAM,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAC/C,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC;IAED,OAAO,GAAG,EAAE,CAAC;AACf,CAAC;AAED;;;;;;GAMG;AACH,SAAS,kBAAkB,CAAC,MAAe;IACzC,IAAI,CAAC;QACH,OAAO,IAAA,oBAAM,EAAC,MAAM,EAAE,+BAA+B,CAAC,CAAC;IACzD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,yBAAW,EAAE,CAAC;YACjC,MAAM,sBAAS,CAAC,aAAa,CAAC;gBAC5B,OAAO,EAAE,mBAAmB,KAAK,CAAC,OAAO,GAAG;aAC7C,CAAC,CAAC;QACL,CAAC;QACD,0BAA0B;QAC1B,MAAM,sBAAS,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;AACH,CAAC","sourcesContent":["import type { JsonRpcEngineEndCallback } from '@metamask/json-rpc-engine';\nimport type { PermittedHandlerExport } from '@metamask/permission-controller';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport type {\n  JsonRpcRequest,\n  ProviderRequestParams,\n  ProviderRequestResult,\n} from '@metamask/snaps-sdk';\nimport { type InferMatching } from '@metamask/snaps-utils';\nimport {\n  StructError,\n  create,\n  object,\n  optional,\n  string,\n  type,\n} from '@metamask/superstruct';\nimport {\n  bigIntToHex,\n  parseCaipChainId,\n  type PendingJsonRpcResponse,\n  type Json,\n  CaipChainIdStruct,\n  JsonRpcParamsStruct,\n} from '@metamask/utils';\n\nimport { SnapEndowments } from '../endowments';\nimport type { MethodHooksObject } from '../utils';\n\n// Read-only methods that are currently allowed for this RPC method.\nconst METHOD_ALLOWLIST = Object.freeze([\n  'eth_blockNumber',\n  'eth_call',\n  'eth_chainId',\n  'eth_coinbase',\n  'eth_estimateGas',\n  'eth_feeHistory',\n  'eth_gasPrice',\n  'eth_getBalance',\n  'eth_getBlockByHash',\n  'eth_getBlockByNumber',\n  'eth_getBlockTransactionCountByHash',\n  'eth_getBlockTransactionCountByNumber',\n  'eth_getCode',\n  'eth_getFilterChanges',\n  'eth_getFilterLogs',\n  'eth_getLogs',\n  'eth_getProof',\n  'eth_getStorageAt',\n  'eth_getTransactionByBlockHashAndIndex',\n  'eth_getTransactionByBlockNumberAndIndex',\n  'eth_getTransactionByHash',\n  'eth_getTransactionCount',\n  'eth_getTransactionReceipt',\n  'eth_getUncleByBlockHashAndIndex',\n  'eth_getUncleByBlockNumberAndIndex',\n  'eth_getUncleCountByBlockHash',\n  'eth_getUncleCountByBlockNumber',\n  'eth_getWork',\n  'eth_hashrate',\n  'eth_mining',\n  'eth_newBlockFilter',\n  'eth_newFilter',\n  'eth_newPendingTransactionFilter',\n  'eth_protocolVersion',\n  'eth_sendRawTransaction',\n  'eth_submitHashrate',\n  'eth_submitWork',\n  'eth_syncing',\n  'eth_uninstallFilter',\n  'net_listening',\n  'net_peerCount',\n  'net_version',\n  'web3_clientVersion',\n  'web3_sha3',\n]);\n\nconst hookNames: MethodHooksObject<ProviderRequestMethodHooks> = {\n  hasPermission: true,\n  getNetworkConfigurationByChainId: true,\n  getNetworkClientById: true,\n};\n\ntype NetworkConfiguration = {\n  defaultRpcEndpointIndex: number;\n  rpcEndpoints: { networkClientId: string }[];\n};\n\nexport type ProviderRequestMethodHooks = {\n  hasPermission: (permissionName: string) => boolean;\n\n  getNetworkConfigurationByChainId: (\n    chainId: string,\n  ) => NetworkConfiguration | undefined;\n\n  getNetworkClientById: (id: string) => {\n    provider: { request: (request: Json) => Promise<Json> };\n  };\n};\n\nexport const providerRequestHandler: PermittedHandlerExport<\n  ProviderRequestMethodHooks,\n  ProviderRequestParameters,\n  ProviderRequestResult\n> = {\n  methodNames: ['snap_experimentalProviderRequest'],\n  implementation: providerRequestImplementation,\n  hookNames,\n};\n\nconst ProviderRequestParametersStruct = object({\n  chainId: CaipChainIdStruct,\n  request: type({\n    method: string(),\n    params: optional(JsonRpcParamsStruct),\n  }),\n});\n\nexport type ProviderRequestParameters = InferMatching<\n  typeof ProviderRequestParametersStruct,\n  ProviderRequestParams\n>;\n\n/**\n * The `snap_experimentalProviderRequest` method implementation.\n *\n * This RPC method lets Snaps make requests to MetaMask networks that are not currently selected in the UI.\n *\n * The RPC method requires the caller to have the endowment:ethereum-provider permission.\n *\n * NOTE: This implementation is experimental and may be removed or changed without warning.\n *\n * @param req - The JSON-RPC request object.\n * @param res - The JSON-RPC response object.\n * @param _next - The `json-rpc-engine` \"next\" callback. Not used by this\n * function.\n * @param end - The `json-rpc-engine` \"end\" callback.\n * @param hooks - The RPC method hooks.\n * @param hooks.hasPermission - Checks whether a given origin has a given permission.\n * @param hooks.getNetworkConfigurationByChainId - Get a network configuration for a given chain ID.\n * @param hooks.getNetworkClientById - Get a network client for a given ID.\n * @returns Nothing.\n */\nasync function providerRequestImplementation(\n  req: JsonRpcRequest<ProviderRequestParams>,\n  res: PendingJsonRpcResponse<ProviderRequestResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  {\n    hasPermission,\n    getNetworkConfigurationByChainId,\n    getNetworkClientById,\n  }: ProviderRequestMethodHooks,\n): Promise<void> {\n  if (!hasPermission(SnapEndowments.EthereumProvider)) {\n    return end(rpcErrors.methodNotFound());\n  }\n\n  const { params } = req;\n\n  try {\n    const { chainId, request } = getValidatedParams(params);\n\n    if (!METHOD_ALLOWLIST.includes(request.method)) {\n      return end(rpcErrors.methodNotFound());\n    }\n\n    const parsedChainId = parseCaipChainId(chainId);\n\n    if (parsedChainId.namespace !== 'eip155') {\n      return end(\n        rpcErrors.invalidParams({\n          message: 'Only EVM networks are currently supported.',\n        }),\n      );\n    }\n\n    const numericalChainId = BigInt(parsedChainId.reference);\n\n    const networkConfiguration = getNetworkConfigurationByChainId(\n      bigIntToHex(numericalChainId),\n    );\n\n    if (!networkConfiguration) {\n      return end(\n        rpcErrors.invalidParams({\n          message: 'The requested network is not available.',\n        }),\n      );\n    }\n\n    const rpc =\n      networkConfiguration.rpcEndpoints[\n        networkConfiguration.defaultRpcEndpointIndex\n      ];\n\n    const networkClient = getNetworkClientById(rpc.networkClientId);\n\n    const { provider } = networkClient;\n\n    res.result = await provider.request(request);\n  } catch (error) {\n    return end(error);\n  }\n\n  return end();\n}\n\n/**\n * Validate the method `params` and returns them cast to the correct\n * type. Throws if validation fails.\n *\n * @param params - The unvalidated params object from the method request.\n * @returns The validated updateInterface method parameter object.\n */\nfunction getValidatedParams(params: unknown): ProviderRequestParameters {\n  try {\n    return create(params, ProviderRequestParametersStruct);\n  } catch (error) {\n    if (error instanceof StructError) {\n      throw rpcErrors.invalidParams({\n        message: `Invalid params: ${error.message}.`,\n      });\n    }\n    /* istanbul ignore next */\n    throw rpcErrors.internal();\n  }\n}\n"]}

package/dist/permitted/experimentalProviderRequest.d.cts

@@ -0,0 +1,39 @@
+import type { PermittedHandlerExport } from "@metamask/permission-controller";
+import type { ProviderRequestParams, ProviderRequestResult } from "@metamask/snaps-sdk";
+import { type InferMatching } from "@metamask/snaps-utils";
+import { type Json } from "@metamask/utils";
+type NetworkConfiguration = {
+    defaultRpcEndpointIndex: number;
+    rpcEndpoints: {
+        networkClientId: string;
+    }[];
+};
+export type ProviderRequestMethodHooks = {
+    hasPermission: (permissionName: string) => boolean;
+    getNetworkConfigurationByChainId: (chainId: string) => NetworkConfiguration | undefined;
+    getNetworkClientById: (id: string) => {
+        provider: {
+            request: (request: Json) => Promise<Json>;
+        };
+    };
+};
+export declare const providerRequestHandler: PermittedHandlerExport<ProviderRequestMethodHooks, ProviderRequestParameters, ProviderRequestResult>;
+declare const ProviderRequestParametersStruct: import("@metamask/superstruct").Struct<{
+    request: {
+        method: string;
+        params?: Record<string, Json> | Json[] | undefined;
+    };
+    chainId: `${string}:${string}`;
+}, {
+    chainId: import("@metamask/superstruct").Struct<`${string}:${string}`, null>;
+    request: import("@metamask/superstruct").Struct<{
+        method: string;
+        params?: Record<string, Json> | Json[] | undefined;
+    }, {
+        method: import("@metamask/superstruct").Struct<string, null>;
+        params: import("@metamask/superstruct").Struct<Record<string, Json> | Json[] | undefined, null>;
+    }>;
+}>;
+export type ProviderRequestParameters = InferMatching<typeof ProviderRequestParametersStruct, ProviderRequestParams>;
+export {};
+//# sourceMappingURL=experimentalProviderRequest.d.cts.map

package/dist/permitted/experimentalProviderRequest.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"experimentalProviderRequest.d.cts","sourceRoot":"","sources":["../../src/permitted/experimentalProviderRequest.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,sBAAsB,EAAE,wCAAwC;AAE9E,OAAO,KAAK,EAEV,qBAAqB,EACrB,qBAAqB,EACtB,4BAA4B;AAC7B,OAAO,EAAE,KAAK,aAAa,EAAE,8BAA8B;AAS3D,OAAO,EAIL,KAAK,IAAI,EAGV,wBAAwB;AA2DzB,KAAK,oBAAoB,GAAG;IAC1B,uBAAuB,EAAE,MAAM,CAAC;IAChC,YAAY,EAAE;QAAE,eAAe,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;CAC7C,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG;IACvC,aAAa,EAAE,CAAC,cAAc,EAAE,MAAM,KAAK,OAAO,CAAC;IAEnD,gCAAgC,EAAE,CAChC,OAAO,EAAE,MAAM,KACZ,oBAAoB,GAAG,SAAS,CAAC;IAEtC,oBAAoB,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK;QACpC,QAAQ,EAAE;YAAE,OAAO,EAAE,CAAC,OAAO,EAAE,IAAI,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;SAAE,CAAC;KACzD,CAAC;CACH,CAAC;AAEF,eAAO,MAAM,sBAAsB,EAAE,sBAAsB,CACzD,0BAA0B,EAC1B,yBAAyB,EACzB,qBAAqB,CAKtB,CAAC;AAEF,QAAA,MAAM,+BAA+B;;;;;;;;;;;;;;;EAMnC,CAAC;AAEH,MAAM,MAAM,yBAAyB,GAAG,aAAa,CACnD,OAAO,+BAA+B,EACtC,qBAAqB,CACtB,CAAC"}

package/dist/permitted/experimentalProviderRequest.d.mts

@@ -0,0 +1,39 @@
+import type { PermittedHandlerExport } from "@metamask/permission-controller";
+import type { ProviderRequestParams, ProviderRequestResult } from "@metamask/snaps-sdk";
+import { type InferMatching } from "@metamask/snaps-utils";
+import { type Json } from "@metamask/utils";
+type NetworkConfiguration = {
+    defaultRpcEndpointIndex: number;
+    rpcEndpoints: {
+        networkClientId: string;
+    }[];
+};
+export type ProviderRequestMethodHooks = {
+    hasPermission: (permissionName: string) => boolean;
+    getNetworkConfigurationByChainId: (chainId: string) => NetworkConfiguration | undefined;
+    getNetworkClientById: (id: string) => {
+        provider: {
+            request: (request: Json) => Promise<Json>;
+        };
+    };
+};
+export declare const providerRequestHandler: PermittedHandlerExport<ProviderRequestMethodHooks, ProviderRequestParameters, ProviderRequestResult>;
+declare const ProviderRequestParametersStruct: import("@metamask/superstruct").Struct<{
+    request: {
+        method: string;
+        params?: Record<string, Json> | Json[] | undefined;
+    };
+    chainId: `${string}:${string}`;
+}, {
+    chainId: import("@metamask/superstruct").Struct<`${string}:${string}`, null>;
+    request: import("@metamask/superstruct").Struct<{
+        method: string;
+        params?: Record<string, Json> | Json[] | undefined;
+    }, {
+        method: import("@metamask/superstruct").Struct<string, null>;
+        params: import("@metamask/superstruct").Struct<Record<string, Json> | Json[] | undefined, null>;
+    }>;
+}>;
+export type ProviderRequestParameters = InferMatching<typeof ProviderRequestParametersStruct, ProviderRequestParams>;
+export {};
+//# sourceMappingURL=experimentalProviderRequest.d.mts.map

package/dist/permitted/experimentalProviderRequest.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"experimentalProviderRequest.d.mts","sourceRoot":"","sources":["../../src/permitted/experimentalProviderRequest.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,sBAAsB,EAAE,wCAAwC;AAE9E,OAAO,KAAK,EAEV,qBAAqB,EACrB,qBAAqB,EACtB,4BAA4B;AAC7B,OAAO,EAAE,KAAK,aAAa,EAAE,8BAA8B;AAS3D,OAAO,EAIL,KAAK,IAAI,EAGV,wBAAwB;AA2DzB,KAAK,oBAAoB,GAAG;IAC1B,uBAAuB,EAAE,MAAM,CAAC;IAChC,YAAY,EAAE;QAAE,eAAe,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;CAC7C,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG;IACvC,aAAa,EAAE,CAAC,cAAc,EAAE,MAAM,KAAK,OAAO,CAAC;IAEnD,gCAAgC,EAAE,CAChC,OAAO,EAAE,MAAM,KACZ,oBAAoB,GAAG,SAAS,CAAC;IAEtC,oBAAoB,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK;QACpC,QAAQ,EAAE;YAAE,OAAO,EAAE,CAAC,OAAO,EAAE,IAAI,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;SAAE,CAAC;KACzD,CAAC;CACH,CAAC;AAEF,eAAO,MAAM,sBAAsB,EAAE,sBAAsB,CACzD,0BAA0B,EAC1B,yBAAyB,EACzB,qBAAqB,CAKtB,CAAC;AAEF,QAAA,MAAM,+BAA+B;;;;;;;;;;;;;;;EAMnC,CAAC;AAEH,MAAM,MAAM,yBAAyB,GAAG,aAAa,CACnD,OAAO,+BAA+B,EACtC,qBAAqB,CACtB,CAAC"}

package/dist/permitted/experimentalProviderRequest.mjs

@@ -0,0 +1,143 @@
+import { rpcErrors } from "@metamask/rpc-errors";
+import { StructError, create, object, optional, string, type } from "@metamask/superstruct";
+import { bigIntToHex, parseCaipChainId, CaipChainIdStruct, JsonRpcParamsStruct } from "@metamask/utils";
+import { SnapEndowments } from "../endowments/index.mjs";
+// Read-only methods that are currently allowed for this RPC method.
+const METHOD_ALLOWLIST = Object.freeze([
+    'eth_blockNumber',
+    'eth_call',
+    'eth_chainId',
+    'eth_coinbase',
+    'eth_estimateGas',
+    'eth_feeHistory',
+    'eth_gasPrice',
+    'eth_getBalance',
+    'eth_getBlockByHash',
+    'eth_getBlockByNumber',
+    'eth_getBlockTransactionCountByHash',
+    'eth_getBlockTransactionCountByNumber',
+    'eth_getCode',
+    'eth_getFilterChanges',
+    'eth_getFilterLogs',
+    'eth_getLogs',
+    'eth_getProof',
+    'eth_getStorageAt',
+    'eth_getTransactionByBlockHashAndIndex',
+    'eth_getTransactionByBlockNumberAndIndex',
+    'eth_getTransactionByHash',
+    'eth_getTransactionCount',
+    'eth_getTransactionReceipt',
+    'eth_getUncleByBlockHashAndIndex',
+    'eth_getUncleByBlockNumberAndIndex',
+    'eth_getUncleCountByBlockHash',
+    'eth_getUncleCountByBlockNumber',
+    'eth_getWork',
+    'eth_hashrate',
+    'eth_mining',
+    'eth_newBlockFilter',
+    'eth_newFilter',
+    'eth_newPendingTransactionFilter',
+    'eth_protocolVersion',
+    'eth_sendRawTransaction',
+    'eth_submitHashrate',
+    'eth_submitWork',
+    'eth_syncing',
+    'eth_uninstallFilter',
+    'net_listening',
+    'net_peerCount',
+    'net_version',
+    'web3_clientVersion',
+    'web3_sha3',
+]);
+const hookNames = {
+    hasPermission: true,
+    getNetworkConfigurationByChainId: true,
+    getNetworkClientById: true,
+};
+export const providerRequestHandler = {
+    methodNames: ['snap_experimentalProviderRequest'],
+    implementation: providerRequestImplementation,
+    hookNames,
+};
+const ProviderRequestParametersStruct = object({
+    chainId: CaipChainIdStruct,
+    request: type({
+        method: string(),
+        params: optional(JsonRpcParamsStruct),
+    }),
+});
+/**
+ * The `snap_experimentalProviderRequest` method implementation.
+ *
+ * This RPC method lets Snaps make requests to MetaMask networks that are not currently selected in the UI.
+ *
+ * The RPC method requires the caller to have the endowment:ethereum-provider permission.
+ *
+ * NOTE: This implementation is experimental and may be removed or changed without warning.
+ *
+ * @param req - The JSON-RPC request object.
+ * @param res - The JSON-RPC response object.
+ * @param _next - The `json-rpc-engine` "next" callback. Not used by this
+ * function.
+ * @param end - The `json-rpc-engine` "end" callback.
+ * @param hooks - The RPC method hooks.
+ * @param hooks.hasPermission - Checks whether a given origin has a given permission.
+ * @param hooks.getNetworkConfigurationByChainId - Get a network configuration for a given chain ID.
+ * @param hooks.getNetworkClientById - Get a network client for a given ID.
+ * @returns Nothing.
+ */
+async function providerRequestImplementation(req, res, _next, end, { hasPermission, getNetworkConfigurationByChainId, getNetworkClientById, }) {
+    if (!hasPermission(SnapEndowments.EthereumProvider)) {
+        return end(rpcErrors.methodNotFound());
+    }
+    const { params } = req;
+    try {
+        const { chainId, request } = getValidatedParams(params);
+        if (!METHOD_ALLOWLIST.includes(request.method)) {
+            return end(rpcErrors.methodNotFound());
+        }
+        const parsedChainId = parseCaipChainId(chainId);
+        if (parsedChainId.namespace !== 'eip155') {
+            return end(rpcErrors.invalidParams({
+                message: 'Only EVM networks are currently supported.',
+            }));
+        }
+        const numericalChainId = BigInt(parsedChainId.reference);
+        const networkConfiguration = getNetworkConfigurationByChainId(bigIntToHex(numericalChainId));
+        if (!networkConfiguration) {
+            return end(rpcErrors.invalidParams({
+                message: 'The requested network is not available.',
+            }));
+        }
+        const rpc = networkConfiguration.rpcEndpoints[networkConfiguration.defaultRpcEndpointIndex];
+        const networkClient = getNetworkClientById(rpc.networkClientId);
+        const { provider } = networkClient;
+        res.result = await provider.request(request);
+    }
+    catch (error) {
+        return end(error);
+    }
+    return end();
+}
+/**
+ * Validate the method `params` and returns them cast to the correct
+ * type. Throws if validation fails.
+ *
+ * @param params - The unvalidated params object from the method request.
+ * @returns The validated updateInterface method parameter object.
+ */
+function getValidatedParams(params) {
+    try {
+        return create(params, ProviderRequestParametersStruct);
+    }
+    catch (error) {
+        if (error instanceof StructError) {
+            throw rpcErrors.invalidParams({
+                message: `Invalid params: ${error.message}.`,
+            });
+        }
+        /* istanbul ignore next */
+        throw rpcErrors.internal();
+    }
+}
+//# sourceMappingURL=experimentalProviderRequest.mjs.map

package/dist/permitted/experimentalProviderRequest.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"experimentalProviderRequest.mjs","sourceRoot":"","sources":["../../src/permitted/experimentalProviderRequest.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,6BAA6B;AAOjD,OAAO,EACL,WAAW,EACX,MAAM,EACN,MAAM,EACN,QAAQ,EACR,MAAM,EACN,IAAI,EACL,8BAA8B;AAC/B,OAAO,EACL,WAAW,EACX,gBAAgB,EAGhB,iBAAiB,EACjB,mBAAmB,EACpB,wBAAwB;AAEzB,OAAO,EAAE,cAAc,EAAE,gCAAsB;AAG/C,oEAAoE;AACpE,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,CAAC;IACrC,iBAAiB;IACjB,UAAU;IACV,aAAa;IACb,cAAc;IACd,iBAAiB;IACjB,gBAAgB;IAChB,cAAc;IACd,gBAAgB;IAChB,oBAAoB;IACpB,sBAAsB;IACtB,oCAAoC;IACpC,sCAAsC;IACtC,aAAa;IACb,sBAAsB;IACtB,mBAAmB;IACnB,aAAa;IACb,cAAc;IACd,kBAAkB;IAClB,uCAAuC;IACvC,yCAAyC;IACzC,0BAA0B;IAC1B,yBAAyB;IACzB,2BAA2B;IAC3B,iCAAiC;IACjC,mCAAmC;IACnC,8BAA8B;IAC9B,gCAAgC;IAChC,aAAa;IACb,cAAc;IACd,YAAY;IACZ,oBAAoB;IACpB,eAAe;IACf,iCAAiC;IACjC,qBAAqB;IACrB,wBAAwB;IACxB,oBAAoB;IACpB,gBAAgB;IAChB,aAAa;IACb,qBAAqB;IACrB,eAAe;IACf,eAAe;IACf,aAAa;IACb,oBAAoB;IACpB,WAAW;CACZ,CAAC,CAAC;AAEH,MAAM,SAAS,GAAkD;IAC/D,aAAa,EAAE,IAAI;IACnB,gCAAgC,EAAE,IAAI;IACtC,oBAAoB,EAAE,IAAI;CAC3B,CAAC;AAmBF,MAAM,CAAC,MAAM,sBAAsB,GAI/B;IACF,WAAW,EAAE,CAAC,kCAAkC,CAAC;IACjD,cAAc,EAAE,6BAA6B;IAC7C,SAAS;CACV,CAAC;AAEF,MAAM,+BAA+B,GAAG,MAAM,CAAC;IAC7C,OAAO,EAAE,iBAAiB;IAC1B,OAAO,EAAE,IAAI,CAAC;QACZ,MAAM,EAAE,MAAM,EAAE;QAChB,MAAM,EAAE,QAAQ,CAAC,mBAAmB,CAAC;KACtC,CAAC;CACH,CAAC,CAAC;AAOH;;;;;;;;;;;;;;;;;;;GAmBG;AACH,KAAK,UAAU,6BAA6B,CAC1C,GAA0C,EAC1C,GAAkD,EAClD,KAAc,EACd,GAA6B,EAC7B,EACE,aAAa,EACb,gCAAgC,EAChC,oBAAoB,GACO;IAE7B,IAAI,CAAC,aAAa,CAAC,cAAc,CAAC,gBAAgB,CAAC,EAAE,CAAC;QACpD,OAAO,GAAG,CAAC,SAAS,CAAC,cAAc,EAAE,CAAC,CAAC;IACzC,CAAC;IAED,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;IAEvB,IAAI,CAAC;QACH,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QAExD,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YAC/C,OAAO,GAAG,CAAC,SAAS,CAAC,cAAc,EAAE,CAAC,CAAC;QACzC,CAAC;QAED,MAAM,aAAa,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAAC;QAEhD,IAAI,aAAa,CAAC,SAAS,KAAK,QAAQ,EAAE,CAAC;YACzC,OAAO,GAAG,CACR,SAAS,CAAC,aAAa,CAAC;gBACtB,OAAO,EAAE,4CAA4C;aACtD,CAAC,CACH,CAAC;QACJ,CAAC;QAED,MAAM,gBAAgB,GAAG,MAAM,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;QAEzD,MAAM,oBAAoB,GAAG,gCAAgC,CAC3D,WAAW,CAAC,gBAAgB,CAAC,CAC9B,CAAC;QAEF,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAC1B,OAAO,GAAG,CACR,SAAS,CAAC,aAAa,CAAC;gBACtB,OAAO,EAAE,yCAAyC;aACnD,CAAC,CACH,CAAC;QACJ,CAAC;QAED,MAAM,GAAG,GACP,oBAAoB,CAAC,YAAY,CAC/B,oBAAoB,CAAC,uBAAuB,CAC7C,CAAC;QAEJ,MAAM,aAAa,GAAG,oBAAoB,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;QAEhE,MAAM,EAAE,QAAQ,EAAE,GAAG,aAAa,CAAC;QAEnC,GAAG,CAAC,MAAM,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAC/C,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC;IAED,OAAO,GAAG,EAAE,CAAC;AACf,CAAC;AAED;;;;;;GAMG;AACH,SAAS,kBAAkB,CAAC,MAAe;IACzC,IAAI,CAAC;QACH,OAAO,MAAM,CAAC,MAAM,EAAE,+BAA+B,CAAC,CAAC;IACzD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,WAAW,EAAE,CAAC;YACjC,MAAM,SAAS,CAAC,aAAa,CAAC;gBAC5B,OAAO,EAAE,mBAAmB,KAAK,CAAC,OAAO,GAAG;aAC7C,CAAC,CAAC;QACL,CAAC;QACD,0BAA0B;QAC1B,MAAM,SAAS,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;AACH,CAAC","sourcesContent":["import type { JsonRpcEngineEndCallback } from '@metamask/json-rpc-engine';\nimport type { PermittedHandlerExport } from '@metamask/permission-controller';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport type {\n  JsonRpcRequest,\n  ProviderRequestParams,\n  ProviderRequestResult,\n} from '@metamask/snaps-sdk';\nimport { type InferMatching } from '@metamask/snaps-utils';\nimport {\n  StructError,\n  create,\n  object,\n  optional,\n  string,\n  type,\n} from '@metamask/superstruct';\nimport {\n  bigIntToHex,\n  parseCaipChainId,\n  type PendingJsonRpcResponse,\n  type Json,\n  CaipChainIdStruct,\n  JsonRpcParamsStruct,\n} from '@metamask/utils';\n\nimport { SnapEndowments } from '../endowments';\nimport type { MethodHooksObject } from '../utils';\n\n// Read-only methods that are currently allowed for this RPC method.\nconst METHOD_ALLOWLIST = Object.freeze([\n  'eth_blockNumber',\n  'eth_call',\n  'eth_chainId',\n  'eth_coinbase',\n  'eth_estimateGas',\n  'eth_feeHistory',\n  'eth_gasPrice',\n  'eth_getBalance',\n  'eth_getBlockByHash',\n  'eth_getBlockByNumber',\n  'eth_getBlockTransactionCountByHash',\n  'eth_getBlockTransactionCountByNumber',\n  'eth_getCode',\n  'eth_getFilterChanges',\n  'eth_getFilterLogs',\n  'eth_getLogs',\n  'eth_getProof',\n  'eth_getStorageAt',\n  'eth_getTransactionByBlockHashAndIndex',\n  'eth_getTransactionByBlockNumberAndIndex',\n  'eth_getTransactionByHash',\n  'eth_getTransactionCount',\n  'eth_getTransactionReceipt',\n  'eth_getUncleByBlockHashAndIndex',\n  'eth_getUncleByBlockNumberAndIndex',\n  'eth_getUncleCountByBlockHash',\n  'eth_getUncleCountByBlockNumber',\n  'eth_getWork',\n  'eth_hashrate',\n  'eth_mining',\n  'eth_newBlockFilter',\n  'eth_newFilter',\n  'eth_newPendingTransactionFilter',\n  'eth_protocolVersion',\n  'eth_sendRawTransaction',\n  'eth_submitHashrate',\n  'eth_submitWork',\n  'eth_syncing',\n  'eth_uninstallFilter',\n  'net_listening',\n  'net_peerCount',\n  'net_version',\n  'web3_clientVersion',\n  'web3_sha3',\n]);\n\nconst hookNames: MethodHooksObject<ProviderRequestMethodHooks> = {\n  hasPermission: true,\n  getNetworkConfigurationByChainId: true,\n  getNetworkClientById: true,\n};\n\ntype NetworkConfiguration = {\n  defaultRpcEndpointIndex: number;\n  rpcEndpoints: { networkClientId: string }[];\n};\n\nexport type ProviderRequestMethodHooks = {\n  hasPermission: (permissionName: string) => boolean;\n\n  getNetworkConfigurationByChainId: (\n    chainId: string,\n  ) => NetworkConfiguration | undefined;\n\n  getNetworkClientById: (id: string) => {\n    provider: { request: (request: Json) => Promise<Json> };\n  };\n};\n\nexport const providerRequestHandler: PermittedHandlerExport<\n  ProviderRequestMethodHooks,\n  ProviderRequestParameters,\n  ProviderRequestResult\n> = {\n  methodNames: ['snap_experimentalProviderRequest'],\n  implementation: providerRequestImplementation,\n  hookNames,\n};\n\nconst ProviderRequestParametersStruct = object({\n  chainId: CaipChainIdStruct,\n  request: type({\n    method: string(),\n    params: optional(JsonRpcParamsStruct),\n  }),\n});\n\nexport type ProviderRequestParameters = InferMatching<\n  typeof ProviderRequestParametersStruct,\n  ProviderRequestParams\n>;\n\n/**\n * The `snap_experimentalProviderRequest` method implementation.\n *\n * This RPC method lets Snaps make requests to MetaMask networks that are not currently selected in the UI.\n *\n * The RPC method requires the caller to have the endowment:ethereum-provider permission.\n *\n * NOTE: This implementation is experimental and may be removed or changed without warning.\n *\n * @param req - The JSON-RPC request object.\n * @param res - The JSON-RPC response object.\n * @param _next - The `json-rpc-engine` \"next\" callback. Not used by this\n * function.\n * @param end - The `json-rpc-engine` \"end\" callback.\n * @param hooks - The RPC method hooks.\n * @param hooks.hasPermission - Checks whether a given origin has a given permission.\n * @param hooks.getNetworkConfigurationByChainId - Get a network configuration for a given chain ID.\n * @param hooks.getNetworkClientById - Get a network client for a given ID.\n * @returns Nothing.\n */\nasync function providerRequestImplementation(\n  req: JsonRpcRequest<ProviderRequestParams>,\n  res: PendingJsonRpcResponse<ProviderRequestResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  {\n    hasPermission,\n    getNetworkConfigurationByChainId,\n    getNetworkClientById,\n  }: ProviderRequestMethodHooks,\n): Promise<void> {\n  if (!hasPermission(SnapEndowments.EthereumProvider)) {\n    return end(rpcErrors.methodNotFound());\n  }\n\n  const { params } = req;\n\n  try {\n    const { chainId, request } = getValidatedParams(params);\n\n    if (!METHOD_ALLOWLIST.includes(request.method)) {\n      return end(rpcErrors.methodNotFound());\n    }\n\n    const parsedChainId = parseCaipChainId(chainId);\n\n    if (parsedChainId.namespace !== 'eip155') {\n      return end(\n        rpcErrors.invalidParams({\n          message: 'Only EVM networks are currently supported.',\n        }),\n      );\n    }\n\n    const numericalChainId = BigInt(parsedChainId.reference);\n\n    const networkConfiguration = getNetworkConfigurationByChainId(\n      bigIntToHex(numericalChainId),\n    );\n\n    if (!networkConfiguration) {\n      return end(\n        rpcErrors.invalidParams({\n          message: 'The requested network is not available.',\n        }),\n      );\n    }\n\n    const rpc =\n      networkConfiguration.rpcEndpoints[\n        networkConfiguration.defaultRpcEndpointIndex\n      ];\n\n    const networkClient = getNetworkClientById(rpc.networkClientId);\n\n    const { provider } = networkClient;\n\n    res.result = await provider.request(request);\n  } catch (error) {\n    return end(error);\n  }\n\n  return end();\n}\n\n/**\n * Validate the method `params` and returns them cast to the correct\n * type. Throws if validation fails.\n *\n * @param params - The unvalidated params object from the method request.\n * @returns The validated updateInterface method parameter object.\n */\nfunction getValidatedParams(params: unknown): ProviderRequestParameters {\n  try {\n    return create(params, ProviderRequestParametersStruct);\n  } catch (error) {\n    if (error instanceof StructError) {\n      throw rpcErrors.invalidParams({\n        message: `Invalid params: ${error.message}.`,\n      });\n    }\n    /* istanbul ignore next */\n    throw rpcErrors.internal();\n  }\n}\n"]}

package/dist/permitted/getCurrencyRate.cjs

@@ -0,0 +1,63 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getCurrencyRateHandler = void 0;
+const rpc_errors_1 = require("@metamask/rpc-errors");
+const snaps_utils_1 = require("@metamask/snaps-utils");
+const superstruct_1 = require("@metamask/superstruct");
+const hookNames = {
+    getCurrencyRate: true,
+};
+exports.getCurrencyRateHandler = {
+    methodNames: ['snap_getCurrencyRate'],
+    implementation: getGetCurrencyRateImplementation,
+    hookNames,
+};
+const GetCurrencyRateParametersStruct = (0, superstruct_1.object)({
+    currency: (0, superstruct_1.union)([(0, snaps_utils_1.currency)('btc')]),
+});
+/**
+ * The `snap_getCurrencyRate` method implementation.
+ *
+ * @param req - The JSON-RPC request object.
+ * @param res - The JSON-RPC response object.
+ * @param _next - The `json-rpc-engine` "next" callback. Not used by this
+ * function.
+ * @param end - The `json-rpc-engine` "end" callback.
+ * @param hooks - The RPC method hooks.
+ * @param hooks.getCurrencyRate - The function to get the rate.
+ * @returns Nothing.
+ */
+function getGetCurrencyRateImplementation(req, res, _next, end, { getCurrencyRate }) {
+    const { params } = req;
+    try {
+        const validatedParams = getValidatedParams(params);
+        const { currency: selectedCurrency } = validatedParams;
+        res.result = getCurrencyRate(selectedCurrency) ?? null;
+    }
+    catch (error) {
+        return end(error);
+    }
+    return end();
+}
+/**
+ * Validate the getCurrencyRate method `params` and returns them cast to the correct
+ * type. Throws if validation fails.
+ *
+ * @param params - The unvalidated params object from the method request.
+ * @returns The validated getCurrencyRate method parameter object.
+ */
+function getValidatedParams(params) {
+    try {
+        return (0, superstruct_1.create)(params, GetCurrencyRateParametersStruct);
+    }
+    catch (error) {
+        if (error instanceof superstruct_1.StructError) {
+            throw rpc_errors_1.rpcErrors.invalidParams({
+                message: `Invalid params: ${error.message}.`,
+            });
+        }
+        /* istanbul ignore next */
+        throw rpc_errors_1.rpcErrors.internal();
+    }
+}
+//# sourceMappingURL=getCurrencyRate.cjs.map

package/dist/permitted/getCurrencyRate.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"getCurrencyRate.cjs","sourceRoot":"","sources":["../../src/permitted/getCurrencyRate.ts"],"names":[],"mappings":";;;AAEA,qDAAiD;AAQjD,uDAAqE;AACrE,uDAA2E;AAK3E,MAAM,SAAS,GAAkD;IAC/D,eAAe,EAAE,IAAI;CACtB,CAAC;AAWW,QAAA,sBAAsB,GAI/B;IACF,WAAW,EAAE,CAAC,sBAAsB,CAAC;IACrC,cAAc,EAAE,gCAAgC;IAChD,SAAS;CACV,CAAC;AAEF,MAAM,+BAA+B,GAAG,IAAA,oBAAM,EAAC;IAC7C,QAAQ,EAAE,IAAA,mBAAK,EAAC,CAAC,IAAA,sBAAQ,EAAC,KAAK,CAAC,CAAC,CAAC;CACnC,CAAC,CAAC;AAOH;;;;;;;;;;;GAWG;AACH,SAAS,gCAAgC,CACvC,GAA8C,EAC9C,GAAkD,EAClD,KAAc,EACd,GAA6B,EAC7B,EAAE,eAAe,EAA8B;IAE/C,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;IAEvB,IAAI,CAAC;QACH,MAAM,eAAe,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QAEnD,MAAM,EAAE,QAAQ,EAAE,gBAAgB,EAAE,GAAG,eAAe,CAAC;QAEvD,GAAG,CAAC,MAAM,GAAG,eAAe,CAAC,gBAAgB,CAAC,IAAI,IAAI,CAAC;IACzD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC;IAED,OAAO,GAAG,EAAE,CAAC;AACf,CAAC;AAED;;;;;;GAMG;AACH,SAAS,kBAAkB,CAAC,MAAe;IACzC,IAAI,CAAC;QACH,OAAO,IAAA,oBAAM,EAAC,MAAM,EAAE,+BAA+B,CAAC,CAAC;IACzD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,yBAAW,EAAE,CAAC;YACjC,MAAM,sBAAS,CAAC,aAAa,CAAC;gBAC5B,OAAO,EAAE,mBAAmB,KAAK,CAAC,OAAO,GAAG;aAC7C,CAAC,CAAC;QACL,CAAC;QACD,0BAA0B;QAC1B,MAAM,sBAAS,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;AACH,CAAC","sourcesContent":["import type { JsonRpcEngineEndCallback } from '@metamask/json-rpc-engine';\nimport type { PermittedHandlerExport } from '@metamask/permission-controller';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport type {\n  AvailableCurrency,\n  CurrencyRate,\n  GetCurrencyRateParams,\n  GetCurrencyRateResult,\n  JsonRpcRequest,\n} from '@metamask/snaps-sdk';\nimport { currency, type InferMatching } from '@metamask/snaps-utils';\nimport { StructError, create, object, union } from '@metamask/superstruct';\nimport type { PendingJsonRpcResponse } from '@metamask/utils';\n\nimport type { MethodHooksObject } from '../utils';\n\nconst hookNames: MethodHooksObject<GetCurrencyRateMethodHooks> = {\n  getCurrencyRate: true,\n};\n\nexport type GetCurrencyRateMethodHooks = {\n  /**\n   * @param currency - The currency symbol.\n   * Currently only 'btc' is supported.\n   * @returns The {@link CurrencyRate} object.\n   */\n  getCurrencyRate: (currency: AvailableCurrency) => CurrencyRate | undefined;\n};\n\nexport const getCurrencyRateHandler: PermittedHandlerExport<\n  GetCurrencyRateMethodHooks,\n  GetCurrencyRateParameters,\n  GetCurrencyRateResult\n> = {\n  methodNames: ['snap_getCurrencyRate'],\n  implementation: getGetCurrencyRateImplementation,\n  hookNames,\n};\n\nconst GetCurrencyRateParametersStruct = object({\n  currency: union([currency('btc')]),\n});\n\nexport type GetCurrencyRateParameters = InferMatching<\n  typeof GetCurrencyRateParametersStruct,\n  GetCurrencyRateParams\n>;\n\n/**\n * The `snap_getCurrencyRate` method implementation.\n *\n * @param req - The JSON-RPC request object.\n * @param res - The JSON-RPC response object.\n * @param _next - The `json-rpc-engine` \"next\" callback. Not used by this\n * function.\n * @param end - The `json-rpc-engine` \"end\" callback.\n * @param hooks - The RPC method hooks.\n * @param hooks.getCurrencyRate - The function to get the rate.\n * @returns Nothing.\n */\nfunction getGetCurrencyRateImplementation(\n  req: JsonRpcRequest<GetCurrencyRateParameters>,\n  res: PendingJsonRpcResponse<GetCurrencyRateResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  { getCurrencyRate }: GetCurrencyRateMethodHooks,\n): void {\n  const { params } = req;\n\n  try {\n    const validatedParams = getValidatedParams(params);\n\n    const { currency: selectedCurrency } = validatedParams;\n\n    res.result = getCurrencyRate(selectedCurrency) ?? null;\n  } catch (error) {\n    return end(error);\n  }\n\n  return end();\n}\n\n/**\n * Validate the getCurrencyRate method `params` and returns them cast to the correct\n * type. Throws if validation fails.\n *\n * @param params - The unvalidated params object from the method request.\n * @returns The validated getCurrencyRate method parameter object.\n */\nfunction getValidatedParams(params: unknown): GetCurrencyRateParameters {\n  try {\n    return create(params, GetCurrencyRateParametersStruct);\n  } catch (error) {\n    if (error instanceof StructError) {\n      throw rpcErrors.invalidParams({\n        message: `Invalid params: ${error.message}.`,\n      });\n    }\n    /* istanbul ignore next */\n    throw rpcErrors.internal();\n  }\n}\n"]}

package/dist/permitted/getCurrencyRate.d.cts

@@ -0,0 +1,20 @@
+import type { PermittedHandlerExport } from "@metamask/permission-controller";
+import type { AvailableCurrency, CurrencyRate, GetCurrencyRateParams, GetCurrencyRateResult } from "@metamask/snaps-sdk";
+import { type InferMatching } from "@metamask/snaps-utils";
+export type GetCurrencyRateMethodHooks = {
+    /**
+     * @param currency - The currency symbol.
+     * Currently only 'btc' is supported.
+     * @returns The {@link CurrencyRate} object.
+     */
+    getCurrencyRate: (currency: AvailableCurrency) => CurrencyRate | undefined;
+};
+export declare const getCurrencyRateHandler: PermittedHandlerExport<GetCurrencyRateMethodHooks, GetCurrencyRateParameters, GetCurrencyRateResult>;
+declare const GetCurrencyRateParametersStruct: import("@metamask/superstruct").Struct<{
+    currency: "btc" | "BTC";
+}, {
+    currency: import("@metamask/superstruct").Struct<"btc" | "BTC", null>;
+}>;
+export type GetCurrencyRateParameters = InferMatching<typeof GetCurrencyRateParametersStruct, GetCurrencyRateParams>;
+export {};
+//# sourceMappingURL=getCurrencyRate.d.cts.map

package/dist/permitted/getCurrencyRate.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getCurrencyRate.d.cts","sourceRoot":"","sources":["../../src/permitted/getCurrencyRate.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,sBAAsB,EAAE,wCAAwC;AAE9E,OAAO,KAAK,EACV,iBAAiB,EACjB,YAAY,EACZ,qBAAqB,EACrB,qBAAqB,EAEtB,4BAA4B;AAC7B,OAAO,EAAY,KAAK,aAAa,EAAE,8BAA8B;AAUrE,MAAM,MAAM,0BAA0B,GAAG;IACvC;;;;OAIG;IACH,eAAe,EAAE,CAAC,QAAQ,EAAE,iBAAiB,KAAK,YAAY,GAAG,SAAS,CAAC;CAC5E,CAAC;AAEF,eAAO,MAAM,sBAAsB,EAAE,sBAAsB,CACzD,0BAA0B,EAC1B,yBAAyB,EACzB,qBAAqB,CAKtB,CAAC;AAEF,QAAA,MAAM,+BAA+B;;;;EAEnC,CAAC;AAEH,MAAM,MAAM,yBAAyB,GAAG,aAAa,CACnD,OAAO,+BAA+B,EACtC,qBAAqB,CACtB,CAAC"}

package/dist/permitted/getCurrencyRate.d.mts

@@ -0,0 +1,20 @@
+import type { PermittedHandlerExport } from "@metamask/permission-controller";
+import type { AvailableCurrency, CurrencyRate, GetCurrencyRateParams, GetCurrencyRateResult } from "@metamask/snaps-sdk";
+import { type InferMatching } from "@metamask/snaps-utils";
+export type GetCurrencyRateMethodHooks = {
+    /**
+     * @param currency - The currency symbol.
+     * Currently only 'btc' is supported.
+     * @returns The {@link CurrencyRate} object.
+     */
+    getCurrencyRate: (currency: AvailableCurrency) => CurrencyRate | undefined;
+};
+export declare const getCurrencyRateHandler: PermittedHandlerExport<GetCurrencyRateMethodHooks, GetCurrencyRateParameters, GetCurrencyRateResult>;
+declare const GetCurrencyRateParametersStruct: import("@metamask/superstruct").Struct<{
+    currency: "btc" | "BTC";
+}, {
+    currency: import("@metamask/superstruct").Struct<"btc" | "BTC", null>;
+}>;
+export type GetCurrencyRateParameters = InferMatching<typeof GetCurrencyRateParametersStruct, GetCurrencyRateParams>;
+export {};
+//# sourceMappingURL=getCurrencyRate.d.mts.map

package/dist/permitted/getCurrencyRate.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getCurrencyRate.d.mts","sourceRoot":"","sources":["../../src/permitted/getCurrencyRate.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,sBAAsB,EAAE,wCAAwC;AAE9E,OAAO,KAAK,EACV,iBAAiB,EACjB,YAAY,EACZ,qBAAqB,EACrB,qBAAqB,EAEtB,4BAA4B;AAC7B,OAAO,EAAY,KAAK,aAAa,EAAE,8BAA8B;AAUrE,MAAM,MAAM,0BAA0B,GAAG;IACvC;;;;OAIG;IACH,eAAe,EAAE,CAAC,QAAQ,EAAE,iBAAiB,KAAK,YAAY,GAAG,SAAS,CAAC;CAC5E,CAAC;AAEF,eAAO,MAAM,sBAAsB,EAAE,sBAAsB,CACzD,0BAA0B,EAC1B,yBAAyB,EACzB,qBAAqB,CAKtB,CAAC;AAEF,QAAA,MAAM,+BAA+B;;;;EAEnC,CAAC;AAEH,MAAM,MAAM,yBAAyB,GAAG,aAAa,CACnD,OAAO,+BAA+B,EACtC,qBAAqB,CACtB,CAAC"}