ox 0.14.48 → 0.14.51

package/core/FrameRequest.ts

@@ -0,0 +1,72 @@
+import * as Frame from './Frame.js'
+import type { Compute, PartialBy } from './internal/types.js'
+
+/** A frame request whose omitted gas limits are estimated by the node. */
+export type FrameRequest<bigintType = bigint> = Frame.Frame<bigintType>
+
+/** JSON-RPC frame request. Only the execution mode is required. */
+export type Rpc = Compute<
+  PartialBy<Frame.Rpc, Exclude<keyof Frame.Rpc, 'mode'>>
+>
+
+/**
+ * Converts an RPC frame request, preserving omitted gas limits for node estimation.
+ *
+ * @example
+ * ```ts twoslash
+ * import { FrameRequest } from 'ox'
+ *
+ * const frame = FrameRequest.fromRpc({ mode: '0x2', stateGas: '0x0' })
+ * ```
+ *
+ * @param frame - The RPC frame request.
+ * @returns The decoded request with omitted gas limits preserved.
+ */
+export function fromRpc(frame: Rpc): FrameRequest {
+  const { executionGas, stateGas, ...rest } = Frame.fromRpc({
+    ...frame,
+    data: frame.data ?? '0x',
+    executionGas: frame.executionGas ?? '0x0',
+    flags: frame.flags ?? '0x0',
+    stateGas: frame.stateGas ?? '0x0',
+    value: frame.value ?? '0x0',
+  })
+  return {
+    ...rest,
+    ...(frame.executionGas === undefined ? {} : { executionGas }),
+    ...(frame.stateGas === undefined ? {} : { stateGas }),
+  }
+}
+
+export declare namespace fromRpc {
+  type ErrorType = Frame.fromRpc.ErrorType
+}
+
+/**
+ * Converts a frame request to RPC fields without filling omitted gas limits.
+ *
+ * Explicit zero limits remain zero. Omitted mode, flags, value, and data use frame defaults.
+ *
+ * @example
+ * ```ts twoslash
+ * import { FrameRequest } from 'ox'
+ *
+ * const frame = FrameRequest.toRpc({ mode: 'sender', stateGas: 0n })
+ * ```
+ *
+ * @param frame - The frame request. Gas and value accept hex, bigint, or number values.
+ * @returns The RPC request with omitted gas limits preserved.
+ */
+export function toRpc(frame: toRpc.Input): Rpc {
+  const { executionGas, stateGas, ...rest } = Frame.toRpc(frame)
+  return {
+    ...rest,
+    ...(frame.executionGas === undefined ? {} : { executionGas }),
+    ...(frame.stateGas === undefined ? {} : { stateGas }),
+  }
+}
+
+export declare namespace toRpc {
+  type Input = Frame.toRpc.Input
+  type ErrorType = Frame.toRpc.ErrorType
+}

package/core/FrameSignature.ts

@@ -26,19 +26,19 @@ export type Arbitrary = {
   signer?: undefined
 }
 
-/** A structured secp256k1 signature entry. */
+/** A secp256k1 signature entry. */
 export type Secp256k1 = {
   /** Explicit nonzero digest. Omit or use empty bytes for the transaction signing hash. */
   payload?: Hex.Hex | undefined
   /** secp256k1 verification scheme. */
   scheme: 1 | 'secp256k1'
-  /** Recovered signature. Omit for an unsigned entry. */
-  signature?: Signature.Signature | undefined
+  /** Recovered signature or `Signature.toHex` bytes. Omit or use `0x` for an unsigned entry. */
+  signature?: Hex.Hex | Signature.Signature | undefined
   /** Signer address. Omit to use the transaction sender. */
   signer?: Address.Address | undefined
 }
 
