ox 1.7.5 → 1.8.1

package/src/core/Transaction.ts

@@ -2,6 +2,8 @@ import type * as AccessList from './AccessList.js'
 import type * as Address from './Address.js'
 import * as Authorization from './Authorization.js'
 import type * as Errors from './Errors.js'
+import * as Frame from './Frame.js'
+import * as FrameSignature from './FrameSignature.js'
 import * as Hex from './Hex.js'
 import * as Quantity from './internal/quantity.js'
 import type { Compute, OneOf, UnionCompute } from './internal/types.js'
@@ -21,6 +23,7 @@ export type Transaction<
     | Eip2930<pending, bigintType, numberType>
     | Eip4844<pending, bigintType, numberType>
     | Eip7702<pending, bigintType, numberType>
+    | Eip8141<pending, bigintType, numberType>
     | (Base & { type: Hex.Hex })
   >
 >
@@ -35,6 +38,7 @@ export type Rpc<pending extends boolean = false> = UnionCompute<
     | Eip2930Rpc<pending>
     | Eip4844Rpc<pending>
     | Eip7702Rpc<pending>
+    | Eip8141Rpc<pending>
     | (BaseRpc & { type: Hex.Hex })
   >
 >
@@ -184,6 +188,48 @@ export type Eip7702Rpc<pending extends boolean = false> = Compute<
   Eip7702<pending, Hex.Hex, Hex.Hex, ToRpcType['eip7702']>
 >
 
+/** An EIP-8141 frame transaction. */
+export type Eip8141<
+  pending extends boolean = false,
+  bigintType = bigint,
+  numberType = number,
+  type extends string = 'eip8141',
+> = Compute<
+  Omit<
+    Base<type, pending, bigintType, numberType>,
+    'chainId' | 'r' | 's' | 'v' | 'yParity'
+  > & {
+    /** Versioned blob hashes. */
+    blobVersionedHashes: readonly Hex.Hex[]
+    /** Chain ID, retaining bigint precision when needed. */
+    chainId: numberType | bigintType
+    /** Frames in execution order. */
+    frames: readonly ([bigintType] extends [Hex.Hex]
+      ? Frame.Rpc
+      : Frame.Frame<bigintType>)[]
+    /** Effective gas price. */
+    gasPrice?: bigintType | undefined
+    /** Maximum fee per blob gas. */
+    maxFeePerBlobGas: bigintType
+    /** Maximum fee per gas. */
+    maxFeePerGas: bigintType
+    /** Maximum priority fee per gas. */
+    maxPriorityFeePerGas: bigintType
+    /** Frame signature entries. */
+    signatures: readonly ([bigintType] extends [Hex.Hex]
+      ? FrameSignature.Rpc
+      : FrameSignature.FrameSignature)[]
+  }
+>
+
+/** An EIP-8141 RPC transaction. */
+export type Eip8141Rpc<pending extends boolean = false> = Eip8141<
+  pending,
+  Hex.Hex,
+  Hex.Hex,
+  '0x6'
+>
+
 /** An legacy Transaction as defined in the [Execution API specification](https://github.com/ethereum/execution-apis/blob/main/src/schemas/transaction.yaml). */
 export type Legacy<
   pending extends boolean = false,
@@ -217,6 +263,7 @@ export const toRpcType = {
   eip1559: '0x2',
   eip4844: '0x3',
   eip7702: '0x4',
+  eip8141: '0x6',
 } as const
 
 /** Type to RPC Type mapping. */
@@ -231,6 +278,7 @@ export const fromRpcType = {
   '0x2': 'eip1559',
   '0x3': 'eip4844',
   '0x4': 'eip7702',
+  '0x6': 'eip8141',
 } as const
 
 /** RPC Type to Type mapping. */
