ox 0.4.3 → 0.5.0

package/erc4337/UserOperationGas.ts

@@ -0,0 +1,109 @@
+import * as Hex from '../core/Hex.js'
+import type { OneOf } from '../core/internal/types.js'
+import type * as EntryPoint from './EntryPoint.js'
+
+/** User Operation Gas type. */
+export type UserOperationGas<
+  entryPointVersion extends EntryPoint.Version = EntryPoint.Version,
+  bigintType = bigint,
+> = OneOf<
+  | (entryPointVersion extends '0.6' ? V06<bigintType> : never)
+  | (entryPointVersion extends '0.7' ? V07<bigintType> : never)
+>
+
+/** RPC User Operation Gas on EntryPoint 0.6 */
+export type Rpc<
+  entryPointVersion extends EntryPoint.Version = EntryPoint.Version,
+> = UserOperationGas<entryPointVersion, Hex.Hex>
+
+/** Type for User Operation Gas on EntryPoint 0.6 */
+export type V06<bigintType = bigint> = {
+  callGasLimit: bigintType
+  preVerificationGas: bigintType
+  verificationGasLimit: bigintType
+}
+
+/** RPC User Operation Gas on EntryPoint 0.6 */
+export type RpcV06 = V06<Hex.Hex>
+
+/** Type for User Operation Gas on EntryPoint 0.7 */
+export type V07<bigintType = bigint> = {
+  callGasLimit: bigintType
+  paymasterVerificationGasLimit?: bigintType | undefined
+  paymasterPostOpGasLimit?: bigintType | undefined
+  preVerificationGas: bigintType
+  verificationGasLimit: bigintType
+}
+
+/** RPC User Operation Gas on EntryPoint 0.7 */
+export type RpcV07 = V07<Hex.Hex>
+
+/**
+ * Converts an {@link ox#UserOperationGas.Rpc} to an {@link ox#UserOperationGas.UserOperationGas}.
+ *
+ * @example
+ * ```ts twoslash
+ * import { UserOperationGas } from 'ox/erc4337'
+ *
+ * const userOperationGas = UserOperationGas.fromRpc({
+ *   callGasLimit: '0x69420',
+ *   preVerificationGas: '0x69420',
+ *   verificationGasLimit: '0x69420',
+ * })
+ * ```
+ *
+ * @param rpc - The RPC user operation gas to convert.
+ * @returns An instantiated {@link ox#UserOperationGas.UserOperationGas}.
+ */
+export function fromRpc(rpc: Rpc): UserOperationGas {
+  return {
+    ...rpc,
+    callGasLimit: BigInt(rpc.callGasLimit),
+    preVerificationGas: BigInt(rpc.preVerificationGas),
+    verificationGasLimit: BigInt(rpc.verificationGasLimit),
+    ...(rpc.paymasterVerificationGasLimit && {
+      paymasterVerificationGasLimit: BigInt(rpc.paymasterVerificationGasLimit),
+    }),
+    ...(rpc.paymasterPostOpGasLimit && {
+      paymasterPostOpGasLimit: BigInt(rpc.paymasterPostOpGasLimit),
+    }),
+  } as UserOperationGas
+}
+
+/**
+ * Converts a {@link ox#UserOperationGas.UserOperationGas} to a {@link ox#UserOperationGas.Rpc}.
+ *
+ * @example
+ * ```ts twoslash
+ * import { UserOperationGas } from 'ox/erc4337'
+ *
+ * const userOperationGas = UserOperationGas.toRpc({
+ *   callGasLimit: 300_000n,
+ *   preVerificationGas: 100_000n,
+ *   verificationGasLimit: 100_000n,
+ * })
+ * ```
+ *
+ * @param userOperationGas - The user operation gas to convert.
+ * @returns An RPC-formatted user operation gas.
+ */
+export function toRpc(userOperationGas: UserOperationGas): Rpc {
+  const rpc = {} as Rpc
+
+  rpc.callGasLimit = Hex.fromNumber(userOperationGas.callGasLimit)
+  rpc.preVerificationGas = Hex.fromNumber(userOperationGas.preVerificationGas)
+  rpc.verificationGasLimit = Hex.fromNumber(
+    userOperationGas.verificationGasLimit,
+  )
+
+  if (typeof userOperationGas.paymasterVerificationGasLimit === 'bigint')
+    rpc.paymasterVerificationGasLimit = Hex.fromNumber(
+      userOperationGas.paymasterVerificationGasLimit,
+    )
+  if (typeof userOperationGas.paymasterPostOpGasLimit === 'bigint')
+    rpc.paymasterPostOpGasLimit = Hex.fromNumber(
+      userOperationGas.paymasterPostOpGasLimit,
+    )
+
+  return rpc
+}

package/erc4337/UserOperationReceipt/package.json

@@ -0,0 +1,6 @@
+{
+  "type": "module",
+  "types": "../../_types/erc4337/UserOperationReceipt.d.ts",
+  "main": "../../_cjs/erc4337/UserOperationReceipt.js",
+  "module": "../../_esm/erc4337/UserOperationReceipt.js"
+}

package/erc4337/UserOperationReceipt.ts

