@nostrify/nostrify 0.46.8 → 0.46.10

package/.turbo/turbo-build.log

@@ -1,28 +1,19 @@
-
-> @nostrify/nostrify@0.46.7 build /home/sid/repos/nostrify/packages/nostrify
-> tsc -p tsconfig.json && node ../../esbuild.config.js --package ./
-
-
-  dist/NRelay1.js                       8.9kb
-  dist/NSchema.js                       5.6kb
-  dist/NPool.js                         5.0kb
-  dist/test/TestRelayServer.js          4.4kb
-  dist/NSet.js                          4.1kb
-  dist/NConnectSigner.js                3.9kb
-  dist/ln/LNURL.js                      3.3kb
-  dist/NBrowserSigner.js                2.6kb
-  dist/NIP98.js                         2.4kb
-  dist/uploaders/NostrBuildUploader.js  1.9kb
-  dist/uploaders/BlossomUploader.js     1.8kb
-  dist/test/MockRelay.js                1.4kb
-  dist/BunkerURI.js                     1.4kb
-  dist/NKinds.js                        1.1kb
-  dist/NIP05.js                         1.1kb
-  dist/NSecSigner.js                    1.1kb
-  dist/utils/Machina.js                 925b 
-  dist/NCache.js                        828b 
-  dist/mod.js                           752b 
-  dist/test/mod.js                      701b 
-  ...and 10 more output files...
-
-⚡ Done in 22ms
+
+
+> @nostrify/nostrify@0.46.9 build /home/sid/repos/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.
+npm warn Unknown env config "_jsr-registry". This will stop working in the next major version of npm.
+⠙Building with esbuild...
+
+  dist/NRelay1.js               8.9kb
+  dist/NSchema.js               5.8kb
+  dist/NPool.js                 5.0kb
+  dist/test/TestRelayServer.js  4.4kb
+  dist/NSet.js                  4.1kb
+  ...and 25 more output files...
+
+⚡ Done in 24ms
+Copying source files...
+Done!

package/.turbo/turbo-test.log

