refactor: abandon enums for NIPs and event kinds in favor of type rec…

…ords (#18)

core/clients.ts

@@ -12,19 +12,13 @@ import {
   NostrNodeEvent,
   NostrNodeModule,
 } from "./nodes.ts";
+import { NIPs } from "./nips.ts";
 
 // ----------------------
 // NIPs
 // ----------------------
 
-const NIPs = await Promise.all(
-  new URL(import.meta.url).searchParams.get("nips")?.split(",").map(Number).map(
-    (nip) =>
-      import(
-        new URL(`../nips/${nip}/clients.ts`, import.meta.url).href
-      ) as Promise<ClientModule>,
-  ) ?? [],
-);
+const nips = await NIPs.import<ClientModule>(import.meta.url, "../nips");
 
 /**
  * A class that represents a remote Nostr client.
@@ -47,7 +41,7 @@ export class Client extends NostrNode<
   constructor(ws: WebSocket, opts?: ClientOptions) {
     super(ws, {
       ...opts,
-      modules: NIPs.concat(opts?.modules ?? []),
+      modules: nips.concat(opts?.modules ?? []),
     });
     this.ws.addEventListener("message", (ev: MessageEvent<string>) => {
       // TODO: Validate the type of the message.

core/nips.ts

@@ -0,0 +1,38 @@
+import type { NIP } from "./protocol.d.ts";
+import { NostrNodeModule } from "./nodes.ts";
+
+export const NIPs = {
+  /**
+   * Import a Nostr module from a URL.
+   *
+   * @param meta - The path to the module to which the NIPs are attached (mostly import.meta.url).
+   * @param root - The path to the root of NIP module to import.
+   */
+  // deno-lint-ignore no-explicit-any
+  import<M extends NostrNodeModule<any>>(
+    meta: string,
+    root: string,
+  ) {
+    const url = new URL(meta);
+    const base = url.pathname.split("/").slice(-1)[0];
+    return Promise.all(
+      url.searchParams.get("nips")?.split(",").map(Number).map(
+        (nip) =>
+          import(
+            new URL(
+              `${root}/${nipToString(nip)}/${base}`,
+              import.meta.url,
+            ).href
+          ) as Promise<M>,
+      ) ?? [],
+    );
+  },
+};
+
+/**
+ * Convert a NIP to a string. If the NIP is less than 10, a leading zero is
+ * added.
+ */
+function nipToString(nip: NIP | number) {
+  return nip > 9 ? nip.toString() : "0" + nip.toString();
+}

core/nodes.ts

@@ -102,7 +102,9 @@ export class NostrNode<
 // Extensions
 // ------------------------------
 
