@nostrify/nostrify 0.48.2 → 0.48.3

package/dist/ln/LNURL.ts

@@ -1,146 +0,0 @@
-import type { NostrEvent } from '@nostrify/types';
-import { bech32 } from '@scure/base';
-
-import { LNURLCallback } from './types/LNURLCallback.ts';
-import { LNURLDetails } from './types/LNURLDetails.ts';
-
-import { NSchema as n, z } from '../NSchema.ts';
-
-/**
- * Represents an LNURL, with methods to fetch details and generate invoices.
- */
-export class LNURL {
-  /** Underlying HTTP(s) URL of the user. */
-  readonly url: URL;
-  /** Fetch function to use for HTTP requests. */
-  private fetch: typeof globalThis.fetch;
-
-  constructor(
-    /** Underlying HTTP(s) URL of the user. */
-    url: URL,
-    /** Options for the LNURL class. */
-    opts?: {
-      /** Fetch function to use for HTTP requests. */
-      fetch: typeof globalThis.fetch;
-    },
-  ) {
-    this.url = url;
-    this.fetch = opts?.fetch ?? globalThis.fetch.bind(globalThis);
-  }
-
-  /**
-   * Create an LNURL object from a bech32 `lnurl1...` string.
-   * Throws if the value is not a valid lnurl.
-   */
-  static fromString(
-    value: string,
-    opts?: { fetch: typeof globalThis.fetch },
-  ): LNURL {
-    if (!n.bech32().safeParse(value).success) {
-      throw new Error('Expected a bech32 string starting with "lnurl1"');
-    }
-
-    const { prefix, words } = bech32.decode(
-      value as `${string}1${string}`,
-      20000,
-    );
-
-    if (prefix !== 'lnurl') {
-      throw new Error('Expected a bech32 string starting with "lnurl1"');
-    }
-
-    const data = bech32.fromWords(words);
-    const url = new URL(new TextDecoder().decode(data));
-
-    return new LNURL(url, opts);
-  }
-
-  /**
-   * Create an LNURL object from a lightning address (email-like format).
-   * Throws if the value is not a valid lightning address.
-   */
-  static fromLightningAddress(
-    ln: string,
-    opts?: { fetch: typeof globalThis.fetch },
-  ): LNURL {
-    if (!z.string().email().safeParse(ln).success) {
-      throw new Error(
-        'Expected a lightning address in email-like format (eg "example@getalby.com")',
-      );
-    }
-
-    const [name, host] = ln.split('@');
-    const url = new URL(`/.well-known/lnurlp/${name}`, `https://${host}`);
-
-    return new LNURL(url, opts);
-  }
-
-  /** Returns the LNURL object as a bech32-encoded `lnurl1...` string. */
-  toString(): `lnurl1${string}` {
-    const data = new TextEncoder().encode(this.url.toString());
-    const words = bech32.toWords(data);
-    return bech32.encode('lnurl', words, 20000);
-  }
-
-  /** Resolve an LNURL to its details. */
-  async getDetails(opts?: { signal?: AbortSignal }): Promise<LNURLDetails> {
-    const response = await this.fetch(this.url, opts);
-    const json = await response.json();
-    return LNURL.lnurlDetailsSchema().parse(json);
-  }
-
-  /** Generate an LNURL invoice from the params. */
-  async getInvoice(opts: {
-    /** Amount in millisatoshis to send to the user. */
-    amount: number;
-    /** NIP-57 Zap Request (kind 9734) event. */
-    nostr?: NostrEvent;
-    /** Signal to abort the request. */
-    signal?: AbortSignal;
-  }): Promise<LNURLCallback> {
-    const details = await this.getDetails(opts);
-    const callback = new URL(details.callback);
-
-    callback.searchParams.set('amount', opts.amount.toString());
-    callback.searchParams.set('lnurl', this.toString());
-
-    if (opts.nostr) {
-      callback.searchParams.set('nostr', JSON.stringify(opts.nostr));
-    }
-
-    const response = await this.fetch(callback, opts);
-    const json = await response.json();
-
-    return LNURL.lnurlCallbackSchema().parse(json);
-  }
-
-  /** LNURL response schema. */
-  static lnurlDetailsSchema(): z.ZodType<LNURLDetails> {
-    return z.object({
-      allowsNostr: z.boolean().optional(),
-      callback: z.string().url(),
-      commentAllowed: z.number().nonnegative().int().optional(),
-      maxSendable: z.number().positive().int(),
-      minSendable: z.number().positive().int(),
-      metadata: z.string(),
-      nostrPubkey: n.id().optional(),
-      tag: z.literal('payRequest'),
-    }).superRefine((details, ctx) => {
-      if (details.minSendable > details.maxSendable) {
-        ctx.addIssue({
-          code: z.ZodIssueCode.custom,
-          message: 'minSendable must be less than or equal to maxSendable',
-          path: ['minSendable'],
-        });
-      }
-    }) as z.ZodType<LNURLDetails>;
-  }
-
-  /** LNURL callback schema. */
-  static lnurlCallbackSchema(): z.ZodType<LNURLCallback> {
-    return z.object({
-      pr: n.bech32('lnbc'),
-      routes: z.tuple([]),
-    }) as unknown as z.ZodType<LNURLCallback>;
-  }
-}

