@nostrify/nostrify 0.46.4

package/README.md

@@ -0,0 +1,314 @@
+# Nostrify
+
+Bring your projects to life on Nostr. 🌱
+
+Nostrify is a Nostr framework for web browsers and Deno. It's made up of of simple modules that can be used independently, or swapped out with your own implementations.
+
+Use it alongside nostr-tools, NDK, or your existing application. Nostrify can be gradually adopted and plays nice with others.
+
+## Schema
+
+A suite of [zod](https://github.com/colinhacks/zod) schemas for Nostr are available in the `NSchema` module.
+
+```ts
+import { NSchema as n } from '@nostrify/nostrify';
+
+const event: NostrEvent = n.event().parse(eventData);
+const metadata: NostrMetadata = n.json().pipe(n.metadata()).parse(event.content);
+const msg: NostrRelayMsg = n.relayMsg().parse(e.data);
+const nsec: `nsec1${string}` = n.bech32('nsec').parse(token);
+```
+
+## Storages
+
+Storages (implementing the `NStore` interface) allow interacting with Nostr events.
+A database is a Storage. A relay is a Storage. A cache is a Storage.
+It should be possible to use Nostr storages interchangeably to get the best performance.
+
+### `NStore` interface
+
+`NStore` is the interface that all Nostr Storages implement.
+
+```ts
+/** Nostr event store. */
+interface NStore {
+  /** Add an event to the store (equivalent of `EVENT` verb). */
+  event(event: NostrEvent, opts?: NStoreOpts): Promise<void>;
+  /** Get an array of events matching filters. */
+  query(filters: NostrFilter[], opts?: NStoreOpts): Promise<NostrEvent[]>;
+  /** Get the number of events matching filters (equivalent of `COUNT` verb). */
+  count?(filters: NostrFilter[], opts?: NStoreOpts): Promise<NostrRelayCOUNT[2]>;
+  /** Remove events from the store. This action is temporary, unless a kind `5` deletion is issued. */
+  remove?(filters: NostrFilter[], opts?: NStoreOpts): Promise<void>;
+}
+```
+
+### `NCache` class
+
+Nostr LRU cache based on [`npm:lru-cache`](https://www.npmjs.com/package/lru-cache).
+It implements both `NStore` and `NSet` interfaces.
+
+```ts
+// Accepts the options of `npm:lru-cache`:
+const cache = new NCache({ max: 1000 });
+
+// Events can be added like a regular `Set`:
+cache.add(event1);
+cache.add(event2);
+
+// Can be queried like `NStore`:
+const events = await cache.query([{ kinds: [1] }]);
+
+// Can be iterated like `NSet`:
+for (const event of cache) {
+  console.log(event);
+}
+```
+
+### `NDatabase` class
+
+SQLite database storage adapter for Nostr events.
+It uses [Kysely](https://kysely.dev/) to make queries, making it flexible for a variety of use-cases.
+
+```ts
+// Create a Kysely instance.
+const kysely = new Kysely({
+  dialect: new DenoSqliteDialect({
+    database: new Sqlite('./db.sqlite3'),
+  }),
+});
+
+// Pass Kysely into the constructor.
+const db = new NDatabase(kysely);
+
+// Migrate the database before use.
+await db.migrate();
+
+// Now it's just a regular storage.
+await db.event(event1);
+await db.event(event2);
+const events = await db.query([{ kinds: [1] }]);
+```
+
+### `NSet` class (not really a storage)
+
+Nostr event implementation of the `Set` interface.
+
+NSet is an implementation of the theory that a Nostr Storage is actually just a Set.
+Events are Nostr's only data type, and they are immutable, making the Set interface ideal.
+
+```ts
+const events = new NSet();
+
+// Events can be added like a regular `Set`:
+events.add(event1);
+events.add(event2);
+
+// Can be iterated:
+for (const event of events) {
+  if (matchFilters(filters, event)) {
+    console.log(event);
+  }
+}
+```
+
+`NSet` will handle kind `5` deletions, removing events from the set.
+Replaceable (and parameterized) events will keep only the newest version.
+However, verification of `id` and `sig` is NOT performed.
+
+Any `Map` instance can be passed into `new NSet()`, making it compatible with
+[lru-cache](https://www.npmjs.com/package/lru-cache), among others.
+
+## Relays
+
+Relays are an extended form of Storage with real-time streaming capabilities.
+
+### `NRelay` interface
+
+`NRelay` implements all the methods of `NStore`, including a `req` method for streaming events.
+
+```ts
+interface NRelay extends NStore {
+  /** Subscribe to events matching the given filters. Returns an iterator of raw NIP-01 relay messages. */
+  req(filters: NostrFilter[], opts?: NReqOpts): AsyncIterable<NostrRelayEVENT | NostrRelayEOSE | NostrRelayCLOSED>;
+}
+```
+
+The `req` method returns raw NIP-01 relay messages, but only those pertaining to subscriptions: `EVENT`, `EOSE`, and `CLOSED`.
+
+Other messages such as `COUNT` and `OK` are handled internally by `NStore` methods:
+
+- `NRelay.event` - sends an `EVENT` and waits for an `OK`. If the `OK` is false, an error is thrown with the reason as its message.
+- `NRelay.query` - calls `NRelay.req` internally, closing the subscription automatically on `EOSE`.
+- `NRelay.count` - sends a `COUNT` and waits for the response `COUNT`.
+- `NRelay.remove` - not applicable.
+
+Other notes:
+
+- `AUTH` is not part of the interface, and should be handled by the implementation using an option in the constructor (see the `NRelay` class below).
+- Using a `break` statement in the `req` loop will close the subscription automatically, sending a `CLOSE` message to the relay. This works thanks to special treatment of `try...finally` blocks by AsyncIterables.
+- Passing an `AbortSignal` into the `req` method will also close the subscription automatically when the signal aborts, sending a `CLOSE` message.
+
+### `NRelay1` class
+
+The main `NRelay` implementation for connecting to one relay.
+Instantiate it with a WebSocket URL, and then loop over the messages:
+
+```ts
+const relay = new NRelay1('wss://relay.mostr.pub');
+
+for await (const msg of relay.req([{ kinds: [1] }])) {
+  if (msg[0] === 'EVENT') console.log(msg[2]);
+  if (msg[0] === 'EOSE') break; // Sends a `CLOSE` message to the relay.
+}
+```
+
+If the WebSocket disconnects, it will reconnect automatically thanks to the wonderful [websocket-ts](https://github.com/jjxxs/websocket-ts) library.
+Upon reconnection, it will automatically re-subscribe to all subscriptions.
+
+#### `NRelay1Opts` interface
+
+All options are optional.
+
+- `auth` - A function like `(challenge: string) => Promise<NostrEvent>`. If provided, it will be called whenever the relay sends an `AUTH` message, and then it will send the resulting event back to the relay in an `AUTH` message. If not provided, auth is ignored.
+- `backoff` - A [`Backoff`](https://github.com/jjxxs/websocket-ts/blob/v2.1.5/src/backoff/backoff.ts) object for reconnection attempts, or `false` to disable automatic reconnect. Default is `new ExponentialBackoff(1000)`.
+- `verifyEvent` - Custom event verification function. Default is `nostrTools.verifyEvent`.
+
+### `NPool` class
+
+The `NPool` class is a `NRelay` implementation for connecting to multiple relays.
+
+```ts
+const pool = new NPool({
+  open: (url) => new NRelay1(url),
+  reqRelays: async (filters) => ['wss://relay1.mostr.pub', 'wss://relay2.mostr.pub'],
+  eventRelays: async (event) => ['wss://relay1.mostr.pub', 'wss://relay2.mostr.pub'],
+});
+
+// Now you can use the pool like a regular relay.
+for await (const msg of pool.req([{ kinds: [1] }])) {
+  if (msg[0] === 'EVENT') console.log(msg[2]);
+  if (msg[0] === 'EOSE') break;
+}
+```
+
+This class is designed with the Outbox model in mind.
+Instead of passing relay URLs into each method, you pass functions into the contructor that statically-analyze filters and events to determine which relays to use for requesting and publishing events.
+If a relay wasn't already connected, it will be opened automatically.
+Defining `open` will also let you use any relay implementation, such as `NRelay1`.
+
+Note that `pool.req` may stream duplicate events, while `pool.query` will correctly process replaceable events and deletions within the event set before returning them.
+
+`pool.req` will only emit an `EOSE` when all relays in its set have emitted an `EOSE`, and likewise for `CLOSED`.
+
+#### `NPoolOpts` interface
+
+- `open` - A function like `(url: string) => NRelay`. This function should return a new instance of `NRelay` for the given URL.
+
+- `reqRelays` - A function like `(filters: NostrFilter[]) => Promise<string[]>`. This function should return an array of relay URLs to use for making a REQ to the given filters. To support the Outbox model, it should analyze the `authors` field of the filters.
+
+- `eventRelays` - A function like `(event: NostrEvent) => Promise<string[]>`. This function should return an array of relay URLs to use for publishing an EVENT. To support the Outbox model, it should analyze the `pubkey` field of the event.
+
+Pro-tip: the `url` parameter is a unique relay identifier (string), and doesn't technically _have_ to be a URL, as long as you handle it correctly in your `open` function.
+
+## Signers
+
+Signer, like storages, should be usable in an interoperable/composable way.
+The foundation of this is NIP-07.
+
+### `NostrSigner` interface
+
+The `NostrSigner` interface is pulled right out of NIP-07.
+This means any signer implementing it can be used as a drop-in replacement for `window.nostr`.
+Since NIP-07 functions don't accept many options, new Signers are created by abusing constructor props.
+
+```ts
+/** NIP-07 Nostr signer. */
+interface NostrSigner {
+  /** Returns a public key as hex. */
+  getPublicKey(): Promise<string>;
+  /** Takes an event template, adds `id`, `pubkey` and `sig` and returns it. */
+  signEvent(event: Omit<NostrEvent, 'id' | 'pubkey' | 'sig'>): Promise<NostrEvent>;
+  /** Returns a record of relay URLs to relay policies. */
+  getRelays?(): Promise<Record<string, { read: boolean; write: boolean }>>;
+  /** @deprecated NIP-04 crypto methods. Use `nip44` instead. */
+  nip04?: {
+    /** @deprecated Returns ciphertext and iv as specified in NIP-04. */
+    encrypt(pubkey: string, plaintext: string): Promise<string>;
+    /** @deprecated Takes ciphertext and iv as specified in NIP-04. */
+    decrypt(pubkey: string, ciphertext: string): Promise<string>;
+  };
+  /** NIP-44 crypto methods. */
+  nip44?: {
+    /** Returns ciphertext as specified in NIP-44. */
+    encrypt(pubkey: string, plaintext: string): Promise<string>;
+    /** Takes ciphertext as specified in NIP-44. */
+    decrypt(pubkey: string, ciphertext: string): Promise<string>;
+  };
+}
+```
+
+### `NSecSigner` class
+
+NIP-07-compatible signer with secret key. It is a drop-in replacement for `window.nostr`.
+
+Usage:
+
+```ts
+const signer = new NSecSigner(secretKey);
+const pubkey = await signer.getPublicKey();
+const event = await signer.signEvent({ kind: 1, content: 'Hello, world!', tags: [], created_at: 0 });
+```
+
+### `NSeedSigner` class
+
+Accepts an HD seed which it uses to derive the secret key according to [NIP-06](https://github.com/nostr-protocol/nips/blob/master/06.md).
+This method is useful for supporting multiple accounts for the same user, or for sharing a Nostr account with a Bitcoin wallet.
+
+```ts
+const signer = new NSeedSigner(seed, 0);
+
+signer.getPublicKey();
+signer.signEvent(t);
+```
+
+### `NPhraseSigner` class
+
+Similar to `NSeedSigner`, but accepts a BIP-39 mnemonic phrase which it converts into a seed before usage.
+
+```ts
+const signer = new NPhraseSigner('abandon baby cabbage dad ...', {
+  account: 0, // Optional account number. Default is 0.
+  passphrase: 'very special mother', // Optional passphrase. Default is no passphrase.
+});
+
+signer.getPublicKey();
+signer.signEvent(t);
+```
+
+### `NCustodial` class
+
+Signer manager for multiple users.
+Pass a shared secret into it, then it will generate keys for your users determinstically.
+Useful for custodial auth where you only want to manage one secret for the entire application.
+
+```ts
+const SECRET_KEY = Deno.env.get('SECRET_KEY'); // generate with `openssl rand -base64 48`
+const seed = new TextEncoder().encode(SECRET_KEY);
+
+const signers = new NCustodial(seed);
+
+const alex = await signers.get('alex');
+const fiatjaf = await signers.get('fiatjaf');
+
+alex.getPublicKey();
+fiatjaf.signEvent(t);
+```
+
+### `NConnectSigner` class
+
+TODO
+
+## License
+
+MIT

package/RelayError.test.ts

@@ -0,0 +1,23 @@
+import { assertThrows } from '@std/assert';
+
+import { RelayError } from './RelayError.ts';
+
+Deno.test('Construct a RelayError from the reason message', () => {
+  assertThrows(
+    () => {
+      throw RelayError.fromReason('duplicate: already exists');
+    },
+    RelayError,
+    'duplicate: already exists',
+  );
+});
+
+Deno.test('Throw a new RelayError if the OK message is false', () => {
+  assertThrows(
+    () => {
+      RelayError.assert(['OK', 'yolo', false, 'error: bla bla bla']);
+    },
+    RelayError,
+    'error: bla bla bla',
+  );
+});

package/RelayError.ts

@@ -0,0 +1,22 @@
+import { NostrRelayOK } from '@nostrify/nostrify';
+
+/** NIP-01 command line result. */
+export class RelayError extends Error {
+  constructor(prefix: string, message: string) {
+    super(`${prefix}: ${message}`);
+  }
+
+  /** Construct a RelayError from the reason message. */
+  static fromReason(reason: string): RelayError {
+    const [prefix, ...rest] = reason.split(': ');
+    return new RelayError(prefix, rest.join(': '));
+  }
+
+  /** Throw a new RelayError if the OK message is false. */
+  static assert(msg: NostrRelayOK): void {
+    const [, , ok, reason] = msg;
+    if (!ok) {
+      throw RelayError.fromReason(reason);
+    }
+  }
+}

package/dist/BunkerURI.d.ts

@@ -0,0 +1,23 @@
+/** Construct a [NIP-46](https://github.com/nostr-protocol/nips/blob/master/46.md) bunker URI. */
+export declare 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);
+    /** Convert into a `bunker://` URI string. */
+    get href(): string;
+    /** Convert into a `bunker://` URI string. */
+    toString(): string;
+    /** Convert a bunker data object into a `BunkerURI` instance. */
+    static fromJSON(data: {
+        pubkey: string;
+        relays: string[];
+        secret?: string;
+    }): BunkerURI;
+    /** Convert a bunker data object into a bunker URI string. */
+    private static toString;
+}
+//# sourceMappingURL=BunkerURI.d.ts.map

package/dist/BunkerURI.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BunkerURI.d.ts","sourceRoot":"","sources":["../BunkerURI.ts"],"names":[],"mappings":"AAAA,iGAAiG;AACjG,qBAAa,SAAS;IACpB,4BAA4B;IAC5B,MAAM,EAAE,MAAM,CAAC;IACf,wFAAwF;IACxF,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,wGAAwG;IACxG,MAAM,CAAC,EAAE,MAAM,CAAC;gBAEJ,GAAG,EAAE,MAAM;IAkBvB,6CAA6C;IAC7C,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED,6CAA6C;IAC7C,QAAQ,IAAI,MAAM;IAIlB,gEAAgE;IAChE,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,EAAE,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,SAAS;IAKvF,6DAA6D;IAC7D,OAAO,CAAC,MAAM,CAAC,QAAQ;CAaxB"}

package/dist/BunkerURI.js

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BunkerURI = void 0;
+/** Construct a [NIP-46](https://github.com/nostr-protocol/nips/blob/master/46.md) bunker URI. */
+class BunkerURI {
+    /** Remote signer pubkey. */
+    pubkey;
+    /** Relay URLs on which the client is listening for responses from the remote-signer. */
+    relays;
+    /** A short random string that the remote-signer should return as the `result` field of its response. */
+    secret;
+    constructor(uri) {
+        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() {
+        return this.toString();
+    }
+    /** Convert into a `bunker://` URI string. */
+    toString() {
+        return BunkerURI.toString(this);
+    }
+    /** Convert a bunker data object into a `BunkerURI` instance. */
+    static fromJSON(data) {
+        const uri = BunkerURI.toString(data);
+        return new BunkerURI(uri);
+    }
+    /** Convert a bunker data object into a bunker URI string. */
+    static toString(data) {
+        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()}`;
+    }
+}
+exports.BunkerURI = BunkerURI;
+//# sourceMappingURL=BunkerURI.js.map

package/dist/BunkerURI.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BunkerURI.js","sourceRoot":"","sources":["../BunkerURI.ts"],"names":[],"mappings":";;;AAAA,iGAAiG;AACjG,MAAa,SAAS;IACpB,4BAA4B;IAC5B,MAAM,CAAS;IACf,wFAAwF;IACxF,MAAM,CAAW;IACjB,wGAAwG;IACxG,MAAM,CAAU;IAEhB,YAAY,GAAW;QACrB,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;QACzB,MAAM,MAAM,GAAG,IAAI,eAAe,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAE/C,gDAAgD;QAChD,MAAM,MAAM,GAAG,GAAG,CAAC,QAAQ,IAAI,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACrD,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,SAAS,CAAC;QAEjD,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;QACxC,CAAC;QAED,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED,6CAA6C;IAC7C,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,QAAQ,EAAE,CAAC;IACzB,CAAC;IAED,6CAA6C;IAC7C,QAAQ;QACN,OAAO,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IAClC,CAAC;IAED,gEAAgE;IAChE,MAAM,CAAC,QAAQ,CAAC,IAA2D;QACzE,MAAM,GAAG,GAAG,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACrC,OAAO,IAAI,SAAS,CAAC,GAAG,CAAC,CAAC;IAC5B,CAAC;IAED,6DAA6D;IACrD,MAAM,CAAC,QAAQ,CAAC,IAA2D;QACjF,MAAM,MAAM,GAAG,IAAI,eAAe,EAAE,CAAC;QAErC,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChC,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAChC,CAAC;QAED,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,MAAM,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;QACpC,CAAC;QAED,OAAO,YAAY,IAAI,CAAC,MAAM,IAAI,MAAM,CAAC,QAAQ,EAAE,EAAE,CAAC;IACxD,CAAC;CACF;AAxDD,8BAwDC"}

package/dist/NBrowserSigner.d.ts

@@ -0,0 +1,27 @@
+import type { NostrEvent, NostrSigner } from '@nostrify/types';
+/**
+ * NIP-07-compatible signer that proxies to browser extension, normalizing behavior across different implementations.
+ *
+ * This signer delegates all operations to the browser's `window.nostr` object,
+ * which is typically provided by browser extensions like Alby, nos2x, etc.
+ *
+ * Usage:
+ *
+ * ```ts
+ * const signer = new NBrowserSigner();
+ * const pubkey = await signer.getPublicKey();
+ * const event = await signer.signEvent({ kind: 1, content: 'Hello, world!', tags: [], created_at: 0 });
+ * ```
+ */
+export declare class NBrowserSigner implements NostrSigner {
+    private get nostr();
+    getPublicKey(): Promise<string>;
+    signEvent(event: Omit<NostrEvent, 'id' | 'pubkey' | 'sig'>): Promise<NostrEvent>;
+    getRelays(): Promise<Record<string, {
+        read: boolean;
+        write: boolean;
+    }>>;
+    get nip04(): NostrSigner['nip04'];
+    get nip44(): NostrSigner['nip44'];
+}
+//# sourceMappingURL=NBrowserSigner.d.ts.map

package/dist/NBrowserSigner.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"NBrowserSigner.d.ts","sourceRoot":"","sources":["../NBrowserSigner.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAE/D;;;;;;;;;;;;;GAaG;AACH,qBAAa,cAAe,YAAW,WAAW;IAChD,OAAO,KAAK,KAAK,GAMhB;IAEK,YAAY,IAAI,OAAO,CAAC,MAAM,CAAC;IAQ/B,SAAS,CAAC,KAAK,EAAE,IAAI,CAAC,UAAU,EAAE,IAAI,GAAG,QAAQ,GAAG,KAAK,CAAC,GAAG,OAAO,CAAC,UAAU,CAAC;IAUhF,SAAS,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE;QAAE,IAAI,EAAE,OAAO,CAAC;QAAC,KAAK,EAAE,OAAO,CAAA;KAAE,CAAC,CAAC;IAW7E,IAAI,KAAK,IAAI,WAAW,CAAC,OAAO,CAAC,CAqBhC;IAED,IAAI,KAAK,IAAI,WAAW,CAAC,OAAO,CAAC,CAqBhC;CACF"}

package/dist/NBrowserSigner.js

@@ -0,0 +1,96 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NBrowserSigner = void 0;
+/**
+ * NIP-07-compatible signer that proxies to browser extension, normalizing behavior across different implementations.
+ *
+ * This signer delegates all operations to the browser's `window.nostr` object,
+ * which is typically provided by browser extensions like Alby, nos2x, etc.
+ *
+ * Usage:
+ *
+ * ```ts
+ * const signer = new NBrowserSigner();
+ * const pubkey = await signer.getPublicKey();
+ * const event = await signer.signEvent({ kind: 1, content: 'Hello, world!', tags: [], created_at: 0 });
+ * ```
+ */
+class NBrowserSigner {
+    get nostr() {
+        const nostr = globalThis.nostr;
+        if (!nostr) {
+            throw new Error('Browser extension not available');
+        }
+        return nostr;
+    }
+    async getPublicKey() {
+        const pubkey = await this.nostr.getPublicKey();
+        if (typeof pubkey !== 'string') {
+            throw new Error(`Nostr public key retrieval failed: expected string, got ${JSON.stringify(pubkey)}`);
+        }
+        return pubkey;
+    }
+    async signEvent(event) {
+        const signed = await this.nostr.signEvent(event);
+        if (typeof signed !== 'object' || !signed.id || !signed.pubkey || !signed.sig) {
+            throw new Error(`Nostr event signing failed: expected object with id, pubkey, and sig, got ${JSON.stringify(signed)}`);
+        }
+        return signed;
+    }
+    async getRelays() {
+        if (!this.nostr.getRelays) {
+            return {};
+        }
+        const relays = await this.nostr.getRelays();
+        if (typeof relays !== 'object' || relays === null) {
+            throw new Error(`Nostr getRelays failed: expected object, got ${JSON.stringify(relays)}`);
+        }
+        return this.nostr.getRelays();
+    }
+    get nip04() {
+        const nostr = this.nostr;
+        if (!nostr.nip04) {
+            return undefined;
+        }
+        return {
+            encrypt: async (pubkey, plaintext) => {
+                const encrypted = await nostr.nip04.encrypt(pubkey, plaintext);
+                if (typeof encrypted !== 'string') {
+                    throw new Error(`NIP-04 encryption failed: expected string result, got ${JSON.stringify(encrypted)}`);
+                }
+                return encrypted;
+            },
+            decrypt: async (pubkey, ciphertext) => {
+                const decrypted = await nostr.nip04.decrypt(pubkey, ciphertext);
+                if (typeof decrypted !== 'string') {
+                    throw new Error(`NIP-04 decryption failed: expected string result, got ${JSON.stringify(decrypted)}`);
+                }
+                return decrypted;
+            },
+        };
+    }
+    get nip44() {
+        const nostr = this.nostr;
+        if (!nostr.nip44) {
+            return undefined;
+        }
+        return {
+            encrypt: async (pubkey, plaintext) => {
+                const encrypted = await nostr.nip44.encrypt(pubkey, plaintext);
+                if (typeof encrypted !== 'string') {
+                    throw new Error(`NIP-44 encryption failed: expected string result, got ${JSON.stringify(encrypted)}`);
+                }
+                return encrypted;
+            },
+            decrypt: async (pubkey, ciphertext) => {
+                const decrypted = await nostr.nip44.decrypt(pubkey, ciphertext);
+                if (typeof decrypted !== 'string') {
+                    throw new Error(`NIP-44 decryption failed: expected string result, got ${JSON.stringify(decrypted)}`);
+                }
+                return decrypted;
+            },
+        };
+    }
+}
+exports.NBrowserSigner = NBrowserSigner;
+//# sourceMappingURL=NBrowserSigner.js.map

package/dist/NBrowserSigner.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"NBrowserSigner.js","sourceRoot":"","sources":["../NBrowserSigner.ts"],"names":[],"mappings":";;;AAEA;;;;;;;;;;;;;GAaG;AACH,MAAa,cAAc;IACzB,IAAY,KAAK;QACf,MAAM,KAAK,GAAI,UAAsC,CAAC,KAAK,CAAC;QAC5D,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;QACrD,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,KAAK,CAAC,YAAY;QAChB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,YAAY,EAAE,CAAC;QAC/C,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;YAC/B,MAAM,IAAI,KAAK,CAAC,2DAA2D,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QACvG,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,KAAK,CAAC,SAAS,CAAC,KAAgD;QAC9D,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QACjD,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC;YAC9E,MAAM,IAAI,KAAK,CACb,6EAA6E,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CACtG,CAAC;QACJ,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,KAAK,CAAC,SAAS;QACb,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC;YAC1B,OAAO,EAAE,CAAC;QACZ,CAAC;QACD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC;QAC5C,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;YAClD,MAAM,IAAI,KAAK,CAAC,gDAAgD,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QAC5F,CAAC;QACD,OAAO,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC;IAChC,CAAC;IAED,IAAI,KAAK;QACP,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;QACzB,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;YACjB,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,OAAO;YACL,OAAO,EAAE,KAAK,EAAE,MAAc,EAAE,SAAiB,EAAmB,EAAE;gBACpE,MAAM,SAAS,GAAG,MAAM,KAAK,CAAC,KAAM,CAAC,OAAO,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;gBAChE,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE,CAAC;oBAClC,MAAM,IAAI,KAAK,CAAC,yDAAyD,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;gBACxG,CAAC;gBACD,OAAO,SAAS,CAAC;YACnB,CAAC;YACD,OAAO,EAAE,KAAK,EAAE,MAAc,EAAE,UAAkB,EAAmB,EAAE;gBACrE,MAAM,SAAS,GAAG,MAAM,KAAK,CAAC,KAAM,CAAC,OAAO,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;gBACjE,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE,CAAC;oBAClC,MAAM,IAAI,KAAK,CAAC,yDAAyD,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;gBACxG,CAAC;gBACD,OAAO,SAAS,CAAC;YACnB,CAAC;SACF,CAAC;IACJ,CAAC;IAED,IAAI,KAAK;QACP,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;QACzB,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;YACjB,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,OAAO;YACL,OAAO,EAAE,KAAK,EAAE,MAAc,EAAE,SAAiB,EAAmB,EAAE;gBACpE,MAAM,SAAS,GAAG,MAAM,KAAK,CAAC,KAAM,CAAC,OAAO,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;gBAChE,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE,CAAC;oBAClC,MAAM,IAAI,KAAK,CAAC,yDAAyD,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;gBACxG,CAAC;gBACD,OAAO,SAAS,CAAC;YACnB,CAAC;YACD,OAAO,EAAE,KAAK,EAAE,MAAc,EAAE,UAAkB,EAAmB,EAAE;gBACrE,MAAM,SAAS,GAAG,MAAM,KAAK,CAAC,KAAM,CAAC,OAAO,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;gBACjE,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE,CAAC;oBAClC,MAAM,IAAI,KAAK,CAAC,yDAAyD,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;gBACxG,CAAC;gBACD,OAAO,SAAS,CAAC;YACnB,CAAC;SACF,CAAC;IACJ,CAAC;CACF;AAnFD,wCAmFC"}

package/dist/NCache.d.ts

@@ -0,0 +1,34 @@
+import { NostrEvent, NostrFilter, NostrRelayCOUNT, NStore } from '@nostrify/types';
+import { LRUCache } from 'lru-cache';
+import { NSet } from './NSet';
+/**
+ * Nostr LRU cache based on [`npm:lru-cache`](https://www.npmjs.com/package/lru-cache).
+ * It implements both `NStore` and `NSet` interfaces.
+ *
+ * ```ts
+ * // Accepts the options of `npm:lru-cache`:
+ * const cache = new NCache({ max: 1000 });
+ *
+ * // Events can be added like a regular `Set`:
+ * cache.add(event1);
+ * cache.add(event2);
+ *
+ * // Can be queried like `NStore`:
+ * const events = await cache.query([{ kinds: [1] }]);
+ *
+ * // Can be iterated like `NSet`:
+ * for (const event of cache) {
+ *  console.log(event);
+ * }
+ * ```
+ */
+declare class NCache extends NSet implements NStore {
+    constructor(...args: ConstructorParameters<typeof LRUCache<string, NostrEvent>>);
+    event(event: NostrEvent): Promise<void>;
+    query(filters: NostrFilter[]): Promise<NostrEvent[]>;
+    remove(filters: NostrFilter[]): Promise<void>;
+    count(filters: NostrFilter[]): Promise<NostrRelayCOUNT[2]>;
+    [Symbol.toStringTag]: string;
+}
+export { NCache };
+//# sourceMappingURL=NCache.d.ts.map

package/dist/NCache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"NCache.d.ts","sourceRoot":"","sources":["../NCache.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AACnF,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAGrC,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAE9B;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,cAAM,MAAO,SAAQ,IAAK,YAAW,MAAM;gBAEvC,GAAG,IAAI,EAAE,qBAAqB,CAAC,OAAO,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IAK/D,KAAK,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IAIvC,KAAK,CAAC,OAAO,EAAE,WAAW,EAAE,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;IAapD,MAAM,CAAC,OAAO,EAAE,WAAW,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAQ7C,KAAK,CAAC,OAAO,EAAE,WAAW,EAAE,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;IAQvD,CAAC,MAAM,CAAC,WAAW,CAAC,SAAY;CAC1C;AAED,OAAO,EAAE,MAAM,EAAE,CAAC"}