ox 0.14.29 → 1.0.0-beta.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023-present wevm
+Copyright (c) 2024-present weth, LLC
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

package/dist/core/Abi.d.ts

@@ -0,0 +1,102 @@
+import * as abitype from 'abitype';
+import type * as Errors from './Errors.js';
+import type * as AbiItem_internal from './internal/abiItem.js';
+/** Root type for an ABI. */
+export type Abi = abitype.Abi;
+/** @internal */
+export declare function format<const abi extends Abi>(abi: abi): format.ReturnType<abi>;
+/**
+ * Formats an {@link ox#Abi.Abi} into a **Human Readable ABI**.
+ *
+ * @example
+ * ```ts twoslash
+ * import { Abi } from 'ox'
+ *
+ * const formatted = Abi.format([
+ *   {
+ *     type: 'function',
+ *     name: 'approve',
+ *     stateMutability: 'nonpayable',
+ *     inputs: [
+ *       {
+ *         name: 'spender',
+ *         type: 'address'
+ *       },
+ *       {
+ *         name: 'amount',
+ *         type: 'uint256'
+ *       }
+ *     ],
+ *     outputs: [{ type: 'bool' }]
+ *   }
+ * ])
+ *
+ * formatted
+ * //    ^?
+ * ```
+ *
+ * @param abi - The ABI to format.
+ * @returns The formatted ABI.
+ */
+export declare function format(abi: Abi | readonly unknown[]): readonly string[];
+export declare namespace format {
+    type ReturnType<abi extends Abi | readonly unknown[] = Abi> = abitype.FormatAbi<abi>;
+    type ErrorType = Errors.GlobalErrorType;
+}
+/** @internal */
+export declare function from<const abi extends Abi | readonly string[]>(abi: abi & (abi extends readonly string[] ? AbiItem_internal.Signatures<abi> : unknown)): from.ReturnType<abi>;
+/**
+ * Parses an arbitrary **JSON ABI** or **Human Readable ABI** into a typed {@link ox#Abi.Abi}.
+ *
+ * @example
+ * ### JSON ABIs
+ *
+ * ```ts twoslash
+ * import { Abi } from 'ox'
+ *
+ * const abi = Abi.from([
+ *   {
+ *     type: 'function',
+ *     name: 'approve',
+ *     stateMutability: 'nonpayable',
+ *     inputs: [
+ *       {
+ *         name: 'spender',
+ *         type: 'address'
+ *       },
+ *       {
+ *         name: 'amount',
+ *         type: 'uint256'
+ *       }
+ *     ],
+ *     outputs: [{ type: 'bool' }]
+ *   }
+ * ])
+ *
+ * abi
+ * //^?
+ * ```
+ *
+ * @example
+ * ### Human Readable ABIs
+ *
+ * ```ts twoslash
+ * import { Abi } from 'ox'
+ *
+ * const abi = Abi.from([
+ *   'function approve(address spender, uint256 amount) returns (bool)'
+ * ])
+ *
+ * abi
+ * //^?
+ * ```
+ *
+ * @param abi - The ABI to parse.
+ * @returns The typed ABI.
+ */
+export declare function from(abi: Abi | readonly string[]): Abi;
+export declare namespace from {
+    type ReturnType<abi extends Abi | readonly string[] | readonly unknown[] = Abi> = abi extends readonly string[] ? abitype.ParseAbi<abi> : abi;
+    type ErrorType = Errors.GlobalErrorType;
+}
+//# sourceMappingURL=Abi.d.ts.map

package/dist/core/Abi.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Abi.d.ts","sourceRoot":"","sources":["../../src/core/Abi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,SAAS,CAAA;AAClC,OAAO,KAAK,KAAK,MAAM,MAAM,aAAa,CAAA;AAE1C,OAAO,KAAK,KAAK,gBAAgB,MAAM,uBAAuB,CAAA;AAE9D,4BAA4B;AAC5B,MAAM,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,CAAA;AAE7B,gBAAgB;AAChB,wBAAgB,MAAM,CAAC,KAAK,CAAC,GAAG,SAAS,GAAG,EAAE,GAAG,EAAE,GAAG,GAAG,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,CAAA;AAC/E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,wBAAgB,MAAM,CAAC,GAAG,EAAE,GAAG,GAAG,SAAS,OAAO,EAAE,GAAG,SAAS,MAAM,EAAE,CAAA;AAMxE,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,KAAK,UAAU,CAAC,GAAG,SAAS,GAAG,GAAG,SAAS,OAAO,EAAE,GAAG,GAAG,IACxD,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,CAAA;IAExB,KAAK,SAAS,GAAG,MAAM,CAAC,eAAe,CAAA;CACxC;AAED,gBAAgB;AAChB,wBAAgB,IAAI,CAAC,KAAK,CAAC,GAAG,SAAS,GAAG,GAAG,SAAS,MAAM,EAAE,EAC5D,GAAG,EAAE,GAAG,GACN,CAAC,GAAG,SAAS,SAAS,MAAM,EAAE,GAC1B,gBAAgB,CAAC,UAAU,CAAC,GAAG,CAAC,GAChC,OAAO,CAAC,GACb,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAA;AACvB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgDG;AACH,wBAAgB,IAAI,CAAC,GAAG,EAAE,GAAG,GAAG,SAAS,MAAM,EAAE,GAAG,GAAG,CAAA;AAOvD,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,KAAK,UAAU,CACb,GAAG,SAAS,GAAG,GAAG,SAAS,MAAM,EAAE,GAAG,SAAS,OAAO,EAAE,GAAG,GAAG,IAC5D,GAAG,SAAS,SAAS,MAAM,EAAE,GAAG,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,GAAG,CAAA;IAE/D,KAAK,SAAS,GAAG,MAAM,CAAC,eAAe,CAAA;CACxC"}

