Skip to content

decodeFunctionResult

Decodes the result of a function call on a contract.

Install

import { decodeFunctionResult } from 'viem'

Usage

Given an ABI (abi) and a function (functionName), pass through the encoded calldata (data) to retrieve the decoded value:

example.ts
import { decodeFunctionResult } from 'viem'
 
const value = decodeFunctionResult({
  abi: wagmiAbi,
  functionName: 'ownerOf',
  data: '0x000000000000000000000000a5cc3c03994db5b0d9a5eedd10cabab0813678ac'
})
// '0xa5cc3c03994db5b0d9a5eedd10cabab0813678ac'

Without functionName

If your abi contains only one ABI item, you can omit the functionName (it becomes optional):

example.ts
import { decodeFunctionResult } from 'viem'
 
const abiItem = {
  inputs: [{ name: 'tokenId', type: 'uint256' }],
  name: 'ownerOf',
  outputs: [{ name: '', type: 'address' }],
  stateMutability: 'view',
  type: 'function',
}
 
const value = decodeFunctionResult({
  abi: [abiItem],
  functionName: 'ownerOf', 
  data: '0x000000000000000000000000a5cc3c03994db5b0d9a5eedd10cabab0813678ac'
})
// '0xa5cc3c03994db5b0d9a5eedd10cabab0813678ac'

A more complex example

example.ts
import { decodeFunctionResult } from 'viem'
 
const value = decodeFunctionResult({
  abi: wagmiAbi,
  functionName: 'getInfo',
  data: '0x000000000000000000000000a5cc3c03994db5b0d9a5eedd10cabab0813678ac0000000000000000000000000000000000000000000000000000000000010f2c0000000000000000000000000000000000000000000000000000000000000001000000000000000000000000a5cc3c03994db5b0d9a5eedd10cabab0813678ac0000000000000000000000000000000000000000000000000000000000000045'
})
/**
 * {
 *  foo: {
 *    sender: '0xa5cc3c03994DB5b0d9A5eEdD10CabaB0813678AC',
 *    x: 69420n,
 *    y: true
 *  },
 *  sender: '0xa5cc3c03994DB5b0d9A5eEdD10CabaB0813678AC',
 *  z: 69
 * }

Return Value

The decoded data. Type is inferred from the ABI.

Parameters

abi

The contract's ABI.

const value = decodeFunctionResult({
  abi: wagmiAbi, 
  functionName: 'ownerOf',
  data: '0x000000000000000000000000a5cc3c03994db5b0d9a5eedd10cabab0813678ac'
})

functionName

  • Type: string

The function to encode from the ABI.

const value = decodeFunctionResult({
  abi: wagmiAbi,
  functionName: 'ownerOf', 
  data: '0x000000000000000000000000a5cc3c03994db5b0d9a5eedd10cabab0813678ac'
})

data

The calldata.

const value = decodeFunctionResult({
  abi: wagmiAbi,
  functionName: 'ownerOf',
  data: '0x000000000000000000000000a5cc3c03994db5b0d9a5eedd10cabab0813678ac'
})