FuelLabs · maschad · Sep 24, 2024 · Sep 24, 2024 · Sep 24, 2024 · Sep 25, 2024
diff --git a/.changeset/late-pugs-carry.md b/.changeset/late-pugs-carry.md
@@ -0,0 +1,7 @@
+---
+"@fuel-ts/interfaces": patch
+"@fuel-ts/address": patch
+"@fuel-ts/errors": patch
+---
+
+chore: deprecate bech32 addresses
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -167,6 +167,9 @@ The e2e test can be found at:
 
 The Bech32 address of this wallet is `fuel1x33ajpj0jy5p2wcqqu45e32r75zrwfeh6hwqfv5un670rv4p0mns58enjg`. This address can be funded via the [faucet](https://faucet-testnet.fuel.network/).
 
+> [!NOTE] Note
+> The `bech32Address` is now deprecated. Hexadecimal will be the only address format from this point onward.
+
 If you want to run an e2e test locally, you can provide your own wallet address and private key. For obvious security reasons, the private key should not be shared.
 
 These can be overridden by generating an environment file:

diff --git a/apps/docs/src/guide/contracts/managing-deployed-contracts.md b/apps/docs/src/guide/contracts/managing-deployed-contracts.md
@@ -8,6 +8,9 @@ The `contractId` property from the [`Contract`](../../api/Program/Contract.md) c
 
 The [`Address`](../../api/Address/Address.md) class wraps all methods from the [`AbstractAddress`](../../api/Interfaces/AbstractAddress.md) class and adds a single property: `bech32Address`. This property is a string encoded in [`Bech32`](../types/bech32.md) format, recognizable by the human-readable prefix `fuel` followed by the separator `1`.
 
+> [!NOTE] Note
+> The `bech32Address` is now deprecated. Hexadecimal will be the only address format from this point onward.
+
 When you log the `contractId` property of an instantiated Contract using `console.log`, the output appears as follows:
 
 ```console

diff --git a/apps/docs/src/guide/types/address.md b/apps/docs/src/guide/types/address.md
@@ -24,6 +24,9 @@ To create an [`Address`](../../api/Address/Address.md) from a `Bech32` address,
 
 <<< @/../../docs-snippets/src/guide/types/address.test.ts#address-2{ts:line-numbers}
 
+> [!NOTE] Note
+> The `bech32Address` is now deprecated. Hexadecimal will be the only address format from this point onward.
+
 ### From a Public Key
 
 To create an [`Address`](../../api/Address/Address.md) from a public key, use the following code snippet:

diff --git a/apps/docs/src/guide/types/bech32.md b/apps/docs/src/guide/types/bech32.md
@@ -1,5 +1,8 @@
 # `Bech32`
 
+> [!NOTE] Note
+> The `bech32Address` is now deprecated. Hexadecimal will be the only address format from this point onward.
+
 The SDK uses the `Bech32` type as the core property of the [`Address`](../../api/Address/Address.md) class, specifically through the `bech32Address` property.
 
 Originally designed for Bitcoin, the `Bech32` format offers numerous advantages such as enhanced error detection, simplified integrations, and improved compatibility with future upgrades. Given these benefits, the [`Address`](../../api/Address/Address.md) class is constructed around the `Bech32` type.

diff --git a/apps/docs/src/guide/utilities/address-conversion.md b/apps/docs/src/guide/utilities/address-conversion.md
@@ -6,6 +6,9 @@ The Fuel Network uses the [`Bech32`](../types/bech32.md) address format for its
 
 <<< @/../../docs-snippets/src/guide/types/bech32.test.ts#addresses-1{ts:line-numbers}
 
+> [!NOTE] Note
+> The `bech32Address` is now deprecated. Hexadecimal will be the only address format from this point onward.
+
 However, a hexlified [Bits256](../types/bits256.md) (hex) is another common address format; an example can be seen below:
 
 <<< @/../../docs-snippets/src/guide/types/bits256.test.ts#addresses-2{ts:line-numbers}

diff --git a/packages/address/README.md b/packages/address/README.md
@@ -4,6 +4,9 @@
 
 This module contains the utilities for encoding and decoding address and contract ids between Bech32 and other address formats.
 
+> [!NOTE] Note
+> The `bech32Address` is now deprecated. Hexadecimal will be the only address format from this point onward.
+
 # Table of contents
 
 - [Documentation](#documentation)

diff --git a/packages/address/src/address.ts b/packages/address/src/address.ts
@@ -24,6 +24,10 @@ import {
  */
 export default class Address extends AbstractAddress {
   // #region address-2
+  /**
+   * @deprecated
+   * The `bech32Address` is now deprecated. Hexadecimal will be the only address format from this point onward.
+   */
   readonly bech32Address: Bech32Address;
   // #endregion address-2
 
@@ -44,7 +48,8 @@ export default class Address extends AbstractAddress {
 
   /**
    * Returns the `bech32Address` property
-   *
+   * @deprecated
+   * The `bech32Address` is now deprecated. Hexadecimal will be the only address format from this point onward.
    * @returns The `bech32Address` property
    */
   toAddress(): Bech32Address {
@@ -53,7 +58,8 @@ export default class Address extends AbstractAddress {
 
   /**
    * Converts and returns the `bech32Address` property to a 256 bit hash string
-   *
+   * @deprecated
+   * The `bech32Address` is now deprecated. Hexadecimal will be the only address format from this point onward.
    * @returns The `bech32Address` property as a 256 bit hash string
    */
   toB256(): B256Address {
@@ -62,7 +68,8 @@ export default class Address extends AbstractAddress {
 
   /**
    * Converts and returns the `bech32Address` property to a byte array
-   *
+   * @deprecated
+   * The `bech32Address` is now deprecated. Hexadecimal will be the only address format from this point onward.
    * @returns The `bech32Address` property as a byte array
    */
   toBytes(): Uint8Array {
@@ -71,7 +78,8 @@ export default class Address extends AbstractAddress {
 
   /**
    * Converts
-   *
+   * @deprecated
+   * The `bech32Address` is now deprecated. Hexadecimal will be the only address format from this point onward.
    * @returns The `bech32Address` property as a 256 bit hash string
    */
   toHexString(): B256Address {
@@ -89,7 +97,8 @@ export default class Address extends AbstractAddress {
 
   /**
    * Converts and returns the `bech32Address` property as a string
-   *
+   * @deprecated
+   * The `bech32Address` is now deprecated. Hexadecimal will be the only address format from this point onward.
    * @returns The `bech32Address` property as a string
    */
   toJSON(): string {
@@ -98,7 +107,8 @@ export default class Address extends AbstractAddress {
 
   /**
    * Clears the first 12 bytes of the `bech32Address` property and returns it as a `EvmAddress`
-   *
+   * @deprecated
+   * The `bech32Address` is now deprecated. Hexadecimal will be the only address format from this point onward.
    * @returns The `bech32Address` property as an {@link EvmAddress | `EvmAddress`}
    */
   toEvmAddress(): EvmAddress {
@@ -111,7 +121,8 @@ export default class Address extends AbstractAddress {
 
   /**
    * Wraps the `bech32Address` property and returns as an `AssetId`.
-   *
+   * @deprecated
+   * The `bech32Address` is now deprecated. Hexadecimal will be the only address format from this point onward.
    * @returns The `bech32Address` property as an {@link AssetId | `AssetId`}
    */
   toAssetId(): AssetId {
@@ -122,7 +133,8 @@ export default class Address extends AbstractAddress {
 
   /**
    * Returns the value of the `bech32Address` property
-   *
+   *@deprecated
+   * The `bech32Address` is now deprecated. Hexadecimal will be the only address format from this point onward.
    * @returns The value of `bech32Address` property
    */
   valueOf(): string {
@@ -131,7 +143,8 @@ export default class Address extends AbstractAddress {
 
   /**
    * Compares this the `bech32Address` property to another for direct equality
-   *
+   * @deprecated
+   * The `bech32Address` is now deprecated. Hexadecimal will be the only address format from this point onward.
    * @param other - Another address to compare against
    * @returns The equality of the comparison
    */

diff --git a/packages/address/src/utils.ts b/packages/address/src/utils.ts
@@ -23,7 +23,8 @@ export const FUEL_BECH32_HRP_PREFIX = 'fuel';
 
 /**
  * Decodes a Bech32 address string into Decoded
- *
+ * @deprecated
+ * The `bech32Address` is now deprecated. Hexadecimal will be the only address format from this point onward.
  * @hidden
  */
 export function fromBech32(address: Bech32Address): Decoded {
@@ -32,7 +33,8 @@ export function fromBech32(address: Bech32Address): Decoded {
 
 /**
  * Converts a B256 address string into Bech32
- *
+ * @deprecated
+ * The `bech32Address` is now deprecated. Hexadecimal will be the only address format from this point onward.
  * @hidden
  */
 export function toBech32(address: B256Address): Bech32Address {
@@ -44,7 +46,8 @@ export function toBech32(address: B256Address): Bech32Address {
 
 /**
  * Determines if a given string is Bech32 format
- *
+ * @deprecated
+ * The `bech32Address` is now deprecated. Hexadecimal will be the only address format from this point onward.
  * @hidden
  */
 export function isBech32(address: BytesLike): boolean {

diff --git a/packages/errors/src/error-codes.ts b/packages/errors/src/error-codes.ts
@@ -25,7 +25,12 @@ export enum ErrorCode {
   WORKSPACE_NOT_DETECTED = 'workspace-not-detected',
 
   // address
+  /**
+   * @deprecated
+   * The `bech32Address` is now deprecated. Hexadecimal will be the only address format from this point onward.
+   */
   INVALID_BECH32_ADDRESS = 'invalid-bech32-address',
+
   INVALID_EVM_ADDRESS = 'invalid-evm-address',
   INVALID_B256_ADDRESS = 'invalid-b256-address',
 

diff --git a/packages/interfaces/src/index.ts b/packages/interfaces/src/index.ts
@@ -8,6 +8,10 @@
  */
 
 // #region bech32-1
+/**
+ * @deprecated
+ * The `bech32Address` is now deprecated. Hexadecimal will be the only address format from this point onward.
+ */
 export type Bech32Address = `fuel${string}`;
 // #endregion bech32-1
 export type B256Address = string;