package/dist/core/Abi.js

@@ -0,0 +1,13 @@
+import * as abitype from 'abitype';
+import * as internal from './internal/abi.js';
+// eslint-disable-next-line jsdoc-js/require-jsdoc
+export function format(abi) {
+    return abitype.formatAbi(abi);
+}
+// eslint-disable-next-line jsdoc-js/require-jsdoc
+export function from(abi) {
+    if (internal.isSignatures(abi))
+        return abitype.parseAbi(abi);
+    return abi;
+}
+//# sourceMappingURL=Abi.js.map

package/dist/core/Abi.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Abi.js","sourceRoot":"","sources":["../../src/core/Abi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,SAAS,CAAA;AAElC,OAAO,KAAK,QAAQ,MAAM,mBAAmB,CAAA;AA0C7C,kDAAkD;AAClD,MAAM,UAAU,MAAM,CAAC,GAA6B;IAClD,OAAO,OAAO,CAAC,SAAS,CAAC,GAAG,CAAU,CAAA;AACxC,CAAC;AAkED,kDAAkD;AAClD,MAAM,UAAU,IAAI,CAAC,GAA4B;IAC/C,IAAI,QAAQ,CAAC,YAAY,CAAC,GAAG,CAAC;QAAE,OAAO,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAA;IAC5D,OAAO,GAAG,CAAA;AACZ,CAAC"}

package/dist/core/AbiConstructor.d.ts

