Merge pull request #170 from zerodevapp/feat/gas-fees-sponsorUserOper…

…ation feat: include maxFeePerGas and maxPriorityFeePerGas as part of sponsorUserOperation action response
pimlicolabs · Apr 17, 2024 · 698d42c · 698d42c
2 parents 4ade690 + ace8a11
commit 698d42c
Show file tree

Hide file tree

Showing 4 changed files with 56 additions and 37 deletions.
diff --git a/.changeset/serious-drinks-burn.md b/.changeset/serious-drinks-burn.md
@@ -0,0 +1,5 @@
+---
+"permissionless": patch
+---
+
+Changed sponsorUserOperation action return type to include maxFeePerGas and maxPriorityFeePerGas if returned by paymaster and return it as part of userOperation from prepareUserOperationRequest action
diff --git a/packages/permissionless/actions/smartAccount.ts b/packages/permissionless/actions/smartAccount.ts
@@ -7,6 +7,7 @@ import {
     type Middleware,
     type PrepareUserOperationRequestParameters,
     type PrepareUserOperationRequestReturnType,
+    type SponsorUserOperationReturnType,
     prepareUserOperationRequest
 } from "./smartAccount/prepareUserOperationRequest"
 
@@ -40,6 +41,7 @@ export {
     prepareUserOperationRequest,
     type PrepareUserOperationRequestParameters,
     type PrepareUserOperationRequestReturnType,
+    type SponsorUserOperationReturnType,
     sendTransaction,
     sendUserOperation,
     type SendUserOperationParameters,

diff --git a/packages/permissionless/actions/smartAccount/prepareUserOperationRequest.ts b/packages/permissionless/actions/smartAccount/prepareUserOperationRequest.ts
@@ -2,6 +2,7 @@ import type { Chain, Client, Transport } from "viem"
 import { estimateFeesPerGas } from "viem/actions"
 import { getAction } from "viem/utils"
 import type { SmartAccount } from "../../accounts/types"
+import type { PartialPick } from "../../types"
 import type {
     GetAccountParameter,
     PartialBy,
@@ -19,6 +20,38 @@ import { AccountOrClientNotFoundError, parseAccount } from "../../utils/"
 import { getEntryPointVersion } from "../../utils/getEntryPointVersion"
 import { estimateUserOperationGas } from "../bundler/estimateUserOperationGas"
 
+export type SponsorUserOperationReturnType<entryPoint extends EntryPoint> =
+    entryPoint extends ENTRYPOINT_ADDRESS_V06_TYPE
+        ? Prettify<
+              Pick<
+                  UserOperation<"v0.6">,
+                  | "callGasLimit"
+                  | "verificationGasLimit"
+                  | "preVerificationGas"
+                  | "paymasterAndData"
+              > &
+                  PartialPick<
+                      UserOperation<"v0.6">,
+                      "maxFeePerGas" | "maxPriorityFeePerGas"
+                  >
+          >
+        : Prettify<
+              Pick<
+                  UserOperation<"v0.7">,
+                  | "callGasLimit"
+                  | "verificationGasLimit"
+                  | "preVerificationGas"
+                  | "paymaster"
+                  | "paymasterVerificationGasLimit"
+                  | "paymasterPostOpGasLimit"
+                  | "paymasterData"
+              > &
+                  PartialPick<
+                      UserOperation<"v0.7">,
+                      "maxFeePerGas" | "maxPriorityFeePerGas"
+                  >
+          >
+
 export type Middleware<entryPoint extends EntryPoint> = {
     middleware?:
         | ((args: {
@@ -33,26 +66,7 @@ export type Middleware<entryPoint extends EntryPoint> = {
               sponsorUserOperation?: (args: {
                   userOperation: UserOperation<GetEntryPointVersion<entryPoint>>
                   entryPoint: entryPoint
-              }) => Promise<
-                  entryPoint extends ENTRYPOINT_ADDRESS_V06_TYPE
-                      ? Pick<
-                              UserOperation<"v0.6">,
-                              | "callGasLimit"
-                              | "verificationGasLimit"
-                              | "preVerificationGas"
-                              | "paymasterAndData"
-                          >
-                      : Pick<
-                              UserOperation<"v0.7">,
-                              | "callGasLimit"
-                              | "verificationGasLimit"
-                              | "preVerificationGas"
-                              | "paymaster"
-                              | "paymasterVerificationGasLimit"
-                              | "paymasterPostOpGasLimit"
-                              | "paymasterData"
-                          >
-              >
+              }) => Promise<SponsorUserOperationReturnType<entryPoint>>
           }
 }
 
@@ -188,13 +202,7 @@ async function prepareUserOperationRequestForEntryPointV06<
                 userOperation: UserOperation<GetEntryPointVersion<entryPoint>>
                 entryPoint: entryPoint
             }
-        )) as Pick<
-            UserOperation<"v0.6">,
-            | "callGasLimit"
-            | "verificationGasLimit"
-            | "preVerificationGas"
-            | "paymasterAndData"
-        >
+        )) as SponsorUserOperationReturnType<ENTRYPOINT_ADDRESS_V06_TYPE>
 
         userOperation.callGasLimit = sponsorUserOperationData.callGasLimit
         userOperation.verificationGasLimit =
