ABIType: Strict TypeScript types for Ethereum ABIs

Strict TypeScript types for Ethereum ABIs. ABIType provides utilities and type definitions for ABI properties and values, covering the Contract ABI Specification, as well as EIP-712 Typed Data.

import { 
  
type AbiParametersToPrimitiveTypes<TAbiParameters extends readonly AbiParameter[], TAbiParameterKind extends AbiParameterKind = AbiParameterKind> = { [K in keyof { [K in keyof TAbiParameters]: AbiParameterToPrimitiveType<TAbiParameters[K], TAbiParameterKind>; }]: { [K in keyof TAbiParameters]: AbiParameterToPrimitiveType<TAbiParameters[K], TAbiParameterKind>; }[K]; }Converts array of AbiParameter to corresponding TypeScript primitive types.
AbiParametersToPrimitiveTypes, 
  
type ExtractAbiFunction<TAbi extends Abi, TFunctionName extends ExtractAbiFunctionNames<TAbi, AbiStateMutability>, TAbiStateMutability extends AbiStateMutability = AbiStateMutability> = Extract<TAbi[number], {
  type: "function";
  stateMutability: TAbiStateMutability;
}> extends {
  name: TFunctionName;
} ? {
  name: TFunctionName;
} & Extract<TAbi[number], {
  type: "function";
  stateMutability: TAbiStateMutability;
}> : neverExtracts AbiFunction with name from Abi.
ExtractAbiFunction 
} from 'abitype'
import { 
const erc20Abi: readonly [{
  readonly type: "event";
  readonly name: "Approval";
  readonly inputs: readonly [
    {
      readonly indexed: true;
      readonly name: "owner";
      readonly type: "address";
    },
    {
      readonly indexed: true;
      readonly name: "spender";
      readonly type: "address";
    },
    {
      readonly indexed: false;
      readonly name: "value";
      readonly type: "uint256";
    }
  ];
}, {
  readonly type: "event";
  readonly name: "Transfer";
  readonly inputs: readonly [
    {
      readonly indexed: true;
      readonly name: "from";
      readonly type: "address";
    },
    {
      readonly indexed: true;
      readonly name: "to";
      readonly type: "address";
    },
    {
      readonly indexed: false;
      readonly name: "value";
      readonly type: "uint256";
    }
  ];
}, {
  readonly type: "function";
  readonly name: "allowance";
  readonly stateMutability: "view";
  readonly inputs: readonly [
    {
      readonly name: "owner";
      readonly type: "address";
    },
    {
      readonly name: "spender";
      readonly type: "address";
    }
  ];
  readonly outputs: readonly [
    {
      readonly name: "";
      readonly type: "uint256";
    }
  ];
}, ... 7 more ..., {
  ...;
}]ERC-20 Token Standard
erc20Abi } from 'abitype/abis'
 
type 
type TransferInputTypes = readonly [`0x${string}`, bigint]TransferInputTypes = 
type AbiParametersToPrimitiveTypes<TAbiParameters extends readonly AbiParameter[], TAbiParameterKind extends AbiParameterKind = AbiParameterKind> = { [K in keyof { [K in keyof TAbiParameters]: AbiParameterToPrimitiveType<TAbiParameters[K], TAbiParameterKind>; }]: { [K in keyof TAbiParameters]: AbiParameterToPrimitiveType<TAbiParameters[K], TAbiParameterKind>; }[K]; }Converts array of AbiParameter to corresponding TypeScript primitive types.
AbiParametersToPrimitiveTypes<
 
 
  
type ExtractAbiFunction<TAbi extends Abi, TFunctionName extends ExtractAbiFunctionNames<TAbi, AbiStateMutability>, TAbiStateMutability extends AbiStateMutability = AbiStateMutability> = Extract<TAbi[number], {
  type: "function";
  stateMutability: TAbiStateMutability;
}> extends {
  name: TFunctionName;
} ? {
  name: TFunctionName;
} & Extract<TAbi[number], {
  type: "function";
  stateMutability: TAbiStateMutability;
}> : neverExtracts AbiFunction with name from Abi.
ExtractAbiFunction<typeof 
const erc20Abi: readonly [{
  readonly type: "event";
  readonly name: "Approval";
  readonly inputs: readonly [
    {
      readonly indexed: true;
      readonly name: "owner";
      readonly type: "address";
    },
    {
      readonly indexed: true;
      readonly name: "spender";
      readonly type: "address";
    },
    {
      readonly indexed: false;
      readonly name: "value";
      readonly type: "uint256";
    }
  ];
}, {
  readonly type: "event";
  readonly name: "Transfer";
  readonly inputs: readonly [
    {
      readonly indexed: true;
      readonly name: "from";
      readonly type: "address";
    },
    {
      readonly indexed: true;
      readonly name: "to";
      readonly type: "address";
    },
    {
      readonly indexed: false;
      readonly name: "value";
      readonly type: "uint256";
    }
  ];
}, {
  readonly type: "function";
  readonly name: "allowance";
  readonly stateMutability: "view";
  readonly inputs: readonly [
    {
      readonly name: "owner";
      readonly type: "address";
    },
    {
      readonly name: "spender";
      readonly type: "address";
    }
  ];
  readonly outputs: readonly [
    {
      readonly name: "";
      readonly type: "uint256";
    }
  ];
}, ... 7 more ..., {
  ...;
}]ERC-20 Token Standard
erc20Abi, 'transfer'>['inputs']
>

Works great for adding blazing fast autocomplete and type checking to functions, variables, or your own types. No need to generate types with third-party tools – just use your ABI and let TypeScript do the rest!

TL;DR

ABIType might be a good option for your project if:

You want to typecheck your ABIs or EIP-712 Typed Data.
You want to add type inference and autocomplete to your library based on user-provided ABIs or EIP-712 Typed Data, like wagmi and viem.
You need to convert ABI types (e.g. 'string') to TypeScript types (e.g. string) or other type transformations.
You need to validate ABIs at runtime (e.g. after fetching from external resource).
You don’t want to set up a build process to generate types (e.g. TypeChain).

Install

Read the Getting Started guide to learn more how to use ABIType.

pnpm add abitype

Sponsor

If you find ABIType useful, please consider supporting development on GitHub Sponsors or sending crypto to wevm.eth. Thank you 🙏

Community

If you have questions or need help, reach out to the community at the ABIType GitHub Discussions.