AA-381: Create a "pull bundle" block building mode and a 'getRip7560Bundle' method

package.json

@@ -35,7 +35,7 @@
     "preprocess1": "yarn submodule-update && yarn && cd submodules/account-abstraction && yarn && yarn --cwd contracts prepack",
     "submodule-update": "git submodule update --remote --init --recursive",
     "runop-self": "ts-node ./packages/bundler/src/runner/runop.ts --deployFactory --selfBundler --unsafe",
-    "ci": "env && yarn depcheck && yarn preprocess ; yarn lerna-test"
+    "ci": "env && yarn depcheck && yarn preprocess && yarn lerna-test"
   },
   "dependencies": {
     "@typescript-eslint/eslint-plugin": "^5.33.0",

packages/bundler/localconfig/bundler.config.json

@@ -1,6 +1,7 @@
 {
   "gasFactor": "1",
   "port": "3000",
+  "privateApiPort": "3001",
   "network": "http://127.0.0.1:8545",
   "entryPoint": "0x0000000071727De22E5E9d8BAf0edAc6f37da032",
   "beneficiary": "0xd21934eD8eAf27a67f0A70042Af50A1D6d195E81",
@@ -10,5 +11,8 @@
   "minStake": "1" ,
   "minUnstakeDelay": 0 ,
   "autoBundleInterval": 3,
-  "autoBundleMempoolSize": 10
+  "autoBundleMempoolSize": 10,
+  "rip7560": false,
+  "rip7560Mode": "PULL",
+  "gethDevMode": true
 }

packages/bundler/localconfig/bundler.rip7560.config.json

@@ -1,6 +1,7 @@
 {
   "gasFactor": "1",
   "port": "3000",
+  "privateApiPort": "3001",
   "network": "http://127.0.0.1:8545",
   "entryPoint": "0x0000000071727De22E5E9d8BAf0edAc6f37da032",
   "beneficiary": "0xd21934eD8eAf27a67f0A70042Af50A1D6d195E81",
@@ -11,5 +12,7 @@
   "minUnstakeDelay": 0 ,
   "autoBundleInterval": 3,
   "autoBundleMempoolSize": 10,
-  "useRip7560Mode": true
+  "rip7560": true,
+  "rip7560Mode": "PULL",
+  "gethDevMode": true
 }

packages/bundler/package.json

@@ -28,6 +28,7 @@
     "@account-abstraction/sdk": "^0.7.0",
     "@account-abstraction/utils": "^0.7.0",
     "@account-abstraction/validation-manager": "^0.7.0",
+    "@ethereumjs/rlp": "^5.0.2",
     "@ethersproject/abi": "^5.7.0",
     "@ethersproject/providers": "^5.7.0",
     "@types/cors": "^2.8.12",

packages/bundler/src/BundlerConfig.ts

@@ -12,6 +12,7 @@ export interface BundlerConfig {
   mnemonic: string
   network: string
   port: string
+  privateApiPort: string
   unsafe: boolean
   debugRpc?: boolean
   conditionalRpc: boolean
@@ -23,7 +24,9 @@ export interface BundlerConfig {
   minUnstakeDelay: number
   autoBundleInterval: number
   autoBundleMempoolSize: number
-  useRip7560Mode: boolean
+  rip7560: boolean
+  rip7560Mode: string
+  gethDevMode: boolean
 }
 
 // TODO: implement merging config (args -> config.js -> default) and runtime shape validation
@@ -35,6 +38,7 @@ export const BundlerConfigShape = {
   mnemonic: ow.string,
   network: ow.string,
   port: ow.string,
+  privateApiPort: ow.string,
   unsafe: ow.boolean,
   debugRpc: ow.optional.boolean,
   conditionalRpc: ow.boolean,
@@ -46,17 +50,19 @@ export const BundlerConfigShape = {
   minUnstakeDelay: ow.number,
   autoBundleInterval: ow.number,
   autoBundleMempoolSize: ow.number,
-  useRip7560Mode: ow.boolean
+  rip7560: ow.boolean,
+  rip7560Mode: ow.string.oneOf(['PULL', 'PUSH']),
+  gethDevMode: ow.boolean
 }
 
 // TODO: consider if we want any default fields at all
 // TODO: implement merging config (args -> config.js -> default) and runtime shape validation
 export const bundlerConfigDefault: Partial<BundlerConfig> = {
   port: '3000',
+  privateApiPort: '3001',
   entryPoint: '0x0000000071727De22E5E9d8BAf0edAc6f37da032',
   unsafe: false,
   conditionalRpc: false,
-  useRip7560Mode: false,
   minStake: MIN_STAKE_VALUE,
   minUnstakeDelay: MIN_UNSTAKE_DELAY
 }

packages/bundler/src/BundlerServer.ts

@@ -1,18 +1,21 @@
 import bodyParser from 'body-parser'
 import cors from 'cors'
-import express, { Express, Response, Request } from 'express'
+import express, { Express, Response, Request, RequestHandler } from 'express'
 import { Provider } from '@ethersproject/providers'
 import { Signer, utils } from 'ethers'
 import { parseEther } from 'ethers/lib/utils'
 import { Server } from 'http'
 
 import {
-  AddressZero, decodeRevertReason,
-  deepHexlify, IEntryPoint__factory,
-  erc4337RuntimeVersion,
-  packUserOp,
+  AddressZero,
+  IEntryPoint__factory,
   RpcError,
-  UserOperation
+  UserOperation,
+  ValidationErrors,
+  decodeRevertReason,
+  deepHexlify,
+  erc4337RuntimeVersion,
+  packUserOp
 } from '@account-abstraction/utils'
 
 import { BundlerConfig } from './BundlerConfig'
@@ -23,9 +26,12 @@ import { DebugMethodHandler } from './DebugMethodHandler'
 import Debug from 'debug'
 
 const debug = Debug('aa.rpc')
+
 export class BundlerServer {
-  app: Express
-  private readonly httpServer: Server
+  readonly appPublic: Express
+  readonly appPrivate: Express
+  private readonly httpServerPublic: Server
+  private readonly httpServerPrivate: Server
   public silent = false
 
   constructor (
@@ -36,32 +42,42 @@ export class BundlerServer {
     readonly provider: Provider,
     readonly wallet: Signer
   ) {
-    this.app = express()
-    this.app.use(cors())
-    this.app.use(bodyParser.json())
-
-    this.app.get('/', this.intro.bind(this))
-    this.app.post('/', this.intro.bind(this))
-
+    this.appPublic = express()
+    this.appPrivate = express()
+    // eslint-disable-next-line @typescript-eslint/no-misused-promises
+    this.initializeExpressApp(this.appPublic, this.getRpc(this.handleRpcPublic.bind(this)))
     // eslint-disable-next-line @typescript-eslint/no-misused-promises
-    this.app.post('/rpc', this.rpc.bind(this))
+    this.initializeExpressApp(this.appPrivate, this.getRpc(this.handleRpcPrivate.bind(this)))
+
+    this.httpServerPublic = this.appPublic.listen(this.config.port)
+    this.httpServerPrivate = this.appPrivate.listen(this.config.privateApiPort)
 
-    this.httpServer = this.app.listen(this.config.port)
     this.startingPromise = this._preflightCheck()
   }
 
+  private initializeExpressApp (app: Express, handler: RequestHandler): void {
+    app.use(cors())
+    app.use(bodyParser.json())
+
+    app.get('/', this.intro.bind(this))
+    app.post('/', this.intro.bind(this))
+
+    app.post('/rpc', handler)
+  }
+
   startingPromise: Promise<void>
 
   async asyncStart (): Promise<void> {
     await this.startingPromise
   }
 
   async stop (): Promise<void> {
-    this.httpServer.close()
+    this.httpServerPublic.close()
+    this.httpServerPrivate.close()
   }
 
   async _preflightCheck (): Promise<void> {
-    if (this.config.useRip7560Mode) {
+    if (this.config.rip7560) {
       // TODO: implement preflight checks for the RIP-7560 mode
       return
     }
@@ -107,27 +123,70 @@ export class BundlerServer {
     res.send(`Account-Abstraction Bundler v.${erc4337RuntimeVersion}. please use "/rpc"`)
   }
 
-  async rpc (req: Request, res: Response): Promise<void> {
-    let resContent: any
-    if (Array.isArray(req.body)) {
-      resContent = []
-      for (const reqItem of req.body) {
-        resContent.push(await this.handleRpc(reqItem))
+  // TODO: I don't see how to elegantly combine express callbacks with classes so I ended up with this spaghetti.
+  //  This is temporary and probably should not be merged like that, we need to simplify the flow.
+  getRpc (handleRpc: any): any {
+    const rpc = async (req: Request, res: Response): Promise<void> => {
+      let resContent: any
+      if (Array.isArray(req.body)) {
+        resContent = []
+        for (const reqItem of req.body) {
+          resContent.push(await handleRpc(reqItem))
+        }
+      } else {
+        resContent = await handleRpc(req.body)
+      }
+
+      try {
+        res.send(resContent)
+      } catch (err: any) {
+        const error = {
+          message: err.message,
+          data: err.data,
+          code: err.code
+        }
+        this.log('failed: ', 'rpc::res.send()', 'error:', JSON.stringify(error))
       }
-    } else {
-      resContent = await this.handleRpc(req.body)
     }
+    return rpc.bind(this)
+  }
 
-    try {
-      res.send(resContent)
-    } catch (err: any) {
+  // TODO: deduplicate!
+  async handleRpcPublic (reqItem: any): Promise<any> {
+    const { method, jsonrpc, id } = reqItem
+
+    if (method === 'aa_getRip7560Bundle') {
       const error = {
-        message: err.message,
-        data: err.data,
-        code: err.code
+        message: `requested RPC method (${method as string}) is not available`,
+        data: '',
+        code: ValidationErrors.InvalidRequest
+      }
+      return {
+        jsonrpc,
+        id,
+        error
       }
-      this.log('failed: ', 'rpc::res.send()', 'error:', JSON.stringify(error))
     }
+    return await this.handleRpc(reqItem)
+  }
+
+  // TODO: deduplicate!
+  async handleRpcPrivate (reqItem: any): Promise<any> {
+    const { method, jsonrpc, id } = reqItem
+
+    if (method !== 'aa_getRip7560Bundle') {
+      const error = {
+        message: `requested RPC method (${method as string}) is not available`,
+        data: '',
+        code: ValidationErrors.InvalidRequest
+      }
+      return {
+        jsonrpc,
+        id,
+        error
+      }
+    }
+    return await this.handleRpc(reqItem)
   }
 
   async handleRpc (reqItem: any): Promise<any> {
@@ -172,18 +231,27 @@ export class BundlerServer {
     let result: any
     switch (method) {
       /** RIP-7560 specific RPC API */
+      case 'aa_getRip7560Bundle': {
+        if (!this.config.rip7560) {
+          throw new RpcError(`Method ${method} is not supported`, -32601)
+        }
+        const [bundle] = await this.methodHandlerRip7560.getRip7560Bundle(
+          params[0].MinBaseFee, params[0].MaxBundleGas, params[0].MaxBundleSize
+        )
+        // TODO: provide a correct value for 'validForBlock'
+        result = { bundle, validForBlock: '0x0' }
+        break
+      }
       case 'eth_sendTransaction':
-        if (!this.config.useRip7560Mode) {
+        if (!this.config.rip7560) {
           throw new RpcError(`Method ${method} is not supported`, -32601)
         }
         if (params[0].sender != null) {
           result = await this.methodHandlerRip7560.sendRIP7560Transaction(params[0])
-        // } else {
-        //   result = await (this.provider as JsonRpcProvider).send(method, params)
         }
         break
       case 'eth_getTransactionReceipt':
-        if (!this.config.useRip7560Mode) {
+        if (!this.config.rip7560) {
           throw new RpcError(`Method ${method} is not supported`, -32601)
         }
         result = await this.methodHandlerRip7560.getRIP7560TransactionReceipt(params[0])

packages/bundler/src/MethodHandlerRIP7560.ts

@@ -1,8 +1,11 @@
+import { BigNumberish } from 'ethers'
 import { JsonRpcProvider, TransactionReceipt } from '@ethersproject/providers'
 import {
   AddressZero,
-  getRIP7560TransactionHash,
+  OperationBase,
   OperationRIP7560,
+  StorageMap,
+  getRIP7560TransactionHash,
   requireCond,
   tostr
 } from '@account-abstraction/utils'
@@ -26,6 +29,14 @@ export class MethodHandlerRIP7560 {
     return getRIP7560TransactionHash(transaction)
   }
 
+  async getRip7560Bundle (
+    minBaseFee: BigNumberish,
+    maxBundleGas: BigNumberish,
+    maxBundleSize: BigNumberish
+  ): Promise<[OperationBase[], StorageMap]> {
+    return await this.execManager.createBundle(minBaseFee, maxBundleGas, maxBundleSize)
+  }
+
   async getRIP7560TransactionReceipt (txHash: string): Promise<RIP7560TransactionReceipt | null> {
     requireCond(txHash?.toString()?.match(HEX_REGEX) != null, 'Missing/invalid userOpHash', -32601)
     return await this.provider.getTransactionReceipt(txHash)