ox 0.0.1 → 0.1.0

package/_types/TransactionEnvelope.d.ts

@@ -0,0 +1,141 @@
+import type * as Address from './Address.js';
+import * as Errors from './Errors.js';
+import type * as Hex from './Hex.js';
+import type { Compute } from './internal/types.js';
+/** Base type for a Transaction Envelope. Transaction Envelopes inherit this type. */
+export type Base<type extends string = string, signed extends boolean = boolean, bigintType = bigint, numberType = number> = Compute<{
+    /** EIP-155 Chain ID. */
+    chainId: numberType;
+    /** 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;
+    /** Sender of the transaction. */
+    from?: Address.Address | undefined;
+    /** Gas provided for transaction execution */
+    gas?: bigintType | undefined;
+    /** Unique number identifying this transaction */
+    nonce?: bigintType | undefined;
+    /** Transaction recipient */
+    to?: Address.Address | null | undefined;
+    /** Transaction type */
+    type: type;
+    /** Value in wei sent with this transaction */
+    value?: bigintType | undefined;
+    /** ECDSA signature r. */
+    r?: bigintType | undefined;
+    /** ECDSA signature s. */
+    s?: bigintType | undefined;
+    /** ECDSA signature yParity. */
+    yParity?: numberType | undefined;
+    /** @deprecated ECDSA signature v (for backwards compatibility). */
+    v?: numberType | undefined;
+} & (signed extends true ? {
+    r: bigintType;
+    s: bigintType;
+} : {})>;
+/** RPC representation of a {@link ox#(TransactionEnvelope:namespace).Base}. */
+export type BaseRpc<type extends string = string, signed extends boolean = boolean> = Base<type, signed, Hex.Hex, Hex.Hex>;
+/** Signed representation of a {@link ox#(TransactionEnvelope:namespace).Base}. */
+export type BaseSigned<type extends string = string> = Base<type, true>;
+/**
+ * Thrown when a fee cap is too high.
+ *
+ * @example
+ * ```ts twoslash
+ * import { TransactionEnvelopeEip1559 } from 'ox'
+ *
+ * TransactionEnvelopeEip1559.assert({
+ *   maxFeePerGas: 2n ** 256n - 1n + 1n,
+ *   chainId: 1,
+ * })
+ * // @error: TransactionEnvelope.FeeCapTooHighError: The fee cap (`maxFeePerGas`/`maxPriorityFeePerGas` = 115792089237316195423570985008687907853269984665640564039457584007913.129639936 gwei) cannot be higher than the maximum allowed value (2^256-1).
+ * ```
+ */
+export declare class FeeCapTooHighError extends Errors.BaseError {
+    readonly name = "TransactionEnvelope.FeeCapTooHighError";
+    constructor({ feeCap, }?: {
+        feeCap?: bigint | undefined;
+    });
+}
+/**
+ * Thrown when a gas price is too high.
+ *
+ * @example
+ * ```ts twoslash
+ * import { TransactionEnvelopeLegacy } from 'ox'
+ *
+ * TransactionEnvelopeLegacy.assert({
+ *   gasPrice: 2n ** 256n - 1n + 1n,
+ *   chainId: 1,
+ * })
+ * // @error: TransactionEnvelope.GasPriceTooHighError: The gas price (`gasPrice` = 115792089237316195423570985008687907853269984665640564039457584007913.129639936 gwei) cannot be higher than the maximum allowed value (2^256-1).
+ * ```
+ */
+export declare class GasPriceTooHighError extends Errors.BaseError {
+    readonly name = "TransactionEnvelope.GasPriceTooHighError";
+    constructor({ gasPrice, }?: {
+        gasPrice?: bigint | undefined;
+    });
+}
+/**
+ * Thrown when a chain ID is invalid.
+ *
+ * @example
+ * ```ts twoslash
+ * import { TransactionEnvelopeEip1559 } from 'ox'
+ *
+ * TransactionEnvelopeEip1559.assert({ chainId: 0 })
+ * // @error: TransactionEnvelope.InvalidChainIdError: Chain ID "0" is invalid.
+ * ```
+ */
+export declare class InvalidChainIdError extends Errors.BaseError {
+    readonly name = "TransactionEnvelope.InvalidChainIdError";
+    constructor({ chainId }: {
+        chainId?: number | undefined;
+    });
+}
+/**
+ * Thrown when a serialized transaction is invalid.
+ *
+ * @example
+ * ```ts twoslash
+ * import { TransactionEnvelopeEip1559 } from 'ox'
+ *
+ * TransactionEnvelopeEip1559.deserialize('0x02c0')
+ * // @error: TransactionEnvelope.InvalidSerializedError: Invalid serialized transaction of type "eip1559" was provided.
+ * // @error: Serialized Transaction: "0x02c0"
+ * // @error: Missing Attributes: chainId, nonce, maxPriorityFeePerGas, maxFeePerGas, gas, to, value, data, accessList
+ * ```
+ */
+export declare class InvalidSerializedError extends Errors.BaseError {
+    readonly name = "TransactionEnvelope.InvalidSerializedError";
+    constructor({ attributes, serialized, type, }: {
+        attributes: Record<string, unknown>;
+        serialized: Hex.Hex;
+        type: string;
+    });
+}
+/**
+ * Thrown when a tip is higher than a fee cap.
+ *
+ * @example
+ * ```ts twoslash
+ * import { TransactionEnvelopeEip1559 } from 'ox'
+ *
+ * TransactionEnvelopeEip1559.assert({
+ *   chainId: 1,
+ *   maxFeePerGas: 10n,
+ *   maxPriorityFeePerGas: 11n,
+ * })
+ * // @error: TransactionEnvelope.TipAboveFeeCapError: The provided tip (`maxPriorityFeePerGas` = 11 gwei) cannot be higher than the fee cap (`maxFeePerGas` = 10 gwei).
+ * ```
+ */
+export declare class TipAboveFeeCapError extends Errors.BaseError {
+    readonly name = "TransactionEnvelope.TipAboveFeeCapError";
+    constructor({ maxPriorityFeePerGas, maxFeePerGas, }?: {
+        maxPriorityFeePerGas?: bigint | undefined;
+        maxFeePerGas?: bigint | undefined;
+    });
+}
+//# sourceMappingURL=TransactionEnvelope.d.ts.map

