abitype

library1.2.4jsnpmunverified

ABIType is a TypeScript-first library providing strict type definitions and utilities for Ethereum ABIs (Application Binary Interfaces) and EIP-712 Typed Data. It enables developers to achieve compile-time type-checking and inference for contract interactions without requiring external code generation tools. The current stable version is 1.2.4, with frequent patch and minor releases addressing bug fixes, performance improvements, and adding experimental features like named tuple support. Its primary differentiator is its deep integration with TypeScript's type system to convert ABI types (e.g., 'string') directly into TypeScript types (e.g., `string` or `0x${string}`) for enhanced developer experience, widely adopted by prominent libraries such as Wagmi and Viem. It also offers runtime validation capabilities for ABIs.

web-framework serialization

npm install abitype

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · ABITYPE

abitype

web-frameworkjavascriptv1.2.4

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

AbiParametersToPrimitiveTypes

✓ import type { AbiParametersToPrimitiveTypes } from 'abitype'

✗ import { AbiParametersToPrimitiveTypes } from 'abitype'

This is a type utility, so `import type` is preferred for tree-shaking and clarity, though `import` works at compile-time.

ExtractAbiFunction

✓ import type { ExtractAbiFunction } from 'abitype'

✗ const ExtractAbiFunction = require('abitype').ExtractAbiFunction

ABIType is primarily an ESM package. CommonJS `require()` is not officially supported and may lead to issues, especially with type-only imports.

erc20Abi

✓ import { erc20Abi } from 'abitype/abis'

✗ import { erc20Abi } from 'abitype'

Pre-defined ABIs like `erc20Abi` are located in the `abitype/abis` subdirectory to keep the main bundle light.

parseAbi

✓ import { parseAbi } from 'abitype'

✗ import { parseAbi } from 'abitype/runtime'

`parseAbi` is a runtime utility. While ABIType is heavily type-driven, it also provides runtime functions. The primary export path is correct.

Demonstrates how to extract function names, derive primitive types from ABI parameters, and parse custom ABI strings at runtime for type-safe contract interactions.

import type { AbiParametersToPrimitiveTypes, ExtractAbiFunction, ExtractAbiFunctionNames } from 'abitype'; import { erc20Abi, parseAbi } from 'abitype/abis'; // Example 1: Extracting function names from an ABI type ViewFunctionNames = ExtractAbiFunctionNames<typeof erc20Abi, 'view'>; // ^? type ViewFunctionNames = "symbol" | "name" | "allowance" | "balanceOf" | "decimals" | "totalSupply" // Example 2: Getting primitive types for a function's inputs type TransferInputTypes = AbiParametersToPrimitiveTypes< ExtractAbiFunction<typeof erc20Abi, 'transfer'>['inputs'] >; // ^? type TransferInputTypes = readonly [`0x${string}`, bigint] // Example 3: Parsing a custom ABI string at runtime const customAbi = parseAbi([ 'function deposit() payable', 'event Deposit(address indexed user, uint256 amount)' ]); console.log(customAbi[0].name); // 'deposit' console.log(customAbi[1].type); // 'event' // Example 4: Type-checking a variable against an ABI type type MyCustomAbi = typeof customAbi; // This will error if the structure doesn't match MyCustomAbi const invalidAbi: MyCustomAbi = [ { type: 'function', name: 'withdraw', inputs: [], stateMutability: 'nonpayable', outputs: [] } ];

Debug

Known issues

breakingABIType `v1.1.0` introduced support for Zod `v4`, broadening compatibility. Users migrating from older Zod versions (pre-v3.22) might experience issues if their `zod` peer dependency is not updated accordingly.

fix

Ensure `zod` is updated to `^3.22.0 || ^4.0.0` in your project's `package.json` and reinstall dependencies.

affects: >=1.1.0

gotchaThe package is designed for ESM (ECMAScript Modules). Using CommonJS `require()` syntax directly might lead to 'Module not found' or incorrect type inference, especially for type-only imports.

fix

Use `import` statements for all imports. If running in Node.js, ensure your project is configured for ESM (e.g., `"type": "module"` in `package.json` or `.mjs` file extension).

affects: >=1.0.0

gotchaABIType relies heavily on advanced TypeScript features. Ensure your `typescript` peer dependency meets the minimum requirement of `>=5.0.4` to avoid compilation errors related to type inference or declaration merging.

fix

Upgrade your project's `typescript` version to `5.0.4` or higher.

affects: >=1.0.0

gotchaVersion `1.2.4` fixed a regex issue for Zod identifiers, preventing invalid identifiers (like those containing spaces or starting with numbers) from being accepted. While a fix, it might make previously 'accepted' but invalid ABIs now fail validation.

fix

Review any custom ABIs that previously worked but might contain non-standard or invalid Zod identifiers. Ensure identifiers conform to typical programming naming conventions (e.g., alphanumeric, starting with a letter or underscore).

affects: >=1.2.4

gotchaPre-defined ABIs (like `erc20Abi`) are located in the `abitype/abis` path, not directly from the main `abitype` export. Attempting to import them from the root might result in undefined symbols.

fix

Always import pre-defined ABIs using `import { abiName } from 'abitype/abis'`.

affects: >=1.0.0

Errors

Common errors & fixes

Error [ERR_MODULE_NOT_FOUND]: Cannot find package 'abitype' imported from /path/to/your/file.js

Attempting to import `abitype` using CommonJS `require()` syntax or running an ESM file in a CommonJS context.

fix

Ensure your Node.js project is configured for ESM (`"type": "module"` in `package.json` or `.mjs` extension) and use `import` statements. If you absolutely must use CommonJS, consider dynamic `import('abitype')` within an `async` function, but this is not the intended usage.

Type '"uint256"' is not assignable to type '"string" | "number" | "boolean" | "null" | "undefined" | "bigint" | `0x${string}` | `0x${string}`[] | ...'.

Mismatch between an ABI type string and the expected primitive TypeScript type. ABIType automatically converts ABI types (e.g., `'uint256'`) to their corresponding TypeScript primitive type (e.g., `bigint`).

fix

Ensure you are using the correct `AbiParametersToPrimitiveTypes` or similar utility to transform the ABI type string into its TypeScript equivalent before assigning or comparing. For example, `AbiParametersToPrimitiveTypes<['uint256']>['inputs']` would resolve to `[bigint]`.

Property 'name' does not exist on type 'AbiParameter'.

Attempting to access a property that might not be present on a generic ABI type or an improperly typed ABI object. For example, a tuple type might not have a direct `name` property at its root.

fix

Use ABIType's specific type utilities like `ExtractAbiFunction` or `ExtractAbiEvent` to narrow down the type of an ABI item, which will then expose properties like `name`, `inputs`, or `outputs` with correct type safety. Ensure your ABI structure is valid according to the Solidity ABI specification.

Upgrade

Version history

1.2.4latest on npm

Audit

Dependencies

typescriptrequiredRequired for type checking and inference, especially for advanced conditional types and template literal types used extensively by ABIType.

zodoptionalUsed for runtime validation of ABIs. It's a peer dependency, allowing users to manage its version.

Agent activity

49 hits · last 30 days

node

Amazon

OpenAI (training)

Resources

githubhttps://github.com/wevm/abitype ↗

packagehttps://www.npmjs.com/package/abitype ↗

homepagehttps://abitype.dev ↗