Merge remote-tracking branch 'origin/main' into bump-dependencies-13-03-2024

Author: montelaidev

packages/user-operation-controller/src/UserOperationController.test.ts

@@ -826,6 +826,42 @@ describe('UserOperationController', () => {
       expect(prepareMock).toHaveBeenCalledTimes(1);
     });
 
+    it('uses gas limits suggested by smart contract account during #addPaymasterData', async () => {
+      const controller = new UserOperationController(optionsMock);
+      const UPDATE_USER_OPERATION_WITH_GAS_LIMITS_RESPONSE_MOCK: UpdateUserOperationResponse =
+        {
+          paymasterAndData: '0xA',
+          callGasLimit: '0x123',
+          preVerificationGas: '0x456',
+          verificationGasLimit: '0x789',
+        };
+      smartContractAccount.updateUserOperation.mockResolvedValue(
+        UPDATE_USER_OPERATION_WITH_GAS_LIMITS_RESPONSE_MOCK,
+      );
+      const { id, hash } = await addUserOperation(
+        controller,
+        ADD_USER_OPERATION_REQUEST_MOCK,
+        { ...ADD_USER_OPERATION_OPTIONS_MOCK, smartContractAccount },
+      );
+
+      await hash();
+
+      expect(Object.keys(controller.state.userOperations)).toHaveLength(1);
+      expect(
+        controller.state.userOperations[id].userOperation.callGasLimit,
+      ).toBe(UPDATE_USER_OPERATION_WITH_GAS_LIMITS_RESPONSE_MOCK.callGasLimit);
+      expect(
+        controller.state.userOperations[id].userOperation.verificationGasLimit,
+      ).toBe(
+        UPDATE_USER_OPERATION_WITH_GAS_LIMITS_RESPONSE_MOCK.verificationGasLimit,
+      );
+      expect(
+        controller.state.userOperations[id].userOperation.preVerificationGas,
+      ).toBe(
+        UPDATE_USER_OPERATION_WITH_GAS_LIMITS_RESPONSE_MOCK.preVerificationGas,
+      );
+    });
+
     describe('if approval request resolved with updated transaction', () => {
       it('updates gas fees without regeneration if paymaster data not set', async () => {
         const controller = new UserOperationController(optionsMock);

packages/user-operation-controller/src/UserOperationController.ts

@@ -538,6 +538,15 @@ export class UserOperationController extends BaseController<
     validateUpdateUserOperationResponse(response);
 
     userOperation.paymasterAndData = response.paymasterAndData ?? EMPTY_BYTES;
+    if (response.callGasLimit) {
+      userOperation.callGasLimit = response.callGasLimit;
+    }
+    if (response.preVerificationGas) {
+      userOperation.preVerificationGas = response.preVerificationGas;
+    }
+    if (response.verificationGasLimit) {
+      userOperation.verificationGasLimit = response.verificationGasLimit;
+    }
 
     this.#updateMetadata(metadata);
   }

packages/user-operation-controller/src/helpers/SnapSmartContractAccount.test.ts

@@ -62,6 +62,9 @@ const PATCH_USER_OPERATION_RESPONSE_MOCK: Awaited<
   ReturnType<KeyringController['patchUserOperation']>
 > = {
   paymasterAndData: '0x123',
+  callGasLimit: '0x444',
+  verificationGasLimit: '0x555',
+  preVerificationGas: '0x667',
 };
 
 const SIGN_USER_OPERATION_RESPONSE_MOCK: Awaited<
@@ -235,6 +238,11 @@ describe('SnapSmartContractAccount', () => {
 
       expect(response).toStrictEqual<UpdateUserOperationResponse>({
         paymasterAndData: PATCH_USER_OPERATION_RESPONSE_MOCK.paymasterAndData,
+        callGasLimit: PATCH_USER_OPERATION_RESPONSE_MOCK.callGasLimit,
+        preVerificationGas:
+          PATCH_USER_OPERATION_RESPONSE_MOCK.preVerificationGas,
+        verificationGasLimit:
+          PATCH_USER_OPERATION_RESPONSE_MOCK.verificationGasLimit,
       });
 
       expect(patchMock).toHaveBeenCalledTimes(1);
@@ -260,6 +268,9 @@ describe('SnapSmartContractAccount', () => {
 
       expect(response).toStrictEqual<UpdateUserOperationResponse>({
         paymasterAndData: undefined,
+        callGasLimit: undefined,
+        preVerificationGas: undefined,
+        verificationGasLimit: undefined,
       });
     });
   });

packages/user-operation-controller/src/helpers/SnapSmartContractAccount.ts

@@ -65,18 +65,22 @@ export class SnapSmartContractAccount implements SmartContractAccount {
   async updateUserOperation(
     request: UpdateUserOperationRequest,
   ): Promise<UpdateUserOperationResponse> {
-    const { userOperation } = request;
+    const { userOperation, chainId } = request;
     const { sender } = userOperation;
 
-    const { paymasterAndData: responsePaymasterAndData } =
-      await this.#messenger.call(
-        'KeyringController:patchUserOperation',
-        sender,
-        userOperation,
-        {
-          chainId: request.chainId,
-        },
-      );
+    const {
+      paymasterAndData: responsePaymasterAndData,
+      verificationGasLimit,
+      preVerificationGas,
+      callGasLimit,
+    } = await this.#messenger.call(
+      'KeyringController:patchUserOperation',
+      sender,
+      userOperation,
+      {
+        chainId,
+      },
+    );
 
     const paymasterAndData =
       responsePaymasterAndData === EMPTY_BYTES
@@ -85,6 +89,9 @@ export class SnapSmartContractAccount implements SmartContractAccount {
 
     return {
       paymasterAndData,
+      verificationGasLimit,
+      preVerificationGas,
+      callGasLimit,
     };
   }
 

packages/user-operation-controller/src/types.ts

@@ -256,6 +256,15 @@ export type UpdateUserOperationResponse = {
    * Not required if a paymaster is not sponsoring the transaction.
    */
   paymasterAndData?: string;
+
+  /**
+   * The final gas limits for the user operation suggested by the smart contract account.
+   * The simulated gas limits may be different after the bundler estimates gas with the use
+   * of the paymaster.
+   */
+  callGasLimit?: string;
+  preVerificationGas?: string;
+  verificationGasLimit?: string;
 };
 
 /**

packages/user-operation-controller/src/utils/validation.test.ts

@@ -432,7 +432,25 @@ describe('validation', () => {
         'paymasterAndData',
         'wrong type',
         123,
-        'Expected a value of type `Hexadecimal String`, but received: `123`',
+        'Expected a value of type `Hexadecimal String or 0x`, but received: `123`',
+      ],
+      [
+        'callGasLimit',
+        'wrong type',
+        123,
+        'Expected a value of type `Hexadecimal String or 0x`, but received: `123`',
+      ],
+      [
+        'preVerificationGas',
+        'wrong type',
+        123,
+        'Expected a value of type `Hexadecimal String or 0x`, but received: `123`',
+      ],
+      [
+        'verificationGasLimit',
+        'wrong type',
+        123,
+        'Expected a value of type `Hexadecimal String or 0x`, but received: `123`',
       ],
     ])(
       'throws if %s is %s',

packages/user-operation-controller/src/utils/validation.ts

@@ -135,11 +135,12 @@ export function validatePrepareUserOperationResponse(
 export function validateUpdateUserOperationResponse(
   response: UpdateUserOperationResponse,
 ) {
-  const HexOrEmptyBytes = defineHex();
-
   const ValidResponse = optional(
     object({
-      paymasterAndData: optional(HexOrEmptyBytes),
+      paymasterAndData: optional(defineHexOrEmptyBytes()),
+      callGasLimit: optional(defineHexOrEmptyBytes()),
+      preVerificationGas: optional(defineHexOrEmptyBytes()),
+      verificationGasLimit: optional(defineHexOrEmptyBytes()),
     }),
   );