Add balanceOverride in prepareUserOperationForErc20Paymaster

pimlicolabs · Oct 22, 2024 · 08f2e76 · 08f2e76
1 parent fc63277
commit 08f2e76
Show file tree

Hide file tree

Showing 8 changed files with 128 additions and 3 deletions.
diff --git a/.changeset/long-walls-hang.md b/.changeset/long-walls-hang.md
@@ -0,0 +1,5 @@
+---
+"permissionless": patch
+---
+
+Added utils to create erc20 state overrides
diff --git a/bun.lockb b/bun.lockb
diff --git a/package.json b/package.json
@@ -29,7 +29,7 @@
         "get-port": "^7.0.0",
         "tsc-alias": "^1.8.8",
         "vitest": "^1.2.0",
-        "viem": "^2.21.2",
+        "viem": "2.21.22",
         "wagmi": "^2.12.8",
         "@permissionless/wagmi": "workspace:packages/wagmi",
         "@types/react": "^18.3.1",

diff --git a/packages/permissionless/actions/pimlico/getTokenQuotes.ts b/packages/permissionless/actions/pimlico/getTokenQuotes.ts
@@ -25,6 +25,8 @@ export type GetTokenQuotesReturnType = {
     postOpGas: bigint
     exchangeRate: bigint
     exchangeRateNativeToUsd: bigint
+    balanceSlot: bigint
+    approvalSlot: bigint
 }[]
 
 /**
@@ -62,6 +64,8 @@ export const getTokenQuotes = async <
 
     return res.quotes.map((quote) => ({
         ...quote,
+        balanceSlot: hexToBigInt(quote.balanceSlot),
+        approvalSlot: hexToBigInt(quote.approvalSlot),
         postOpGas: hexToBigInt(quote.postOpGas),
         exchangeRate: hexToBigInt(quote.exchangeRate),
         exchangeRateNativeToUsd: hexToBigInt(quote.exchangeRateNativeToUsd)

diff --git a/...s/permissionless/experimental/pimlico/utils/prepareUserOperationForErc20Paymaster.test.ts b/...s/permissionless/experimental/pimlico/utils/prepareUserOperationForErc20Paymaster.test.ts
@@ -191,5 +191,93 @@ describe.each(getCoreSmartAccounts())(
                 expect(FINAL_ETH_BALANCE).toEqual(INTIAL_ETH_BALANCE) // There should be no ETH balance change
             }
         )
+
+        testWithRpc.skipIf(!supportsEntryPointV07)(
+            "prepareUserOperationForErc20Paymaster_v07",
+            async ({ rpc }) => {
+                const { anvilRpc } = rpc
+
+                const account = (
+                    await getSmartAccountClient({
+                        entryPoint: {
+                            version: "0.7"
+                        },
+                        ...rpc
+                    })
+                ).account
+
+                const publicClient = getPublicClient(anvilRpc)
+
+                const pimlicoClient = createPimlicoClient({
+                    transport: http(rpc.paymasterRpc),
+                    entryPoint: {
+                        address: entryPoint07Address,
+                        version: "0.7"
+                    }
+                })
+
+                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: ERC20_ADDRESS
+                    }
+                })
+
+                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
+            }
+        )
     }
 )
diff --git a/packages/permissionless/experimental/pimlico/utils/prepareUserOperationForErc20Paymaster.ts b/packages/permissionless/experimental/pimlico/utils/prepareUserOperationForErc20Paymaster.ts
@@ -24,9 +24,17 @@ import { getChainId as getChainId_ } from "viem/actions"
 import { readContract } from "viem/actions"
 import { getAction, parseAccount } from "viem/utils"
 import { getTokenQuotes } from "../../../actions/pimlico"
+import { erc20ApprovalOverride, erc20BalanceOverride } from "../../../utils"
 
 export const prepareUserOperationForErc20Paymaster =
-    (pimlicoClient: Client) =>
+    (
+        pimlicoClient: Client,
+        {
+            balanceOverride = false
+        }: {
+            balanceOverride?: boolean
+        } = {}
+    ) =>
     async <
         account extends SmartAccount | undefined,
         const calls extends readonly unknown[],
@@ -98,6 +106,8 @@ export const prepareUserOperationForErc20Paymaster =
             const {
                 postOpGas,
                 exchangeRate,
+                balanceSlot,
+                approvalSlot,
                 paymaster: paymasterERC20Address
             } = quotes[0]
 
@@ -121,6 +131,22 @@ export const prepareUserOperationForErc20Paymaster =
             // Call prepareUserOperation
             ////////////////////////////////////////////////////////////////////////////////
 
+            parameters.stateOverride = balanceOverride
+                ? (parameters.stateOverride ?? []).concat(
+                      erc20ApprovalOverride({
+                          token,
+                          owner: account.address,
+                          spender: paymasterERC20Address,
+                          slot: approvalSlot
+                      }),
+                      erc20BalanceOverride({
+                          token,
+                          owner: account.address,
+                          slot: balanceSlot
+                      })
+                  )
+                : parameters.stateOverride
+
             const userOperation = await getAction(
                 client,
                 prepareUserOperation,

diff --git a/packages/permissionless/package.json b/packages/permissionless/package.json
@@ -71,6 +71,6 @@
         }
     },
     "peerDependencies": {
-        "viem": "^2.21.2"
+        "viem": "^2.21.22"
     }
 }
diff --git a/packages/permissionless/types/pimlico.ts b/packages/permissionless/types/pimlico.ts
@@ -35,6 +35,8 @@ type GetTokenQuotesWithBigIntAsHex = {
         postOpGas: Hex
         exchangeRate: Hex
         exchangeRateNativeToUsd: Hex
+        balanceSlot: Hex
+        approvalSlot: Hex
     }[]
 }