ox/src/erc4337/UserOperationGas.ts

Ethereum Standard Library

import * as Hex from '../core/Hex.js'
import * as Quantity from '../core/internal/quantity.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)
  | (entryPointVersion extends '0.8' ? V08<bigintType> : never)
  | (entryPointVersion extends '0.9' ? V09<bigintType> : never)
>

/** RPC User Operation Gas. */
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>

/** Type for User Operation Gas on EntryPoint 0.8 */
export type V08<bigintType = bigint> = V07<bigintType>

/** RPC User Operation Gas on EntryPoint 0.8 */
export type RpcV08 = V08<Hex.Hex>

/** Type for User Operation Gas on EntryPoint 0.9 */
export type V09<bigintType = bigint> = V08<bigintType>

/** RPC User Operation Gas on EntryPoint 0.9 */
export type RpcV09 = V09<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<
  entryPointVersion extends EntryPoint.Version = EntryPoint.Version,
>(rpc: Rpc<entryPointVersion>): UserOperationGas<entryPointVersion> {
  const gas = rpc as Rpc
  return {
    ...gas,
    callGasLimit: BigInt(gas.callGasLimit),
    preVerificationGas: BigInt(gas.preVerificationGas),
    verificationGasLimit: BigInt(gas.verificationGasLimit),
    ...(gas.paymasterVerificationGasLimit && {
      paymasterVerificationGasLimit: BigInt(gas.paymasterVerificationGasLimit),
    }),
    ...(gas.paymasterPostOpGasLimit && {
      paymasterPostOpGasLimit: BigInt(gas.paymasterPostOpGasLimit),
    }),
  } as UserOperationGas<entryPointVersion>
}

/**
 * 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<
  entryPointVersion extends EntryPoint.Version = EntryPoint.Version,
>(userOperationGas: toRpc.Input<entryPointVersion>): Rpc<entryPointVersion> {
  const gas = userOperationGas as toRpc.Input
  const rpc = {} as Rpc

  rpc.callGasLimit = Quantity.fromNumberish(gas.callGasLimit)
  rpc.preVerificationGas = Quantity.fromNumberish(gas.preVerificationGas)
  rpc.verificationGasLimit = Quantity.fromNumberish(gas.verificationGasLimit)

  if (gas.paymasterVerificationGasLimit !== undefined)
    rpc.paymasterVerificationGasLimit = Quantity.fromNumberish(
      gas.paymasterVerificationGasLimit,
    )
  if (gas.paymasterPostOpGasLimit !== undefined)
    rpc.paymasterPostOpGasLimit = Quantity.fromNumberish(
      gas.paymasterPostOpGasLimit,
    )

  return rpc as Rpc<entryPointVersion>
}

export declare namespace toRpc {
  /** Numberish input accepted by {@link ox#UserOperationGas.(toRpc:function)}. */
  export type Input<
    entryPointVersion extends EntryPoint.Version = EntryPoint.Version,
  > = UserOperationGas<entryPointVersion, Hex.Hex | bigint | number>
}