package/dist/ln/mod.ts

@@ -1,4 +0,0 @@
-export { LNURL } from './LNURL.ts';
-
-export type { LNURLCallback } from './types/LNURLCallback.ts';
-export type { LNURLDetails } from './types/LNURLDetails.ts';

package/dist/ln/types/LNURLCallback.ts

@@ -1,7 +0,0 @@
-/** LNURL callback response, as defined by LUD-06. */
-export interface LNURLCallback {
-  /** bech32-serialized lightning invoice. */
-  pr: `lnbc1${string}`;
-  /** An empty array. */
-  routes: [];
-}

package/dist/ln/types/LNURLDetails.ts

@@ -1,19 +0,0 @@
-/** LNURL `payRequest` details, as defined by LUD-06. Includes additional properties from NIP-57. */
-export interface LNURLDetails {
-  /** Whether the LN SERVICE supports NIP-57 Lightning Zaps. */
-  allowsNostr?: boolean;
-  /** The URL from LN SERVICE which will accept the pay request parameters. */
-  callback: string;
-  /** The number of characters accepted for the `comment` query parameter on subsequent callback. (Should be interpreted as 0 if not provided). */
-  commentAllowed?: number;
-  /** Max millisatoshi amount LN SERVICE is willing to receive. */
-  maxSendable: number;
-  /** Min millisatoshi amount LN SERVICE is willing to receive, can not be less than 1 or more than `maxSendable`. */
-  minSendable: number;
-  /** Metadata json which must be presented as raw string here, this is required to pass signature verification at a later step. */
-  metadata: string;
-  /** The Nostr pubkey LN SERVICE will use to sign zap receipt events. Clients will use this to validate zap receipts. */
-  nostrPubkey?: string;
-  /** Type of LNURL. */
-  tag: 'payRequest';
-}

package/dist/mod.ts

@@ -1,17 +0,0 @@
-export { BunkerURI } from './BunkerURI.ts';
-export { NBrowserSigner } from './NBrowserSigner.ts';
-export { NCache } from './NCache.ts';
-export { NConnectSigner, type NConnectSignerOpts } from './NConnectSigner.ts';
-export { NIP05 } from './NIP05.ts';
-export { NIP50 } from './NIP50.ts';
-export { NIP98 } from './NIP98.ts';
-export { NIP98Client, type NIP98ClientOpts } from './NIP98Client.ts';
-export { NKinds } from './NKinds.ts';
-export { NPool, type NPoolOpts } from './NPool.ts';
-export { NRelay1, type NRelay1Opts } from './NRelay1.ts';
-export { NSchema } from './NSchema.ts';
-export { NSecSigner } from './NSecSigner.ts';
-export { NSet } from './NSet.ts';
-export { RelayError } from './RelayError.ts';
-
-export type * from '@nostrify/types';

package/dist/test/ErrorRelay.ts