@@ -1,123 +1,91 @@
-
-> @nostrify/nostrify@0.46.7 test /home/sid/repos/nostrify/packages/nostrify
-> node --test "**/*.test.ts"
-
-✔ BunkerURI (3.139394ms)
-✔ BunkerURI.fromJSON (1.078848ms)
-✔ NBrowserSigner - without extension (6.464847ms)
-✔ NBrowserSigner - with extension polyfill (234.080428ms)
-✔ NBrowserSigner.nip44 - with extension polyfill (91.327807ms)
-✔ NBrowserSigner.nip04 - with extension polyfill (83.997199ms)
-✔ NBrowserSigner.getRelays - with extension polyfill (1.347041ms)
-✔ NBrowserSigner - missing nip44 support (7.24135ms)
-✔ NBrowserSigner - missing nip04 support (0.957463ms)
-✔ NBrowserSigner - feature detection (0.630183ms)
-✔ NCache (7.515339ms)
-✔ NConnectSigner.signEvent with nip04 encryption (279.362646ms)
-✔ NConnectSigner.signEvent with nip44 encryption (108.072198ms)
-✔ NIP05.lookup (127.775302ms)
-✔ NIP05.lookup with invalid values but valid profile pointer (11.722058ms)
-✔ NIP05.lookup with invalid document (13.281978ms)
-✔ NIP50.parseInput (3.655177ms)
-✔ NIP50.parseInput with negated token (0.487567ms)
-✔ NIP98.template (24.095253ms)
-✔ NIP98.template with payload (53.842113ms)
-✔ NIP98.verify (281.757944ms)
-✔ NIP98.verify fails with missing header (7.416304ms)
-✔ NIP98.verify fails with missing token (4.561446ms)
-✔ NIP98.verify fails with invalid token (9.659557ms)
-✔ NIP98.verify fails with invalid event (37.684884ms)
-✔ NIP98.verify fails with wrong event kind (62.228241ms)
-✔ NIP98.verify fails with wrong request URL (32.012672ms)
-✔ NIP98.verify fails with wrong request method (61.338176ms)
-✔ NIP98.verify fails with expired event (33.697888ms)
-✔ NIP98.verify fails with invalid payload (73.713885ms)
-✔ NKinds (2.137233ms)
-✔ NPool.query (1002.066008ms)
-✔ NPool.req (97.498969ms)
-✔ NPool.event (267.305626ms)
-✔ NRelay1.query (746.453455ms)
-✔ NRelay1.query mismatched filter (259.123715ms)
-✔ NRelay1.req (297.033979ms)
-✔ NRelay1.event (246.217138ms)
-﹣ NRelay1 backoff (1.75855ms) # SKIP
-▶ NRelay1 idleTimeout
-  ✔ websocket opens (43.318751ms)
-  ✔ websocket closes after idleTimeout (151.53622ms)
-  ✔ websocket wakes up during activity (20.337967ms)
-✔ NRelay1 idleTimeout (429.224616ms)
-✔ NRelay1.count rejects when the server sends CLOSED (223.243687ms)
-✔ NRelay1 closes when it receives a binary message (221.917598ms)
-✔ n.id (19.246617ms)
-✔ n.bech32 (5.666764ms)
-✔ n.filter (41.374213ms)
-✔ n.event (5.833826ms)
-✔ n.metadata (22.364081ms)
-✔ NSecSigner (265.119504ms)
-✔ NSecSigner.nip44 (70.579379ms)
-✔ NSet (36.583337ms)
-✔ NSet.add (replaceable) (0.930993ms)
-✔ NSet.add (parameterized) (1.035127ms)
-✔ NSet.add (deletion) (0.479884ms)
-✔ Construct a RelayError from the reason message (2.876998ms)
-✔ Throw a new RelayError if the OK message is false (0.544837ms)
-✔ LNURL.fromString (7.092726ms)
-✔ LNURL.fromLightningAddress (1.072702ms)
-✔ LNURL.toString (1.514522ms)
-✔ LNURL.getDetails (94.441569ms)
-✔ LNURL.getInvoice (8.24442ms)
-✔ ErrorRelay (123.796477ms)
-✔ MockRelay (3.191496ms)
-✔ BlossomUploader.upload (1004.663359ms)
-{
-  status: 'error',
-  message: 'Unauthorized, please provide a valid nip-98 token',
-  data: {}
-}
-✖ NostrBuildUploader.upload (1590.593336ms)
-✔ CircularSet (7.081691ms)
-✔ push, iterate, & close (104.057684ms)
-✔ close & reopen (0.858706ms)
-✔ aborts with signal (52.838065ms)
-✔ already aborted signal in constructor (0.887341ms)
-✔ push after abort (1.140029ms)
-✔ multiple messages in queue (0.695626ms)
-✔ N64 (8.897581ms)
-✔ N64.encodeEvent (0.552799ms)
-✔ N64.decodeEvent (1.49315ms)
-ℹ tests 77
-ℹ suites 0
-ℹ pass 75
-ℹ fail 1
-ℹ cancelled 0
-ℹ skipped 1
-ℹ todo 0
-ℹ duration_ms 3317.855572
-
-✖ failing tests:
-
-test at uploaders/NostrBuildUploader.test.ts:10:7
-✖ NostrBuildUploader.upload (1590.593336ms)
-  Error [ZodError]: [
-    {
-      "code": "invalid_type",
-      "expected": "array",
-      "received": "object",
-      "path": [
-        "data"
-      ],
-      "message": "Expected array, received object"
-    }
-  ]
-      at get error (file:///home/sid/repos/nostrify/node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.js:39:31)
-      at ZodObject.parse (file:///home/sid/repos/nostrify/node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.js:114:22)
-      at NostrBuildUploader.upload (file:///home/sid/repos/nostrify/packages/nostrify/uploaders/NostrBuildUploader.ts:51:48)
-      at process.processTicksAndRejections (node:internal/process/task_queues:105:5)
-      at async TestContext.<anonymous> (file:///home/sid/repos/nostrify/packages/nostrify/uploaders/NostrBuildUploader.test.ts:22:18)
-      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/sid/repos/nostrify/packages/nostrify/uploaders/NostrBuildUploader.test.ts:10:1 {
-    issues: [ { code: 'invalid_type', expected: 'array', received: 'object', path: [Array], message: 'Expected array, received object' } ],
-    [errors]: [ { code: 'invalid_type', expected: 'array', received: 'object', path: [Array], message: 'Expected array, received object' } ]
-  }
- ELIFECYCLE  Test failed. See above for more details.
+
+
+> @nostrify/nostrify@0.46.8 test /home/sid/repos/nostrify/packages/nostrify
+> node --test "**/*.test.ts"
+
+✔ BunkerURI (2.901722ms)
+✔ BunkerURI.fromJSON (0.681727ms)
+✔ NBrowserSigner - without extension (2.955361ms)
+✔ NBrowserSigner - with extension polyfill (142.479686ms)
+✔ NBrowserSigner.nip44 - with extension polyfill (63.176698ms)
+✔ NBrowserSigner.nip04 - with extension polyfill (94.046199ms)
+✔ NBrowserSigner.getRelays - with extension polyfill (1.225726ms)
+✔ NBrowserSigner - missing nip44 support (0.470316ms)
+✔ NBrowserSigner - missing nip04 support (0.596869ms)
+✔ NBrowserSigner - feature detection (0.692134ms)
+✔ NCache (4.463457ms)
+✔ NConnectSigner.signEvent with nip04 encryption (264.497854ms)
+✔ NConnectSigner.signEvent with nip44 encryption (151.108865ms)
+✔ NIP05.lookup (82.449297ms)
+✔ NIP05.lookup with invalid values but valid profile pointer (5.343535ms)
+✔ NIP05.lookup with invalid document (5.910931ms)
+✔ NIP50.parseInput (6.388441ms)
+✔ NIP50.parseInput with negated token (0.443007ms)
+✔ NIP98.template (3.769298ms)
+✔ NIP98.template with payload (18.668676ms)
+✔ NIP98.verify (102.562862ms)
+✔ NIP98.verify fails with missing header (4.419038ms)
+✔ NIP98.verify fails with missing token (2.752191ms)
+✔ NIP98.verify fails with invalid token (4.587427ms)
+✔ NIP98.verify fails with invalid event (16.989187ms)
+✔ NIP98.verify fails with wrong event kind (40.621459ms)
+✔ NIP98.verify fails with wrong request URL (41.071101ms)
+✔ NIP98.verify fails with wrong request method (62.625645ms)
+✔ NIP98.verify fails with expired event (20.760162ms)
+✔ NIP98.verify fails with invalid payload (51.97091ms)
+✔ NKinds (3.308412ms)
+✔ NPool.query (368.093259ms)
+✔ NPool.req (266.969001ms)
+✔ NPool.event (232.161184ms)
+✔ NRelay1.query (280.362725ms)
+✔ NRelay1.query mismatched filter (245.542477ms)
+✔ NRelay1.req (247.658198ms)
+✔ NRelay1.event (216.357493ms)
+﹣ NRelay1 backoff (0.334682ms) # SKIP
+▶ NRelay1 idleTimeout
+  ✔ websocket opens (40.531572ms)
+  ✔ websocket closes after idleTimeout (150.405626ms)
+  ✔ websocket wakes up during activity (14.544161ms)
+✔ NRelay1 idleTimeout (209.795356ms)
+✔ NRelay1.count rejects when the server sends CLOSED (6.440892ms)
+✔ NRelay1 closes when it receives a binary message (5.03225ms)
+✔ n.id (3.950608ms)
+✔ n.bech32 (1.817636ms)
+✔ n.filter (10.95275ms)
+✔ n.event (2.561941ms)
+✔ n.metadata (11.862022ms)
+✔ NSecSigner (178.164717ms)
+✔ NSecSigner.nip44 (31.935079ms)
+✔ NSet (19.978352ms)
+✔ NSet.add (replaceable) (0.615308ms)
+✔ NSet.add (parameterized) (0.985888ms)
+✔ NSet.add (deletion) (0.380918ms)
+✔ Construct a RelayError from the reason message (1.717692ms)
+✔ Throw a new RelayError if the OK message is false (0.750801ms)
+✔ LNURL.fromString (7.817616ms)
+✔ LNURL.fromLightningAddress (0.932529ms)
+✔ LNURL.toString (1.933713ms)
+✔ LNURL.getDetails (111.66131ms)
+✔ LNURL.getInvoice (13.562812ms)
+✔ ErrorRelay (112.209428ms)
+✔ MockRelay (3.019126ms)
+﹣ BlossomUploader.upload (1.127947ms) # SKIP
+﹣ NostrBuildUploader.upload (2.842008ms) # SKIP
+✔ CircularSet (2.247513ms)
+✔ push, iterate, & close (103.751782ms)
+✔ close & reopen (0.982257ms)
+✔ aborts with signal (51.656203ms)
+✔ already aborted signal in constructor (1.251916ms)
+✔ push after abort (0.906129ms)
+✔ multiple messages in queue (0.531637ms)
+✔ N64 (8.171994ms)
+✔ N64.encodeEvent (0.513338ms)
+✔ N64.decodeEvent (1.449988ms)
+ℹ tests 77
+ℹ suites 0
+ℹ pass 74
+ℹ fail 0
+ℹ cancelled 0
+ℹ skipped 3
+ℹ todo 0
+ℹ duration_ms 2192.909865

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## 0.46.10
+
+### Patch Changes
+
+- distribute ts files
+- Updated dependencies
+  - @nostrify/types@0.36.6
+
+## 0.46.9
+
+### Patch Changes
+
+- tests should pass now
+- Updated dependencies
+  - @nostrify/types@0.36.5
+
 ## 0.46.8
 
 ### Patch Changes

package/NIP05.ts

@@ -1,6 +1,6 @@
-import type { NProfilePointer } from '@nostrify/types';
+import type { NProfilePointer } from "@nostrify/types";
 
-import { NSchema as n, z } from './NSchema.ts';
+import { NSchema as n, z } from "./NSchema.ts";
 
 interface LookupOpts {
   fetch?: typeof fetch;
@@ -18,7 +18,7 @@ export class NIP05 {
     return z.object({
       pubkey: n.id(),
       relays: n.relayUrl().array().optional(),
-    });
+    }) as z.ZodType<NProfilePointer>;
   }
 
   /** Resolve NIP-05 name to a profile pointer. */
@@ -31,10 +31,10 @@ export class NIP05 {
     const match = nip05.match(NIP05.regex());
     if (!match) throw new Error(`NIP-05: invalid name ${nip05}`);
 
-    const [_, name = '_', domain] = match;
+    const [_, name = "_", domain] = match;
 
-    const url = new URL('/.well-known/nostr.json', `https://${domain}/`);
-    url.searchParams.set('name', name);
+    const url = new URL("/.well-known/nostr.json", `https://${domain}/`);
+    url.searchParams.set("name", name);
 
     const response = await fetch(url, { signal });
     const json = await response.json();

package/NSchema.ts

@@ -1,4 +1,4 @@
-import { z } from 'zod';
+import { z } from "zod";
 
 import type {
   NostrClientAUTH,
@@ -20,7 +20,7 @@ import type {
   NostrRelayMsg,
   NostrRelayNOTICE,
   NostrRelayOK,
-} from '@nostrify/types';
+} from "@nostrify/types";
 
 /**
  * A suite of [zod](https://github.com/colinhacks/zod) schemas for Nostr.
@@ -50,7 +50,15 @@ class NSchema {
       content: z.string(),
       created_at: z.number().int().nonnegative(),
       sig: z.string(),
-    });
+    }).required({
+      id: true,
+      kind: true,
+      pubkey: true,
+      tags: true,
+      content: true,
+      created_at: true,
+      sig: true,
+    }) as z.ZodType<NostrEvent>;
   }
 
   /** Nostr filter schema. */
@@ -67,16 +75,16 @@ class NSchema {
       .passthrough()
       .transform((value) => {
         const keys = [
-          'kinds',
-          'ids',
-          'authors',
-          'since',
-          'until',
-          'limit',
-          'search',
+          "kinds",
+          "ids",
+          "authors",
+          "since",
+          "until",
+          "limit",
+          "search",
         ];
         return Object.entries(value).reduce((acc, [key, val]) => {
-          if (keys.includes(key) || key.startsWith('#')) {
+          if (keys.includes(key) || key.startsWith("#")) {
             acc[key] = val;
           }
           return acc;
@@ -92,7 +100,9 @@ class NSchema {
     return z
       .string()
       .regex(/^[\x21-\x7E]{1,83}1[023456789acdefghjklmnpqrstuvwxyz]{6,}$/)
-      .refine((value) => prefix ? value.startsWith(`${prefix}1`) : true) as z.ZodType<`${P}1${string}`>;
+      .refine((value) =>
+        prefix ? value.startsWith(`${prefix}1`) : true
+      ) as z.ZodType<`${P}1${string}`>;
   }
 
   /** WebSocket URL starting with `ws://` or `wss://`. */
@@ -105,27 +115,39 @@ class NSchema {
 
   /** NIP-01 `EVENT` message from client to relay. */
   static clientEVENT(): z.ZodType<NostrClientEVENT> {
-    return z.tuple([z.literal('EVENT'), NSchema.event()]);
+    return z.tuple([
+      z.literal("EVENT"),
+      NSchema.event(),
+    ]) as unknown as z.ZodType<
+      NostrClientEVENT
+    >;
   }
 
   /** NIP-01 `REQ` message from client to relay. */
   static clientREQ(): z.ZodType<NostrClientREQ> {
-    return z.tuple([z.literal('REQ'), z.string()]).rest(NSchema.filter());
+    return z.tuple([z.literal("REQ"), z.string()]).rest(NSchema.filter());
   }
 
   /** NIP-45 `COUNT` message from client to relay. */
   static clientCOUNT(): z.ZodType<NostrClientCOUNT> {
-    return z.tuple([z.literal('COUNT'), z.string()]).rest(NSchema.filter());
+    return z.tuple([z.literal("COUNT"), z.string()]).rest(NSchema.filter());
   }
 
   /** NIP-01 `CLOSE` message from client to relay. */
   static clientCLOSE(): z.ZodType<NostrClientCLOSE> {
-    return z.tuple([z.literal('CLOSE'), z.string()]);
+    return z.tuple([z.literal("CLOSE"), z.string()]) as unknown as z.ZodType<
+      NostrClientCLOSE
+    >;
   }
 
   /** NIP-42 `AUTH` message from client to relay. */
   static clientAUTH(): z.ZodType<NostrClientAUTH> {
-    return z.tuple([z.literal('AUTH'), NSchema.event()]);
+    return z.tuple([
+      z.literal("AUTH"),
+      NSchema.event(),
+    ]) as unknown as z.ZodType<
+      NostrClientAUTH
+    >;
   }
 
   /** NIP-01 message from client to relay. */
@@ -136,49 +158,68 @@ class NSchema {
       NSchema.clientCOUNT(),
       NSchema.clientCLOSE(),
       NSchema.clientAUTH(),
-    ]);
+    ]) as z.ZodType<NostrClientMsg>;
   }
 
   /** NIP-01 `EVENT` message from relay to client. */
   static relayEVENT(): z.ZodType<NostrRelayEVENT> {
-    return z.tuple([z.literal('EVENT'), z.string(), NSchema.event()]);
+    return z.tuple([
+      z.literal("EVENT"),
+      z.string(),
+      NSchema.event(),
+    ]) as unknown as z.ZodType<NostrRelayEVENT>;
   }
 
   /** NIP-01 `OK` message from relay to client. */
   static relayOK(): z.ZodType<NostrRelayOK> {
-    return z.tuple([z.literal('OK'), NSchema.id(), z.boolean(), z.string()]);
+    return z.tuple([
+      z.literal("OK"),
+      NSchema.id(),
+      z.boolean(),
+      z.string(),
+    ]) as unknown as z.ZodType<NostrRelayOK>;
   }
 
   /** NIP-01 `EOSE` message from relay to client. */
   static relayEOSE(): z.ZodType<NostrRelayEOSE> {
-    return z.tuple([z.literal('EOSE'), z.string()]);
+    return z.tuple([z.literal("EOSE"), z.string()]) as unknown as z.ZodType<
+      NostrRelayEOSE
+    >;
   }
 
   /** NIP-01 `NOTICE` message from relay to client. */
   static relayNOTICE(): z.ZodType<NostrRelayNOTICE> {
-    return z.tuple([z.literal('NOTICE'), z.string()]);
+    return z.tuple([z.literal("NOTICE"), z.string()]) as unknown as z.ZodType<
+      NostrRelayNOTICE
+    >;
   }
 
   /** NIP-01 `CLOSED` message from relay to client. */
   static relayCLOSED(): z.ZodType<NostrRelayCLOSED> {
-    return z.tuple([z.literal('CLOSED'), z.string(), z.string()]);
+    return z.tuple([
+      z.literal("CLOSED"),
+      z.string(),
+      z.string(),
+    ]) as unknown as z.ZodType<NostrRelayCLOSED>;
   }
 
   /** NIP-42 `AUTH` message from relay to client. */
   static relayAUTH(): z.ZodType<NostrRelayAUTH> {
-    return z.tuple([z.literal('AUTH'), z.string()]);
+    return z.tuple([z.literal("AUTH"), z.string()]) as unknown as z.ZodType<
+      NostrRelayAUTH
+    >;
   }
 
   /** NIP-45 `COUNT` message from relay to client. */
   static relayCOUNT(): z.ZodType<NostrRelayCOUNT> {
     return z.tuple([
-      z.literal('COUNT'),
+      z.literal("COUNT"),
       z.string(),
       z.object({
         count: z.number().int().nonnegative(),
         approximate: z.boolean().optional(),
       }),
-    ]);
+    ]) as unknown as z.ZodType<NostrRelayCOUNT>;
   }
 
   /** NIP-01 message from relay to client. */
@@ -201,7 +242,7 @@ class NSchema {
       banner: z.string().url().optional().catch(undefined),
       bot: z.boolean().optional().catch(undefined),
       display_name: z.string().optional().catch(undefined),
-      lud06: NSchema.bech32('lnurl').optional().catch(undefined),
+      lud06: NSchema.bech32("lnurl").optional().catch(undefined),
       lud16: z.string().email().optional().catch(undefined),
       name: z.string().optional().catch(undefined),
       nip05: z.string().email().optional().catch(undefined),
@@ -216,7 +257,7 @@ class NSchema {
       id: z.string(),
       method: z.string(),
       params: z.string().array(),
-    });
+    }) as z.ZodType<NostrConnectRequest>;
   }
 
   /** NIP-46 response content schema. */
@@ -225,7 +266,7 @@ class NSchema {
       id: z.string(),
       result: z.string(),
       error: z.string().optional(),
-    });
+    }) as z.ZodType<NostrConnectResponse>;
   }
 
   /**
@@ -240,7 +281,7 @@ class NSchema {
       try {
         return JSON.parse(value) as unknown;
       } catch (_e) {
-        ctx.addIssue({ code: z.ZodIssueCode.custom, message: 'Invalid JSON' });
+        ctx.addIssue({ code: z.ZodIssueCode.custom, message: "Invalid JSON" });
         return z.NEVER;
       }
     });

package/dist/BunkerURI.ts

@@ -0,0 +1,58 @@
+/** Construct a [NIP-46](https://github.com/nostr-protocol/nips/blob/master/46.md) bunker URI. */
+export class BunkerURI {
+  /** Remote signer pubkey. */
+  pubkey: string;
+  /** Relay URLs on which the client is listening for responses from the remote-signer. */
+  relays: string[];
+  /** A short random string that the remote-signer should return as the `result` field of its response. */
+  secret?: string;
+
+  constructor(uri: string) {
+    const url = new URL(uri);
+    const params = new URLSearchParams(url.search);
+
+    // https://github.com/denoland/deno/issues/26440
+    const pubkey = url.hostname || url.pathname.slice(2);
+    const relays = params.getAll('relay');
+    const secret = params.get('secret') ?? undefined;
+
+    if (!pubkey) {
+      throw new Error('Invalid bunker URI');
+    }
+
+    this.pubkey = pubkey;
+    this.relays = relays;
+    this.secret = secret;
+  }
+
+  /** Convert into a `bunker://` URI string. */
+  get href(): string {
+    return this.toString();
+  }
+
+  /** Convert into a `bunker://` URI string. */
+  toString(): string {
+    return BunkerURI.toString(this);
+  }
+
+  /** Convert a bunker data object into a `BunkerURI` instance. */
+  static fromJSON(data: { pubkey: string; relays: string[]; secret?: string }): BunkerURI {
+    const uri = BunkerURI.toString(data);
+    return new BunkerURI(uri);
+  }
+
+  /** Convert a bunker data object into a bunker URI string. */
+  private static toString(data: { pubkey: string; relays: string[]; secret?: string }): string {
+    const search = new URLSearchParams();
+
+    for (const relay of data.relays) {
+      search.append('relay', relay);
+    }
+
+    if (data.secret) {
+      search.set('secret', data.secret);
+    }
+
+    return `bunker://${data.pubkey}?${search.toString()}`;
+  }
+}