@nostrify/nostrify 0.48.2 → 0.49.0

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
 
-> @nostrify/nostrify@0.48.1 build /home/sid/repos/nostrify/packages/nostrify
+> @nostrify/nostrify@0.48.3 build /home/alex/Projects/nostrify/packages/nostrify
 > npx tsc -p tsconfig.json && node ../../esbuild.config.js --package ./
 
 npm warn Unknown env config "verify-deps-before-run". This will stop working in the next major version of npm.
@@ -8,7 +8,7 @@ Building with esbuild...
 
   dist/NRelay1.js                       8.9kb
   dist/NSchema.js                       5.8kb
-  dist/NPool.js                         5.0kb
+  dist/NPool.js                         5.4kb
   dist/test/TestRelayServer.js          4.4kb
   dist/NSet.js                          4.1kb
   dist/NConnectSigner.js                3.9kb
@@ -28,6 +28,5 @@ Building with esbuild...
   dist/test/mod.js                      701b 
   ...and 11 more output files...
 
-⚡ Done in 31ms
-Copying source files...
+⚡ Done in 21ms
 Done!

package/.turbo/turbo-test.log

@@ -0,0 +1,112 @@
+
+> @nostrify/nostrify@0.48.3 test /home/alex/Projects/nostrify/packages/nostrify
+> node --test "**/*.test.ts" NPool.test.ts
+
+✔ BunkerURI (3.103099ms)
+✔ BunkerURI.fromJSON (0.946417ms)
+✔ NBrowserSigner - without extension (2.589198ms)
+✔ NBrowserSigner - with extension polyfill (119.959927ms)
+✔ NBrowserSigner.nip44 - with extension polyfill (52.91706ms)
+✔ NBrowserSigner.nip04 - with extension polyfill (26.596641ms)
+✔ NBrowserSigner.getRelays - with extension polyfill (2.472527ms)
+✔ NBrowserSigner - missing nip44 support (0.590565ms)
+✔ NBrowserSigner - missing nip04 support (0.438438ms)
+✔ NBrowserSigner - feature detection (2.027338ms)
+✔ NCache (5.240283ms)
+✔ NConnectSigner.signEvent with nip04 encryption (176.945128ms)
+✔ NConnectSigner.signEvent with nip44 encryption (48.644554ms)
+✔ NIP05.lookup (62.16534ms)
+✔ NIP05.lookup with invalid values but valid profile pointer (7.565914ms)
+✔ NIP05.lookup with invalid document (8.293136ms)
+✔ NIP50.parseInput (3.720895ms)
+✔ NIP50.parseInput with negated token (0.516845ms)
+✔ NIP98.template (5.089398ms)
+✔ NIP98.template with payload (25.784117ms)
+✔ NIP98.verify (147.280886ms)
+✔ NIP98.verify fails with missing header (2.366208ms)
+✔ NIP98.verify fails with missing token (2.93968ms)
+✔ NIP98.verify fails with invalid token (1.902872ms)
+✔ NIP98.verify fails with invalid event (19.228631ms)
+✔ NIP98.verify fails with wrong event kind (43.698948ms)
+✔ NIP98.verify fails with wrong request URL (28.101031ms)
+✔ NIP98.verify fails with wrong request method (16.899954ms)
+✔ NIP98.verify fails with expired event (11.929701ms)
+✔ NIP98.verify fails with invalid payload (22.675508ms)
+✔ NIP98Client.fetch - basic GET request (148.088681ms)
+✔ NIP98Client.fetch - POST request with body (61.272434ms)
+✔ NIP98Client.fetch - with Request object input (20.816298ms)
+✔ NIP98Client.fetch - with URL object input (13.590767ms)
+✔ NIP98Client.fetch - uses default fetch when not provided (11.116957ms)
+✔ NIP98Client.fetch - preserves existing headers (10.24455ms)
+✔ NIP98Client.fetch - event can be verified with NIP98.verify (20.715648ms)
+✔ NIP98Client.fetch - handles different HTTP methods (42.038683ms)
+✔ NKinds (2.178663ms)
+✔ NPool.query (241.171699ms)
+✔ NPool.req (46.962439ms)
+✔ NPool.event (23.769734ms)
+✔ NPool.query with eoseTimeout (539.078185ms)
+✔ NPool.query with eoseTimeout disabled (513.370943ms)
+✔ NRelay1.query (211.675544ms)
+✔ NRelay1.query mismatched filter (23.228492ms)
+✔ NRelay1.req (39.130493ms)
+✔ NRelay1.event (10.531752ms)
+﹣ NRelay1 backoff (0.314695ms) # SKIP
+▶ NRelay1 idleTimeout
+  ✔ websocket opens (3.120731ms)
+  ✔ websocket closes after idleTimeout (150.272113ms)
+  ✔ websocket wakes up during activity (13.881526ms)
+✔ NRelay1 idleTimeout (171.04005ms)
+✔ NRelay1.count rejects when the server sends CLOSED (4.5074ms)
+✔ NRelay1 closes when it receives a binary message (3.958042ms)
+✔ n.id (4.218825ms)
+✔ n.bech32 (2.260858ms)
+✔ n.filter (10.493851ms)
+✔ n.event (4.264811ms)
+✔ n.metadata (12.16193ms)
+✔ NSecSigner (144.76192ms)
+✔ NSecSigner.nip44 (46.572963ms)
+✔ NSet (22.349102ms)
+✔ NSet.add (replaceable) (0.442686ms)
+✔ NSet.add (parameterized) (0.812003ms)
+✔ NSet.add (deletion) (0.396319ms)
+✔ Construct a RelayError from the reason message (2.506081ms)
+✔ Throw a new RelayError if the OK message is false (0.543135ms)
+✔ LNURL.fromString (6.121727ms)
+✔ LNURL.fromLightningAddress (1.103623ms)
+✔ LNURL.toString (1.355309ms)
+✔ LNURL.getDetails (51.878139ms)
+✔ LNURL.getInvoice (4.968249ms)
+✔ ErrorRelay (101.168282ms)
+✔ MockRelay (3.234627ms)
+✔ BlossomUploader.upload (582.794766ms)
+✖ NostrBuildUploader.upload (13.017756ms)
+✔ CircularSet (8.83538ms)
+✔ push, iterate, & close (103.505875ms)
+✔ close & reopen (0.598761ms)
+✔ aborts with signal (51.591307ms)
+✔ already aborted signal in constructor (0.68864ms)
+✔ push after abort (0.767599ms)
+✔ multiple messages in queue (0.448797ms)
+✔ N64 (7.090686ms)
+✔ N64.encodeEvent (0.411437ms)
+✔ N64.decodeEvent (1.08019ms)
+ℹ tests 87
+ℹ suites 0
+ℹ pass 85
+ℹ fail 1
+ℹ cancelled 0
+ℹ skipped 1
+ℹ todo 0
+ℹ duration_ms 2955.079793
+
+✖ failing tests:
+
+test at uploaders/NostrBuildUploader.test.ts:12:7
+✖ NostrBuildUploader.upload (13.017756ms)
+  Error: nostr.build with default uploader requires a secret key to be configured
+      at TestContext.<anonymous> (file:///home/alex/Projects/nostrify/packages/nostrify/uploaders/NostrBuildUploader.test.ts:25:13)
+      at process.processTicksAndRejections (node:internal/process/task_queues:105:5)
+      at async Test.run (node:internal/test_runner/test:1088:7)
+      at async startSubtestAfterBootstrap (node:internal/test_runner/harness:332:3)
+      at async file:///home/alex/Projects/nostrify/packages/nostrify/uploaders/NostrBuildUploader.test.ts:12:1
+ ELIFECYCLE  Test failed. See above for more details.

package/.turbo/turbo-typecheck.log

@@ -1,5 +1,5 @@
 
-> @nostrify/nostrify@0.48.1 typecheck /home/sid/repos/nostrify/packages/nostrify
+> @nostrify/nostrify@0.48.3 typecheck /home/alex/Projects/nostrify/packages/nostrify
 > npx tsc --noEmit
 
 npm warn Unknown env config "verify-deps-before-run". This will stop working in the next major version of npm.

package/CHANGELOG.md

@@ -1,5 +1,29 @@
 # Changelog
 
+## 0.49.0
+
+### Minor Changes
+
+- Add configurable EOSE timeout to NPool to prevent slow relays from degrading query performance
+
+  Added a new `eoseTimeout` option to `NPoolOpts` that starts a timer after the first relay sends EOSE. This prevents slow relays from blocking queries while still giving them reasonable time to respond.
+
+  Key features:
+
+  - Defaults to 1000ms timeout after first EOSE
+  - Set to 0 to disable and wait for all relays (previous behavior)
+  - Configurable via `eoseTimeout` in NPool constructor options
+
+  This significantly improves query performance when using relay pools with varying response times.
+
+## 0.48.3
+
+### Patch Changes
+
+- Fix TypeScript import errors by removing source .ts files from dist directory
+- Updated dependencies
+  - @nostrify/types@0.36.9
+
 ## 0.48.2
 
 ### Patch Changes

package/NPool.test.ts

@@ -126,3 +126,103 @@ await test("NPool.event", async () => {
 
   clearTimeout(tid);
 });
+
+await test("NPool.query with eoseTimeout", async () => {
+  const controller = new AbortController();
+  const tid = setTimeout(() => controller.abort(), 5000);
+
+  await using server1 = await TestRelayServer.create();
+  
+  // Create a slow server that delays EOSE by 2 seconds
+  await using server2 = await TestRelayServer.create({
+    async handleMessage(socket, msg) {
+      if (msg[0] === 'REQ') {
+        const [_, subId, ...filters] = msg;
+        // Send events first
+        for (const event of event1s) {
+          socket.send(JSON.stringify(['EVENT', subId, event]));
+        }
+        // Delay EOSE by 2 seconds
+        await new Promise((resolve) => setTimeout(resolve, 2000));
+        socket.send(JSON.stringify(['EOSE', subId]));
+      }
+    },
+  });
+
+  for (const event of event1s) {
+    await server1.event(event);
+  }
+
+  const pool = new NPool({
+    open: (url) => new NRelay1(url),
+    reqRouter: (filters) =>
+      new Map([
+        [server1.url, filters],
+        [server2.url, filters],
+      ]),
+    eventRouter: () => [server1.url],
+    eoseTimeout: 500, // 500ms timeout after first EOSE
+  });
+
+  const startTime = Date.now();
+  const events = await pool.query([{ kinds: [1], limit: 15 }]);
+  const duration = Date.now() - startTime;
+
+  // Should return events from the fast relay
+  deepStrictEqual(events.length, 10);
+  
+  // Should complete in less than 1 second (500ms fast relay + 500ms timeout)
+  // Not wait for the slow relay's 2 second delay
+  ok(duration < 1500, `Expected duration < 1500ms, got ${duration}ms`);
+  
+  await pool.close();
+  clearTimeout(tid);
+});
+
+await test("NPool.query with eoseTimeout disabled", async () => {
+  const controller = new AbortController();
+  const tid = setTimeout(() => controller.abort(), 5000);
+
+  await using server1 = await TestRelayServer.create();
+  
+  // Create a slow server that delays EOSE by 500ms
+  await using server2 = await TestRelayServer.create({
+    async handleMessage(socket, msg) {
+      if (msg[0] === 'REQ') {
+        const [_, subId, ...filters] = msg;
+        for (const event of event1s) {
+          socket.send(JSON.stringify(['EVENT', subId, event]));
+        }
+        await new Promise((resolve) => setTimeout(resolve, 500));
+        socket.send(JSON.stringify(['EOSE', subId]));
+      }
+    },
+  });
+
+  for (const event of event1s) {
+    await server1.event(event);
+  }
+
+  const pool = new NPool({
+    open: (url) => new NRelay1(url),
+    reqRouter: (filters) =>
+      new Map([
+        [server1.url, filters],
+        [server2.url, filters],
+      ]),
+    eventRouter: () => [server1.url],
+    eoseTimeout: 0, // Disable timeout
+  });
+
+  const startTime = Date.now();
+  const events = await pool.query([{ kinds: [1], limit: 15 }]);
+  const duration = Date.now() - startTime;
+
+  deepStrictEqual(events.length, 10);
+  
+  // Should wait for both relays to finish (at least 500ms for the slow one)
+  ok(duration >= 400, `Expected duration >= 400ms, got ${duration}ms`);
+  
+  await pool.close();
+  clearTimeout(tid);
+});

package/NPool.ts

@@ -23,6 +23,8 @@ export interface NPoolOpts<T extends NRelay> {
     | Promise<ReadonlyMap<string, NostrFilter[]>>;
   /** Determines the relays to use for publishing the given event. To support the Outbox model, it should analyze the `pubkey` field of the event. */
   eventRouter(event: NostrEvent): string[] | Promise<string[]>;
+  /** Maximum time in milliseconds to wait for remaining relays after the first EOSE is received in query(). Defaults to 1000ms. Set to 0 to disable timeout. */
+  eoseTimeout?: number;
 }
 
 /**
@@ -121,6 +123,9 @@ export class NPool<T extends NRelay = NRelay> implements NRelay {
     const closes = new Set<string>();
     const events = new CircularSet<string>(1000);
 
+    const eoseTimeout = this.opts.eoseTimeout ?? 1000;
+    let timeoutId: ReturnType<typeof setTimeout> | undefined;
+
     const relayPromises: Promise<void>[] = [];
 
     for (const [url, filters] of routes.entries()) {
@@ -130,6 +135,12 @@ export class NPool<T extends NRelay = NRelay> implements NRelay {
           for await (const msg of relay.req(filters, { signal })) {
             if (msg[0] === 'EOSE') {
               eoses.add(url);
+              // Start timeout after first EOSE if timeout is enabled
+              if (eoses.size === 1 && eoseTimeout > 0 && timeoutId === undefined) {
+                timeoutId = setTimeout(() => {
+                  controller.abort();
+                }, eoseTimeout);
+              }
               if (eoses.size === routes.size) {
                 machina.push(msg);
               }
@@ -160,6 +171,9 @@ export class NPool<T extends NRelay = NRelay> implements NRelay {
         yield msg;
       }
     } finally {
+      if (timeoutId !== undefined) {
+        clearTimeout(timeoutId);
+      }
       controller.abort();
       // Wait for all relay promises to complete to prevent hanging promises
       await Promise.allSettled(relayPromises);

package/dist/NPool.d.ts

@@ -6,6 +6,8 @@ export interface NPoolOpts<T extends NRelay> {
     reqRouter(filters: NostrFilter[]): ReadonlyMap<string, NostrFilter[]> | Promise<ReadonlyMap<string, NostrFilter[]>>;
     /** Determines the relays to use for publishing the given event. To support the Outbox model, it should analyze the `pubkey` field of the event. */
     eventRouter(event: NostrEvent): string[] | Promise<string[]>;
+    /** Maximum time in milliseconds to wait for remaining relays after the first EOSE is received in query(). Defaults to 1000ms. Set to 0 to disable timeout. */
+    eoseTimeout?: number;
 }
 /**
  * The `NPool` class is a `NRelay` implementation for connecting to multiple relays.

package/dist/NPool.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"NPool.d.ts","sourceRoot":"","sources":["../NPool.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,UAAU,EACV,WAAW,EACX,gBAAgB,EAChB,cAAc,EACd,eAAe,EACf,MAAM,EACP,MAAM,iBAAiB,CAAC;AAOzB,MAAM,WAAW,SAAS,CAAC,CAAC,SAAS,MAAM;IACzC,sDAAsD;IACtD,IAAI,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,CAAC;IACrB,8JAA8J;IAC9J,SAAS,CACP,OAAO,EAAE,WAAW,EAAE,GAEpB,WAAW,CAAC,MAAM,EAAE,WAAW,EAAE,CAAC,GAClC,OAAO,CAAC,WAAW,CAAC,MAAM,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC;IAChD,mJAAmJ;IACnJ,WAAW,CAAC,KAAK,EAAE,UAAU,GAAG,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;CAC9D;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,qBAAa,KAAK,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,CAAE,YAAW,MAAM;IAC7D,OAAO,CAAC,OAAO,CAAwB;IACvC,OAAO,CAAC,IAAI,CAAe;gBAEf,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC;IAI9B,wDAAwD;IACjD,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC;IAY5B,6GAA6G;IACtG,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC;IAQtC,IAAW,MAAM,IAAI,WAAW,CAAC,MAAM,EAAE,CAAC,CAAC,CAE1C;IAED;;;;;;;;;OASG;IACI,GAAG,CACR,OAAO,EAAE,WAAW,EAAE,EACtB,IAAI,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,WAAW,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;KAAE,GACjD,aAAa,CAAC,eAAe,GAAG,cAAc,GAAG,gBAAgB,CAAC;IAiErE;;;;OAIG;IACG,KAAK,CACT,KAAK,EAAE,UAAU,EACjB,IAAI,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,WAAW,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;KAAE,GACjD,OAAO,CAAC,IAAI,CAAC;IAahB;;;;;;;;;;;OAWG;IACG,KAAK,CACT,OAAO,EAAE,WAAW,EAAE,EACtB,IAAI,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,WAAW,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;KAAE,GACjD,OAAO,CAAC,UAAU,EAAE,CAAC;IA4BxB,wCAAwC;IAClC,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAMtB,CAAC,MAAM,CAAC,YAAY,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC;CAG7C"}
+{"version":3,"file":"NPool.d.ts","sourceRoot":"","sources":["../NPool.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,UAAU,EACV,WAAW,EACX,gBAAgB,EAChB,cAAc,EACd,eAAe,EACf,MAAM,EACP,MAAM,iBAAiB,CAAC;AAOzB,MAAM,WAAW,SAAS,CAAC,CAAC,SAAS,MAAM;IACzC,sDAAsD;IACtD,IAAI,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,CAAC;IACrB,8JAA8J;IAC9J,SAAS,CACP,OAAO,EAAE,WAAW,EAAE,GAEpB,WAAW,CAAC,MAAM,EAAE,WAAW,EAAE,CAAC,GAClC,OAAO,CAAC,WAAW,CAAC,MAAM,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC;IAChD,mJAAmJ;IACnJ,WAAW,CAAC,KAAK,EAAE,UAAU,GAAG,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IAC7D,8JAA8J;IAC9J,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,qBAAa,KAAK,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,CAAE,YAAW,MAAM;IAC7D,OAAO,CAAC,OAAO,CAAwB;IACvC,OAAO,CAAC,IAAI,CAAe;gBAEf,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC;IAI9B,wDAAwD;IACjD,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC;IAY5B,6GAA6G;IACtG,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC;IAQtC,IAAW,MAAM,IAAI,WAAW,CAAC,MAAM,EAAE,CAAC,CAAC,CAE1C;IAED;;;;;;;;;OASG;IACI,GAAG,CACR,OAAO,EAAE,WAAW,EAAE,EACtB,IAAI,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,WAAW,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;KAAE,GACjD,aAAa,CAAC,eAAe,GAAG,cAAc,GAAG,gBAAgB,CAAC;IA6ErE;;;;OAIG;IACG,KAAK,CACT,KAAK,EAAE,UAAU,EACjB,IAAI,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,WAAW,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;KAAE,GACjD,OAAO,CAAC,IAAI,CAAC;IAahB;;;;;;;;;;;OAWG;IACG,KAAK,CACT,OAAO,EAAE,WAAW,EAAE,EACtB,IAAI,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,WAAW,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;KAAE,GACjD,OAAO,CAAC,UAAU,EAAE,CAAC;IA4BxB,wCAAwC;IAClC,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAMtB,CAAC,MAAM,CAAC,YAAY,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC;CAG7C"}

package/dist/NPool.js

@@ -51,6 +51,8 @@ class NPool {
     const eoses = /* @__PURE__ */ new Set();
     const closes = /* @__PURE__ */ new Set();
     const events = new CircularSet(1e3);
+    const eoseTimeout = this.opts.eoseTimeout ?? 1e3;
+    let timeoutId;
     const relayPromises = [];
     for (const [url, filters2] of routes.entries()) {
       const relay = this.relay(url);
@@ -59,6 +61,11 @@ class NPool {
           for await (const msg of relay.req(filters2, { signal })) {
             if (msg[0] === "EOSE") {
               eoses.add(url);
+              if (eoses.size === 1 && eoseTimeout > 0 && timeoutId === void 0) {
+                timeoutId = setTimeout(() => {
+                  controller.abort();
+                }, eoseTimeout);
+              }
               if (eoses.size === routes.size) {
                 machina.push(msg);
               }
@@ -87,6 +94,9 @@ class NPool {
         yield msg;
       }
     } finally {
+      if (timeoutId !== void 0) {
+        clearTimeout(timeoutId);
+      }
       controller.abort();
       await Promise.allSettled(relayPromises);
     }