Add unit tests for TokenModuleReference and TokenId

Author: soerenbf

packages/sdk/src/plt/TokenId.ts

@@ -8,15 +8,15 @@ export type JSON = string;
 const MAX_LENGTH = 256;
 
 /**
- * Enum representing the types of errors that can occur with token amounts.
+ * Enum representing the types of errors that can occur with token IDs.
  */
 export enum ErrorType {
-    /** Error type indicating the length of module reference is incorrect. */
+    /** Error type indicating the length length exceeds the max allowed. */
     EXCEEDS_MAX_LENGTH = 'EXCEEDS_MAX_LENGTH',
 }
 
 /**
- * Custom error to represent issues with token amounts.
+ * Custom error to represent issues with token IDs.
  */
 export class Err extends Error {
     private constructor(
@@ -29,9 +29,9 @@ export class Err extends Error {
     }
 
     /**
-     * Creates a TokenId.Err indicating the length of module reference is incorrect.
+     * Creates a TokenId.Err indicating the length exceeds the max allowed.
      */
-    public static incorrectLength(): Err {
+    public static exceedsMaxLength(): Err {
         return new Err(
             ErrorType.EXCEEDS_MAX_LENGTH,
             `Token ID's cannot be longer than ${MAX_LENGTH} utf-8 encoded bytes`
@@ -58,7 +58,7 @@ class TokenId {
     ) {
         // Check if the value exceeds 256 UTF-8 bytes
         if (new TextEncoder().encode(symbol).length > MAX_LENGTH) {
-            throw Err.incorrectLength();
+            throw Err.exceedsMaxLength();
         }
     }
 

packages/sdk/src/plt/TokenModuleReference.ts

@@ -10,15 +10,15 @@ const MODULE_REF_BYTE_LENGTH = 32;
 export type JSON = HexString;
 
 /**
- * Enum representing the types of errors that can occur with token amounts.
+ * Enum representing the types of errors that can occur with token module references.
  */
 export enum ErrorType {
     /** Error type indicating the length of module reference is incorrect. */
     INCORRECT_LENGTH = 'INCORRECT_LENGTH',
 }
 
 /**
- * Custom error to represent issues with token amounts.
+ * Custom error to represent issues with token module references.
  */
 export class Err extends Error {
     private constructor(
@@ -33,10 +33,11 @@ export class Err extends Error {
     /**
      * Creates a TokenModuleReference.Err indicating the length of module reference is incorrect.
      */
-    public static incorrectLength(moduleRef: Type): Err {
+    public static incorrectLength(bytes: Uint8Array): Err {
+        const hex = Buffer.from(bytes).toString('hex');
         return new Err(
             ErrorType.INCORRECT_LENGTH,
-            `Token module reference ${moduleRef.toString()} is invalid, as it must contain ${MODULE_REF_BYTE_LENGTH} bytes`
+            `Token module reference ${hex} is invalid, as it must contain ${MODULE_REF_BYTE_LENGTH} bytes`
         );
     }
 }
@@ -59,7 +60,7 @@ class ModuleReference {
         public readonly bytes: Uint8Array
     ) {
         if (bytes.byteLength !== MODULE_REF_BYTE_LENGTH) {
-            throw Err.incorrectLength(this);
+            throw Err.incorrectLength(bytes);
         }
     }
 
@@ -114,7 +115,7 @@ export function fromBuffer(buffer: ArrayBuffer): ModuleReference {
  * @throws {Err} If the value is not exactly 32 bytes.
  */
 export function fromHexString(moduleRef: HexString): ModuleReference {
-    return new ModuleReference(new Uint8Array(Buffer.from(moduleRef, 'hex')));
+    return fromBuffer(Buffer.from(moduleRef, 'hex'));
 }
 
 /**

packages/sdk/test/ci/plt/TokenId.test.ts

@@ -0,0 +1,27 @@
+import { TokenId } from '../../../src/plt/types.ts';
+
+describe('PLT TokenId', () => {
+    test('Creates token IDs as expected', () => {
+        const str = 'DKK';
+        const expected = TokenId.fromString(str);
+
+        expect(TokenId.fromString(str).symbol).toEqual(str);
+
+        const bytes = new TextEncoder().encode(str);
+        expect(TokenId.fromBytes(bytes)).toEqual(expected);
+
+        const json = str;
+        expect(TokenId.fromJSON(json)).toEqual(expected);
+
+        expect(() => TokenId.fromString('T'.repeat(256))).not.toThrow()
+    });
+
+    test('JSON id test', () => {
+        const json = 'TOKEN';
+        expect(TokenId.fromJSON(json).toJSON()).toEqual(json);
+    });
+
+    test('Throws errors on invalid values', () => {
+        expect(() => TokenId.fromString('T'.repeat(257))).toThrow(TokenId.Err.exceedsMaxLength())
+    })
+});

packages/sdk/test/ci/plt/TokenModuleReference.test.ts

@@ -0,0 +1,28 @@
+import { TokenModuleReference } from '../../../src/plt/types.ts';
+
+describe('PLT TokenModuleReference', () => {
+    test('Creates token module references as expected', () => {
+        const hex = '0ea8121fdc427c9b23ae5e26cfea3e8cbb544c84aa0c82db26a85949ce1706c3';
+        const bytes = Buffer.from(hex, 'hex');
+        const expected = TokenModuleReference.fromBuffer(bytes);
+
+        expect(expected.bytes).toEqual(new Uint8Array(bytes));
+        expect(TokenModuleReference.fromHexString(hex)).toEqual(expected);
+    });
+
+    test('JSON id test', () => {
+        const json = '0ea8121fdc427c9b23ae5e26cfea3e8cbb544c84aa0c82db26a85949ce1706c3';
+        expect(TokenModuleReference.fromJSON(json).toJSON()).toEqual(json);
+    });
+
+    test('Throws errors on invalid values', () => {
+        let bytes = Buffer.from('0EA8121FDC427C9B23AE5E26CFEA3E8CBB544C84AA0C82DB26A85949CE1706', 'hex');
+        expect(() => TokenModuleReference.fromBuffer(bytes)).toThrow(TokenModuleReference.Err.incorrectLength(bytes));
+
+        bytes = Buffer.from('0EA8121FDC427C9B23AE5E26CFEA3E8CBB544C84AA0C82DB26A85949CE1706E1706', 'hex');
+        expect(() => TokenModuleReference.fromBuffer(bytes)).toThrow(TokenModuleReference.Err.incorrectLength(bytes));
+
+        const invalidHex = '0EA8121FDC427C9B23AE5E26CFEA3E8CBB544C84AA0C82DB26A85949CE1706E170'
+        expect(() => TokenModuleReference.fromHexString(invalidHex)).toThrow();
+    });
+});