Fix issue where accountMeta was not being included on the response object correctly. (#95)

* Fix issue where accountMeta was not being included on the response object correctly. Fix test that was asserting that the accountMeta was incorrectly included on the response object.

* Improve accountMeta
- accountMeta is now a required field in the response
- simplified resolving accountMeta in the orchestrator
- added resolving environment to existing Promise.all statement to reduce latency
- remove errant console.log from dapp

Author: jeffsmale90

packages/gator-permissions-snap/snap.manifest.json

@@ -7,7 +7,7 @@
     "url": "https://github.com/MetaMask/snap-7715-permissions.git"
   },
   "source": {
-    "shasum": "D1xZgkqOmv2yug3z6/YsbDkUWAzgxWujvWgz+W5bWH8=",
+    "shasum": "B/45l1lyLyqYX2GkYxvKAmCCWOCSu030Do+IEMdQV+c=",
     "location": {
       "npm": {
         "filePath": "dist/bundle.js",

packages/gator-permissions-snap/src/core/permissionRequestLifecycleOrchestrator.ts

@@ -1,4 +1,5 @@
 import type {
+  AccountMeta,
   PermissionRequest,
   PermissionResponse,
 } from '@metamask/7715-permissions-shared/types';
@@ -203,21 +204,21 @@ export class PermissionRequestLifecycleOrchestrator {
       isAdjustmentAllowed,
     };
 
-    const [address, accountMeta, delegationManager] = await Promise.all([
-      this.#accountController.getAccountAddress({
-        chainId,
-      }),
-      this.#accountController.getAccountMetadata({
-        chainId,
-      }),
-      this.#accountController.getDelegationManager({
-        chainId,
-      }),
-    ]);
-
-    const environment = await this.#accountController.getEnvironment({
-      chainId,
-    });
+    const [environment, address, accountMetadata, delegationManager] =
+      await Promise.all([
+        this.#accountController.getEnvironment({
+          chainId,
+        }),
+        this.#accountController.getAccountAddress({
+          chainId,
+        }),
+        this.#accountController.getAccountMetadata({
+          chainId,
+        }),
+        this.#accountController.getDelegationManager({
+          chainId,
+        }),
+      ]);
 
     const caveatBuilder = await lifecycleHandlers.appendCaveats({
       permission: populatedPermission,
@@ -241,23 +242,25 @@ export class PermissionRequestLifecycleOrchestrator {
         caveats: finalCaveatBuilder,
       }),
     });
-    const permissionsContext = encodeDelegation([signedDelegation]);
 
-    // we do this because we cannot have undefined properties set on the response
-    const accountMetaObject =
-      accountMeta.factory && accountMeta.factoryData
-        ? {
-            factory: accountMeta.factory,
-            factoryData: accountMeta.factoryData,
-          }
-        : {};
+    const context = encodeDelegation([signedDelegation]);
+
+    const accountMeta: AccountMeta[] =
+      accountMetadata.factory && accountMetadata.factoryData
+        ? [
+            {
+              factory: accountMetadata.factory,
+              factoryData: accountMetadata.factoryData,
+            },
+          ]
+        : [];
 
     const response: PermissionResponse = {
       ...grantedPermissionRequest,
       chainId: toHex(chainId),
       address,
-      context: permissionsContext,
-      ...accountMetaObject,
+      accountMeta,
+      context,
       signerMeta: {
         delegationManager,
       },

packages/gator-permissions-snap/test/core/permissionRequestLifecycleOrchestrator.test.ts

@@ -173,7 +173,7 @@ describe('PermissionRequestLifecycleOrchestrator', () => {
         expect(result.approved).toBe(true);
         expect(result.approved && result.response).toStrictEqual({
           ...mockPermissionRequest,
-          ...mockAccountMetadata,
+          accountMeta: [mockAccountMetadata],
           permission: mockPopulatedPermission,
           address: grantingAccountAddress,
           context: expect.stringMatching(/^0x[0-9a-fA-F]+$/u),

packages/gator-permissions-snap/test/rpc/rpcHandler.test.ts

@@ -48,6 +48,7 @@ const VALID_PERMISSION_RESPONSE: PermissionResponse = {
     data: { justification: 'Testing permission request' },
   },
   context: TEST_CONTEXT,
+  accountMeta: [],
   signerMeta: {
     delegationManager: TEST_ADDRESS,
   },

packages/permissions-kernel-snap/snap.manifest.json

@@ -7,7 +7,7 @@
     "url": "https://github.com/MetaMask/snap-7715-permissions.git"
   },
   "source": {
-    "shasum": "fgjg6Gg3LrnSgdKeWo8X3v3vg3fK4lDl728FzSySqPU=",
+    "shasum": "VvmzRf0CQohjyCGxQipja9d4Ghoq1q9w5kAJryTTw/8=",
     "location": {
       "npm": {
         "filePath": "dist/bundle.js",

packages/shared/src/types/7715-permissions-response.ts

@@ -18,11 +18,13 @@ export const zGrantedPermission = z.object({
   context: zHexStr,
 
   /**
-   * Optional but when present then fields for factory and factoryData are required as defined in ERC-4337.
-   * They are either both specified, or none.
-   * DApp MUST deploy the accounts by calling the factory contract with factoryData as the calldata.
+   * The accountMeta field is required and contains information needed to deploy accounts.
+   * Each entry specifies a factory contract and its associated deployment data.
+   * If no account deployment is needed when redeeming the permission, this array must be empty.
+   * When non-empty, DApps MUST deploy the accounts by calling the factory contract with factoryData as the calldata.
+   * Defined in ERC-4337.
    */
-  accountMeta: z.array(zAccountMeta).optional(),
+  accountMeta: z.array(zAccountMeta),
 
   /**
    * Account to assign the permissions to and is dependent on the account type.