ox 0.9.3 → 0.9.5

package/core/AbiError.ts

@@ -59,6 +59,23 @@ export function decode<
  * ```
  *
  * @example
+ * Or define the ABI and error name as parameters to {@link ox#AbiError.(decode:function)}:
+ *
+ * ```ts twoslash
+ * // @noErrors
+ * import { Abi, AbiError } from 'ox'
+ *
+ * const abi = Abi.from([...])
+ *
+ * const value = AbiError.decode(
+ *   abi, // [!code hl]
+ *   'InvalidSignature', // [!code hl]
+ *   '0x...'
+ * )
+ * // @log: [420n, 69n, 1]
+ * ```
+ *
+ * @example
  * You can pass the error `data` to the `name` property of {@link ox#AbiError.(fromAbi:function)} to extract and infer the error by its 4-byte selector:
  *
  * ```ts twoslash
@@ -139,17 +156,58 @@ export function decode<
  * @param options - Decoding options.
  * @returns The decoded error.
  */
-export function decode(
-  abiError: AbiError,
+export function decode<
+  const abi extends Abi.Abi | readonly unknown[],
+  name extends Name<abi>,
+  const args extends
+    | AbiItem_internal.ExtractArgs<abi, name>
+    | undefined = undefined,
+  as extends 'Object' | 'Array' = 'Array',
+  //
+  abiError extends AbiError = AbiItem.fromAbi.ReturnType<
+    abi,
+    name,
+    args,
+    AbiError
+  >,
+  allNames = Name<abi>,
+>(
+  abi: abi | Abi.Abi | readonly unknown[],
+  name: Hex.Hex | (name extends allNames ? name : never),
   data: Hex.Hex,
-  options?: decode.Options | undefined,
-): unknown | readonly unknown[] | undefined
-/** @internal */
-export function decode(
-  abiError: AbiError,
+  options?: decode.Options<as> | undefined,
+): decode.ReturnType<abiError, as>
+export function decode<
+  const abiError extends AbiError,
+  as extends 'Object' | 'Array' = 'Array',
+>(
+  abiError: abiError | AbiError,
   data: Hex.Hex,
-  options: decode.Options = {},
+  options?: decode.Options<as> | undefined,
+): decode.ReturnType<abiError, as>
+// eslint-disable-next-line jsdoc/require-jsdoc
+export function decode(
+  ...parameters:
+    | [
+        abi: Abi.Abi | readonly unknown[],
+        name: Hex.Hex | string,
+        data: Hex.Hex,
+        options?: decode.Options | undefined,
+      ]
+    | [abiError: AbiError, data: Hex.Hex, options?: decode.Options | undefined]
 ): decode.ReturnType {
+  const [abiError, data, options = {}] = (() => {
+    if (Array.isArray(parameters[0])) {
+      const [abi, name, data, options] = parameters as [
+        Abi.Abi | readonly unknown[],
+        Hex.Hex | string,
+        Hex.Hex,
+        decode.Options | undefined,
+      ]
+      return [fromAbi(abi, name), data, options]
+    }
+    return parameters as [AbiError, Hex.Hex, decode.Options | undefined]
+  })()
   if (Hex.size(data) < 4) throw new AbiItem.InvalidSelectorSizeError({ data })
   if (abiError.inputs.length === 0) return undefined
 
@@ -255,10 +313,55 @@ export declare namespace decode {
  * @param args - Error arguments
  * @returns ABI-encoded error name and arguments
  */
+export function encode<
+  const abi extends Abi.Abi | readonly unknown[],
+  name extends Name<abi>,
+  const args extends
+    | AbiItem_internal.ExtractArgs<abi, name>
+    | undefined = undefined,
+  //
+  abiError extends AbiError = AbiItem.fromAbi.ReturnType<
+    abi,
+    name,
+    args,
+    AbiError
+  >,
+  allNames = Name<abi>,
+>(
+  abi: abi | Abi.Abi | readonly unknown[],
+  name: Hex.Hex | (name extends allNames ? name : never),
+  ...args: encode.Args<abiError>
+): encode.ReturnType
 export function encode<const abiError extends AbiError>(
   abiError: abiError,
   ...args: encode.Args<abiError>
-): encode.ReturnType {
+): encode.ReturnType
+// eslint-disable-next-line jsdoc/require-jsdoc
+export function encode(
+  ...parameters:
+    | [
+        abi: Abi.Abi | readonly unknown[],
+        name: Hex.Hex | string,
+        ...args: readonly unknown[],
+      ]
+    | [abiError: AbiError, ...args: readonly unknown[]]
+) {
+  const [abiError, args] = (() => {
+    if (Array.isArray(parameters[0])) {
+      const [abi, name, ...args] = parameters as [
+        Abi.Abi | readonly unknown[],
+        Hex.Hex | string,
+        ...(readonly unknown[]),
+      ]
+      return [fromAbi(abi, name), args]
+    }
+    const [abiError, ...args] = parameters as [
+      AbiError,
+      ...(readonly unknown[]),
+    ]
+    return [abiError, args]
+  })()
+
   const selector = getSelector(abiError)
 
   const data =

package/core/AbiEvent.ts

@@ -286,10 +286,51 @@ export declare namespace assertArgs {
  * @param log - `topics` & `data` to decode.
  * @returns The decoded event.
  */
+export function decode<
+  const abi extends Abi.Abi | readonly unknown[],
+  name extends Name<abi>,
+  const args extends
+    | AbiItem_internal.ExtractArgs<abi, name>
+    | undefined = undefined,
+  //
+  abiEvent extends AbiEvent = AbiItem.fromAbi.ReturnType<
+    abi,
+    name,
+    args,
+    AbiEvent
+  >,
+  allNames = Name<abi>,
+>(
+  abi: abi | Abi.Abi | readonly unknown[],
+  name: Hex.Hex | (name extends allNames ? name : never),
+  log: decode.Log,
+): decode.ReturnType<abiEvent>
 export function decode<const abiEvent extends AbiEvent>(
   abiEvent: abiEvent | AbiEvent,
   log: decode.Log,
-): decode.ReturnType<abiEvent> {
+): decode.ReturnType<abiEvent>
+// eslint-disable-next-line jsdoc/require-jsdoc
+export function decode(
+  ...parameters:
+    | [
+        abi: Abi.Abi | readonly unknown[],
+        name: Hex.Hex | string,
+        log: decode.Log,
+      ]
+    | [abiEvent: AbiEvent, log: decode.Log]
+): decode.ReturnType {
+  const [abiEvent, log] = (() => {
+    if (Array.isArray(parameters[0])) {
+      const [abi, name, log] = parameters as [
+        Abi.Abi | readonly unknown[],
+        Hex.Hex | string,
+        decode.Log,
+      ]
+      return [fromAbi(abi, name), log]
+    }
+    return parameters as [AbiEvent, decode.Log]
+  })()
+
   const { data, topics } = log
 
   const [selector_, ...argTopics] = topics
@@ -496,10 +537,55 @@ export declare namespace decode {
  * @param args - The arguments to encode.
  * @returns The encoded event topics.
  */
+export function encode<
+  const abi extends Abi.Abi | readonly unknown[],
+  name extends Name<abi>,
+  const args extends
+    | AbiItem_internal.ExtractArgs<abi, name>
+    | undefined = undefined,
+  //
+  abiEvent extends AbiEvent = AbiItem.fromAbi.ReturnType<
+    abi,
+    name,
+    args,
+    AbiEvent
+  >,
+  allNames = Name<abi>,
+>(
+  abi: abi | Abi.Abi | readonly unknown[],
+  name: Hex.Hex | (name extends allNames ? name : never),
+  ...[args]: encode.Args<abiEvent>
+): encode.ReturnType
 export function encode<const abiEvent extends AbiEvent>(
   abiEvent: abiEvent | AbiEvent,
   ...[args]: encode.Args<abiEvent>
+): encode.ReturnType
+// eslint-disable-next-line jsdoc/require-jsdoc
+export function encode(
+  ...parameters:
+    | [
+        abi: Abi.Abi | readonly unknown[],
+        name: Hex.Hex | string,
+        args?: readonly unknown[] | Record<string, unknown>,
+      ]
+    | [abiEvent: AbiEvent, args?: readonly unknown[] | Record<string, unknown>]
 ): encode.ReturnType {
+  const [abiEvent, args] = (() => {
+    if (Array.isArray(parameters[0])) {
+      const [abi, name, args] = parameters as [
+        Abi.Abi | readonly unknown[],
+        Hex.Hex | string,
+        readonly unknown[] | Record<string, unknown> | undefined,
+      ]
+      return [fromAbi(abi, name), args]
+    }
+    const [abiEvent, args] = parameters as [
+      AbiEvent,
+      readonly unknown[] | Record<string, unknown> | undefined,
+    ]
+    return [abiEvent, args]
+  })()
+
   let topics: (Hex.Hex | Hex.Hex[] | null)[] = []
   if (args && abiEvent.inputs) {
     const indexedInputs = abiEvent.inputs.filter(

package/core/AbiFunction.ts

@@ -93,10 +93,47 @@ export type ExtractNames<
  * @param abiFunction - The ABI Item to decode.
  * @param data - The data to decode.
  */
+export function decodeData<
+  const abi extends Abi.Abi | readonly unknown[],
+  name extends Name<abi>,
+  const args extends
+    | AbiItem_internal.ExtractArgs<abi, name>
+    | undefined = undefined,
+  //
+  abiFunction extends AbiFunction = AbiItem.fromAbi.ReturnType<
+    abi,
+    name,
+    args,
+    AbiFunction
+  >,
+  allNames = Name<abi>,
+>(
+  abi: abi | Abi.Abi | readonly unknown[],
+  name: Hex.Hex | (name extends allNames ? name : never),
+  data: Hex.Hex,
+): decodeData.ReturnType<abiFunction>
 export function decodeData<const abiItem extends AbiFunction>(
   abiFunction: abiItem | AbiFunction,
   data: Hex.Hex,
-): decodeData.ReturnType<abiItem> {
+): decodeData.ReturnType<abiItem>
+// eslint-disable-next-line jsdoc/require-jsdoc
+export function decodeData(
+  ...parameters:
+    | [abi: Abi.Abi | readonly unknown[], name: Hex.Hex | string, data: Hex.Hex]
+    | [abiFunction: AbiFunction, data: Hex.Hex]
+) {
+  const [abiFunction, data] = (() => {
+    if (Array.isArray(parameters[0])) {
+      const [abi, name, data] = parameters as [
+        Abi.Abi | readonly unknown[],
+        Hex.Hex | string,
+        Hex.Hex,
+      ]
+      return [fromAbi(abi, name), data]
+    }
+    return parameters as [AbiFunction, Hex.Hex]
+  })()
+
   const { overloads } = abiFunction
 
   if (Hex.size(data) < 4) throw new AbiItem.InvalidSelectorSizeError({ data })
@@ -174,6 +211,25 @@ export declare namespace decodeData {
  * ```
  *
  * @example
+ * Or define the ABI and function name as parameters to {@link ox#AbiFunction.(decodeResult:function)}:
+ *
+ * ```ts twoslash
+ * // @noErrors
+ * import { Abi, AbiFunction } from 'ox'
+ *
+ * const data = '0x000000000000000000000000000000000000000000000000000000000000002a'
+ *
+ * const erc20Abi = Abi.from([...])
+ *
+ * const output = AbiFunction.decodeResult(
+ *   erc20Abi, // [!code hl]
+ *   'totalSupply', // [!code hl]
+ *   data
+ * )
+ * // @log: 42n
+ * ```
+ *
+ * @example
  * ### End-to-end
  *
  * Below is an end-to-end example of using `AbiFunction.decodeResult` to decode the result of a `balanceOf` contract call on the [Wagmi Mint Example contract](https://etherscan.io/address/0xfba3912ca04dd458c843e2ee08967fc04f3579c2).
@@ -230,14 +286,67 @@ export declare namespace decodeData {
  * @param options - Decoding options
  * @returns Decoded function output
  */
+export function decodeResult<
+  const abi extends Abi.Abi | readonly unknown[],
+  name extends Name<abi>,
+  const args extends
+    | AbiItem_internal.ExtractArgs<abi, name>
+    | undefined = undefined,
+  //
+  abiFunction extends AbiFunction = AbiItem.fromAbi.ReturnType<
+    abi,
+    name,
+    args,
+    AbiFunction
+  >,
+  allNames = Name<abi>,
+  as extends 'Object' | 'Array' = 'Array',
+>(
+  abi: abi | Abi.Abi | readonly unknown[],
+  name: Hex.Hex | (name extends allNames ? name : never),
+  data: Hex.Hex,
+  options?: decodeResult.Options<as> | undefined,
+): decodeResult.ReturnType<abiFunction, as>
 export function decodeResult<
   const abiFunction extends AbiFunction,
   as extends 'Object' | 'Array' = 'Array',
 >(
   abiFunction: abiFunction | AbiFunction,
   data: Hex.Hex,
-  options: decodeResult.Options<as> = {},
-): decodeResult.ReturnType<abiFunction, as> {
+  options?: decodeResult.Options<as> | undefined,
+): decodeResult.ReturnType<abiFunction, as>
+// eslint-disable-next-line jsdoc/require-jsdoc
+export function decodeResult(
+  ...parameters:
+    | [
+        abi: Abi.Abi | readonly unknown[],
+        name: Hex.Hex | string,
+        data: Hex.Hex,
+        options?: decodeResult.Options | undefined,
+      ]
+    | [
+        abiFunction: AbiFunction,
+        data: Hex.Hex,
+        options?: decodeResult.Options | undefined,
+      ]
+) {
+  const [abiFunction, data, options = {}] = (() => {
+    if (Array.isArray(parameters[0])) {
+      const [abi, name, data, options] = parameters as [
+        Abi.Abi | readonly unknown[],
+        Hex.Hex | string,
+        Hex.Hex,
+        decodeResult.Options | undefined,
+      ]
+      return [fromAbi(abi, name), data, options]
+    }
+    return parameters as [
+      AbiFunction,
+      Hex.Hex,
+      decodeResult.Options | undefined,
+    ]
+  })()
+
   const values = AbiParameters.decode(abiFunction.outputs, data, options)
   if (values && Object.keys(values).length === 0) return undefined
   if (values && Object.keys(values).length === 1) {
@@ -248,7 +357,7 @@ export function decodeResult<
 }
 
 export declare namespace decodeResult {
-  type Options<as extends 'Object' | 'Array'> = {
+  type Options<as extends 'Object' | 'Array' = 'Array'> = {
     /**
      * Whether the decoded values should be returned as an `Object` or `Array`.
      *
@@ -324,6 +433,22 @@ export declare namespace decodeResult {
  * ```
  *
  * @example
+ * Or define the ABI and function name as parameters to {@link ox#AbiFunction.(encodeData:function)}:
+ *
+ * ```ts twoslash
+ * // @noErrors
+ * import { Abi, AbiFunction } from 'ox'
+ *
+ * const erc20Abi = Abi.from([...])
+ *
+ * const data = AbiFunction.encodeData(
+ *   erc20Abi, // [!code hl]
+ *   'approve', // [!code hl]
+ *   ['0xd8da6bf26964af9d7eed9e03e53415d37aa96045', 69420n]
+ * )
+ * ```
+ *
+ * @example
  * ### End-to-end
  *
  * Below is an end-to-end example of using `AbiFunction.encodeData` to encode the input of a `balanceOf` contract call on the [Wagmi Mint Example contract](https://etherscan.io/address/0xfba3912ca04dd458c843e2ee08967fc04f3579c2).
@@ -378,24 +503,64 @@ export declare namespace decodeResult {
  * @param args - Function arguments
  * @returns ABI-encoded function name and arguments
  */
+export function encodeData<
+  const abi extends Abi.Abi | readonly unknown[],
+  name extends Name<abi>,
+  const args extends
+    | AbiItem_internal.ExtractArgs<abi, name>
+    | undefined = undefined,
+  //
+  abiFunction extends AbiFunction = AbiItem.fromAbi.ReturnType<
+    abi,
+    name,
+    args,
+    AbiFunction
+  >,
+  allNames = Name<abi>,
+>(
+  abi: abi | Abi.Abi | readonly unknown[],
+  name: Hex.Hex | (name extends allNames ? name : never),
+  ...args: encodeData.Args<abiFunction>
+): Hex.Hex
 export function encodeData<const abiFunction extends AbiFunction>(
   abiFunction: abiFunction | AbiFunction,
   ...args: encodeData.Args<abiFunction>
-): Hex.Hex {
+): Hex.Hex
+// eslint-disable-next-line jsdoc/require-jsdoc
+export function encodeData(
+  ...parameters:
+    | [
+        abi: Abi.Abi | readonly unknown[],
+        name: Hex.Hex | string,
+        ...args: readonly unknown[],
+      ]
+    | [abiFunction: AbiFunction, ...args: readonly unknown[]]
+) {
+  const [abiFunction, args = []] = (() => {
+    if (Array.isArray(parameters[0])) {
+      const [abi, name, args] = parameters as [
+        Abi.Abi | readonly unknown[],
+        Hex.Hex | string,
+        readonly unknown[],
+      ]
+      return [fromAbi(abi, name, { args }), args]
+    }
+    const [abiFunction, args] = parameters as [AbiFunction, readonly unknown[]]
+    return [abiFunction, args]
+  })()
+
   const { overloads } = abiFunction
 
   const item = overloads
     ? (fromAbi([abiFunction as AbiFunction, ...overloads], abiFunction.name, {
-        args: (args as any)[0],
+        args,
       }) as AbiFunction)
     : abiFunction
 
   const selector = getSelector(item)
 
   const data =
-    args.length > 0
-      ? AbiParameters.encode(item.inputs, (args as any)[0])
-      : undefined
+    args.length > 0 ? AbiParameters.encode(item.inputs, args) : undefined
 
   return data ? Hex.concat(selector, data) : selector
 }
@@ -443,14 +608,67 @@ export declare namespace encodeData {
  * @param options - Encoding options.
  * @returns The encoded function output.
  */
+export function encodeResult<
+  const abi extends Abi.Abi | readonly unknown[],
+  name extends Name<abi>,
+  const args extends
+    | AbiItem_internal.ExtractArgs<abi, name>
+    | undefined = undefined,
+  as extends 'Object' | 'Array' = 'Array',
+  //
+  abiFunction extends AbiFunction = AbiItem.fromAbi.ReturnType<
+    abi,
+    name,
+    args,
+    AbiFunction
+  >,
+  allNames = Name<abi>,
+>(
+  abi: abi | Abi.Abi | readonly unknown[],
+  name: Hex.Hex | (name extends allNames ? name : never),
+  output: encodeResult.Output<abiFunction, as>,
+  options?: encodeResult.Options<as>,
+): Hex.Hex
 export function encodeResult<
   const abiFunction extends AbiFunction,
   as extends 'Object' | 'Array' = 'Array',
 >(
   abiFunction: abiFunction | AbiFunction,
   output: encodeResult.Output<abiFunction, as>,
-  options: encodeResult.Options<as> = {},
-): Hex.Hex {
+  options?: encodeResult.Options<as>,
+): Hex.Hex
+// eslint-disable-next-line jsdoc/require-jsdoc
+export function encodeResult(
+  ...parameters:
+    | [
+        abi: Abi.Abi | readonly unknown[],
+        name: Hex.Hex | string,
+        output: any,
+        options?: encodeResult.Options<any> | undefined,
+      ]
+    | [
+        abiFunction: AbiFunction,
+        output: any,
+        options?: encodeResult.Options<any> | undefined,
+      ]
+) {
+  const [abiFunction, output, options = {}] = (() => {
+    if (Array.isArray(parameters[0])) {
+      const [abi, name, output, options] = parameters as [
+        Abi.Abi | readonly unknown[],
+        Hex.Hex | string,
+        any,
+        encodeResult.Options<any> | undefined,
+      ]
+      return [fromAbi(abi, name), output, options]
+    }
+    return parameters as [
+      AbiFunction,
+      any,
+      encodeResult.Options<any> | undefined,
+    ]
+  })()
+
   const { as = 'Array' } = options
 
   const values = (() => {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "ox",
   "description": "Ethereum Standard Library",
-  "version": "0.9.3",
+  "version": "0.9.5",
   "main": "./_cjs/index.js",
   "module": "./_esm/index.js",
   "types": "./_types/index.d.ts",

package/version.ts

@@ -1,2 +1,2 @@
 /** @internal */
-export const version = '0.9.3'
+export const version = '0.9.5'