fix: removed circular dependencies from the core package (#1349)

* fix: circular dependency 1 * fix: circular dependency 1 * fix: more dependencies fixed * fix: more dependencies fixed * fix: more dependencies fixed * fix: more fixes * fix: more fixes * fix: more fixes * fix: more fixes * fix: more fixes * fix: more fixes * fix: more fixes * fix: more fixes * fix: more fixes * fix: added exclusion temporarily * fix: added exclusion temporarily
vechain · Sep 26, 2024 · b09bbfb · b09bbfb · github-actions · Sep 26, 2024
1 parent 8f60e9e
commit b09bbfb
Show file tree

Hide file tree

Showing 27 changed files with 117 additions and 120 deletions.
diff --git a/.github/workflows/build-lint.yml b/.github/workflows/build-lint.yml
@@ -21,6 +21,9 @@ jobs:
 
             - name: Lint
               run: yarn lint
+
+            - name: Circular dependencies check
+              run: yarn check:circular-dependencies
 
             - name: Build
               run: yarn build
diff --git a/.husky/pre-commit b/.husky/pre-commit
@@ -1,4 +1,5 @@
 yarn build
 yarn lint
+yarn check:circular-dependencies
 yarn test:unit && git add docs
-yarn check-tests-naming
+yarn check:tests-naming
diff --git a/package.json b/package.json
@@ -24,6 +24,7 @@
         "stop-thor-solo": "echo 'Stopping thor solo node ...' && docker compose down && echo 'Thor solo node stopped ...'",
         "postinstall": "husky",
         "build": "turbo build",
+        "check:circular-dependencies": "turbo check:circular-dependencies",
         "pre-release": "ts-node scripts/pre-release.ts",
         "test-rpc-proxy": "ts-node scripts/test-rpc-proxy.ts",
         "generate:apidocs": "typedoc --options typedoc.json --logLevel Error",
@@ -40,7 +41,7 @@
         "test:solo": "(yarn start-thor-solo && yarn test && yarn stop-thor-solo) || yarn stop-thor-solo",
         "test:browser:solo": "(yarn start-thor-solo && yarn test:browser && yarn stop-thor-solo) || yarn stop-thor-solo",
         "merge-coverage": "ts-node scripts/merge-coverage.ts",
-        "check-tests-naming": "ts-node scripts/check-tests-naming.ts"
+        "check:tests-naming": "ts-node scripts/check-tests-naming.ts"
     },
     "devDependencies": {
         "@changesets/cli": "^2.27.7",

diff --git a/packages/core/package.json b/packages/core/package.json
@@ -28,6 +28,7 @@
   ],
   "scripts": {
     "build": "rm -rf ./dist && tsup-node src/index.ts --format cjs,esm --dts",
+    "check:circular-dependencies": "npx madge --exclude 'transaction/Clause.ts' --circular --extensions ts src",
     "lint": "eslint --ext .ts src --ext .ts tests",
     "format": "prettier --write src/**/*.ts tests/**/*.ts",
     "test:unit": "rm -rf ./coverageUnit && jest --coverage --coverageDirectory=coverageUnit --group=unit",

diff --git a/packages/core/src/encoding/rlp/helpers/compactfixedhexblobkind.ts b/packages/core/src/encoding/rlp/helpers/compactfixedhexblobkind.ts
@@ -1,4 +1,4 @@
-import { Hex } from '../../../vcdm';
+import { Hex } from '../../../vcdm/Hex';
 import { InvalidRLP } from '@vechain/sdk-errors';
 
 /**

diff --git a/packages/core/src/encoding/rlp/helpers/numerickind.ts b/packages/core/src/encoding/rlp/helpers/numerickind.ts
@@ -1,5 +1,7 @@
 import { InvalidRLP } from '@vechain/sdk-errors';
-import { FixedPointNumber, Hex, HexUInt } from '../../../vcdm';
+import { FixedPointNumber } from '../../../vcdm/FixedPointNumber';
+import { Hex } from '../../../vcdm/Hex';
+import { HexUInt } from '../../../vcdm/HexUInt';
 import { type RLPInput } from '../types';
 
 /**
@@ -204,8 +206,8 @@ const decodeBufferToNumberOrHex = (buffer: Buffer): number | string => {
 };
 
 export {
-    validateNumericKindData,
     assertValidNumericKindBuffer,
+    decodeBufferToNumberOrHex,
     encodeBigIntToBuffer,
-    decodeBufferToNumberOrHex
+    validateNumericKindData
 };
diff --git a/packages/core/src/encoding/rlp/index.ts b/packages/core/src/encoding/rlp/index.ts
@@ -1,7 +1,6 @@
 import { RLPBase } from './rlp';
-import { RLPProfiles } from './kind';
+import * as RLPProfiles from './kind';
 
-export * from './rlp';
 export * from './kind';
 export type * from './types.d';
 export * from './helpers';

diff --git a/packages/core/src/encoding/rlp/kind/hexblobkinds/hexblob.ts b/packages/core/src/encoding/rlp/kind/hexblobkinds/hexblob.ts
@@ -1,4 +1,4 @@
-import { Hex } from '../../../../vcdm';
+import { Hex } from '../../../../vcdm/Hex';
 import { ScalarKind } from '../scalarkind.abstract';
 import {
     assertValidHexBlobKindBuffer,

diff --git a/packages/core/src/encoding/rlp/kind/index.ts b/packages/core/src/encoding/rlp/kind/index.ts
@@ -1,25 +1,14 @@
 import { BufferKind } from './bufferkind';
 import { NumericKind } from './numerickind';
-import { ScalarKind } from './scalarkind.abstract';
+import { ScalarKind, type RLPProfile } from './scalarkind.abstract';
 import {
     CompactFixedHexBlobKind,
     FixedHexBlobKind,
     HexBlobKind,
     OptionalFixedHexBlobKind
 } from './hexblobkinds';
 
-/**
- * RLP_CODER profile classes.
- */
-export const RLPProfiles: {
-    ScalarKind: typeof ScalarKind;
-    BufferKind: typeof BufferKind;
-    NumericKind: typeof NumericKind;
-    HexBlobKind: typeof HexBlobKind;
-    FixedHexBlobKind: typeof FixedHexBlobKind;
-    OptionalFixedHexBlobKind: typeof OptionalFixedHexBlobKind;
-    CompactFixedHexBlobKind: typeof CompactFixedHexBlobKind;
-} = {
+export {
     ScalarKind,
     BufferKind,
     NumericKind,
@@ -29,4 +18,4 @@ export const RLPProfiles: {
     CompactFixedHexBlobKind
 };
 
-export type { ScalarKind };
+export type { RLPProfile };
diff --git a/packages/core/src/encoding/rlp/kind/scalarkind.abstract.ts b/packages/core/src/encoding/rlp/kind/scalarkind.abstract.ts
@@ -1,10 +1,31 @@
 import {
-    type RLPInput,
     type BufferOutput,
-    type RLPValidObject,
-    type DataOutput
+    type DataOutput,
+    type RLPInput,
+    type RLPValidObject
 } from '../types';
 
+/* ------- RLP Profile Types ------- */
+/**
+ * `RLPProfile` Interface - Describes the profile of the RLP encoding.
+ */
+interface RLPProfile {
+    name: string;
+    kind: ScalarKind | ArrayKind | StructKind;
+}
+
+/**
+ * `ArrayKind` Interface - Describes an array-kind in the RLP encoding profile.
+ */
+interface ArrayKind {
+    item: RLPProfile['kind'];
+}
+
+/**
+ * `StructKind` Type - Describes a structured-kind in the RLP encoding profile using an array of `RLPProfile`.
+ */
+type StructKind = RLPProfile[];
+
 /**
  * `ScalarKind` Abstract Class - A base for scalar kinds providing contract for data and buffer manipulations.
  */
@@ -29,4 +50,4 @@ abstract class ScalarKind {
     public abstract buffer(buffer: Buffer, context: string): BufferOutput;
 }
 
-export { ScalarKind };
+export { ScalarKind, type RLPProfile };
diff --git a/packages/core/src/encoding/rlp/rlp.ts b/packages/core/src/encoding/rlp/rlp.ts
@@ -1,13 +1,12 @@
 import { RLP } from '@ethereumjs/rlp';
+import { InvalidRLP } from '@vechain/sdk-errors';
+import { ScalarKind, type RLPProfile } from './kind/scalarkind.abstract';
 import {
     type RLPInput,
     type RLPOutput,
-    type RLPProfile,
     type RLPValidObject,
     type RLPValueType
 } from './types';
-import { RLPProfiles } from '.';
-import { InvalidRLP } from '@vechain/sdk-errors';
 
 /**
  * Encodes data using the Ethereumjs RLP library.
@@ -81,7 +80,7 @@ const _packData = (
     const kind = profile.kind;
 
     // ScalarKind: direct encoding using the provided method.
-    if (kind instanceof RLPProfiles.ScalarKind) {
+    if (kind instanceof ScalarKind) {
         return kind.data(obj, context).encode();
     }
 
@@ -142,7 +141,7 @@ const _unpackData = (
     const kind = profile.kind;
 
     // ScalarKind: Direct decoding using the provided method.
-    if (kind instanceof RLPProfiles.ScalarKind) {
+    if (kind instanceof ScalarKind) {
         if (!Buffer.isBuffer(packed) && !(packed instanceof Uint8Array)) {
             throw new InvalidRLP(
                 '_unpackData()',

diff --git a/packages/core/src/encoding/rlp/types.d.ts b/packages/core/src/encoding/rlp/types.d.ts
@@ -1,5 +1,4 @@
 import { type Input, type NestedUint8Array } from '@ethereumjs/rlp';
-import { type ScalarKind } from './kind';
 /**
  * Represents a valid input for the RLP (Recursive Length Prefix) encoding.
  * The RLP encoding is used to encode arbitrary binary data (nested arrays of bytes).
@@ -51,27 +50,6 @@ type RLPValidObject = Record<string, RLPValueType>;
  */
 type RLPValueType = RLPInput | RLPComplexObject | RLPComplexObject[];
 
-/* ------- RLP Profile Types ------- */
-/**
- * `RLPProfile` Interface - Describes the profile of the RLP encoding.
- */
-interface RLPProfile {
-    name: string;
-    kind: ScalarKind | ArrayKind | StructKind;
-}
-
-/**
- * `ArrayKind` Interface - Describes an array-kind in the RLP encoding profile.
- */
-interface ArrayKind {
-    item: RLPProfile['kind'];
-}
-
-/**
- * `StructKind` Type - Describes a structured-kind in the RLP encoding profile using an array of `RLPProfile`.
- */
-type StructKind = RLPProfile[];
-
 /**
  * `DataOutput` Interface - Provides an encoding mechanism to convert data into a Buffer.
  */
@@ -87,13 +65,10 @@ interface BufferOutput {
 }
 
 export type {
+    BufferOutput,
+    DataOutput,
     RLPInput,
     RLPOutput,
     RLPValidObject,
-    RLPValueType,
-    RLPProfile,
-    ArrayKind,
-    StructKind,
-    DataOutput,
-    BufferOutput
+    RLPValueType
 };
diff --git a/packages/core/src/hdkey/HDKey.ts b/packages/core/src/hdkey/HDKey.ts
@@ -2,9 +2,10 @@ import * as s_bip32 from '@scure/bip32';
 import * as s_bip39 from '@scure/bip39';
 import * as nc_utils from '@noble/curves/abstract/utils';
 import { base58 } from '@scure/base';
-import { FixedPointNumber, Sha256 } from '../vcdm';
+import { FixedPointNumber } from '../vcdm/FixedPointNumber';
+import { Sha256 } from '../vcdm/hash/Sha256';
 import { HexUInt } from '../vcdm/HexUInt';
-import { Secp256k1 } from '../secp256k1';
+import { Secp256k1 } from '../secp256k1/Secp256k1';
 import {
     InvalidHDKey,
     InvalidHDKeyMnemonic,

diff --git a/packages/core/src/secp256k1/Secp256k1.ts b/packages/core/src/secp256k1/Secp256k1.ts
@@ -1,5 +1,5 @@
 import * as nc_utils from '@noble/curves/abstract/utils';
-import { HexUInt } from '../vcdm';
+import { HexUInt } from '../vcdm/HexUInt';
 import { randomBytes as nh_randomBytes } from '@noble/hashes/utils';
 import { secp256k1 as nc_secp256k1 } from '@noble/curves/secp256k1';
 import {

diff --git a/packages/core/src/transaction/Clause.ts b/packages/core/src/transaction/Clause.ts
@@ -1,4 +1,5 @@
 import { InvalidDataType } from '@vechain/sdk-errors';
+import { ERC721_ABI, VIP180_ABI } from '../utils';
 import {
     abi,
     ABIContract,
@@ -11,9 +12,8 @@ import {
 } from '../vcdm';
 import { Hex } from '../vcdm/Hex';
 import { HexInt } from '../vcdm/HexInt';
-import { ERC721_ABI, VIP180_ABI } from '../utils';
-import { type ClauseOptions, type TransactionClause } from './index';
 import type { DeployParams } from './DeployParams';
+import { type ClauseOptions, type TransactionClause } from './types';
 
 /**
  * This class represent a transaction clause.

diff --git a/packages/core/src/transaction/handlers/sign.ts b/packages/core/src/transaction/handlers/sign.ts
@@ -1,4 +1,4 @@
-import { Address } from '../../vcdm';
+import { Address } from '../../vcdm/Address';
 import { Secp256k1 } from '../../secp256k1';
 import { Transaction } from '../transaction';
 import {

diff --git a/packages/core/src/transaction/transaction.ts b/packages/core/src/transaction/transaction.ts
@@ -1,11 +1,10 @@
-import { Address, Hex } from '../vcdm';
-import { Blake2b256 } from '../vcdm/hash/Blake2b256';
 import {
     InvalidSecp256k1Signature,
     InvalidTransactionField,
     NotDelegatedTransaction,
     UnavailableTransactionField
 } from '@vechain/sdk-errors';
+import { type RLPValidObject } from '../encoding';
 import { Secp256k1 } from '../secp256k1';
 import {
     BLOCK_REF_LENGTH,
@@ -15,7 +14,9 @@ import {
     TransactionUtils,
     UNSIGNED_TRANSACTION_RLP
 } from '../utils';
-import { type RLPValidObject } from '../encoding';
+import { Address } from '../vcdm/Address';
+import { Hex } from '../vcdm/Hex';
+import { Blake2b256 } from '../vcdm/hash/Blake2b256';
 import { type TransactionBody } from './types';
 
 /**

diff --git a/packages/core/src/utils/data/data.ts b/packages/core/src/utils/data/data.ts
@@ -1,6 +1,7 @@
 import * as nc_utils from '@noble/curves/abstract/utils';
-import { Hex, Txt } from '../../vcdm';
 import { InvalidDataType } from '@vechain/sdk-errors';
+import { Hex } from '../../vcdm/Hex';
+import { Txt } from '../../vcdm/Txt';
 import { ZERO_BYTES } from '../const';
 
 /**

diff --git a/packages/core/src/utils/transaction/transaction.ts b/packages/core/src/utils/transaction/transaction.ts
@@ -1,6 +1,6 @@
 import { InvalidDataType } from '@vechain/sdk-errors';
-import { type TransactionClause } from '../../transaction';
-import { Address } from '../../vcdm';
+import { type TransactionClause } from '../../transaction/types';
+import { Address } from '../../vcdm/Address';
 import { Hex } from '../../vcdm/Hex';
 import { TRANSACTIONS_GAS_CONSTANTS } from '../const';
 

diff --git a/packages/core/src/vcdm/Address.ts b/packages/core/src/vcdm/Address.ts
@@ -1,8 +1,8 @@
 import { Keccak256 } from './hash/Keccak256';
-import { HDKey } from '../hdkey';
+import { HDKey } from '../hdkey/HDKey';
 import { Hex } from './Hex';
 import { HexUInt } from './HexUInt';
-import { Secp256k1 } from '../secp256k1';
+import { Secp256k1 } from '../secp256k1/Secp256k1';
 import { Txt } from './Txt';
 import {
     InvalidDataType,

diff --git a/packages/core/src/vcdm/account/Account.ts b/packages/core/src/vcdm/account/Account.ts
@@ -1,6 +1,6 @@
 import { InvalidOperation } from '@vechain/sdk-errors';
 import { type Address } from '../Address';
-import { type Currency } from '../currency';
+import { type Currency } from '../currency/Currency';
 import { type VeChainDataModel } from '../VeChainDataModel';
 
 type AccountType = 'EOA' | 'Contract';

diff --git a/packages/core/src/vcdm/currency/VET.ts b/packages/core/src/vcdm/currency/VET.ts
@@ -1,10 +1,9 @@
-import { Clause } from '../../transaction';
-import { Coin } from './Coin';
+import { Clause, type ClauseOptions } from '../../transaction';
+import { type Address } from '../Address';
 import { FixedPointNumber } from '../FixedPointNumber';
 import { Txt } from '../Txt';
+import { Coin } from './Coin';
 import { Units } from './Units';
-import { type Address } from '../Address';
-import { type ClauseOptions } from '../../transaction';
 
 /**
  * Represents a

diff --git a/packages/core/src/vcdm/hash/Blake2b256.ts b/packages/core/src/vcdm/hash/Blake2b256.ts
@@ -1,7 +1,8 @@
 import { blake2b as nh_blake2b } from '@noble/hashes/blake2b';
 import { InvalidOperation } from '@vechain/sdk-errors';
-import { Hex, Txt } from '../index';
+import { Hex } from '../Hex';
 import { HexUInt } from '../HexUInt';
+import { Txt } from '../Txt';
 
 /**
  * Represents the result of an [BLAKE](https://en.wikipedia.org/wiki/BLAKE_(hash_function)) [BlAKE2B 256](https://www.blake2.net/) hash operation.

diff --git a/packages/core/src/vcdm/hash/Keccak256.ts b/packages/core/src/vcdm/hash/Keccak256.ts
@@ -1,7 +1,8 @@
 import { keccak_256 as nh_keccak_256 } from '@noble/hashes/sha3';
 import { InvalidOperation } from '@vechain/sdk-errors';
-import { Hex, Txt } from '../index';
+import { Hex } from '../Hex';
 import { HexUInt } from '../HexUInt';
+import { Txt } from '../Txt';
 
 /**
  * Represents the result of an [SHA-3](https://en.wikipedia.org/wiki/SHA-3) [KECCAK 256](https://keccak.team/keccak.html) hash operation.

diff --git a/packages/core/src/vcdm/hash/Sha256.ts b/packages/core/src/vcdm/hash/Sha256.ts
@@ -1,7 +1,8 @@
 import * as nh_sha256 from '@noble/hashes/sha256';
 import { InvalidOperation } from '@vechain/sdk-errors';
-import { Hex, Txt } from '../index';
+import { Hex } from '../Hex';
 import { HexUInt } from '../HexUInt';
+import { Txt } from '../Txt';
 
 /**
  * Represents the result of an [SHA256](https://en.wikipedia.org/wiki/SHA-2) hash operation.
Title	Tests	Time
core	764	1m 52s ⏱️
network	692	4m 30s ⏱️
errors	42	17.331s ⏱️