@@ -0,0 +1,139 @@
+import type * as Address from '../core/Address.js'
+import * as Hex from '../core/Hex.js'
+import * as Log from '../core/Log.js'
+import * as TransactionReceipt from '../core/TransactionReceipt.js'
+import type * as EntryPoint from './EntryPoint.js'
+
+/**
+ * User Operation Receipt type.
+ *
+ * @see https://eips.ethereum.org/EIPS/eip-4337#-eth_getuseroperationreceipt
+ */
+export type UserOperationReceipt<
+  _entryPointVersion extends EntryPoint.Version = EntryPoint.Version,
+  bigIntType = bigint,
+  intType = number,
+  receipt = TransactionReceipt.TransactionReceipt<
+    TransactionReceipt.Status,
+    TransactionReceipt.Type,
+    bigIntType,
+    intType
+  >,
+> = {
+  /** Actual gas cost. */
+  actualGasCost: bigIntType
+  /** Actual gas used. */
+  actualGasUsed: bigIntType
+  /** Entrypoint address. */
+  entryPoint: Address.Address
+  /** Logs emitted during execution. */
+  logs: Log.Log<false, bigIntType, intType>[]
+  /** Anti-replay parameter. */
+  nonce: bigIntType
+  /** Paymaster for the user operation. */
+  paymaster?: Address.Address | undefined
+  /** Revert reason, if unsuccessful. */
+  reason?: string | undefined
+  /** Transaction receipt of the user operation execution. */
+  receipt: receipt
+  /** The account sending the user operation. */
+  sender: Address.Address
+  /** If the user operation execution was successful. */
+  success: boolean
+  /** Hash of the user operation. */
+  userOpHash: Hex.Hex
+}
+
+/** RPC User Operation Receipt on EntryPoint 0.6 */
+export type Rpc<
+  entryPointVersion extends EntryPoint.Version = EntryPoint.Version,
+> = UserOperationReceipt<
+  entryPointVersion,
+  Hex.Hex,
+  Hex.Hex,
+  TransactionReceipt.TransactionReceipt<
+    TransactionReceipt.RpcStatus,
+    TransactionReceipt.RpcType,
+    Hex.Hex,
+    Hex.Hex
+  >
+>
+
+/**
+ * Converts an {@link ox#UserOperationReceipt.Rpc} to an {@link ox#UserOperationReceipt.UserOperationReceipt}.
+ *
+ * @example
+ * ```ts twoslash
+ * // @noErrors
+ * import { UserOperationReceipt } from 'ox/erc4337'
+ *
+ * const userOperationReceipt = UserOperationReceipt.fromRpc({
+ *   actualGasCost: '0x1',
+ *   actualGasUsed: '0x2',
+ *   entryPoint: '0x0000000071727de22e5e9d8baf0edac6f37da032',
+ *   logs: [],
+ *   nonce: '0x1',
+ *   receipt: { ... },
+ *   sender: '0xE911628bF8428C23f179a07b081325cAe376DE1f',
+ *   success: true,
+ *   userOpHash: '0x5ab163e9b2f30549274c7c567ca0696edf9ef1aa476d9784d22974468fdb24d8',
+ * })
+ * ```
+ *
+ * @param rpc - The RPC user operation receipt to convert.
+ * @returns An instantiated {@link ox#UserOperationReceipt.UserOperationReceipt}.
+ */
+export function fromRpc(rpc: Rpc): UserOperationReceipt {
+  return {
+    ...rpc,
+    actualGasCost: BigInt(rpc.actualGasCost),
+    actualGasUsed: BigInt(rpc.actualGasUsed),
+    logs: rpc.logs.map((log) => Log.fromRpc(log)),
+    nonce: BigInt(rpc.nonce),
+    receipt: TransactionReceipt.fromRpc(rpc.receipt),
+  } as UserOperationReceipt
+}
+
+/**
+ * Converts a {@link ox#UserOperationReceipt.UserOperationReceipt} to a {@link ox#UserOperationReceipt.Rpc}.
+ *
+ * @example
+ * ```ts twoslash
+ * // @noErrors
+ * import { UserOperationReceipt } from 'ox/erc4337'
+ *
+ * const userOperationReceipt = UserOperationReceipt.toRpc({
+ *   actualGasCost: 1n,
+ *   actualGasUsed: 2n,
+ *   entryPoint: '0x0000000071727de22e5e9d8baf0edac6f37da032',
+ *   logs: [],
+ *   nonce: 1n,
+ *   receipt: { ... },
+ *   sender: '0xE911628bF8428C23f179a07b081325cAe376DE1f',
+ *   success: true,
+ *   userOpHash: '0x5ab163e9b2f30549274c7c567ca0696edf9ef1aa476d9784d22974468fdb24d8',
+ * })
+ * ```
+ *
+ * @param userOperationReceipt - The user operation receipt to convert.
+ * @returns An RPC-formatted user operation receipt.
+ */
+export function toRpc(userOperationReceipt: UserOperationReceipt): Rpc {
+  const rpc = {} as Rpc
+
+  rpc.actualGasCost = Hex.fromNumber(userOperationReceipt.actualGasCost)
+  rpc.actualGasUsed = Hex.fromNumber(userOperationReceipt.actualGasUsed)
+  rpc.entryPoint = userOperationReceipt.entryPoint
+  rpc.logs = userOperationReceipt.logs.map((log) => Log.toRpc(log))
+  rpc.nonce = Hex.fromNumber(userOperationReceipt.nonce)
+  rpc.receipt = TransactionReceipt.toRpc(userOperationReceipt.receipt)
+  rpc.sender = userOperationReceipt.sender
+  rpc.success = userOperationReceipt.success
+  rpc.userOpHash = userOperationReceipt.userOpHash
+
+  if (userOperationReceipt.paymaster)
+    rpc.paymaster = userOperationReceipt.paymaster
+  if (userOperationReceipt.reason) rpc.reason = userOperationReceipt.reason
+
+  return rpc
+}

package/erc4337/index.ts

@@ -0,0 +1,38 @@
+/** @entrypointCategory ERCs */
+// biome-ignore lint/complexity/noUselessEmptyExport: tsdoc
+export type {}
+
+/**
+ * Utility functions and types for working with [ERC-4337 EntryPoints](https://eips.ethereum.org/EIPS/eip-4337).
+ *
+ * @category ERC-4337
+ */
+export * as EntryPoint from './EntryPoint.js'
+
+/**
+ * Utility types for working with ERC-4337 JSON-RPC schemas.
+ *
+ * @category ERC-4337
+ */
+export * as RpcSchema from './RpcSchema.js'
+
+/**
+ * Utility functions and types for working with [ERC-4337 User Operations](https://eips.ethereum.org/EIPS/eip-4337).
+ *
+ * @category ERC-4337
+ */
+export * as UserOperation from './UserOperation.js'
+
+/**
+ * Utility functions and types for working with [ERC-4337 User Operation Gas](https://eips.ethereum.org/EIPS/eip-4337).
+ *
+ * @category ERC-4337
+ */
+export * as UserOperationGas from './UserOperationGas.js'
+
+/**
+ * Utility functions and types for working with [ERC-4337 User Operation Receipts](https://eips.ethereum.org/EIPS/eip-4337).
+ *
+ * @category ERC-4337
+ */
+export * as UserOperationReceipt from './UserOperationReceipt.js'

package/erc4337/package.json

@@ -0,0 +1,6 @@
+{
+  "type": "module",
+  "types": "../_types/erc4337/index.d.ts",
+  "main": "../_cjs/erc4337/index.js",
+  "module": "../_esm/erc4337/index.js"
+}

package/index.docs.ts

@@ -1,4 +1,5 @@
 // @ts-nocheck
 /** Used by api-extractor for docgen. https://github.com/microsoft/rushstack/issues/3557 */
 export * from './index.js'
+export * from './erc4337/index.js'
 export * from './erc6492/index.js'

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "ox",
   "description": "Ethereum Standard Library",
-  "version": "0.4.3",
+  "version": "0.5.0",
   "main": "./_cjs/index.js",
   "module": "./_esm/index.js",
   "types": "./_types/index.d.ts",
@@ -357,6 +357,36 @@
       "import": "./_esm/core/Withdrawal.js",
       "default": "./_cjs/core/Withdrawal.js"
     },
+    "./erc4337/EntryPoint": {
+      "types": "./_types/erc4337/EntryPoint.d.ts",
+      "import": "./_esm/erc4337/EntryPoint.js",
+      "default": "./_cjs/erc4337/EntryPoint.js"
+    },
+    "./erc4337/RpcSchema": {
+      "types": "./_types/erc4337/RpcSchema.d.ts",
+      "import": "./_esm/erc4337/RpcSchema.js",
+      "default": "./_cjs/erc4337/RpcSchema.js"
+    },
+    "./erc4337/UserOperation": {
+      "types": "./_types/erc4337/UserOperation.d.ts",
+      "import": "./_esm/erc4337/UserOperation.js",
+      "default": "./_cjs/erc4337/UserOperation.js"
+    },
+    "./erc4337/UserOperationGas": {
+      "types": "./_types/erc4337/UserOperationGas.d.ts",
+      "import": "./_esm/erc4337/UserOperationGas.js",
+      "default": "./_cjs/erc4337/UserOperationGas.js"
+    },
+    "./erc4337/UserOperationReceipt": {
+      "types": "./_types/erc4337/UserOperationReceipt.d.ts",
+      "import": "./_esm/erc4337/UserOperationReceipt.js",
+      "default": "./_cjs/erc4337/UserOperationReceipt.js"
+    },
+    "./erc4337": {
+      "types": "./_types/erc4337/index.d.ts",
+      "import": "./_esm/erc4337/index.js",
+      "default": "./_cjs/erc4337/index.js"
+    },
     "./erc6492/WrappedSignature": {
       "types": "./_types/erc6492/WrappedSignature.d.ts",
       "import": "./_esm/erc6492/WrappedSignature.js",

package/version.ts

@@ -1,2 +1,2 @@
 /** @internal */
-export const version = '0.4.3'
+export const version = '0.5.0'