permissionless 0.2.44 → 0.2.46

package/actions/smartAccount/signTypedData.test.ts

@@ -48,6 +48,7 @@ describe.each(getCoreSmartAccounts())(
         isEip1271Compliant,
         supportsEntryPointV06,
         supportsEntryPointV07,
+        supportsEntryPointV08,
         name
     }) => {
         testWithRpc.skipIf(isEip1271Compliant || !supportsEntryPointV06)(
@@ -144,5 +145,58 @@ describe.each(getCoreSmartAccounts())(
                 expect(isVerified).toBeTruthy()
             }
         )
+
+        testWithRpc.skipIf(isEip1271Compliant || !supportsEntryPointV08)(
+            "not isEip1271Compliant_v08",
+            async ({ rpc }) => {
+                const smartClient = await getSmartAccountClient({
+                    entryPoint: {
+                        version: "0.8"
+                    },
+                    ...rpc
+                })
+
+                await expect(async () =>
+                    signTypedData(smartClient, typedData)
+                ).rejects.toThrow()
+            }
+        )
+
+        testWithRpc.skipIf(!isEip1271Compliant || !supportsEntryPointV08)(
+            "isEip1271Compliant_v08",
+            async ({ rpc }) => {
+                const { anvilRpc } = rpc
+
+                const smartClient = await getSmartAccountClient({
+                    entryPoint: {
+                        version: "0.8"
+                    },
+                    ...rpc
+                })
+
+                const signature = await signTypedData(smartClient, typedData)
+
+                const publicClient = getPublicClient(anvilRpc)
+
+                if (name === "LightAccount 2.0.0") {
+                    // LightAccount 2.0.0 doesn't support EIP-1271
+                    return
+                }
+
+                if (name.includes("Safe 7579")) {
+                    // Due to 7579 launchpad, we can't verify the signature before deploying the account.
+                    await smartClient.sendTransaction({
+                        calls: [{ to: zeroAddress, value: 0n }]
+                    })
+                }
+                const isVerified = await publicClient.verifyTypedData({
+                    ...typedData,
+                    address: smartClient.account.address,
+                    signature
+                })
+
+                expect(isVerified).toBeTruthy()
+            }
+        )
     }
 )

package/clients/decorators/pimlico.ts

@@ -1,4 +1,5 @@
 import type { Address, Chain, Client, Hash, Prettify, Transport } from "viem"
