chore: mimic JsonAbi interface from abi-coder in abi-typegen (#…

…2743)

.changeset/strange-buses-smell.md

@@ -0,0 +1,5 @@
+---
+"@fuel-ts/abi-typegen": patch
+---
+
+chore: mimic `JsonAbi` interface from `abi-coder` in `abi-typegen`

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

@@ -5,7 +5,7 @@ import {
   getTypegenForcProject,
 } from '../../test/fixtures/forc-projects/index';
 import { ProgramTypeEnum } from '../types/enums/ProgramTypeEnum';
-import type { IRawAbiTypeRoot } from '../types/interfaces/IRawAbiType';
+import type { JsonAbiType } from '../types/interfaces/JsonAbi';
 import * as parseConfigurablesMod from '../utils/parseConfigurables';
 import * as parseFunctionsMod from '../utils/parseFunctions';
 import * as parseTypesMod from '../utils/parseTypes';
@@ -63,7 +63,7 @@ describe('Abi.ts', () => {
   }
 
   function getRawTypeFor(params: { type: string }) {
-    const rawAbiType: IRawAbiTypeRoot = {
+    const rawAbiType: JsonAbiType = {
       typeId: 1,
       type: params.type,
       components: null,

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

@@ -4,8 +4,8 @@ import { normalizeString } from '@fuel-ts/utils';
 import type { ProgramTypeEnum } from '../types/enums/ProgramTypeEnum';
 import type { IConfigurable } from '../types/interfaces/IConfigurable';
 import type { IFunction } from '../types/interfaces/IFunction';
-import type { IRawAbi } from '../types/interfaces/IRawAbi';
 import type { IType } from '../types/interfaces/IType';
+import type { JsonAbi } from '../types/interfaces/JsonAbi';
 import { parseConfigurables } from '../utils/parseConfigurables';
 import { parseFunctions } from '../utils/parseFunctions';
 import { parseTypes } from '../utils/parseTypes';
@@ -22,7 +22,7 @@ export class Abi {
 
   public commonTypesInUse: string[] = [];
 
-  public rawContents: IRawAbi;
+  public rawContents: JsonAbi;
   public hexlifiedBinContents?: string;
   public storageSlotsContents?: string;
 
@@ -33,7 +33,7 @@ export class Abi {
   constructor(params: {
     filepath: string;
     programType: ProgramTypeEnum;
-    rawContents: IRawAbi;
+    rawContents: JsonAbi;
     hexlifiedBinContents?: string;
     storageSlotsContents?: string;
     outputDir: string;

packages/abi-typegen/src/abi/configurable/Configurable.test.ts

@@ -2,8 +2,8 @@ import {
   AbiTypegenProjectsEnum,
   getTypegenForcProject,
 } from '../../../test/fixtures/forc-projects/index';
-import type { IRawAbiTypeRoot } from '../../types/interfaces/IRawAbiType';
 import type { IType } from '../../types/interfaces/IType';
+import type { JsonAbiType } from '../../types/interfaces/JsonAbi';
 import * as findTypeMod from '../../utils/findType';
 
 import { Configurable } from './Configurable';
@@ -13,7 +13,7 @@ import { Configurable } from './Configurable';
  */
 describe('Configurable.ts', () => {
   function mockAllDeps() {
-    const rawAbiType: IRawAbiTypeRoot = {
+    const rawAbiType: JsonAbiType = {
       typeId: 1,
       type: 'mockType',
       components: null,

packages/abi-typegen/src/abi/configurable/Configurable.ts

@@ -1,14 +1,14 @@
 import type { IConfigurable } from '../../types/interfaces/IConfigurable';
-import type { IRawAbiConfigurable } from '../../types/interfaces/IRawAbiConfigurable';
 import type { IType } from '../../types/interfaces/IType';
+import type { JsonAbiConfigurable } from '../../types/interfaces/JsonAbi';
 import { findType } from '../../utils/findType';
 
 export class Configurable implements IConfigurable {
   public name: string;
   public type: IType;
-  public rawAbiConfigurable: IRawAbiConfigurable;
+  public rawAbiConfigurable: JsonAbiConfigurable;
 
-  constructor(params: { types: IType[]; rawAbiConfigurable: IRawAbiConfigurable }) {
+  constructor(params: { types: IType[]; rawAbiConfigurable: JsonAbiConfigurable }) {
     const { types, rawAbiConfigurable } = params;
 
     this.name = rawAbiConfigurable.name;

packages/abi-typegen/src/abi/functions/Function.ts

@@ -1,4 +1,4 @@
-import type { IFunction, IRawAbiFunction, IFunctionAttributes } from '../../index';
+import type { IFunction, JsonAbiFunction, IFunctionAttributes } from '../../index';
 import { TargetEnum } from '../../types/enums/TargetEnum';
 import type { IType } from '../../types/interfaces/IType';
 import { findType } from '../../utils/findType';
@@ -8,10 +8,10 @@ import { EmptyType } from '../types/EmptyType';
 export class Function implements IFunction {
   public name: string;
   public types: IType[];
-  public rawAbiFunction: IRawAbiFunction;
+  public rawAbiFunction: JsonAbiFunction;
   public attributes: IFunctionAttributes;
 
-  constructor(params: { types: IType[]; rawAbiFunction: IRawAbiFunction }) {
+  constructor(params: { types: IType[]; rawAbiFunction: JsonAbiFunction }) {
     this.rawAbiFunction = params.rawAbiFunction;
     this.types = params.types;
     this.name = params.rawAbiFunction.name;

packages/abi-typegen/src/abi/types/AType.ts

@@ -1,12 +1,12 @@
-import type { IRawAbiTypeRoot } from '../../types/interfaces/IRawAbiType';
 import type { ITypeAttributes } from '../../types/interfaces/IType';
+import type { JsonAbiType } from '../../types/interfaces/JsonAbi';
 
 export class AType {
-  public rawAbiType: IRawAbiTypeRoot;
+  public rawAbiType: JsonAbiType;
   public attributes: ITypeAttributes;
   public requiredFuelsMembersImports: string[];
 
-  constructor(params: { rawAbiType: IRawAbiTypeRoot }) {
+  constructor(params: { rawAbiType: JsonAbiType }) {
     this.rawAbiType = params.rawAbiType;
     this.attributes = {
       inputLabel: 'unknown',

packages/abi-typegen/src/abi/types/ArrayType.test.ts

@@ -2,7 +2,7 @@ import {
   AbiTypegenProjectsEnum,
   getTypegenForcProject,
 } from '../../../test/fixtures/forc-projects';
-import type { IRawAbiTypeRoot } from '../../types/interfaces/IRawAbiType';
+import type { JsonAbiType } from '../../types/interfaces/JsonAbi';
 import { findType } from '../../utils/findType';
 import { makeType } from '../../utils/makeType';
 import * as parseTypeArgumentsMod from '../../utils/parseTypeArguments';
@@ -32,7 +32,7 @@ describe('ArrayType.ts', () => {
     const project = getTypegenForcProject(AbiTypegenProjectsEnum.STRUCT_WITH_ARRAY);
 
     const rawTypes = project.abiContents.types;
-    const types = rawTypes.map((rawAbiType: IRawAbiTypeRoot) => makeType({ rawAbiType }));
+    const types = rawTypes.map((rawAbiType: JsonAbiType) => makeType({ rawAbiType }));
 
     // validating `struct B`, with simple tuples on property `x`
     const b = findType({ types, typeId: 0 }) as ArrayType;
@@ -50,7 +50,7 @@ describe('ArrayType.ts', () => {
     const project = getTypegenForcProject(AbiTypegenProjectsEnum.ARRAY_WITH_GENERICS);
 
     const rawTypes = project.abiContents.types;
-    const types = rawTypes.map((rawAbiType: IRawAbiTypeRoot) => makeType({ rawAbiType }));
+    const types = rawTypes.map((rawAbiType: JsonAbiType) => makeType({ rawAbiType }));
 
     const a = findType({ types, typeId: 1 }) as ArrayType;
 

packages/abi-typegen/src/abi/types/EmptyType.ts

@@ -1,4 +1,4 @@
-import type { IRawAbiTypeRoot } from '../..';
+import type { JsonAbiType } from '../..';
 import type { IType } from '../../types/interfaces/IType';
 
 import { AType } from './AType';
@@ -10,7 +10,7 @@ export class EmptyType extends AType implements IType {
 
   static MATCH_REGEX: RegExp = /^\(\)$/m;
 
-  constructor(params: { rawAbiType: IRawAbiTypeRoot }) {
+  constructor(params: { rawAbiType: JsonAbiType }) {
     super(params);
     this.attributes = {
       /**

packages/abi-typegen/src/abi/types/EnumType.test.ts

@@ -3,7 +3,7 @@ import {
   getTypegenForcProject,
 } from '../../../test/fixtures/forc-projects/index';
 import { TargetEnum } from '../../types/enums/TargetEnum';
-import type { IRawAbiTypeRoot } from '../../types/interfaces/IRawAbiType';
+import type { JsonAbiType } from '../../types/interfaces/JsonAbi';
 import { findType } from '../../utils/findType';
 import { makeType } from '../../utils/makeType';
 
@@ -23,7 +23,7 @@ describe('EnumType.ts', () => {
       abiContents: { types: rawTypes },
     } = getTypegenForcProject(project);
 
-    const types = rawTypes.map((rawAbiType: IRawAbiTypeRoot) => makeType({ rawAbiType }));
+    const types = rawTypes.map((rawAbiType: JsonAbiType) => makeType({ rawAbiType }));
 
     return { types };
   }

packages/abi-typegen/src/abi/types/EnumType.ts

@@ -1,4 +1,4 @@
-import type { IRawAbiTypeComponent } from '../../index';
+import type { JsonAbiArgument } from '../../index';
 import type { TargetEnum } from '../../types/enums/TargetEnum';
 import type { IType } from '../../types/interfaces/IType';
 import { extractStructName } from '../../utils/extractStructName';
@@ -58,7 +58,7 @@ export class EnumType extends AType implements IType {
     const { components } = this.rawAbiType;
 
     // `components` array guaranteed to always exist for structs/enums
-    const enumComponents = components as IRawAbiTypeComponent[];
+    const enumComponents = components as JsonAbiArgument[];
 
     if (!enumComponents.every(({ type }) => typeHash[type] === EmptyType.swayType)) {
       return undefined;
@@ -73,7 +73,7 @@ export class EnumType extends AType implements IType {
     const { components } = this.rawAbiType;
 
     // `components` array guaranteed to always exist for structs/enums
-    const enumComponents = components as IRawAbiTypeComponent[];
+    const enumComponents = components as JsonAbiArgument[];
 
     const attributeKey: 'inputLabel' | 'outputLabel' = `${target}Label`;
 

packages/abi-typegen/src/abi/types/EvmAddressType.test.ts

@@ -2,7 +2,7 @@ import {
   AbiTypegenProjectsEnum,
   getTypegenForcProject,
 } from '../../../test/fixtures/forc-projects/index';
-import type { IRawAbiTypeRoot } from '../../index';
+import type { JsonAbiType } from '../../index';
 import { findType } from '../../utils/findType';
 import { makeType } from '../../utils/makeType';
 import * as parseTypeArgumentsMod from '../../utils/parseTypeArguments';
@@ -21,7 +21,7 @@ describe('EvmAddressType.ts', () => {
     const project = getTypegenForcProject(AbiTypegenProjectsEnum.EVM_ADDRESS);
 
     const rawTypes = project.abiContents.types;
-    const types = rawTypes.map((rawAbiType: IRawAbiTypeRoot) => makeType({ rawAbiType }));
+    const types = rawTypes.map((rawAbiType: JsonAbiType) => makeType({ rawAbiType }));
 
     const suitableForEvmAddress = EvmAddressType.isSuitableFor({ type: EvmAddressType.swayType });
     const suitableForStruct = EvmAddressType.isSuitableFor({ type: StructType.swayType });

packages/abi-typegen/src/abi/types/OptionType.test.ts

@@ -2,7 +2,7 @@ import {
   AbiTypegenProjectsEnum,
   getTypegenForcProject,
 } from '../../../test/fixtures/forc-projects/index';
-import type { IRawAbiTypeRoot } from '../../index';
+import type { JsonAbiType } from '../../index';
 import { findType } from '../../utils/findType';
 import { makeType } from '../../utils/makeType';
 
@@ -20,7 +20,7 @@ describe('OptionType.ts', () => {
     const project = getTypegenForcProject(AbiTypegenProjectsEnum.OPTION_SIMPLE);
     const rawTypes = project.abiContents.types;
 
-    const types = rawTypes.map((rawAbiType: IRawAbiTypeRoot) => makeType({ rawAbiType }));
+    const types = rawTypes.map((rawAbiType: JsonAbiType) => makeType({ rawAbiType }));
 
     return { types };
   }

packages/abi-typegen/src/abi/types/ResultType.test.ts

@@ -2,7 +2,7 @@ import {
   AbiTypegenProjectsEnum,
   getTypegenForcProject,
 } from '../../../test/fixtures/forc-projects/index';
-import type { IRawAbiTypeRoot } from '../../index';
+import type { JsonAbiType } from '../../index';
 import { parseTypes } from '../../utils/parseTypes';
 
 import { EnumType } from './EnumType';
@@ -17,7 +17,7 @@ describe('ResultType.ts', () => {
   */
   function getResultType() {
     const project = getTypegenForcProject(AbiTypegenProjectsEnum.FULL);
-    const rawTypes = project.abiContents.types as IRawAbiTypeRoot[];
+    const rawTypes = project.abiContents.types as JsonAbiType[];
     // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
     return parseTypes({ rawAbiTypes: [rawTypes.find((t) => t.type === 'enum Result')!] })[0];
   }

packages/abi-typegen/src/abi/types/StructType.test.ts

@@ -2,7 +2,7 @@ import {
   AbiTypegenProjectsEnum,
   getTypegenForcProject,
 } from '../../../test/fixtures/forc-projects/index';
-import type { IRawAbiTypeRoot } from '../../index';
+import type { JsonAbiType } from '../../index';
 import { TargetEnum } from '../../types/enums/TargetEnum';
 import { findType } from '../../utils/findType';
 import { makeType } from '../../utils/makeType';
@@ -24,7 +24,7 @@ describe('StructType.ts', () => {
     const project = getTypegenForcProject(AbiTypegenProjectsEnum.STRUCT_SIMPLE);
 
     const rawTypes = project.abiContents.types;
-    const types = rawTypes.map((rawAbiType: IRawAbiTypeRoot) => makeType({ rawAbiType }));
+    const types = rawTypes.map((rawAbiType: JsonAbiType) => makeType({ rawAbiType }));
 
     const suitableForStruct = StructType.isSuitableFor({ type: StructType.swayType });
     const suitableForU16 = StructType.isSuitableFor({ type: U16Type.swayType });

packages/abi-typegen/src/abi/types/StructType.ts

@@ -1,4 +1,4 @@
-import type { IRawAbiTypeComponent } from '../../index';
+import type { JsonAbiArgument } from '../../index';
 import type { TargetEnum } from '../../types/enums/TargetEnum';
 import type { IType } from '../../types/interfaces/IType';
 import { extractStructName } from '../../utils/extractStructName';
@@ -46,7 +46,7 @@ export class StructType extends AType implements IType {
     const { components } = this.rawAbiType;
 
     // `components` array guaranteed to always exist for structs/enums
-    const structComponents = components as IRawAbiTypeComponent[];
+    const structComponents = components as JsonAbiArgument[];
 
     // loop through all components
     const members = structComponents.map((component) => {

packages/abi-typegen/src/abi/types/TupleType.test.ts

@@ -2,7 +2,7 @@ import {
   AbiTypegenProjectsEnum,
   getTypegenForcProject,
 } from '../../../test/fixtures/forc-projects/index';
-import type { IRawAbiTypeRoot } from '../../index';
+import type { JsonAbiType } from '../../index';
 import { findType } from '../../utils/findType';
 import { makeType } from '../../utils/makeType';
 import * as parseTypeArgumentsMod from '../../utils/parseTypeArguments';
@@ -20,7 +20,7 @@ describe('TupleType.ts', () => {
     const project = getTypegenForcProject(AbiTypegenProjectsEnum.TUPLE_SIMPLE);
     const rawTypes = project.abiContents.types;
 
-    const types = rawTypes.map((rawAbiType: IRawAbiTypeRoot) => makeType({ rawAbiType }));
+    const types = rawTypes.map((rawAbiType: JsonAbiType) => makeType({ rawAbiType }));
 
     const suitableForTuple = TupleType.isSuitableFor({ type: TupleType.swayType });
     const suitableForArray = TupleType.isSuitableFor({ type: ArrayType.swayType });

packages/abi-typegen/src/abi/types/U8Type.ts

@@ -1,4 +1,4 @@
-import type { IRawAbiTypeRoot } from '../../index';
+import type { JsonAbiType } from '../../index';
 import type { IType } from '../../types/interfaces/IType';
 
 import { AType } from './AType';
@@ -10,7 +10,7 @@ export class U8Type extends AType implements IType {
 
   public static MATCH_REGEX: RegExp = /^u8$/m;
 
-  constructor(params: { rawAbiType: IRawAbiTypeRoot }) {
+  constructor(params: { rawAbiType: JsonAbiType }) {
     super(params);
     this.attributes = {
       inputLabel: `BigNumberish`,

packages/abi-typegen/src/index.ts

@@ -6,8 +6,4 @@ export * from './types/enums/ProgramTypeEnum';
 export * from './types/interfaces/IConfigurable';
 export * from './types/interfaces/IFile';
 export * from './types/interfaces/IFunction';
-export * from './types/interfaces/IRawAbi';
-export * from './types/interfaces/IRawAbiConfigurable';
-export * from './types/interfaces/IRawAbiFunction';
-export * from './types/interfaces/IRawAbiType';
-export * from './types/interfaces/IRawAbiLoggedTypes';
+export * from './types/interfaces/JsonAbi';

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

@@ -1,8 +1,8 @@
-import type { IRawAbiConfigurable } from './IRawAbiConfigurable';
 import type { IType } from './IType';
+import type { JsonAbiConfigurable } from './JsonAbi';
 
 export interface IConfigurable {
   name: string;
   type: IType;
-  rawAbiConfigurable: IRawAbiConfigurable;
+  rawAbiConfigurable: JsonAbiConfigurable;
 }

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

@@ -1,5 +1,5 @@
-import type { IRawAbiFunction } from './IRawAbiFunction';
 import type { IType } from './IType';
+import type { JsonAbiFunction } from './JsonAbi';
 
 export interface IFunctionAttributes {
   inputs: string;
@@ -10,7 +10,7 @@ export interface IFunctionAttributes {
 export interface IFunction {
   types: IType[];
   name: string;
-  rawAbiFunction: IRawAbiFunction;
+  rawAbiFunction: JsonAbiFunction;
   attributes: IFunctionAttributes;
   getDeclaration(): string;
 }