-/** A structured P-256 signature entry. */
+/** A P-256 signature entry. */
 export type P256 = {
   /** Explicit nonzero digest. Omit or use empty bytes for the transaction signing hash. */
   payload?: Hex.Hex | undefined
@@ -50,14 +50,14 @@ export type P256 = {
   | {
       /** Uncompressed P-256 public key. */
       publicKey: PublicKey.PublicKey
-      /** P-256 signature. */
-      signature: Signature.Signature<false>
+      /** P-256 signature or `Signature.toHex` bytes. */
+      signature: Hex.Hex | Signature.Signature<false>
     }
   | {
       /** Public key, if already known. Empty wire signatures do not retain it. */
       publicKey?: PublicKey.PublicKey | undefined
-      /** Omit for an unsigned entry. */
-      signature?: undefined
+      /** Omit or use `0x` for an unsigned entry. */
+      signature?: '0x' | undefined
     }
 )
 
@@ -67,13 +67,13 @@ export type FrameSignature = Arbitrary | Secp256k1 | P256
 /** JSON-RPC representation of a frame signature. */
 export type Rpc = {
   /** Explicit digest, or empty bytes for the transaction signing hash. */
-  msg: Hex.Hex
+  msg?: Hex.Hex | undefined
   /** Signature verification scheme. */
-  scheme: 0 | 1 | 2
+  scheme: '0x0' | '0x1' | '0x2'
   /** Encoded signature bytes. */
-  signature: Hex.Hex
+  signature?: Hex.Hex | undefined
   /** Signer address; absent for the transaction sender. */
-  signer?: Address.Address | null | undefined
+  signer?: Address.Address | '0x' | undefined
 }
 
 /** RLP-ready signature entry. The payload occupies the specification's `msg` field. */
@@ -167,27 +167,34 @@ export function assert(
           throw new InvalidError('Public key coordinates must fit in 32 bytes.')
       }
     }
-    if (entry.signature !== undefined && entry.publicKey === undefined)
+    if (
+      entry.signature !== undefined &&
+      entry.signature !== '0x' &&
+      entry.publicKey === undefined
+    )
       throw new InvalidError('P-256 signatures require a public key.')
   }