@@ -1,52 +0,0 @@
-// deno-lint-ignore-file require-await require-yield
-import type {
-  NostrEvent,
-  NostrFilter,
-  NostrRelayCLOSED,
-  NostrRelayCOUNT,
-  NostrRelayEOSE,
-  NostrRelayEVENT,
-  NRelay,
-} from '@nostrify/types';
-
-/** A relay storage class that intentionally throws errors for every method. */
-export class ErrorRelay implements NRelay {
-  async *req(
-    _filters: NostrFilter[],
-    _opts?: { signal?: AbortSignal },
-  ): AsyncIterable<NostrRelayEVENT | NostrRelayEOSE | NostrRelayCLOSED> {
-    throw new Error('This error is intentional.');
-  }
-
-  async event(
-    _event: NostrEvent,
-    _opts?: { signal?: AbortSignal },
-  ): Promise<void> {
-    throw new Error('This error is intentional.');
-  }
-
-  async query(
-    _filters: NostrFilter[],
-    _opts?: { signal?: AbortSignal },
-  ): Promise<NostrEvent[]> {
-    throw new Error('This error is intentional.');
-  }
-
-  async count(
-    _filters: NostrFilter[],
-    _opts?: { signal?: AbortSignal },
-  ): Promise<NostrRelayCOUNT[2]> {
-    throw new Error('This error is intentional.');
-  }
-
-  async remove(
-    _filters: NostrFilter[],
-    _opts?: { signal?: AbortSignal },
-  ): Promise<void> {
-    throw new Error('This error is intentional.');
-  }
-
-  async close(): Promise<void> {
-    throw new Error('This error is intentional.');
-  }
-}

package/dist/test/MockRelay.ts

@@ -1,92 +0,0 @@
-// deno-lint-ignore-file require-await
-
-import type {
-  NostrEvent,
-  NostrFilter,
-  NostrRelayCLOSED,
-  NostrRelayCOUNT,
-  NostrRelayEOSE,
-  NostrRelayEVENT,
-  NRelay,
-} from '@nostrify/types';
-import { matchFilters } from 'nostr-tools';
-
-import { Machina } from '../utils/Machina.ts';
-import { NSet } from '../NSet.ts';
-
-/** Mock relay for testing. */
-export class MockRelay extends NSet implements NRelay {
-  readonly subs: Map<
-    string,
-    { filters: NostrFilter[]; machina: Machina<NostrEvent> }
-  > = new Map();
-
-  async *req(
-    filters: NostrFilter[],
-    opts?: { signal?: AbortSignal },
-  ): AsyncIterable<NostrRelayEVENT | NostrRelayEOSE | NostrRelayCLOSED> {
-    const uuid = crypto.randomUUID();
-    const machina = new Machina<NostrEvent>(opts?.signal);
-
-    this.subs.set(uuid, { filters, machina });
-
-    try {
-      for (const event of await this.query(filters)) {
-        yield ['EVENT', uuid, event];
-      }
-
-      yield ['EOSE', uuid];
-
-      for await (const event of machina) {
-        yield ['EVENT', uuid, event];
-      }
-    } finally {
-      this.subs.delete(uuid);
-    }
-  }
-
-  async event(event: NostrEvent): Promise<void> {
-    this.add(event);
-
-    for (const { filters, machina } of this.subs.values()) {
-      if (matchFilters(filters, event)) {
-        machina.push(event);
-      }
-    }
-  }
-
-  async query(filters: NostrFilter[]): Promise<NostrEvent[]> {
-    const events: NostrEvent[] = [];
-
-    for (const event of this) {
-      if (matchFilters(filters, event)) {
-        this.cache.get(event.id);
-        events.push(event);
-      }
-    }
-
-    return events;
-  }
-
-  async remove(filters: NostrFilter[]): Promise<void> {
-    for (const event of this) {
-      if (matchFilters(filters, event)) {
-        this.delete(event);
-      }
-    }
-  }
-
-  async count(filters: NostrFilter[]): Promise<NostrRelayCOUNT[2]> {
-    const events = await this.query(filters);
-    return {
-      count: events.length,
-      approximate: false,
-    };
-  }
-
-  close(): Promise<void> {
-    return Promise.resolve();
-  }
-
-  override [Symbol.toStringTag] = 'MockRelay';
-}

package/dist/test/TestRelayServer.ts