package/_types/TransactionEnvelope.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TransactionEnvelope.d.ts","sourceRoot":"","sources":["../TransactionEnvelope.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,OAAO,MAAM,cAAc,CAAA;AAC5C,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA;AACrC,OAAO,KAAK,KAAK,GAAG,MAAM,UAAU,CAAA;AAEpC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAA;AAElD,qFAAqF;AACrF,MAAM,MAAM,IAAI,CACd,IAAI,SAAS,MAAM,GAAG,MAAM,EAC5B,MAAM,SAAS,OAAO,GAAG,OAAO,EAChC,UAAU,GAAG,MAAM,EACnB,UAAU,GAAG,MAAM,IACjB,OAAO,CACT;IACE,wBAAwB;IACxB,OAAO,EAAE,UAAU,CAAA;IACnB,8DAA8D;IAC9D,IAAI,CAAC,EAAE,GAAG,CAAC,GAAG,GAAG,SAAS,CAAA;IAC1B,iFAAiF;IACjF,KAAK,CAAC,EAAE,GAAG,CAAC,GAAG,GAAG,SAAS,CAAA;IAC3B,iCAAiC;IACjC,IAAI,CAAC,EAAE,OAAO,CAAC,OAAO,GAAG,SAAS,CAAA;IAClC,6CAA6C;IAC7C,GAAG,CAAC,EAAE,UAAU,GAAG,SAAS,CAAA;IAC5B,iDAAiD;IACjD,KAAK,CAAC,EAAE,UAAU,GAAG,SAAS,CAAA;IAC9B,4BAA4B;IAC5B,EAAE,CAAC,EAAE,OAAO,CAAC,OAAO,GAAG,IAAI,GAAG,SAAS,CAAA;IACvC,uBAAuB;IACvB,IAAI,EAAE,IAAI,CAAA;IACV,8CAA8C;IAC9C,KAAK,CAAC,EAAE,UAAU,GAAG,SAAS,CAAA;IAC9B,yBAAyB;IACzB,CAAC,CAAC,EAAE,UAAU,GAAG,SAAS,CAAA;IAC1B,yBAAyB;IACzB,CAAC,CAAC,EAAE,UAAU,GAAG,SAAS,CAAA;IAC1B,+BAA+B;IAC/B,OAAO,CAAC,EAAE,UAAU,GAAG,SAAS,CAAA;IAChC,mEAAmE;IACnE,CAAC,CAAC,EAAE,UAAU,GAAG,SAAS,CAAA;CAC3B,GAAG,CAAC,MAAM,SAAS,IAAI,GAAG;IAAE,CAAC,EAAE,UAAU,CAAC;IAAC,CAAC,EAAE,UAAU,CAAA;CAAE,GAAG,EAAE,CAAC,CAClE,CAAA;AAED,+EAA+E;AAC/E,MAAM,MAAM,OAAO,CACjB,IAAI,SAAS,MAAM,GAAG,MAAM,EAC5B,MAAM,SAAS,OAAO,GAAG,OAAO,IAC9B,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,CAAC,CAAA;AAExC,kFAAkF;AAClF,MAAM,MAAM,UAAU,CAAC,IAAI,SAAS,MAAM,GAAG,MAAM,IAAI,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;AAEvE;;;;;;;;;;;;;GAaG;AACH,qBAAa,kBAAmB,SAAQ,MAAM,CAAC,SAAS;IACtD,SAAkB,IAAI,4CAA2C;gBACrD,EACV,MAAM,GACP,GAAE;QACD,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;KACvB;CAOP;AAED;;;;;;;;;;;;;GAaG;AACH,qBAAa,oBAAqB,SAAQ,MAAM,CAAC,SAAS;IACxD,SAAkB,IAAI,8CAA6C;gBACvD,EACV,QAAQ,GACT,GAAE;QACD,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;KACzB;CAOP;AAED;;;;;;;;;;GAUG;AACH,qBAAa,mBAAoB,SAAQ,MAAM,CAAC,SAAS;IACvD,SAAkB,IAAI,6CAA4C;gBACtD,EAAE,OAAO,EAAE,EAAE;QAAE,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;KAAE;CAO1D;AAED;;;;;;;;;;;;GAYG;AACH,qBAAa,sBAAuB,SAAQ,MAAM,CAAC,SAAS;IAC1D,SAAkB,IAAI,gDAA+C;gBACzD,EACV,UAAU,EACV,UAAU,EACV,IAAI,GACL,EAAE;QACD,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;QACnC,UAAU,EAAE,GAAG,CAAC,GAAG,CAAA;QACnB,IAAI,EAAE,MAAM,CAAA;KACb;CAWF;AAED;;;;;;;;;;;;;;GAcG;AACH,qBAAa,mBAAoB,SAAQ,MAAM,CAAC,SAAS;IACvD,SAAkB,IAAI,6CAA4C;gBACtD,EACV,oBAAoB,EACpB,YAAY,GACb,GAAE;QACD,oBAAoB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;QACzC,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;KAC7B;CAaP"}

