docs: deprecate human-readable ABI utilities

.changeset/sour-crabs-share.md

@@ -0,0 +1,5 @@
+---
+"abitype": minor
+---
+
+Deprecated human-readable ABI utilities in favor of Ox's `Abi`, `AbiItem`, `AbiParameter`, and `AbiParameters` modules.

packages/abitype/src/human-readable/formatAbi.ts

@@ -6,6 +6,9 @@ import { type FormatAbiItem, formatAbiItem } from './formatAbiItem.js'
  *
  * @param abi - ABI
  * @returns Human-readable ABI
+ *
+ * @deprecated Human-readable ABI utilities are moving to Ox. Install `ox` and
+ * use `Abi.format.ReturnType` instead: `import { Abi } from 'ox'`.
  */
 export type FormatAbi<abi extends Abi | readonly unknown[]> = Abi extends abi
   ? readonly string[]
@@ -22,6 +25,9 @@ export type FormatAbi<abi extends Abi | readonly unknown[]> = Abi extends abi
  *
  * @param abi - ABI
  * @returns Human-readable ABI
+ *
+ * @deprecated Human-readable ABI utilities are moving to Ox. Install `ox` and
+ * use `Abi.format` instead: `import { Abi } from 'ox'`.
  */
 export function formatAbi<const abi extends Abi | readonly unknown[]>(
   abi: abi,

packages/abitype/src/human-readable/formatAbiItem.ts

@@ -21,6 +21,9 @@ import type { AssertName } from './types/signatures.js'
  *
  * @param abiItem - ABI item
  * @returns Human-readable ABI item
+ *
+ * @deprecated Human-readable ABI utilities are moving to Ox. Install `ox` and
+ * use `AbiItem.format.ReturnType` instead: `import { AbiItem } from 'ox'`.
  */
 export type FormatAbiItem<abiItem extends Abi[number]> =
   Abi[number] extends abiItem
@@ -94,6 +97,9 @@ type FormatAbiParameters<
  *
  * @param abiItem - ABI item
  * @returns Human-readable ABI item
+ *
+ * @deprecated Human-readable ABI utilities are moving to Ox. Install `ox` and
+ * use `AbiItem.format` instead: `import { AbiItem } from 'ox'`.
  */
 export function formatAbiItem<const abiItem extends Abi[number]>(
   abiItem: abiItem,

packages/abitype/src/human-readable/formatAbiParameter.ts

@@ -9,6 +9,10 @@ import type { AssertName } from './types/signatures.js'
  * @param abiParameter - ABI parameter
  * @returns Human-readable ABI parameter
  *
+ * @deprecated Human-readable ABI utilities are moving to Ox. Install `ox` and
+ * use `AbiParameter.format.ReturnType` instead: `import { AbiParameter } from
+ * 'ox'`.
+ *
  * @example
  * type Result = FormatAbiParameter<{ type: 'address'; name: 'from'; }>
  * //   ^? type Result = 'address from'
@@ -60,6 +64,9 @@ const tupleRegex = /^tuple(?<array>(\[(\d*)\])*)$/
  * @param abiParameter - ABI parameter
  * @returns Human-readable ABI parameter
  *
+ * @deprecated Human-readable ABI utilities are moving to Ox. Install `ox` and
+ * use `AbiParameter.format` instead: `import { AbiParameter } from 'ox'`.
+ *
  * @example
  * const result = formatAbiParameter({ type: 'address', name: 'from' })
  * //    ^? const result: 'address from'

packages/abitype/src/human-readable/formatAbiParameters.ts

@@ -11,6 +11,10 @@ import {
  * @param abiParameters - ABI parameters
  * @returns Human-readable ABI parameters
  *
+ * @deprecated Human-readable ABI utilities are moving to Ox. Install `ox` and
+ * use `AbiParameters.format.ReturnType` instead: `import { AbiParameters } from
+ * 'ox'`.
+ *
  * @example
  * type Result = FormatAbiParameters<[
  *   // ^? type Result = 'address from, uint256 tokenId'
@@ -36,6 +40,9 @@ export type FormatAbiParameters<
  * @param abiParameters - ABI parameters
  * @returns Human-readable ABI parameters
  *
+ * @deprecated Human-readable ABI utilities are moving to Ox. Install `ox` and
+ * use `AbiParameters.format` instead: `import { AbiParameters } from 'ox'`.
+ *
  * @example
  * const result = formatAbiParameters([
  *   //  ^? const result: 'address from, uint256 tokenId'

packages/abitype/src/human-readable/parseAbi.ts

@@ -13,6 +13,9 @@ import type { ParseSignature } from './types/utils.js'
  * @param signatures - Human-readable ABI
  * @returns Parsed {@link Abi}
  *
+ * @deprecated Human-readable ABI utilities are moving to Ox. Install `ox` and
+ * use `Abi.from.ReturnType` instead: `import { Abi } from 'ox'`.
+ *
  * @example
  * type Result = ParseAbi<
  *   // ^? type Result = readonly [{ name: "balanceOf"; type: "function"; stateMutability:...
@@ -49,6 +52,9 @@ export type ParseAbi<signatures extends readonly string[]> =
  * @param signatures - Human-Readable ABI
  * @returns Parsed {@link Abi}
  *
+ * @deprecated Human-readable ABI utilities are moving to Ox. Install `ox` and
+ * use `Abi.from` instead: `import { Abi } from 'ox'`.
+ *
  * @example
  * const abi = parseAbi([
  *   //  ^? const abi: readonly [{ name: "balanceOf"; type: "function"; stateMutability:...

packages/abitype/src/human-readable/parseAbiItem.ts

@@ -15,6 +15,9 @@ import type { ParseSignature } from './types/utils.js'
  * @param signature - Human-readable ABI item
  * @returns Parsed {@link Abi} item
  *
+ * @deprecated Human-readable ABI utilities are moving to Ox. Install `ox` and
+ * use `AbiItem.from.ReturnType` instead: `import { AbiItem } from 'ox'`.
+ *
  * @example
  * type Result = ParseAbiItem<'function balanceOf(address owner) view returns (uint256)'>
  * //   ^? type Result = { name: "balanceOf"; type: "function"; stateMutability: "view";...
@@ -63,6 +66,9 @@ export type ParseAbiItem<
  * @param signature - Human-readable ABI item
  * @returns Parsed {@link Abi} item
  *
+ * @deprecated Human-readable ABI utilities are moving to Ox. Install `ox` and
+ * use `AbiItem.from` instead: `import { AbiItem } from 'ox'`.
+ *
  * @example
  * const abiItem = parseAbiItem('function balanceOf(address owner) view returns (uint256)')
  * //    ^? const abiItem: { name: "balanceOf"; type: "function"; stateMutability: "view";...

packages/abitype/src/human-readable/parseAbiParameter.ts

@@ -15,6 +15,10 @@ import type { ParseAbiParameter as ParseAbiParameter_ } from './types/utils.js'
  * @param param - Human-readable ABI parameter
  * @returns Parsed {@link AbiParameter}
  *
+ * @deprecated Human-readable ABI utilities are moving to Ox. Install `ox` and
+ * use `AbiParameter.from.ReturnType` instead: `import { AbiParameter } from
+ * 'ox'`.
+ *
  * @example
  * type Result = ParseAbiParameter<'address from'>
  * //   ^? type Result = { type: "address"; name: "from"; }
@@ -64,6 +68,9 @@ export type ParseAbiParameter<
  * @param param - Human-readable ABI parameter
  * @returns Parsed {@link AbiParameter}
  *
+ * @deprecated Human-readable ABI utilities are moving to Ox. Install `ox` and
+ * use `AbiParameter.from` instead: `import { AbiParameter } from 'ox'`.
+ *
  * @example
  * const abiParameter = parseAbiParameter('address from')
  * //    ^? const abiParameter: { type: "address"; name: "from"; }

packages/abitype/src/human-readable/parseAbiParameters.ts

@@ -17,6 +17,10 @@ import type { ParseAbiParameters as ParseAbiParameters_ } from './types/utils.js
  * @param params - Human-readable ABI parameters
  * @returns Parsed {@link AbiParameter}s
  *
+ * @deprecated Human-readable ABI utilities are moving to Ox. Install `ox` and
+ * use `AbiParameters.from.ReturnType` instead: `import { AbiParameters } from
+ * 'ox'`.
+ *
  * @example
  * type Result = ParseAbiParameters('address from, address to, uint256 amount')
  * //   ^? type Result: [{ type: "address"; name: "from"; }, { type: "address";...
@@ -88,6 +92,9 @@ type DeepFlatten<
  * @param params - Human-readable ABI parameters
  * @returns Parsed {@link AbiParameter}s
  *
+ * @deprecated Human-readable ABI utilities are moving to Ox. Install `ox` and
+ * use `AbiParameters.from` instead: `import { AbiParameters } from 'ox'`.
+ *
  * @example
  * const abiParameters = parseAbiParameters('address from, address to, uint256 amount')
  * //    ^? const abiParameters: [{ type: "address"; name: "from"; }, { type: "address";...