@@ -282,7 +330,8 @@ export function fromRpc<
 ): transaction extends Rpc<pending> ? Transaction<pending> : null {
   if (!transaction) return null as never
 
-  const signature = Signature.extract(transaction)
+  const signature =
+    transaction.type === '0x6' ? undefined : Signature.extract(transaction)
 
   const transaction_ = {
     ...transaction,
@@ -310,7 +359,23 @@ export function fromRpc<
     transaction_.authorizationList = Authorization.fromRpcList(
       transaction.authorizationList,
     )
-  if (transaction.chainId) transaction_.chainId = Number(transaction.chainId)
+  if (transaction.chainId) {
+    const chainId = BigInt(transaction.chainId)
+    transaction_.chainId =
+      transaction.type === '0x6' && chainId > BigInt(Number.MAX_SAFE_INTEGER)
+        ? chainId
+        : Number(chainId)
+  }
+  if (transaction.type === '0x6' && transaction.frames) {
+    transaction_.frames = transaction.frames.map(Frame.fromRpc)
+    transaction_.signatures = (transaction.signatures ?? []).map(
+      FrameSignature.fromRpc,
+    )
+    delete transaction_.r
+    delete transaction_.s
+    delete transaction_.v
+    delete transaction_.yParity
+  }
   if (transaction.gasPrice) transaction_.gasPrice = BigInt(transaction.gasPrice)
   if (transaction.maxFeePerBlobGas)
     transaction_.maxFeePerBlobGas = BigInt(transaction.maxFeePerBlobGas)
@@ -335,7 +400,11 @@ export declare namespace fromRpc {
     pending?: pending | boolean | undefined
   }
 
-  type ErrorType = Signature.extract.ErrorType | Errors.GlobalErrorType
+  type ErrorType =
+    | Signature.extract.ErrorType
+    | Frame.fromRpc.ErrorType
+    | FrameSignature.fromRpc.ErrorType
+    | Errors.GlobalErrorType
 }
 
 /**
@@ -400,6 +469,10 @@ export function toRpc<pending extends boolean = false>(
   rpc.type = (toRpcType as any)[transaction.type] ?? transaction.type
   rpc.value = Quantity.fromNumberish(transaction.value ?? 0n)
 
+  if (transaction.type === 'eip8141' && transaction.frames) {
+    rpc.frames = transaction.frames.map(Frame.toRpc)
+    rpc.signatures = transaction.signatures.map(FrameSignature.toRpc)
+  }
   if (transaction.accessList) rpc.accessList = transaction.accessList
   if (transaction.authorizationList)
     rpc.authorizationList = Authorization.toRpcList(
@@ -407,7 +480,7 @@ export function toRpc<pending extends boolean = false>(
     )
   if (transaction.blobVersionedHashes)
     rpc.blobVersionedHashes = transaction.blobVersionedHashes
-  if (transaction.chainId)
+  if (transaction.chainId !== undefined)
     rpc.chainId = Quantity.fromNumberish(transaction.chainId)
   if (transaction.gasPrice !== undefined)
     rpc.gasPrice = Quantity.fromNumberish(transaction.gasPrice)
@@ -441,5 +514,9 @@ export declare namespace toRpc {
     pending?: pending | boolean | undefined
   }
 
-  type ErrorType = Signature.extract.ErrorType | Errors.GlobalErrorType
+  type ErrorType =
+    | Signature.extract.ErrorType
+    | Frame.toRpc.ErrorType
+    | FrameSignature.toRpc.ErrorType
+    | Errors.GlobalErrorType
 }

package/src/core/TransactionReceipt.ts

@@ -1,5 +1,6 @@
 import type * as Address from './Address.js'
 import type * as Errors from './Errors.js'
+import * as FrameReceipt from './FrameReceipt.js'
 import * as Hex from './Hex.js'
 import * as Quantity from './internal/quantity.js'
 import type { Compute } from './internal/types.js'
@@ -26,6 +27,12 @@ export type TransactionReceipt<
   cumulativeGasUsed: bigintType
   /** Pre-London, it is equal to the transaction's gasPrice. Post-London, it is equal to the actual gas price paid for inclusion. */
   effectiveGasPrice: bigintType
+  /** Receipts for each EIP-8141 frame, in execution order. */
+  frameReceipts?:
+    | readonly ([bigintType] extends [Hex.Hex]
+        ? FrameReceipt.Rpc
+        : FrameReceipt.FrameReceipt<bigintType>)[]
+    | undefined
   /** Transaction sender */
   from: Address.Address
   /** Gas used by this transaction */
@@ -34,6 +41,8 @@ export type TransactionReceipt<
   logs: Log.Log<false, bigintType, numberType>[]
   /** Logs bloom filter */
   logsBloom: Hex.Hex
+  /** Account that paid the transaction fees. */
+  payer?: Address.Address | undefined
   /** The post-transaction state root. Only specified for transactions included before the Byzantium upgrade. */
   root?: Hex.Hex | undefined
   /** `success` if this transaction was successful or `reverted` if it failed */
@@ -75,6 +84,7 @@ export type RpcStatus = '0x0' | '0x1'
  * - `eip2930`
  * - `eip4844`
  * - `eip7702`
+ * - `eip8141`
  * - any other string
  */
 export type Type =
@@ -83,6 +93,7 @@ export type Type =
   | 'eip2930'
   | 'eip4844'
   | 'eip7702'
+  | 'eip8141'
   | (string & {})
 
 /**
@@ -93,9 +104,17 @@ export type Type =
  * - `0x2`: EIP-2930 transactions
  * - `0x3`: EIP-4844 transactions
  * - `0x4`: EIP-7702 transactions
+ * - `0x6`: EIP-8141 transactions
  * - any other string
  */
-export type RpcType = '0x0' | '0x1' | '0x2' | '0x3' | '0x4' | (string & {})
+export type RpcType =
+  | '0x0'
+  | '0x1'
+  | '0x2'
+  | '0x3'
+  | '0x4'
+  | '0x6'
+  | (string & {})
 
 /** RPC status to status mapping. */
 export const fromRpcStatus = {
@@ -116,6 +135,7 @@ export const fromRpcType = {
   '0x2': 'eip1559',
   '0x3': 'eip4844',
   '0x4': 'eip7702',
+  '0x6': 'eip8141',
 } as const
 
 /** Type to RPC type mapping. */
@@ -125,6 +145,7 @@ export const toRpcType = {
   eip1559: '0x2',
   eip4844: '0x3',
   eip7702: '0x4',
+  eip8141: '0x6',
 } as const
 
 /**
@@ -231,6 +252,11 @@ export function fromRpc<const receipt extends Rpc | null>(
 
   return {
     ...receipt,
+    ...(receipt.frameReceipts
+      ? {
+          frameReceipts: receipt.frameReceipts.map(FrameReceipt.fromRpc),
+        }
+      : {}),
     blobGasPrice: receipt.blobGasPrice
       ? BigInt(receipt.blobGasPrice)
       : undefined,
@@ -247,7 +273,10 @@ export function fromRpc<const receipt extends Rpc | null>(
 }
 
 export declare namespace fromRpc {
-  export type ErrorType = Log.fromRpc.ErrorType | Errors.GlobalErrorType
+  export type ErrorType =
+    | Log.fromRpc.ErrorType
+    | FrameReceipt.fromRpc.ErrorType
+    | Errors.GlobalErrorType
 }
 
 /**
@@ -316,10 +345,16 @@ export function toRpc(receipt: toRpc.Input): Rpc {
     contractAddress: receipt.contractAddress,
     cumulativeGasUsed: Quantity.fromNumberish(receipt.cumulativeGasUsed),
     effectiveGasPrice: Quantity.fromNumberish(receipt.effectiveGasPrice),
+    ...(receipt.frameReceipts
+      ? {
+          frameReceipts: receipt.frameReceipts.map(FrameReceipt.toRpc),
+        }
+      : {}),
     from: receipt.from,
     gasUsed: Quantity.fromNumberish(receipt.gasUsed),
     logs: receipt.logs.map(Log.toRpc as never),
     logsBloom: receipt.logsBloom,
+    ...(receipt.payer === undefined ? {} : { payer: receipt.payer }),
     root: receipt.root,
     status: toRpcStatus[receipt.status],
     to: receipt.to,
@@ -338,5 +373,8 @@ export declare namespace toRpc {
     Hex.Hex | number
   >
 
-  export type ErrorType = Hex.fromNumber.ErrorType | Errors.GlobalErrorType
+  export type ErrorType =
+    | Hex.fromNumber.ErrorType
+    | FrameReceipt.toRpc.ErrorType
+    | Errors.GlobalErrorType
 }

package/src/core/TransactionRequest.ts

@@ -3,12 +3,15 @@ import type * as Address from './Address.js'
 import * as Authorization from './Authorization.js'
 import * as Blobs from './Blobs.js'
 import * as Errors from './Errors.js'
+import * as Frame from './Frame.js'
+import * as FrameSignature from './FrameSignature.js'
 import * as Hex from './Hex.js'
 import * as Quantity from './internal/quantity.js'
 import type { Compute } from './internal/types.js'
 import type * as Kzg from './Kzg.js'
 import * as Transaction from './Transaction.js'
 import * as TxEnvelope from './TxEnvelope.js'
+import * as TxEnvelopeEip8141 from './TxEnvelopeEip8141.js'
 import type * as TxEnvelopeEip4844 from './TxEnvelopeEip4844.js'
 
 /** A Transaction Request that is generic to all transaction types, as defined in the [Execution API specification](https://github.com/ethereum/execution-apis/blob/4aca1d7a3e5aab24c8f6437131289ad386944eaa/src/schemas/transaction.yaml#L358-L423). */
@@ -16,6 +19,10 @@ export type TransactionRequest<
   bigintType = bigint,
   numberType = number,
   type extends string = string,
+  frame = [bigintType] extends [Hex.Hex] ? Frame.Rpc : Frame.Frame<bigintType>,
+  signature = [bigintType] extends [Hex.Hex]
+    ? FrameSignature.Rpc
+    : FrameSignature.FrameSignature,
 > = Compute<{
   /** EIP-2930 Access List. */
   accessList?: AccessList.AccessList | undefined
@@ -31,14 +38,16 @@ export type TransactionRequest<
   chainId?: numberType | undefined
   /** Contract code or a hashed method call with encoded args */
   data?: Hex.Hex | undefined
-  /** @alias `data` – added for TransactionEnvelope - Transaction compatibility. */
-  input?: Hex.Hex | undefined
+  /** Frames in execution order for EIP-8141 transactions. */
+  frames?: readonly frame[] | undefined
   /** Sender of the transaction. */
   from?: Address.Address | undefined
   /** Gas provided for transaction execution */
   gas?: bigintType | undefined
   /** Base fee per gas. */
   gasPrice?: bigintType | undefined
+  /** @alias `data` – added for TransactionEnvelope - Transaction compatibility. */
+  input?: Hex.Hex | undefined
   /** Maximum total fee per gas sender is willing to pay for blob gas (in wei). */
   maxFeePerBlobGas?: bigintType | undefined
   /** Total fee per gas in wei (gasPrice/baseFeePerGas + maxPriorityFeePerGas). */
@@ -47,6 +56,8 @@ export type TransactionRequest<
   maxPriorityFeePerGas?: bigintType | undefined
   /** Unique number identifying this transaction */
   nonce?: bigintType | undefined
+  /** Frame signature entries for EIP-8141 transactions. */
+  signatures?: readonly signature[] | undefined
   /** Transaction recipient */
   to?: Address.Address | null | undefined
   /** Transaction type */
@@ -64,7 +75,13 @@ export type TransactionRequest<
 }>
 
 /** RPC representation of a {@link ox#TransactionRequest.TransactionRequest}. */
-export type Rpc = TransactionRequest<Hex.Hex, Hex.Hex, string>
+export type Rpc = TransactionRequest<
+  Hex.Hex,
+  Hex.Hex,
+  string,
+  Frame.Rpc,
+  FrameSignature.Rpc
+>
 
 /**
  * Converts a {@link ox#TransactionRequest.Rpc} to a {@link ox#TransactionRequest.TransactionRequest}.
@@ -91,6 +108,10 @@ export function fromRpc(request: Rpc): TransactionRequest {
     )
   if (typeof request.chainId !== 'undefined')
     request_.chainId = Hex.toNumber(request.chainId)
+  if (request.frames !== undefined)
+    request_.frames = request.frames.map(Frame.fromRpc)
+  if (request.signatures !== undefined)
+    request_.signatures = request.signatures.map(FrameSignature.fromRpc)
   if (typeof request.gas !== 'undefined')
     request_.gas = Hex.toBigInt(request.gas)
   if (typeof request.gasPrice !== 'undefined')
@@ -120,6 +141,8 @@ export function fromRpc(request: Rpc): TransactionRequest {
 export declare namespace fromRpc {
   export type ErrorType =
     | Authorization.fromRpcList.ErrorType
+    | Frame.fromRpc.ErrorType
+    | FrameSignature.fromRpc.ErrorType
     | Hex.toNumber.ErrorType
     | Hex.toBigInt.ErrorType
     | Errors.GlobalErrorType
@@ -186,6 +209,10 @@ export function toRpc(request: toRpc.Input): Rpc {
     request_rpc.data = request.input
     request_rpc.input = request.input
   }
+  if (request.frames !== undefined)
+    request_rpc.frames = request.frames.map(Frame.toRpc)
+  if (request.signatures !== undefined)
+    request_rpc.signatures = request.signatures.map(FrameSignature.toRpc)
   if (typeof request.from !== 'undefined') request_rpc.from = request.from
   if (typeof request.gas !== 'undefined')
     request_rpc.gas = Quantity.fromNumberish(request.gas)
@@ -231,6 +258,8 @@ export declare namespace toRpc {
 
   export type ErrorType =
     | Authorization.toRpcList.ErrorType
+    | Frame.toRpc.ErrorType
+    | FrameSignature.toRpc.ErrorType
     | Hex.fromNumber.ErrorType
     | Errors.GlobalErrorType
 }
@@ -305,7 +334,7 @@ export function toEnvelope(
         : {}),
     }) as never
 
-  if (type === 'eip4844') {
+  if (type === 'eip4844' || type === 'eip8141') {
     const { kzg } = options
     const blobs = request.blobs
     const hasSidecars =
@@ -331,6 +360,10 @@ export function toEnvelope(
     })()
 
     const blobVersionedHashes = (() => {
+      if (type === 'eip8141' && sidecars)
+        return Blobs.commitmentsToVersionedHashes(sidecars.commitments, {
+          as: 'Hex',
+        })
       if (request.blobVersionedHashes) return request.blobVersionedHashes
       if (sidecars) {
         if (!kzg) throw new MissingKzgError()
@@ -341,6 +374,38 @@ export function toEnvelope(
       return []
     })()
 
+    if (type === 'eip8141') {
+      if (request.chainId === undefined)
+        throw new Quantity.MissingFieldError({
+          container: 'TransactionRequest',
+          field: 'chainId',
+        })
+      if (request.frames === undefined)
+        throw new Quantity.MissingFieldError({
+          container: 'TransactionRequest',
+          field: 'frames',
+        })
+      if (request.from === undefined)
+        throw new Quantity.MissingFieldError({
+          container: 'TransactionRequest',
+          field: 'from',
+        })
+      return TxEnvelopeEip8141.from({
+        ...(request.blobVersionedHashes || sidecars
+          ? { blobVersionedHashes }
+          : {}),
+        chainId: request.chainId,
+        frames: request.frames,
+        maxFeePerBlobGas: request.maxFeePerBlobGas,
+        maxFeePerGas: request.maxFeePerGas,
+        maxPriorityFeePerGas: request.maxPriorityFeePerGas,
+        nonce: request.nonce,
+        sender: request.from,
+        sidecars,
+        signatures: request.signatures,
+      })
+    }
+
     return TxEnvelope.from({
       type: 'eip4844',
       ...pickBase(request),
@@ -411,6 +476,8 @@ export declare namespace toEnvelope {
   type ErrorType =
     | TxEnvelope.getType.ErrorType
     | TxEnvelope.from.ErrorType
+    | Quantity.MissingFieldError
+    | TxEnvelopeEip8141.from.ErrorType
     | Blobs.toCommitments.ErrorType
     | Blobs.toCellProofs.ErrorType
     | Blobs.commitmentsToVersionedHashes.ErrorType