feat: Expose ABI decoding utilities

Author: joaquim-verges

.changeset/perfect-bananas-behave.md

@@ -0,0 +1,5 @@
+---
+"thirdweb": patch
+---
+
+Expose utilities to decode errors and function data

packages/thirdweb/src/exports/utils.ts

@@ -138,11 +138,17 @@ export { isBytes } from "viem";
 // abi
 // ------------------------------------------------
 export { encodeAbiParameters } from "../utils/abi/encodeAbiParameters.js";
+export { decodeError } from "../utils/abi/decodeError.js";
+export { decodeFunctionData } from "../utils/abi/decodeFunctionData.js";
+export { decodeFunctionResult } from "../utils/abi/decodeFunctionResult.js";
 
 /**
  * @utils
  */
-export { encodePacked } from "viem";
+export {
+  encodePacked,
+  decodeAbiParameters,
+} from "viem";
 
 // Useful helpers
 export { setThirdwebDomains } from "../utils/domains.js";

packages/thirdweb/src/utils/abi/decodeError.ts

@@ -0,0 +1,36 @@
+import { type Abi, AbiError } from "ox";
+import { resolveContractAbi } from "../../contract/actions/resolve-abi.js";
+import type { ThirdwebContract } from "../../contract/contract.js";
+import type { Hex } from "../encoding/hex.js";
+
+/**
+ * Decodes an error.
+ * @param options - The options object.
+ * @returns The decoded error.
+ * @example
+ * ```ts
+ * import { decodeError } from "thirdweb/utils";
+ *
+ * const data = "0x...";
+ * const error = await decodeError({ contract, data });
+ * ```
+ *
+ * @utils
+ */
+export async function decodeError<abi extends Abi.Abi>(options: {
+  contract: ThirdwebContract<abi>;
+  data: Hex;
+}) {
+  const { contract, data } = options;
+  let abi = contract?.abi;
+  if (contract && !abi) {
+    abi = await resolveContractAbi(contract).catch(() => undefined);
+  }
+  if (!abi) {
+    throw new Error(
+      `No ABI found for contract ${contract.address} on chain ${contract.chain.id}`,
+    );
+  }
+  const abiError = AbiError.fromAbi(abi, data) as AbiError.AbiError;
+  return AbiError.decode(abiError, data);
+}

packages/thirdweb/src/utils/abi/decodeFunctionData.ts

@@ -0,0 +1,35 @@
+import { type Abi, AbiFunction, type Hex } from "ox";
+import { resolveContractAbi } from "../../contract/actions/resolve-abi.js";
+import type { ThirdwebContract } from "../../contract/contract.js";
+
+/**
+ * Decodes the data of a function call.
+ * @param options - The options object.
+ * @returns The decoded data.
+ * @example
+ * ```ts
+ * import { decodeFunctionData } from "thirdweb/utils";
+ *
+ * const data = "0x...";
+ * const decodedData = await decodeFunctionData({ contract, data });
+ * ```
+ *
+ * @utils
+ */
+export async function decodeFunctionData<abi extends Abi.Abi>(options: {
+  contract: ThirdwebContract<abi>;
+  data: Hex.Hex;
+}) {
+  const { contract, data } = options;
+  let abi = contract?.abi;
+  if (contract && !abi) {
+    abi = await resolveContractAbi(contract).catch(() => undefined);
+  }
+  if (!abi) {
+    throw new Error(
+      `No ABI found for contract ${contract.address} on chain ${contract.chain.id}`,
+    );
+  }
+  const abiFunction = AbiFunction.fromAbi(abi, data);
+  return AbiFunction.decodeData(abiFunction, data);
+}

packages/thirdweb/src/utils/abi/decodeFunctionResult.ts

@@ -0,0 +1,35 @@
+import { type Abi, AbiFunction, type Hex } from "ox";
+import { resolveContractAbi } from "../../contract/actions/resolve-abi.js";
+import type { ThirdwebContract } from "../../contract/contract.js";
+
+/**
+ * Decodes the result of a function call.
+ * @param options - The options object.
+ * @returns The decoded result.
+ * @example
+ * ```ts
+ * import { decodeFunctionResult } from "thirdweb/utils";
+ *
+ * const data = "0x...";
+ * const result = await decodeFunctionResult({ contract, data });
+ * ```
+ *
+ * @utils
+ */
+export async function decodeFunctionResult<abi extends Abi.Abi>(options: {
+  contract: ThirdwebContract<abi>;
+  data: Hex.Hex;
+}) {
+  const { contract, ...rest } = options;
+  let abi = contract?.abi;
+  if (contract && !abi) {
+    abi = await resolveContractAbi(contract).catch(() => undefined);
+  }
+  if (!abi) {
+    throw new Error(
+      `No ABI found for contract ${contract.address} on chain ${contract.chain.id}`,
+    );
+  }
+  const abiFunction = AbiFunction.fromAbi(abi, rest.data);
+  return AbiFunction.decodeResult(abiFunction, rest.data);
+}