@@ -203,6 +211,11 @@ async function prepareUserOperationRequestForEntryPointV06<
             sponsorUserOperationData.preVerificationGas
         userOperation.paymasterAndData =
             sponsorUserOperationData.paymasterAndData
+        userOperation.maxFeePerGas =
+            sponsorUserOperationData.maxFeePerGas || userOperation.maxFeePerGas
+        userOperation.maxPriorityFeePerGas =
+            sponsorUserOperationData.maxPriorityFeePerGas ||
+            userOperation.maxPriorityFeePerGas
         return userOperation as PrepareUserOperationRequestReturnType<entryPoint>
     }
 
@@ -338,16 +351,8 @@ async function prepareUserOperationRequestEntryPointV07<
                 userOperation: UserOperation<GetEntryPointVersion<entryPoint>>
                 entryPoint: entryPoint
             }
-        )) as Pick<
-            UserOperation<"v0.7">,
-            | "callGasLimit"
-            | "verificationGasLimit"
-            | "preVerificationGas"
-            | "paymaster"
-            | "paymasterVerificationGasLimit"
-            | "paymasterPostOpGasLimit"
-            | "paymasterData"
-        >
+        )) as SponsorUserOperationReturnType<ENTRYPOINT_ADDRESS_V07_TYPE>
+
         userOperation.callGasLimit = sponsorUserOperationData.callGasLimit
         userOperation.verificationGasLimit =
             sponsorUserOperationData.verificationGasLimit
@@ -359,6 +364,11 @@ async function prepareUserOperationRequestEntryPointV07<
         userOperation.paymasterPostOpGasLimit =
             sponsorUserOperationData.paymasterPostOpGasLimit
         userOperation.paymasterData = sponsorUserOperationData.paymasterData
+        userOperation.maxFeePerGas =
+            sponsorUserOperationData.maxFeePerGas || userOperation.maxFeePerGas
+        userOperation.maxPriorityFeePerGas =
+            sponsorUserOperationData.maxPriorityFeePerGas ||
+            userOperation.maxPriorityFeePerGas
 
         return userOperation as PrepareUserOperationRequestReturnType<entryPoint>
     }

diff --git a/packages/permissionless/types/index.ts b/packages/permissionless/types/index.ts
@@ -37,6 +37,8 @@ export type Prettify<T> = {
 
 export type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>
 
+export type PartialPick<T, K extends keyof T> = Partial<Pick<T, K>>
+
 // biome-ignore lint/suspicious/noExplicitAny: generic type
 export type UnionOmit<T, K extends keyof any> = T extends any
     ? Omit<T, K>