Merge pull request #193 from pimlicolabs/feat/7677-experimental

Add 7677 experimental support

.changeset/mean-otters-arrive.md

@@ -0,0 +1,5 @@
+---
+"permissionless": patch
+---
+
+Added experimental EIP 7677 support

package.json

@@ -1,5 +1,7 @@
 {
-    "workspaces": ["packages/*"],
+    "workspaces": [
+        "packages/*"
+    ],
     "private": true,
     "author": "Pimlico",
     "type": "module",

packages/permissionless-test/src/ep-0.6/experiments.ts

@@ -0,0 +1,83 @@
+import {
+    ENTRYPOINT_ADDRESS_V06,
+    createSmartAccountClient
+} from "permissionless"
+import { privateKeyToSafeSmartAccount } from "permissionless/accounts"
+import { paymasterActionsEip7677 } from "permissionless/experimental"
+import type { ENTRYPOINT_ADDRESS_V06_TYPE } from "permissionless/types"
+import { http, createClient, zeroAddress } from "viem"
+import { generatePrivateKey } from "viem/accounts"
+import { foundry } from "viem/chains"
+import { describe, test } from "vitest"
+import type { AAParamType } from "../types"
+import {
+    PAYMASTER_RPC,
+    getPimlicoPaymasterClient,
+    getPublicClient,
+    getSafeClient
+} from "../utils"
+
+describe.each([
+    {
+        name: "Eip 7677 client",
+
+        getSmartAccountClient: async (
+            conf: AAParamType<ENTRYPOINT_ADDRESS_V06_TYPE>
+        ) => getSafeClient(conf)
+    }
+])("$name test", ({ name, getSmartAccountClient }) => {
+    test("Can get stab data", async () => {
+        const publicClient = getPublicClient()
+
+        const smartAccount = await privateKeyToSafeSmartAccount(publicClient, {
+            safeVersion: "1.4.1",
+            entryPoint: ENTRYPOINT_ADDRESS_V06,
+            privateKey: generatePrivateKey()
+        })
+        const ALTO_RPC = "http://localhost:4337"
+
+        const paymasterClient = getPimlicoPaymasterClient(
+            ENTRYPOINT_ADDRESS_V06
+        )
+
+        const smartAccountClient = createSmartAccountClient({
+            chain: foundry,
+            account: smartAccount,
+            bundlerTransport: http(ALTO_RPC)
+        })
+
+        const userOperaton =
+            await smartAccountClient.prepareUserOperationRequest({
+                userOperation: {
+                    callData: await smartAccountClient.account.encodeCallData({
+                        to: zeroAddress,
+                        value: 0n,
+                        data: "0x"
+                    })
+                }
+            })
+
+        const eip7677Client = createClient({
+            chain: foundry,
+            transport: http(PAYMASTER_RPC)
+        }).extend(
+            paymasterActionsEip7677({ entryPoint: ENTRYPOINT_ADDRESS_V06 })
+        )
+
+        const response = await eip7677Client.getPaymasterData({
+            userOperation: userOperaton
+        })
+
+        // await eip7677Client.getPaymasterStubData({
+        //     userOperation: await smartClient.prepareUserOperationRequest({
+        //         userOperation: {
+        //             callData: await smartClient.account.encodeCallData({
+        //                 to: zeroAddress,
+        //                 value: 0n,
+        //                 data: "0x"
+        //             })
+        //         }
+        //     })
+        // })
+    })
+})

packages/permissionless-test/src/utils.ts

@@ -22,6 +22,7 @@ import {
     createPimlicoBundlerClient,
     createPimlicoPaymasterClient
 } from "permissionless/clients/pimlico"
+import { paymasterActionsEip7677 } from "permissionless/experimental"
 import type {
     ENTRYPOINT_ADDRESS_V06_TYPE,
     EntryPoint
@@ -34,6 +35,7 @@ import {
     type Hex,
     type Transport,
     type WalletClient,
+    createClient,
     createPublicClient,
     createWalletClient,
     parseEther
@@ -52,7 +54,7 @@ import type { AAParamType } from "./types"
 
 export const ALTO_RPC = "http://localhost:4337"
 const ANVIL_RPC = "http://localhost:8545"
-const PAYMASTER_RPC = "http://localhost:3000"
+export const PAYMASTER_RPC = "http://localhost:3000"
 
 export const ensureBundlerIsReady = async () => {
     const bundlerClient = getBundlerClient(ENTRYPOINT_ADDRESS_V06)
@@ -212,20 +214,18 @@ export const getLightAccountClient = async <T extends EntryPoint>({
 }: AAParamType<T>): Promise<
     SmartAccountClient<T, Transport, Chain, SmartAccount<T>>
 > => {
-    const smartAccount = await signerToLightSmartAccount<T, Transport, Chain>(
-        publicClient,
-        {
-            entryPoint,
-            signer: privateKeyToAccount(privateKey),
-            lightAccountVersion: "1.1.0"
-        }
-    )
+    const smartAccount = await signerToLightSmartAccount(publicClient, {
+        entryPoint,
+        signer: privateKeyToAccount(privateKey),
+        lightAccountVersion: "1.1.0"
+    })
 
-    // @ts-ignore
     return createSmartAccountClient({
         chain: foundry,
         account: smartAccount,
         bundlerTransport: http(ALTO_RPC),
+        entryPoint: entryPoint,
+        // eip7677Client: await getEip7677Client({ entryPoint }),
         middleware: {
             // @ts-ignore
             sponsorUserOperation: paymasterClient?.sponsorUserOperation
@@ -316,3 +316,14 @@ export const getSafeClient = async <T extends EntryPoint>({
         }
     })
 }
+
+export const getEip7677Client = async <TEntryPoint extends EntryPoint>({
+    entryPoint
+}: { entryPoint: TEntryPoint }) => {
+    const client = createClient({
+        chain: foundry,
+        transport: http(PAYMASTER_RPC)
+    }).extend(paymasterActionsEip7677({ entryPoint }))
+
+    return client
+}

packages/permissionless/actions/smartAccount/sendTransaction.ts

@@ -6,12 +6,12 @@ import type {
     Transport
 } from "viem"
 import { getAction } from "viem/utils"
-import { type SmartAccount } from "../../accounts/types"
+import type { SmartAccount } from "../../accounts/types"
 import type { Prettify } from "../../types/"
 import type { EntryPoint } from "../../types/entrypoint"
 import { AccountOrClientNotFoundError, parseAccount } from "../../utils/"
 import { waitForUserOperationReceipt } from "../bundler/waitForUserOperationReceipt"
-import { type Middleware } from "./prepareUserOperationRequest"
+import type { Middleware } from "./prepareUserOperationRequest"
 import { sendUserOperation } from "./sendUserOperation"
 
 export type SendTransactionWithPaymasterParameters<

packages/permissionless/actions/smartAccount/sendTransactions.ts

@@ -8,12 +8,12 @@ import type {
     Transport
 } from "viem"
 import { getAction } from "viem/utils"
-import { type SmartAccount } from "../../accounts/types"
+import type { SmartAccount } from "../../accounts/types"
 import type { GetAccountParameter, Prettify } from "../../types/"
 import type { EntryPoint } from "../../types/entrypoint"
 import { AccountOrClientNotFoundError, parseAccount } from "../../utils/"
 import { waitForUserOperationReceipt } from "../bundler/waitForUserOperationReceipt"
-import { type Middleware } from "./prepareUserOperationRequest"
+import type { Middleware } from "./prepareUserOperationRequest"
 import { sendUserOperation } from "./sendUserOperation"
 
 export type SendTransactionsWithPaymasterParameters<

packages/permissionless/actions/smartAccount/writeContract.ts

@@ -11,9 +11,9 @@ import {
     encodeFunctionData
 } from "viem"
 import { getAction } from "viem/utils"
-import { type SmartAccount } from "../../accounts/types"
+import type { SmartAccount } from "../../accounts/types"
 import type { EntryPoint } from "../../types/entrypoint"
-import { type Middleware } from "./prepareUserOperationRequest"
+import type { Middleware } from "./prepareUserOperationRequest"
 import {
     type SendTransactionWithPaymasterParameters,
     sendTransaction

packages/permissionless/clients/decorators/smartAccount.ts

@@ -300,7 +300,7 @@ export type SmartAccountActions<
                 TChainOverride
             >
         >
-    ) => ReturnType<typeof deployContract<entryPoint, TChain, TSmartAccount>>
+    ) => Promise<Hash>
     /**
      * Executes a write function on a contract.
      * This function also allows you to sponsor this transaction if sender is a smartAccount

packages/permissionless/errors/sendUserOperation.ts

@@ -1,5 +1,5 @@
 import { BaseError } from "viem"
-import { type SendUserOperationParameters } from "../actions/bundler/sendUserOperation"
+import type { SendUserOperationParameters } from "../actions/bundler/sendUserOperation"
 import type { EntryPoint } from "../types/entrypoint"
 import { prettyPrint } from "./utils"
 

packages/permissionless/experimental/eip7677/actions/getPaymasterData.ts

@@ -0,0 +1,122 @@
+import {
+    type Chain,
+    ChainNotFoundError,
+    type Client,
+    type GetChainParameter,
+    type Hex,
+    type Transport,
+    toHex
+} from "viem"
+import type {
+    ENTRYPOINT_ADDRESS_V06_TYPE,
+    ENTRYPOINT_ADDRESS_V07_TYPE,
+    EntryPoint,
+    GetEntryPointVersion
+} from "../../../types/entrypoint"
+import type {
+    UserOperation,
+    UserOperationWithBigIntAsHex
+} from "../../../types/userOperation"
+import { deepHexlify, getEntryPointVersion } from "../../../utils"
+import type {
+    Eip7677RpcSchema,
+    GetRpcPaymasterDataReturnType
+} from "../types/paymaster"
+
+export type GetPaymasterDataParameters<
+    TEntryPoint extends EntryPoint,
+    TChain extends Chain | undefined = Chain | undefined,
+    TChainOverride extends Chain | undefined = Chain | undefined
+> = {
+    userOperation: UserOperation<GetEntryPointVersion<TEntryPoint>>
+    entryPoint: TEntryPoint
+    context?: Record<string, unknown>
+} & GetChainParameter<TChain, TChainOverride>
+
+export type GetPaymasterDataReturnType<TEntryPoint extends EntryPoint> =
+    GetEntryPointVersion<TEntryPoint> extends "v0.6"
+        ? {
+              paymasterAndData: Hex
+          }
+        : {
+              paymaster: Hex
+              paymasterData: Hex
+          }
+
+export async function getPaymasterData<
+    TEntryPoint extends EntryPoint,
+    TChain extends Chain | undefined,
+    TTransport extends Transport = Transport,
+    TChainOverride extends Chain | undefined = Chain | undefined
+>(
+    client: Client<
+        TTransport,
+        TChain,
+        undefined,
+        Eip7677RpcSchema<TEntryPoint>
+    >,
+    {
+        userOperation,
+        entryPoint,
+        context,
+        chain
+    }: GetPaymasterDataParameters<TEntryPoint, TChain, TChainOverride>
+): Promise<GetPaymasterDataReturnType<TEntryPoint>> {
+    const chainId = chain?.id ?? client.chain?.id
+
+    if (!chainId) {
+        throw new ChainNotFoundError()
+    }
+
+    const params:
+        | [
+              UserOperationWithBigIntAsHex<GetEntryPointVersion<TEntryPoint>>,
+              TEntryPoint,
+              Hex,
+              Record<string, unknown>
+          ]
+        | [
+              UserOperationWithBigIntAsHex<GetEntryPointVersion<TEntryPoint>>,
+              TEntryPoint,
+              Hex
+          ] = context
+        ? [
+              deepHexlify(userOperation) as UserOperationWithBigIntAsHex<
+                  GetEntryPointVersion<TEntryPoint>
+              >,
+              entryPoint,
+              toHex(chainId),
+              context
+          ]
+        : [
+              deepHexlify(userOperation) as UserOperationWithBigIntAsHex<
+                  GetEntryPointVersion<TEntryPoint>
+              >,
+              entryPoint,
+              toHex(chainId)
+          ]
+
+    const response = await client.request({
+        method: "pm_getPaymasterData",
+        params
+    })
+
+    const entryPointVersion = getEntryPointVersion(entryPoint)
+
+    if (entryPointVersion === "v0.6") {
+        const responseV06 =
+            response as GetRpcPaymasterDataReturnType<ENTRYPOINT_ADDRESS_V06_TYPE>
+
+        return {
+            paymasterAndData: responseV06.paymasterAndData
+        } as GetPaymasterDataReturnType<TEntryPoint>
+    }
+
+    const responseV07 =
+        response as GetRpcPaymasterDataReturnType<ENTRYPOINT_ADDRESS_V07_TYPE>
+
+    return {
+        paymaster: responseV07.paymaster,
+        paymasterData: responseV07.paymasterData
+    } as GetPaymasterDataReturnType<TEntryPoint>
+}