-export interface NostrNodeModule<R extends FunctionParameterTypeRecord> {
+export interface NostrNodeModule<
+  R extends FunctionParameterTypeRecord,
+> {
   default: NostrNodeFunctions<R>;
 }
 

core/protocol.d.ts

@@ -1,4 +1,4 @@
-// deno-lint-ignore-file no-empty-enum no-empty-interface
+// deno-lint-ignore-file no-empty-interface
 
 /**
  * Implementation of unextendable part of NIP-01 (Nostr basic protocol):
@@ -15,11 +15,9 @@ import type { AlphabetLetter, Brand, Stringified } from "./types.ts";
 // Extendable interfaces
 // ----------------------
 
-export enum NIP {}
-export enum EventKind {}
+export interface NipRecord {}
 
-export interface EventKindRecord
-  extends Record<EventKind, EventKindRecordEntry> {}
+export interface EventKindRecord {}
 
 export interface TagRecord {}
 
@@ -65,7 +63,7 @@ export type EventSerializePrecursor<K extends EventKind = EventKind> = [
 // Tags
 // ----------------------
 
-export type TagType = keyof TagRecord;
+export type TagType = keyof TagRecord & string;
 export type TagParam = string | undefined;
 
 export type Tag<T extends TagType = TagType> = {
@@ -150,6 +148,8 @@ export type SubscriptionFilter<
 // Events
 // ----------------------
 
+export type EventKind = keyof EventKindRecord & number;
+
 export interface EventKindRecordEntry {
   Tag: Tag;
   Content: unknown;
@@ -158,8 +158,8 @@ export interface EventKindRecordEntry {
 
 export type EventContent = EventContentFor<EventKind>;
 
-export type EventContentFor<K extends EventKind> =
-  EventKindRecord[K]["Content"];
+export type EventContentFor<K extends EventKind> = EventKindRecord[K] extends
+  EventKindRecordEntry ? EventKindRecord[K]["Content"] : never;
 
 export type ResponsePrefixFor<K extends EventKind = EventKind> =
   EventKindRecord[K] extends { ResponsePrefix: infer P extends string } ? P
@@ -172,3 +172,16 @@ export type ParameterizedReplaceableEventKind = Brand<
   EventKind,
   "ParameterizedReplaceable"
 >;
+
+// ----------------------
+// NIPs
+// ----------------------
+
+export type NIP = keyof NipRecord & number;
+
+export interface NipRecordEntry {
+  ClientToRelayMessage: ClientToRelayMessageType;
+  RelayToClientMessage: RelayToClientMessageType;
+  EventKind: EventKind;
+  Tag: TagType;
+}

core/relays.ts

@@ -18,19 +18,13 @@ import {
   NostrNodeEvent,
   NostrNodeModule,
 } from "./nodes.ts";
+import { NIPs } from "./nips.ts";
 
 // ----------------------
 // NIPs
 // ----------------------
 
-const NIPs = await Promise.all(
-  new URL(import.meta.url).searchParams.get("nips")?.split(",").map(Number).map(
-    (nip) =>
-      import(
-        new URL(`../nips/${nip}/relays.ts`, import.meta.url).href
-      ) as Promise<RelayModule>,
-  ) ?? [],
-);
+const nips = await NIPs.import<RelayModule>(import.meta.url, "../nips");
 
 // ----------------------
 // Errors
@@ -89,7 +83,7 @@ export class Relay extends NostrNode<
       nbuffer: 10,
       logger: {},
       ...options,
-      modules: NIPs.concat(options?.modules ?? []),
+      modules: nips.concat(options?.modules ?? []),
     };
     super(new LazyWebSocket(url), config);
     this.config = {

lib/signs.ts

@@ -7,10 +7,12 @@ import type {
   NostrEvent,
   Signature,
 } from "../core/protocol.d.ts";
+import type { UnsignedEvent } from "../nips/07/protocol.d.ts";
 import { bytesToHex, schnorr, sha256 } from "./x/noble.ts";
 import type { EventInit } from "./events.ts";
 import { Timestamp } from "./times.ts";
-import { UnsignedEvent } from "../nips/7/protocol.d.ts";
+
+export type { UnsignedEvent } from "../nips/07/protocol.d.ts";
 
 export type PrivateKey = Brand<string, "PrivateKey">;
 

lib/signs_test.ts

@@ -1,7 +1,15 @@
+import { Stringified } from "../core/types.ts";
+import "../nips/01/protocol.d.ts";
 import { describe, it } from "../lib/std/testing.ts";
 import { assert, assertEquals } from "../lib/std/assert.ts";
 import { Timestamp } from "../lib/times.ts";
-import { PrivateKey, PublicKey, Signer, Verifier } from "./signs.ts";
+import {
+  PrivateKey,
+  PublicKey,
+  Signer,
+  UnsignedEvent,
+  Verifier,
+} from "./signs.ts";
 
 describe("PrivateKey", () => {
   it("generates a private key", () => {
@@ -21,12 +29,12 @@ describe("PublicKey", () => {
 describe("Signer/Verifier", () => {
   const nsec = PrivateKey.generate();
   const signer = new Signer(nsec);
-  const event = {
+  const event: UnsignedEvent = {
     pubkey: PublicKey.from(nsec),
     created_at: Timestamp.now,
     kind: 1,
     tags: [],
-    content: "lophus",
+    content: "lophus" as Stringified<string>,
   };
   const verifier = new Verifier();
 

nips/1/protocol.d.ts → nips/01/protocol.d.ts

@@ -11,12 +11,13 @@ import "../../core/protocol.d.ts";
 import type { Url } from "../../core/types.ts";
 
 declare module "../../core/protocol.d.ts" {
-  enum NIP {
-    BasicProtocol = 1,
-  }
-  enum EventKind {
-    Metadata = 0,
-    TextNote = 1,
+  interface NipRecord {
+    1: {
+      ClientToRelayMessage: "EVENT" | "REQ" | "CLOSE";
+      RelayToClientMessage: "EVENT" | "OK" | "EOSE" | "NOTICE";
+      EventKind: 0 | 1;
+      Tag: "e" | "p" | "a" | "d";
+    };
   }
   interface TagRecord {
     /** Event ID */

nips/2/protocol.d.ts → nips/02/protocol.d.ts

@@ -1,16 +1,16 @@
 import "../../core/protocol.d.ts";
 
 declare module "../../core/protocol.d.ts" {
-  enum NIP {
-    ContactList = 2,
-  }
-  enum EventKind {
-    ContactList = 3,
+  interface NipRecord {
+    2: {
+      Tag: "p";
+    };
   }
   interface EventKindRecord {
     3: {
-      Tag: ["p", PublicKey, RelayUrl, string];
+      Tag: ContactTag;
       Content: "";
     };
   }
+  type ContactTag = ["p", PublicKey, RelayUrl, petname: string];
 }

nips/7/protocol.d.ts → nips/07/protocol.d.ts

@@ -1,9 +1,16 @@
 import { EventKind, NostrEvent, PublicKey } from "../../core/protocol.d.ts";
+import type { Optional } from "../../lib/types.ts";
+
+declare module "../../core/protocol.d.ts" {
+  interface NipRecord {
+    7: Record<string, never>;
+  }
+}
 
 /**
  * An event that has not been signed.
  */
-export type UnsignedEvent<K extends EventKind = EventKind> = Omit<
+export type UnsignedEvent<K extends EventKind = EventKind> = Optional<
   NostrEvent<K>,
   "id" | "pubkey" | "sig"
 >;

nips/7/signs.ts → nips/07/signs.ts

@@ -1,5 +1,9 @@
 import type { Stringified } from "../../core/types.ts";
-import { EventContent, EventKind, NostrEvent } from "../../core/protocol.d.ts";
+import {
+  EventContentFor,
+  EventKind,
+  NostrEvent,
+} from "../../core/protocol.d.ts";
 import { EventInit } from "../../lib/events.ts";
 import { Timestamp } from "../../lib/times.ts";
 import { UnsignedEvent } from "./protocol.d.ts";
@@ -23,8 +27,8 @@ export class Signer extends TransformStream<EventInit, NostrEvent> {
       created_at: Timestamp.now,
       tags: [],
       ...init,
-      content: JSON.stringify(init.content) as Stringified<EventContent>,
-    } satisfies UnsignedEvent;
+      content: JSON.stringify(init.content) as Stringified<EventContentFor<K>>,
+    } satisfies UnsignedEvent<K>;
     return window.nostr!.signEvent(unsigned);
   }
 }

nips/42/protocol.d.ts

@@ -3,11 +3,13 @@ import "../../core/relays.ts";
 import type { Signer } from "../../lib/signs.ts";
 
 declare module "../../core/protocol.d.ts" {
-  enum NIP {
-    Authentication = 42,
-  }
-  enum EventKind {
-    ClientAuth = 22242,
+  interface NipRecord {
+    42: {
+      ClientToRelayMessage: "AUTH";
+      RelayToClientMessage: "AUTH";
+      EventKind: 22242;
+      Tag: Tag<"relay" | "challenge">;
+    };
   }
   interface RelayToClientMessageRecord {
     AUTH: [challenge: string];