WIP: create nips module

core/deno.json

@@ -6,5 +6,11 @@
     "./clients": "./clients.ts",
     "./protocol": "./protocol.ts",
     "./relays": "./relays.ts"
+  },
+  "imports": {
+    "@lophus/lib": "jsr:@lophus/[email protected]"
+  },
+  "publish": {
+    "exclude": ["*_test.ts"]
   }
 }

core/protocol.ts

@@ -1,11 +1,10 @@
 // deno-lint-ignore-file no-empty-interface
 
 /**
- * Implementation of unextendable part of NIP-01 (Nostr basic protocol):
+ * Implementation of the fundamental part of NIP-01 (Nostr basic protocol):
  * https://github.com/nostr-protocol/nips/blob/master/01.md
  *
- * See also `../../nips/01/protocol.d.ts` for the extendable part.
- *
+ * See also `../../nips/01/protocol.ts` for the remaining "optional" part.
  * @module
  */
 
@@ -59,6 +58,12 @@ export type EventSerializePrecursor<K extends EventKind = EventKind> = [
   content: NostrEvent<K>["content"],
 ];
 
+/** An event that has not been signed. */
+export type UnsignedEvent<K extends EventKind = EventKind> = Omit<
+  NostrEvent<K>,
+  "id" | "pubkey" | "sig"
+>;
+
 // ----------------------
 // Tags
 // ----------------------

deno.json

@@ -5,12 +5,17 @@
   "imports": {
     "@noble/curves": "npm:@noble/curves@^1.3.0",
     "@noble/hashes": "npm:@noble/hashes@^1.3.3",
-    "@lophus/core/clients": "./core/clients.ts",
-    "@lophus/core/protocol": "./core/protocol.ts",
-    "@lophus/core/relays": "./core/relays.ts",
     "@lophus/lib/types": "./lib/types.ts",
     "@lophus/lib/testing": "./lib/testing.ts",
     "@lophus/lib/streams": "./lib/streams.ts",
+    "@lophus/core/clients": "./core/clients.ts",
+    "@lophus/core/protocol": "./core/protocol.ts",
+    "@lophus/core/relays": "./core/relays.ts",
+    "@lophus/nips": "./nips/mod.ts",
+    "@lophus/nips/01": "./nips/01/mod.ts",
+    "@lophus/nips/02": "./nips/02/mod.ts",
+    "@lophus/nips/07": "./nips/07/mod.ts",
+    "@lophus/nips/42": "./nips/42/mod.ts",
     "@lophus/std/env": "./std/env.ts",
     "@lophus/std/events": "./std/events.ts",
     "@lophus/std/notes": "./std/notes.ts",
@@ -26,7 +31,7 @@
     "build": "mkdir -p ./dist && deno run -A ./bin/bundle.ts",
     "cache": "deno cache ./**/*.ts --lock",
     "check": "deno check ./**/*.ts",
-    "lock": "deno task cache --lock-write && git add deno.lock",
+    "lock": "deno task cache --lock-write",
     "pre-commit": "deno fmt && deno lint && deno task -q check && deno task -q lock && deno task -q test",
     "test": "deno test -A --no-check",
     "update": "deno run --allow-read --allow-env --allow-write --allow-net=registry.npmjs.org,jsr.io --allow-run=deno,git https://deno.land/x/[email protected]/cli.ts deno.json --unstable-lock",

lib/deno.json

@@ -5,5 +5,8 @@
     "./streams": "./streams.ts",
     "./testing": "./testing.ts",
     "./types": "./types.ts"
+  },
+  "publish": {
+    "exclude": ["*_test.ts"]
   }
 }

nips/01/protocol.ts

@@ -1,16 +1,16 @@
 /**
- * Implementation of extendable part of NIP-01 (Nostr basic protocol):
+ * Implementation of the "optional" part of NIP-01 (Nostr basic protocol):
  * https://github.com/nostr-protocol/nips/blob/master/01.md
  *
- * See also `../../core/protocol.d.ts` for the unextendable part.
+ * See also `../../core/protocol.ts` for the unextendable part.
  *
  * @module
  */
 
-import "../../core/protocol.ts";
-import type { Url } from "../../lib/types.ts";
+import "@lophus/core/protocol";
+import type { Url } from "@lophus/lib/types";
 
-declare module "../../core/protocol.ts" {
+declare module "@lophus/core/protocol" {
   interface NipRecord {
     1: {
       ClientToRelayMessage: "EVENT" | "REQ" | "CLOSE";

nips/07/mod.ts

@@ -0,0 +1 @@
+import "./protocol.ts";

nips/07/protocol.ts

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

nips/42/protocol.ts

@@ -1,7 +1,6 @@
-import "../../core/protocol.ts";
-import "../../core/relays.ts";
+import "@lophus/core/protocol";
 
-declare module "../../core/protocol.ts" {
+declare module "@lophus/core/protocol" {
   interface NipRecord {
     42: {
       ClientToRelayMessage: "AUTH";

nips/deno.json

@@ -0,0 +1,20 @@
+{
+  "name": "@lophus/nips",
+  "version": "0.0.14",
+  "exports": {
+    ".": "./mod.ts",
+    "./01": "./01/mod.ts",
+    "./02": "./02/mod.ts",
+    "./07": "./07/mod.ts",
+    "./42": "./42/mod.ts"
+  },
+  "imports": {
+    "@std/dotenv": "jsr:@std/dotenv@^0.219.1",
+    "@std/streams": "jsr:@std/streams@^0.219.1",
+    "@lophus/lib": "jsr:@lophus/[email protected]",
+    "@lophus/core": "jsr:@lophus/[email protected]"
+  },
+  "publish": {
+    "exclude": ["*_test.ts"]
+  }
+}

nips/mod.ts

@@ -0,0 +1,4 @@
+export * from "./01/mod.ts";
+export * from "./02/mod.ts";
+export * from "./07/mod.ts";
+export * from "./42/mod.ts";

std/deno.json

@@ -4,10 +4,17 @@
   "exports": {
     ".": "./mod.ts",
     "./env": "./env.ts",
-    "./events": "./events.ts",
-    "./notes": "./notes.ts",
     "./pools": "./pools.ts",
     "./signs": "./signs.ts",
     "./times": "./times.ts"
+  },
+  "imports": {
+    "@std/dotenv": "jsr:@std/dotenv@^0.219.1",
+    "@std/streams": "jsr:@std/streams@^0.219.1",
+    "@lophus/lib": "jsr:@lophus/lib@^0.0.14",
+    "@lophus/core": "jsr:@lophus/core@^0.0.14"
+  },
+  "publish": {
+    "exclude": ["*_test.ts"]
   }
 }

std/mod.ts

@@ -1,6 +1,4 @@
 export * from "./env.ts";
-export * from "./events.ts";
-export * from "./notes.ts";
 export * from "./times.ts";
 export * from "./signs.ts";
 export * from "./pools.ts";

std/notes.ts

@@ -1,10 +1,9 @@
-import type { Optional } from "@lophus/lib/types";
 import type { NostrEvent, RelayUrl } from "@lophus/core/protocol";
-import { type EventInit } from "@lophus/std/events";
+import { type EventInit } from "@lophus/std/signs";
 
 export type TextNote = EventInit<1>;
 
-export type TextNoteInit = Optional<TextNote, "kind">;
+export type TextNoteInit = Omit<TextNote, "kind">;
 
 export class TextNoteComposer extends TransformStream<TextNoteInit, TextNote> {
   constructor(readonly opts: { recommendedRelay?: RelayUrl } = {}) {