@@ -0,0 +1,319 @@
+import * as abitype from 'abitype';
+import type * as Abi from './Abi.js';
+import * as AbiItem from './AbiItem.js';
+import * as AbiParameters from './AbiParameters.js';
+import * as Errors from './Errors.js';
+import * as Hex from './Hex.js';
+import type * as internal from './internal/abiConstructor.js';
+import type { IsNarrowable } from './internal/types.js';
+/** Root type for an {@link ox#AbiItem.AbiItem} with a `constructor` type. */
+export type AbiConstructor = abitype.AbiConstructor;
+type ExtractConstructor<abi extends Abi.Abi | readonly unknown[]> = [
+    fromAbi.ReturnType<abi>
+] extends [never] ? undefined : fromAbi.ReturnType<abi> extends AbiConstructor ? fromAbi.ReturnType<abi> : undefined;
+type ExtractArgs<abiConstructor extends AbiConstructor | undefined> = [
+    abiConstructor
+] extends [never] ? readonly [] : abiConstructor extends AbiConstructor ? abitype.AbiParametersToPrimitiveTypes<abiConstructor['inputs']> : readonly [];
+/**
+ * ABI-decodes the provided constructor input (`inputs`).
+ *
+ * @example
+ * ```ts twoslash
+ * import { AbiConstructor } from 'ox'
+ *
+ * const constructor = AbiConstructor.from(
+ *   'constructor(address, uint256)'
+ * )
+ *
+ * const bytecode = '0x...'
+ *
+ * const data = AbiConstructor.encode(constructor, {
+ *   bytecode,
+ *   args: ['0xd8da6bf26964af9d7eed9e03e53415d37aa96045', 123n]
+ * })
+ *
+ * const decoded = AbiConstructor.decode(constructor, {
+ *   // [!code focus]
+ *   bytecode, // [!code focus]
+ *   data // [!code focus]
+ * }) // [!code focus]
+ * ```
+ *
+ * @example
+ * ### ABI-shorthand
+ *
+ * You can also specify an entire ABI object as a parameter to `AbiConstructor.decode`.
+ *
+ * ```ts twoslash
+ * // @noErrors
+ * import { Abi, AbiConstructor } from 'ox'
+ *
+ * const abi = Abi.from([...])
+ *
+ * const data = AbiConstructor.encode(abi, {
+ *   bytecode: '0x...',
+ *   args: ['0xd8da6bf26964af9d7eed9e03e53415d37aa96045', 123n],
+ * })
+ *
+ * const decoded = AbiConstructor.decode(abi, { // [!code focus]
+ *   bytecode: '0x...', // [!code focus]
+ *   data, // [!code focus]
+ * }) // [!code focus]
+ * ```
+ *
+ * @param abiConstructor - The ABI Constructor to decode.
+ * @param options - Decoding options.
+ * @returns The decoded constructor inputs.
+ */
+export declare function decode<const abi extends Abi.Abi | readonly unknown[], abiConstructor extends AbiConstructor | undefined = ExtractConstructor<abi>>(abi: abi | Abi.Abi | readonly unknown[], options: decode.Options): decode.ReturnType<abiConstructor>;
+export declare function decode<const abiConstructor extends AbiConstructor>(abiConstructor: abiConstructor | AbiConstructor, options: decode.Options): decode.ReturnType<abiConstructor>;
+export declare namespace decode {
+    interface Options {
+        /** The bytecode of the contract. */
+        bytecode: Hex.Hex;
+        /** The encoded constructor. */
+        data: Hex.Hex;
+        /**
+         * Whether decoded addresses should be checksummed.
+         *
+         * @default true
+         */
+        checksumAddress?: boolean | undefined;
+    }
+    type ReturnType<abiConstructor extends AbiConstructor | undefined = AbiConstructor> = (abiConstructor extends undefined ? undefined : abiConstructor extends AbiConstructor ? abiConstructor['inputs']['length'] extends 0 ? undefined : abitype.AbiParametersToPrimitiveTypes<abiConstructor['inputs']> : never) | (IsNarrowable<abiConstructor, AbiConstructor> extends true ? never : undefined);
+    type ErrorType = Errors.GlobalErrorType;
+}
+/**
+ * ABI-encodes the provided constructor input (`inputs`).
+ *
+ * @example
+ * ```ts twoslash
+ * import { AbiConstructor } from 'ox'
+ *
+ * const constructor = AbiConstructor.from(
+ *   'constructor(address, uint256)'
+ * )
+ *
+ * const data = AbiConstructor.encode(constructor, {
+ *   bytecode: '0x...',
+ *   args: ['0xd8da6bf26964af9d7eed9e03e53415d37aa96045', 123n]
+ * })
+ * ```
+ *
+ * @example
+ * ### ABI-shorthand
+ *
+ * You can also specify an entire ABI object as a parameter to `AbiConstructor.encode`.
+ *
+ * ```ts twoslash
+ * // @noErrors
+ * import { Abi, AbiConstructor } from 'ox'
+ *
+ * const abi = Abi.from([...])
+ *
+ * const data = AbiConstructor.encode(abi, { // [!code focus]
+ *   bytecode: '0x...', // [!code focus]
+ *   args: ['0xd8da6bf26964af9d7eed9e03e53415d37aa96045', 123n], // [!code focus]
+ * }) // [!code focus]
+ * ```
+ *
+ * @example
+ * ### End-to-end
+ *
+ * Below is an end-to-end example of using `AbiConstructor.encode` to encode the constructor of a contract and deploy it.
+ *
+ * ```ts twoslash
+ * import 'ox/window'
+ * import { AbiConstructor, Hex } from 'ox'
+ *
+ * // 1. Instantiate the ABI Constructor.
+ * const constructor = AbiConstructor.from(
+ *   'constructor(address owner, uint256 amount)'
+ * )
+ *
+ * // 2. Encode the ABI Constructor.
+ * const data = AbiConstructor.encode(constructor, {
+ *   bytecode: '0x...',
+ *   args: ['0xd8da6bf26964af9d7eed9e03e53415d37aa96045', 123n]
+ * })
+ *
+ * // 3. Deploy the contract.
+ * const hash = await window.ethereum!.request({
+ *   method: 'eth_sendTransaction',
+ *   params: [{ data }]
+ * })
+ * ```
+ *
+ * :::note
+ *
+ * For simplicity, the above example uses `window.ethereum.request`, but you can use any
+ * type of JSON-RPC interface.
+ *
+ * :::
+ *
+ * @param abiConstructor - The ABI Constructor to encode.
+ * @param options - Encoding options.
+ * @returns The encoded constructor.
+ */
+export declare function encode<const abi extends Abi.Abi | readonly unknown[], abiConstructor extends AbiConstructor | undefined = ExtractConstructor<abi>>(abi: abi | Abi.Abi | readonly unknown[], options: encode.Options<abiConstructor>): encode.ReturnType;
+export declare function encode<const abiConstructor extends AbiConstructor>(abiConstructor: abiConstructor | AbiConstructor, options: encode.Options<abiConstructor>): encode.ReturnType;
+export declare namespace encode {
+    type Options<abiConstructor extends AbiConstructor | undefined = AbiConstructor, args extends ExtractArgs<abiConstructor> = ExtractArgs<abiConstructor>> = {
+        /** The bytecode of the contract. */
+        bytecode: Hex.Hex;
+        /** The constructor arguments to encode. */
+        args?: args | undefined;
+    } & (readonly [] extends args ? {} : {
+        /** The constructor arguments to encode. */
+        args: args;
+    });
+    type ReturnType = Hex.Hex;
+    type ErrorType = Hex.concat.ErrorType | AbiParameters.encode.ErrorType | Errors.GlobalErrorType;
+}
+/** @internal */
+export declare function format<const abiConstructor extends AbiConstructor>(abiConstructor: abiConstructor): format.ReturnType<abiConstructor>;
+/**
+ * Formats an {@link ox#AbiConstructor.AbiConstructor} into a **Human Readable ABI Function**.
+ *
+ * @example
+ * ```ts twoslash
+ * import { AbiConstructor } from 'ox'
+ *
+ * const formatted = AbiConstructor.format({
+ *   inputs: [{ name: 'owner', type: 'address' }],
+ *   payable: false,
+ *   stateMutability: 'nonpayable',
+ *   type: 'constructor'
+ * })
+ *
+ * formatted
+ * //    ^?
+ * ```
+ *
+ * @param abiConstructor - The ABI Constructor to format.
+ * @returns The formatted ABI Constructor.
+ */
+export declare function format(abiConstructor: AbiConstructor): string;
+export declare namespace format {
+    type ReturnType<abiConstructor extends AbiConstructor = AbiConstructor> = abitype.FormatAbiItem<abiConstructor>;
+    type ErrorType = Errors.GlobalErrorType;
+}
+/** @internal */
+export declare function from<const abiConstructor extends AbiConstructor | string | readonly string[]>(abiConstructor: (abiConstructor | string | readonly string[]) & ((abiConstructor extends string ? internal.Signature<abiConstructor> : never) | (abiConstructor extends readonly string[] ? internal.Signatures<abiConstructor> : never) | AbiConstructor)): from.ReturnType<abiConstructor>;
+/**
+ * Parses an arbitrary **JSON ABI Constructor** or **Human Readable ABI Constructor** into a typed {@link ox#AbiConstructor.AbiConstructor}.
+ *
+ * @example
+ * ### JSON ABIs
+ *
+ * ```ts twoslash
+ * import { AbiConstructor } from 'ox'
+ *
+ * const constructor = AbiConstructor.from({
+ *   inputs: [{ name: 'owner', type: 'address' }],
+ *   payable: false,
+ *   stateMutability: 'nonpayable',
+ *   type: 'constructor'
+ * })
+ *
+ * constructor
+ * //^?
+ * ```
+ *
+ * @example
+ * ### Human Readable ABIs
+ *
+ * A Human Readable ABI can be parsed into a typed ABI object:
+ *
+ * ```ts twoslash
+ * import { AbiConstructor } from 'ox'
+ *
+ * const constructor = AbiConstructor.from(
+ *   'constructor(address owner)' // [!code hl]
+ * )
+ *
+ * constructor
+ * //^?
+ * ```
+ *
+ * @example
+ * It is possible to specify `struct`s along with your definitions:
+ *
+ * ```ts twoslash
+ * import { AbiConstructor } from 'ox'
+ *
+ * const constructor = AbiConstructor.from([
+ *   'struct Foo { address owner; uint256 amount; }', // [!code hl]
+ *   'constructor(Foo foo)'
+ * ])
+ *
+ * constructor
+ * //^?
+ * ```
+ *
+ *
+ *
+ * @param abiConstructor - The ABI Constructor to parse.
+ * @returns Typed ABI Constructor.
+ */
+export declare function from(abiConstructor: AbiConstructor | string | readonly string[]): AbiConstructor;
+export declare namespace from {
+    type ReturnType<abiConstructor extends AbiConstructor | string | readonly string[] = AbiConstructor> = AbiItem.from.ReturnType<abiConstructor>;
+    type ErrorType = AbiItem.from.ErrorType | Errors.GlobalErrorType;
+}
+/** @internal */
+export declare function fromAbi<const abi extends Abi.Abi | readonly unknown[]>(abi: abi | Abi.Abi | readonly unknown[]): fromAbi.ReturnType<abi>;
+/**
+ * Extracts an {@link ox#AbiConstructor.AbiConstructor} from an {@link ox#Abi.Abi} given a name and optional arguments.
+ *
+ * @example
+ * ### Extracting by Name
+ *
+ * ABI Events can be extracted by their name using the `name` option:
+ *
+ * ```ts twoslash
+ * import { Abi, AbiConstructor } from 'ox'
+ *
+ * const abi = Abi.from([
+ *   'constructor(address owner)',
+ *   'function foo()',
+ *   'event Transfer(address owner, address to, uint256 tokenId)',
+ *   'function bar(string a) returns (uint256 x)'
+ * ])
+ *
+ * const item = AbiConstructor.fromAbi(abi) // [!code focus]
+ * //    ^?
+ * ```
+ *
+ * @returns The ABI constructor.
+ */
+export declare function fromAbi(abi: Abi.Abi | readonly unknown[]): AbiConstructor;
+export declare namespace fromAbi {
+    type ReturnType<abi extends Abi.Abi | readonly unknown[] = Abi.Abi> = Extract<abi[number], {
+        type: 'constructor';
+    }>;
+    type ErrorType = AbiItem.NotFoundError | Errors.GlobalErrorType;
+}
+/**
+ * Throws when the provided `data` does not begin with the provided `bytecode`.
+ *
+ * @example
+ * ```ts twoslash
+ * import { AbiConstructor } from 'ox'
+ *
+ * AbiConstructor.decode(
+ *   AbiConstructor.from('constructor(address)'),
+ *   { bytecode: '0x6080...', data: '0xdeadbeef' }
+ * )
+ * // @error: AbiConstructor.BytecodeMismatchError: Provided `data` does not start with the provided `bytecode`.
+ * ```
+ */
+export declare class BytecodeMismatchError extends Errors.BaseError {
+    readonly name = "AbiConstructor.BytecodeMismatchError";
+    constructor({ bytecode, data }: {
+        bytecode: Hex.Hex;
+        data: Hex.Hex;
+    });
+}
+export {};
+//# sourceMappingURL=AbiConstructor.d.ts.map

package/dist/core/AbiConstructor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AbiConstructor.d.ts","sourceRoot":"","sources":["../../src/core/AbiConstructor.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,SAAS,CAAA;AAClC,OAAO,KAAK,KAAK,GAAG,MAAM,UAAU,CAAA;AACpC,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AACvC,OAAO,KAAK,aAAa,MAAM,oBAAoB,CAAA;AACnD,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA;AACrC,OAAO,KAAK,GAAG,MAAM,UAAU,CAAA;AAC/B,OAAO,KAAK,KAAK,QAAQ,MAAM,8BAA8B,CAAA;AAC7D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAA;AAEvD,6EAA6E;AAC7E,MAAM,MAAM,cAAc,GAAG,OAAO,CAAC,cAAc,CAAA;AAEnD,KAAK,kBAAkB,CAAC,GAAG,SAAS,GAAG,CAAC,GAAG,GAAG,SAAS,OAAO,EAAE,IAAI;IAClE,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC;CACxB,SAAS,CAAC,KAAK,CAAC,GACb,SAAS,GACT,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,SAAS,cAAc,GAC5C,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,GACvB,SAAS,CAAA;AAEf,KAAK,WAAW,CAAC,cAAc,SAAS,cAAc,GAAG,SAAS,IAAI;IACpE,cAAc;CACf,SAAS,CAAC,KAAK,CAAC,GACb,SAAS,EAAE,GACX,cAAc,SAAS,cAAc,GACnC,OAAO,CAAC,6BAA6B,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC,GAC/D,SAAS,EAAE,CAAA;AAEjB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkDG;AACH,wBAAgB,MAAM,CACpB,KAAK,CAAC,GAAG,SAAS,GAAG,CAAC,GAAG,GAAG,SAAS,OAAO,EAAE,EAC9C,cAAc,SAAS,cAAc,GAAG,SAAS,GAAG,kBAAkB,CAAC,GAAG,CAAC,EAE3E,GAAG,EAAE,GAAG,GAAG,GAAG,CAAC,GAAG,GAAG,SAAS,OAAO,EAAE,EACvC,OAAO,EAAE,MAAM,CAAC,OAAO,GACtB,MAAM,CAAC,UAAU,CAAC,cAAc,CAAC,CAAA;AACpC,wBAAgB,MAAM,CAAC,KAAK,CAAC,cAAc,SAAS,cAAc,EAChE,cAAc,EAAE,cAAc,GAAG,cAAc,EAC/C,OAAO,EAAE,MAAM,CAAC,OAAO,GACtB,MAAM,CAAC,UAAU,CAAC,cAAc,CAAC,CAAA;AAiCpC,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,UAAU,OAAO;QACf,oCAAoC;QACpC,QAAQ,EAAE,GAAG,CAAC,GAAG,CAAA;QACjB,+BAA+B;QAC/B,IAAI,EAAE,GAAG,CAAC,GAAG,CAAA;QACb;;;;WAIG;QACH,eAAe,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;KACtC;IAED,KAAK,UAAU,CACb,cAAc,SAAS,cAAc,GAAG,SAAS,GAAG,cAAc,IAEhE,CAAC,cAAc,SAAS,SAAS,GAC7B,SAAS,GACT,cAAc,SAAS,cAAc,GACnC,cAAc,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,GAC1C,SAAS,GACT,OAAO,CAAC,6BAA6B,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC,GACjE,KAAK,CAAC,GACZ,CAAC,YAAY,CAAC,cAAc,EAAE,cAAc,CAAC,SAAS,IAAI,GACtD,KAAK,GACL,SAAS,CAAC,CAAA;IAElB,KAAK,SAAS,GAAG,MAAM,CAAC,eAAe,CAAA;CACxC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuEG;AACH,wBAAgB,MAAM,CACpB,KAAK,CAAC,GAAG,SAAS,GAAG,CAAC,GAAG,GAAG,SAAS,OAAO,EAAE,EAC9C,cAAc,SAAS,cAAc,GAAG,SAAS,GAAG,kBAAkB,CAAC,GAAG,CAAC,EAE3E,GAAG,EAAE,GAAG,GAAG,GAAG,CAAC,GAAG,GAAG,SAAS,OAAO,EAAE,EACvC,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,GACtC,MAAM,CAAC,UAAU,CAAA;AACpB,wBAAgB,MAAM,CAAC,KAAK,CAAC,cAAc,SAAS,cAAc,EAChE,cAAc,EAAE,cAAc,GAAG,cAAc,EAC/C,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,GACtC,MAAM,CAAC,UAAU,CAAA;AA8BpB,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,KAAK,OAAO,CACV,cAAc,SAAS,cAAc,GAAG,SAAS,GAAG,cAAc,EAElE,IAAI,SAAS,WAAW,CAAC,cAAc,CAAC,GAAG,WAAW,CAAC,cAAc,CAAC,IACpE;QACF,oCAAoC;QACpC,QAAQ,EAAE,GAAG,CAAC,GAAG,CAAA;QACjB,2CAA2C;QAC3C,IAAI,CAAC,EAAE,IAAI,GAAG,SAAS,CAAA;KACxB,GAAG,CAAC,SAAS,EAAE,SAAS,IAAI,GACzB,EAAE,GACF;QACE,2CAA2C;QAC3C,IAAI,EAAE,IAAI,CAAA;KACX,CAAC,CAAA;IAEN,KAAK,UAAU,GAAG,GAAG,CAAC,GAAG,CAAA;IAEzB,KAAK,SAAS,GACV,GAAG,CAAC,MAAM,CAAC,SAAS,GACpB,aAAa,CAAC,MAAM,CAAC,SAAS,GAC9B,MAAM,CAAC,eAAe,CAAA;CAC3B;AAED,gBAAgB;AAChB,wBAAgB,MAAM,CAAC,KAAK,CAAC,cAAc,SAAS,cAAc,EAChE,cAAc,EAAE,cAAc,GAC7B,MAAM,CAAC,UAAU,CAAC,cAAc,CAAC,CAAA;AACpC;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,MAAM,CAAC,cAAc,EAAE,cAAc,GAAG,MAAM,CAAA;AAM9D,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,KAAK,UAAU,CAAC,cAAc,SAAS,cAAc,GAAG,cAAc,IACpE,OAAO,CAAC,aAAa,CAAC,cAAc,CAAC,CAAA;IAEvC,KAAK,SAAS,GAAG,MAAM,CAAC,eAAe,CAAA;CACxC;AAED,gBAAgB;AAChB,wBAAgB,IAAI,CAClB,KAAK,CAAC,cAAc,SAAS,cAAc,GAAG,MAAM,GAAG,SAAS,MAAM,EAAE,EAExE,cAAc,EAAE,CAAC,cAAc,GAAG,MAAM,GAAG,SAAS,MAAM,EAAE,CAAC,GAC3D,CACI,CAAC,cAAc,SAAS,MAAM,GAC1B,QAAQ,CAAC,SAAS,CAAC,cAAc,CAAC,GAClC,KAAK,CAAC,GACV,CAAC,cAAc,SAAS,SAAS,MAAM,EAAE,GACrC,QAAQ,CAAC,UAAU,CAAC,cAAc,CAAC,GACnC,KAAK,CAAC,GACV,cAAc,CACjB,GACF,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,CAAA;AAClC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuDG;AACH,wBAAgB,IAAI,CAClB,cAAc,EAAE,cAAc,GAAG,MAAM,GAAG,SAAS,MAAM,EAAE,GAC1D,cAAc,CAAA;AAQjB,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,KAAK,UAAU,CACb,cAAc,SAAS,cAAc,GAAG,MAAM,GAAG,SAAS,MAAM,EAAE,GAChE,cAAc,IACd,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,CAAA;IAE3C,KAAK,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,eAAe,CAAA;CACjE;AAED,gBAAgB;AAChB,wBAAgB,OAAO,CAAC,KAAK,CAAC,GAAG,SAAS,GAAG,CAAC,GAAG,GAAG,SAAS,OAAO,EAAE,EACpE,GAAG,EAAE,GAAG,GAAG,GAAG,CAAC,GAAG,GAAG,SAAS,OAAO,EAAE,GACtC,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,CAAA;AAC1B;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,GAAG,SAAS,OAAO,EAAE,GAAG,cAAc,CAAA;AAQ1E,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,KAAK,UAAU,CAAC,GAAG,SAAS,GAAG,CAAC,GAAG,GAAG,SAAS,OAAO,EAAE,GAAG,GAAG,CAAC,GAAG,IAAI,OAAO,CAC3E,GAAG,CAAC,MAAM,CAAC,EACX;QAAE,IAAI,EAAE,aAAa,CAAA;KAAE,CACxB,CAAA;IAED,KAAK,SAAS,GAAG,OAAO,CAAC,aAAa,GAAG,MAAM,CAAC,eAAe,CAAA;CAChE;AAED;;;;;;;;;;;;;GAaG;AACH,qBAAa,qBAAsB,SAAQ,MAAM,CAAC,SAAS;IACzD,SAAkB,IAAI,0CAAyC;gBACnD,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE;QAAE,QAAQ,EAAE,GAAG,CAAC,GAAG,CAAC;QAAC,IAAI,EAAE,GAAG,CAAC,GAAG,CAAA;KAAE;CAQrE"}

