Chain ID -> Scope

Author: FrederikBolding

packages/snaps-controllers/src/multichain/MultichainRoutingController.test.ts

@@ -51,7 +51,7 @@ describe('MultichainRoutingController', () => {
       'MultichainRoutingController:handleRequest',
       {
         connectedAddresses: BTC_CONNECTED_ACCOUNTS,
-        chainId: BTC_CAIP2,
+        scope: BTC_CAIP2,
         request: {
           method: 'btc_sendmany',
           params: {
@@ -104,7 +104,7 @@ describe('MultichainRoutingController', () => {
       'MultichainRoutingController:handleRequest',
       {
         connectedAddresses: SOLANA_CONNECTED_ACCOUNTS,
-        chainId: SOLANA_CAIP2,
+        scope: SOLANA_CAIP2,
         request: {
           method: 'signAndSendTransaction',
           params: {
@@ -154,7 +154,7 @@ describe('MultichainRoutingController', () => {
       'MultichainRoutingController:handleRequest',
       {
         connectedAddresses: [],
-        chainId: SOLANA_CAIP2,
+        scope: SOLANA_CAIP2,
         request: {
           method: 'getVersion',
         },
@@ -190,7 +190,7 @@ describe('MultichainRoutingController', () => {
     await expect(
       messenger.call('MultichainRoutingController:handleRequest', {
         connectedAddresses: [],
-        chainId: SOLANA_CAIP2,
+        scope: SOLANA_CAIP2,
         request: {
           method: 'getVersion',
         },

packages/snaps-controllers/src/multichain/MultichainRoutingController.ts

@@ -7,7 +7,7 @@ import { BaseController } from '@metamask/base-controller';
 import type { GetPermissions } from '@metamask/permission-controller';
 import { rpcErrors } from '@metamask/rpc-errors';
 import {
-  getProtocolCaveatChains,
+  getProtocolCaveatScopes,
   SnapEndowments,
 } from '@metamask/snaps-rpc-methods';
 import type {
@@ -136,7 +136,7 @@ export class MultichainRoutingController extends BaseController<
 
   async #resolveRequestAddress(
     snapId: SnapId,
-    chainId: CaipChainId,
+    scope: CaipChainId,
     request: JsonRpcRequest,
   ) {
     try {
@@ -148,7 +148,7 @@ export class MultichainRoutingController extends BaseController<
           request: {
             method: '',
             params: {
-              chainId,
+              scope,
               request,
             },
           },
@@ -164,11 +164,11 @@ export class MultichainRoutingController extends BaseController<
 
   async #getAccountSnap(
     connectedAddresses: CaipAccountId[],
-    chainId: CaipChainId,
+    scope: CaipChainId,
     request: JsonRpcRequest,
   ) {
     const accounts = this.messagingSystem
-      .call('AccountsController:listMultichainAccounts', chainId)
+      .call('AccountsController:listMultichainAccounts', scope)
       .filter(
         (account: InternalAccount) =>
           account.metadata.snap?.enabled &&
@@ -187,7 +187,7 @@ export class MultichainRoutingController extends BaseController<
     // Attempt to resolve the address that should be used for signing.
     const address = await this.#resolveRequestAddress(
       resolutionSnapId,
-      chainId,
+      scope,
       request,
     );
 
@@ -214,7 +214,7 @@ export class MultichainRoutingController extends BaseController<
     };
   }
 
-  #getProtocolSnaps(chainId: CaipChainId) {
+  #getProtocolSnaps(scope: CaipChainId) {
     const allSnaps = this.messagingSystem.call('SnapController:getAll');
     const filteredSnaps = getRunnableSnaps(allSnaps);
 
@@ -225,11 +225,11 @@ export class MultichainRoutingController extends BaseController<
       );
       if (permissions && hasProperty(permissions, SnapEndowments.Protocol)) {
         const permission = permissions[SnapEndowments.Protocol];
-        const chains = getProtocolCaveatChains(permission);
-        if (chains && hasProperty(chains, chainId)) {
+        const scopes = getProtocolCaveatScopes(permission);
+        if (scopes && hasProperty(scopes, scope)) {
           accumulator.push({
             snapId: snap.id,
-            methods: chains[chainId].methods,
+            methods: scopes[scope].methods,
           });
         }
       }
@@ -240,12 +240,12 @@ export class MultichainRoutingController extends BaseController<
 
   async handleRequest({
     connectedAddresses,
-    chainId,
+    scope,
     request,
   }: {
     connectedAddresses: CaipAccountId[];
     origin: string;
-    chainId: CaipChainId;
+    scope: CaipChainId;
     request: JsonRpcRequest;
   }): Promise<unknown> {
     // TODO: Determine if the request is already validated here?
@@ -254,7 +254,7 @@ export class MultichainRoutingController extends BaseController<
     // If the RPC request can be serviced by an account Snap, route it there.
     const accountSnap = await this.#getAccountSnap(
       connectedAddresses,
-      chainId,
+      scope,
       request,
     );
     if (accountSnap) {
@@ -263,13 +263,13 @@ export class MultichainRoutingController extends BaseController<
         address: accountSnap.address,
         method,
         params,
-        chainId,
+        chainId: scope,
       });
     }
 
     // If the RPC request cannot be serviced by an account Snap,
     // but has a protocol Snap available, route it there.
-    const protocolSnaps = this.#getProtocolSnaps(chainId);
+    const protocolSnaps = this.#getProtocolSnaps(scope);
     const protocolSnap = protocolSnaps.find((snap) =>
       snap.methods.includes(method),
     );
@@ -281,7 +281,7 @@ export class MultichainRoutingController extends BaseController<
           method: '',
           params: {
             request,
-            chainId,
+            scope,
           },
         },
         handler: HandlerType.OnProtocolRequest,

packages/snaps-controllers/src/test-utils/multichain.ts

@@ -77,7 +77,7 @@ export const MOCK_SOLANA_SNAP_PERMISSIONS: Record<
   [SnapEndowments.Protocol]: {
     caveats: [
       {
-        type: SnapCaveatType.ProtocolSnapChains,
+        type: SnapCaveatType.ProtocolSnapScopes,
         value: { [SOLANA_CAIP2]: { methods: ['getVersion'] } },
       },
     ],

packages/snaps-rpc-methods/src/endowments/index.ts

@@ -128,4 +128,4 @@ export { getChainIdsCaveat, getLookupMatchersCaveat } from './name-lookup';
 export { getKeyringCaveatOrigins } from './keyring';
 export { getMaxRequestTimeCaveat } from './caveats';
 export { getCronjobCaveatJobs } from './cronjob';
-export { getProtocolCaveatChains } from './protocol';
+export { getProtocolCaveatScopes } from './protocol';

packages/snaps-rpc-methods/src/endowments/protocol.ts

@@ -10,7 +10,7 @@ import type {
 } from '@metamask/permission-controller';
 import { PermissionType, SubjectType } from '@metamask/permission-controller';
 import { rpcErrors } from '@metamask/rpc-errors';
-import { ProtocolChainsStruct, SnapCaveatType } from '@metamask/snaps-utils';
+import { ProtocolScopesStruct, SnapCaveatType } from '@metamask/snaps-utils';
 import type { Infer } from '@metamask/superstruct';
 import type { Json, NonEmptyArray } from '@metamask/utils';
 import {
@@ -52,7 +52,7 @@ const specificationBuilder: PermissionSpecificationBuilder<
     allowedCaveats: [SnapCaveatType.ChainIds, SnapCaveatType.MaxRequestTime],
     endowmentGetter: (_getterOptions?: EndowmentGetterParams) => null,
     validator: createGenericPermissionValidator([
-      { type: SnapCaveatType.ProtocolSnapChains },
+      { type: SnapCaveatType.ProtocolSnapScopes },
       { type: SnapCaveatType.MaxRequestTime, optional: true },
     ]),
     subjectTypes: [SubjectType.Snap],
@@ -83,29 +83,29 @@ export function getProtocolCaveatMapper(
 
   if (value.chains) {
     caveats.push({
-      type: SnapCaveatType.ProtocolSnapChains,
+      type: SnapCaveatType.ProtocolSnapScopes,
       value: value.chains,
     });
   }
 
   return { caveats: caveats as NonEmptyArray<CaveatConstraint> };
 }
 
-export type ProtocolChains = Infer<typeof ProtocolChainsStruct>;
+export type ProtocolScopes = Infer<typeof ProtocolScopesStruct>;
 
 /**
- * Getter function to get the {@link ProtocolSnapChains} caveat value from a
+ * Getter function to get the {@link ProtocolSnapScopes} caveat value from a
  * permission.
  *
  * @param permission - The permission to get the caveat value from.
  * @returns The caveat value.
  */
-export function getProtocolCaveatChains(
+export function getProtocolCaveatScopes(
   permission?: PermissionConstraint,
-): ProtocolChains | null {
+): ProtocolScopes | null {
   const caveat = permission?.caveats?.find(
-    (permCaveat) => permCaveat.type === SnapCaveatType.ProtocolSnapChains,
-  ) as Caveat<string, ProtocolChains> | undefined;
+    (permCaveat) => permCaveat.type === SnapCaveatType.ProtocolSnapScopes,
+  ) as Caveat<string, ProtocolScopes> | undefined;
 
   return caveat ? caveat.value : null;
 }
@@ -126,18 +126,18 @@ function validateCaveat(caveat: Caveat<string, any>): void {
   const { value } = caveat;
   assertStruct(
     value,
-    ProtocolChainsStruct,
+    ProtocolScopesStruct,
     'Invalid chains specified',
     rpcErrors.invalidParams,
   );
 }
 
 export const protocolCaveatSpecifications: Record<
-  SnapCaveatType.ProtocolSnapChains,
+  SnapCaveatType.ProtocolSnapScopes,
   CaveatSpecificationConstraint
 > = {
-  [SnapCaveatType.ProtocolSnapChains]: Object.freeze({
-    type: SnapCaveatType.ProtocolSnapChains,
+  [SnapCaveatType.ProtocolSnapScopes]: Object.freeze({
+    type: SnapCaveatType.ProtocolSnapScopes,
     validator: (caveat: Caveat<string, any>) => validateCaveat(caveat),
   }),
 };

packages/snaps-sdk/src/types/handlers/protocol.ts

@@ -14,7 +14,7 @@ import type {
  * @param args - The request arguments.
  * @param args.origin - The origin of the request. This can be the ID of another
  * Snap, or the URL of a website.
- * @param args.chainId - The chain ID of the request.
+ * @param args.scope - The scope of the request.
  * @param args.request - The protocol request sent to the Snap. This includes
  * the method name and parameters.
  * @returns The response to the protocol request. This must be a
@@ -25,6 +25,6 @@ export type OnProtocolRequestHandler<
   Params extends JsonRpcParams = JsonRpcParams,
 > = (args: {
   origin: string;
-  chainId: CaipChainId;
+  scope: CaipChainId;
   request: JsonRpcRequest<Params>;
 }) => Promise<Json>;

packages/snaps-utils/src/caveats.ts

@@ -55,7 +55,7 @@ export enum SnapCaveatType {
   MaxRequestTime = 'maxRequestTime',
 
   /**
-   * Caveat specifying a list of RPC methods serviced by an endowment.
+   * Caveat specifying a list of scopes serviced by an endowment.
    */
-  ProtocolSnapChains = 'protocolSnapChains',
+  ProtocolSnapScopes = 'protocolSnapScopes',
 }

packages/snaps-utils/src/manifest/validation.ts

@@ -175,7 +175,7 @@ export const MaxRequestTimeStruct = size(
   MAXIMUM_REQUEST_TIMEOUT,
 );
 
-export const ProtocolChainsStruct = record(
+export const ProtocolScopesStruct = record(
   CaipChainIdStruct,
   object({ methods: array(string()) }),
 );
@@ -207,7 +207,7 @@ export const PermissionsStruct: Describe<InitialPermissions> = type({
   'endowment:protocol': optional(
     mergeStructs(
       HandlerCaveatsStruct,
-      object({ chains: ProtocolChainsStruct }),
+      object({ chains: ProtocolScopesStruct }),
     ),
   ),
   'endowment:lifecycle-hooks': optional(HandlerCaveatsStruct),