feat: adding new versions package (#616)

Author: arboleya

.changeset/tame-bugs-act.md

@@ -0,0 +1,12 @@
+---
+"@fuel-ts/abi-coder": minor
+"@fuel-ts/address": minor
+"@fuel-ts/contract": minor
+"forc-bin": minor
+"fuels": minor
+"@fuel-ts/predicate": minor
+"@fuel-ts/providers": minor
+"@fuel-ts/versions": minor
+---
+
+Adding new `versions` package for exposing and managing compatibility versions of Fuel toolchain components

.npmrc

@@ -0,0 +1,2 @@
+auto-install-peers=true
+enable-pre-post-scripts=true

README.md

@@ -21,6 +21,7 @@
   - [Dependencies](#dependencies)
   - [Using Generated Types](https://fuellabs.github.io/fuels-ts/guide/types/using-generated-types)
 - [Deploying Contracts](https://fuellabs.github.io/fuels-ts/guide/contracts/deploying-contracts)
+- [CLI](/#CLI)
 - [Contributing](./docs/CONTRIBUTING.md)
 - [License](#license)
 
@@ -72,6 +73,24 @@ console.log(Wallet.generate());
 console.log(new Wallet("0x0000...0000"));
 ```
 
+## CLI
+
+Fuels include some utility commnands via built-in CLI tool.
+
+```console
+$ yarn add fuels
+$ yarn exec fuels -h
+Usage: fuels [options] [command]
+
+Options:
+  -V, --version   output the version number
+  -h, --help      display help for command
+
+Commands:
+  versions        checks for version incompatibilities
+  help [command]  display help for command
+```
+
 ## License
 
 The primary license for this repo is `Apache 2.0`, see [`LICENSE`](./LICENSE).

package.json

@@ -1,9 +1,8 @@
 {
   "name": "fuels-ts",
-  "version": "0.7.0",
+  "version": "0.0.0",
   "description": "Fuel TS SDK",
   "author": "Fuel Labs <[email protected]> (https://fuel.network/)",
-  "main": "index.js",
   "private": true,
   "engines": {
     "node": ">=14.19.0",

packages/abi-coder/package.json

@@ -32,9 +32,10 @@
     "@ethersproject/sha2": "^5.7.0",
     "@ethersproject/strings": "^5.7.0",
     "@fuel-ts/math": "workspace:*",
+    "@fuel-ts/versions": "workspace:*",
     "type-fest": "^3.1.0"
   },
   "scripts": {
-    "build": "tsup --dts --env.BUILD_VERSION $BUILD_VERSION"
+    "build": "tsup --dts"
   }
 }

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

@@ -2,6 +2,7 @@
 import type { BytesLike } from '@ethersproject/bytes';
 import { concat, arrayify } from '@ethersproject/bytes';
 import { Logger } from '@ethersproject/logger';
+import { versions } from '@fuel-ts/versions';
 
 import type { DecodedValue, InputValue } from './coders/abstract-coder';
 import type Coder from './coders/abstract-coder';
@@ -30,7 +31,7 @@ import {
 import type { JsonAbiFragmentType } from './json-abi';
 import { filterEmptyParams, getVectorAdjustments, hasOptionTypes } from './utilities';
 
-const logger = new Logger(process.env.BUILD_VERSION || '~');
+const logger = new Logger(versions.FUELS);
 
 export default class AbiCoder {
   constructor() {

packages/abi-coder/src/coders/abstract-coder.ts

@@ -1,8 +1,9 @@
 import type { BytesLike } from '@ethersproject/bytes';
 import { Logger } from '@ethersproject/logger';
 import type { BN } from '@fuel-ts/math';
+import { versions } from '@fuel-ts/versions';
 
-const logger = new Logger(process.env.BUILD_VERSION || '~');
+const logger = new Logger(versions.FUELS);
 
 type Primitive = string | number | boolean;
 

packages/abi-coder/src/interface.ts

@@ -4,6 +4,7 @@ import { arrayify, concat, hexlify } from '@ethersproject/bytes';
 import { Logger } from '@ethersproject/logger';
 import { sha256 } from '@ethersproject/sha2';
 import { toUtf8Bytes } from '@ethersproject/strings';
+import { versions } from '@fuel-ts/versions';
 
 import AbiCoder from './abi-coder';
 import type { InputValue } from './coders/abstract-coder';
@@ -20,7 +21,7 @@ import type {
 import { isFlatJsonAbi, ABI, isReferenceType } from './json-abi';
 import { filterEmptyParams } from './utilities';
 
-const logger = new Logger(process.env.BUILD_VERSION || '~');
+const logger = new Logger(versions.FUELS);
 
 const coerceFragments = (value: ReadonlyArray<JsonAbiFragment>): Array<Fragment> => {
   const fragments: Array<Fragment> = [];

packages/address/package.json

@@ -27,6 +27,7 @@
     "@fuel-ts/constants": "workspace:*",
     "@fuel-ts/interfaces": "workspace:*",
     "@fuel-ts/keystore": "workspace:*",
+    "@fuel-ts/versions": "workspace:*",
     "@ethersproject/bytes": "^5.7.0",
     "@ethersproject/logger": "^5.7.0",
     "@ethersproject/sha2": "^5.7.0",

packages/address/src/address.ts

@@ -2,6 +2,7 @@ import { Logger } from '@ethersproject/logger';
 import { sha256 } from '@ethersproject/sha2';
 import { AbstractAddress } from '@fuel-ts/interfaces';
 import type { Bech32Address, B256Address } from '@fuel-ts/interfaces';
+import { versions } from '@fuel-ts/versions';
 
 import {
   normalizeBech32,
@@ -12,7 +13,7 @@ import {
   getRandomB256,
 } from './utils';
 
-const logger = new Logger(process.env.BUILD_VERSION || '~');
+const logger = new Logger(versions.FUELS);
 
 export default class Address extends AbstractAddress {
   readonly bech32Address: Bech32Address;