chore!: redistributed the @fuel-ts/interfaces package (#3492)

* chore: removed `@fuel-ts/interfaces` package and `AbstractAddress` * chore: finalize changes * chore: fix logger test * chore: changeset * chore: update changeset * chore: fixed changeset * chore: fixed failing tests * Update packages/logger/test/index.test.ts * chore: fix import * chore: fixed import --------- Co-authored-by: Anderson Arboleya <[email protected]> Co-authored-by: Sérgio Torres <[email protected]>
FuelLabs · Jan 7, 2025 · 0b4c3ab · 0b4c3ab
1 parent e83b237
commit 0b4c3ab
Show file tree

Hide file tree

Showing 127 changed files with 318 additions and 1,145 deletions.
diff --git a/.changeset/wild-dots-bake.md b/.changeset/wild-dots-bake.md
@@ -0,0 +1,20 @@
+---
+"@internal/check-imports": patch
+"@fuel-ts/transactions": patch
+"@fuel-ts/abi-typegen": patch
+"@fuel-ts/abi-coder": patch
+"@fuel-ts/contract": patch
+"@fuel-ts/account": patch
+"@fuel-ts/address": patch
+"@fuel-ts/program": patch
+"@fuel-ts/recipes": patch
+"@fuel-ts/crypto": patch
+"@fuel-ts/errors": patch
+"@fuel-ts/hasher": patch
+"@fuel-ts/logger": patch
+"@fuel-ts/script": patch
+"fuels": minor
+"@fuel-ts/utils": patch
+---
+
+chore!: redistributed the `@fuel-ts/interfaces` package
diff --git a/apps/docs/spell-check-custom-words.txt b/apps/docs/spell-check-custom-words.txt
@@ -2,7 +2,6 @@ ABI
 ABI's
 abigen
 ABIs
-AbstractAddress
 ALU
 ANDs
 API's

diff --git a/apps/docs/src/guide/contracts/managing-deployed-contracts.md b/apps/docs/src/guide/contracts/managing-deployed-contracts.md
@@ -4,7 +4,7 @@ To interact with a deployed contract using the SDK without redeploying it, you o
 
 ## Contract ID
 
-The `contractId` property from the [`Contract`](https://fuels-ts-docs-api.vercel.app/classes/_fuel_ts_program.Contract.html) class is of type [`AbstractAddress`](https://fuels-ts-docs-api.vercel.app/classes/_fuel_ts_interfaces.AbstractAddress.html), an abstract class that is exclusively extended by the [`Address`](https://fuels-ts-docs-api.vercel.app/classes/_fuel_ts_address.Address.html) class.
+The `contractId` property from the [`Contract`](https://fuels-ts-docs-api.vercel.app/classes/_fuel_ts_program.Contract.html) class is an instance of the [`Address`](https://fuels-ts-docs-api.vercel.app/classes/_fuel_ts_address.Address.html) class.
 
 The [`Address`](https://fuels-ts-docs-api.vercel.app/classes/_fuel_ts_address.Address.html) class wraps all methods from the [`AbstractAddress`](https://fuels-ts-docs-api.vercel.app/classes/_fuel_ts_interfaces.AbstractAddress.html) class and adds a single property: `b256Address`. This property is a string encoded in [`B256`](../types/bits256.md) format.
 

diff --git a/apps/docs/src/guide/types/address.md b/apps/docs/src/guide/types/address.md
@@ -2,21 +2,15 @@
 
 In Sway, the [`Address`](https://fuels-ts-docs-api.vercel.app/classes/_fuel_ts_address.Address.html) type serves as a type-safe wrapper around the primitive `b256` type. The SDK takes a different approach and has its own abstraction for the [Address](https://fuels-ts-docs-api.vercel.app/classes/_fuel_ts_address.Address.html) type.
 
-## `AbstractAddress` Class
-
-The SDK defines the [AbstractAddress](https://fuels-ts-docs-api.vercel.app/classes/_fuel_ts_interfaces.AbstractAddress.html) class, which provides a set of utility functions for easy manipulation and conversion between address formats.
-
-<<< @/../../../packages/interfaces/src/index.ts#address-1{ts:line-numbers}
-
 ## Address Class
 
-Besides conforming to the interface of the [`AbstractAddress`](https://fuels-ts-docs-api.vercel.app/classes/_fuel_ts_interfaces.AbstractAddress.html), the [`Address`](https://fuels-ts-docs-api.vercel.app/classes/_fuel_ts_address.Address.html) class also defines one property; `b256Address`, which is of the [`B256`](./bits256.md) type.
+The [`Address`](https://fuels-ts-docs-api.vercel.app/classes/_fuel_ts_address.Address.html) class also provides a set of utility functions for easy manipulation and conversion between address formats along with one property; `b256Address`, which is of the [`B256`](./bits256.md) type.
 
 <<< @/../../../packages/address/src/address.ts#address-2{ts:line-numbers}
 
 ## Creating an Address
 
-Thanks to the utility functions provided by the [`AbstractAddress`](https://fuels-ts-docs-api.vercel.app/classes/_fuel_ts_interfaces.AbstractAddress.html) class, there are several ways to create an [`Address`](https://fuels-ts-docs-api.vercel.app/classes/_fuel_ts_address.Address.html) instance:
+There are several ways to create an [`Address`](https://fuels-ts-docs-api.vercel.app/classes/_fuel_ts_address.Address.html) instance:
 
 ### From a b256 address
 

diff --git a/apps/docs/src/guide/utilities/address-conversion.md b/apps/docs/src/guide/utilities/address-conversion.md
@@ -25,13 +25,13 @@ This guide demonstrates how to convert between address formats and Sway Standard
 
 ## Converting a Contract ID
 
-The Contract `id` property has the [`AbstractAddress`](../types/address.md#abstractaddress-class) type. Therefore, it can be converted using the [`Address`](https://fuels-ts-docs-api.vercel.app/classes/_fuel_ts_address.Address.html) class functions such as `toAddress` and `toB256`:
+The Contract `id` property is an instance of the [`Address`](https://fuels-ts-docs-api.vercel.app/classes/_fuel_ts_address.Address.html) class. Therefore, it can be converted using the [`Address`](https://fuels-ts-docs-api.vercel.app/classes/_fuel_ts_address.Address.html) class functions such as `toAddress` and `toB256`:
 
 <<< @./snippets/address-conversion/contract.ts#conversion-2{ts:line-numbers}
 
 ## Converting a Wallet Address
 
-Similarly, the Wallet `address` property is also of type [`AbstractAddress`](../types/address.md#abstractaddress-class) and can therefore use the same [`Address`](https://fuels-ts-docs-api.vercel.app/classes/_fuel_ts_address.Address.html) class functions for conversion:
+Similarly, the Wallet `address` property is also of type [`Address`](https://fuels-ts-docs-api.vercel.app/classes/_fuel_ts_address.Address.html) and can therefore use the same [`Address`](https://fuels-ts-docs-api.vercel.app/classes/_fuel_ts_address.Address.html) class functions for conversion:
 
 <<< @./snippets/address-conversion/wallet.ts#conversion-3{ts:line-numbers}
 

diff --git a/internal/check-imports/package.json b/internal/check-imports/package.json
@@ -16,7 +16,6 @@
     "@fuel-ts/crypto": "workspace:*",
     "@fuel-ts/errors": "workspace:*",
     "@fuel-ts/hasher": "workspace:*",
-    "@fuel-ts/interfaces": "workspace:*",
     "@fuel-ts/math": "workspace:*",
     "@fuel-ts/merkle": "workspace:*",
     "@fuel-ts/program": "workspace:*",

diff --git a/internal/check-imports/src/imports.ts b/internal/check-imports/src/imports.ts
@@ -8,7 +8,6 @@ import * as errors from '@fuel-ts/errors';
 // forc-bin
 // fuels-gauge
 import * as hasher from '@fuel-ts/hasher';
-import * as interfaces from '@fuel-ts/interfaces';
 import * as math from '@fuel-ts/math';
 import * as merkle from '@fuel-ts/merkle';
 import * as program from '@fuel-ts/program';
@@ -28,7 +27,6 @@ log([
   errors,
   fuels,
   hasher,
-  interfaces,
   crypto,
   math,
   merkle,

diff --git a/packages/abi-coder/package.json b/packages/abi-coder/package.json
@@ -29,8 +29,7 @@
   "dependencies": {
     "@fuel-ts/crypto": "workspace:*",
     "@fuel-ts/errors": "workspace:*",
-    "@fuel-ts/hasher": "workspace:*",
-    "@fuel-ts/interfaces": "workspace:*",
+    "@fuel-ts/hasher": "workspace:^",
     "@fuel-ts/math": "workspace:*",
     "@fuel-ts/utils": "workspace:*",
     "type-fest": "4.26.1"

diff --git a/packages/abi-coder/src/FunctionFragment.ts b/packages/abi-coder/src/FunctionFragment.ts
@@ -1,8 +1,8 @@
 import { bufferFromString } from '@fuel-ts/crypto';
 import { ErrorCode, FuelError } from '@fuel-ts/errors';
 import { sha256 } from '@fuel-ts/hasher';
-import type { BytesLike } from '@fuel-ts/interfaces';
 import { bn } from '@fuel-ts/math';
+import type { BytesLike } from '@fuel-ts/utils';
 import { arrayify } from '@fuel-ts/utils';
 
 import { AbiCoder } from './AbiCoder';

diff --git a/packages/abi-coder/src/Interface.ts b/packages/abi-coder/src/Interface.ts
@@ -1,6 +1,6 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 import { ErrorCode, FuelError } from '@fuel-ts/errors';
-import type { BytesLike } from '@fuel-ts/interfaces';
+import type { BytesLike } from '@fuel-ts/utils';
 import { arrayify } from '@fuel-ts/utils';
 
 import { AbiCoder } from './AbiCoder';

diff --git a/packages/abi-coder/src/encoding/coders/AbstractCoder.ts b/packages/abi-coder/src/encoding/coders/AbstractCoder.ts
@@ -1,5 +1,5 @@
-import type { BytesLike } from '@fuel-ts/interfaces';
 import type { BN } from '@fuel-ts/math';
+import type { BytesLike } from '@fuel-ts/utils';
 
 import type { Option } from './OptionCoder';
 

diff --git a/packages/abi-coder/src/index.ts b/packages/abi-coder/src/index.ts
@@ -14,3 +14,4 @@ export {
   calculateVmTxMemory,
   ENCODING_V1,
 } from './utils/constants';
+export type { Bytes, RawSlice, StdString, StrSlice } from './utils/types';
diff --git a/packages/abi-coder/src/utils/types.ts b/packages/abi-coder/src/utils/types.ts
@@ -0,0 +1,4 @@
+export type Bytes = Uint8Array | number[];
+export type RawSlice = Uint8Array | number[];
+export type StdString = string;
+export type StrSlice = string;
diff --git a/packages/abi-typegen/package.json b/packages/abi-typegen/package.json
@@ -53,7 +53,6 @@
   "license": "Apache-2.0",
   "dependencies": {
     "@fuel-ts/errors": "workspace:*",
-    "@fuel-ts/interfaces": "workspace:*",
     "@fuel-ts/utils": "workspace:*",
     "@fuel-ts/versions": "workspace:*",
     "commander": "12.1.0",

diff --git a/packages/abi-typegen/src/templates/contract/main.hbs b/packages/abi-typegen/src/templates/contract/main.hbs
@@ -6,7 +6,7 @@ import type {
   Provider,
   Account,
   StorageSlot,
-  AbstractAddress,
+  Address,
 {{#each imports}}
   {{this}},
 {{/each}}
@@ -81,7 +81,7 @@ export class {{capitalizedName}} extends Contract {
   };
 
   constructor(
-    id: string | AbstractAddress,
+    id: string | Address,
     accountOrProvider: Account | Provider,
   ) {
     super(id, abi, accountOrProvider);

diff --git a/packages/abi-typegen/test/fixtures/templates/contract-with-configurable/main.hbs b/packages/abi-typegen/test/fixtures/templates/contract-with-configurable/main.hbs
@@ -15,7 +15,7 @@ import type {
   Provider,
   Account,
   StorageSlot,
-  AbstractAddress,
+  Address,
   BigNumberish,
   FunctionFragment,
   InvokeFunction,
@@ -197,7 +197,7 @@ export class MyContract extends Contract {
   };
 
   constructor(
-    id: string | AbstractAddress,
+    id: string | Address,
     accountOrProvider: Account | Provider,
   ) {
     super(id, abi, accountOrProvider);

diff --git a/packages/abi-typegen/test/fixtures/templates/contract/main.hbs b/packages/abi-typegen/test/fixtures/templates/contract/main.hbs
@@ -15,7 +15,7 @@ import type {
   Provider,
   Account,
   StorageSlot,
-  AbstractAddress,
+  Address,
   BigNumberish,
   BN,
   Bytes,
@@ -1248,7 +1248,7 @@ export class MyContract extends Contract {
   };
 
   constructor(
-    id: string | AbstractAddress,
+    id: string | Address,
     accountOrProvider: Account | Provider,
   ) {
     super(id, abi, accountOrProvider);

diff --git a/packages/account/package.json b/packages/account/package.json
@@ -53,7 +53,6 @@
     "@fuel-ts/crypto": "workspace:*",
     "@fuel-ts/errors": "workspace:*",
     "@fuel-ts/hasher": "workspace:*",
-    "@fuel-ts/interfaces": "workspace:*",
     "@fuel-ts/math": "workspace:*",
     "@fuel-ts/merkle": "workspace:*",
     "@fuel-ts/transactions": "workspace:*",

diff --git a/packages/account/src/account.ts b/packages/account/src/account.ts
@@ -1,12 +1,12 @@
 import { UTXO_ID_LEN } from '@fuel-ts/abi-coder';
+import type { WithAddress } from '@fuel-ts/address';
 import { Address } from '@fuel-ts/address';
 import { randomBytes } from '@fuel-ts/crypto';
 import { ErrorCode, FuelError } from '@fuel-ts/errors';
-import { AbstractAccount } from '@fuel-ts/interfaces';
-import type { AbstractAddress, BytesLike } from '@fuel-ts/interfaces';
 import type { BigNumberish, BN } from '@fuel-ts/math';
 import { bn } from '@fuel-ts/math';
 import { InputType } from '@fuel-ts/transactions';
+import type { BytesLike } from '@fuel-ts/utils';
 import { arrayify, hexlify, isDefined } from '@fuel-ts/utils';
 import { clone } from 'ramda';
 
@@ -46,6 +46,7 @@ import {
   isRequestInputResource,
 } from './providers/transaction-request/helpers';
 import { mergeQuantities } from './providers/utils/merge-quantities';
+import { AbstractAccount } from './types';
 import { assembleTransferToContractScript } from './utils/formatTransferToContractScriptData';
 
 export type TxParamsType = Pick<
@@ -54,13 +55,13 @@ export type TxParamsType = Pick<
 >;
 
 export type TransferParams = {
-  destination: string | AbstractAddress;
+  destination: string | Address;
   amount: BigNumberish;
   assetId: BytesLike;
 };
 
 export type ContractTransferParams = {
-  contractId: string | AbstractAddress;
+  contractId: string | Address;
   amount: BigNumberish;
   assetId: BytesLike;
 };
@@ -76,11 +77,11 @@ export type FakeResources = Partial<Coin> & Required<Pick<Coin, 'amount' | 'asse
 /**
  * `Account` provides an abstraction for interacting with accounts or wallets on the network.
  */
-export class Account extends AbstractAccount {
+export class Account extends AbstractAccount implements WithAddress {
   /**
    * The address associated with the account.
    */
-  readonly address: AbstractAddress;
+  readonly address: Address;
 
   /**
    * The provider used to interact with the network.
@@ -99,7 +100,7 @@ export class Account extends AbstractAccount {
    * @param provider - A Provider instance  (optional).
    * @param connector - A FuelConnector instance (optional).
    */
-  constructor(address: string | AbstractAddress, provider?: Provider, connector?: FuelConnector) {
+  constructor(address: string | Address, provider?: Provider, connector?: FuelConnector) {
     super();
     this._provider = provider;
     this._connector = connector;
@@ -341,7 +342,7 @@ export class Account extends AbstractAccount {
    * @returns A promise that resolves to the prepared transaction request.
    */
   async createTransfer(
-    destination: string | AbstractAddress,
+    destination: string | Address,
     amount: BigNumberish,
     assetId?: BytesLike,
     txParams: TxParamsType = {}
@@ -369,7 +370,7 @@ export class Account extends AbstractAccount {
    * @returns A promise that resolves to the transaction response.
    */
   async transfer(
-    destination: string | AbstractAddress,
+    destination: string | Address,
     amount: BigNumberish,
     assetId?: BytesLike,
     txParams: TxParamsType = {}
@@ -437,7 +438,7 @@ export class Account extends AbstractAccount {
    * @returns A promise that resolves to the transaction response.
    */
   async transferToContract(
-    contractId: string | AbstractAddress,
+    contractId: string | Address,
     amount: BigNumberish,
     assetId: BytesLike,
     txParams: TxParamsType = {}
@@ -499,7 +500,7 @@ export class Account extends AbstractAccount {
    * @returns A promise that resolves to the transaction response.
    */
   async withdrawToBaseLayer(
-    recipient: string | AbstractAddress,
+    recipient: string | Address,
     amount: BigNumberish,
     txParams: TxParamsType = {}
   ): Promise<TransactionResponse> {

diff --git a/packages/account/src/connectors/fuel.ts b/packages/account/src/connectors/fuel.ts
@@ -1,5 +1,5 @@
+import type { Address } from '@fuel-ts/address';
 import { ErrorCode, FuelError } from '@fuel-ts/errors';
-import type { AbstractAddress } from '@fuel-ts/interfaces';
 
 import { Account } from '../account';
 import { Provider } from '../providers';
@@ -62,10 +62,7 @@ interface FuelSdk {
   hasWallet(): Promise<boolean>;
   // #endregion connector-manager-method-hasWallet
   // #region connector-manager-method-getWallet
-  getWallet(
-    address: string | AbstractAddress,
-    providerOrNetwork?: Provider | Network
-  ): Promise<Account>;
+  getWallet(address: string | Address, providerOrNetwork?: Provider | Network): Promise<Account>;
   // #endregion connector-manager-method-getWallet
   // #region connector-manager-method-unsubscribe
   unsubscribe(): void;
@@ -465,7 +462,7 @@ export class Fuel extends FuelConnector implements FuelSdk {
    * connectors.
    */
   async getWallet(
-    address: string | AbstractAddress,
+    address: string | Address,
     providerOrNetwork?: Provider | Network
   ): Promise<Account> {
     const provider = await this._getProvider(providerOrNetwork);

diff --git a/packages/account/src/hdwallet/hdwallet.ts b/packages/account/src/hdwallet/hdwallet.ts
@@ -1,8 +1,8 @@
 import { computeHmac, ripemd160 } from '@fuel-ts/crypto';
 import { ErrorCode, FuelError } from '@fuel-ts/errors';
 import { sha256 } from '@fuel-ts/hasher';
-import type { BytesLike } from '@fuel-ts/interfaces';
 import { bn, toBytes, toHex } from '@fuel-ts/math';
+import type { BytesLike } from '@fuel-ts/utils';
 import { arrayify, hexlify, concat, dataSlice, encodeBase58, decodeBase58 } from '@fuel-ts/utils';
 
 import { Mnemonic } from '../mnemonic';

diff --git a/packages/account/src/index.ts b/packages/account/src/index.ts
@@ -1,4 +1,5 @@
 export * from './account';
+export * from './types';
 export * from './wallet';
 export * from './hdwallet';
 export * from './mnemonic';

diff --git a/packages/account/src/mnemonic/mnemonic.ts b/packages/account/src/mnemonic/mnemonic.ts
@@ -1,7 +1,7 @@
 import { randomBytes, pbkdf2, computeHmac } from '@fuel-ts/crypto';
 import { ErrorCode, FuelError } from '@fuel-ts/errors';
 import { sha256 } from '@fuel-ts/hasher';
-import type { BytesLike } from '@fuel-ts/interfaces';
+import type { BytesLike } from '@fuel-ts/utils';
 import { arrayify, hexlify, concat, dataSlice, encodeBase58, toUtf8Bytes } from '@fuel-ts/utils';
 
 import { english } from '../wordlists';

diff --git a/packages/account/src/mnemonic/utils.ts b/packages/account/src/mnemonic/utils.ts
@@ -1,6 +1,6 @@
 import { ErrorCode, FuelError } from '@fuel-ts/errors';
 import { sha256 } from '@fuel-ts/hasher';
-import type { BytesLike } from '@fuel-ts/interfaces';
+import type { BytesLike } from '@fuel-ts/utils';
 import { arrayify } from '@fuel-ts/utils';
 
 /* Mnemonic phrase composed by words from the provided wordlist it can be a text or a array of words */

diff --git a/packages/account/src/predicate/predicate.ts b/packages/account/src/predicate/predicate.ts
@@ -2,7 +2,7 @@ import type { JsonAbi, InputValue } from '@fuel-ts/abi-coder';
 import { Interface } from '@fuel-ts/abi-coder';
 import { Address } from '@fuel-ts/address';
 import { ErrorCode, FuelError } from '@fuel-ts/errors';
-import type { BytesLike } from '@fuel-ts/interfaces';
+import type { BytesLike } from '@fuel-ts/utils';
 import { arrayify, hexlify } from '@fuel-ts/utils';
 
 import type { FakeResources } from '../account';

diff --git a/packages/account/src/predicate/utils/getPredicateRoot.ts b/packages/account/src/predicate/utils/getPredicateRoot.ts
@@ -1,7 +1,7 @@
 import { hash } from '@fuel-ts/hasher';
-import type { BytesLike } from '@fuel-ts/interfaces';
 import { calcRoot } from '@fuel-ts/merkle';
 import { chunkAndPadBytes, hexlify, concat, arrayify } from '@fuel-ts/utils';
+import type { BytesLike } from '@fuel-ts/utils';
 
 /**
  * @hidden
-Original file line number
+Diff line change
@@ Expand Up / @@ -2,7 +2,6 @@ ABI @@
     ABI's
     abigen
     ABIs
-    AbstractAddress
     ALU
     ANDs
     API's
@@ Expand Down @@