chore: warn on fuel client version incompatibility

.changeset/soft-knives-sit.md

@@ -0,0 +1,6 @@
+---
+"@fuel-ts/account": patch
+"@fuel-ts/errors": patch
+---
+
+chore: warn on fuel client version incompatibility

apps/docs/src/guide/errors/error-codes.md

@@ -3,211 +3,247 @@
 Here is a list of the expected error codes the SDK can throw. These error codes are used to help understand the error that has been thrown with potential resolutions.
 
 ## `ABI_MAIN_METHOD_MISSING`
+
 When your ABI does not have a main method.
 
 This can be resolved by adding a main method to your ABI.
 
 ## `ABI_TYPES_AND_VALUES_MISMATCH`
+
 When the arguments supplied to the function do not match the minimum required input length.
 
 Check that the arguments supplied to the function, match the required type.
 
 ## `ACCOUNT_REQUIRED`
+
 When an [`Account`](../../api/Account/Account.md) is required for an operation. This will usually be in the form of a [`Wallet`](../wallets/index.md).
 
 It could be caused during the deployments of contracts when an account is required to sign the transaction. This can be resolved by following the deployment guide [here](../contracts/deploying-contracts.md).
 
 ## `CONVERTING_FAILED`
+
 When converting a big number into an incompatible format.
 
 Ensure that the value you've supplied to the big number is compatible with the value you are converting to.
 
 ## `DUPLICATED_POLICY`
+
 When there are more than policies with the same type, for a transaction.
 
 Ensure that there are no duplicate (by type) policies for a transaction.
 
 ## `ERROR_BUILDING_BLOCK_EXPLORER_URL`
+
 When more than one of the following options is passed: `path`, `address`, `txId`, `blockNumber`.
 
 Check that only one of the following options is passed: `path`, `address`, `txId`, `blockNumber`.
 
 ## `FUNCTION_NOT_FOUND`
+
 When the function with the given name, signature or selector is not found in the ABI.
 
 Check that the function name, signature or selector is correct and exits on the ABI.
 
 ## `GAS_LIMIT_TOO_LOW`
+
 When the gas limit is lower than the minimum gas limit.
 
 Increase the gas limit to be greater than the minimum gas limit.
 
 ## `GAS_PRICE_TOO_LOW`
+
 When the gas price is lower than the minimum gas price.
 
 Increase the gas price to be greater than the minimum gas price.
 
 ## `HD_WALLET_ERROR`
+
 A hardware wallet will throw for unsupported configurations.
 
 The error message will determine which element of the configuration is incorrect. It could be due to the public or private key or when configuring to/from an extended key.
 
 ## `INVALID_CHECKSUM`
+
 Checksum validation failed for the provided mnemonic.
 
 Ensure that the mnemonic is correct.
 
 ## `INVALID_CONFIGURABLE_CONSTANTS`
+
 When the program type either: does _not_ have configurable constants to be set; or the provided configurable constant does not belong to the program type, as defined by its ABI.
 
 Ensure the configurable constants provided are correct and are defined in ABI.
 
 ## `INVALID_COMPONENT`
+
 When an expected component is not found in the ABI or is malformed.
 
 Ensure that you have correctly formed Sway types for [Arrays](../types/arrays.md) and [Vectors](../types/vectors.md).
 
 ## `INVALID_CREDENTIALS`
+
 When the password provided is incorrect.
 
 Ensure that the password is correct.
 
 ## `INVALID_DATA`
+
 When the value is more than the max value.
 
 Ensure that the value is less than the max value.
 
 ## `INVALID_ENTROPY`
+
 When the entropy is not: between 16 and 32 bytes; a multiple of 4.
 
 Ensure that the entropy is between 16 and 32 bytes and a multiple of 4.
 
 ## `INVALID_EVM_ADDRESS`
+
 When the provided EVM address is invalid.
 
 Ensure that the [EVM address](../types/evm-address.md) is valid.
 
 ## `INVALID_INPUT_PARAMETERS`
+
 When the provided input parameters are _not_ valid.
 
 The error message will determine which parameter is missing. It could be that the provided program type is not one of the following `contract`, `script`, or `predicate`.
 
 ## `INVALID_MNEMONIC`
+
 When the supplied mnemonic is invalid.
 
-Check the message for more details. It could be that the mnemonic phrase word length is _not__ one of the following: 12, 15, 18, 21, or 24 lengths.
+Check the message for more details. It could be that the mnemonic phrase word length is \_not\_\_ one of the following: 12, 15, 18, 21, or 24 lengths.
 
 ## `INVALID_MULTICALL`
