refactor!: move CIP-20 utils to tx-construction package

A circular reference was the motivator for this move, but it's better suited here anyway.
input-output-hk · Aug 22, 2024 · 33422e4 · 33422e4
1 parent b7ec9fb
commit 33422e4
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 11 deletions.
diff --git a/packages/core/src/index.ts b/packages/core/src/index.ts
@@ -1,7 +1,6 @@
 export * as Asset from './Asset';
 export * as Cardano from './Cardano';
 export * as Serialization from './Serialization';
-export * as TxMetadata from './TxMetadata';
 export * from './Provider';
 export * from './util';
 export * from './errors';

diff --git a/packages/tx-construction/src/index.ts b/packages/tx-construction/src/index.ts
@@ -3,6 +3,7 @@ export * from './fees';
 export * from './input-selection';
 export * from './output-validation';
 export * from './tx-builder';
+export * from './tx-metadata';
 export * from './ensureValidityInterval';
 export * from './types';
 export * from './computeScriptDataHash';
diff --git a/packages/core/src/TxMetadata/cip20.ts → .../tx-construction/src/tx-metadata/cip20.ts b/packages/core/src/TxMetadata/cip20.ts → .../tx-construction/src/tx-metadata/cip20.ts
@@ -1,6 +1,6 @@
+import { Cardano } from '@cardano-sdk/core';
 import { CustomError } from 'ts-custom-error';
 import { StringUtils } from '@cardano-sdk/util';
-import { TxMetadata } from '../Cardano';
 
 export const CIP_20_METADATUM_LABEL = 674n;
 const MAX_BYTES = 64;
@@ -53,7 +53,7 @@ export const validateMessage = (entry: unknown): MessageValidationResult => {
  * @returns CIP20-compliant transaction metadata
  * @throws Message validation error containing details. Use validateMessage to independently check each message before calling this function
  */
-export const toCIP20Metadata = (args: CIP20TxMetadataArgs | string): TxMetadata => {
+export const toCIP20Metadata = (args: CIP20TxMetadataArgs | string): Cardano.TxMetadata => {
   const messages = typeof args === 'string' ? StringUtils.chunkByBytes(args, MAX_BYTES) : args.messages;
   const invalidMessages: ValidationResultMap = new Map();
   for (const message of messages) {

diff --git a/packages/core/src/TxMetadata/index.ts → .../tx-construction/src/tx-metadata/index.ts b/packages/core/src/TxMetadata/index.ts → .../tx-construction/src/tx-metadata/index.ts
diff --git a/packages/core/test/TxMetadata/cip20.test.ts → ...nstruction/test/tx-metadata/cip20.test.ts b/packages/core/test/TxMetadata/cip20.test.ts → ...nstruction/test/tx-metadata/cip20.test.ts
@@ -4,11 +4,10 @@ import {
   MessageValidationFailure,
   toCIP20Metadata,
   validateMessage
-} from '../../src/TxMetadata';
-import { Cardano } from '../../src';
-import { TxMetadata } from '../../src/Cardano';
+} from '../../src';
+import { Cardano } from '@cardano-sdk/core';
 
-describe('TxMetadata.cip20', () => {
+describe('CIP-20 helper functions', () => {
   const compliantShortMessage = 'Lorem ipsum dolor';
   const compliantMaxMessage = 'Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean';
   const oversizeMessage = `${compliantMaxMessage}1`;
@@ -44,7 +43,7 @@ describe('TxMetadata.cip20', () => {
   describe('toCIP20Metadata', () => {
     describe('args object', () => {
       it('produces a CIP-20-compliant TxMetadata map', () => {
-        const metadata = toCIP20Metadata({ messages: [compliantShortMessage] }) as TxMetadata;
+        const metadata = toCIP20Metadata({ messages: [compliantShortMessage] }) as Cardano.TxMetadata;
         expect(metadata.has(CIP_20_METADATUM_LABEL)).toBe(true);
         const cip20Metadata = metadata.get(CIP_20_METADATUM_LABEL) as Cardano.MetadatumMap;
         expect(cip20Metadata.get('msg')).toStrictEqual([compliantShortMessage]);
@@ -59,19 +58,19 @@ describe('TxMetadata.cip20', () => {
     });
     describe('producing a CIP-20-compliant TxMetadata map with a string arg', () => {
       test('larger than 64 bytes', () => {
-        const metadata = toCIP20Metadata(oversizeMessage) as TxMetadata;
+        const metadata = toCIP20Metadata(oversizeMessage) as Cardano.TxMetadata;
         expect(metadata.has(CIP_20_METADATUM_LABEL)).toBe(true);
         const cip20Metadata = metadata.get(CIP_20_METADATUM_LABEL) as Cardano.MetadatumMap;
         expect((cip20Metadata.get('msg') as string[]).length).toBe(2);
       });
       test('equal to 64 bytes', () => {
-        const metadata = toCIP20Metadata(compliantMaxMessage) as TxMetadata;
+        const metadata = toCIP20Metadata(compliantMaxMessage) as Cardano.TxMetadata;
         expect(metadata.has(CIP_20_METADATUM_LABEL)).toBe(true);
         const cip20Metadata = metadata.get(CIP_20_METADATUM_LABEL) as Cardano.MetadatumMap;
         expect((cip20Metadata.get('msg') as string[]).length).toBe(1);
       });
       test('smaller than to 64 bytes', () => {
-        const metadata = toCIP20Metadata(compliantShortMessage) as TxMetadata;
+        const metadata = toCIP20Metadata(compliantShortMessage) as Cardano.TxMetadata;
         expect(metadata.has(CIP_20_METADATUM_LABEL)).toBe(true);
         const cip20Metadata = metadata.get(CIP_20_METADATUM_LABEL) as Cardano.MetadatumMap;
         expect((cip20Metadata.get('msg') as string[]).length).toBe(1);