package/_types/TransactionEnvelopeEip1559.d.ts

@@ -0,0 +1,367 @@
+import * as AccessList from './AccessList.js';
+import * as Address from './Address.js';
+import type * as Errors from './Errors.js';
+import * as Hash from './Hash.js';
+import * as Hex from './Hex.js';
+import * as Rlp from './Rlp.js';
+import * as Signature from './Signature.js';
+import * as TransactionEnvelope from './TransactionEnvelope.js';
+import type { Assign, Compute, PartialBy, UnionPartialBy } from './internal/types.js';
+export type TransactionEnvelopeEip1559<signed extends boolean = boolean, bigintType = bigint, numberType = number, type extends string = Type> = Compute<TransactionEnvelope.Base<type, signed, bigintType, numberType> & {
+    /** EIP-2930 Access List. */
+    accessList?: AccessList.AccessList | undefined;
+    /** Total fee per gas in wei (gasPrice/baseFeePerGas + maxPriorityFeePerGas). */
+    maxFeePerGas?: bigintType | undefined;
+    /** Max priority fee per gas (in wei). */
+    maxPriorityFeePerGas?: bigintType | undefined;
+}>;
+export type Rpc<signed extends boolean = boolean> = TransactionEnvelopeEip1559<signed, Hex.Hex, Hex.Hex, '0x2'>;
+export type Serialized = `${SerializedType}${string}`;
+export declare const serializedType: "0x02";
+export type SerializedType = typeof serializedType;
+export type Signed = TransactionEnvelopeEip1559<true>;
+export declare const type: "eip1559";
+export type Type = typeof type;
+/**
+ * Asserts a {@link ox#TransactionEnvelopeEip1559.TransactionEnvelopeEip1559} is valid.
+ *
+ * @example
+ * ```ts twoslash
+ * import { TransactionEnvelopeEip1559, Value } from 'ox'
+ *
+ * TransactionEnvelopeEip1559.assert({
+ *   maxFeePerGas: 2n ** 256n - 1n + 1n,
+ *   chainId: 1,
+ *   to: '0x0000000000000000000000000000000000000000',
+ *   value: Value.fromEther('1'),
+ * })
+ * // @error: FeeCapTooHighError:
+ * // @error: The fee cap (`masFeePerGas` = 115792089237316195423570985008687907853269984665640564039457584007913 gwei) cannot be
+ * // @error: higher than the maximum allowed value (2^256-1).
+ * ```
+ *
+ * @param envelope - The transaction envelope to assert.
+ */
+export declare function assert(envelope: PartialBy<TransactionEnvelopeEip1559, 'type'>): void;
+export declare namespace assert {
+    var parseError: (error: unknown) => assert.ErrorType;
+}
+export declare namespace assert {
+    type ErrorType = Address.assert.ErrorType | TransactionEnvelope.InvalidChainIdError | TransactionEnvelope.FeeCapTooHighError | TransactionEnvelope.TipAboveFeeCapError | Errors.GlobalErrorType;
+}
+/**
+ * Deserializes a {@link ox#TransactionEnvelopeEip1559.TransactionEnvelopeEip1559} from its serialized form.
+ *
+ * @example
+ * ```ts twoslash
+ * import { TransactionEnvelopeEip1559 } from 'ox'
+ *
+ * const envelope = TransactionEnvelopeEip1559.deserialize('0x02ef0182031184773594008477359400809470997970c51812dc3a010c7d01b50e0d17dc79c8880de0b6b3a764000080c0')
+ * // @log: {
+ * // @log:   type: 'eip1559',
+ * // @log:   nonce: 785n,
+ * // @log:   maxFeePerGas: 2000000000n,
+ * // @log:   gas: 1000000n,
+ * // @log:   to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
+ * // @log:   value: 1000000000000000000n,
+ * // @log: }
+ * ```
+ *
+ * @param serialized - The serialized transaction.
+ * @returns Deserialized Transaction Envelope.
+ */
+export declare function deserialize(serialized: Serialized): Compute<TransactionEnvelopeEip1559>;
+export declare namespace deserialize {
+    var parseError: (error: unknown) => deserialize.ErrorType;
+}
+export declare namespace deserialize {
+    type ErrorType = Errors.GlobalErrorType;
+}
+/**
+ * Converts an arbitrary transaction object into an EIP-1559 Transaction Envelope.
+ *
+ * @example
+ * ```ts twoslash
+ * import { TransactionEnvelopeEip1559, Value } from 'ox'
+ *
+ * const envelope = TransactionEnvelopeEip1559.from({
+ *   chainId: 1,
+ *   maxFeePerGas: Value.fromGwei('10'),
+ *   maxPriorityFeePerGas: Value.fromGwei('1'),
+ *   to: '0x0000000000000000000000000000000000000000',
+ *   value: Value.fromEther('1'),
+ * })
+ * ```
+ *
+ * @example
+ * ### Attaching Signatures
+ *
+ * It is possible to attach a `signature` to the transaction envelope.
+ *
+ * ```ts twoslash
+ * import { Secp256k1, TransactionEnvelopeEip1559, Value } from 'ox'
+ *
+ * const envelope = TransactionEnvelopeEip1559.from({
+ *   chainId: 1,
+ *   maxFeePerGas: Value.fromGwei('10'),
+ *   maxPriorityFeePerGas: Value.fromGwei('1'),
+ *   to: '0x0000000000000000000000000000000000000000',
+ *   value: Value.fromEther('1'),
+ * })
+ *
+ * const signature = Secp256k1.sign({
+ *   payload: TransactionEnvelopeEip1559.getSignPayload(envelope),
+ *   privateKey: '0x...',
+ * })
+ *
+ * const envelope_signed = TransactionEnvelopeEip1559.from(envelope, { // [!code focus]
+ *   signature, // [!code focus]
+ * }) // [!code focus]
+ * // @log: {
+ * // @log:   chainId: 1,
+ * // @log:   maxFeePerGas: 10000000000n,
+ * // @log:   maxPriorityFeePerGas: 1000000000n,
+ * // @log:   to: '0x0000000000000000000000000000000000000000',
+ * // @log:   type: 'eip1559',
+ * // @log:   value: 1000000000000000000n,
+ * // @log:   r: 125...n,
+ * // @log:   s: 642...n,
+ * // @log:   yParity: 0,
+ * // @log: }
+ * ```
+ *
+ * @example
+ * ### From Serialized
+ *
+ * It is possible to instantiate an EIP-1559 Transaction Envelope from a {@link ox#TransactionEnvelopeEip1559.Serialized} value.
+ *
+ * ```ts twoslash
+ * import { TransactionEnvelopeEip1559 } from 'ox'
+ *
+ * const envelope = TransactionEnvelopeEip1559.from('0x02f858018203118502540be4008504a817c800809470997970c51812dc3a010c7d01b50e0d17dc79c8880de0b6b3a764000080c08477359400e1a001627c687261b0e7f8638af1112efa8a77e23656f6e7945275b19e9deed80261')
+ * // @log: {
+ * // @log:   chainId: 1,
+ * // @log:   maxFeePerGas: 10000000000n,
+ * // @log:   maxPriorityFeePerGas: 1000000000n,
+ * // @log:   to: '0x0000000000000000000000000000000000000000',
+ * // @log:   type: 'eip1559',
+ * // @log:   value: 1000000000000000000n,
+ * // @log: }
+ * ```
+ *
+ * @param envelope - The transaction object to convert.
+ * @param options - Options.
+ * @returns An EIP-1559 Transaction Envelope.
+ */
+export declare function from<const envelope extends UnionPartialBy<TransactionEnvelopeEip1559, 'type'> | Serialized, const signature extends Signature.Signature | undefined = undefined>(envelope: envelope | UnionPartialBy<TransactionEnvelopeEip1559, 'type'> | Serialized, options?: from.Options<signature>): from.ReturnType<envelope, signature>;
+export declare namespace from {
+    var parseError: (error: unknown) => from.ErrorType;
+}
+export declare namespace from {
+    type Options<signature extends Signature.Signature | undefined = undefined> = {
+        signature?: signature | Signature.Signature | undefined;
+    };
+    type ReturnType<envelope extends UnionPartialBy<TransactionEnvelopeEip1559, 'type'> | Hex.Hex = TransactionEnvelopeEip1559 | Hex.Hex, signature extends Signature.Signature | undefined = undefined> = Compute<envelope extends Hex.Hex ? TransactionEnvelopeEip1559 : Assign<envelope, (signature extends Signature.Signature ? Readonly<signature> : {}) & {
+        readonly type: 'eip1559';
+    }>>;
+    type ErrorType = deserialize.ErrorType | assert.ErrorType | Errors.GlobalErrorType;
+}
+/**
+ * Returns the payload to sign for a {@link ox#TransactionEnvelopeEip1559.TransactionEnvelopeEip1559}.
+ *
+ * @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'
+ *
+ * const envelope = TransactionEnvelopeEip1559.from({
+ *   chainId: 1,
+ *   nonce: 0n,
+ *   maxFeePerGas: 1000000000n,
+ *   gas: 21000n,
+ *   to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
+ *   value: 1000000000000000000n,
+ * })
+ *
+ * const payload = TransactionEnvelopeEip1559.getSignPayload(envelope) // [!code focus]
+ * // @log: '0x...'
+ *
+ * const signature = Secp256k1.sign({ payload, privateKey: '0x...' })
+ * ```
+ *
+ * @param envelope - The transaction envelope to get the sign payload for.
+ * @returns The sign payload.
+ */
+export declare function getSignPayload(envelope: TransactionEnvelopeEip1559): getSignPayload.ReturnType;
+export declare namespace getSignPayload {
+    var parseError: (error: unknown) => getSignPayload.ErrorType;
+}
+export declare namespace getSignPayload {
+    type ReturnType = Hex.Hex;
+    type ErrorType = hash.ErrorType | Errors.GlobalErrorType;
+}
+/**
+ * Hashes a {@link ox#TransactionEnvelopeEip1559.TransactionEnvelopeEip1559}. This is the "transaction hash".
+ *
+ * @example
+ * ```ts twoslash
+ * import { Secp256k1, TransactionEnvelopeEip1559 } from 'ox'
+ *
+ * const envelope = TransactionEnvelopeEip1559.from({
+ *   chainId: 1,
+ *   nonce: 0n,
+ *   maxFeePerGas: 1000000000n,
+ *   gas: 21000n,
+ *   to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
+ *   value: 1000000000000000000n,
+ * })
+ *
+ * const signature = Secp256k1.sign({
+ *   payload: TransactionEnvelopeEip1559.getSignPayload(envelope),
+ *   privateKey: '0x...'
+ * })
+ *
+ * const envelope_signed = TransactionEnvelopeEip1559.from(envelope, { signature })
+ *
+ * const hash = TransactionEnvelopeEip1559.hash(envelope_signed) // [!code focus]
+ * ```
+ *
+ * @param envelope - The EIP-1559 Transaction Envelope to hash.
+ * @param options - Options.
+ * @returns The hash of the transaction envelope.
+ */
+export declare function hash<presign extends boolean = false>(envelope: TransactionEnvelopeEip1559<presign extends true ? false : true>, options?: hash.Options<presign>): hash.ReturnType;
+export declare namespace hash {
+    var parseError: (error: unknown) => hash.ErrorType;
+}
+export declare namespace hash {
+    type Options<presign extends boolean = false> = {
+        /** Whether to hash this transaction for signing. @default false */
+        presign?: presign | boolean | undefined;
+    };
+    type ReturnType = Hex.Hex;
+    type ErrorType = Hash.keccak256.ErrorType | serialize.ErrorType | Errors.GlobalErrorType;
+}
+/**
+ * Serializes a {@link ox#TransactionEnvelopeEip1559.TransactionEnvelopeEip1559}.
+ *
+ * @example
+ * ```ts twoslash
+ * import { TransactionEnvelopeEip1559, Value } from 'ox'
+ *
+ * const envelope = TransactionEnvelopeEip1559.from({
+ *   chainId: 1,
+ *   maxFeePerGas: Value.fromGwei('10'),
+ *   maxPriorityFeePerGas: Value.fromGwei('1'),
+ *   to: '0x0000000000000000000000000000000000000000',
+ *   value: Value.fromEther('1'),
+ * })
+ *
+ * const serialized = TransactionEnvelopeEip1559.serialize(envelope) // [!code focus]
+ * ```
+ *
+ * @example
+ * ### Attaching Signatures
+ *
+ * It is possible to attach a `signature` to the serialized Transaction Envelope.
+ *
+ * ```ts twoslash
+ * import { Secp256k1, TransactionEnvelopeEip1559, Value } from 'ox'
+ *
+ * const envelope = TransactionEnvelopeEip1559.from({
+ *   chainId: 1,
+ *   maxFeePerGas: Value.fromGwei('10'),
+ *   maxPriorityFeePerGas: Value.fromGwei('1'),
+ *   to: '0x0000000000000000000000000000000000000000',
+ *   value: Value.fromEther('1'),
+ * })
+ *
+ * const signature = Secp256k1.sign({
+ *   payload: TransactionEnvelopeEip1559.getSignPayload(envelope),
+ *   privateKey: '0x...',
+ * })
+ *
+ * const serialized = TransactionEnvelopeEip1559.serialize(envelope, { // [!code focus]
+ *   signature, // [!code focus]
+ * }) // [!code focus]
+ *
+ * // ... send `serialized` transaction to JSON-RPC `eth_sendRawTransaction`
+ * ```
+ *
+ * @param envelope - The Transaction Envelope to serialize.
+ * @param options - Options.
+ * @returns The serialized Transaction Envelope.
+ */
+export declare function serialize(envelope: PartialBy<TransactionEnvelopeEip1559, 'type'>, options?: serialize.Options): Serialized;
+export declare namespace serialize {
+    var parseError: (error: unknown) => serialize.ErrorType;
+}
+export declare namespace serialize {
+    type Options = {
+        /** Signature to append to the serialized Transaction Envelope. */
+        signature?: Signature.Signature | undefined;
+    };
+    type ErrorType = assert.ErrorType | Hex.fromNumber.ErrorType | Signature.toTuple.ErrorType | Hex.concat.ErrorType | Rlp.fromHex.ErrorType | Errors.GlobalErrorType;
+}
+/**
+ * Converts an {@link ox#TransactionEnvelopeEip1559.TransactionEnvelopeEip1559} to an {@link ox#TransactionEnvelopeEip1559.Rpc}.
+ *
+ * @example
+ * ```ts twoslash
+ * import { RpcRequest, TransactionEnvelopeEip1559, Value } from 'ox'
+ *
+ * const envelope = TransactionEnvelopeEip1559.from({
+ *   chainId: 1,
+ *   nonce: 0n,
+ *   gas: 21000n,
+ *   to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
+ *   value: Value.fromEther('1'),
+ * })
+ *
+ * const envelope_rpc = TransactionEnvelopeEip1559.toRpc(envelope) // [!code focus]
+ *
+ * const request = RpcRequest.from({
+ *   id: 0,
+ *   method: 'eth_sendTransaction',
+ *   params: [envelope_rpc],
+ * })
+ * ```
+ *
+ * @param envelope - The EIP-1559 transaction envelope to convert.
+ * @returns An RPC-formatted EIP-1559 transaction envelope.
+ */
+export declare function toRpc(envelope: Omit<TransactionEnvelopeEip1559, 'type'>): Rpc;
+export declare namespace toRpc {
+    var parseError: (error: unknown) => toRpc.ErrorType;
+}
+export declare namespace toRpc {
+    type ErrorType = Signature.extract.ErrorType | Errors.GlobalErrorType;
+}
+/**
+ * Validates a {@link ox#TransactionEnvelopeEip1559.TransactionEnvelopeEip1559}. Returns `true` if the envelope is valid, `false` otherwise.
+ *
+ * @example
+ * ```ts twoslash
+ * import { TransactionEnvelopeEip1559, Value } from 'ox'
+ *
+ * const valid = TransactionEnvelopeEip1559.assert({
+ *   maxFeePerGas: 2n ** 256n - 1n + 1n,
+ *   chainId: 1,
+ *   to: '0x0000000000000000000000000000000000000000',
+ *   value: Value.fromEther('1'),
+ * })
+ * // @log: false
+ * ```
+ *
+ * @param envelope - The transaction envelope to validate.
+ */
+export declare function validate(envelope: PartialBy<TransactionEnvelopeEip1559, 'type'>): boolean;
+export declare namespace validate {
+    var parseError: (error: unknown) => validate.ErrorType;
+}
+export declare namespace validate {
+    type ErrorType = Errors.GlobalErrorType;
+}
+//# sourceMappingURL=TransactionEnvelopeEip1559.d.ts.map

