Skip to content

docs: deprecate human-readable ABI utilities#309

Draft
tmm wants to merge 1 commit into
mainfrom
tmm/deprecate-human-readable-ox
Draft

docs: deprecate human-readable ABI utilities#309
tmm wants to merge 1 commit into
mainfrom
tmm/deprecate-human-readable-ox

Conversation

@tmm

@tmm tmm commented Jun 22, 2026

Copy link
Copy Markdown
Member

Companion to wevm/ox#274. Deprecates ABIType's human-readable ABI runtime and type-level utilities with TSDoc migration notes pointing users to Ox's Abi, AbiItem, AbiParameter, and AbiParameters modules.

Also adds a minor changeset for the deprecation notice.

@changeset-bot

changeset-bot Bot commented Jun 22, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 3373a92

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
abitype Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@vercel

vercel Bot commented Jun 22, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
abitype Ready Ready Preview, Comment Jun 22, 2026 4:19pm

Request Review

@github-actions

Copy link
Copy Markdown
Contributor

Size Change: +1.21 kB (+0.99%)

Total Size: 124 kB

Filename Size Change
packages/abitype/dist/cjs/register.js 12 kB +2 B (+0.02%)
packages/abitype/dist/esm/human-readable/errors/struct.js 342 B +71 B (+26.2%) 🚨
packages/abitype/dist/esm/human-readable/formatAbi.js 474 B +70 B (+17.33%) ⚠️
packages/abitype/dist/esm/human-readable/formatAbiItem.js 637 B +68 B (+11.95%) ⚠️
packages/abitype/dist/esm/human-readable/formatAbiParameter.js 448 B +71 B (+18.83%) ⚠️
packages/abitype/dist/esm/human-readable/formatAbiParameters.js 548 B +69 B (+14.41%) ⚠️
packages/abitype/dist/esm/human-readable/parseAbi.js 659 B +66 B (+11.13%) ⚠️
packages/abitype/dist/esm/human-readable/parseAbiItem.js 627 B +67 B (+11.96%) ⚠️
packages/abitype/dist/esm/human-readable/parseAbiParameter.js 703 B +67 B (+10.53%) ⚠️
packages/abitype/dist/esm/register.js 13.4 kB +7 B (+0.05%)
packages/abitype/dist/types/human-readable/errors/struct.d.ts 394 B +80 B (+25.48%) 🚨
packages/abitype/dist/types/human-readable/formatAbi.d.ts 719 B +79 B (+12.34%) ⚠️
packages/abitype/dist/types/human-readable/formatAbiItem.d.ts 746 B +83 B (+12.52%) ⚠️
packages/abitype/dist/types/human-readable/formatAbiParameter.d.ts 537 B +85 B (+18.81%) ⚠️
packages/abitype/dist/types/human-readable/formatAbiParameters.d.ts 720 B +79 B (+12.32%) ⚠️
packages/abitype/dist/types/human-readable/parseAbi.d.ts 834 B +78 B (+10.32%) ⚠️
packages/abitype/dist/types/human-readable/parseAbiItem.d.ts 818 B +83 B (+11.29%) ⚠️
packages/abitype/dist/types/human-readable/parseAbiParameter.d.ts 1.08 kB +89 B (+8.99%) 🔍
ℹ️ View Unchanged
Filename Size Change
packages/abitype/dist 0 B 0 B 🆕
packages/abitype/dist/cjs 123 B 0 B
packages/abitype/dist/cjs/abi.js 0 B 0 B 🆕
packages/abitype/dist/cjs/abis 3.59 kB 0 B
packages/abitype/dist/cjs/abis/human-readable.js 5.91 kB 0 B
packages/abitype/dist/cjs/abis/json.js 575 B 0 B
packages/abitype/dist/cjs/errors.js 0 B 0 B 🆕
packages/abitype/dist/cjs/exports 588 B 0 B
packages/abitype/dist/cjs/exports/abis.js 744 B 0 B
packages/abitype/dist/cjs/exports/index.js 567 B 0 B
packages/abitype/dist/cjs/exports/zod.js 127 B 0 B
packages/abitype/dist/cjs/generated.js 0 B 0 B 🆕
packages/abitype/dist/cjs/human-readable 0 B 0 B 🆕
packages/abitype/dist/cjs/human-readable/errors 531 B 0 B
packages/abitype/dist/cjs/human-readable/errors/abiItem.js 801 B 0 B
packages/abitype/dist/cjs/human-readable/errors/abiParameter.js 425 B 0 B
packages/abitype/dist/cjs/human-readable/errors/signature.js 403 B 0 B
packages/abitype/dist/cjs/human-readable/errors/splitParameters.js 336 B 0 B
packages/abitype/dist/cjs/human-readable/errors/struct.js 286 B 0 B
packages/abitype/dist/cjs/human-readable/formatAbi.js 410 B 0 B
packages/abitype/dist/cjs/human-readable/formatAbiItem.js 477 B 0 B
packages/abitype/dist/cjs/human-readable/formatAbiParameter.js 300 B 0 B
packages/abitype/dist/cjs/human-readable/formatAbiParameters.js 339 B 0 B
packages/abitype/dist/cjs/human-readable/parseAbi.js 429 B 0 B
packages/abitype/dist/cjs/human-readable/parseAbiItem.js 460 B 0 B
packages/abitype/dist/cjs/human-readable/parseAbiParameter.js 519 B 0 B
packages/abitype/dist/cjs/human-readable/parseAbiParameters.js 0 B 0 B 🆕
packages/abitype/dist/cjs/human-readable/runtime 749 B 0 B
packages/abitype/dist/cjs/human-readable/runtime/cache.js 759 B 0 B
packages/abitype/dist/cjs/human-readable/runtime/signatures.js 1.02 kB 0 B
packages/abitype/dist/cjs/human-readable/runtime/structs.js 2.23 kB 0 B
packages/abitype/dist/cjs/human-readable/runtime/utils.js 0 B 0 B 🆕
packages/abitype/dist/cjs/human-readable/types 127 B 0 B
packages/abitype/dist/cjs/human-readable/types/signatures.js 125 B 0 B
packages/abitype/dist/cjs/human-readable/types/structs.js 124 B 0 B
packages/abitype/dist/cjs/human-readable/types/utils.js 160 B 0 B
packages/abitype/dist/cjs/narrow.js 40 B 0 B
packages/abitype/dist/cjs/package.json 369 B 0 B
packages/abitype/dist/cjs/regex.js 125 B 0 B
packages/abitype/dist/cjs/tsconfig.build.tsbuildinfo 124 B 0 B
packages/abitype/dist/cjs/types.js 124 B 0 B
packages/abitype/dist/cjs/utils.js 149 B 0 B
packages/abitype/dist/cjs/version.js 2.14 kB 0 B
packages/abitype/dist/cjs/zod.js 0 B 0 B 🆕
packages/abitype/dist/esm 62 B 0 B
packages/abitype/dist/esm/abi.js 0 B 0 B 🆕
packages/abitype/dist/esm/abis 3.95 kB 0 B
packages/abitype/dist/esm/abis/human-readable.js 6.26 kB 0 B
packages/abitype/dist/esm/abis/json.js 522 B 0 B
packages/abitype/dist/esm/errors.js 0 B 0 B 🆕
packages/abitype/dist/esm/exports 297 B 0 B
packages/abitype/dist/esm/exports/abis.js 403 B 0 B
packages/abitype/dist/esm/exports/index.js 279 B 0 B
packages/abitype/dist/esm/exports/zod.js 68 B 0 B
packages/abitype/dist/esm/generated.js 0 B 0 B 🆕
packages/abitype/dist/esm/human-readable 0 B 0 B 🆕
packages/abitype/dist/esm/human-readable/errors 448 B 0 B
packages/abitype/dist/esm/human-readable/errors/abiItem.js 670 B 0 B
packages/abitype/dist/esm/human-readable/errors/abiParameter.js 338 B 0 B
packages/abitype/dist/esm/human-readable/errors/signature.js 343 B 0 B
packages/abitype/dist/esm/human-readable/errors/splitParameters.js 280 B 0 B
packages/abitype/dist/esm/human-readable/parseAbiParameters.js 0 B 0 B 🆕
packages/abitype/dist/esm/human-readable/runtime 1.06 kB 0 B
packages/abitype/dist/esm/human-readable/runtime/cache.js 629 B 0 B
packages/abitype/dist/esm/human-readable/runtime/signatures.js 1.01 kB 0 B
packages/abitype/dist/esm/human-readable/runtime/structs.js 2.33 kB 0 B
packages/abitype/dist/esm/human-readable/runtime/utils.js 0 B 0 B 🆕
packages/abitype/dist/esm/human-readable/types 69 B 0 B
packages/abitype/dist/esm/human-readable/types/signatures.js 66 B 0 B
packages/abitype/dist/esm/human-readable/types/structs.js 64 B 0 B
packages/abitype/dist/esm/human-readable/types/utils.js 264 B 0 B
packages/abitype/dist/esm/narrow.js 58 B 0 B
packages/abitype/dist/esm/package.json 504 B 0 B
packages/abitype/dist/esm/regex.js 67 B 0 B
packages/abitype/dist/esm/tsconfig.build.tsbuildinfo 64 B 0 B
packages/abitype/dist/esm/types.js 64 B 0 B
packages/abitype/dist/esm/utils.js 82 B 0 B
packages/abitype/dist/esm/version.js 2.5 kB 0 B
packages/abitype/dist/esm/zod.js 0 B 0 B 🆕
packages/abitype/dist/types 1.84 kB 0 B
packages/abitype/dist/types/abi.d.ts 0 B 0 B 🆕
packages/abitype/dist/types/abis 3.88 kB 0 B
packages/abitype/dist/types/abis/human-readable.d.ts 5.96 kB 0 B
packages/abitype/dist/types/abis/json.d.ts 273 B 0 B
packages/abitype/dist/types/errors.d.ts 0 B 0 B 🆕
packages/abitype/dist/types/exports 260 B 0 B
packages/abitype/dist/types/exports/abis.d.ts 655 B 0 B
packages/abitype/dist/types/exports/index.d.ts 244 B 0 B
packages/abitype/dist/types/exports/zod.d.ts 9.51 kB 0 B
packages/abitype/dist/types/generated.d.ts 0 B 0 B 🆕
packages/abitype/dist/types/human-readable 0 B 0 B 🆕
packages/abitype/dist/types/human-readable/errors 227 B 0 B
packages/abitype/dist/types/human-readable/errors/abiItem.d.ts 376 B 0 B
packages/abitype/dist/types/human-readable/errors/abiParameter.d.ts 245 B 0 B
packages/abitype/dist/types/human-readable/errors/signature.d.ts 203 B 0 B
packages/abitype/dist/types/human-readable/errors/splitParameters.d.ts 174 B 0 B
packages/abitype/dist/types/human-readable/parseAbiParameters.d.ts 0 B 0 B 🆕
packages/abitype/dist/types/human-readable/runtime 575 B 0 B
packages/abitype/dist/types/human-readable/runtime/cache.d.ts 379 B 0 B
packages/abitype/dist/types/human-readable/runtime/signatures.d.ts 155 B 0 B
packages/abitype/dist/types/human-readable/runtime/structs.d.ts 710 B 0 B
packages/abitype/dist/types/human-readable/runtime/utils.d.ts 0 B 0 B 🆕
packages/abitype/dist/types/human-readable/types 1.83 kB 0 B
packages/abitype/dist/types/human-readable/types/signatures.d.ts 725 B 0 B
packages/abitype/dist/types/human-readable/types/structs.d.ts 2.11 kB 0 B
packages/abitype/dist/types/human-readable/types/utils.d.ts 422 B 0 B
packages/abitype/dist/types/narrow.d.ts 161 B 0 B
packages/abitype/dist/types/regex.d.ts 1.14 kB 0 B
packages/abitype/dist/types/register.d.ts 1.9 kB 0 B
packages/abitype/dist/types/types.d.ts 2.77 kB 0 B
packages/abitype/dist/types/utils.d.ts 92 B 0 B
packages/abitype/dist/types/version.d.ts 2.13 kB 0 B
packages/abitype/dist/types/zod.d.ts 0 B 0 B 🆕

compressed-size-action

@codecov

codecov Bot commented Jun 22, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.13%. Comparing base (629ace5) to head (3373a92).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #309   +/-   ##
=======================================
  Coverage   99.13%   99.13%           
=======================================
  Files          23       23           
  Lines         463      463           
  Branches      119      119           
=======================================
  Hits          459      459           
  Partials        4        4           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@pkg-pr-new

pkg-pr-new Bot commented Jun 22, 2026

Copy link
Copy Markdown

Open in StackBlitz

npm i https://pkg.pr.new/abitype@309

commit: 3373a92

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant