TokenPaymaster (BASE_USDC, CELO_USD, LISK_LSK) (#5634)

Co-authored-by: 0xFirekeeper <[email protected]>

Author: joaquim-verges

.changeset/tiny-pugs-hunt.md

@@ -0,0 +1,20 @@
+---
+"thirdweb": minor
+---
+
+ERC20 Token Paymaster support
+
+You can now use ERC20 Token Paymasters with Smart Wallets.
+
+```typescript
+import { base } from "thirdweb/chains";
+import { TokenPaymaster, smartWallet } from "thirdweb/wallets";
+
+const wallet = smartWallet({
+  chain: base,
+  sponsorGas: true, // only sponsor gas for the first ERC20 approval
+  overrides: {
+    tokenPaymaster: TokenPaymaster.BASE_USDC,
+  },
+});
+```

packages/thirdweb/src/exports/wallets/smart.ts

@@ -35,4 +35,5 @@ export {
   ENTRYPOINT_ADDRESS_v0_7,
   DEFAULT_ACCOUNT_FACTORY_V0_6,
   DEFAULT_ACCOUNT_FACTORY_V0_7,
+  TokenPaymaster,
 } from "../../wallets/smart/lib/constants.js";

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,12 @@ import {
   prepareBatchExecute,
   prepareExecute,
 } from "./lib/calls.js";
-import { getDefaultAccountFactory } from "./lib/constants.js";
+import {
+  ENTRYPOINT_ADDRESS_v0_6,
+  ENTRYPOINT_ADDRESS_v0_7,
+  getDefaultAccountFactory,
+  getEntryPointVersion,
+} from "./lib/constants.js";
 import {
   clearAccountDeploying,
   createUnsignedUserOp,
@@ -58,6 +62,7 @@ import type {
   SmartAccountOptions,
   SmartWalletConnectionOptions,
   SmartWalletOptions,
+  TokenPaymasterConfig,
   UserOperationV06,
   UserOperationV07,
 } from "./types.js";
@@ -116,6 +121,17 @@ export async function connectSmartWallet(
     }
   }
 
+  if (
+    options.overrides?.tokenPaymaster &&
+    !options.overrides?.entrypointAddress
+  ) {
+    // if token paymaster is set, but no entrypoint address, set the entrypoint address to v0.7
+    options.overrides = {
+      ...options.overrides,
+      entrypointAddress: ENTRYPOINT_ADDRESS_v0_7,
+    };
+  }
+
   const factoryAddress =
     options.factoryAddress ??
     getDefaultAccountFactory(options.overrides?.entrypointAddress);
@@ -196,12 +212,24 @@ export async function disconnectSmartWallet(
 async function createSmartAccount(
   options: SmartAccountOptions,
 ): Promise<Account> {
+  const erc20Paymaster = options.overrides?.tokenPaymaster;
+  if (erc20Paymaster) {
+    if (
+      getEntryPointVersion(
+        options.overrides?.entrypointAddress || ENTRYPOINT_ADDRESS_v0_6,
+      ) !== "v0.7"
+    ) {
+      throw new Error(
+        "Token paymaster is only supported for entrypoint version v0.7",
+      );
+    }
+  }
+
   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 +243,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 +459,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 +471,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 +480,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 +498,7 @@ async function approveERC20(args: {
       ...options,
       overrides: {
         ...options.overrides,
-        erc20Paymaster: undefined,
+        tokenPaymaster: undefined,
       },
     },
   });

packages/thirdweb/src/wallets/smart/lib/bundler.ts

@@ -67,16 +67,26 @@ 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;
+  },
+  stateOverrides?: {
+    [x: string]: {
+      stateDiff: {
+        [x: string]: `0x${string}`;
+      };
+    };
+  },
+): Promise<EstimationResult> {
   const res = await sendBundlerRequest({
     ...args,
     operation: "eth_estimateUserOperationGas",
     params: [
       hexlifyUserOp(args.userOp),
       args.options.entrypointAddress ?? ENTRYPOINT_ADDRESS_v0_6,
+      stateOverrides,
     ],
   });
 

packages/thirdweb/src/wallets/smart/lib/constants.ts

@@ -1,6 +1,7 @@
 import type { Chain } from "../../../chains/types.js";
 import { getAddress } from "../../../utils/address.js";
 import { getThirdwebDomains } from "../../../utils/domains.js";
+import type { TokenPaymasterConfig } from "../types.js";
 
 export const DUMMY_SIGNATURE =
   "0xfffffffffffffffffffffffffffffff0000000000000000000000000000000007aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1c";
@@ -17,6 +18,28 @@ export const ENTRYPOINT_ADDRESS_v0_7 =
 
 export const MANAGED_ACCOUNT_GAS_BUFFER = 50000n;
 
+type PAYMASTERS = "BASE_USDC" | "CELO_CUSD" | "LISK_LSK";
+export const TokenPaymaster: Record<PAYMASTERS, TokenPaymasterConfig> = {
+  BASE_USDC: {
+    chainId: 8453,
+    paymasterAddress: "0x2222f2738BE6bB7aA0Bfe4AEeAf2908172CF5539",
+    tokenAddress: "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913",
+    balanceStorageSlot: 9n,
+  },
+  CELO_CUSD: {
+    chainId: 42220,
+    paymasterAddress: "0x3feA3c5744D715ff46e91C4e5C9a94426DfF2aF9",
+    tokenAddress: "0x765DE816845861e75A25fCA122bb6898B8B1282a",
+    balanceStorageSlot: 9n,
+  },
+  LISK_LSK: {
+    chainId: 1135,
+    paymasterAddress: "0x9eb8cf7fBa5ed9EeDCC97a0d52254cc0e9B1AC25",
+    tokenAddress: "0xac485391EB2d7D88253a7F1eF18C37f4242D1A24",
+    balanceStorageSlot: 9n,
+  },
+};
+
 /*
  * @internal
  */

packages/thirdweb/src/wallets/smart/lib/userop.ts

@@ -1,4 +1,5 @@
-import { concat } from "viem";
+import { maxUint96 } from "ox/Solidity";
+import { concat, keccak256, toHex } from "viem";
 import type { Chain } from "../../../chains/types.js";
 import type { ThirdwebClient } from "../../../client/client.js";
 import {
@@ -13,6 +14,7 @@ import { encode } from "../../../transaction/actions/encode.js";
 import { toSerializableTransaction } from "../../../transaction/actions/to-serializable-transaction.js";
 import type { PreparedTransaction } from "../../../transaction/prepare-transaction.js";
 import type { TransactionReceipt } from "../../../transaction/types.js";
+import { encodeAbiParameters } from "../../../utils/abi/encodeAbiParameters.js";
 import { isContractDeployed } from "../../../utils/bytecode/is-contract-deployed.js";
 import type { Hex } from "../../../utils/encoding/hex.js";
 import { hexToBytes } from "../../../utils/encoding/to-bytes.js";
@@ -361,17 +363,38 @@ 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.tokenAddress]: {
+              stateDiff: {
+                [keccak256(
+                  encodeAbiParameters(
+                    [{ type: "address" }, { type: "uint256" }],
+                    [
+                      accountContract.address,
+                      overrides.tokenPaymaster.balanceStorageSlot,
+                    ],
+                  ),
+                )]: toHex(maxUint96, { size: 32 }),
+              },
+            },
+          }
+        : undefined;
+      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
+        ? 500000n // TODO: estimate this better, needed if there's an extra swap needed in the paymaster
+        : estimates.paymasterPostOpGasLimit || 0n;
       partialOp.paymasterVerificationGasLimit =
-        paymasterResult.paymasterVerificationGasLimit || 0n;
+        estimates.paymasterVerificationGasLimit || 0n;
       // need paymaster to re-sign after estimates
       const paymasterResult2 = (await getPaymasterAndData({
         userOp: partialOp,