Skip to content

decodeFunctionData

Decodes ABI encoded data (4 byte selector & arguments) into a function name and arguments.

The opposite of encodeFunctionData.

Install

import { decodeFunctionData } from 'viem'

Usage

Below is a very basic example of how to decode a function to calldata.

example.ts
import { decodeFunctionData } from 'viem'
 
const { functionName } = decodeFunctionData({
  abi: wagmiAbi,
  data: '0xc2985578'
})
// { functionName: 'totalSupply' }

Extracting Arguments

If your calldata includes argument(s) after the 4byte function signature, you can extract them with the args return value.

example.ts
import { decodeFunctionData } from 'viem'
import { wagmiAbi } from './abi'
 
const { functionName, args } = decodeFunctionData({
  abi: wagmiAbi,
  data: '0x0423a1320000000000000000000000000000000000000000000000000000000000000001'
})
// { functionName: 'balanceOf', args: [1n] }

Return Value

{
  functionName: string;
  args: unknown[] | undefined;
}

Decoded ABI function data.

functionName

  • Type: string

The decoded function name.

args

  • Type: unknown[] | undefined

The decoded function arguments.

Parameters

abi

The contract's ABI.

const { functionName } = decodeFunctionData({
  abi: wagmiAbi, 
  data: '0xc2985578'
})

data

The encoded calldata.

const { functionName } = decodeFunctionData({
  abi: wagmiAbi,
  data: '0xc2985578'
})