feat: Add TxnHash

src/index.ts

@@ -9,4 +9,5 @@ export * from "./nameparser";
 export * from "./nft";
 export * from "./number";
 export * from "./price";
-export * from "./time";
+export * from "./time";
+export * from "./transaction";

src/transaction.test.ts

@@ -0,0 +1,30 @@
+import { describe, it, expect } from "vitest";
+import { buildTxnHash } from "./transaction";
+
+describe("buildTxnHash() function", () => {
+
+    it("doesn't begin with 0x", () => {
+        const hash = "1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef";
+
+        expect(() => buildTxnHash(hash)).toThrow();
+    });
+
+    it("too few digits", () => {
+        const hash = "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcde";
+
+        expect(() => buildTxnHash(hash)).toThrow();
+    });
+
+    it("too many digits", () => {
+        const hash = "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef1";
+
+        expect(() => buildTxnHash(hash)).toThrow();
+    });
+
+    it("valid hash", () => {
+        const hash = "0x1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF";
+
+        const result = buildTxnHash(hash);
+        expect(result.hash).toStrictEqual(hash.toLowerCase());
+    });
+});

src/transaction.ts

@@ -0,0 +1,21 @@
+export interface TxnHash {
+    hash: `0x${string}`;
+}
+
+const regex = /^0x[0-9a-fA-F]{64}$/;
+
+const isTxnHash = (maybeTxnHash: string): boolean => {
+    return regex.test(maybeTxnHash);
+}
+
+export const buildTxnHash = (maybeTxnHash: string): TxnHash => {
+
+    if (!isTxnHash(maybeTxnHash))
+        throw new Error(`Invalid transaction hash: ${maybeTxnHash}`);
+
+    const normalizedHash = maybeTxnHash.toLowerCase() as `0x${string}`;
+
+    return {
+        hash: normalizedHash
+    };
+}