feat!: v1 encoding and encoding improvements (FuelLabs#1780)

Author: danielbate

.changeset/mighty-berries-try.md

@@ -0,0 +1,6 @@
+---
+"@fuel-ts/abi-coder": minor
+"@fuel-ts/errors": minor
+---
+
+Introduce the v1 encoding scheme and use correct file naming conventions for `@fuel-ts/abi-coder`

packages/abi-coder/src/AbiCoder.ts

@@ -0,0 +1,40 @@
+import { ResolvedAbiType } from './ResolvedAbiType';
+import type { DecodedValue, InputValue, Coder } from './encoding/coders/AbstractCoder';
+import { getCoderForEncoding } from './encoding/strategies/getCoderForEncoding';
+import type { EncodingOptions } from './types/EncodingOptions';
+import type { JsonAbi, JsonAbiArgument } from './types/JsonAbi';
+
+export abstract class AbiCoder {
+  static getCoder(
+    abi: JsonAbi,
+    argument: JsonAbiArgument,
+    options: EncodingOptions = {
+      isSmallBytes: false,
+    }
+  ): Coder {
+    const resolvedAbiType = new ResolvedAbiType(abi, argument);
+    return getCoderForEncoding(options.encoding)(resolvedAbiType, options);
+  }
+
+  static encode(
+    abi: JsonAbi,
+    argument: JsonAbiArgument,
+    value: InputValue,
+    options?: EncodingOptions
+  ) {
+    return this.getCoder(abi, argument, options).encode(value);
+  }
+
+  static decode(
+    abi: JsonAbi,
+    argument: JsonAbiArgument,
+    data: Uint8Array,
+    offset: number,
+    options?: EncodingOptions
+  ): [DecodedValue | undefined, number] {
+    return this.getCoder(abi, argument, options).decode(data, offset) as [
+      DecodedValue | undefined,
+      number,
+    ];
+  }
+}

packages/abi-coder/src/function-fragment.ts packages/abi-coder/src/FunctionFragment.ts

@@ -5,21 +5,21 @@ import { bn } from '@fuel-ts/math';
 import { arrayify } from '@fuel-ts/utils';
 import { sha256 } from 'ethers';
 
-import { AbiCoder } from './abi-coder';
-import type { DecodedValue, InputValue } from './coders/abstract-coder';
-import { ByteCoder } from './coders/v0/byte';
-import { TupleCoder } from './coders/v0/tuple';
-import { VecCoder } from './coders/v0/vec';
-import { OPTION_CODER_TYPE } from './constants';
+import { AbiCoder } from './AbiCoder';
+import { ResolvedAbiType } from './ResolvedAbiType';
+import type { DecodedValue, InputValue } from './encoding/coders/AbstractCoder';
+import { ByteCoder } from './encoding/coders/v0/ByteCoder';
+import { TupleCoder } from './encoding/coders/v0/TupleCoder';
+import { VecCoder } from './encoding/coders/v0/VecCoder';
 import type {
   JsonAbi,
   JsonAbiArgument,
   JsonAbiFunction,
   JsonAbiFunctionAttribute,
-} from './json-abi';
-import { ResolvedAbiType } from './resolved-abi-type';
-import type { Uint8ArrayWithDynamicData } from './utilities';
-import { isPointerType, unpackDynamicData, findOrThrow, isHeapType } from './utilities';
+} from './types/JsonAbi';
+import { OPTION_CODER_TYPE } from './utils/constants';
+import type { Uint8ArrayWithDynamicData } from './utils/utilities';
+import { isPointerType, unpackDynamicData, findOrThrow, isHeapType } from './utils/utilities';
 
 export class FunctionFragment<
   TAbi extends JsonAbi = JsonAbi,

packages/abi-coder/src/interface.ts packages/abi-coder/src/Interface.ts

@@ -3,11 +3,11 @@ import { ErrorCode, FuelError } from '@fuel-ts/errors';
 import type { BytesLike } from '@fuel-ts/interfaces';
 import { arrayify } from '@fuel-ts/utils';
 
-import { AbiCoder } from './abi-coder';
-import type { InputValue } from './coders/abstract-coder';
-import { FunctionFragment } from './function-fragment';
-import type { JsonAbi, JsonAbiConfigurable } from './json-abi';
-import { findOrThrow } from './utilities';
+import { AbiCoder } from './AbiCoder';
+import { FunctionFragment } from './FunctionFragment';
+import type { InputValue } from './encoding/coders/AbstractCoder';
+import type { JsonAbi, JsonAbiConfigurable } from './types/JsonAbi';
+import { findOrThrow } from './utils/utilities';
 
 export class Interface<TAbi extends JsonAbi = JsonAbi> {
   readonly functions!: Record<string, FunctionFragment>;
@@ -101,7 +101,7 @@ export class Interface<TAbi extends JsonAbi = JsonAbi> {
     const { loggedType } = findOrThrow(this.jsonAbi.loggedTypes, (type) => type.logId === logId);
 
     return AbiCoder.decode(this.jsonAbi, loggedType, arrayify(data), 0, {
-      version: this.jsonAbi.encoding,
+      encoding: this.jsonAbi.encoding,
     });
   }
 

packages/abi-coder/src/resolved-abi-type.ts packages/abi-coder/src/ResolvedAbiType.ts

@@ -1,8 +1,8 @@
 import { ErrorCode, FuelError } from '@fuel-ts/errors';
 
-import { arrayRegEx, enumRegEx, genericRegEx, stringRegEx, structRegEx } from './constants';
-import type { JsonAbi, JsonAbiArgument } from './json-abi';
-import { findOrThrow } from './utilities';
+import type { JsonAbi, JsonAbiArgument } from './types/JsonAbi';
+import { arrayRegEx, enumRegEx, genericRegEx, stringRegEx, structRegEx } from './utils/constants';
+import { findOrThrow } from './utils/utilities';
 
 export class ResolvedAbiType {
   readonly abi: JsonAbi;