feat: implement support for new ABI error codes

.changeset/hot-results-happen.md

@@ -0,0 +1,11 @@
+---
+"@fuel-ts/transactions": patch
+"@fuel-ts/abi-typegen": patch
+"@fuel-ts/abi-coder": patch
+"@fuel-ts/versions": patch
+"@fuel-ts/account": patch
+"@fuel-ts/program": patch
+"@internal/forc": patch
+---
+
+feat: implement support for new ABI error codes

apps/create-fuels-counter-guide/fuel-toolchain.toml

@@ -2,5 +2,5 @@
 channel = "testnet"
 
 [components]
-forc = "0.68.6"
+forc = "0.68.7"
 fuel-core = "0.43.1"

internal/forc/VERSION

@@ -1 +1 @@
-0.68.6
+0.68.7

packages/abi-coder/src/index.ts

@@ -2,7 +2,7 @@ export { Coder, InputValue, DecodedValue } from './encoding/coders/AbstractCoder
 export type { FunctionFragment } from './FunctionFragment';
 export * from './encoding/coders';
 export { Interface } from './Interface';
-export type { JsonAbi } from './types/JsonAbiNew';
+export type { JsonAbi, ErrorCode as JsonAbiErrorCode } from './types/JsonAbiNew';
 export {
   SCRIPT_FIXED_SIZE,
   INPUT_COIN_FIXED_SIZE,

packages/abi-coder/src/types/JsonAbiNew.ts

@@ -12,6 +12,7 @@ export interface JsonAbi {
   readonly loggedTypes: readonly LoggedType[];
   readonly messagesTypes: readonly MessageType[];
   readonly configurables: readonly Configurable[];
+  readonly errorCodes?: Record<string, ErrorCode>;
 }
 
 export interface ConcreteType {
@@ -99,3 +100,16 @@ export interface Configurable {
   readonly concreteTypeId: string;
   readonly offset: number;
 }
+
+export interface ErrorPosition {
+  pkg: string;
+  file: string;
+  line: number;
+  column: number;
+}
+
+export interface ErrorCode {
+  readonly pos: ErrorPosition;
+  readonly logId: string | null;
+  readonly msg: string | null;
+}

packages/abi-coder/src/utils/transpile-abi.ts

@@ -139,6 +139,7 @@ export function transpileAbi(abi) {
     loggedTypes,
     messagesTypes: abi.messagesTypes,
     configurables,
+    errorCodes: abi.errorCodes,
   };
 
   // eslint-disable-next-line @typescript-eslint/no-explicit-any

packages/abi-typegen/src/abi/Abi.ts

@@ -3,10 +3,12 @@ import { normalizeString } from '@fuel-ts/utils';
 
 import type { ProgramTypeEnum } from '../types/enums/ProgramTypeEnum';
 import type { IConfigurable } from '../types/interfaces/IConfigurable';
+import type { IErrorCode } from '../types/interfaces/IErrorCode';
 import type { IFunction } from '../types/interfaces/IFunction';
 import type { IType } from '../types/interfaces/IType';
 import type { JsonAbiOld } from '../types/interfaces/JsonAbi';
 import type { JsonAbi } from '../types/interfaces/JsonAbiNew';
+import { parseErrorCodes } from '../utils/parseErrorCodes';
 import { parseFunctions } from '../utils/parseFunctions';
 import { parseTypes } from '../utils/parseTypes';
 import { transpileAbi } from '../utils/transpile-abi';
@@ -33,6 +35,7 @@ export class Abi {
   public types: IType[];
   public functions: IFunction[];
   public configurables: IConfigurable[];
+  public errorCodes?: IErrorCode[];
 
   constructor(params: {
     filepath: string;
@@ -73,11 +76,12 @@ export class Abi {
     this.storageSlotsContents = storageSlotsContents;
     this.outputDir = outputDir;
 
-    const { types, functions, configurables } = this.parse();
+    const { types, functions, configurables, errorCodes } = this.parse();
 
     this.types = types;
     this.functions = functions;
     this.configurables = configurables;
+    this.errorCodes = errorCodes;
 
     this.computeCommonTypesInUse();
   }
@@ -88,18 +92,21 @@ export class Abi {
       types: rawAbiTypes,
       functions: rawAbiFunctions,
       configurables: rawAbiConfigurables,
+      errorCodes: rawErrorCodes,
     } = transpiled;
 
     const types = parseTypes({ rawAbiTypes });
     const functions = parseFunctions({ rawAbiFunctions, types });
     const configurables = rawAbiConfigurables.map(
       (rawAbiConfigurable) => new Configurable({ types, rawAbiConfigurable })
     );
+    const errorCodes = parseErrorCodes({ rawErrorCodes, types });
 
     return {
       types,
       functions,
       configurables,
+      errorCodes,
     };
   }
 

packages/abi-typegen/src/abi/errors/ErrorCode.ts

@@ -0,0 +1,11 @@
+import type { IErrorCode } from '../../types/interfaces/IErrorCode';
+
+export class ErrorCode {
+  public code: string;
+  public value: IErrorCode['value'];
+
+  constructor(params: IErrorCode) {
+    this.code = params.code;
+    this.value = params.value;
+  }
+}

packages/abi-typegen/src/types/interfaces/IErrorCode.ts

@@ -0,0 +1,6 @@
+import type { JsonAbiErrorCode } from './JsonAbi';
+
+export interface IErrorCode {
+  code: string;
+  value: JsonAbiErrorCode;
+}

packages/abi-typegen/src/types/interfaces/JsonAbi.ts

@@ -8,6 +8,7 @@ export interface JsonAbiOld {
   readonly functions: readonly JsonAbiFunction[];
   readonly messagesTypes: readonly JsonAbiMessagesType[];
   readonly configurables: readonly JsonAbiConfigurable[];
+  readonly errorCodes?: Record<string, JsonAbiErrorCode>;
   readonly encoding?: string;
 }
 
@@ -55,3 +56,14 @@ export interface JsonAbiConfigurable {
   configurableType: JsonAbiArgument;
   offset: number;
 }
+
+export interface JsonAbiErrorCode {
+  pos: {
+    pkg: string;
+    file: string;
+    line: number;
+    column: number;
+  };
+  logId: string | null;
+  msg: string | null;
+}

packages/abi-typegen/src/types/interfaces/JsonAbiNew.ts

@@ -12,6 +12,7 @@ export interface JsonAbi {
   readonly loggedTypes: readonly LoggedType[];
   readonly messagesTypes: readonly MessageType[];
   readonly configurables: readonly Configurable[];
+  readonly errorCodes?: Record<string, ErrorCode>;
 }
 
 export interface ConcreteType {
@@ -99,3 +100,16 @@ export interface Configurable {
   readonly concreteTypeId: string;
   readonly offset: number;
 }
+
+export interface ErrorPosition {
+  pkg: string;
+  file: string;
+  line: number;
+  column: number;
+}
+
+export interface ErrorCode {
+  readonly pos: ErrorPosition;
+  readonly logId: string | null;
+  readonly msg: string | null;
+}

packages/abi-typegen/src/utils/makeErrorCodes.ts

@@ -0,0 +1,6 @@
+import { ErrorCode } from '../abi/errors/ErrorCode';
+import type { IErrorCode } from '../types/interfaces/IErrorCode';
+
+export function makeErrorCode(params: IErrorCode) {
+  return new ErrorCode(params);
+}

packages/abi-typegen/src/utils/parseErrorCodes.ts

@@ -0,0 +1,18 @@
+import type { ErrorCode } from '../abi/errors/ErrorCode';
+import type { IType } from '../types/interfaces/IType';
+import type { JsonAbiErrorCode } from '../types/interfaces/JsonAbi';
+
+import { makeErrorCode } from './makeErrorCodes';
+
+export function parseErrorCodes(params: {
+  types: IType[];
+  rawErrorCodes?: Record<string, JsonAbiErrorCode>;
+}) {
+  // const { types, rawErrorCodes } = params;
+  const { rawErrorCodes } = params;
+  const errorCodes: ErrorCode[] = Object.entries(rawErrorCodes ?? {}).map(([code, value]) =>
+    makeErrorCode({ code, value })
+  );
+
+  return errorCodes;
+}

packages/abi-typegen/src/utils/transpile-abi.ts

@@ -139,6 +139,7 @@ export function transpileAbi(abi) {
     loggedTypes,
     messagesTypes: abi.messagesTypes,
     configurables,
+    errorCodes: abi.errorCodes,
   };
 
   // eslint-disable-next-line @typescript-eslint/no-explicit-any

packages/account/src/providers/provider.ts

@@ -2615,20 +2615,24 @@ export default class Provider {
   ): FuelError {
     let logs: DecodedLogs['logs'] = [];
     let groupedLogs: DecodedLogs['groupedLogs'] = {};
+    let abis: JsonAbisFromAllCalls | undefined;
 
     if (transactionRequest.type === TransactionType.Script && transactionRequest.abis) {
       ({ logs, groupedLogs } = getAllDecodedLogs({
         receipts,
         mainAbi: transactionRequest.abis.main,
         externalAbis: transactionRequest.abis.otherContractsAbis,
       }));
+
+      abis = transactionRequest.abis;
     }
 
     return extractTxError({
       logs,
       groupedLogs,
       receipts,
       statusReason: reason,
+      abis,
     });
   }
 

packages/account/src/providers/transaction-response/transaction-response.ts

@@ -482,6 +482,7 @@ export class TransactionResponse {
     };
 
     let { logs, groupedLogs }: DecodedLogs = { logs: [], groupedLogs: {} };
+    let abis: JsonAbisFromAllCalls | undefined;
 
     if (this.abis) {
       ({ logs, groupedLogs } = getAllDecodedLogs({
@@ -492,6 +493,8 @@ export class TransactionResponse {
 
       transactionResult.logs = logs;
       transactionResult.groupedLogs = groupedLogs;
+
+      abis = this.abis;
     }
 
     const { receipts } = transactionResult;
@@ -505,6 +508,7 @@ export class TransactionResponse {
         statusReason: reason,
         logs,
         groupedLogs,
+        abis,
       });
     }