ABIType: Ethereum ABI TypeScript Types

Common errors

Warnings

Install

Imports

• AbiParametersToPrimitiveTypes
  wrong

  import { AbiParametersToPrimitiveTypes } from 'abitype'

  correct

  import type { 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
  wrong

  const ExtractAbiFunction = require('abitype').ExtractAbiFunction

  correct

  import type { ExtractAbiFunction } from 'abitype'

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

• erc20Abi
  wrong

  import { erc20Abi } from 'abitype'

  correct

  import { erc20Abi } from 'abitype/abis'

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

• parseAbi
  wrong

  import { parseAbi } from 'abitype/runtime'

  correct

  import { parseAbi } from 'abitype'

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

Quickstart

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: []
  }
];