package/dist/core/AbiConstructor.js

@@ -0,0 +1,91 @@
+import * as abitype from 'abitype';
+import * as AbiItem from './AbiItem.js';
+import * as AbiParameters from './AbiParameters.js';
+import * as Errors from './Errors.js';
+import * as Hex from './Hex.js';
+// eslint-disable-next-line jsdoc-js/require-jsdoc
+export function decode(...parameters) {
+    const [abiConstructor, options] = (() => {
+        if (Array.isArray(parameters[0])) {
+            const [abi, options] = parameters;
+            if (options.data === options.bytecode)
+                return [undefined, options];
+            return [fromAbi(abi), options];
+        }
+        return parameters;
+    })();
+    if (!abiConstructor)
+        return undefined;
+    const { bytecode } = options;
+    if (abiConstructor.inputs?.length === 0)
+        return undefined;
+    if (!options.data.startsWith(bytecode))
+        throw new BytecodeMismatchError({
+            bytecode,
+            data: options.data,
+        });
+    const data = ('0x' + options.data.slice(bytecode.length));
+    return AbiParameters.decode(abiConstructor.inputs, data, {
+        checksumAddress: options.checksumAddress,
+    });
+}
+// eslint-disable-next-line jsdoc-js/require-jsdoc
+export function encode(...parameters) {
+    const [abiConstructor, options] = (() => {
+        const options = parameters[1];
+        if (!options.args || options.args.length === 0)
+            return [undefined, options];
+        if (Array.isArray(parameters[0])) {
+            const [abi] = parameters;
+            return [fromAbi(abi), options];
+        }
+        return parameters;
+    })();
+    const { bytecode, args } = options;
+    if (!abiConstructor)
+        return bytecode;
+    return Hex.concat(bytecode, abiConstructor.inputs?.length && args?.length
+        ? AbiParameters.encode(abiConstructor.inputs, args)
+        : '0x');
+}
+/** @internal */
+export function format(abiConstructor) {
+    return abitype.formatAbiItem(abiConstructor);
+}
+/** @internal */
+export function from(abiConstructor) {
+    return AbiItem.from(abiConstructor);
+}
+/** @internal */
+export function fromAbi(abi) {
+    const item = abi.find((item) => item.type === 'constructor');
+    if (!item)
+        throw new AbiItem.NotFoundError({ name: 'constructor' });
+    return item;
+}
+/**
+ * Throws when the provided `data` does not begin with the provided `bytecode`.
+ *
+ * @example
+ * ```ts twoslash
+ * import { AbiConstructor } from 'ox'
+ *
+ * AbiConstructor.decode(
+ *   AbiConstructor.from('constructor(address)'),
+ *   { bytecode: '0x6080...', data: '0xdeadbeef' }
+ * )
+ * // @error: AbiConstructor.BytecodeMismatchError: Provided `data` does not start with the provided `bytecode`.
+ * ```
+ */
+export class BytecodeMismatchError extends Errors.BaseError {
+    name = 'AbiConstructor.BytecodeMismatchError';
+    constructor({ bytecode, data }) {
+        super('Provided `data` does not start with the provided `bytecode`.', {
+            metaMessages: [
+                `Bytecode: ${bytecode.slice(0, 18)}${bytecode.length > 18 ? '...' : ''}`,
+                `Data:     ${data.slice(0, 18)}${data.length > 18 ? '...' : ''}`,
+            ],
+        });
+    }
+}
+//# sourceMappingURL=AbiConstructor.js.map

package/dist/core/AbiConstructor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AbiConstructor.js","sourceRoot":"","sources":["../../src/core/AbiConstructor.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,SAAS,CAAA;AAElC,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AACvC,OAAO,KAAK,aAAa,MAAM,oBAAoB,CAAA;AACnD,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA;AACrC,OAAO,KAAK,GAAG,MAAM,UAAU,CAAA;AAqF/B,kDAAkD;AAClD,MAAM,UAAU,MAAM,CACpB,GAAG,UAE0D;IAE7D,MAAM,CAAC,cAAc,EAAE,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE;QACtC,IAAI,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YACjC,MAAM,CAAC,GAAG,EAAE,OAAO,CAAC,GAAG,UAGtB,CAAA;YACD,IAAI,OAAO,CAAC,IAAI,KAAK,OAAO,CAAC,QAAQ;gBAAE,OAAO,CAAC,SAAS,EAAE,OAAO,CAAC,CAAA;YAClE,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,OAAO,CAAqC,CAAA;QACpE,CAAC;QACD,OAAO,UAA8C,CAAA;IACvD,CAAC,CAAC,EAAE,CAAA;IAEJ,IAAI,CAAC,cAAc;QAAE,OAAO,SAAS,CAAA;IACrC,MAAM,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAA;IAC5B,IAAI,cAAc,CAAC,MAAM,EAAE,MAAM,KAAK,CAAC;QAAE,OAAO,SAAS,CAAA;IACzD,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC;QACpC,MAAM,IAAI,qBAAqB,CAAC;YAC9B,QAAQ;YACR,IAAI,EAAE,OAAO,CAAC,IAAI;SACnB,CAAC,CAAA;IACJ,MAAM,IAAI,GAAG,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAY,CAAA;IACpE,OAAO,aAAa,CAAC,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,IAAI,EAAE;QACvD,eAAe,EAAE,OAAO,CAAC,eAAe;KACzC,CAAC,CAAA;AACJ,CAAC;AAoHD,kDAAkD;AAClD,MAAM,UAAU,MAAM,CACpB,GAAG,UAE0D;IAE7D,MAAM,CAAC,cAAc,EAAE,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE;QACtC,MAAM,OAAO,GAAG,UAAU,CAAC,CAAC,CAAmB,CAAA;QAC/C,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC;YAC5C,OAAO,CAAC,SAAS,EAAE,OAAO,CAAgC,CAAA;QAE5D,IAAI,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YACjC,MAAM,CAAC,GAAG,CAAC,GAAG,UAA4D,CAAA;YAC1E,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,OAAO,CAAqC,CAAA;QACpE,CAAC;QAED,OAAO,UAA8C,CAAA;IACvD,CAAC,CAAC,EAAE,CAAA;IAEJ,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,OAAO,CAAA;IAClC,IAAI,CAAC,cAAc;QAAE,OAAO,QAAQ,CAAA;IACpC,OAAO,GAAG,CAAC,MAAM,CACf,QAAQ,EACR,cAAc,CAAC,MAAM,EAAE,MAAM,IAAI,IAAI,EAAE,MAAM;QAC3C,CAAC,CAAC,aAAa,CAAC,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,IAA0B,CAAC;QACzE,CAAC,CAAC,IAAI,CACT,CAAA;AACH,CAAC;AAqDD,gBAAgB;AAChB,MAAM,UAAU,MAAM,CAAC,cAA8B;IACnD,OAAO,OAAO,CAAC,aAAa,CAAC,cAAc,CAAC,CAAA;AAC9C,CAAC;AAmFD,gBAAgB;AAChB,MAAM,UAAU,IAAI,CAClB,cAA2D;IAE3D,OAAO,OAAO,CAAC,IAAI,CAAC,cAAgC,CAAC,CAAA;AACvD,CAAC;AAwCD,gBAAgB;AAChB,MAAM,UAAU,OAAO,CAAC,GAAiC;IACvD,MAAM,IAAI,GAAI,GAAe,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,aAAa,CAAC,CAAA;IACzE,IAAI,CAAC,IAAI;QAAE,MAAM,IAAI,OAAO,CAAC,aAAa,CAAC,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC,CAAA;IACnE,OAAO,IAAI,CAAA;AACb,CAAC;AAWD;;;;;;;;;;;;;GAaG;AACH,MAAM,OAAO,qBAAsB,SAAQ,MAAM,CAAC,SAAS;IACvC,IAAI,GAAG,sCAAsC,CAAA;IAC/D,YAAY,EAAE,QAAQ,EAAE,IAAI,EAAwC;QAClE,KAAK,CAAC,8DAA8D,EAAE;YACpE,YAAY,EAAE;gBACZ,aAAa,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;gBACxE,aAAa,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;aACjE;SACF,CAAC,CAAA;IACJ,CAAC;CACF"}