Merge pull request #1 from gelatodigital/feat/bundler/implementation

feat: bundler

Author: bennoprice

.changeset/config.json

@@ -5,7 +5,7 @@
   "changelog": "@changesets/cli/changelog",
   "commit": false,
   "fixed": [],
-  "ignore": [],
+  "ignore": ["bundler-sponsored-payment", "bundler-erc20-payment"],
   "linked": [],
   "updateInternalDependencies": "patch"
 }

biome.json

@@ -80,7 +80,7 @@
           "options": {
             "patterns": [
               {
-                "group": ["**/dist/**"],
+                "group": ["**/dist/**", "**/_dist/**"],
                 "message": "Direct imports from 'dist' folders are disallowed. Import from the package root instead."
               }
             ]
@@ -153,7 +153,7 @@
       }
     },
     {
-      "includes": ["scripts/**/*"],
+      "includes": ["scripts/**/*", "examples/**/*"],
       "linter": {
         "rules": {
           "style": {

examples/bundler/sponsored/.env.example

@@ -0,0 +1,2 @@
+GELATO_API_KEY="Get your api key at https://app.gelato.cloud/"
+PRIVATE_KEY="0x<PRIVATE_KEY>" # Optional

examples/bundler/sponsored/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "bundler-sponsored-payment",
+  "private": true,
+  "version": "0.0.1",
+  "scripts": {
+    "dev": "tsx src/index.ts"
+  },
+  "dependencies": {
+    "@gelatonetwork/ferry-sdk": "workspace:*",
+    "permissionless": "catalog:",
+    "viem": "catalog:"
+  },
+  "devDependencies": {
+    "@types/node": "latest",
+    "dotenv": "^17.2.3",
+    "tsx": "^4.21.0",
+    "typescript": "catalog:"
+  }
+}

examples/bundler/sponsored/src/index.ts

@@ -0,0 +1,60 @@
+import { baseSepolia } from 'viem/chains';
+import 'dotenv/config';
+import { createGelatoBundlerClient, sponsored } from '@gelatonetwork/ferry-sdk';
+import { toKernelSmartAccount } from 'permissionless/accounts';
+import { createWalletClient, type Hex, http, publicActions } from 'viem';
+import { generatePrivateKey, privateKeyToAccount } from 'viem/accounts';
+
+const GELATO_API_KEY = process.env['GELATO_API_KEY'];
+const PRIVATE_KEY = process.env['PRIVATE_KEY'];
+
+if (!GELATO_API_KEY) {
+  throw new Error('GELATO_API_KEY is not set');
+}
+
+const chain = baseSepolia;
+
+const main = async () => {
+  const owner = privateKeyToAccount((PRIVATE_KEY ?? generatePrivateKey()) as Hex);
+
+  const client = createWalletClient({
+    account: owner,
+    chain,
+    transport: http()
+  }).extend(publicActions);
+
+  const account = await toKernelSmartAccount({
+    client,
+    owners: [owner],
+    version: '0.3.3'
+  });
+
+  const bundler = await createGelatoBundlerClient({
+    account,
+    apiKey: GELATO_API_KEY,
+    client,
+    payment: sponsored(),
+    pollingInterval: 100
+  });
+
+  const hash = await bundler.sendUserOperation({
+    calls: [
+      {
+        data: '0xd09de08a',
+        to: '0xE27C1359cf02B49acC6474311Bd79d1f10b1f8De'
+      }
+    ]
+  });
+
+  console.log('userOpHash:', hash);
+
+  const { receipt } = await bundler.waitForUserOperationReceipt({ hash });
+
+  console.log('transaction hash:', receipt.transactionHash);
+  process.exit(0);
+};
+
+main().catch((error) => {
+  console.error(error);
+  process.exit(1);
+});

examples/bundler/sponsored/tsconfig.json

@@ -0,0 +1,3 @@
+{
+  "extends": "../../../tsconfig.json"
+}

pnpm-lock.yaml

@@ -3,6 +3,7 @@ packages:
   - src
 
 catalog:
+  permissionless: 0.3.2
   typescript: 5.9.3
   viem: 2.39.3
 

pnpm-workspace.yaml

@@ -0,0 +1,63 @@
+import type { BaseError, Chain, Client, Transport } from 'viem';
+import {
+  type EstimateUserOperationGasParameters,
+  type EstimateUserOperationGasReturnType,
+  formatUserOperationGas,
+  formatUserOperationRequest,
+  getUserOperationError,
+  type PrepareUserOperationParameters,
+  type SmartAccount,
+  type UserOperation
+} from 'viem/account-abstraction';
+import { parseAccount } from 'viem/accounts';
+import { AccountNotFoundError, type Payment } from '../../types/index.js';
+import { serializeStateOverride } from '../../utils/index.js';
+import type { Capabilities } from './getCapabilities.js';
+import { prepareUserOperation } from './prepareUserOperation.js';
+
+export const estimateUserOperationGas = async <account extends SmartAccount | undefined>(
+  client: Client<Transport, Chain | undefined, account>,
+  parameters: EstimateUserOperationGasParameters,
+  capabilities: Capabilities,
+  payment?: Payment
+): Promise<EstimateUserOperationGasReturnType> => {
+  const { account: account_ = client.account, entryPointAddress, stateOverride } = parameters;
+
+  if (!account_ && !parameters.sender) throw new AccountNotFoundError();
+  const account = account_ ? parseAccount(account_) : undefined;
+
+  const rpcStateOverride = serializeStateOverride(stateOverride);
+
+  const request = account
+    ? await prepareUserOperation(
+        client,
+        {
+          ...parameters,
+          parameters: ['authorization', 'factory', 'nonce', 'paymaster', 'signature']
+        } as unknown as PrepareUserOperationParameters,
+        capabilities,
+        payment
+      )
+    : parameters;
+
+  try {
+    const params = [
+      formatUserOperationRequest(request as UserOperation),
+      // biome-ignore lint/style/noNonNullAssertion: copied from viem
+      (entryPointAddress ?? account?.entryPoint?.address)!
+    ] as const;
+
+    const result = await client.request({
+      method: 'eth_estimateUserOperationGas',
+      params: rpcStateOverride ? [...params, rpcStateOverride] : [...params]
+    });
+    return formatUserOperationGas(result) as EstimateUserOperationGasReturnType<account>;
+  } catch (error) {
+    // biome-ignore lint/suspicious/noExplicitAny: copied from viem
+    const calls = (parameters as any).calls;
+    throw getUserOperationError(error as BaseError, {
+      ...(request as UserOperation),
+      ...(calls ? { calls } : {})
+    });
+  }
+};

src/bundler/actions/estimateUserOperationGas.ts

@@ -0,0 +1,14 @@
+import type { Address, Chain, Client, Transport } from 'viem';
+
+export type Capabilities = {
+  feeCollector: Address;
+};
+
+export const getCapabilities = async (client: Client<Transport, Chain>): Promise<Capabilities> => {
+  const capabilities = await client.request({
+    method: 'relayer_getCapabilities',
+    params: [client.chain.id.toString()]
+  } as never);
+
+  return capabilities[client.chain.id.toString()];
+};