+
 When the multi-call has a call that returns a heap type that is not the last call, or the multi-call has more than one call that returns a heap type.
 
 Ensure that the multi-call has only one call that returns a heap type (which should be the last call).
 
 ## `INVALID_PASSWORD`
+
 When the provided password is incorrect.
 
 Ensure that the password is correct.
 
 ## `INVALID_POLICY_TYPE`
+
 When the supplied policy type is invalid for the given Script.
 
 Check the policy type is defined in `PolicyType`.
 
 ## `INVALID_PUBLIC_KEY`
+
 When the provided public key is invalid.
 
 Ensure that the public key is valid.
 
 ## `INVALID_RECEIPT_TYPE`
+
 When the receipt type is invalid.
 
 Check the type is within `ReceiptType`.
 
 ## `INVALID_REQUEST`
+
 When the request to the Fuel node fails, error messages are propagated from the Fuel node.
 
 Check the error message from the Fuel node.
 
 ## `INVALID_SEED`
+
 When the seed length is not between 16 and 64 bytes.
 
 Ensure that the seed length is between 16 and 64 bytes.
 
 ## `INVALID_TRANSACTION_INPUT`
+
 When the input type is invalid.
 
 Check the type is within `InputType`.
 
 ## `INVALID_TRANSACTION_OUTPUT`
+
 When the output type is invalid.
 
 Check the type is within `OutputType`.
 
 ## `INVALID_TRANSACTION_STATUS`
+
 When the transaction status received from the node is unexpected.
 
 Check the status received is within `TransactionStatus`.
 
 ## `INVALID_TRANSACTION_TYPE`
+
 When the transaction type from the Fuel Node is _not_ valid.
 
 The type is within [`TransactionType`](../../api/Account/TransactionType.md).
 
 ## `INVALID_TTL`
+
 When the TTL is less than or equal to zero.
 
 Ensure that the TTL is a number and that the TTL is greater than zero.
 
 ## `INVALID_WORD_LIST`
+
 When the word list length is not equal to 2048.
 
 The word list provided to the mnemonic length should be equal to 2048.
 
 ## `JSON_ABI_ERROR`
+
 When an ABI type does not conform to the correct format.
 
 It is usually caused by an incorrect type/s within your program, check our type [docs](../types/index.md) here for information on the types we support and their expected format.
 
 ## `LOG_TYPE_NOT_FOUND`
+
 When the log type ID supplied can not be found in the ABI.
 
 Check that the log type ID is correct and exists in the ABI.
 
 ## `MISSING_CONNECTOR`
+
 A connector is missing when it's required for a given operation.
 
 Ensure that a connector has been supplied to the `Account` or `Wallet`.
 
 ## `MISSING_PROVIDER`
+
 A provider is missing when it's required for a given operation.
 
 It could be caused by the provider not being set for either an [`Account`](../../api/Account/index.md) or a [`Wallet`](../wallets/index.md) - use the `connect` method to attach a provider.
 
 ## `MISSING_REQUIRED_PARAMETER`
+
 When a required parameter has not been supplied to a given method.
 
 The error message will determine which parameter is missing. This could be caused during type generation when neither `inputs` nor `filepaths` are supplied (at least one is required).
 
 ## `NODE_INFO_CACHE_EMPTY`
+
 When the Fuel Node info cache is empty; This is usually caused by not being connected to the Fuel Node.
 
 Ensure that the provider has connected to a Fuel Node successfully.
 
 ## `TYPE_NOT_FOUND`
+
 When the type with the given type ID is not found in the ABI.
 
 Check that the type ID is correct and exists in the ABI.
 
 ## `TYPE_NOT_SUPPORTED`
+
 When an unexpected type has been detected - the error message will determine which type is incorrect.
 
 Check the type against your ABI and ensure that it is correct. You can find a list of all our types [here](../types/index.md).
 
-## `UNSUPPORTED_FUEL_CLIENT_VERSION`
-When the version of the Fuel Node you are targeting is not supported by the client you are accessing it from.
-
-Check the version of the Fuel Node and use a compatible version of the SDK to target it.
-
 ## `WALLET_MANAGER_ERROR`
+
 A wallet manager will throw for a multitude of reasons. The error message will determine which element of the configuration is incorrect.
 
 It could be that the passphrase is incorrect and/or the wallet does _not_ exist in the manager.