@@ -1,185 +0,0 @@
-import { MockRelay } from './mod.ts';
-import type { NostrClientMsg, NostrEvent, NostrRelayMsg } from '@nostrify/types';
-import { NSchema as n } from '../NSchema.ts';
-import { WebSocket, WebSocketServer } from 'ws';
-import { createServer, Server } from 'node:http';
-import type { AddressInfo } from 'node:net';
-import { Buffer } from 'node:buffer';
-
-interface TestRelayServerOpts {
-  handleMessage?(socket: WebSocket, msg: NostrClientMsg): Promise<void> | void;
-}
-
-export class TestRelayServer {
-  private port = 0;
-  private inited = false;
-  private httpServer: Server;
-  private wsServer: WebSocketServer;
-  private opts: TestRelayServerOpts;
-  private connections = new Set<WebSocket>();
-  private controllers = new Map<string, AbortController>();
-  private store = new MockRelay();
-
-  constructor(opts?: TestRelayServerOpts) {
-    this.opts = opts || {};
-    this.httpServer = createServer();
-    this.wsServer = new WebSocketServer({ server: this.httpServer });
-    this.setupWebSocketServer();
-  }
-
-  init() {
-    const { resolve, promise } = Promise.withResolvers<void>();
-    this.httpServer.listen(0, '127.0.0.1', () => {
-      this.port = (this.httpServer.address() as AddressInfo).port;
-      this.inited = true;
-      resolve();
-    });
-
-    return promise;
-  }
-
-  private setupWebSocketServer(): void {
-    this.wsServer.on('connection', (socket: WebSocket) => {
-      this.connections.add(socket);
-
-      socket.on('close', () => {
-        this.connections.delete(socket);
-        for (const [subId, controller] of this.controllers.entries()) {
-          controller.abort();
-          this.controllers.delete(subId);
-        }
-      });
-
-      socket.on('message', (data: Buffer) => {
-        try {
-          const result = n.json().pipe(n.clientMsg()).safeParse(data.toString());
-          if (result.success) {
-            const handleMessage = this.opts?.handleMessage ??
-              this.handleMessage.bind(this);
-            handleMessage(socket, result.data);
-          }
-        } catch {
-          // do nothing
-        }
-      });
-
-      socket.on('error', (error: any) => {
-        console.error('WebSocket error:', error);
-        this.connections.delete(socket);
-      });
-    });
-  }
-
-  send(socket: WebSocket, msg: NostrRelayMsg): void {
-    if (!this.inited) throw new Error('TestRelayServer not initialized');
-    if (socket.readyState === WebSocket.OPEN) {
-      socket.send(JSON.stringify(msg));
-    }
-  }
-
-  private async handleMessage(
-    socket: WebSocket,
-    msg: NostrClientMsg,
-  ): Promise<void> {
-    if (!this.inited) throw new Error('TestRelayServer not initialized');
-
-    switch (msg[0]) {
-      case 'REQ': {
-        const [_, subId, ...filters] = msg;
-
-        const controller = new AbortController();
-        this.controllers.set(subId, controller);
-
-        try {
-          for await (
-            const msg of this.store.req(filters, { signal: controller.signal })
-          ) {
-            msg[1] = subId;
-            this.send(socket, msg);
-          }
-        } catch {
-          // do nothing
-        }
-
-        break;
-      }
-
-      case 'CLOSE': {
-        const subId = msg[1];
-        this.controllers.get(subId)?.abort();
-        this.controllers.delete(subId);
-        break;
-      }
-
-      case 'EVENT': {
-        const [_, event] = msg;
-        await this.store.event(event);
-        this.send(socket, ['OK', event.id, true, '']);
-        break;
-      }
-    }
-  }
-
-  get url(): string {
-    if (!this.inited) throw new Error('TestRelayServer not initialized');
-    const addr = this.httpServer.address() as AddressInfo;
-    return `ws://${addr.address}:${addr.port}`;
-  }
-
-  // deno-lint-ignore require-await
-  async close(): Promise<void> {
-    if (!this.inited) throw new Error('TestRelayServer not initialized');
-    return new Promise((resolve) => {
-      this.connections.forEach((conn) => {
-        if (conn.readyState === WebSocket.OPEN) {
-          conn.close();
-        }
-      });
-      this.connections.clear();
-
-      this.controllers.forEach((controller) => controller.abort());
-      this.controllers.clear();
-
-      this.wsServer.close(() => {
-        this.httpServer.close(() => {
-          this.inited = false;
-          resolve();
-        });
-      });
-    });
-  }
-
-  open(): Promise<void> {
-    if (this.inited) throw new Error('TestRelayServer already initialized');
-    if (!this.httpServer.listening) {
-      const { resolve, promise } = Promise.withResolvers<void>();
-      this.httpServer = createServer();
-      this.wsServer = new WebSocketServer({ server: this.httpServer });
-      this.setupWebSocketServer();
-      this.httpServer.listen(0, '127.0.0.1', () => {
-        this.port = (this.httpServer.address() as AddressInfo).port;
-        this.inited = true;
-        resolve();
-      });
-      return promise;
-    }
-    return Promise.resolve();
-  }
-
-  event(event: NostrEvent): Promise<void> {
-    if (!this.inited) throw new Error('TestRelayServer not initialized');
-    return this.store.event(event);
-  }
-
-  async [Symbol.asyncDispose](): Promise<void> {
-    if (this.inited) {
-      await this.close();
-    }
-  }
-
-  static async create(opts?: TestRelayServerOpts) {
-    const server = new TestRelayServer(opts);
-    await server.init();
-    return server;
-  }
-}

