feat: decodeErrorResult

.changeset/thick-peas-remember.md

@@ -0,0 +1,5 @@
+---
+"viem": patch
+---
+
+Added `decodeErrorResult`.

site/.vitepress/sidebar.ts

@@ -438,8 +438,8 @@ export const sidebar: DefaultTheme.Sidebar = {
               link: '/docs/contract/decodeDeployData',
             },
             {
-              text: 'decodeErrorData 🚧',
-              link: '/docs/contract/decodeErrorData',
+              text: 'decodeErrorResult',
+              link: '/docs/contract/decodeErrorResult',
             },
             {
               text: 'decodeEventTopics 🚧',
@@ -462,8 +462,8 @@ export const sidebar: DefaultTheme.Sidebar = {
               link: '/docs/contract/encodeDeployData',
             },
             {
-              text: 'encodeErrorData 🚧',
-              link: '/docs/contract/encodeErrorData',
+              text: 'encodeErrorResult 🚧',
+              link: '/docs/contract/encodeErrorResult',
             },
             {
               text: 'encodeEventTopics 🚧',

site/docs/contract/decodeErrorResult.md

@@ -0,0 +1,85 @@
+# decodeErrorResult
+
+Decodes reverted error from a contract function call.
+
+## Install
+
+```ts
+import { decodeErrorResult } from 'viem'
+```
+
+## Usage
+
+::: code-group
+
+```ts [example.ts]
+import { decodeErrorResult } from 'viem'
+
+const value = decodeErrorResult({
+  abi: wagmiAbi,
+  data: '0xb758934b000000000000000000000000000000000000000000000000000000000000002000000000000000000000000000000000000000000000000000000000000000600000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000000b68656c6c6f20776f726c64000000000000000000000000000000000000000000'
+})
+// { errorName: 'InvalidTokenError', args: ['sold out'] }
+```
+
+```ts [abi.ts]
+export const wagmiAbi = [
+  ...
+  {
+		inputs: [
+			{
+				internalType: "string",
+				name: "reason",
+				type: "string"
+			}
+		],
+		name: "InvalidTokenError",
+		type: "error"
+	},
+  ...
+] as const;
+```
+
+```ts [client.ts]
+import { createPublicClient, http } from 'viem'
+import { mainnet } from 'viem/chains'
+
+export const publicClient = createPublicClient({
+  chain: mainnet,
+  transport: http()
+})
+```
+
+:::
+
+## Return Value
+
+The decoded error. Type is inferred from the ABI.
+
+## Parameters
+
+### abi
+
+- **Type:** [`Abi`](/docs/glossary/types#TODO)
+
+The contract's ABI.
+
+```ts
+const value = decodeErrorResult({
+  abi: wagmiAbi, // [!code focus]
+  data: '0xb758934b000000000000000000000000000000000000000000000000000000000000002000000000000000000000000000000000000000000000000000000000000000600000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000000b68656c6c6f20776f726c64000000000000000000000000000000000000000000'
+})
+```
+
+### data
+
+- **Type**: `Hex`
+
+The calldata.
+
+```ts
+const value = decodeErrorResult({
+  abi: wagmiAbi,
+  data: '0xb758934b000000000000000000000000000000000000000000000000000000000000002000000000000000000000000000000000000000000000000000000000000000600000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000000b68656c6c6f20776f726c64000000000000000000000000000000000000000000' // [!code focus]
+})
+```

src/errors/abi.ts

@@ -76,6 +76,22 @@ export class AbiEncodingLengthMismatchError extends BaseError {
   }
 }
 
+export class AbiErrorSignatureNotFoundError extends BaseError {
+  name = 'AbiErrorSignatureNotFoundError'
+  constructor(signature: Hex) {
+    super(
+      [
+        `Encoded error signature "${signature}" not found on ABI.`,
+        'Make sure you are using the correct ABI and that the error exists on it.',
+        `You can look up the signature "${signature}" here: https://sig.eth.samczsun.com/.`,
+      ].join('\n'),
+      {
+        docsPath: '/docs/contract/decodeErrorResult',
+      },
+    )
+  }
+}
+
 export class AbiFunctionNotFoundError extends BaseError {
   name = 'AbiFunctionNotFoundError'
   constructor(functionName: string) {

src/errors/index.ts

@@ -4,6 +4,7 @@ export {
   AbiDecodingDataSizeInvalidError,
   AbiEncodingArrayLengthMismatchError,
   AbiEncodingLengthMismatchError,
+  AbiErrorSignatureNotFoundError,
   AbiFunctionNotFoundError,
   AbiFunctionOutputsNotFoundError,
   AbiFunctionSignatureNotFoundError,

src/index.test.ts

@@ -70,6 +70,7 @@ test('exports actions', () => {
       "custom": [Function],
       "decodeAbi": [Function],
       "decodeBytes": [Function],
+      "decodeErrorResult": [Function],
       "decodeFunctionData": [Function],
       "decodeFunctionResult": [Function],
       "decodeHex": [Function],

src/index.ts

@@ -273,6 +273,7 @@ export {
   bytesToNumber,
   decodeAbi,
   decodeBytes,
+  decodeErrorResult,
   decodeFunctionData,
   decodeFunctionResult,
   decodeHex,

src/utils/abi/decodeErrorResult.test.ts

@@ -0,0 +1,130 @@
+import { expect, test } from 'vitest'
+
+import { decodeErrorResult } from './decodeErrorResult'
+
+test('revert SoldOutError()', () => {
+  expect(
+    decodeErrorResult({
+      abi: [
+        {
+          inputs: [],
+          name: 'SoldOutError',
+          type: 'error',
+        },
+      ],
+      data: '0x7f6df6bb',
+    }),
+  ).toEqual({ errorName: 'SoldOutError', args: undefined })
+  expect(
+    decodeErrorResult({
+      abi: [
+        // @ts-expect-error
+        {
+          name: 'SoldOutError',
+          type: 'error',
+        },
+      ],
+      data: '0x7f6df6bb',
+    }),
+  ).toEqual({ errorName: 'SoldOutError', args: undefined })
+})
+
+test('revert AccessDeniedError(string)', () => {
+  expect(
+    decodeErrorResult({
+      abi: [
+        {
+          inputs: [
+            {
+              internalType: 'string',
+              name: 'a',
+              type: 'string',
+            },
+          ],
+          name: 'AccessDeniedError',
+          type: 'error',
+        },
+      ],
+      data: '0x83aa206e0000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000001a796f7520646f206e6f7420686176652061636365737320736572000000000000',
+    }),
+  ).toEqual({
+    errorName: 'AccessDeniedError',
+    args: ['you do not have access ser'],
+  })
+})
+
+test('revert AccessDeniedError((uint256,bool,address,uint256))', () => {
+  expect(
+    decodeErrorResult({
+      abi: [
+        {
+          inputs: [
+            {
+              components: [
+                {
+                  internalType: 'uint256',
+                  name: 'weight',
+                  type: 'uint256',
+                },
+                {
+                  internalType: 'bool',
+                  name: 'voted',
+                  type: 'bool',
+                },
+                {
+                  internalType: 'address',
+                  name: 'delegate',
+                  type: 'address',
+                },
+                {
+                  internalType: 'uint256',
+                  name: 'vote',
+                  type: 'uint256',
+                },
+              ],
+              internalType: 'struct Ballot.Voter',
+              name: 'voter',
+              type: 'tuple',
+            },
+          ],
+          name: 'AccessDeniedError',
+          type: 'error',
+        },
+      ],
+      data: '0x0a1895610000000000000000000000000000000000000000000000000000000000010f2c0000000000000000000000000000000000000000000000000000000000000001000000000000000000000000a5cc3c03994db5b0d9a5eedd10cabab0813678ac0000000000000000000000000000000000000000000000000000000000000029',
+    }),
+  ).toEqual({
+    errorName: 'AccessDeniedError',
+    args: [
+      {
+        delegate: '0xa5cc3c03994DB5b0d9A5eEdD10CabaB0813678AC',
+        vote: 41n,
+        voted: true,
+        weight: 69420n,
+      },
+    ],
+  })
+})
+
+test("errors: error doesn't exist", () => {
+  expect(() =>
+    decodeErrorResult({
+      abi: [
+        {
+          inputs: [],
+          name: 'SoldOutError',
+          type: 'error',
+        },
+      ],
+      data: '0xa37414670000000000000000000000000000000000000000000000000000000000010f2c0000000000000000000000000000000000000000000000000000000000000001000000000000000000000000a5cc3c03994db5b0d9a5eedd10cabab0813678ac0000000000000000000000000000000000000000000000000000000000000029',
+    }),
+  ).toThrowErrorMatchingInlineSnapshot(`
+    "Encoded error signature \\"0xa3741467\\" not found on ABI.
+    Make sure you are using the correct ABI and that the error exists on it.
+    You can look up the signature \\"0xa3741467\\" here: https://sig.eth.samczsun.com/.
+
+    Docs: https://viem.sh/docs/contract/decodeErrorResult
+
+    Version: [email protected]"
+  `)
+})

src/utils/abi/decodeErrorResult.ts

@@ -0,0 +1,24 @@
+import { Abi } from 'abitype'
+import { AbiErrorSignatureNotFoundError } from '../../errors'
+import { Hex } from '../../types'
+import { slice } from '../data'
+import { getFunctionSignature } from '../hash'
+import { decodeAbi } from './decodeAbi'
+import { getDefinition } from './getDefinition'
+
+export function decodeErrorResult({ abi, data }: { abi: Abi; data: Hex }) {
+  const signature = slice(data, 0, 4)
+  const description = abi.find(
+    (x) => signature === getFunctionSignature(getDefinition(x)),
+  )
+  if (!description) throw new AbiErrorSignatureNotFoundError(signature)
+  return {
+    errorName: (description as { name: string }).name,
+    args:
+      'inputs' in description &&
+      description.inputs &&
+      description.inputs.length > 0
+        ? decodeAbi({ data: slice(data, 4), params: description.inputs })
+        : undefined,
+  }
+}

src/utils/abi/decodeFunctionData.ts

@@ -1,6 +1,6 @@
 import { Abi } from 'abitype'
-import { AbiFunctionSignatureNotFoundError } from '../../errors'
 
+import { AbiFunctionSignatureNotFoundError } from '../../errors'
 import { Hex } from '../../types'
 import { slice } from '../data'
 import { getFunctionSignature } from '../hash'

src/utils/abi/index.test.ts

@@ -6,6 +6,7 @@ test('exports utils', () => {
   expect(utils).toMatchInlineSnapshot(`
     {
       "decodeAbi": [Function],
+      "decodeErrorResult": [Function],
       "decodeFunctionData": [Function],
       "decodeFunctionResult": [Function],
       "encodeAbi": [Function],

src/utils/abi/index.ts

@@ -1,5 +1,7 @@
 export { decodeAbi } from './decodeAbi'
 
+export { decodeErrorResult } from './decodeErrorResult'
+
 export { decodeFunctionData } from './decodeFunctionData'
 
 export { decodeFunctionResult } from './decodeFunctionResult'

src/utils/index.test.ts

@@ -15,6 +15,7 @@ test('exports utils', () => {
       "bytesToString": [Function],
       "decodeAbi": [Function],
       "decodeBytes": [Function],
+      "decodeErrorResult": [Function],
       "decodeFunctionData": [Function],
       "decodeFunctionResult": [Function],
       "decodeHex": [Function],

src/utils/index.ts

@@ -1,5 +1,6 @@
 export {
   decodeAbi,
+  decodeErrorResult,
   decodeFunctionData,
   decodeFunctionResult,
   encodeAbi,