@biconomy/bundler

Bundler

In the context of (ERC4337), A bundler plays a main role in the infrastructure. This concept is integral to the operation of account abstraction across any network that utilizes the Ethereum Virtual Machine (EVM).

Installation

Using npm package manager

npm i @biconomy/bundler

OR

Using yarn package manager

yarn add @biconomy/bundler

configuration

Key	Description
bundlerUrl	Represent ERC4337 spec implemented bundler url. you can get one from biconomy dashboard. Alternatively you can supply any of your preferred
chainId	This represents the network your smart wallet transactions will be conducted on. Take a look following Link for supported chain id's
entryPointAddress	Since entrypoint can have different addresses you can call getSupportedEntryPoints() on bundler instance for supported addresses list

// This is how you create bundler instance in your dapp's
import { IBundler, createBundler } from "@biconomy/bundler";

// Make use of core-types package
import { ChainId } from "@biconomy/core-types";

const bundler: IBundler = await createBundler({ bundlerUrl: "" }); // you can get this value from biconomy dashboard. https://dashboard.biconomy.io

Following are the methods that can be call on bundler instance

export interface IBundler {
  estimateUserOpGas(userOp: Partial<UserOperation>): Promise<UserOpGasResponse>;
  sendUserOp(userOp: UserOperation): Promise<UserOpResponse>;
  getUserOpReceipt(userOpHash: string): Promise<UserOpReceipt>;
  getUserOpByHash(userOpHash: string): Promise<UserOpByHashResponse>;
}

estimateUserOpGas Estimate the gas values for a UserOperation. Given UserOperation optionally without gas limits and gas prices, return the needed gas limits. The signature field is ignored by the wallet, so that the operation will not require user's approval. Still, it might require putting a "semi-valid" signature (e.g. a signature in the right length)

Return Values

preVerificationGas gas overhead of this UserOperation verificationGasLimit actual gas used by the validation of this UserOperation callGasLimit limit used to execute userop.callData called from EntryPoint to the Smart Account

              --------------------------------

sendUserOp it submits a User Operation object to the User Operation pool of the client. The client MUST validate the UserOperation, and return a result accordingly.

The result SHOULD be set to the userOpHash if and only if the request passed simulation and was accepted in the client's User Operation pool. If the validation, simulation, or User Operation pool inclusion fails, result SHOULD NOT be returned. Rather, the client SHOULD return the failure reason.

Return Values If the UserOperation is valid, the client MUST return the calculated userOpHash for it

              --------------------------------

getUserOpByHash Return a UserOperation based on a hash (userOpHash) returned by sendUserOp (eth_sendUserOperation)

Return Values

null in case the UserOperation is not yet included in a block, or a full UserOperation, with the addition of entryPoint, blockNumber, blockHash and transactionHash

              --------------------------------

getUserOpReceipt

Return a UserOperation receipt based on a hash (userOpHash) returned by eth_sendUserOperation

Return Values null in case the UserOperation is not yet included in a block, or:

userOpHash the request hash entryPoint sender nonce paymaster the paymaster used for this userOp (or empty) actualGasCost - actual amount paid (by account or paymaster) for this UserOperation actualGasUsed - total gas used by this UserOperation (including preVerification, creation, validation and execution) success boolean - did this execution completed without revert reason in case of revert, this is the revert reason logs the logs generated by this UserOperation (not including logs of other UserOperations in the same bundle) receipt the TransactionReceipt object. Note that the returned TransactionReceipt is for the entire bundle, not only for this UserOperation.

              --------------------------------

Changelog

4.1.0 (2023-04-03)

Features:

• Added Speed optimisation, removing redundant gasEstimate call to bundler (2371b2)
• Added smartAccount.getBalances() method (4b8bae)
• Added smartAccount.getSupportedTokens() method (6d2fb27)
• Added smartAccount.deploy() method (be9dc4)
• Increased checking of the chainId from the bundler, paymaster and the provider (5d2f3)
• Added entity name to Logger calls (9278ec)
• Export a 'getChain' by id helper, which returns a viem chain (ab2ba)
• Add "stateOverride" optional param (20fd54)

Fixes:

• Fix for encodeAbiParameters inside batched session module (b27061)
• added flag to skip calldata approval patch (75698)
• Fixed the particle auth build

Chores:

• Added tests for ecdsa module (1a8f29)
• Increased test coverage (329003)
• Improved issue reporting guidelines (8b9fb5d)
• Added e2e tests for optimism, ran from GH actions (5051ba)
• Added ABI SVM test (49c96)
• Added tests for batched session router testing (2eb9765)