-  if (entry.signature === undefined) {
+  if (entry.signature === undefined || entry.signature === '0x') {
     if (options.signed) throw new InvalidError('Signature is required.')
     return
   }
-  if (
-    typeof entry.signature.r !== 'bigint' ||
-    typeof entry.signature.s !== 'bigint'
-  )
+  if (typeof entry.signature === 'string')
+    Hex.assert(entry.signature, { strict: true })
+  const signature =
+    typeof entry.signature === 'string'
+      ? Signature.fromHex(entry.signature)
+      : entry.signature
+  if (typeof signature.r !== 'bigint' || typeof signature.s !== 'bigint')
     throw new InvalidError('Signature scalars must be bigint.')
   if (
-    (scheme === 1 || entry.signature.yParity !== undefined) &&
-    entry.signature.yParity !== 0 &&
-    entry.signature.yParity !== 1
+    (scheme === 1 || signature.yParity !== undefined) &&
+    signature.yParity !== 0 &&
+    signature.yParity !== 1
   )
     throw new InvalidError('Signature parity must be 0 or 1.')
-  Signature.assert(entry.signature, { recovered: scheme === 1 })
-  const r = entry.signature.r
-  const s = entry.signature.s
+  Signature.assert(signature, { recovered: scheme === 1 })
+  const r = signature.r
+  const s = signature.s
   const order = scheme === 1 ? secp256k1N : p256N
   if (
     r === 0n ||
@@ -216,13 +223,15 @@ export declare namespace assert {
     | Hex.toBigInt.ErrorType
     | PublicKey.assert.ErrorType
     | Signature.assert.ErrorType
+    | Signature.fromHex.ErrorType
     | Errors.GlobalErrorType
 }
 
 /**
  * Coerces a value into a {@link ox#FrameSignature.FrameSignature}.
  *
- * Accepts arbitrary signature bytes or a structured signature entry. Omitted
+ * Accepts arbitrary signature bytes or a signature entry. Protocol signatures accept
+ * structured objects or `Signature.toHex` bytes. P-256 entries still require a public key. Omitted
  * `scheme` and `payload` default to `'arbitrary'` and `'0x'`, respectively.
  * An empty payload selects the canonical transaction signing hash; an explicit
  * payload must be a nonzero 32-byte digest.
@@ -346,7 +355,7 @@ export declare namespace from {
  *
  * const entry = FrameSignature.fromRpc({
  *   msg: '0x',
- *   scheme: 0,
+ *   scheme: '0x0',
  *   signature: '0xdeadbeef'
  * })
  * ```
@@ -356,15 +365,20 @@ export declare namespace from {
  */
 export function fromRpc(entry: Rpc): FrameSignature {
   return fromTuple([
-    entry.scheme === 0 ? '0x' : Hex.fromNumber(entry.scheme, { size: 1 }),
+    entry.scheme === '0x0'
+      ? '0x'
+      : Hex.fromNumber(Hex.toNumber(entry.scheme), { size: 1 }),
     entry.signer ?? '0x',
-    entry.msg,
-    entry.signature,
+    entry.msg ?? '0x',
+    entry.signature ?? '0x',
   ])
 }
 
 export declare namespace fromRpc {
-  type ErrorType = fromTuple.ErrorType | Hex.fromNumber.ErrorType
+  type ErrorType =
+    | fromTuple.ErrorType
+    | Hex.fromNumber.ErrorType
+    | Hex.toNumber.ErrorType
 }
 
 /**
@@ -387,8 +401,10 @@ export function toRpc(entry: FrameSignature): Rpc {
   const [scheme, signer, msg, signature] = toTuple(entry)
   return {
     msg,
-    scheme: (scheme === '0x' ? 0 : Hex.toNumber(scheme)) as Rpc['scheme'],
-    signature,
+    scheme: (scheme === '0x'
+      ? '0x0'
+      : Hex.fromNumber(Hex.toNumber(scheme))) as Rpc['scheme'],
+    ...(signature === '0x' && scheme !== '0x' ? {} : { signature }),
     ...(signer === '0x' ? {} : { signer }),
   }
 }
@@ -518,18 +534,28 @@ export function toTuple(entry: FrameSignature): Tuple {
       case 'arbitrary':
         return entry.signature
       case 1:
-      case 'secp256k1':
-        return entry.signature === undefined
-          ? '0x'
-          : Hex.concat(
-              Hex.fromNumber(entry.signature.yParity, { size: 1 }),
-              Hex.fromNumber(entry.signature.r, { size: 32 }),
-              Hex.fromNumber(entry.signature.s, { size: 32 }),
-            )
+      case 'secp256k1': {
+        if (entry.signature === undefined || entry.signature === '0x')
+          return '0x'
+        const signature =
+          typeof entry.signature === 'string'
+            ? Signature.fromHex(entry.signature)
+            : entry.signature
+        return Hex.concat(
+          Hex.fromNumber(signature.yParity, { size: 1 }),
+          Hex.fromNumber(signature.r, { size: 32 }),
+          Hex.fromNumber(signature.s, { size: 32 }),
+        )
+      }
       case 2:
       case 'p256': {
-        if (entry.signature === undefined) return '0x'
-        const { publicKey, signature } = entry
+        if (entry.signature === undefined || entry.signature === '0x')
+          return '0x'
+        const publicKey = entry.publicKey!
+        const signature =
+          typeof entry.signature === 'string'
+            ? Signature.fromHex(entry.signature)
+            : entry.signature
         const s = signature.s
         return Hex.concat(
           Hex.fromNumber(signature.r, { size: 32 }),

package/core/Siwe.ts

@@ -21,7 +21,7 @@ export const prefixRegex =
 
 // https://regexr.com/80gf9
 export const suffixRegex =
-  /(?:URI: (?<uri>.+))\n(?:Version: (?<version>.+))\n(?:Chain ID: (?<chainId>\d+))\n(?:Nonce: (?<nonce>[a-zA-Z0-9]+))\n(?:Issued At: (?<issuedAt>.+))(?:\nExpiration Time: (?<expirationTime>.+))?(?:\nNot Before: (?<notBefore>.+))?(?:\nRequest ID: (?<requestId>.+))?/
+  /(?:URI: (?<uri>.+))\n(?:Version: (?<version>.+))\n(?:Chain ID: (?<chainId>\d+))\n(?:Nonce: (?<nonce>[a-zA-Z0-9]+))\n(?:Issued At: (?<issuedAt>.+))(?:\nExpiration Time: (?<expirationTime>.+))?(?:\nNot Before: (?<notBefore>.+))?(?:\nRequest ID: (?<requestId>.*))?(?:\nResources:(?<resources>(?:\n- .+)*))?/
 
 /** [EIP-4361](https://eips.ethereum.org/EIPS/eip-4361) message fields. */
 export type Message = {
@@ -372,18 +372,26 @@ export function parseMessage(message: string): ExactPartial<Message> {
     scheme?: string
     statement?: string
   }
-  const { chainId, expirationTime, issuedAt, notBefore, requestId, ...suffix } =
-    (message.match(suffixRegex)?.groups ?? {}) as {
-      chainId: string
-      expirationTime?: string
-      issuedAt?: string
-      nonce: string
-      notBefore?: string
-      requestId?: string
-      uri: string
-      version: '1'
-    }
-  const resources = message.split('Resources:')[1]?.split('\n- ').slice(1)
+  const {
+    chainId,
+    expirationTime,
+    issuedAt,
+    notBefore,
+    requestId,
+    resources: resources_,
+    ...suffix
+  } = (message.match(suffixRegex)?.groups ?? {}) as {
+    chainId: string
+    expirationTime?: string
+    issuedAt?: string
+    nonce: string
+    notBefore?: string
+    requestId?: string
+    resources?: string
+    uri: string
+    version: '1'
+  }
+  const resources = resources_?.split('\n- ').slice(1)
   return {
     ...prefix,
     ...suffix,

package/core/TransactionRequest.ts

@@ -2,7 +2,7 @@ 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 FrameRequest from './FrameRequest.js'
 import * as FrameSignature from './FrameSignature.js'
 import * as Hex from './Hex.js'
 import type { Compute } from './internal/types.js'
@@ -13,7 +13,7 @@ export type TransactionRequest<
   bigintType = bigint,
   numberType = number,
   type extends string = string,
-  frame = Frame.Frame<bigintType>,
+  frame = FrameRequest.FrameRequest<bigintType>,
   signature = FrameSignature.FrameSignature,
 > = Compute<{
   /** EIP-2930 Access List. */
@@ -63,7 +63,7 @@ export type Rpc = TransactionRequest<
   Hex.Hex,
   Hex.Hex,
   string,
-  Frame.Rpc,
+  FrameRequest.Rpc,
   FrameSignature.Rpc
 >
 
@@ -92,7 +92,7 @@ export function fromRpc(request: Rpc): TransactionRequest {
     )
   if (typeof request.chainId !== 'undefined')
     request_.chainId = Hex.toNumber(request.chainId)
-  if (request.frames) request_.frames = request.frames.map(Frame.fromRpc)
+  if (request.frames) request_.frames = request.frames.map(FrameRequest.fromRpc)
   if (request.signatures)
     request_.signatures = request.signatures.map(FrameSignature.fromRpc)
   if (typeof request.gas !== 'undefined')
@@ -120,7 +120,7 @@ export function fromRpc(request: Rpc): TransactionRequest {
 
 export declare namespace fromRpc {
   export type ErrorType =
-    | Frame.fromRpc.ErrorType
+    | FrameRequest.fromRpc.ErrorType
     | FrameSignature.fromRpc.ErrorType
     | Authorization.fromRpcList.ErrorType
     | Hex.toNumber.ErrorType
@@ -189,7 +189,8 @@ export function toRpc(request: TransactionRequest): Rpc {
     request_rpc.input = request.input
   }
   if (typeof request.from !== 'undefined') request_rpc.from = request.from
-  if (request.frames) request_rpc.frames = request.frames.map(Frame.toRpc)
+  if (request.frames)
+    request_rpc.frames = request.frames.map(FrameRequest.toRpc)
   if (request.signatures)
     request_rpc.signatures = request.signatures.map(FrameSignature.toRpc)
   if (typeof request.gas !== 'undefined')
@@ -224,7 +225,7 @@ export function toRpc(request: TransactionRequest): Rpc {
 
 export declare namespace toRpc {
   export type ErrorType =
-    | Frame.toRpc.ErrorType
+    | FrameRequest.toRpc.ErrorType
     | FrameSignature.toRpc.ErrorType
     | Authorization.toRpcList.ErrorType
     | Hex.fromNumber.ErrorType

package/core/internal/rpcSchemas/eth.ts

@@ -4,6 +4,7 @@ import type * as Block from '../../Block.js'
 import type * as BlockOverrides from '../../BlockOverrides.js'
 import type * as Fee from '../../Fee.js'
 import type * as Filter from '../../Filter.js'
+import type * as FrameReceipt from '../../FrameReceipt.js'
 import type * as Hex from '../../Hex.js'
 import type * as Log from '../../Log.js'
 import type * as RpcSchema from '../../RpcSchema.js'
@@ -11,6 +12,12 @@ import type * as StateOverrides from '../../StateOverrides.js'
 import type * as Transaction from '../../Transaction.js'
 import type * as TransactionReceipt from '../../TransactionReceipt.js'
 import type * as TransactionRequest from '../../TransactionRequest.js'
+import type * as TxEnvelopeEip1559 from '../../TxEnvelopeEip1559.js'
+import type * as TxEnvelopeEip2930 from '../../TxEnvelopeEip2930.js'
+import type * as TxEnvelopeEip4844 from '../../TxEnvelopeEip4844.js'
+import type * as TxEnvelopeEip7702 from '../../TxEnvelopeEip7702.js'
+import type * as TxEnvelopeEip8141 from '../../TxEnvelopeEip8141.js'
+import type * as TxEnvelopeLegacy from '../../TxEnvelopeLegacy.js'
 
 /**
  * Union of all JSON-RPC Methods for the `eth_` namespace.
@@ -217,6 +224,31 @@ export type Eth = RpcSchema.From<
       }
       ReturnType: Fee.FeeHistoryRpc
     }
+  /**
+   * Fills transaction defaults and returns the unsigned transaction.
+   *
+   * @example
+   * ```
+   * request({ method: 'eth_fillTransaction', params: [{ from: '0x...', to: '0x...', value: '0x...' }] })
+   * // { tx: { ... } }
+   * ```
+   */
+  | {
+      Request: {
+        method: 'eth_fillTransaction'
+        params: [transaction: TransactionRequest.Rpc]
+      }
+      ReturnType: {
+        tx: (
+          | TxEnvelopeLegacy.Rpc<false>
+          | TxEnvelopeEip2930.Rpc<false>
+          | TxEnvelopeEip1559.Rpc<false>
+          | TxEnvelopeEip4844.Rpc<false>
+          | TxEnvelopeEip7702.Rpc<false>
+          | TxEnvelopeEip8141.Rpc
+        ) & { from: Address.Address }
+      }
+    }
   /**
    * Returns the current price of gas expressed in wei
    *
@@ -772,6 +804,13 @@ export type Eth = RpcSchema.From<
                     message: string
                   }
                 | undefined
+              frameResults?:
+                | readonly (FrameReceipt.Rpc & {
+                    error?: { code: number; message: string } | undefined
+                    returnData: Hex.Hex
+                  })[]
+                | undefined
+              payer?: Address.Address | undefined
               logs?: readonly Log.Rpc[] | undefined
               gasUsed: Hex.Hex
               returnData: Hex.Hex

package/index.ts

@@ -1579,6 +1579,21 @@ export * as Frame from './core/Frame.js'
  * @category Frames (EIP-8141)
  */
 export * as FrameReceipt from './core/FrameReceipt.js'
+
+/**
+ * Convert EIP-8141 frame requests while preserving omitted gas limits for node estimation.
+ *
+ * @example
+ * ```ts twoslash
+ * import { FrameRequest } from 'ox'
+ *
+ * const frame = FrameRequest.toRpc({ mode: 'sender', stateGas: 0n })
+ * ```
+ *
+ * @category Frames (EIP-8141)
+ */
+export * as FrameRequest from './core/FrameRequest.js'
+
 /**
  * Utilities for constructing, validating, and encoding [EIP-8141](https://eips.ethereum.org/EIPS/eip-8141) signature entries.
  *

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "ox",
   "description": "Ethereum Standard Library",
-  "version": "0.14.48",
+  "version": "0.14.51",
   "main": "./_cjs/index.js",
   "module": "./_esm/index.js",
   "types": "./_types/index.d.ts",
@@ -232,6 +232,11 @@
       "import": "./_esm/core/FrameReceipt.js",
       "default": "./_cjs/core/FrameReceipt.js"
     },
+    "./FrameRequest": {
+      "types": "./_types/core/FrameRequest.d.ts",
+      "import": "./_esm/core/FrameRequest.js",
+      "default": "./_cjs/core/FrameRequest.js"
+    },
     "./FrameSignature": {
       "types": "./_types/core/FrameSignature.d.ts",
       "import": "./_esm/core/FrameSignature.js",

package/version.ts

@@ -1,2 +1,2 @@
 /** @internal */
-export const version = '0.14.48'
+export const version = '0.14.51'