package/_types/TransactionEnvelopeEip1559.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TransactionEnvelopeEip1559.d.ts","sourceRoot":"","sources":["../TransactionEnvelopeEip1559.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,UAAU,MAAM,iBAAiB,CAAA;AAC7C,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AACvC,OAAO,KAAK,KAAK,MAAM,MAAM,aAAa,CAAA;AAC1C,OAAO,KAAK,IAAI,MAAM,WAAW,CAAA;AACjC,OAAO,KAAK,GAAG,MAAM,UAAU,CAAA;AAC/B,OAAO,KAAK,GAAG,MAAM,UAAU,CAAA;AAC/B,OAAO,KAAK,SAAS,MAAM,gBAAgB,CAAA;AAC3C,OAAO,KAAK,mBAAmB,MAAM,0BAA0B,CAAA;AAC/D,OAAO,KAAK,EACV,MAAM,EACN,OAAO,EACP,SAAS,EACT,cAAc,EACf,MAAM,qBAAqB,CAAA;AAE5B,MAAM,MAAM,0BAA0B,CACpC,MAAM,SAAS,OAAO,GAAG,OAAO,EAChC,UAAU,GAAG,MAAM,EACnB,UAAU,GAAG,MAAM,EACnB,IAAI,SAAS,MAAM,GAAG,IAAI,IACxB,OAAO,CACT,mBAAmB,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU,CAAC,GAAG;IAC/D,4BAA4B;IAC5B,UAAU,CAAC,EAAE,UAAU,CAAC,UAAU,GAAG,SAAS,CAAA;IAC9C,gFAAgF;IAChF,YAAY,CAAC,EAAE,UAAU,GAAG,SAAS,CAAA;IACrC,yCAAyC;IACzC,oBAAoB,CAAC,EAAE,UAAU,GAAG,SAAS,CAAA;CAC9C,CACF,CAAA;AAED,MAAM,MAAM,GAAG,CAAC,MAAM,SAAS,OAAO,GAAG,OAAO,IAAI,0BAA0B,CAC5E,MAAM,EACN,GAAG,CAAC,GAAG,EACP,GAAG,CAAC,GAAG,EACP,KAAK,CACN,CAAA;AAED,MAAM,MAAM,UAAU,GAAG,GAAG,cAAc,GAAG,MAAM,EAAE,CAAA;AAErD,eAAO,MAAM,cAAc,QAAkB,CAAA;AAC7C,MAAM,MAAM,cAAc,GAAG,OAAO,cAAc,CAAA;AAElD,MAAM,MAAM,MAAM,GAAG,0BAA0B,CAAC,IAAI,CAAC,CAAA;AAErD,eAAO,MAAM,IAAI,WAAqB,CAAA;AACtC,MAAM,MAAM,IAAI,GAAG,OAAO,IAAI,CAAA;AAE9B;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,MAAM,CACpB,QAAQ,EAAE,SAAS,CAAC,0BAA0B,EAAE,MAAM,CAAC,QAiBxD;yBAlBe,MAAM;4BA6BM,OAAO,KAExB,MAAM,CAAC,SAAS;;AAX3B,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,KAAK,SAAS,GACV,OAAO,CAAC,MAAM,CAAC,SAAS,GACxB,mBAAmB,CAAC,mBAAmB,GACvC,mBAAmB,CAAC,kBAAkB,GACtC,mBAAmB,CAAC,mBAAmB,GACvC,MAAM,CAAC,eAAe,CAAA;CAC3B;AAMD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,WAAW,CACzB,UAAU,EAAE,UAAU,GACrB,OAAO,CAAC,0BAA0B,CAAC,CAqErC;yBAvEe,WAAW;4BA6EM,OAAO,KAE7B,WAAW,CAAC,SAAS;;AANhC,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,KAAK,SAAS,GAAG,MAAM,CAAC,eAAe,CAAA;CACxC;AAMD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2EG;AACH,wBAAgB,IAAI,CAClB,KAAK,CAAC,QAAQ,SACV,cAAc,CAAC,0BAA0B,EAAE,MAAM,CAAC,GAClD,UAAU,EACd,KAAK,CAAC,SAAS,SAAS,SAAS,CAAC,SAAS,GAAG,SAAS,GAAG,SAAS,EAEnE,QAAQ,EACJ,QAAQ,GACR,cAAc,CAAC,0BAA0B,EAAE,MAAM,CAAC,GAClD,UAAU,EACd,OAAO,GAAE,IAAI,CAAC,OAAO,CAAC,SAAS,CAAM,GACpC,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,SAAS,CAAC,CActC;yBAzBe,IAAI;4BAuDM,OAAO,KAEtB,IAAI,CAAC,SAAS;;AA9BzB,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,KAAK,OAAO,CAAC,SAAS,SAAS,SAAS,CAAC,SAAS,GAAG,SAAS,GAAG,SAAS,IACxE;QACE,SAAS,CAAC,EAAE,SAAS,GAAG,SAAS,CAAC,SAAS,GAAG,SAAS,CAAA;KACxD,CAAA;IAEH,KAAK,UAAU,CACb,QAAQ,SACJ,cAAc,CAAC,0BAA0B,EAAE,MAAM,CAAC,GAClD,GAAG,CAAC,GAAG,GAAG,0BAA0B,GAAG,GAAG,CAAC,GAAG,EAClD,SAAS,SAAS,SAAS,CAAC,SAAS,GAAG,SAAS,GAAG,SAAS,IAC3D,OAAO,CACT,QAAQ,SAAS,GAAG,CAAC,GAAG,GACpB,0BAA0B,GAC1B,MAAM,CACJ,QAAQ,EACR,CAAC,SAAS,SAAS,SAAS,CAAC,SAAS,GAAG,QAAQ,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC,GAAG;QACnE,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAA;KACzB,CACF,CACN,CAAA;IAED,KAAK,SAAS,GACV,WAAW,CAAC,SAAS,GACrB,MAAM,CAAC,SAAS,GAChB,MAAM,CAAC,eAAe,CAAA;CAC3B;AAMD;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAgB,cAAc,CAC5B,QAAQ,EAAE,0BAA0B,GACnC,cAAc,CAAC,UAAU,CAE3B;yBAJe,cAAc;4BAYM,OAAO,KAEhC,cAAc,CAAC,SAAS;;AARnC,MAAM,CAAC,OAAO,WAAW,cAAc,CAAC;IACtC,KAAK,UAAU,GAAG,GAAG,CAAC,GAAG,CAAA;IAEzB,KAAK,SAAS,GAAG,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,eAAe,CAAA;CACzD;AAMD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,wBAAgB,IAAI,CAAC,OAAO,SAAS,OAAO,GAAG,KAAK,EAClD,QAAQ,EAAE,0BAA0B,CAAC,OAAO,SAAS,IAAI,GAAG,KAAK,GAAG,IAAI,CAAC,EACzE,OAAO,GAAE,IAAI,CAAC,OAAO,CAAC,OAAO,CAAM,GAClC,IAAI,CAAC,UAAU,CAejB;yBAlBe,IAAI;4BAkCM,OAAO,KAEtB,IAAI,CAAC,SAAS;;AAhBzB,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,KAAK,OAAO,CAAC,OAAO,SAAS,OAAO,GAAG,KAAK,IAAI;QAC9C,mEAAmE;QACnE,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,GAAG,SAAS,CAAA;KACxC,CAAA;IAED,KAAK,UAAU,GAAG,GAAG,CAAC,GAAG,CAAA;IAEzB,KAAK,SAAS,GACV,IAAI,CAAC,SAAS,CAAC,SAAS,GACxB,SAAS,CAAC,SAAS,GACnB,MAAM,CAAC,eAAe,CAAA;CAC3B;AAMD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiDG;AACH,wBAAgB,SAAS,CACvB,QAAQ,EAAE,SAAS,CAAC,0BAA0B,EAAE,MAAM,CAAC,EACvD,OAAO,GAAE,SAAS,CAAC,OAAY,GAC9B,UAAU,CAkCZ;yBArCe,SAAS;4BAuDM,OAAO,KAAc,SAAS,CAAC,SAAS;;AAhBvE,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,KAAK,OAAO,GAAG;QACb,kEAAkE;QAClE,SAAS,CAAC,EAAE,SAAS,CAAC,SAAS,GAAG,SAAS,CAAA;KAC5C,CAAA;IAED,KAAK,SAAS,GACV,MAAM,CAAC,SAAS,GAChB,GAAG,CAAC,UAAU,CAAC,SAAS,GACxB,SAAS,CAAC,OAAO,CAAC,SAAS,GAC3B,GAAG,CAAC,MAAM,CAAC,SAAS,GACpB,GAAG,CAAC,OAAO,CAAC,SAAS,GACrB,MAAM,CAAC,eAAe,CAAA;CAC3B;AAKD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC,0BAA0B,EAAE,MAAM,CAAC,GAAG,GAAG,CA2B7E;yBA3Be,KAAK;4BAkCM,OAAO,KAAc,KAAK,CAAC,SAAS;;AAL/D,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,KAAY,SAAS,GAAG,SAAS,CAAC,OAAO,CAAC,SAAS,GAAG,MAAM,CAAC,eAAe,CAAA;CAC7E;AAKD;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,QAAQ,CACtB,QAAQ,EAAE,SAAS,CAAC,0BAA0B,EAAE,MAAM,CAAC,WAQxD;yBATe,QAAQ;4BAeM,OAAO,KAE1B,QAAQ,CAAC,SAAS;;AAN7B,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,KAAK,SAAS,GAAG,MAAM,CAAC,eAAe,CAAA;CACxC"}