packages/account/src/providers/provider.test.ts

@@ -857,7 +857,7 @@ describe('Provider', () => {
  );
  });
 
- it('throws on difference between major client version and supported major version', async () => {
+ it('warns on difference between major client version and supported major version', async () => {
  const { FUEL_CORE } = versions;
  const [major, minor, patch] = FUEL_CORE.split('.');
  const majorMismatch = major === '0' ? 1 : parseInt(patch, 10) - 1;
@@ -876,13 +876,20 @@ describe('Provider', () => {
  const spy = vi.spyOn(fuelTsVersionsMod, 'checkFuelCoreVersionCompatibility');
  spy.mockImplementationOnce(() => mock);
 
- await expectToThrowFuelError(() => Provider.create(FUEL_NETWORK_URL), {
- code: ErrorCode.UNSUPPORTED_FUEL_CLIENT_VERSION,
- message: `Fuel client version: ${FUEL_CORE}, Supported version: ${mock.supportedVersion}`,
- });
+ const consoleWarnSpy = vi.spyOn(console, 'warn');
+
+ await Provider.create(FUEL_NETWORK_URL);
+
+ expect(consoleWarnSpy).toHaveBeenCalledOnce();
+ expect(consoleWarnSpy).toHaveBeenCalledWith(
+ `The Fuel Node that you are trying to connect to is using fuel-core version ${FUEL_CORE}, 
+which is not supported by the version of the TS SDK that you are using. 
+Things may not work as expected.
+Supported fuel-core version: ${mock.supportedVersion}.`
+ );
  });
 
- it('throws on difference between minor client version and supported minor version', async () => {
+ it('warns on difference between minor client version and supported minor version', async () => {
  const { FUEL_CORE } = versions;
  const [major, minor, patch] = FUEL_CORE.split('.');
  const minorMismatch = minor === '0' ? 1 : parseInt(patch, 10) - 1;
@@ -901,10 +908,17 @@ describe('Provider', () => {
  const spy = vi.spyOn(fuelTsVersionsMod, 'checkFuelCoreVersionCompatibility');
  spy.mockImplementationOnce(() => mock);
 
- await expectToThrowFuelError(() => Provider.create(FUEL_NETWORK_URL), {
- code: ErrorCode.UNSUPPORTED_FUEL_CLIENT_VERSION,
- message: `Fuel client version: ${FUEL_CORE}, Supported version: ${mock.supportedVersion}`,
- });
+ const consoleWarnSpy = vi.spyOn(console, 'warn');
+
+ await Provider.create(FUEL_NETWORK_URL);
+
+ expect(consoleWarnSpy).toHaveBeenCalledOnce();
+ expect(consoleWarnSpy).toHaveBeenCalledWith(
+ `The Fuel Node that you are trying to connect to is using fuel-core version ${FUEL_CORE}, 
+which is not supported by the version of the TS SDK that you are using. 
+Things may not work as expected.
+Supported fuel-core version: ${mock.supportedVersion}.`
+ );
  });
 
  it('An invalid subscription request throws a FuelError and does not hold the test runner (closes all handles)', async () => {

packages/account/src/providers/provider.ts

@@ -481,9 +481,12 @@ export default class Provider {
  checkFuelCoreVersionCompatibility(nodeInfo.nodeVersion);
 
  if (!isMajorSupported || !isMinorSupported) {
- throw new FuelError(
- FuelError.CODES.UNSUPPORTED_FUEL_CLIENT_VERSION,
- `Fuel client version: ${nodeInfo.nodeVersion}, Supported version: ${supportedVersion}`
+ // eslint-disable-next-line no-console
+ console.warn(
+ `The Fuel Node that you are trying to connect to is using fuel-core version ${nodeInfo.nodeVersion}, 
+which is not supported by the version of the TS SDK that you are using. 
+Things may not work as expected.
+Supported fuel-core version: ${supportedVersion}.`
  );
  }
  }

packages/errors/src/error-codes.ts

@@ -87,7 +87,6 @@ export enum ErrorCode {
 
  // chain
  ERROR_BUILDING_BLOCK_EXPLORER_URL = 'error-building-block-explorer-url',
- UNSUPPORTED_FUEL_CLIENT_VERSION = 'unsupported-fuel-client-version',
 
  // docs
  VITEPRESS_PLUGIN_ERROR = 'vitepress-plugin-error',