Bundler Package #163

talhamalik883 · 2023-05-10T08:00:06Z

This PR includes bundler package integration in modular sdk code

tomarsachin2271 · 2023-05-18T15:25:10Z

packages/bundler-rpc/package.json

Rename bundler-rpc to bundler.

Same goes for paymaster folder as well.

tomarsachin2271 · 2023-05-18T15:25:52Z

packages/bundler-rpc/package.json

+  "typings": "./dist/src/index.d.ts",
+  "keywords": [
+    "Ethereum",
+    "Gnosis",


Remove Gnosis keyword from this list. and add Bundler, Relayer, ERC4337, Gasless Transactions to the list.

tomarsachin2271 · 2023-05-18T15:26:29Z

packages/bundler-rpc/package.json

+{
+  "name": "@biconomy/bundler-rpc",
+  "version": "2.0.0",
+  "description": "Biconomy Bundler Rpc to interact with any bundler",


Description should be

Biconomy Bundler package to interact with any bundler node as per ERC4337 standard.

tomarsachin2271 · 2023-05-18T15:27:53Z

packages/bundler-rpc/src/Bundler.ts

+
+export class Bundler implements IBundler {
+
+    constructor(readonly bundlerUrl: string,


Convert the constructor params to a single object and add these parameters as property of that object.

Check all other constructors and do the same changes there.

tomarsachin2271 · 2023-05-18T15:30:14Z

packages/bundler-rpc/src/Bundler.ts

+import { deepHexlify } from '@biconomy/common'
+import { HttpMethod, sendRequest } from './utils/httpRequests'
+
+export class Bundler implements IBundler {


Add class level comments.

This class implements IBundler interface. Implementation sends UserOperation to a bundler URL as per ERC4337 standard. Checkout the proposal for more details on Bundlers.

tomarsachin2271 · 2023-05-18T15:36:47Z

packages/bundler-rpc/src/Bundler.ts

+     * @description This function will fetch gasPrices from bundler
+     * @returns 
+     */
+    async getUserOpGasPrices(chainId: ChainId): Promise<getUserOpGasPricesResponse> {


This rpc method name should be

eth_getUserOpGasFields

as it return fields related to gas limit and gas price both.

Similarly method name should be getUserOpGasFields

tomarsachin2271 · 2023-05-18T15:37:07Z

packages/bundler-rpc/src/Bundler.ts

+        return response
+    }
+    /**
+     * 


Method level comment can be a bit more descriptive. Add the return type and description about what its doing with dappAPIKey.

have removed the dapp key as its going to be the part of url

tomarsachin2271 · 2023-05-18T19:34:01Z

packages/bundler-rpc/src/interfaces/IBundler.interface.ts

Keep the interface name as IBundler.ts

tomarsachin2271 · 2023-05-18T19:34:36Z

packages/bundler-rpc/src/interfaces/IBundler.interface.ts

@@ -0,0 +1,7 @@
+import { SendUserOpResponse, getUserOpGasPricesResponse } from "../types/Bundler.types"
+import { ChainId,UserOperation  } from '@biconomy/core-types'


Linting error. Give a space after ChainId,

tomarsachin2271 · 2023-05-18T19:39:48Z

packages/bundler-rpc/src/types/Bundler.types.ts

@@ -0,0 +1,21 @@
+export type SendUserOpResponse = {


These types should return only the object mentioned in data field. code and message are returned from the API call, and it should be handled inside the sdk methods.

If code is anything other than 2xx then sdk should throw an exception with proper message so dapps can handle it at their end.

Types name should be

UserOpResponse = {
userOpHash: string,
wait: <mention function type here that return Promise>
}

UserOpGasFieldsResponse = {
preVerificationGas: string,
verificationGasLimit: string,
callGasLimit: string,
maxPriorityFeePerGas: string,
maxFeePerGas: string
}

I removed the gasPrice field. Why there is need to gasPrice field? It's not used in creating UserOp

code and message are removed and types name are updated. gasPrice filed is just of type1 transaction as bundler just send gasPrice for non 1155 blockchain so we assign gasPrice value to maxFeePerGas and maxPriorityFeePerGas in userOP

In case of type1 transaction, maxFeePerGas and maxPriorityFeePerGas should have same value of gasPrice. This is mentioned in ERC as well. In userOp there is not gasPrice field.

See the method in EntryPoint.sol as well

function getUserOpGasPrice(MemoryUserOp memory mUserOp) internal view returns (uint256) { unchecked { uint256 maxFeePerGas = mUserOp.maxFeePerGas; uint256 maxPriorityFeePerGas = mUserOp.maxPriorityFeePerGas; if (maxFeePerGas == maxPriorityFeePerGas) { //legacy mode (for networks that don't support basefee opcode) return maxFeePerGas; } return min(maxFeePerGas, maxPriorityFeePerGas + block.basefee); }

See the method in EntryPoint.sol as well

function getUserOpGasPrice(MemoryUserOp memory mUserOp) internal view returns (uint256) { unchecked { uint256 maxFeePerGas = mUserOp.maxFeePerGas; uint256 maxPriorityFeePerGas = mUserOp.maxPriorityFeePerGas; if (maxFeePerGas == maxPriorityFeePerGas) { //legacy mode (for networks that don't support basefee opcode) return maxFeePerGas; } return min(maxFeePerGas, maxPriorityFeePerGas + block.basefee); }

So bundler don't have to send gasPrice. Instead it should send same gasPrice value in both maxFeePerGas and maxPriorityFeePerGas

talhamalik883 · 2023-05-19T13:31:06Z

Some of the changes that i did in bundler package in my latest work is also update in this branch

tomarsachin2271 · 2023-05-19T14:47:25Z

packages/bundler/src/interfaces/IBundler.ts

@@ -0,0 +1,7 @@
+import { UserOpResponse, UserOpGasPricesResponse } from "../types/Types"


Rename UserOpGasPricesResponse to UserOpGasFieldsResponse

tomarsachin2271 · 2023-05-19T14:48:02Z

packages/bundler/src/types/Types.ts

+    entryPointAddress: string
+}
+
+export type UserOpResponse = {
    data: {
        transactionOd: string,


Typo here
It should be transactionId

livingrockrises

does this change also include forward scrapping?
seeing lot of files being deleted

livingrockrises · 2023-05-23T17:40:26Z

packages/ethers-lib/src/contracts/SmartWallet/v1.0.0/SmartWalletContractEthers.ts

@@ -8,8 +8,8 @@ import {
  ITransactionResult
 } from '@biconomy/core-types'
 import { toTxResult } from '../../../utils'
-import { SmartWalletContractV100 as SmartWalletContract_TypeChain } from '../../../../typechain/src/ethers-v5/v1.0.0/SmartWalletContractV100'
-import { SmartWalletContractV100Interface } from '../../../../typechain/src/ethers-v5/v1.0.0/SmartWalletContractV100'
+import { SmartWalletContract_v1_0_0 as SmartWalletContract_TypeChain } from '../../../../typechain/src/ethers-v5/v1.0.0/SmartWalletContract_v1_0_0'


what is the reason for this change?

Also, are we not going to use typechain and not ethers lib anymore

two different questions ^

livingrockrises · 2023-05-23T17:41:30Z

packages/bundler/src/utils/httpRequests.ts

 /* eslint-disable  @typescript-eslint/no-explicit-any */
 interface HttpRequest {
  url: string
  method: HttpMethod
  body?: Record<string, any>
  headers?: object
 }
+
 export async function sendRequest<T>({ url, method, body, headers = {} }: HttpRequest): Promise<T> {


instead of renaming relayer to bundler would this not be a fresh package from scratch?

livingrockrises

looks good

talhamalik883 added 3 commits May 9, 2023 14:14

forward flow code scrapping

becac3d

bundler package with rpc endpoint integration

81b818d

added function comments

c1450f0

talhamalik883 requested review from livingrockrises and tomarsachin2271 May 10, 2023 08:00

talhamalik883 added 2 commits May 10, 2023 13:15

modified package name as in Doc

a7379dd

missing token package added

88af9bd

tomarsachin2271 reviewed May 18, 2023

View reviewed changes

talhamalik883 added 2 commits May 19, 2023 18:19

Review changes implementation

134e14b

added timestamp in request for id

387159d

talhamalik883 requested a review from tomarsachin2271 May 19, 2023 13:29

tomarsachin2271 reviewed May 19, 2023

View reviewed changes

review changes for type and response type

8b08b5d

livingrockrises reviewed May 23, 2023

View reviewed changes

livingrockrises approved these changes May 23, 2023

View reviewed changes

livingrockrises merged commit b9298e4 into sdk_modularity May 23, 2023

talhamalik883 deleted the BSDK_530 branch June 21, 2023 08:24

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Bundler Package #163

Bundler Package #163

talhamalik883 commented May 10, 2023

tomarsachin2271 May 18, 2023

talhamalik883 May 19, 2023

tomarsachin2271 May 18, 2023

talhamalik883 May 19, 2023

tomarsachin2271 May 18, 2023

talhamalik883 May 19, 2023

tomarsachin2271 May 18, 2023

talhamalik883 May 19, 2023

tomarsachin2271 May 18, 2023

talhamalik883 May 19, 2023

tomarsachin2271 May 18, 2023

talhamalik883 May 19, 2023

tomarsachin2271 May 18, 2023

talhamalik883 May 19, 2023

tomarsachin2271 May 18, 2023

talhamalik883 May 19, 2023

tomarsachin2271 May 18, 2023

talhamalik883 May 19, 2023

tomarsachin2271 May 18, 2023

talhamalik883 May 19, 2023

tomarsachin2271 May 19, 2023

tomarsachin2271 May 19, 2023

talhamalik883 May 19, 2023

talhamalik883 commented May 19, 2023

tomarsachin2271 May 19, 2023

talhamalik883 May 19, 2023

tomarsachin2271 May 19, 2023

talhamalik883 May 19, 2023

livingrockrises left a comment

livingrockrises May 23, 2023

livingrockrises May 23, 2023

livingrockrises left a comment


		export class Bundler implements IBundler {

		constructor(readonly bundlerUrl: string,

		@@ -0,0 +1,7 @@
		import { SendUserOpResponse, getUserOpGasPricesResponse } from "../types/Bundler.types"
		import { ChainId,UserOperation } from '@biconomy/core-types'

		@@ -0,0 +1,7 @@
		import { UserOpResponse, UserOpGasPricesResponse } from "../types/Types"

Bundler Package #163

Bundler Package #163

Conversation

talhamalik883 commented May 10, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

talhamalik883 commented May 19, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

livingrockrises left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

livingrockrises left a comment

Choose a reason for hiding this comment