Merge branch 'feat/update-bundler-docs' into docs

bcnmy · Mar 13, 2024 · c15ad4b · c15ad4b
2 parents d6544d5 + 0be5a02
commit c15ad4b
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 23 deletions.
diff --git a/packages/bundler/src/utils/Types.ts b/packages/bundler/src/utils/Types.ts
@@ -22,23 +22,23 @@ export type BundlerConfig = {
 export type BundlerConfigWithChainId = BundlerConfig & { chainId: number };
 
 export type UserOpReceipt = {
-  /* The request hash of the UserOperation. */
+  /** The request hash of the UserOperation. */
   userOpHash: string;
-  /* The entry point address used for the UserOperation. */
+  /** The entry point address used for the UserOperation. */
   entryPoint: string;
-  /* The paymaster used for this UserOperation (or empty). */
+  /** The paymaster used for this UserOperation (or empty). */
   paymaster: string;
-  /* The actual amount paid (by account or paymaster) for this UserOperation. */
+  /** The actual amount paid (by account or paymaster) for this UserOperation. */
   actualGasCost: Hex;
-  /* The total gas used by this UserOperation (including preVerification, creation, validation, and execution). */
+  /** The total gas used by this UserOperation (including preVerification, creation, validation, and execution). */
   actualGasUsed: Hex;
-  /* Indicates whether the execution completed without reverting. */
+  /** Indicates whether the execution completed without reverting. */
   success: "true" | "false";
-  /* In case of revert, this is the revert reason. */
+  /** In case of revert, this is the revert reason. */
   reason: string;
-  /* The logs generated by this UserOperation (not including logs of other UserOperations in the same bundle). */
+  /** The logs generated by this UserOperation (not including logs of other UserOperations in the same bundle). */
   logs: Array<any>;
-  /* The TransactionReceipt object for the entire bundle, not only for this UserOperation. */
+  /** The TransactionReceipt object for the entire bundle, not only for this UserOperation. */
   receipt: UserOperationReceipt["receipt"];
 };
 
@@ -108,15 +108,15 @@ export type EstimateUserOpGasResponse = {
 };
 
 export type UserOpGasResponse = {
-  /* The amount of gas to pay to compensate the bundler for pre-verification execution and calldata */
+  /** The amount of gas to pay to compensate the bundler for pre-verification execution and calldata */
   preVerificationGas: string;
   /*The amount of gas to allocate for the verification step. */
   verificationGasLimit: string;
-  /* The amount of gas to allocate for the main execution call */
+  /** The amount of gas to allocate for the main execution call */
   callGasLimit: string;
-  /* Maximum priority fee per gas (similar to EIP-1559 max_priority_fee_per_gas) */
+  /** Maximum priority fee per gas (similar to EIP-1559 max_priority_fee_per_gas) */
   maxPriorityFeePerGas: string;
-  /* Maximum fee per gas (similar to EIP-1559 max_fee_per_gas) */
+  /** Maximum fee per gas (similar to EIP-1559 max_fee_per_gas) */
   maxFeePerGas: string;
 };
 
@@ -138,7 +138,7 @@ export type UserOpByHashResponse = UserOperationStruct & {
   /** The entrypoint used */
   entryPoint: string;
 };
-/* eslint-disable  @typescript-eslint/no-explicit-any */
+/** eslint-disable  @typescript-eslint/no-explicit-any */
 export type JsonRpcError = {
   code: string;
   message: string;

diff --git a/packages/paymaster/src/utils/Types.ts b/packages/paymaster/src/utils/Types.ts
@@ -108,7 +108,7 @@ export type BiconomyTokenPaymasterRequest = {
   spender: Hex;
   /** Not recommended */
   maxApproval?: boolean;
-  /* skip option to patch callData if approval is already given to the paymaster */
+  /** skip option to patch callData if approval is already given to the paymaster */
   skipPatchCallData?: boolean;
 };
 
@@ -119,21 +119,21 @@ export type FeeQuotesOrDataResponse = {
   tokenPaymasterAddress?: Hex;
   /** Relevant Data returned from the paymaster */
   paymasterAndData?: Uint8Array | Hex;
-  /* Gas overhead of this UserOperation */
+  /** Gas overhead of this UserOperation */
   preVerificationGas?: BigNumberish;
-  /* Actual gas used by the validation of this UserOperation */
+  /** Actual gas used by the validation of this UserOperation */
   verificationGasLimit?: BigNumberish;
-  /* Value used by inner account execution */
+  /** Value used by inner account execution */
   callGasLimit?: BigNumberish;
 };
 
 export type PaymasterAndDataResponse = {
   paymasterAndData: Hex;
-  /* Gas overhead of this UserOperation */
+  /** Gas overhead of this UserOperation */
   preVerificationGas: number;
-  /* Actual gas used by the validation of this UserOperation */
+  /** Actual gas used by the validation of this UserOperation */
   verificationGasLimit: number;
-  /* Value used by inner account execution */
+  /** Value used by inner account execution */
   callGasLimit: number;
 };
 
@@ -152,11 +152,11 @@ export type EstimateUserOpGasResponse = {
 
 export type UserOpGasResponse = {
   paymasterAndData: string;
-  /* Gas overhead of this UserOperation */
+  /** Gas overhead of this UserOperation */
   preVerificationGas: string;
   maxPriorityFeePerGas: string;
   maxFeePerGas: string;
-  /* Actual gas used by the validation of this UserOperation */
+  /** Actual gas used by the validation of this UserOperation */
   verificationGasLimit: string;
   callGasLimit: string;
 };