Merge pull request #1406 from input-output-hk/refactor/address-circular-imports

refactor: resolve circular references in core package

Author: mkazlauskas

packages/cardano-services-client/src/TxSubmitProvider/TxSubmitApiProvider.ts

@@ -1,4 +1,11 @@
-import { Cardano, ProviderError, ProviderFailure, SubmitTxArgs, TxBodyCBOR, TxSubmitProvider } from '@cardano-sdk/core';
+import {
+  Cardano,
+  ProviderError,
+  ProviderFailure,
+  Serialization,
+  SubmitTxArgs,
+  TxSubmitProvider
+} from '@cardano-sdk/core';
 import { Logger } from 'ts-log';
 import { hexStringToBuffer } from '@cardano-sdk/util';
 import { mapCardanoTxSubmitError } from './cardanoTxSubmitErrorMapper';
@@ -35,7 +42,7 @@ export class TxSubmitApiProvider implements TxSubmitProvider {
     let txId: Cardano.TransactionId | undefined;
 
     try {
-      txId = Cardano.TransactionId.fromTxBodyCbor(TxBodyCBOR.fromTxCBOR(signedTransaction));
+      txId = Serialization.TransactionBody.fromCbor(signedTransaction).hash();
 
       this.#logger.debug(`Submitting tx ${txId} ...`);
 

packages/core/package.json

@@ -23,6 +23,7 @@
   "scripts": {
     "build": "yarn build:cjs && tsc -p src/tsconfig.json --outDir ./dist/esm --module es2020 && tsc-alias -p src/tsconfig.json --outDir ./dist/esm && cp ../../build/esm-package.json ./dist/esm/package.json",
     "build:cjs": "tsc --build src && cp ../../build/cjs-package.json ./dist/cjs/package.json",
+    "circular-deps:check": "madge --circular dist/cjs --exclude \"/(?:Address)|(?:Serialization/(?:PlutusData)|(?:Certificates)|(?:Scripts)|(?:AuxiliaryData))/*\"",
     "tscNoEmit": "echo typescript --noEmit command not implemented yet",
     "cleanup:dist": "rm -rf dist",
     "cleanup:nm": "rm -rf node_modules",
@@ -59,7 +60,6 @@
     "@cardano-ogmios/schema": "6.5.0",
     "@cardano-sdk/crypto": "workspace:~",
     "@cardano-sdk/util": "workspace:~",
-    "@cardano-sdk/util-dev": "workspace:~",
     "@foxglove/crc": "^0.0.3",
     "@scure/base": "^1.1.1",
     "fraction.js": "4.0.1",

packages/core/src/Asset/NftMetadata/fromMetadatum.ts

@@ -1,13 +1,13 @@
+import { AssetId, AssetName } from '../../Cardano/types/Asset';
 import { AssetInfo } from '../types';
-import { AssetName } from '../../Cardano';
-import { Cardano } from '../..';
 import { ImageMediaType, MediaType, NftMetadata, NftMetadataFile, Uri } from './types';
 import { InvalidFileError } from './errors';
 import { Logger } from 'ts-log';
 import { asMetadatumArray, asMetadatumMap } from '../../util/metadatum';
 import { asString } from './util';
 import { isNotNil } from '@cardano-sdk/util';
 import difference from 'lodash/difference.js';
+import type { Cardano } from '../../';
 
 const isString = (obj: unknown): obj is string => typeof obj === 'string';
 const VersionRegExp = /^\d+\.?\d?$/;
@@ -151,7 +151,7 @@ export const fromMetadatum = (
   if (!assetMetadata) return null;
   const name = getName(assetMetadata, version, asset, logger, true);
   const image = metadatumToString(assetMetadata.get('image'));
-  const assetId = Cardano.AssetId.fromParts(asset.policyId, asset.name);
+  const assetId = AssetId.fromParts(asset.policyId, asset.name);
 
   if ((strict && !name) || !image) {
     logger.warn(missingFieldLogMessage(!name ? 'name' : 'image', assetId, true));

packages/core/src/Asset/NftMetadata/fromPlutusData.ts

@@ -1,4 +1,3 @@
-import { Cardano } from '../..';
 import { ImageMediaType, MediaType, NftMetadata, NftMetadataFile, Uri } from './types';
 import { Logger } from 'ts-log';
 import { asString } from './util';
@@ -11,6 +10,7 @@ import {
   isPlutusMap,
   tryConvertPlutusMapToUtf8Record
 } from '../../Cardano/util';
+import type { Cardano } from '../..';
 
 const tryCoerce = <T>(
   value: string | Cardano.PlutusData | undefined,

packages/core/src/Asset/NftMetadata/types.ts

@@ -1,6 +1,6 @@
 /* eslint-disable wrap-regex */
 import { InvalidStringError, OpaqueString } from '@cardano-sdk/util';
-import { Metadatum } from '../../Cardano';
+import type { Metadatum } from '../../Cardano';
 
 export type Uri = OpaqueString<'Uri'>;
 export const Uri = (uri: string) => {

packages/core/src/Asset/cip67.ts

@@ -1,4 +1,4 @@
-import * as Cardano from '../Cardano';
+import { AssetName } from '../Cardano/types/Asset';
 import { InvalidArgumentError, OpaqueNumber } from '@cardano-sdk/util';
 import crc8 from './crc8';
 
@@ -18,7 +18,7 @@ export const AssetNameLabelNum = {
 
 export interface DecodedAssetName {
   label: AssetNameLabel;
-  content: Cardano.AssetName;
+  content: AssetName;
 }
 
 const assertLabelNumInterval = (labelNum: number) => {
@@ -55,7 +55,7 @@ const assetNameLabelHexToNum = (label: string): AssetNameLabel | null => {
   return AssetNameLabel(Number.parseInt(labelNumHex, 16));
 };
 
-AssetNameLabel.decode = (assetName: Cardano.AssetName): DecodedAssetName | null => {
+AssetNameLabel.decode = (assetName: AssetName): DecodedAssetName | null => {
   const assetNameLabel = assetName.slice(0, ASSET_LABEL_LENGTH);
   const assetNameContent = assetName.slice(ASSET_LABEL_LENGTH);
   const assetNameLabelNum = assetNameLabelHexToNum(assetNameLabel);
@@ -65,15 +65,13 @@ AssetNameLabel.decode = (assetName: Cardano.AssetName): DecodedAssetName | null
   }
 
   return {
-    content: Cardano.AssetName(assetNameContent),
+    content: AssetName(assetNameContent),
     label: assetNameLabelNum
   };
 };
 
-AssetNameLabel.encode = (assetName: Cardano.AssetName, labelNum: AssetNameLabel): Cardano.AssetName => {
+AssetNameLabel.encode = (assetName: AssetName, labelNum: AssetNameLabel): AssetName => {
   assertLabelNumInterval(labelNum);
   const labelNumHex = labelNum.toString(16).padStart(4, ASSET_LABEL_BRACKET);
-  return Cardano.AssetName(
-    `${ASSET_LABEL_BRACKET}${labelNumHex}${checksum(labelNumHex)}${ASSET_LABEL_BRACKET}${assetName}`
-  );
+  return AssetName(`${ASSET_LABEL_BRACKET}${labelNumHex}${checksum(labelNumHex)}${ASSET_LABEL_BRACKET}${assetName}`);
 };

packages/core/src/Asset/types/AssetInfo.ts

@@ -1,6 +1,6 @@
-import { AssetFingerprint, AssetId, AssetName, PolicyId, TransactionId } from '../../Cardano';
 import { NftMetadata } from '../NftMetadata';
 import { TokenMetadata } from './TokenMetadata';
+import type { AssetFingerprint, AssetId, AssetName, PolicyId, TransactionId } from '../../Cardano';
 
 export interface AssetMintOrBurn {
   transactionId: TransactionId;

packages/core/src/Asset/util/coalesceTokenMaps.ts

@@ -1,5 +1,5 @@
-import { TokenMap } from '../../Cardano';
 import { isNotNil } from '@cardano-sdk/util';
+import type { TokenMap } from '../../Cardano';
 
 /** Sum asset quantities */
 export const coalesceTokenMaps = (totals: (TokenMap | undefined)[]): TokenMap | undefined => {

packages/core/src/Asset/util/getAssetNameAsText.ts

@@ -0,0 +1,8 @@
+import { AssetId } from '../../Cardano/types/Asset';
+import { AssetNameLabel } from '../cip67';
+
+export const getAssetNameAsText = (id: AssetId) => {
+  const assetName = AssetId.getAssetName(id);
+  const assetNameContent = AssetNameLabel.decode(assetName)?.content;
+  return Buffer.from(assetNameContent || assetName, 'hex').toString('utf8');
+};

packages/core/src/Asset/util/index.ts

@@ -2,3 +2,4 @@ export * from './coalesceTokenMaps';
 export * from './removeNegativesFromTokenMap';
 export * from './subtractTokenMaps';
 export * from './isValidHandle';
+export * from './getAssetNameAsText';

packages/core/src/Asset/util/removeNegativesFromTokenMap.ts

@@ -1,4 +1,4 @@
-import { TokenMap } from '../../Cardano';
+import type { TokenMap } from '../../Cardano';
 
 /**
  * Remove all negative quantities from a TokenMap.

packages/core/src/Asset/util/subtractTokenMaps.ts

@@ -1,6 +1,6 @@
 /* eslint-disable complexity,sonarjs/cognitive-complexity */
-import * as Cardano from '../../Cardano';
 import uniq from 'lodash/uniq.js';
+import type * as Cardano from '../../Cardano';
 
 /**
  * Given two Cardano.TokenMaps, compute a Cardano.TokenMap with the difference between the left-hand side and the right-hand side.

packages/core/src/CBOR/TxBodyCBOR.ts

@@ -7,9 +7,10 @@ import {
   assertIsBech32WithPrefix,
   assertIsHexString
 } from '@cardano-sdk/util';
-import { HydratedTx, HydratedTxIn, Tx, TxIn, TxOut } from '../types';
-import { NetworkId } from '../ChainId';
-import { RewardAccount } from './RewardAccount';
+import type { HydratedTx, Tx } from '../types/Transaction';
+import type { HydratedTxIn, TxIn, TxOut } from '../types/Utxo';
+import type { NetworkId } from '../ChainId';
+import type { RewardAccount } from './RewardAccount';
 
 /** mainnet or testnet address (Shelley as bech32 string, Byron as base58-encoded string) */
 export type PaymentAddress = OpaqueString<'PaymentAddress'>;

packages/core/src/CBOR/TxCBOR.ts

@@ -3,7 +3,7 @@ import { Address, AddressProps, AddressType, Credential, CredentialType } from '
 import { Hash28ByteBase16 } from '@cardano-sdk/crypto';
 import { InvalidArgumentError, OpaqueNumber } from '@cardano-sdk/util';
 import { NetworkId } from '../ChainId';
-import { Slot } from '../types';
+import { Slot } from '../types/Block';
 
 /**
  * Encodes the specified value with a variable number of bytes.

packages/core/src/CBOR/index.ts

@@ -1,5 +1,4 @@
 import * as Crypto from '@cardano-sdk/crypto';
-import { AssetNameLabel } from '../../Asset';
 import { HexBlob, InvalidStringError, OpaqueString, assertIsHexString, typedBech32 } from '@cardano-sdk/util';
 import { TextDecoder } from 'web-encoding';
 
@@ -50,11 +49,6 @@ export const PolicyId = (value: string): PolicyId => Crypto.Hash28ByteBase16(val
 AssetId.getPolicyId = (id: AssetId) => PolicyId(id.slice(0, 56));
 AssetId.getAssetName = (id: AssetId) => AssetName(id.slice(56));
 AssetId.fromParts = (policyId: PolicyId, assetName: AssetName): AssetId => AssetId(policyId + assetName);
-AssetId.getAssetNameAsText = (id: AssetId) => {
-  const assetName = AssetId.getAssetName(id);
-  const assetNameContent = AssetNameLabel.decode(assetName)?.content;
-  return Buffer.from(assetNameContent || assetName, 'hex').toString('utf8');
-};
 
 /** Fingerprint of a native asset for human comparison See CIP-0014 */
 export type AssetFingerprint = OpaqueString<'AssetFingerprint'>;

packages/core/src/Cardano/Address/PaymentAddress.ts

@@ -1,5 +1,5 @@
 import * as Crypto from '@cardano-sdk/crypto';
-import * as Serialization from '../../Serialization';
+import * as Serialization from '../../Serialization/AuxiliaryData';
 import { Hash32ByteBase16 } from '@cardano-sdk/crypto';
 import { Script } from './Script';
 import { hexToBytes } from '../../util/misc';

packages/core/src/Cardano/Address/PointerAddress.ts

@@ -1,11 +1,11 @@
-import * as Crypto from '@cardano-sdk/crypto';
-import { Anchor, DelegateRepresentative } from './Governance';
 import { Credential, CredentialType, RewardAccount } from '../Address';
-import { EpochNo } from './Block';
 import { Hash28ByteBase16 } from '@cardano-sdk/crypto';
-import { Lovelace } from './Value';
-import { PoolId, PoolParameters } from './StakePool';
 import { isNotNil } from '@cardano-sdk/util';
+import type * as Crypto from '@cardano-sdk/crypto';
+import type { Anchor, DelegateRepresentative } from './Governance';
+import type { EpochNo } from './Block';
+import type { Lovelace } from './Value';
+import type { PoolId, PoolParameters } from './StakePool';
 
 export enum CertificateType {
   StakeRegistration = 'StakeRegistrationCertificate',

packages/core/src/Cardano/types/Asset.ts

@@ -11,8 +11,6 @@ import { PlutusData } from './PlutusData';
 import { ProposalProcedure, VotingProcedures } from './Governance';
 import { RewardAccount } from '../Address';
 import { Script } from './Script';
-import { TxBodyCBOR } from '../../CBOR/TxBodyCBOR';
-import { bytesToHex, hexToBytes } from '../../util/misc';
 
 /** transaction hash as hex string */
 export type TransactionId = OpaqueString<'TransactionId'>;
@@ -24,12 +22,6 @@ export type TransactionId = OpaqueString<'TransactionId'>;
 export const TransactionId = (value: string): TransactionId =>
   Crypto.Hash32ByteBase16(value) as unknown as TransactionId;
 TransactionId.fromHexBlob = (value: HexBlob) => Crypto.Hash32ByteBase16.fromHexBlob<TransactionId>(value);
-TransactionId.fromTxBodyCbor = (bodyCbor: TxBodyCBOR): TransactionId =>
-  bytesToHex(
-    Crypto.blake2b(Crypto.blake2b.BYTES)
-      .update(hexToBytes(bodyCbor as unknown as HexBlob))
-      .digest()
-  ) as unknown as TransactionId;
 
 export interface Withdrawal {
   stakeAddress: RewardAccount;

packages/core/src/Cardano/types/AuxiliaryData.ts

@@ -1,8 +1,8 @@
 import { Address, AddressType, Credential } from '../Address/Address';
-import { Hash28ByteBase16 } from '@cardano-sdk/crypto';
 import { InvalidStringError } from '@cardano-sdk/util';
-import { PaymentAddress } from '../Address/PaymentAddress';
-import { Pointer } from '../Address/PointerAddress';
+import type { Hash28ByteBase16 } from '@cardano-sdk/crypto';
+import type { PaymentAddress } from '../Address/PaymentAddress';
+import type { Pointer } from '../Address/PointerAddress';
 
 type PaymentId = { credential: Credential } | { byronRoot: Hash28ByteBase16 };
 type StakeId = { credential: Credential } | { pointer: Pointer };