something

README.md

@@ -133,14 +133,6 @@ import WebSocket from 'ws'
 useWebSocketImplementation(WebSocket)
 ```
 
-You can enable regular pings of connected relays with the `enablePing` option. This will set up a heartbeat that closes the websocket if it doesn't receive a response in time. Some platforms don't report websocket disconnections due to network issues, and enabling this can increase reliability.
-
-```js
-import { SimplePool } from 'nostr-tools/pool'
-
-const pool = new SimplePool({ enablePing: true })
-```
-
 ### Parsing references (mentions) from a content based on NIP-27
 
 ```js
@@ -169,10 +161,8 @@ for (let block of nip27.parse(evt.content)) {
     case 'video':
     case 'audio':
       console.log("it's a media url:", block.url)
-      break
     case 'relay':
       console.log("it's a websocket url, probably a relay address:", block.url)
-      break
     default:
       break
   }
@@ -181,24 +171,14 @@ for (let block of nip27.parse(evt.content)) {
 
 ### Connecting to a bunker using NIP-46
 
-`BunkerSigner` allows your application to request signatures and other actions from a remote NIP-46 signer, often called a "bunker". There are two primary ways to establish a connection, depending on whether the client or the bunker initiates the connection.
-
-A local secret key is required for the client to communicate securely with the bunker. This key should generally be persisted for the user's session.
-
-```js
-import { generateSecretKey } from '@nostr/tools/pure'
-
-const localSecretKey = generateSecretKey()
-```
-
-### Method 1: Using a Bunker URI (`bunker://`)
-
-This is the bunker-initiated flow. Your client receives a `bunker://` string or a NIP-05 identifier from the user. You use `BunkerSigner.fromBunker()` to create an instance, which returns immediately. For the **initial connection** with a new bunker, you must explicitly call `await bunker.connect()` to establish the connection and receive authorization.
-
 ```js
+import { generateSecretKey, getPublicKey } from '@nostr/tools/pure'
 import { BunkerSigner, parseBunkerInput } from '@nostr/tools/nip46'
 import { SimplePool } from '@nostr/tools/pool'
 
+// the client needs a local secret key (which is generally persisted) for communicating with the bunker
+const localSecretKey = generateSecretKey()
+
 // parse a bunker URI
 const bunkerPointer = await parseBunkerInput('bunker://abcd...?relay=wss://relay.example.com')
 if (!bunkerPointer) {
@@ -207,7 +187,7 @@ if (!bunkerPointer) {
 
 // create the bunker instance
 const pool = new SimplePool()
-const bunker = BunkerSigner.fromBunker(localSecretKey, bunkerPointer, { pool })
+const bunker = new BunkerSigner(localSecretKey, bunkerPointer, { pool })
 await bunker.connect()
 
 // and use it
@@ -223,47 +203,6 @@ const event = await bunker.signEvent({
 await signer.close()
 pool.close([])
 ```
-> **Note on Reconnecting:** Once a connection has been successfully established and the `BunkerPointer` is stored, you do **not** need to call `await bunker.connect()` on subsequent sessions. 
-
-### Method 2: Using a Client-generated URI (`nostrconnect://`)
-
-This is the client-initiated flow, which generally provides a better user experience for first-time connections (e.g., via QR code). Your client generates a `nostrconnect://` URI and waits for the bunker to connect to it.
-
-`BunkerSigner.fromURI()` is an **asynchronous** method. It returns a `Promise` that resolves only after the bunker has successfully connected. Therefore, the returned signer instance is already fully connected and ready to use, so you **do not** need to call `.connect()` on it.
-
-```js
-import { getPublicKey } from '@nostr/tools/pure'
-import { BunkerSigner, createNostrConnectURI } from '@nostr/tools/nip46'
-import { SimplePool } from '@nostr/tools/pool'
-
-const clientPubkey = getPublicKey(localSecretKey)
-
-// generate a connection URI for the bunker to scan
-const connectionUri = createNostrConnectURI({
-  clientPubkey,
-  relays: ['wss://relay.damus.io', 'wss://relay.primal.net'],
-  secret: 'a-random-secret-string', // A secret to verify the bunker's response
-  name: 'My Awesome App'
-})
-
-// wait for the bunker to connect
-const pool = new SimplePool()
-const signer = await BunkerSigner.fromURI(localSecretKey, connectionUri, { pool })
-
-// and use it
-const pubkey = await signer.getPublicKey()
-const event = await signer.signEvent({
-  kind: 1,
-  created_at: Math.floor(Date.now() / 1000),
-  tags: [],
-  content: 'Hello from a client-initiated connection!'
-})
-
-// cleanup
-await signer.close()
-pool.close([])
-```
-> **Note on Persistence:** This method is ideal for the initial sign-in. To allow users to stay logged in across sessions, you should store the connection details and use `Method 1` for subsequent reconnections. 
 
 ### Parsing thread from any note based on NIP-10
 

abstract-pool.ts

@@ -32,7 +32,6 @@ export class AbstractSimplePool {
   public trackRelays: boolean = false
 
   public verifyEvent: Nostr['verifyEvent']
-  public enablePing: boolean | undefined
   public trustedRelayURLs: Set<string> = new Set()
 
   private _WebSocket?: typeof WebSocket
@@ -40,7 +39,6 @@ export class AbstractSimplePool {
   constructor(opts: AbstractPoolConstructorOptions) {
     this.verifyEvent = opts.verifyEvent
     this._WebSocket = opts.websocketImplementation
-    this.enablePing = opts.enablePing
   }
 
   async ensureRelay(url: string, params?: { connectionTimeout?: number }): Promise<AbstractRelay> {
@@ -51,7 +49,6 @@ export class AbstractSimplePool {
       relay = new AbstractRelay(url, {
         verifyEvent: this.trustedRelayURLs.has(url) ? alwaysTrue : this.verifyEvent,
         websocketImplementation: this._WebSocket,
-        enablePing: this.enablePing,
       })
       relay.onclose = () => {
         this.relays.delete(url)
@@ -74,44 +71,24 @@ export class AbstractSimplePool {
   subscribe(relays: string[], filter: Filter, params: SubscribeManyParams): SubCloser {
     params.onauth = params.onauth || params.doauth
 
-    const request: { url: string; filter: Filter }[] = []
-    for (let i = 0; i < relays.length; i++) {
-      const url = normalizeURL(relays[i])
-      if (!request.find(r => r.url === url)) {
-        request.push({ url, filter: filter })
-      }
+    return this.subscribeMap(
+      relays.map(url => ({ url, filter })),
+      params,
+    )
   }
 
-    return this.subscribeMap(request, params)
-  }
-
-  subscribeMany(relays: string[], filter: Filter, params: SubscribeManyParams): SubCloser {
+  subscribeMany(relays: string[], filters: Filter[], params: SubscribeManyParams): SubCloser {
     params.onauth = params.onauth || params.doauth
 
-    const request: { url: string; filter: Filter }[] = []
-    const uniqUrls: string[] = []
-    for (let i = 0; i < relays.length; i++) {
-      const url = normalizeURL(relays[i])
-      if (uniqUrls.indexOf(url) === -1) {
-        uniqUrls.push(url)
-        request.push({ url, filter: filter })
-      }
-    }
-
-    return this.subscribeMap(request, params)
+    return this.subscribeMap(
+      relays.flatMap(url => filters.map(filter => ({ url, filter }))),
+      params,
+    )
   }
 
   subscribeMap(requests: { url: string; filter: Filter }[], params: SubscribeManyParams): SubCloser {
     params.onauth = params.onauth || params.doauth
 
-    const grouped = new Map<string, Filter[]>()
-    for (const req of requests) {
-      const { url, filter } = req
-      if (!grouped.has(url)) grouped.set(url, [])
-      grouped.get(url)!.push(filter)
-    }
-    const groupedRequests = Array.from(grouped.entries()).map(([url, filters]) => ({ url, filters }))
-
     if (this.trackRelays) {
       params.receivedEvent = (relay: AbstractRelay, id: string) => {
         let set = this.seenOn.get(id)
@@ -159,7 +136,9 @@ export class AbstractSimplePool {
 
     // open a subscription in all given relays
     const allOpened = Promise.all(
-      groupedRequests.map(async ({ url, filters }, i) => {
+      requests.map(async ({ url, filter }, i) => {
+        url = normalizeURL(url)
+
         let relay: AbstractRelay
         try {
           relay = await this.ensureRelay(url, {
@@ -170,7 +149,7 @@ export class AbstractSimplePool {
           return
         }
 
-        let subscription = relay.subscribe(filters, {
+        let subscription = relay.subscribe([filter], {
           ...params,
           oneose: () => handleEose(i),
           onclose: reason => {
@@ -178,7 +157,7 @@ export class AbstractSimplePool {
               relay
                 .auth(params.onauth)
                 .then(() => {
-                  relay.subscribe(filters, {
+                  relay.subscribe([filter], {
                     ...params,
                     oneose: () => handleEose(i),
                     onclose: reason => {
@@ -231,12 +210,12 @@ export class AbstractSimplePool {
 
   subscribeManyEose(
     relays: string[],
-    filter: Filter,
+    filters: Filter[],
     params: Pick<SubscribeManyParams, 'label' | 'id' | 'onevent' | 'onclose' | 'maxWait' | 'onauth' | 'doauth'>,
   ): SubCloser {
     params.onauth = params.onauth || params.doauth
 
-    const subcloser = this.subscribeMany(relays, filter, {
+    const subcloser = this.subscribeMany(relays, filters, {
       ...params,
       oneose() {
         subcloser.close('closed automatically on eose')

abstract-relay.ts

@@ -7,15 +7,22 @@ import { Queue, normalizeURL } from './utils.ts'
 import { makeAuthEvent } from './nip42.ts'
 import { yieldThread } from './helpers.ts'
 
-type RelayWebSocket = WebSocket & {
-  ping?(): void
-  on?(event: 'pong', listener: () => void): any
+export type RelayRecord = Record<string, { read: boolean; write: boolean }>
+
+export interface WebSocketBase {
+  new (url: string | URL, protocols?: string | string[] | undefined): WebSocketBaseConn
+}
+
+export interface WebSocketBaseConn {
+  onopen: ((this: WebSocketBaseConn, ev: Event) => any) | null
+  onclose: ((this: WebSocketBaseConn) => void) | null
+  onerror: ((this: WebSocketBaseConn, _: MessageEvent<any>) => void) | null
+  onmessage: ((_: MessageEvent<any>) => void) | null
 }
 
 export type AbstractRelayConstructorOptions = {
   verifyEvent: Nostr['verifyEvent']
-  websocketImplementation?: typeof WebSocket
-  enablePing?: boolean
+  websocketImplementation?: WebSocketBase
 }
 
 export class SendingOnClosedConnection extends Error {
@@ -35,16 +42,13 @@ export class AbstractRelay {
   public baseEoseTimeout: number = 4400
   public connectionTimeout: number = 4400
   public publishTimeout: number = 4400
-  public pingFrequency: number = 20000
-  public pingTimeout: number = 20000
   public openSubs: Map<string, Subscription> = new Map()
-  public enablePing: boolean | undefined
   private connectionTimeoutHandle: ReturnType<typeof setTimeout> | undefined
 
   private connectionPromise: Promise<void> | undefined
   private openCountRequests = new Map<string, CountResolver>()
   private openEventPublishes = new Map<string, EventPublishResolver>()
-  private ws: RelayWebSocket | undefined
+  private ws: WebSocket | undefined
   private incomingMessageQueue = new Queue<string>()
   private queueRunning = false
   private challenge: string | undefined
@@ -52,13 +56,12 @@ export class AbstractRelay {
   private serial: number = 0
   private verifyEvent: Nostr['verifyEvent']
 
-  private _WebSocket: typeof WebSocket
+  private _WebSocket: WebSocketBase
 
   constructor(url: string, opts: AbstractRelayConstructorOptions) {
     this.url = normalizeURL(url)
     this.verifyEvent = opts.verifyEvent
     this._WebSocket = opts.websocketImplementation || WebSocket
-    this.enablePing = opts.enablePing
   }
 
   static async connect(url: string, opts: AbstractRelayConstructorOptions): Promise<AbstractRelay> {
@@ -112,29 +115,30 @@ export class AbstractRelay {
       this.ws.onopen = () => {
         clearTimeout(this.connectionTimeoutHandle)
         this._connected = true
-        if (this.enablePing) {
-          this.pingpong()
-        }
         resolve()
       }
 
       this.ws.onerror = ev => {
         clearTimeout(this.connectionTimeoutHandle)
         reject((ev as any).message || 'websocket error')
+        if (this._connected) {
           this._connected = false
           this.connectionPromise = undefined
           this.onclose?.()
           this.closeAllSubscriptions('relay connection errored')
         }
+      }
 
       this.ws.onclose = ev => {
         clearTimeout(this.connectionTimeoutHandle)
         reject((ev as any).message || 'websocket closed')
+        if (this._connected) {
           this._connected = false
           this.connectionPromise = undefined
           this.onclose?.()
           this.closeAllSubscriptions('relay connection closed')
         }
+      }
 
       this.ws.onmessage = this._onmessage.bind(this)
     })
@@ -142,53 +146,6 @@ export class AbstractRelay {
     return this.connectionPromise
   }
 
-  private async waitForPingPong() {
-    return new Promise((res, err) => {
-      // listen for pong
-      ;(this.ws && this.ws.on && this.ws.on('pong', () => res(true))) || err("ws can't listen for pong")
-      // send a ping
-      this.ws && this.ws.ping && this.ws.ping()
-    })
-  }
-
-  private async waitForDummyReq() {
-    return new Promise((resolve, _) => {
-      // make a dummy request with expected empty eose reply
-      // ["REQ", "_", {"ids":["aaaa...aaaa"]}]
-      const sub = this.subscribe([{ ids: ['a'.repeat(64)] }], {
-        oneose: () => {
-          sub.close()
-          resolve(true)
-        },
-        eoseTimeout: this.pingTimeout + 1000,
-      })
-    })
-  }
-
-  // nodejs requires this magic here to ensure connections are closed when internet goes off and stuff
-  // in browsers it's done automatically. see https://github.com/nbd-wtf/nostr-tools/issues/491
-  private async pingpong() {
-    // if the websocket is connected
-    if (this.ws?.readyState === 1) {
-      // wait for either a ping-pong reply or a timeout
-      const result = await Promise.any([
-        // browsers don't have ping so use a dummy req
-        this.ws && this.ws.ping && this.ws.on ? this.waitForPingPong() : this.waitForDummyReq(),
-        new Promise(res => setTimeout(() => res(false), this.pingTimeout)),
-      ])
-      if (result) {
-        // schedule another pingpong
-        setTimeout(() => this.pingpong(), this.pingFrequency)
-      } else {
-        // pingpong closing socket
-        this.closeAllSubscriptions('pingpong timed out')
-        this._connected = false
-        this.onclose?.()
-        this.ws?.close()
-      }
-    }
-  }
-
   private async runQueue() {
     this.queueRunning = true
     while (true) {
@@ -374,8 +331,8 @@ export class AbstractRelay {
   public close() {
     this.closeAllSubscriptions('relay connection closed by us')
     this._connected = false
-    this.onclose?.()
     this.ws?.close()
+    this.onclose?.()
   }
 
   // this is the function assigned to this.ws.onmessage

jsr.json

@@ -1,6 +1,6 @@
 {
   "name": "@nostr/tools",
-  "version": "2.17.0",
+  "version": "2.15.1",
   "exports": {
     ".": "./index.ts",
     "./core": "./core.ts",

justfile

@@ -13,7 +13,7 @@ test-only file:
 
 publish: build
   # publish to jsr first because it is more strict and will catch some errors
-  perl -i -0pe "s/},\n  \"optionalDependencies\": {\n/,/" package.json
+  jq 'delete(.optionalDependencies)' package.json | sponge package.json
   jsr publish --allow-dirty
   git checkout -- package.json
 

nip19.test.ts

@@ -1,5 +1,4 @@
 import { describe, expect, test } from 'bun:test'
-// prettier-ignore
 import {
   decode,
   naddrEncode,

nip27.ts

@@ -90,19 +90,35 @@ export function* parse(content: string): Iterable<Block> {
           yield { type: 'text', text: content.substring(prevIndex, u - prefixLen) }
         }
 
-        if (/\.(png|jpe?g|gif|webp)$/i.test(url.pathname)) {
+        if (
+          url.pathname.endsWith('.png') ||
+          url.pathname.endsWith('.jpg') ||
+          url.pathname.endsWith('.jpeg') ||
+          url.pathname.endsWith('.gif') ||
+          url.pathname.endsWith('.webp')
+        ) {
           yield { type: 'image', url: url.toString() }
           index = end
           prevIndex = index
           continue
         }
-        if (/\.(mp4|avi|webm|mkv)$/i.test(url.pathname)) {
+        if (
+          url.pathname.endsWith('.mp4') ||
+          url.pathname.endsWith('.avi') ||
+          url.pathname.endsWith('.webm') ||
+          url.pathname.endsWith('.mkv')
+        ) {
           yield { type: 'video', url: url.toString() }
           index = end
           prevIndex = index
           continue
         }
-        if (/\.(mp3|aac|ogg|opus)$/i.test(url.pathname)) {
+        if (
+          url.pathname.endsWith('.mp3') ||
+          url.pathname.endsWith('.aac') ||
+          url.pathname.endsWith('.ogg') ||
+          url.pathname.endsWith('.opus')
+        ) {
           yield { type: 'audio', url: url.toString() }
           index = end
           prevIndex = index

nip29.ts

@@ -2,7 +2,7 @@ import { AbstractSimplePool } from './abstract-pool.ts'
 import { Subscription } from './abstract-relay.ts'
 import type { Event, EventTemplate } from './core.ts'
 import { fetchRelayInformation, RelayInformation } from './nip11.ts'
-import { decode, NostrTypeGuard } from './nip19.ts'
+import { AddressPointer, decode, NostrTypeGuard } from './nip19.ts'
 import { normalizeURL } from './utils.ts'
 
 /**

nip46.ts

@@ -5,6 +5,7 @@ import { getConversationKey, decrypt, encrypt } from './nip44.ts'
 import { NIP05_REGEX } from './nip05.ts'
 import { SimplePool } from './pool.ts'
 import { Handlerinformation, NostrConnect } from './kinds.ts'
+import type { RelayRecord } from './relay.ts'
 import { Signer } from './signer.ts'
 
 var _fetch: any
@@ -77,114 +78,6 @@ export async function queryBunkerProfile(nip05: string): Promise<BunkerPointer |
   }
 }
 
-export type NostrConnectParams = {
-  clientPubkey: string
-  relays: string[]
-  secret: string
-  perms?: string[]
-  name?: string
-  url?: string
-  image?: string
-}
-
-export type ParsedNostrConnectURI = {
-  protocol: 'nostrconnect'
-  clientPubkey: string
-  params: {
-    relays: string[]
-    secret: string
-    perms?: string[]
-    name?: string
-    url?: string
-    image?: string
-  }
-  originalString: string
-}
-
-export function createNostrConnectURI(params: NostrConnectParams): string {
-  if (!params.clientPubkey) {
-    throw new Error('clientPubkey is required.')
-  }
-  if (!params.relays || params.relays.length === 0) {
-    throw new Error('At least one relay is required.')
-  }
-  if (!params.secret) {
-    throw new Error('secret is required.')
-  }
-
-  const queryParams = new URLSearchParams()
-
-  params.relays.forEach(relay => {
-    queryParams.append('relay', relay)
-  })
-
-  queryParams.append('secret', params.secret)
-
-  if (params.perms && params.perms.length > 0) {
-    queryParams.append('perms', params.perms.join(','))
-  }
-  if (params.name) {
-    queryParams.append('name', params.name)
-  }
-  if (params.url) {
-    queryParams.append('url', params.url)
-  }
-  if (params.image) {
-    queryParams.append('image', params.image)
-  }
-
-  return `nostrconnect://${params.clientPubkey}?${queryParams.toString()}`
-}
-
-export function parseNostrConnectURI(uri: string): ParsedNostrConnectURI {
-  if (!uri.startsWith('nostrconnect://')) {
-    throw new Error('Invalid nostrconnect URI: Must start with "nostrconnect://".')
-  }
-
-  const [protocolAndPubkey, queryString] = uri.split('?')
-  if (!protocolAndPubkey || !queryString) {
-    throw new Error('Invalid nostrconnect URI: Missing query string.')
-  }
-
-  const clientPubkey = protocolAndPubkey.substring('nostrconnect://'.length)
-  if (!clientPubkey) {
-    throw new Error('Invalid nostrconnect URI: Missing client-pubkey.')
-  }
-
-  const queryParams = new URLSearchParams(queryString)
-
-  const relays = queryParams.getAll('relay')
-  if (relays.length === 0) {
-    throw new Error('Invalid nostrconnect URI: Missing "relay" parameter.')
-  }
-
-  const secret = queryParams.get('secret')
-  if (!secret) {
-    throw new Error('Invalid nostrconnect URI: Missing "secret" parameter.')
-  }
-
-  const permsString = queryParams.get('perms')
-  const perms = permsString ? permsString.split(',') : undefined
-
-  const name = queryParams.get('name') || undefined
-  const url = queryParams.get('url') || undefined
-  const image = queryParams.get('image') || undefined
-
-  return {
-    protocol: 'nostrconnect',
-    clientPubkey,
-    params: {
-      relays,
-      secret,
-      perms,
-      name,
-      url,
-      image,
-    },
-    originalString: uri,
-  }
-}
-
 export type BunkerSignerParams = {
   pool?: AbstractSimplePool
   onauth?: (url: string) => void
@@ -205,9 +98,8 @@ export class BunkerSigner implements Signer {
   }
   private waitingForAuth: { [id: string]: boolean }
   private secretKey: Uint8Array
-  // If the client initiates the connection, the two variables below can be filled in later.
-  private conversationKey!: Uint8Array
-  public bp!: BunkerPointer
+  private conversationKey: Uint8Array
+  public bp: BunkerPointer
 
   private cachedPubKey: string | undefined
 
@@ -217,95 +109,23 @@ export class BunkerSigner implements Signer {
    * @param remotePubkey - An optional remote public key. This is the key you want to sign as.
    * @param secretKey - An optional key pair.
    */
-  private constructor(clientSecretKey: Uint8Array, params: BunkerSignerParams) {
+  public constructor(clientSecretKey: Uint8Array, bp: BunkerPointer, params: BunkerSignerParams = {}) {
+    if (bp.relays.length === 0) {
+      throw new Error('no relays are specified for this bunker')
+    }
+
     this.params = params
     this.pool = params.pool || new SimplePool()
     this.secretKey = clientSecretKey
+    this.conversationKey = getConversationKey(clientSecretKey, bp.pubkey)
+    this.bp = bp
     this.isOpen = false
     this.idPrefix = Math.random().toString(36).substring(7)
     this.serial = 0
     this.listeners = {}
     this.waitingForAuth = {}
-  }
 
-  /**
-   * [Factory Method 1] Creates a Signer using bunker information (bunker:// URL or NIP-05).
-   * This method is used when the public key of the bunker is known in advance.
-   */
-  public static fromBunker(
-    clientSecretKey: Uint8Array,
-    bp: BunkerPointer,
-    params: BunkerSignerParams = {},
-  ): BunkerSigner {
-    if (bp.relays.length === 0) {
-      throw new Error('No relays specified for this bunker')
-    }
-
-    const signer = new BunkerSigner(clientSecretKey, params)
-
-    signer.conversationKey = getConversationKey(clientSecretKey, bp.pubkey)
-    signer.bp = bp
-
-    signer.setupSubscription(params)
-    return signer
-  }
-
-  /**
-   * [Factory Method 2] Creates a Signer using a nostrconnect:// URI generated by the client.
-   * In this method, the bunker initiates the connection by scanning the URI.
-   */
-  public static async fromURI(
-    clientSecretKey: Uint8Array,
-    connectionURI: string,
-    params: BunkerSignerParams = {},
-    maxWait: number = 300_000,
-  ): Promise<BunkerSigner> {
-    const signer = new BunkerSigner(clientSecretKey, params)
-    const parsedURI = parseNostrConnectURI(connectionURI)
-    const clientPubkey = getPublicKey(clientSecretKey)
-
-    return new Promise((resolve, reject) => {
-      const timer = setTimeout(() => {
-        sub.close()
-        reject(new Error(`Connection timed out after ${maxWait / 1000} seconds`))
-      }, maxWait)
-
-      const sub = signer.pool.subscribe(
-        parsedURI.params.relays,
-        { kinds: [NostrConnect], '#p': [clientPubkey] },
-        {
-          onevent: async (event: NostrEvent) => {
-            try {
-              const tempConvKey = getConversationKey(clientSecretKey, event.pubkey)
-              const decryptedContent = decrypt(event.content, tempConvKey)
-
-              const response = JSON.parse(decryptedContent)
-
-              if (response.result === parsedURI.params.secret) {
-                clearTimeout(timer)
-                sub.close()
-
-                signer.bp = {
-                  pubkey: event.pubkey,
-                  relays: parsedURI.params.relays,
-                  secret: parsedURI.params.secret,
-                }
-                signer.conversationKey = getConversationKey(clientSecretKey, event.pubkey)
-                signer.setupSubscription(params)
-                resolve(signer)
-              }
-            } catch (e) {
-              console.warn('Failed to process potential connection event', e)
-            }
-          },
-          onclose: () => {
-            clearTimeout(timer)
-            reject(new Error('Subscription closed before connection was established.'))
-          },
-          maxWait,
-        },
-      )
-    })
+    this.setupSubscription(params)
   }
 
   private setupSubscription(params: BunkerSignerParams) {
@@ -418,6 +238,13 @@ export class BunkerSigner implements Signer {
     return this.cachedPubKey
   }
 
+  /**
+   * @deprecated removed from NIP
+   */
+  async getRelays(): Promise<RelayRecord> {
+    return JSON.parse(await this.sendRequest('get_relays', []))
+  }
+
   /**
    * Signs an event using the remote private key.
    * @param event - The event to sign.
@@ -471,7 +298,7 @@ export async function createAccount(
 ): Promise<BunkerSigner> {
   if (email && !EMAIL_REGEX.test(email)) throw new Error('Invalid email')
 
-  let rpc = BunkerSigner.fromBunker(localSecretKey, bunker.bunkerPointer, params)
+  let rpc = new BunkerSigner(localSecretKey, bunker.bunkerPointer, params)
 
   let pubkey = await rpc.sendRequest('create_account', [username, domain, email || ''])
 

nip57.test.ts

@@ -1,7 +1,112 @@
-import { describe, test, expect } from 'bun:test'
+import { describe, test, expect, mock } from 'bun:test'
 import { finalizeEvent } from './pure.ts'
 import { getPublicKey, generateSecretKey } from './pure.ts'
-import { getSatoshisAmountFromBolt11, makeZapReceipt, validateZapRequest } from './nip57.ts'
+import {
+  getSatoshisAmountFromBolt11,
+  getZapEndpoint,
+  makeZapReceipt,
+  makeZapRequest,
+  useFetchImplementation,
+  validateZapRequest,
+} from './nip57.ts'
+import { buildEvent } from './test-helpers.ts'
+
+describe('getZapEndpoint', () => {
+  test('returns null if neither lud06 nor lud16 is present', async () => {
+    const metadata = buildEvent({ kind: 0, content: '{}' })
+    const result = await getZapEndpoint(metadata)
+
+    expect(result).toBeNull()
+  })
+
+  test('returns null if fetch fails', async () => {
+    const fetchImplementation = mock(() => Promise.reject(new Error()))
+    useFetchImplementation(fetchImplementation)
+
+    const metadata = buildEvent({ kind: 0, content: '{"lud16": "name@domain"}' })
+    const result = await getZapEndpoint(metadata)
+
+    expect(result).toBeNull()
+    expect(fetchImplementation).toHaveBeenCalledWith('https://domain/.well-known/lnurlp/name')
+  })
+
+  test('returns null if the response does not allow Nostr payments', async () => {
+    const fetchImplementation = mock(() => Promise.resolve({ json: () => ({ allowsNostr: false }) }))
+    useFetchImplementation(fetchImplementation)
+
+    const metadata = buildEvent({ kind: 0, content: '{"lud16": "name@domain"}' })
+    const result = await getZapEndpoint(metadata)
+
+    expect(result).toBeNull()
+    expect(fetchImplementation).toHaveBeenCalledWith('https://domain/.well-known/lnurlp/name')
+  })
+
+  test('returns the callback URL if the response allows Nostr payments', async () => {
+    const fetchImplementation = mock(() =>
+      Promise.resolve({
+        json: () => ({
+          allowsNostr: true,
+          nostrPubkey: 'pubkey',
+          callback: 'callback',
+        }),
+      }),
+    )
+    useFetchImplementation(fetchImplementation)
+
+    const metadata = buildEvent({ kind: 0, content: '{"lud16": "name@domain"}' })
+    const result = await getZapEndpoint(metadata)
+
+    expect(result).toBe('callback')
+    expect(fetchImplementation).toHaveBeenCalledWith('https://domain/.well-known/lnurlp/name')
+  })
+})
+
+describe('makeZapRequest', () => {
+  test('throws an error if amount is not given', () => {
+    expect(() =>
+      // @ts-expect-error
+      makeZapRequest({
+        profile: 'profile',
+        event: null,
+        relays: [],
+        comment: '',
+      }),
+    ).toThrow()
+  })
+
+  test('throws an error if profile is not given', () => {
+    expect(() =>
+      // @ts-expect-error
+      makeZapRequest({
+        event: null,
+        amount: 100,
+        relays: [],
+        comment: '',
+      }),
+    ).toThrow()
+  })
+
+  test('returns a valid Zap request', () => {
+    const result = makeZapRequest({
+      profile: 'profile',
+      event: 'event',
+      amount: 100,
+      relays: ['relay1', 'relay2'],
+      comment: 'comment',
+    })
+    expect(result.kind).toBe(9734)
+    expect(result.created_at).toBeCloseTo(Date.now() / 1000, 0)
+    expect(result.content).toBe('comment')
+    expect(result.tags).toEqual(
+      expect.arrayContaining([
+        ['p', 'profile'],
+        ['amount', '100'],
+        ['relays', 'relay1', 'relay2'],
+        ['e', 'event'],
+      ]),
+    )
+  })
+})
 
 describe('validateZapRequest', () => {
   test('returns an error message for invalid JSON', () => {

nip57.ts

@@ -1,6 +1,6 @@
 import { bech32 } from '@scure/base'
 
-import { NostrEvent, validateEvent, verifyEvent, type Event, type EventTemplate } from './pure.ts'
+import { validateEvent, verifyEvent, type Event, type EventTemplate } from './pure.ts'
 import { utf8Decoder } from './utils.ts'
 import { isReplaceableKind, isAddressableKind } from './kinds.ts'
 
@@ -42,44 +42,48 @@ export async function getZapEndpoint(metadata: Event): Promise<null | string> {
   return null
 }
 
-type ProfileZap = {
-  pubkey: string
+export function makeZapRequest({
+  profile,
+  event,
+  amount,
+  relays,
+  comment = '',
+}: {
+  profile: string
+  event: string | Event | null
   amount: number
-  comment?: string
+  comment: string
   relays: string[]
-}
+}): EventTemplate {
+  if (!amount) throw new Error('amount not given')
+  if (!profile) throw new Error('profile not given')
 
-type EventZap = {
-  event: NostrEvent
-  amount: number
-  comment?: string
-  relays: string[]
-}
-
-export function makeZapRequest(params: ProfileZap | EventZap): EventTemplate {
   let zr: EventTemplate = {
     kind: 9734,
     created_at: Math.round(Date.now() / 1000),
-    content: params.comment || '',
+    content: comment,
     tags: [
-      ['p', 'pubkey' in params ? params.pubkey : params.event.pubkey],
-      ['amount', params.amount.toString()],
-      ['relays', ...params.relays],
+      ['p', profile],
+      ['amount', amount.toString()],
+      ['relays', ...relays],
     ],
   }
 
-  if ('event' in params) {
-    zr.tags.push(['e', params.event.id])
-    if (isReplaceableKind(params.event.kind)) {
-      const a = ['a', `${params.event.kind}:${params.event.pubkey}:`]
+  if (event && typeof event === 'string') {
+    zr.tags.push(['e', event])
+  }
+  if (event && typeof event === 'object') {
+    // replacable event
+    if (isReplaceableKind(event.kind)) {
+      const a = ['a', `${event.kind}:${event.pubkey}:`]
       zr.tags.push(a)
-    } else if (isAddressableKind(params.event.kind)) {
-      let d = params.event.tags.find(([t, v]) => t === 'd' && v)
+      // addressable event
+    } else if (isAddressableKind(event.kind)) {
+      let d = event.tags.find(([t, v]) => t === 'd' && v)
       if (!d) throw new Error('d tag not found or is empty')
-      const a = ['a', `${params.event.kind}:${params.event.pubkey}:${d[1]}`]
+      const a = ['a', `${event.kind}:${event.pubkey}:${d[1]}`]
       zr.tags.push(a)
     }
-    zr.tags.push(['k', params.event.kind.toString()])
   }
 
   return zr

node-ws-relay.ts

@@ -0,0 +1,29 @@
+import WebSocket from 'ws'
+import { verifyEvent } from './pure.ts'
+import { AbstractRelay, WebSocketBase } from './abstract-relay.ts'
+
+class NodeWs extends WebSocket implements WebSocketBase {
+  constructor(url: string | URL, protocols?: string | string[] | undefined) {
+    super(url, {
+      protocol: Array.isArray(protocols) ? protocols[0] : protocols,
+    })
+
+    setInterval(() => {
+      this.ping()
+    }, 29000)
+  }
+}
+
+export class NodeWsRelay extends AbstractRelay {
+  constructor(url: string) {
+    super(url, { verifyEvent, websocketImplementation: NodeWs })
+  }
+
+  static async connect(url: string): Promise<NodeWsRelay> {
+    const relay = new NodeWsRelay(url)
+    await relay.connect()
+    return relay
+  }
+}
+
+export * from './abstract-relay.ts'

package.json

@@ -1,7 +1,7 @@
 {
   "type": "module",
   "name": "nostr-tools",
-  "version": "2.17.0",
+  "version": "2.15.0",
   "description": "Tools for making a Nostr client.",
   "repository": {
     "type": "git",
@@ -241,12 +241,15 @@
     "@noble/hashes": "1.3.1",
     "@scure/base": "1.1.1",
     "@scure/bip32": "1.3.1",
-    "@scure/bip39": "1.2.1",
-    "nostr-wasm": "0.1.0"
+    "@scure/bip39": "1.2.1"
   },
   "peerDependencies": {
     "typescript": ">=5.0.0"
   },
+  "optionalDependencies": {
+    "nostr-wasm": "0.1.0",
+    "ws": "^8.18.3"
+  },
   "peerDependenciesMeta": {
     "typescript": {
       "optional": true

pool.test.ts

@@ -35,18 +35,14 @@ test('removing duplicates when subscribing', async () => {
     priv,
   )
 
-  pool.subscribeMany(
-    relayURLs,
-    { authors: [pub] },
-    {
+  pool.subscribeMany(relayURLs, [{ authors: [pub] }], {
     onevent(event: Event) {
       // this should be called only once even though we're listening
       // to multiple relays because the events will be caught and
       // deduplicated efficiently (without even being parsed)
       received.push(event)
     },
-    },
-  )
+  })
 
   await Promise.any(pool.publish(relayURLs, event))
   await new Promise(resolve => setTimeout(resolve, 200)) // wait for the new published event to be received
@@ -59,12 +55,12 @@ test('same with double subs', async () => {
   let priv = generateSecretKey()
   let pub = getPublicKey(priv)
 
-  pool.subscribeMany(relayURLs, { authors: [pub] }, {
+  pool.subscribeMany(relayURLs, [{ authors: [pub] }], {
     onevent(event) {
       received.push(event)
     },
   })
-  pool.subscribeMany(relayURLs, { authors: [pub] }, {
+  pool.subscribeMany(relayURLs, [{ authors: [pub] }], {
     onevent(event) {
       received.push(event)
     },
@@ -172,7 +168,7 @@ test('query a bunch of events and cancel on eose', async () => {
   let events = new Set<string>()
 
   await new Promise<void>(resolve => {
-    pool.subscribeManyEose(relayURLs, { kinds: [0, 1, 2, 3, 4, 5, 6], limit: 40 }, {
+    pool.subscribeManyEose(relayURLs, [{ kinds: [0, 1, 2, 3, 4, 5, 6], limit: 40 }], {
       onevent(event) {
         events.add(event.id)
       },

pool.ts

@@ -14,8 +14,8 @@ export function useWebSocketImplementation(websocketImplementation: any) {
 }
 
 export class SimplePool extends AbstractSimplePool {
-  constructor(options?: { enablePing?: boolean }) {
-    super({ verifyEvent, websocketImplementation: _WebSocket, ...options })
+  constructor() {
+    super({ verifyEvent, websocketImplementation: _WebSocket })
   }
 }
 

relay.ts

@@ -1,21 +1,13 @@
 /* global WebSocket */
 
 import { verifyEvent } from './pure.ts'
-import { AbstractRelay } from './abstract-relay.ts'
+import { AbstractRelay, WebSocketBaseConn } from './abstract-relay.ts'
 
-var _WebSocket: typeof WebSocket
-
-try {
-  _WebSocket = WebSocket
-} catch {}
-
-export function useWebSocketImplementation(websocketImplementation: any) {
-  _WebSocket = websocketImplementation
-}
+class BrowserWs extends WebSocket implements WebSocketBase, WebSocketBaseConn {}
 
 export class Relay extends AbstractRelay {
   constructor(url: string) {
-    super(url, { verifyEvent, websocketImplementation: _WebSocket })
+    super(url, { verifyEvent, websocketImplementation: BrowserWs })
   }
 
   static async connect(url: string): Promise<Relay> {
@@ -25,6 +17,4 @@ export class Relay extends AbstractRelay {
   }
 }
 
-export type RelayRecord = Record<string, { read: boolean; write: boolean }>
-
 export * from './abstract-relay.ts'