@metamask/snaps-controllers 9.17.0 → 9.18.0

package/CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [9.18.0]
+
+### Added
+
+- Add support for `onAssetsLookup` and `onAssetsConversion` handlers ([#3028](https://github.com/MetaMask/snaps/pull/3028))
+
 ## [9.17.0]
 
 ### Added
@@ -605,7 +611,8 @@ 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-controllers@9.17.0...HEAD
+[Unreleased]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-controllers@9.18.0...HEAD
+[9.18.0]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-controllers@9.17.0...@metamask/snaps-controllers@9.18.0
 [9.17.0]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-controllers@9.16.0...@metamask/snaps-controllers@9.17.0
 [9.16.0]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-controllers@9.15.0...@metamask/snaps-controllers@9.16.0
 [9.15.0]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-controllers@9.14.0...@metamask/snaps-controllers@9.15.0

package/dist/snaps/SnapController.cjs

@@ -13,7 +13,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
-var _SnapController_instances, _SnapController_closeAllConnections, _SnapController_dynamicPermissions, _SnapController_environmentEndowmentPermissions, _SnapController_excludedPermissions, _SnapController_featureFlags, _SnapController_fetchFunction, _SnapController_idleTimeCheckInterval, _SnapController_maxIdleTime, _SnapController_encryptor, _SnapController_getMnemonic, _SnapController_getFeatureFlags, _SnapController_clientCryptography, _SnapController_detectSnapLocation, _SnapController_snapsRuntimeData, _SnapController_rollbackSnapshots, _SnapController_timeoutForLastRequestStatus, _SnapController_statusMachine, _SnapController_preinstalledSnaps, _SnapController_initializeStateMachine, _SnapController_registerMessageHandlers, _SnapController_handlePreinstalledSnaps, _SnapController_pollForLastRequestStatus, _SnapController_blockSnap, _SnapController_unblockSnap, _SnapController_assertIsInstallAllowed, _SnapController_assertCanInstallSnaps, _SnapController_assertCanUsePlatform, _SnapController_stopSnapsLastRequestPastMax, _SnapController_transition, _SnapController_terminateSnap, _SnapController_getSnapEncryptionKey, _SnapController_hasCachedEncryptionKey, _SnapController_decryptSnapState, _SnapController_encryptSnapState, _SnapController_getStateToPersist, _SnapController_persistSnapState, _SnapController_handleInitialConnections, _SnapController_addSnapToSubject, _SnapController_removeSnapFromSubjects, _SnapController_revokeAllSnapPermissions, _SnapController_createApproval, _SnapController_updateApproval, _SnapController_resolveAllowlistVersion, _SnapController_add, _SnapController_startSnap, _SnapController_getEndowments, _SnapController_set, _SnapController_validateSnapPermissions, _SnapController_validatePlatformVersion, _SnapController_getExecutionTimeout, _SnapController_getRpcRequestHandler, _SnapController_createInterface, _SnapController_assertInterfaceExists, _SnapController_transformSnapRpcRequestResult, _SnapController_assertSnapRpcRequestResult, _SnapController_recordSnapRpcRequestStart, _SnapController_recordSnapRpcRequestFinish, _SnapController_getRollbackSnapshot, _SnapController_createRollbackSnapshot, _SnapController_rollbackSnap, _SnapController_rollbackSnaps, _SnapController_getRuntime, _SnapController_getRuntimeExpect, _SnapController_setupRuntime, _SnapController_calculatePermissionsChange, _SnapController_isSubjectConnectedToSnap, _SnapController_calculateConnectionsChange, _SnapController_updatePermissions, _SnapController_isValidUpdate, _SnapController_callLifecycleHook, _SnapController_handleLock;
+var _SnapController_instances, _SnapController_closeAllConnections, _SnapController_dynamicPermissions, _SnapController_environmentEndowmentPermissions, _SnapController_excludedPermissions, _SnapController_featureFlags, _SnapController_fetchFunction, _SnapController_idleTimeCheckInterval, _SnapController_maxIdleTime, _SnapController_encryptor, _SnapController_getMnemonic, _SnapController_getFeatureFlags, _SnapController_clientCryptography, _SnapController_detectSnapLocation, _SnapController_snapsRuntimeData, _SnapController_rollbackSnapshots, _SnapController_timeoutForLastRequestStatus, _SnapController_statusMachine, _SnapController_preinstalledSnaps, _SnapController_initializeStateMachine, _SnapController_registerMessageHandlers, _SnapController_handlePreinstalledSnaps, _SnapController_pollForLastRequestStatus, _SnapController_blockSnap, _SnapController_unblockSnap, _SnapController_assertIsInstallAllowed, _SnapController_assertCanInstallSnaps, _SnapController_assertCanUsePlatform, _SnapController_stopSnapsLastRequestPastMax, _SnapController_transition, _SnapController_terminateSnap, _SnapController_getSnapEncryptionKey, _SnapController_hasCachedEncryptionKey, _SnapController_decryptSnapState, _SnapController_encryptSnapState, _SnapController_getStateToPersist, _SnapController_persistSnapState, _SnapController_handleInitialConnections, _SnapController_addSnapToSubject, _SnapController_removeSnapFromSubjects, _SnapController_revokeAllSnapPermissions, _SnapController_createApproval, _SnapController_updateApproval, _SnapController_resolveAllowlistVersion, _SnapController_add, _SnapController_startSnap, _SnapController_getEndowments, _SnapController_set, _SnapController_validateSnapPermissions, _SnapController_validatePlatformVersion, _SnapController_getExecutionTimeout, _SnapController_getRpcRequestHandler, _SnapController_createInterface, _SnapController_assertInterfaceExists, _SnapController_transformSnapRpcRequestResult, _SnapController_transformOnAssetsLookupResult, _SnapController_transformOnAssetsConversionResult, _SnapController_assertSnapRpcRequestResult, _SnapController_recordSnapRpcRequestStart, _SnapController_recordSnapRpcRequestFinish, _SnapController_getRollbackSnapshot, _SnapController_createRollbackSnapshot, _SnapController_rollbackSnap, _SnapController_rollbackSnaps, _SnapController_getRuntime, _SnapController_getRuntimeExpect, _SnapController_setupRuntime, _SnapController_calculatePermissionsChange, _SnapController_isSubjectConnectedToSnap, _SnapController_calculateConnectionsChange, _SnapController_updatePermissions, _SnapController_isValidUpdate, _SnapController_callLifecycleHook, _SnapController_handleLock;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SnapController = exports.SNAP_APPROVAL_RESULT = exports.SNAP_APPROVAL_UPDATE = exports.SNAP_APPROVAL_INSTALL = exports.controllerName = void 0;
 const base_controller_1 = require("@metamask/base-controller");
@@ -1723,7 +1723,7 @@ async function _SnapController_getEndowments(snapId) {
                 throw new Error(`${snapId} failed to respond to the request in time.`);
             }
             await __classPrivateFieldGet(this, _SnapController_instances, "m", _SnapController_assertSnapRpcRequestResult).call(this, snapId, handlerType, result);
-            const transformedResult = await __classPrivateFieldGet(this, _SnapController_instances, "m", _SnapController_transformSnapRpcRequestResult).call(this, snapId, handlerType, result);
+            const transformedResult = await __classPrivateFieldGet(this, _SnapController_instances, "m", _SnapController_transformSnapRpcRequestResult).call(this, snapId, handlerType, request, result);
             __classPrivateFieldGet(this, _SnapController_instances, "m", _SnapController_recordSnapRpcRequestFinish).call(this, snapId, request.id);
             return transformedResult;
         }
@@ -1759,10 +1759,11 @@ async function _SnapController_createInterface(snapId, content, contentType) {
  *
  * @param snapId - The snap ID of the snap that produced the result.
  * @param handlerType - The handler type that produced the result.
+ * @param request - The request that returned the result.
  * @param result - The result.
  * @returns The transformed result if applicable, otherwise the original result.
  */
-async function _SnapController_transformSnapRpcRequestResult(snapId, handlerType, result) {
+async function _SnapController_transformSnapRpcRequestResult(snapId, handlerType, request, result) {
     switch (handlerType) {
         case snaps_utils_1.HandlerType.OnTransaction:
         case snaps_utils_1.HandlerType.OnSignature:
@@ -1778,9 +1779,47 @@ async function _SnapController_transformSnapRpcRequestResult(snapId, handlerType
             }
             return result;
         }
+        case snaps_utils_1.HandlerType.OnAssetsLookup:
+            // We can cast since the request and result have already been validated.
+            return __classPrivateFieldGet(this, _SnapController_instances, "m", _SnapController_transformOnAssetsLookupResult).call(this, snapId, request, result);
+        case snaps_utils_1.HandlerType.OnAssetsConversion:
+            // We can cast since the request and result have already been validated.
+            return __classPrivateFieldGet(this, _SnapController_instances, "m", _SnapController_transformOnAssetsConversionResult).call(this, request, result);
         default:
             return result;
     }
+}, _SnapController_transformOnAssetsLookupResult = function _SnapController_transformOnAssetsLookupResult(snapId, { params: requestedParams }, { assets }) {
+    const permissions = this.messagingSystem.call('PermissionController:getPermissions', snapId);
+    // We know the permissions are guaranteed to be set here.
+    (0, utils_1.assert)(permissions);
+    const permission = permissions[snaps_rpc_methods_1.SnapEndowments.Assets];
+    const scopes = (0, snaps_rpc_methods_1.getChainIdsCaveat)(permission);
+    (0, utils_1.assert)(scopes);
+    const { assets: requestedAssets } = requestedParams;
+    const filteredAssets = Object.keys(assets).reduce((accumulator, assetType) => {
+        const castAssetType = assetType;
+        const isValid = scopes.some((scope) => castAssetType.startsWith(scope)) &&
+            requestedAssets.includes(castAssetType);
+        // Filter out unrequested assets and assets for scopes the Snap hasn't registered for.
+        if (isValid) {
+            accumulator[castAssetType] = assets[castAssetType];
+        }
+        return accumulator;
+    }, {});
+    return { assets: filteredAssets };
+}, _SnapController_transformOnAssetsConversionResult = function _SnapController_transformOnAssetsConversionResult({ params: requestedParams }, { conversionRates }) {
+    const { conversions: requestedConversions } = requestedParams;
+    const filteredConversionRates = requestedConversions.reduce((accumulator, conversion) => {
+        var _a;
+        const rate = conversionRates[conversion.from]?.[conversion.to];
+        // Only include rates that were actually requested.
+        if (rate) {
+            accumulator[_a = conversion.from] ?? (accumulator[_a] = {});
+            accumulator[conversion.from][conversion.to] = rate;
+        }
+        return accumulator;
+    }, {});
+    return { conversionRates: filteredConversionRates };
 }, _SnapController_assertSnapRpcRequestResult = 
 /**
  * Assert that the returned result of a Snap RPC call is the expected shape.
@@ -1822,6 +1861,12 @@ async function _SnapController_assertSnapRpcRequestResult(snapId, handlerType, r
         case snaps_utils_1.HandlerType.OnNameLookup:
             (0, utils_1.assertStruct)(result, snaps_utils_1.OnNameLookupResponseStruct);
             break;
+        case snaps_utils_1.HandlerType.OnAssetsLookup:
+            (0, utils_1.assertStruct)(result, snaps_sdk_1.OnAssetsLookupResponseStruct);
+            break;
+        case snaps_utils_1.HandlerType.OnAssetsConversion:
+            (0, utils_1.assertStruct)(result, snaps_sdk_1.OnAssetsConversionResponseStruct);
+            break;
         default:
             break;
     }