package/dist/test/mod.ts

@@ -1,28 +0,0 @@
-import type { NostrEvent } from '@nostrify/types';
-import { finalizeEvent, generateSecretKey } from 'nostr-tools';
-import { readFile } from 'node:fs/promises';
-
-export { ErrorRelay } from './ErrorRelay.ts';
-export { MockRelay } from './MockRelay.ts';
-
-/** Import a JSONL fixture by name in tests. */
-export async function jsonlEvents(path: string): Promise<NostrEvent[]> {
-  const data = await readFile(path, { encoding: 'utf8' });
-  return data.split('\n').map((line: string) => JSON.parse(line));
-}
-
-/** Generate an event for use in tests. */
-export function genEvent(
-  t: Partial<NostrEvent> = {},
-  sk: Uint8Array = generateSecretKey(),
-): NostrEvent {
-  const { id, kind, pubkey, tags, content, created_at, sig } = finalizeEvent({
-    kind: 255,
-    created_at: 0,
-    content: '',
-    tags: [],
-    ...t,
-  }, sk);
-
-  return { id, kind, pubkey, tags, content, created_at, sig };
-}

package/dist/uploaders/BlossomUploader.ts

@@ -1,100 +0,0 @@
-import type { NostrSigner, NUploader } from "@nostrify/types";
-import { toHex } from "@smithy/util-hex-encoding";
-import { z } from "zod";
-
-import { N64 } from "../utils/N64.ts";
-
-/** BlossomUploader options. */
-export interface BlossomUploaderOpts {
-  /** Blossom servers to use. */
-  servers: Request["url"][];
-  /** Signer for Blossom authorizations. */
-  signer: NostrSigner;
-  /** Custom fetch implementation. */
-  fetch?: typeof fetch;
-  /** Number of milliseconds until each request should expire. (Default: `60_000`) */
-  expiresIn?: number;
-}
-
-/** Upload files to Blossom servers. */
-export class BlossomUploader implements NUploader {
-  private servers: Request["url"][];
-  private signer: NostrSigner;
-  private fetch: typeof fetch;
-  private expiresIn: number;
-
-  constructor(opts: BlossomUploaderOpts) {
-    this.servers = opts.servers;
-    this.signer = opts.signer;
-    this.fetch = opts.fetch ?? globalThis.fetch.bind(globalThis);
-    this.expiresIn = opts.expiresIn ?? 60_000;
-  }
-
-  async upload(
-    file: File,
-    opts?: { signal?: AbortSignal },
-  ): Promise<[["url", string], ...string[][]]> {
-    const digest = await crypto.subtle.digest(
-      "SHA-256",
-      await file.arrayBuffer(),
-    );
-    const x = toHex(new Uint8Array(digest));
-
-    const now = Date.now();
-    const expiration = now + this.expiresIn;
-
-    const event = await this.signer.signEvent({
-      kind: 24242,
-      content: `Upload ${file.name}`,
-      created_at: Math.floor(now / 1000),
-      tags: [
-        ["t", "upload"],
-        ["x", x],
-        ["size", file.size.toString()],
-        ["expiration", Math.floor(expiration / 1000).toString()],
-      ],
-    });
-
-    const authorization = `Nostr ${N64.encodeEvent(event)}`;
-
-    return Promise.any(this.servers.map(async (server) => {
-      const url = new URL("/upload", server);
-
-      const response = await this.fetch(url, {
-        method: "PUT",
-        body: file,
-        headers: {
-          authorization,
-          "content-type": file.type,
-        },
-        signal: opts?.signal,
-      });
-
-      const json = await response.json();
-      const data = BlossomUploader.schema().parse(json);
-
-      const tags: [["url", string], ...string[][]] = [
-        ["url", data.url],
-        ["x", data.sha256],
-        ["ox", data.sha256],
-        ["size", data.size.toString()],
-      ];
-
-      if (data.type) {
-        tags.push(["m", data.type]);
-      }
-
-      return tags;
-    }));
-  }
-
-  /** Blossom "BlobDescriptor" schema. */
-  private static schema() {
-    return z.object({
-      url: z.string(),
-      sha256: z.string(),
-      size: z.number(),
-      type: z.string().optional(),
-    });
-  }
-}