TokenPaymaster (BASE_USDC, CELO_USD, LISK_LSK)

0xFirekeeper · 0xFirekeeper · commit 94da14646cce · 2024-12-06T02:31:36.000+07:00
diff --git a/packages/thirdweb/src/wallets/smart/index.ts b/packages/thirdweb/src/wallets/smart/index.ts
@@ -22,7 +22,6 @@ import type { PreparedTransaction } from "../../transaction/prepare-transaction.
 import { readContract } from "../../transaction/read-contract.js";
 import { getAddress } from "../../utils/address.js";
 import { isZkSyncChain } from "../../utils/any-evm/zksync/isZkSyncChain.js";
-import { concatHex } from "../../utils/encoding/helpers/concat-hex.js";
 import type { Hex } from "../../utils/encoding/hex.js";
 import { parseTypedData } from "../../utils/signatures/helpers/parseTypedData.js";
 import type {
@@ -45,7 +44,11 @@ import {
   prepareBatchExecute,
   prepareExecute,
 } from "./lib/calls.js";
-import { getDefaultAccountFactory } from "./lib/constants.js";
+import {
+  ENTRYPOINT_ADDRESS_v0_6,
+  getDefaultAccountFactory,
+  getEntryPointVersion,
+} from "./lib/constants.js";
 import {
   clearAccountDeploying,
   createUnsignedUserOp,
@@ -58,6 +61,7 @@ import type {
   SmartAccountOptions,
   SmartWalletConnectionOptions,
   SmartWalletOptions,
+  TokenPaymasterConfig,
   UserOperationV06,
   UserOperationV07,
 } from "./types.js";
@@ -196,12 +200,50 @@ export async function disconnectSmartWallet(
 async function createSmartAccount(
   options: SmartAccountOptions,
 ): Promise<Account> {
+  let erc20Paymaster = options.overrides?.tokenPaymaster;
+  if (erc20Paymaster && typeof erc20Paymaster === "string") {
+    if (
+      getEntryPointVersion(
+        options.overrides?.entrypointAddress || ENTRYPOINT_ADDRESS_v0_6,
+      ) !== "v0.7"
+    ) {
+      throw new Error(
+        "Token paymaster is only supported for entrypoint version v0.7",
+      );
+    }
+    switch (erc20Paymaster) {
+      case "BASE_USDC":
+        erc20Paymaster = {
+          chainId: 8453,
+          paymasterAddress: "0x2222f2738BE6bB7aA0Bfe4AEeAf2908172CF5539",
+          tokenAddress: "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913",
+          balanceStorageSlot: 9,
+        };
+        break;
+      case "CELO_CUSD":
+        erc20Paymaster = {
+          chainId: 42220,
+          paymasterAddress: "0x3feA3c5744D715ff46e91C4e5C9a94426DfF2aF9",
+          tokenAddress: "0x765DE816845861e75A25fCA122bb6898B8B1282a",
+          balanceStorageSlot: 9,
+        };
+        break;
+      case "LISK_LSK":
+        erc20Paymaster = {
+          chainId: 1135,
+          paymasterAddress: "0x9eb8cf7fBa5ed9EeDCC97a0d52254cc0e9B1AC25",
+          tokenAddress: "0xac485391EB2d7D88253a7F1eF18C37f4242D1A24",
+          balanceStorageSlot: 9,
+        };
+        break;
+    }
+  }
+
   const { accountContract } = options;
   const account: Account = {
     address: getAddress(accountContract.address),
     async sendTransaction(transaction: SendTransactionOption) {
       // if erc20 paymaster - check allowance and approve if needed
-      const erc20Paymaster = options.overrides?.erc20Paymaster;
       let paymasterOverride:
         | undefined
         | ((
@@ -215,12 +257,7 @@ async function createSmartAccount(
         });
         const paymasterCallback = async (): Promise<PaymasterResult> => {
           return {
-            paymasterAndData: concatHex([
-              erc20Paymaster.address as Hex,
-              erc20Paymaster?.token as Hex,
-            ]),
-            // for 0.7 compatibility
-            paymaster: erc20Paymaster.address as Hex,
+            paymaster: erc20Paymaster.paymasterAddress as Hex,
             paymasterData: "0x",
           };
         };
@@ -436,13 +473,10 @@ async function createSmartAccount(
 async function approveERC20(args: {
   accountContract: ThirdwebContract;
   options: SmartAccountOptions;
-  erc20Paymaster: {
-    address: string;
-    token: string;
-  };
+  erc20Paymaster: TokenPaymasterConfig;
 }) {
   const { accountContract, erc20Paymaster, options } = args;
-  const tokenAddress = erc20Paymaster.token;
+  const tokenAddress = erc20Paymaster.tokenAddress;
   const tokenContract = getContract({
     address: tokenAddress,
     chain: accountContract.chain,
@@ -451,7 +485,7 @@ async function approveERC20(args: {
   const accountAllowance = await allowance({
     contract: tokenContract,
     owner: accountContract.address,
-    spender: erc20Paymaster.address,
+    spender: erc20Paymaster.paymasterAddress,
   });
 
   if (accountAllowance > 0n) {
@@ -460,7 +494,7 @@ async function approveERC20(args: {
 
   const approveTx = approve({
     contract: tokenContract,
-    spender: erc20Paymaster.address,
+    spender: erc20Paymaster.paymasterAddress,
     amountWei: maxUint96 - 1n,
   });
   const transaction = await toSerializableTransaction({
@@ -478,7 +512,7 @@ async function approveERC20(args: {
       ...options,
       overrides: {
         ...options.overrides,
-        erc20Paymaster: undefined,
+        tokenPaymaster: undefined,
       },
     },
   });
diff --git a/packages/thirdweb/src/wallets/smart/lib/bundler.ts b/packages/thirdweb/src/wallets/smart/lib/bundler.ts
@@ -67,16 +67,21 @@ export async function bundleUserOp(args: {
  * ```
  * @walletUtils
  */
-export async function estimateUserOpGas(args: {
-  userOp: UserOperationV06 | UserOperationV07;
-  options: BundlerOptions;
-}): Promise<EstimationResult> {
+export async function estimateUserOpGas(
+  args: {
+    userOp: UserOperationV06 | UserOperationV07;
+    options: BundlerOptions;
+  },
+  // biome-ignore lint/suspicious/noExplicitAny: <explanation>
+  stateOverrides?: any,
+): Promise<EstimationResult> {
   const res = await sendBundlerRequest({
     ...args,
     operation: "eth_estimateUserOperationGas",
     params: [
       hexlifyUserOp(args.userOp),
       args.options.entrypointAddress ?? ENTRYPOINT_ADDRESS_v0_6,
+      stateOverrides,
     ],
   });
 
diff --git a/packages/thirdweb/src/wallets/smart/lib/userop.ts b/packages/thirdweb/src/wallets/smart/lib/userop.ts
@@ -1,4 +1,4 @@
-import { concat } from "viem";
+import { concat, encodePacked, keccak256, toBytes, toHex } from "viem";
 import type { Chain } from "../../../chains/types.js";
 import type { ThirdwebClient } from "../../../client/client.js";
 import {
@@ -23,6 +23,7 @@ import type {
   BundlerOptions,
   PaymasterResult,
   SmartWalletOptions,
+  TokenPaymasterConfig,
   UserOperationV06,
   UserOperationV07,
 } from "../types.js";
@@ -361,15 +362,41 @@ async function populateUserOp_v0_7(args: {
         paymasterResult.paymasterVerificationGasLimit;
     } else {
       // otherwise fallback to bundler for gas limits
-      const estimates = await estimateUserOpGas({
-        userOp: partialOp,
-        options: bundlerOptions,
-      });
+      const stateOverrides = overrides?.tokenPaymaster
+        ? {
+            [(overrides.tokenPaymaster as TokenPaymasterConfig).tokenAddress]: {
+              stateDiff: {
+                [keccak256(
+                  encodePacked(
+                    ["address", "uint256"],
+                    [
+                      accountContract.address,
+                      BigInt(
+                        (overrides?.tokenPaymaster as TokenPaymasterConfig)
+                          .balanceStorageSlot,
+                      ),
+                    ],
+                  ),
+                )]: toBytes(toHex(BigInt(2) * BigInt(96) - BigInt(1)), {
+                  size: 32,
+                }),
+              },
+            },
+          }
+        : {};
+      const estimates = await estimateUserOpGas(
+        {
+          userOp: partialOp,
+          options: bundlerOptions,
+        },
+        stateOverrides,
+      );
       partialOp.callGasLimit = estimates.callGasLimit;
       partialOp.verificationGasLimit = estimates.verificationGasLimit;
       partialOp.preVerificationGas = estimates.preVerificationGas;
-      partialOp.paymasterPostOpGasLimit =
-        paymasterResult.paymasterPostOpGasLimit || 0n;
+      partialOp.paymasterPostOpGasLimit = overrides?.tokenPaymaster
+        ? 500_000n
+        : paymasterResult.paymasterPostOpGasLimit || 0n;
       partialOp.paymasterVerificationGasLimit =
         paymasterResult.paymasterVerificationGasLimit || 0n;
       // need paymaster to re-sign after estimates
diff --git a/packages/thirdweb/src/wallets/smart/smart-wallet-tokenpaymaster.test.ts b/packages/thirdweb/src/wallets/smart/smart-wallet-tokenpaymaster.test.ts
@@ -0,0 +1,63 @@
+import { base } from "src/chains/chain-definitions/base.js";
+import { sendTransaction } from "src/transaction/actions/send-transaction.js";
+import { prepareTransaction } from "src/transaction/prepare-transaction.js";
+import { beforeAll, describe, expect, it } from "vitest";
+import { TEST_CLIENT } from "../../../test/src/test-clients.js";
+import { setThirdwebDomains } from "../../utils/domains.js";
+import type { Account } from "../interfaces/wallet.js";
+import { privateKeyToAccount } from "../private-key.js";
+import { smartWallet } from "./smart-wallet.js";
+
+let personalAccount: Account;
+
+const client = TEST_CLIENT;
+
+describe.runIf(process.env.TW_SECRET_KEY).skip.sequential(
+  "SmartWallet policy tests",
+  {
+    retry: 0,
+    timeout: 240_000,
+  },
+  () => {
+    beforeAll(async () => {
+      setThirdwebDomains({
+        rpc: "rpc.thirdweb-dev.com",
+        storage: "storage.thirdweb-dev.com",
+        bundler: "bundler.thirdweb-dev.com",
+      });
+      personalAccount = await privateKeyToAccount({
+        client,
+        privateKey:
+          "edf401e8ddbb743f3353b055081cb220ce4c5c04e08da162d86e0dba7c6f0f01", // 0xa470E7c88611364f55B2d7912613e10AF2eA918D
+      });
+    });
+
+    it("can self transfer with BASE_USDC", async () => {
+      const wallet = smartWallet({
+        chain: base,
+        gasless: true,
+        overrides: {
+          tokenPaymaster: "BASE_USDC",
+        },
+      });
+      const smartAccount = await wallet.connect({
+        client: TEST_CLIENT,
+        personalAccount,
+      });
+
+      console.log("smartAccount", smartAccount.address);
+
+      const tx = prepareTransaction({
+        client,
+        chain: base,
+        to: smartAccount.address,
+        value: 0n,
+      });
+      const receipt = await sendTransaction({
+        transaction: tx,
+        account: smartAccount,
+      });
+      expect(receipt.transactionHash).toBeDefined();
+    });
+  },
+);
diff --git a/packages/thirdweb/src/wallets/smart/smart-wallet.ts b/packages/thirdweb/src/wallets/smart/smart-wallet.ts
@@ -118,7 +118,7 @@ import { getDefaultAccountFactory } from "./lib/constants.js";
  *    accountAddress: "0x...", // override account address
  *    accountSalt: "0x...", // override account salt
  *    entrypointAddress: "0x...", // override entrypoint address
- *    erc20Paymaster: { ... }, // enable erc20 paymaster
+ *    erc20Paymaster: "BASE_USDC", // enable erc20 paymaster
  *    bundlerUrl: "https://...", // override bundler url
  *    paymaster: (userOp) => { ... }, // override paymaster
  *    ...
diff --git a/packages/thirdweb/src/wallets/smart/types.ts b/packages/thirdweb/src/wallets/smart/types.ts
@@ -8,6 +8,13 @@ import type { Hex } from "../../utils/encoding/hex.js";
 import type { Prettify } from "../../utils/type-utils.js";
 import type { Account, SendTransactionOption } from "../interfaces/wallet.js";
 
+export type TokenPaymasterConfig = {
+  chainId: number;
+  paymasterAddress: string;
+  tokenAddress: string;
+  balanceStorageSlot: number;
+};
+
 export type SmartWalletOptions = Prettify<
   {
     chain: Chain; // TODO consider making default chain optional
@@ -17,24 +24,25 @@ export type SmartWalletOptions = Prettify<
       accountAddress?: string;
       accountSalt?: string;
       entrypointAddress?: string;
-      erc20Paymaster?: {
-        address: string;
-        token: string;
-      };
+      tokenPaymaster?:
+        | "BASE_USDC"
+        | "CELO_CUSD"
+        | "LISK_LSK"
+        | TokenPaymasterConfig;
       paymaster?: (
-        userOp: UserOperationV06 | UserOperationV07,
+        userOp: UserOperationV06 | UserOperationV07
       ) => Promise<PaymasterResult>;
       predictAddress?: (factoryContract: ThirdwebContract) => Promise<string>;
       createAccount?: (
-        factoryContract: ThirdwebContract,
+        factoryContract: ThirdwebContract
       ) => PreparedTransaction;
       execute?: (
         accountContract: ThirdwebContract,
-        transaction: SendTransactionOption,
+        transaction: SendTransactionOption
       ) => PreparedTransaction;
       executeBatch?: (
         accountContract: ThirdwebContract,
-        transactions: SendTransactionOption[],
+        transactions: SendTransactionOption[]
       ) => PreparedTransaction;
       getAccountNonce?: (accountContract: ThirdwebContract) => Promise<bigint>;
     };
@@ -204,7 +212,7 @@ export type UserOperationReceipt = {
 };
 
 export function formatUserOperationReceipt(
-  userOpReceiptRaw: UserOperationReceipt,
+  userOpReceiptRaw: UserOperationReceipt
 ) {
   const { receipt: transactionReceipt } = userOpReceiptRaw;
 
