ox 0.9.16 → 0.10.0

package/core/{TransactionEnvelopeEip1559.ts → TxEnvelopeEip1559.ts}

@@ -11,9 +11,9 @@ import type {
 } from './internal/types.js'
 import * as Rlp from './Rlp.js'
 import * as Signature from './Signature.js'
-import * as TransactionEnvelope from './TransactionEnvelope.js'
+import * as TransactionEnvelope from './TxEnvelope.js'
 
-export type TransactionEnvelopeEip1559<
+export type TxEnvelopeEip1559<
   signed extends boolean = boolean,
   bigintType = bigint,
   numberType = number,
@@ -29,7 +29,7 @@ export type TransactionEnvelopeEip1559<
   }
 >
 
-export type Rpc<signed extends boolean = boolean> = TransactionEnvelopeEip1559<
+export type Rpc<signed extends boolean = boolean> = TxEnvelopeEip1559<
   signed,
   Hex.Hex,
   Hex.Hex,
@@ -41,19 +41,19 @@ export type Serialized = `${SerializedType}${string}`
 export const serializedType = '0x02' as const
 export type SerializedType = typeof serializedType
 
-export type Signed = TransactionEnvelopeEip1559<true>
+export type Signed = TxEnvelopeEip1559<true>
 
 export const type = 'eip1559' as const
 export type Type = typeof type
 
 /**
- * Asserts a {@link ox#TransactionEnvelopeEip1559.TransactionEnvelopeEip1559} is valid.
+ * Asserts a {@link ox#TxEnvelopeEip1559.TxEnvelopeEip1559} is valid.
  *
  * @example
  * ```ts twoslash
- * import { TransactionEnvelopeEip1559, Value } from 'ox'
+ * import { TxEnvelopeEip1559, Value } from 'ox'
  *
- * TransactionEnvelopeEip1559.assert({
+ * TxEnvelopeEip1559.assert({
  *   maxFeePerGas: 2n ** 256n - 1n + 1n,
  *   chainId: 1,
  *   to: '0x0000000000000000000000000000000000000000',
@@ -66,9 +66,7 @@ export type Type = typeof type
  *
  * @param envelope - The transaction envelope to assert.
  */