+import type { EntryPointVersion } from "viem/account-abstraction"
 import {
     type GetTokenQuotesParameters,
     type GetTokenQuotesReturnType,
@@ -26,7 +27,7 @@ import {
 
 export type PimlicoActions<
     TChain extends Chain | undefined,
-    entryPointVersion extends "0.6" | "0.7" = "0.6" | "0.7"
+    entryPointVersion extends EntryPointVersion = EntryPointVersion
 > = {
     /**
      * Returns the live gas prices that you can use to send a user operation.
@@ -126,7 +127,7 @@ export type PimlicoActions<
 }
 
 export const pimlicoActions =
-    <entryPointVersion extends "0.6" | "0.7">({
+    <entryPointVersion extends EntryPointVersion>({
         entryPoint
     }: {
         entryPoint: { address: Address; version: entryPointVersion }

package/clients/pimlico.ts

@@ -11,6 +11,7 @@ import type {
 import { createClient } from "viem"
 import {
     type BundlerActions,
+    type EntryPointVersion,
     type PaymasterActions,
     type SmartAccount,
     bundlerActions,
@@ -21,7 +22,7 @@ import type { PimlicoRpcSchema } from "../types/pimlico.js"
 import { type PimlicoActions, pimlicoActions } from "./decorators/pimlico.js"
 
 export type PimlicoClient<
-    entryPointVersion extends "0.6" | "0.7" = "0.7" | "0.6",
+    entryPointVersion extends EntryPointVersion = EntryPointVersion,
     transport extends Transport = Transport,
     chain extends Chain | undefined = Chain | undefined,
     account extends SmartAccount | undefined = SmartAccount | undefined,
@@ -47,7 +48,7 @@ export type PimlicoClient<
 >
 
 export type PimlicoClientConfig<
-    entryPointVersion extends "0.6" | "0.7" = "0.7" | "0.6",
+    entryPointVersion extends EntryPointVersion = EntryPointVersion,
     transport extends Transport = Transport,
     chain extends Chain | undefined = Chain | undefined,
     account extends SmartAccount | undefined = SmartAccount | undefined,
@@ -72,7 +73,7 @@ export type PimlicoClientConfig<
 }
 
 export function createPimlicoClient<
-    entryPointVersion extends "0.6" | "0.7" = "0.7",
+    entryPointVersion extends EntryPointVersion = "0.7",
     transport extends Transport = Transport,
     chain extends Chain | undefined = undefined,
     account extends SmartAccount | undefined = SmartAccount | undefined,

package/experimental/pimlico/utils/prepareUserOperationForErc20Paymaster.test.ts

@@ -1,23 +1,24 @@
 import { http, parseEther, zeroAddress } from "viem"
 import {
     entryPoint06Address,
-    entryPoint07Address
+    entryPoint07Address,
+    entryPoint08Address
 } from "viem/account-abstraction"
 import { foundry } from "viem/chains"
 import { describe, expect } from "vitest"
 import {
-    ERC20_ADDRESS,
+    erc20Address,
     sudoMintTokens,
     tokenBalanceOf
-} from "../../../../mock-paymaster/helpers/erc20-utils.ts"
-import { testWithRpc } from "../../../../permissionless-test/src/testWithRpc.ts"
+} from "../../../../mock-paymaster/helpers/erc20-utils"
+import { testWithRpc } from "../../../../permissionless-test/src/testWithRpc"
 import {
     getCoreSmartAccounts,
     getPublicClient
 } from "../../../../permissionless-test/src/utils"
-import { createSmartAccountClient } from "../../../clients/createSmartAccountClient.ts"
-import { createPimlicoClient } from "../../../clients/pimlico.ts"
-import { prepareUserOperationForErc20Paymaster } from "./prepareUserOperationForErc20Paymaster.ts"
+import { createSmartAccountClient } from "../../../clients/createSmartAccountClient"
+import { createPimlicoClient } from "../../../clients/pimlico"
+import { prepareUserOperationForErc20Paymaster } from "./prepareUserOperationForErc20Paymaster"
 
 describe.each(getCoreSmartAccounts())(
     "prepareUserOperationForErc20Paymaster $name",
@@ -25,9 +26,10 @@ describe.each(getCoreSmartAccounts())(
         getSmartAccountClient,
         supportsEntryPointV06,
         supportsEntryPointV07,
+        supportsEntryPointV08,
         name
     }) => {
-        testWithRpc.skipIf(!supportsEntryPointV06)(
+        testWithRpc.skipIf(!supportsEntryPointV06 || name === "Kernel 0.2.1")(
             "prepareUserOperationForErc20Paymaster_v06",
             async ({ rpc }) => {
                 const { anvilRpc } = rpc
@@ -84,7 +86,7 @@ describe.each(getCoreSmartAccounts())(
                         }
                     ],
                     paymasterContext: {
-                        token: ERC20_ADDRESS
+                        token: erc20Address
                     }
                 })
 
@@ -96,21 +98,17 @@ describe.each(getCoreSmartAccounts())(
                 expect(receipt).toBeTruthy()
                 expect(receipt).toBeTruthy()
 
-                if (name !== "Kernel 0.2.1") {
-                    expect(receipt.success).toBeTruthy()
-                    const FINAL_TOKEN_BALANCE = await tokenBalanceOf(
-                        smartAccountClient.account.address,
-                        rpc.anvilRpc
-                    )
-                    const FINAL_ETH_BALANCE = await publicClient.getBalance({
-                        address: smartAccountClient.account.address
-                    })
+                expect(receipt.success).toBeTruthy()
+                const FINAL_TOKEN_BALANCE = await tokenBalanceOf(
+                    smartAccountClient.account.address,
+                    rpc.anvilRpc
+                )
+                const FINAL_ETH_BALANCE = await publicClient.getBalance({
+                    address: smartAccountClient.account.address
+                })
 
-                    expect(FINAL_TOKEN_BALANCE).toBeLessThan(
-                        INITIAL_TOKEN_BALANCE
-                    ) // Token balance should be deducted
-                    expect(FINAL_ETH_BALANCE).toEqual(INTIAL_ETH_BALANCE) // There should be no ETH balance change
-                }
+                expect(FINAL_TOKEN_BALANCE).toBeLessThan(INITIAL_TOKEN_BALANCE) // Token balance should be deducted
+                expect(FINAL_ETH_BALANCE).toEqual(INTIAL_ETH_BALANCE) // There should be no ETH balance change
             }
         )
 
@@ -171,7 +169,90 @@ describe.each(getCoreSmartAccounts())(
                         }
                     ],
                     paymasterContext: {
-                        token: ERC20_ADDRESS
+                        token: erc20Address
+                    }
+                })
+
+                const receipt =
+                    await smartAccountClient.waitForUserOperationReceipt({
+                        hash: opHash
+                    })
+
+                expect(receipt).toBeTruthy()
+                expect(receipt).toBeTruthy()
+                expect(receipt.success).toBeTruthy()
+
+                const FINAL_TOKEN_BALANCE = await tokenBalanceOf(
+                    smartAccountClient.account.address,
+                    rpc.anvilRpc
+                )
+                const FINAL_ETH_BALANCE = await publicClient.getBalance({
+                    address: smartAccountClient.account.address
+                })
+
+                expect(FINAL_TOKEN_BALANCE).toBeLessThan(INITIAL_TOKEN_BALANCE) // Token balance should be deducted
+                expect(FINAL_ETH_BALANCE).toEqual(INTIAL_ETH_BALANCE) // There should be no ETH balance change
+            }
+        )
+
+        testWithRpc.skipIf(!supportsEntryPointV08)(
+            "prepareUserOperationForErc20Paymaster_v08",
+            async ({ rpc }) => {
+                const { anvilRpc } = rpc
+
+                const account = (
+                    await getSmartAccountClient({
+                        entryPoint: {
+                            version: "0.8"
+                        },
+                        ...rpc
+                    })
+                ).account
+
+                const publicClient = getPublicClient(anvilRpc)
+
+                const pimlicoClient = createPimlicoClient({
+                    transport: http(rpc.paymasterRpc),
+                    entryPoint: {
+                        address: entryPoint08Address,
+                        version: "0.8"
+                    }
+                })
+
+                const smartAccountClient = createSmartAccountClient({
+                    // @ts-ignore
+                    client: getPublicClient(anvilRpc),
+                    account,
+                    paymaster: pimlicoClient,
+                    chain: foundry,
+                    userOperation: {
+                        prepareUserOperation:
+                            prepareUserOperationForErc20Paymaster(pimlicoClient)
+                    },
+                    bundlerTransport: http(rpc.altoRpc)
+                })
+
+                const INITIAL_TOKEN_BALANCE = parseEther("100")
+                const INTIAL_ETH_BALANCE = await publicClient.getBalance({
+                    address: smartAccountClient.account.address
+                })
+
+                sudoMintTokens({
+                    amount: INITIAL_TOKEN_BALANCE,
+                    to: smartAccountClient.account.address,
+                    anvilRpc
+                })
+
+                const opHash = await smartAccountClient.sendUserOperation({
+                    calls: [
+                        {
+                            to: zeroAddress,
+                            data: "0x",
+                            value: 0n
+                        }
+                    ],
+                    paymasterContext: {
+                        token: erc20Address
                     }
                 })
 
@@ -259,7 +340,7 @@ describe.each(getCoreSmartAccounts())(
                         }
                     ],
                     paymasterContext: {
-                        token: ERC20_ADDRESS
+                        token: erc20Address
                     }
                 })
 
@@ -285,7 +366,95 @@ describe.each(getCoreSmartAccounts())(
             }
         )
 
-        testWithRpc.skipIf(!supportsEntryPointV06)(
+        testWithRpc.skipIf(!supportsEntryPointV08)(
+            "prepareUserOperationForErc20Paymaster_v08 (balanceOverride enabled)",
+            async ({ rpc }) => {
+                const { anvilRpc } = rpc
+
+                const account = (
+                    await getSmartAccountClient({
+                        entryPoint: {
+                            version: "0.8"
+                        },
+                        ...rpc
+                    })
+                ).account
+
+                const publicClient = getPublicClient(anvilRpc)
+
+                const pimlicoClient = createPimlicoClient({
+                    transport: http(rpc.paymasterRpc),
+                    entryPoint: {
+                        address: entryPoint08Address,
+                        version: "0.8"
+                    }
+                })
+
+                const smartAccountClient = createSmartAccountClient({
+                    // @ts-ignore
+                    client: getPublicClient(anvilRpc),
+                    account,
+                    paymaster: pimlicoClient,
+                    chain: foundry,
+                    userOperation: {
+                        prepareUserOperation:
+                            prepareUserOperationForErc20Paymaster(
+                                pimlicoClient,
+                                {
+                                    balanceOverride: true
+                                }
+                            )
+                    },
+                    bundlerTransport: http(rpc.altoRpc)
+                })
+
+                const INITIAL_TOKEN_BALANCE = parseEther("100")
+                const INTIAL_ETH_BALANCE = await publicClient.getBalance({
+                    address: smartAccountClient.account.address
+                })
+
+                sudoMintTokens({
+                    amount: INITIAL_TOKEN_BALANCE,
+                    to: smartAccountClient.account.address,
+                    anvilRpc
+                })
+
+                const opHash = await smartAccountClient.sendUserOperation({
+                    calls: [
+                        {
+                            to: zeroAddress,
+                            data: "0x",
+                            value: 0n
+                        }
+                    ],
+                    paymasterContext: {
+                        token: erc20Address
+                    }
+                })
+
+                const receipt =
+                    await smartAccountClient.waitForUserOperationReceipt({
+                        hash: opHash
+                    })
+
+                expect(receipt).toBeTruthy()
+                expect(receipt).toBeTruthy()
+                expect(receipt.success).toBeTruthy()
+
+                const FINAL_TOKEN_BALANCE = await tokenBalanceOf(
+                    smartAccountClient.account.address,
+                    rpc.anvilRpc
+                )
+                const FINAL_ETH_BALANCE = await publicClient.getBalance({
+                    address: smartAccountClient.account.address
+                })
+
+                expect(FINAL_TOKEN_BALANCE).toBeLessThan(INITIAL_TOKEN_BALANCE) // Token balance should be deducted
+                expect(FINAL_ETH_BALANCE).toEqual(INTIAL_ETH_BALANCE) // There should be no ETH balance change
+            }
+        )
+
+        testWithRpc.skipIf(!supportsEntryPointV06 || name === "Kernel 0.2.1")(
             "prepareUserOperationForErc20Paymaster_v06",
             async ({ rpc }) => {
                 const { anvilRpc } = rpc
@@ -342,7 +511,7 @@ describe.each(getCoreSmartAccounts())(
                         }
                     ]),
                     paymasterContext: {
-                        token: ERC20_ADDRESS
+                        token: erc20Address
                     }
                 })
 
@@ -354,21 +523,17 @@ describe.each(getCoreSmartAccounts())(
                 expect(receipt).toBeTruthy()
                 expect(receipt).toBeTruthy()
 
-                if (name !== "Kernel 0.2.1") {
-                    expect(receipt.success).toBeTruthy()
-                    const FINAL_TOKEN_BALANCE = await tokenBalanceOf(
-                        smartAccountClient.account.address,
-                        rpc.anvilRpc
-                    )
-                    const FINAL_ETH_BALANCE = await publicClient.getBalance({
-                        address: smartAccountClient.account.address
-                    })
+                expect(receipt.success).toBeTruthy()
+                const FINAL_TOKEN_BALANCE = await tokenBalanceOf(
+                    smartAccountClient.account.address,
+                    rpc.anvilRpc
+                )
+                const FINAL_ETH_BALANCE = await publicClient.getBalance({
+                    address: smartAccountClient.account.address
+                })
 
-                    expect(FINAL_TOKEN_BALANCE).toBeLessThan(
-                        INITIAL_TOKEN_BALANCE
-                    ) // Token balance should be deducted
-                    expect(FINAL_ETH_BALANCE).toEqual(INTIAL_ETH_BALANCE) // There should be no ETH balance change
-                }
+                expect(FINAL_TOKEN_BALANCE).toBeLessThan(INITIAL_TOKEN_BALANCE) // Token balance should be deducted
+                expect(FINAL_ETH_BALANCE).toEqual(INTIAL_ETH_BALANCE) // There should be no ETH balance change
             }
         )
 
@@ -429,7 +594,7 @@ describe.each(getCoreSmartAccounts())(
                         }
                     ]),
                     paymasterContext: {
-                        token: ERC20_ADDRESS
+                        token: erc20Address
                     }
                 })
 
@@ -517,7 +682,7 @@ describe.each(getCoreSmartAccounts())(
                         }
                     ]),
                     paymasterContext: {
-                        token: ERC20_ADDRESS
+                        token: erc20Address
                     }
                 })
 

package/experimental/pimlico/utils/prepareUserOperationForErc20Paymaster.ts

@@ -68,7 +68,7 @@ export const prepareUserOperationForErc20Paymaster =
         const account_ = client.account
 
         if (!account_) throw new Error("Account not found")
-        const account = parseAccount(account_)
+        const account = parseAccount<SmartAccount>(account_)
 
         const bundlerClient = client as unknown as BundlerClient
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "permissionless",
-    "version": "0.2.44",
+    "version": "0.2.46",
     "author": "Pimlico",
     "homepage": "https://docs.pimlico.io/permissionless",
     "repository": "github:pimlicolabs/permissionless.js",
@@ -97,7 +97,7 @@
         }
     },
     "peerDependencies": {
-        "viem": "^2.23.2",
+        "viem": "^2.28.1",
         "ox": "0.6.7"
     },
     "peerDependenciesMeta": {

package/types/pimlico.ts

@@ -1,5 +1,5 @@
 import type { Address, Hash, Hex, OneOf, PartialBy } from "viem"
-import type { UserOperation } from "viem/account-abstraction"
+import type { EntryPointVersion, UserOperation } from "viem/account-abstraction"
 
 type PimlicoUserOperationGasPriceWithBigIntAsHex = {
     slow: {
@@ -41,7 +41,7 @@ type GetTokenQuotesWithBigIntAsHex = {
 }
 
 export type PimlicoRpcSchema<
-    entryPointVersion extends "0.6" | "0.7" = "0.6" | "0.7"
+    entryPointVersion extends EntryPointVersion = EntryPointVersion
 > = [
     {
         Method: "pimlico_getUserOperationGasPrice"
@@ -84,6 +84,16 @@ export type PimlicoRpcSchema<
                             | "paymasterPostOpGasLimit"
                         >
                       : never)
+                | (entryPointVersion extends "0.8"
+                      ? PartialBy<
+                            UserOperation<"0.7", Hex>,
+                            | "callGasLimit"
+                            | "preVerificationGas"
+                            | "verificationGasLimit"
+                            | "paymasterVerificationGasLimit"
+                            | "paymasterPostOpGasLimit"
+                        >
+                      : never)
             >,
             entryPoint: Address,
             metadata?: {

package/utils/getEstimationCallData.ts

@@ -1,5 +1,6 @@
 import { type Address, type Hex, encodeFunctionData } from "viem"
 import {
+    type EntryPointVersion,
     type UserOperation,
     entryPoint06Abi,
     toPackedUserOperation
@@ -44,7 +45,7 @@ function getPimlicoEstimationCallData06({
 function encodeSimulateHandleOpLast({
     userOperation
 }: {
-    userOperation: UserOperation<"0.7">
+    userOperation: UserOperation<"0.7" | "0.8">
 }): Hex {
     const userOperations = [userOperation]
     const packedUserOperations = userOperations.map((uop) => ({
@@ -177,11 +178,11 @@ function getPimlicoEstimationCallData07({
     estimationAddress,
     entrypoint
 }: {
-    userOperation: UserOperation<"0.7">
+    userOperation: UserOperation<"0.7" | "0.8">
     estimationAddress?: Address
     entrypoint: {
         address: Address
-        version: "0.7"
+        version: "0.7" | "0.8"
     }
 }): { to: Address; data: Hex } {
     const simulateHandleOpLast = encodeSimulateHandleOpLast({
@@ -224,7 +225,7 @@ function getPimlicoEstimationCallData07({
 }
 
 export type GetPimlicoEstimationCallDataParams<
-    entryPointVersion extends "0.6" | "0.7"
+    entryPointVersion extends EntryPointVersion
 > = {
     userOperation: UserOperation<entryPointVersion>
     entrypoint: {
@@ -238,19 +239,25 @@ export type GetPimlicoEstimationCallDataParams<
     : { estimationAddress?: Address })
 
 function isEntryPoint06(
-    args: GetPimlicoEstimationCallDataParams<"0.6" | "0.7">
+    args: GetPimlicoEstimationCallDataParams<EntryPointVersion>
 ): args is GetPimlicoEstimationCallDataParams<"0.6"> {
     return args.entrypoint.version === "0.6"
 }
 
 function isEntryPoint07(
-    args: GetPimlicoEstimationCallDataParams<"0.6" | "0.7">
+    args: GetPimlicoEstimationCallDataParams<EntryPointVersion>
 ): args is GetPimlicoEstimationCallDataParams<"0.7"> {
     return args.entrypoint.version === "0.7"
 }
 
+function isEntryPoint08(
+    args: GetPimlicoEstimationCallDataParams<EntryPointVersion>
+): args is GetPimlicoEstimationCallDataParams<"0.8"> {
+    return args.entrypoint.version === "0.8"
+}
+
 export function getPimlicoEstimationCallData<
-    entryPointVersion extends "0.6" | "0.7"
+    entryPointVersion extends EntryPointVersion
 >(
     args: GetPimlicoEstimationCallDataParams<entryPointVersion>
 ): { to: Address; data: Hex } {
@@ -275,5 +282,16 @@ export function getPimlicoEstimationCallData<
         })
     }
 
+    if (isEntryPoint08(args)) {
+        return getPimlicoEstimationCallData07({
+            userOperation: args.userOperation,
+            estimationAddress: args.estimationAddress,
+            entrypoint: {
+                address: args.entrypoint.address,
+                version: "0.8"
+            }
+        })
+    }
+
     throw new Error("Invalid entrypoint version")
 }

package/utils/getRequiredPrefund.ts

@@ -1,7 +1,7 @@
-import type { UserOperation } from "viem/account-abstraction"
+import type { EntryPointVersion, UserOperation } from "viem/account-abstraction"
 
 export type GetRequiredPrefundReturnType<
-    entryPointVersion extends "0.6" | "0.7"
+    entryPointVersion extends EntryPointVersion = "0.7"
 > = {
     userOperation: UserOperation<entryPointVersion>
     entryPointVersion: entryPointVersion
@@ -21,7 +21,9 @@ export type GetRequiredPrefundReturnType<
  *     userOperation
  * })
  */
-export const getRequiredPrefund = <entryPointVersion extends "0.6" | "0.7">({
+export const getRequiredPrefund = <
+    entryPointVersion extends EntryPointVersion
+>({
     userOperation,
     entryPointVersion
 }: GetRequiredPrefundReturnType<entryPointVersion>): bigint => {
@@ -41,7 +43,7 @@ export const getRequiredPrefund = <entryPointVersion extends "0.6" | "0.7">({
         )
     }
 
-    const userOperationV07 = userOperation as UserOperation<"0.7">
+    const userOperationV07 = userOperation as UserOperation<"0.7" | "0.8">
 
     const requiredGas =
         userOperationV07.verificationGasLimit +