feat: add global config var for w3id

Author: coodos

infrastructure/w3id/src/index.ts

@@ -24,12 +24,18 @@ export class W3IDBuilder {
     private entropy?: string;
     private namespace?: string;
     private nextKeyHash?: string;
+    private global?: boolean = false;
 
     public withEntropy(str: string): W3IDBuilder {
         this.entropy = str;
         return this;
     }
 
+    public withGlobal(isGlobal: boolean): W3IDBuilder {
+        this.global = isGlobal;
+        return this;
+    }
+
     public withNamespace(uuid: string): W3IDBuilder {
         this.namespace = uuid;
         return this;
@@ -55,7 +61,9 @@ export class W3IDBuilder {
     public async build(): Promise<W3ID> {
         this.entropy = this.entropy ?? generateRandomAlphaNum();
         this.namespace = this.namespace ?? uuidv4();
-        const id = generateUuid(this.entropy, this.namespace);
+        const id = this.global
+            ? "@"
+            : "" + generateUuid(this.entropy, this.namespace);
         if (!this.signer) {
             return new W3ID(id);
         } else {

infrastructure/w3id/tests/logs/log.test.ts

@@ -1,20 +1,10 @@
-import { StorageSpec } from "../../src/logs/storage/storage-spec.ts";
-import {
-    LogEvent,
-    Signer,
-    VerifierCallback,
-} from "../../src/logs/log.types.ts";
+import { LogEvent } from "../../src/logs/log.types.ts";
 import { IDLogManager } from "../../src/logs/log-manager";
 import { generateUuid } from "../../src/utils/uuid";
 import { describe, expect, test, expectTypeOf } from "vitest";
 import { hash } from "../../src/utils/hash";
 import nacl from "tweetnacl";
-import {
-    uint8ArrayToHex,
-    stringToUint8Array,
-    hexToUint8Array,
-} from "../../src/utils/codec";
-import { base58btc } from "multiformats/bases/base58";
+import { uint8ArrayToHex } from "../../src/utils/codec";
 import falso from "@ngneat/falso";
 import {
     BadNextKeySpecifiedError,
@@ -23,44 +13,9 @@ import {
     MalformedHashChainError,
     MalformedIndexChainError,
 } from "../../src/errors/errors.ts";
+import { InMemoryStorage } from "../utils/store.ts";
+import { createSigner, verifierCallback } from "../utils/crypto.ts";
 
-export class InMemoryStorage<T extends LogEvent, K extends LogEvent>
-    implements StorageSpec<T, K>
-{
-    private data: K[] = [];
-
-    public static build<T extends LogEvent, K extends LogEvent>(): StorageSpec<
-        T,
-        K
-    > {
-        return new InMemoryStorage<T, K>();
-    }
-
-    public async create(body: T): Promise<K> {
-        const entry = body as unknown as K;
-        this.data.push(entry);
-        return entry;
-    }
-
-    public async findOne(options: Partial<K>): Promise<K> {
-        const result = this.data.find((item) =>
-            Object.entries(options).every(
-                ([key, value]) => item[key as keyof K] === value,
-            ),
-        );
-
-        if (!result) throw new Error("Not found");
-        return result;
-    }
-
-    public async findMany(options: Partial<K>): Promise<K[]> {
-        return this.data.filter((item) =>
-            Object.entries(options).every(
-                ([key, value]) => item[key as keyof K] === value,
-            ),
-        );
-    }
-}
 const keyPair = nacl.sign.keyPair();
 let currNextKey = nacl.sign.keyPair();
 
@@ -69,36 +24,6 @@ const signer = createSigner(keyPair);
 const logManager = new IDLogManager(InMemoryStorage.build(), signer);
 const w3id = `@${generateUuid("asdfa")}`;
 
-export const verifierCallback: VerifierCallback = async (
-    message: string,
-    signature: string,
-    pubKey: string,
-) => {
-    const signatureBuffer = base58btc.decode(signature);
-    const messageBuffer = stringToUint8Array(message);
-    const publicKey = hexToUint8Array(pubKey);
-    const isValid = nacl.sign.detached.verify(
-        messageBuffer,
-        signatureBuffer,
-        publicKey,
-    );
-
-    return isValid;
-};
-
-export function createSigner(keyPair: nacl.SignKeyPair): Signer {
-    const publicKey = uint8ArrayToHex(keyPair.publicKey);
-    const signer: Signer = {
-        pubKey: publicKey,
-        sign: (str: string) => {
-            const buffer = stringToUint8Array(str);
-            const signature = nacl.sign.detached(buffer, keyPair.secretKey);
-            return base58btc.encode(signature);
-        },
-    };
-    return signer;
-}
-
 describe("LogManager", async () => {
     test("GenesisEvent: [Throw at Bad Options]", async () => {
         const nextKeyHash = await hash(uint8ArrayToHex(currNextKey.publicKey));

infrastructure/w3id/tests/utils/crypto.ts

@@ -0,0 +1,38 @@
+import { base58btc } from "multiformats/bases/base58";
+import { Signer, VerifierCallback } from "../../src/logs/log.types";
+import {
+    hexToUint8Array,
+    stringToUint8Array,
+    uint8ArrayToHex,
+} from "../../src/utils/codec";
+import nacl from "tweetnacl";
+
+export const verifierCallback: VerifierCallback = async (
+    message: string,
+    signature: string,
+    pubKey: string,
+) => {
+    const signatureBuffer = base58btc.decode(signature);
+    const messageBuffer = stringToUint8Array(message);
+    const publicKey = hexToUint8Array(pubKey);
+    const isValid = nacl.sign.detached.verify(
+        messageBuffer,
+        signatureBuffer,
+        publicKey,
+    );
+
+    return isValid;
+};
+
+export function createSigner(keyPair: nacl.SignKeyPair): Signer {
+    const publicKey = uint8ArrayToHex(keyPair.publicKey);
+    const signer: Signer = {
+        pubKey: publicKey,
+        sign: (str: string) => {
+            const buffer = stringToUint8Array(str);
+            const signature = nacl.sign.detached(buffer, keyPair.secretKey);
+            return base58btc.encode(signature);
+        },
+    };
+    return signer;
+}

infrastructure/w3id/tests/utils/store.ts

@@ -0,0 +1,40 @@
+import { LogEvent } from "../../src/logs/log.types";
+import { StorageSpec } from "../../src/logs/storage/storage-spec.ts";
+
+export class InMemoryStorage<T extends LogEvent, K extends LogEvent>
+    implements StorageSpec<T, K>
+{
+    private data: K[] = [];
+
+    public static build<T extends LogEvent, K extends LogEvent>(): StorageSpec<
+        T,
+        K
+    > {
+        return new InMemoryStorage<T, K>();
+    }
+
+    public async create(body: T): Promise<K> {
+        const entry = body as unknown as K;
+        this.data.push(entry);
+        return entry;
+    }
+
+    public async findOne(options: Partial<K>): Promise<K> {
+        const result = this.data.find((item) =>
+            Object.entries(options).every(
+                ([key, value]) => item[key as keyof K] === value,
+            ),
+        );
+
+        if (!result) throw new Error("Not found");
+        return result;
+    }
+
+    public async findMany(options: Partial<K>): Promise<K[]> {
+        return this.data.filter((item) =>
+            Object.entries(options).every(
+                ([key, value]) => item[key as keyof K] === value,
+            ),
+        );
+    }
+}

infrastructure/w3id/tests/w3id.test.ts

@@ -2,11 +2,8 @@ import { W3ID, W3IDBuilder } from "../src";
 import { describe, test, expect } from "vitest";
 import falso from "@ngneat/falso";
 import nacl from "tweetnacl";
-import {
-    createSigner,
-    InMemoryStorage,
-    verifierCallback,
-} from "./logs/log.test";
+import { createSigner, verifierCallback } from "./utils/crypto";
+import { InMemoryStorage } from "./utils/store";
 import { IDLogManager } from "../src/logs/log-manager";
 import { hash } from "../src/utils/hash";
 import { uint8ArrayToHex } from "../src/utils/codec";
@@ -21,6 +18,16 @@ describe("W3IDBuilder", () => {
         expect(id.logs).toBeUndefined();
     });
 
+    test("ID Generation: Global ID begins with `@`", async () => {
+        const id = await new W3IDBuilder().withGlobal(true).build();
+        expect(id.id.startsWith("@")).toBe(true);
+    });
+
+    test("ID Generation: Local ID begins doesn't begin with `@`", async () => {
+        const id = await new W3IDBuilder().build();
+        expect(id.id.startsWith("@")).toBe(false);
+    });
+
     test("ID Generation: UUID is Deterministic", async () => {
         const namespace = falso.randUuid();
         const entropy = falso.randText();