permissionless 0.0.35 → 0.1.0

package/errors/estimateUserOperationGas.ts

@@ -1,12 +1,15 @@
 import { BaseError } from "viem"
 import type { EstimateUserOperationGasParameters } from "../actions/bundler/estimateUserOperationGas"
+import type { EntryPoint } from "../types/entrypoint"
 import { prettyPrint } from "./utils"
 
-export type EstimateUserOperationGasErrorType =
-    EstimateUserOperationGasError & {
+export type EstimateUserOperationGasErrorType<entryPoint extends EntryPoint> =
+    EstimateUserOperationGasError<entryPoint> & {
         name: "EstimateUserOperationGasError"
     }
-export class EstimateUserOperationGasError extends BaseError {
+export class EstimateUserOperationGasError<
+    entryPoint extends EntryPoint
+> extends BaseError {
     override cause: BaseError
 
     override name = "EstimateUserOperationGasError"
@@ -17,7 +20,7 @@ export class EstimateUserOperationGasError extends BaseError {
             userOperation,
             entryPoint,
             docsPath
-        }: EstimateUserOperationGasParameters & {
+        }: EstimateUserOperationGasParameters<entryPoint> & {
             docsPath?: string
         }
     ) {

package/errors/sendUserOperation.ts

@@ -1,11 +1,15 @@
 import { BaseError } from "viem"
 import { type SendUserOperationParameters } from "../actions/bundler/sendUserOperation"
+import type { EntryPoint } from "../types/entrypoint"
 import { prettyPrint } from "./utils"
 
-export type SendUserOperationErrorType = SendUserOperationError & {
-    name: "SendUserOperationError"
-}
-export class SendUserOperationError extends BaseError {
+export type SendUserOperationErrorType<entryPoint extends EntryPoint> =
+    SendUserOperationError<entryPoint> & {
+        name: "SendUserOperationError"
+    }
+export class SendUserOperationError<
+    entryPoint extends EntryPoint
+> extends BaseError {
     override cause: BaseError
 
     override name = "SendUserOperationError"
@@ -16,7 +20,7 @@ export class SendUserOperationError extends BaseError {
             userOperation,
             entryPoint,
             docsPath
-        }: SendUserOperationParameters & {
+        }: SendUserOperationParameters<entryPoint> & {
             docsPath?: string
         }
     ) {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "permissionless",
-    "version": "0.0.35",
+    "version": "0.1.0",
     "author": "Pimlico",
     "homepage": "https://docs.pimlico.io/permissionless",
     "repository": "github:pimlicolabs/permissionless.js",

package/types/bundler.ts

@@ -1,43 +1,53 @@
 import type { Address, Hash, Hex } from "viem"
 import type { PartialBy } from "viem/types/utils"
+import type { EntryPoint, GetEntryPointVersion } from "./entrypoint"
 import type { UserOperationWithBigIntAsHex } from "./userOperation"
 
-export type BundlerRpcSchema = [
+export type BundlerRpcSchema<entryPoint extends EntryPoint> = [
     {
         Method: "eth_sendUserOperation"
         Parameters: [
-            userOperation: UserOperationWithBigIntAsHex,
-            entryPoint: Address
+            userOperation: UserOperationWithBigIntAsHex<
+                GetEntryPointVersion<entryPoint>
+            >,
+            entryPoint: entryPoint
         ]
         ReturnType: Hash
     },
     {
         Method: "eth_estimateUserOperationGas"
         Parameters: [
-            userOperation: PartialBy<
-                UserOperationWithBigIntAsHex,
-                "callGasLimit" | "preVerificationGas" | "verificationGasLimit"
-            >,
-            entryPoint: Address,
-            stateOverrides?: {
-                [x: string]: {
-                    balance?: Hex
-                    nonce?: Hex
-                    code?: Hex
-                    state?: {
-                        [x: Hex]: Hex
-                    }
-                    stateDiff?: {
-                        [x: Hex]: Hex
-                    }
-                }
-            }
+            userOperation: GetEntryPointVersion<entryPoint> extends "v0.6"
+                ? PartialBy<
+                      UserOperationWithBigIntAsHex<"v0.6">,
+                      | "callGasLimit"
+                      | "preVerificationGas"
+                      | "verificationGasLimit"
+                  >
+                : PartialBy<
+                      UserOperationWithBigIntAsHex<"v0.7">,
+                      | "callGasLimit"
+                      | "preVerificationGas"
+                      | "verificationGasLimit"
+                      | "paymasterVerificationGasLimit"
+                      | "paymasterPostOpGasLimit"
+                  >,
+            entryPoint: entryPoint,
+            stateOverrides?: StateOverrides
         ]
-        ReturnType: {
-            preVerificationGas: Hex
-            verificationGasLimit: Hex
-            callGasLimit: Hex
-        }
+        ReturnType: GetEntryPointVersion<entryPoint> extends "v0.6"
+            ? {
+                  preVerificationGas: Hex
+                  verificationGasLimit: Hex
+                  callGasLimit: Hex
+              }
+            : {
+                  preVerificationGas: Hex
+                  verificationGasLimit: Hex
+                  callGasLimit: Hex | null | undefined
+                  paymasterVerificationGasLimit: Hex | null | undefined
+                  paymasterPostOpGasLimit: Hex | null | undefined
+              }
     },
     {
         Method: "eth_supportedEntryPoints"
@@ -53,8 +63,10 @@ export type BundlerRpcSchema = [
         Method: "eth_getUserOperationByHash"
         Parameters: [hash: Hash]
         ReturnType: {
-            userOperation: UserOperationWithBigIntAsHex
-            entryPoint: Address
+            userOperation: UserOperationWithBigIntAsHex<
+                GetEntryPointVersion<entryPoint>
+            >
+            entryPoint: entryPoint
             transactionHash: Hash
             blockHash: Hash
             blockNumber: Hex

package/types/entrypoint.ts

@@ -0,0 +1,13 @@
+export type EntryPointVersion = "v0.6" | "v0.7"
+
+export type ENTRYPOINT_ADDRESS_V06_TYPE =
+    "0x5FF137D4b0FDCD49DcA30c7CF57E578a026d2789"
+export type ENTRYPOINT_ADDRESS_V07_TYPE =
+    "0x0000000071727De22E5E9d8BAf0edAc6f37da032"
+
+export type GetEntryPointVersion<entryPoint extends EntryPoint> =
+    entryPoint extends ENTRYPOINT_ADDRESS_V06_TYPE ? "v0.6" : "v0.7"
+
+export type EntryPoint =
+    | ENTRYPOINT_ADDRESS_V06_TYPE
+    | ENTRYPOINT_ADDRESS_V07_TYPE

package/types/index.ts

@@ -1,9 +1,16 @@
 import type { Account, Chain, Client, Transport } from "viem"
+import type { IsUndefined } from "viem/types/utils"
 import type { SmartAccount } from "../accounts/types"
+import type { EntryPoint } from "./entrypoint"
 import type { UserOperation } from "./userOperation"
 export type { UserOperation }
-
-export type IsUndefined<T> = [undefined] extends [T] ? true : false
+export type {
+    EntryPointVersion,
+    ENTRYPOINT_ADDRESS_V06_TYPE,
+    ENTRYPOINT_ADDRESS_V07_TYPE,
+    GetEntryPointVersion,
+    EntryPoint
+} from "./entrypoint"
 
 export type GetAccountParameterWithClient<
     TTransport extends Transport = Transport,
@@ -14,10 +21,13 @@ export type GetAccountParameterWithClient<
     : { client: Client<TTransport, TChain, TAccount>; account?: Account }
 
 export type GetAccountParameter<
-    TAccount extends SmartAccount | undefined = SmartAccount | undefined
+    entryPoint extends EntryPoint,
+    TAccount extends SmartAccount<entryPoint> | undefined =
+        | SmartAccount<entryPoint>
+        | undefined
 > = IsUndefined<TAccount> extends true
-    ? { account: SmartAccount }
-    : { account?: SmartAccount }
+    ? { account: SmartAccount<entryPoint> }
+    : { account?: SmartAccount<entryPoint> }
 
 export type Prettify<T> = {
     [K in keyof T]: T[K]

package/types/pimlico.ts

@@ -1,5 +1,6 @@
 import type { Address, Hash, Hex } from "viem"
 import type { PartialBy } from "viem/types/utils"
+import type { EntryPoint, GetEntryPointVersion } from "./entrypoint"
 import type { UserOperationWithBigIntAsHex } from "./userOperation"
 
 type PimlicoUserOperationGasPriceWithBigIntAsHex = {
@@ -51,34 +52,59 @@ export type PimlicoBundlerRpcSchema = [
     }
 ]
 
-export type PimlicoPaymasterRpcSchema = [
+export type PimlicoPaymasterRpcSchema<entryPoint extends EntryPoint> = [
     {
         Method: "pm_sponsorUserOperation"
         Parameters: [
-            userOperation: PartialBy<
-                UserOperationWithBigIntAsHex,
-                | "callGasLimit"
-                | "preVerificationGas"
-                | "verificationGasLimit"
-                | "paymasterAndData"
-            >,
-            entryPoint: Address,
+            userOperation: GetEntryPointVersion<entryPoint> extends "v0.6"
+                ? PartialBy<
+                      UserOperationWithBigIntAsHex<"v0.6">,
+                      | "callGasLimit"
+                      | "preVerificationGas"
+                      | "verificationGasLimit"
+                  >
+                : PartialBy<
+                      UserOperationWithBigIntAsHex<"v0.7">,
+                      | "callGasLimit"
+                      | "preVerificationGas"
+                      | "verificationGasLimit"
+                      | "paymasterVerificationGasLimit"
+                      | "paymasterPostOpGasLimit"
+                  >,
+            entryPoint: entryPoint,
             metadata?: {
                 sponsorshipPolicyId?: string
             }
         ]
-        ReturnType: {
-            paymasterAndData: Hex
-            preVerificationGas: Hex
-            verificationGasLimit: Hex
-            callGasLimit: Hex
-        }
+        ReturnType: GetEntryPointVersion<entryPoint> extends "v0.6"
+            ? {
+                  paymasterAndData: Hex
+                  preVerificationGas: Hex
+                  verificationGasLimit: Hex
+                  callGasLimit: Hex
+                  paymaster?: never
+                  paymasterVerificationGasLimit?: never
+                  paymasterPostOpGasLimit?: never
+                  paymasterData?: never
+              }
+            : {
+                  preVerificationGas: Hex
+                  verificationGasLimit: Hex
+                  callGasLimit: Hex
+                  paymaster: Address
+                  paymasterVerificationGasLimit: Hex
+                  paymasterPostOpGasLimit: Hex
+                  paymasterData: Hex
+                  paymasterAndData?: never
+              }
     },
     {
         Method: "pm_validateSponsorshipPolicies"
         Parameters: [
-            userOperation: UserOperationWithBigIntAsHex,
-            entryPoint: Address,
+            userOperation: UserOperationWithBigIntAsHex<
+                GetEntryPointVersion<entryPoint>
+            >,
+            entryPoint: entryPoint,
             sponsorshipPolicyIds: string[]
         ]
         ReturnType: {

package/types/stackup.ts

@@ -1,5 +1,6 @@
 import type { Address, Hex } from "viem"
 import type { PartialBy } from "viem/types/utils"
+import type { ENTRYPOINT_ADDRESS_V06_TYPE, EntryPoint } from "./entrypoint"
 import type { UserOperationWithBigIntAsHex } from "./userOperation"
 
 interface StackupPaymasterContextType {
@@ -10,26 +11,49 @@ export type StackupPaymasterContext =
     | (StackupPaymasterContextType & { type: "erc20token"; token: string })
     | (StackupPaymasterContextType & { type: "payg" })
 
-export type StackupPaymasterRpcSchema = [
+export type StackupPaymasterRpcSchema<entryPoint extends EntryPoint> = [
     {
         Method: "pm_sponsorUserOperation"
         Parameters: [
-            userOperation: PartialBy<
-                UserOperationWithBigIntAsHex,
-                | "callGasLimit"
-                | "preVerificationGas"
-                | "verificationGasLimit"
-                | "paymasterAndData"
-            >,
-            entryPoint: Address,
+            userOperation: entryPoint extends ENTRYPOINT_ADDRESS_V06_TYPE
+                ? PartialBy<
+                      UserOperationWithBigIntAsHex<"v0.6">,
+                      | "callGasLimit"
+                      | "preVerificationGas"
+                      | "verificationGasLimit"
+                  >
+                : PartialBy<
+                      UserOperationWithBigIntAsHex<"v0.7">,
+                      | "callGasLimit"
+                      | "preVerificationGas"
+                      | "verificationGasLimit"
+                      | "paymasterVerificationGasLimit"
+                      | "paymasterPostOpGasLimit"
+                  >,
+            entryPoint: entryPoint,
             context: StackupPaymasterContext
         ]
-        ReturnType: {
-            paymasterAndData: Hex
-            preVerificationGas: Hex
-            verificationGasLimit: Hex
-            callGasLimit: Hex
-        }
+        ReturnType: entryPoint extends ENTRYPOINT_ADDRESS_V06_TYPE
+            ? {
+                  paymasterAndData: Hex
+                  preVerificationGas: Hex
+                  verificationGasLimit: Hex
+                  callGasLimit: Hex
+                  paymaster?: never
+                  paymasterVerificationGasLimit?: never
+                  paymasterPostOpGasLimit?: never
+                  paymasterData?: never
+              }
+            : {
+                  preVerificationGas: Hex
+                  verificationGasLimit: Hex
+                  callGasLimit: Hex
+                  paymaster: Address
+                  paymasterVerificationGasLimit: Hex
+                  paymasterPostOpGasLimit: Hex
+                  paymasterData: Hex
+                  paymasterAndData?: never
+              }
     },
     {
         Method: "pm_accounts"

package/types/userOperation.ts

@@ -1,32 +1,88 @@
 import type { Address } from "viem"
 import type { Hex } from "viem"
+import type { EntryPointVersion } from "./entrypoint"
 
 export type TStatus = "success" | "reverted"
 
-export type UserOperationWithBigIntAsHex = {
-    sender: Address
-    nonce: Hex
-    initCode: Hex
-    callData: Hex
-    callGasLimit: Hex
-    verificationGasLimit: Hex
-    preVerificationGas: Hex
-    maxFeePerGas: Hex
-    maxPriorityFeePerGas: Hex
-    paymasterAndData: Hex
-    signature: Hex
-}
+export type UserOperationWithBigIntAsHex<
+    entryPointVersion extends EntryPointVersion
+> = entryPointVersion extends "v0.6"
+    ? {
+          sender: Address
+          nonce: Hex
+          initCode: Hex
+          callData: Hex
+          callGasLimit: Hex
+          verificationGasLimit: Hex
+          preVerificationGas: Hex
+          maxFeePerGas: Hex
+          maxPriorityFeePerGas: Hex
+          paymasterAndData: Hex
+          signature: Hex
+          factory?: never
+          factoryData?: never
+          paymaster?: never
+          paymasterVerificationGasLimit?: never
+          paymasterPostOpGasLimit?: never
+          paymasterData?: never
+      }
+    : {
+          sender: Address
+          nonce: Hex
+          factory: Address
+          factoryData: Hex
+          callData: Hex
+          callGasLimit: Hex
+          verificationGasLimit: Hex
+          preVerificationGas: Hex
+          maxFeePerGas: Hex
+          maxPriorityFeePerGas: Hex
+          paymaster: Address
+          paymasterVerificationGasLimit: Hex
+          paymasterPostOpGasLimit: Hex
+          paymasterData: Hex
+          signature: Hex
+          initCode?: never
+          paymasterAndData?: never
+      }
 
-export type UserOperation = {
-    sender: Address
-    nonce: bigint
-    initCode: Hex
-    callData: Hex
-    callGasLimit: bigint
-    verificationGasLimit: bigint
-    preVerificationGas: bigint
-    maxFeePerGas: bigint
-    maxPriorityFeePerGas: bigint
-    paymasterAndData: Hex
-    signature: Hex
-}
+export type UserOperation<entryPointVersion extends EntryPointVersion> =
+    entryPointVersion extends "v0.6"
+        ? {
+              sender: Address
+              nonce: bigint
+              initCode: Hex
+              callData: Hex
+              callGasLimit: bigint
+              verificationGasLimit: bigint
+              preVerificationGas: bigint
+              maxFeePerGas: bigint
+              maxPriorityFeePerGas: bigint
+              paymasterAndData: Hex
+              signature: Hex
+              factory?: never
+              factoryData?: never
+              paymaster?: never
+              paymasterVerificationGasLimit?: never
+              paymasterPostOpGasLimit?: never
+              paymasterData?: never
+          }
+        : {
+              sender: Address
+              nonce: bigint
+              factory: Address | undefined
+              factoryData: Hex | undefined
+              callData: Hex
+              callGasLimit: bigint
+              verificationGasLimit: bigint
+              preVerificationGas: bigint
+              maxFeePerGas: bigint
+              maxPriorityFeePerGas: bigint
+              paymaster: Address | undefined
+              paymasterVerificationGasLimit: bigint | undefined
+              paymasterPostOpGasLimit: bigint | undefined
+              paymasterData: Hex | undefined
+              signature: Hex
+              initCode?: never
+              paymasterAndData?: never
+          }

package/utils/errors/getBundlerError.ts

@@ -38,10 +38,14 @@ import {
     PaymasterValidityPeriodError,
     type PaymasterValidityPeriodErrorType
 } from "../../errors/paymaster"
-import type { UserOperation } from "../../types"
-
-export type GetBundlerErrorParameters = {
-    userOperation: Partial<UserOperation>
+import type {
+    EntryPoint,
+    GetEntryPointVersion,
+    UserOperation
+} from "../../types"
+
+export type GetBundlerErrorParameters<entryPoint extends EntryPoint> = {
+    userOperation: Partial<UserOperation<GetEntryPointVersion<entryPoint>>>
     entryPoint: Address
 }
 
@@ -63,9 +67,9 @@ export type GetBundlerErrorReturnType =
     | PaymasterValidationRevertedErrorType
     | PaymasterDataRejectedErrorType
 
-export function getBundlerError(
+export function getBundlerError<entryPoint extends EntryPoint>(
     err: BaseError,
-    args: GetBundlerErrorParameters
+    args: GetBundlerErrorParameters<entryPoint>
 ) {
     const message = (err.details || "").toLowerCase()
 

package/utils/errors/getEstimateUserOperationGasError.ts

@@ -5,26 +5,29 @@ import {
     type EstimateUserOperationGasErrorType
 } from "../../errors/estimateUserOperationGas"
 import { type ErrorType } from "../../errors/utils"
+import type { EntryPoint } from "../../types/entrypoint"
 import {
     type GetBundlerErrorParameters,
     type GetBundlerErrorReturnType,
     getBundlerError
 } from "./getBundlerError"
 
-export type GetEstimateUserOperationGasErrorReturnType<cause = ErrorType> =
-    Omit<EstimateUserOperationGasErrorType, "cause"> & {
-        cause: cause | GetBundlerErrorReturnType
-    }
+export type GetEstimateUserOperationGasErrorReturnType<
+    entryPoint extends EntryPoint,
+    cause = ErrorType
+> = Omit<EstimateUserOperationGasErrorType<entryPoint>, "cause"> & {
+    cause: cause | GetBundlerErrorReturnType
+}
 
-export function getEstimateUserOperationGasError<err extends ErrorType<string>>(
-    error: err,
-    args: EstimateUserOperationGasParameters
-) {
+export function getEstimateUserOperationGasError<
+    err extends ErrorType<string>,
+    entryPoint extends EntryPoint
+>(error: err, args: EstimateUserOperationGasParameters<entryPoint>) {
     const cause = (() => {
         const cause = getBundlerError(
             // biome-ignore lint/complexity/noBannedTypes: <explanation>
             error as {} as BaseError,
-            args as GetBundlerErrorParameters
+            args as GetBundlerErrorParameters<entryPoint>
         )
         // biome-ignore lint/complexity/noBannedTypes: <explanation>
         if (cause instanceof UnknownNodeError) return error as {} as BaseError
@@ -33,5 +36,5 @@ export function getEstimateUserOperationGasError<err extends ErrorType<string>>(
 
     throw new EstimateUserOperationGasError(cause, {
         ...args
-    }) as GetEstimateUserOperationGasErrorReturnType<err>
+    }) as GetEstimateUserOperationGasErrorReturnType<entryPoint, err>
 }

package/utils/errors/getSendUserOperationError.ts

@@ -1,19 +1,20 @@
 import { BaseError, UnknownNodeError } from "viem"
 import type { SendUserOperationParameters } from "../../actions/bundler/sendUserOperation"
 import { SendUserOperationError } from "../../errors"
+import type { EntryPoint } from "../../types/entrypoint"
 import {
     type GetBundlerErrorParameters,
     getBundlerError
 } from "./getBundlerError"
 
-export function getSendUserOperationError(
+export function getSendUserOperationError<entryPoint extends EntryPoint>(
     err: BaseError,
-    args: SendUserOperationParameters
+    args: SendUserOperationParameters<entryPoint>
 ) {
     const cause = (() => {
         const cause = getBundlerError(
             err as BaseError,
-            args as GetBundlerErrorParameters
+            args as GetBundlerErrorParameters<entryPoint>
         )
         if (cause instanceof UnknownNodeError) return err as BaseError
         return cause

package/utils/getEntryPointVersion.ts

@@ -0,0 +1,15 @@
+import type {
+    ENTRYPOINT_ADDRESS_V06_TYPE,
+    ENTRYPOINT_ADDRESS_V07_TYPE
+} from "../types"
+import type { EntryPoint, GetEntryPointVersion } from "../types/entrypoint"
+
+export const ENTRYPOINT_ADDRESS_V06: ENTRYPOINT_ADDRESS_V06_TYPE =
+    "0x5FF137D4b0FDCD49DcA30c7CF57E578a026d2789"
+export const ENTRYPOINT_ADDRESS_V07: ENTRYPOINT_ADDRESS_V07_TYPE =
+    "0x0000000071727De22E5E9d8BAf0edAc6f37da032"
+
+export const getEntryPointVersion = (
+    entryPoint: EntryPoint
+): GetEntryPointVersion<EntryPoint> =>
+    entryPoint === ENTRYPOINT_ADDRESS_V06 ? "v0.6" : "v0.7"

package/utils/getRequiredPrefund.ts

@@ -1,7 +1,9 @@
-import type { UserOperation } from "../types"
+import type { EntryPoint, GetEntryPointVersion, UserOperation } from "../types"
+import { ENTRYPOINT_ADDRESS_V06 } from "./getEntryPointVersion"
 
-export type GetRequiredPrefundReturnType = {
-    userOperation: UserOperation
+export type GetRequiredPrefundReturnType<entryPoint extends EntryPoint> = {
+    userOperation: UserOperation<GetEntryPointVersion<entryPoint>>
+    entryPoint: entryPoint
 }
 
 /**
@@ -18,14 +20,36 @@ export type GetRequiredPrefundReturnType = {
  *     userOperation
  * })
  */
-export const getRequiredPrefund = ({
-    userOperation
-}: GetRequiredPrefundReturnType): bigint => {
-    const multiplier = userOperation.paymasterAndData.length > 2 ? 3n : 1n
+export const getRequiredPrefund = <entryPoint extends EntryPoint>({
+    userOperation,
+    entryPoint: entryPointAddress
+}: GetRequiredPrefundReturnType<entryPoint>): bigint => {
+    if (entryPointAddress === ENTRYPOINT_ADDRESS_V06) {
+        const userOperationVersion0_6 = userOperation as UserOperation<"v0.6">
+        const multiplier =
+            userOperationVersion0_6.paymasterAndData.length > 2 ? 3n : 1n
+        const requiredGas =
+            userOperationVersion0_6.callGasLimit +
+            userOperationVersion0_6.verificationGasLimit * multiplier +
+            userOperationVersion0_6.preVerificationGas
+
+        return (
+            BigInt(requiredGas) * BigInt(userOperationVersion0_6.maxFeePerGas)
+        )
+    }
+
+    const userOperationV07 = userOperation as UserOperation<"v0.7">
+    const multiplier = userOperationV07.paymaster ? 3n : 1n
+
+    const verificationGasLimit =
+        userOperationV07.verificationGasLimit +
+        (userOperationV07.paymasterPostOpGasLimit || 0n) +
+        (userOperationV07.paymasterVerificationGasLimit || 0n)
+
     const requiredGas =
-        userOperation.callGasLimit +
-        userOperation.verificationGasLimit * multiplier +
-        userOperation.preVerificationGas
+        userOperationV07.callGasLimit +
+        verificationGasLimit * multiplier +
+        userOperationV07.preVerificationGas
 
-    return BigInt(requiredGas) * BigInt(userOperation.maxFeePerGas)
+    return BigInt(requiredGas) * BigInt(userOperationV07.maxFeePerGas)
 }