-export function assert(
-  envelope: PartialBy<TransactionEnvelopeEip1559, 'type'>,
-) {
+export function assert(envelope: PartialBy<TxEnvelopeEip1559, 'type'>) {
   const { chainId, maxPriorityFeePerGas, maxFeePerGas, to } = envelope
   if (chainId <= 0)
     throw new TransactionEnvelope.InvalidChainIdError({ chainId })
@@ -96,13 +94,13 @@ export declare namespace assert {
 }
 
 /**
- * Deserializes a {@link ox#TransactionEnvelopeEip1559.TransactionEnvelopeEip1559} from its serialized form.
+ * Deserializes a {@link ox#TxEnvelopeEip1559.TxEnvelopeEip1559} from its serialized form.
  *
  * @example
  * ```ts twoslash
- * import { TransactionEnvelopeEip1559 } from 'ox'
+ * import { TxEnvelopeEip1559 } from 'ox'
  *
- * const envelope = TransactionEnvelopeEip1559.deserialize('0x02ef0182031184773594008477359400809470997970c51812dc3a010c7d01b50e0d17dc79c8880de0b6b3a764000080c0')
+ * const envelope = TxEnvelopeEip1559.deserialize('0x02ef0182031184773594008477359400809470997970c51812dc3a010c7d01b50e0d17dc79c8880de0b6b3a764000080c0')
  * // @log: {
  * // @log:   type: 'eip1559',
  * // @log:   nonce: 785n,
@@ -118,7 +116,7 @@ export declare namespace assert {
  */
 export function deserialize(
   serialized: Serialized,
-): Compute<TransactionEnvelopeEip1559> {
+): Compute<TxEnvelopeEip1559> {
   const transactionArray = Rlp.toHex(Hex.slice(serialized, 1))
 
   const [
@@ -163,7 +161,7 @@ export function deserialize(
   let transaction = {
     chainId: Number(chainId),
     type,
-  } as TransactionEnvelopeEip1559
+  } as TxEnvelopeEip1559
   if (Hex.validate(to) && to !== '0x') transaction.to = to
   if (Hex.validate(gas) && gas !== '0x') transaction.gas = BigInt(gas)
   if (Hex.validate(data) && data !== '0x') transaction.data = data
@@ -183,7 +181,7 @@ export function deserialize(
     transaction = {
       ...transaction,
       ...signature,
-    } as TransactionEnvelopeEip1559
+    } as TxEnvelopeEip1559
 
   assert(transaction)
 
@@ -199,9 +197,9 @@ export declare namespace deserialize {
  *
  * @example
  * ```ts twoslash
- * import { TransactionEnvelopeEip1559, Value } from 'ox'
+ * import { TxEnvelopeEip1559, Value } from 'ox'
  *
- * const envelope = TransactionEnvelopeEip1559.from({
+ * const envelope = TxEnvelopeEip1559.from({
  *   chainId: 1,
  *   maxFeePerGas: Value.fromGwei('10'),
  *   maxPriorityFeePerGas: Value.fromGwei('1'),
@@ -216,9 +214,9 @@ export declare namespace deserialize {
  * It is possible to attach a `signature` to the transaction envelope.
  *
  * ```ts twoslash
- * import { Secp256k1, TransactionEnvelopeEip1559, Value } from 'ox'
+ * import { Secp256k1, TxEnvelopeEip1559, Value } from 'ox'
  *
- * const envelope = TransactionEnvelopeEip1559.from({
+ * const envelope = TxEnvelopeEip1559.from({
  *   chainId: 1,
  *   maxFeePerGas: Value.fromGwei('10'),
  *   maxPriorityFeePerGas: Value.fromGwei('1'),
@@ -227,11 +225,11 @@ export declare namespace deserialize {
  * })
  *
  * const signature = Secp256k1.sign({
- *   payload: TransactionEnvelopeEip1559.getSignPayload(envelope),
+ *   payload: TxEnvelopeEip1559.getSignPayload(envelope),
  *   privateKey: '0x...',
  * })
  *
- * const envelope_signed = TransactionEnvelopeEip1559.from(envelope, { // [!code focus]
+ * const envelope_signed = TxEnvelopeEip1559.from(envelope, { // [!code focus]
  *   signature, // [!code focus]
  * }) // [!code focus]
  * // @log: {
@@ -250,12 +248,12 @@ export declare namespace deserialize {
  * @example
  * ### From Serialized
  *
- * It is possible to instantiate an EIP-1559 Transaction Envelope from a {@link ox#TransactionEnvelopeEip1559.Serialized} value.
+ * It is possible to instantiate an EIP-1559 Transaction Envelope from a {@link ox#TxEnvelopeEip1559.Serialized} value.
  *
  * ```ts twoslash
- * import { TransactionEnvelopeEip1559 } from 'ox'
+ * import { TxEnvelopeEip1559 } from 'ox'
  *
- * const envelope = TransactionEnvelopeEip1559.from('0x02f858018203118502540be4008504a817c800809470997970c51812dc3a010c7d01b50e0d17dc79c8880de0b6b3a764000080c08477359400e1a001627c687261b0e7f8638af1112efa8a77e23656f6e7945275b19e9deed80261')
+ * const envelope = TxEnvelopeEip1559.from('0x02f858018203118502540be4008504a817c800809470997970c51812dc3a010c7d01b50e0d17dc79c8880de0b6b3a764000080c08477359400e1a001627c687261b0e7f8638af1112efa8a77e23656f6e7945275b19e9deed80261')
  * // @log: {
  * // @log:   chainId: 1,
  * // @log:   maxFeePerGas: 10000000000n,
@@ -271,22 +269,17 @@ export declare namespace deserialize {
  * @returns An EIP-1559 Transaction Envelope.
  */
 export function from<
-  const envelope extends
-    | UnionPartialBy<TransactionEnvelopeEip1559, 'type'>
-    | Serialized,
+  const envelope extends UnionPartialBy<TxEnvelopeEip1559, 'type'> | Serialized,
   const signature extends Signature.Signature | undefined = undefined,
 >(
-  envelope:
-    | envelope
-    | UnionPartialBy<TransactionEnvelopeEip1559, 'type'>
-    | Serialized,
+  envelope: envelope | UnionPartialBy<TxEnvelopeEip1559, 'type'> | Serialized,
   options: from.Options<signature> = {},
 ): from.ReturnType<envelope, signature> {
   const { signature } = options
 
   const envelope_ = (
     typeof envelope === 'string' ? deserialize(envelope) : envelope
-  ) as TransactionEnvelopeEip1559
+  ) as TxEnvelopeEip1559
 
   assert(envelope_)
 
@@ -304,13 +297,13 @@ export declare namespace from {
     }
 
   type ReturnType<
-    envelope extends
-      | UnionPartialBy<TransactionEnvelopeEip1559, 'type'>
-      | Hex.Hex = TransactionEnvelopeEip1559 | Hex.Hex,
+    envelope extends UnionPartialBy<TxEnvelopeEip1559, 'type'> | Hex.Hex =
+      | TxEnvelopeEip1559
+      | Hex.Hex,
     signature extends Signature.Signature | undefined = undefined,
   > = Compute<
     envelope extends Hex.Hex
-      ? TransactionEnvelopeEip1559
+      ? TxEnvelopeEip1559
       : Assign<
           envelope,
           (signature extends Signature.Signature ? Readonly<signature> : {}) & {
@@ -326,16 +319,16 @@ export declare namespace from {
 }
 
 /**
- * Returns the payload to sign for a {@link ox#TransactionEnvelopeEip1559.TransactionEnvelopeEip1559}.
+ * Returns the payload to sign for a {@link ox#TxEnvelopeEip1559.TxEnvelopeEip1559}.
  *
  * @example
  * The example below demonstrates how to compute the sign payload which can be used
  * with ECDSA signing utilities like {@link ox#Secp256k1.(sign:function)}.
  *
  * ```ts twoslash
- * import { Secp256k1, TransactionEnvelopeEip1559 } from 'ox'
+ * import { Secp256k1, TxEnvelopeEip1559 } from 'ox'
  *
- * const envelope = TransactionEnvelopeEip1559.from({
+ * const envelope = TxEnvelopeEip1559.from({
  *   chainId: 1,
  *   nonce: 0n,
  *   maxFeePerGas: 1000000000n,
@@ -344,7 +337,7 @@ export declare namespace from {
  *   value: 1000000000000000000n,
  * })
  *
- * const payload = TransactionEnvelopeEip1559.getSignPayload(envelope) // [!code focus]
+ * const payload = TxEnvelopeEip1559.getSignPayload(envelope) // [!code focus]
  * // @log: '0x...'
  *
  * const signature = Secp256k1.sign({ payload, privateKey: '0x...' })
@@ -354,7 +347,7 @@ export declare namespace from {
  * @returns The sign payload.
  */
 export function getSignPayload(
-  envelope: TransactionEnvelopeEip1559,
+  envelope: TxEnvelopeEip1559,
 ): getSignPayload.ReturnType {
   return hash(envelope, { presign: true })
 }
@@ -366,13 +359,13 @@ export declare namespace getSignPayload {
 }
 
 /**
- * Hashes a {@link ox#TransactionEnvelopeEip1559.TransactionEnvelopeEip1559}. This is the "transaction hash".
+ * Hashes a {@link ox#TxEnvelopeEip1559.TxEnvelopeEip1559}. This is the "transaction hash".
  *
  * @example
  * ```ts twoslash
- * import { Secp256k1, TransactionEnvelopeEip1559 } from 'ox'
+ * import { Secp256k1, TxEnvelopeEip1559 } from 'ox'
  *
- * const envelope = TransactionEnvelopeEip1559.from({
+ * const envelope = TxEnvelopeEip1559.from({
  *   chainId: 1,
  *   nonce: 0n,
  *   maxFeePerGas: 1000000000n,
@@ -382,13 +375,13 @@ export declare namespace getSignPayload {
  * })
  *
  * const signature = Secp256k1.sign({
- *   payload: TransactionEnvelopeEip1559.getSignPayload(envelope),
+ *   payload: TxEnvelopeEip1559.getSignPayload(envelope),
  *   privateKey: '0x...'
  * })
  *
- * const envelope_signed = TransactionEnvelopeEip1559.from(envelope, { signature })
+ * const envelope_signed = TxEnvelopeEip1559.from(envelope, { signature })
  *
- * const hash = TransactionEnvelopeEip1559.hash(envelope_signed) // [!code focus]
+ * const hash = TxEnvelopeEip1559.hash(envelope_signed) // [!code focus]
  * ```
  *
  * @param envelope - The EIP-1559 Transaction Envelope to hash.
@@ -396,7 +389,7 @@ export declare namespace getSignPayload {
  * @returns The hash of the transaction envelope.
  */
 export function hash<presign extends boolean = false>(
-  envelope: TransactionEnvelopeEip1559<presign extends true ? false : true>,
+  envelope: TxEnvelopeEip1559<presign extends true ? false : true>,
   options: hash.Options<presign> = {},
 ): hash.ReturnType {
   const { presign } = options
@@ -430,13 +423,13 @@ export declare namespace hash {
 }
 
 /**
- * Serializes a {@link ox#TransactionEnvelopeEip1559.TransactionEnvelopeEip1559}.
+ * Serializes a {@link ox#TxEnvelopeEip1559.TxEnvelopeEip1559}.
  *
  * @example
  * ```ts twoslash
- * import { TransactionEnvelopeEip1559, Value } from 'ox'
+ * import { TxEnvelopeEip1559, Value } from 'ox'
  *
- * const envelope = TransactionEnvelopeEip1559.from({
+ * const envelope = TxEnvelopeEip1559.from({
  *   chainId: 1,
  *   maxFeePerGas: Value.fromGwei('10'),
  *   maxPriorityFeePerGas: Value.fromGwei('1'),
@@ -444,7 +437,7 @@ export declare namespace hash {
  *   value: Value.fromEther('1'),
  * })
  *
- * const serialized = TransactionEnvelopeEip1559.serialize(envelope) // [!code focus]
+ * const serialized = TxEnvelopeEip1559.serialize(envelope) // [!code focus]
  * ```
  *
  * @example
@@ -453,9 +446,9 @@ export declare namespace hash {
  * It is possible to attach a `signature` to the serialized Transaction Envelope.
  *
  * ```ts twoslash
- * import { Secp256k1, TransactionEnvelopeEip1559, Value } from 'ox'
+ * import { Secp256k1, TxEnvelopeEip1559, Value } from 'ox'
  *
- * const envelope = TransactionEnvelopeEip1559.from({
+ * const envelope = TxEnvelopeEip1559.from({
  *   chainId: 1,
  *   maxFeePerGas: Value.fromGwei('10'),
  *   maxPriorityFeePerGas: Value.fromGwei('1'),
@@ -464,11 +457,11 @@ export declare namespace hash {
  * })
  *
  * const signature = Secp256k1.sign({
- *   payload: TransactionEnvelopeEip1559.getSignPayload(envelope),
+ *   payload: TxEnvelopeEip1559.getSignPayload(envelope),
  *   privateKey: '0x...',
  * })
  *
- * const serialized = TransactionEnvelopeEip1559.serialize(envelope, { // [!code focus]
+ * const serialized = TxEnvelopeEip1559.serialize(envelope, { // [!code focus]
  *   signature, // [!code focus]
  * }) // [!code focus]
  *
@@ -480,7 +473,7 @@ export declare namespace hash {
  * @returns The serialized Transaction Envelope.
  */
 export function serialize(
-  envelope: PartialBy<TransactionEnvelopeEip1559, 'type'>,
+  envelope: PartialBy<TxEnvelopeEip1559, 'type'>,
   options: serialize.Options = {},
 ): Serialized {
   const {
@@ -534,13 +527,13 @@ export declare namespace serialize {
 }
 
 /**
- * Converts an {@link ox#TransactionEnvelopeEip1559.TransactionEnvelopeEip1559} to an {@link ox#TransactionEnvelopeEip1559.Rpc}.
+ * Converts an {@link ox#TxEnvelopeEip1559.TxEnvelopeEip1559} to an {@link ox#TxEnvelopeEip1559.Rpc}.
  *
  * @example
  * ```ts twoslash
- * import { RpcRequest, TransactionEnvelopeEip1559, Value } from 'ox'
+ * import { RpcRequest, TxEnvelopeEip1559, Value } from 'ox'
  *
- * const envelope = TransactionEnvelopeEip1559.from({
+ * const envelope = TxEnvelopeEip1559.from({
  *   chainId: 1,
  *   nonce: 0n,
  *   gas: 21000n,
@@ -548,7 +541,7 @@ export declare namespace serialize {
  *   value: Value.fromEther('1'),
  * })
  *
- * const envelope_rpc = TransactionEnvelopeEip1559.toRpc(envelope) // [!code focus]
+ * const envelope_rpc = TxEnvelopeEip1559.toRpc(envelope) // [!code focus]
  *
  * const request = RpcRequest.from({
  *   id: 0,
@@ -560,7 +553,7 @@ export declare namespace serialize {
  * @param envelope - The EIP-1559 transaction envelope to convert.
  * @returns An RPC-formatted EIP-1559 transaction envelope.
  */
-export function toRpc(envelope: Omit<TransactionEnvelopeEip1559, 'type'>): Rpc {
+export function toRpc(envelope: Omit<TxEnvelopeEip1559, 'type'>): Rpc {
   const signature = Signature.extract(envelope)
 
   return {
@@ -594,13 +587,13 @@ export declare namespace toRpc {
 }
 
 /**
- * Validates a {@link ox#TransactionEnvelopeEip1559.TransactionEnvelopeEip1559}. Returns `true` if the envelope is valid, `false` otherwise.
+ * Validates a {@link ox#TxEnvelopeEip1559.TxEnvelopeEip1559}. Returns `true` if the envelope is valid, `false` otherwise.
  *
  * @example
  * ```ts twoslash
- * import { TransactionEnvelopeEip1559, Value } from 'ox'
+ * import { TxEnvelopeEip1559, Value } from 'ox'
  *
- * const valid = TransactionEnvelopeEip1559.assert({
+ * const valid = TxEnvelopeEip1559.assert({
  *   maxFeePerGas: 2n ** 256n - 1n + 1n,
  *   chainId: 1,
  *   to: '0x0000000000000000000000000000000000000000',
@@ -611,9 +604,7 @@ export declare namespace toRpc {
  *
  * @param envelope - The transaction envelope to validate.
  */
-export function validate(
-  envelope: PartialBy<TransactionEnvelopeEip1559, 'type'>,
-) {
+export function validate(envelope: PartialBy<TxEnvelopeEip1559, 'type'>) {
   try {
     assert(envelope)
     return true