another nip57 helper and bump version.

too complicated. if anyone wants this they can do it themselves.

.github/workflows/test.yml

@@ -1,7 +1,9 @@
 name: test every commit
 on:
-  - push
-  - pull_request
+  push:
+    branches:
+      - master
+  pull_request:
 
 jobs:
   test:

README.md

@@ -104,9 +104,6 @@ let pub = relay.publish(event)
 pub.on('ok', () => {
   console.log(`${relay.url} has accepted our event`)
 })
-pub.on('seen', () => {
-  console.log(`we saw the event on ${relay.url}`)
-})
 pub.on('failed', reason => {
   console.log(`failed to publish to ${relay.url}: ${reason}`)
 })
@@ -128,7 +125,7 @@ import 'websocket-polyfill'
 ### Interacting with multiple relays
 
 ```js
-import {pool} from 'nostr-tools'
+import {SimplePool} from 'nostr-tools'
 
 const pool = new SimplePool()
 
@@ -158,6 +155,11 @@ let events = await pool.list(relays, [{kinds: [0, 1]}])
 let event = await pool.get(relays, {
   ids: ['44e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245']
 })
+
+let relaysForEvent = pool.seenOn(
+  '44e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245'
+)
+// relaysForEvent will be an array of URLs from relays a given event was seen on
 ```
 
 ### Querying profile data from a NIP-05 address
@@ -288,6 +290,11 @@ Please consult the tests or [the source code](https://github.com/fiatjaf/nostr-t
 </script>
 ```
 
+## Plumbing
+
+1. Install [`just`](https://just.systems/)
+2. `just -l`
+
 ## License
 
 Public domain.

event.ts

@@ -16,23 +16,31 @@ export enum Kind {
   ChannelMetadata = 41,
   ChannelMessage = 42,
   ChannelHideMessage = 43,
-  ChannelMuteUser = 44
+  ChannelMuteUser = 44,
+  Report = 1984,
+  ZapRequest = 9734,
+  Zap = 9735,
+  RelayList = 10002,
+  ClientAuth = 22242,
+  Article = 30023
 }
 
-export type Event = {
-  id?: string
-  sig?: string
+export type EventTemplate = {
   kind: Kind
   tags: string[][]
-  pubkey: string
   content: string
   created_at: number
 }
 
-export function getBlankEvent(): Event {
+export type Event = EventTemplate & {
+  pubkey: string
+  id: string
+  sig: string
+}
+
+export function getBlankEvent(): EventTemplate {
   return {
     kind: 255,
-    pubkey: '',
     content: '',
     tags: [],
     created_at: 0
@@ -59,6 +67,7 @@ export function getEventHash(event: Event): string {
 }
 
 export function validateEvent(event: Event): boolean {
+  if (typeof event !== 'object') return false
   if (typeof event.content !== 'string') return false
   if (typeof event.created_at !== 'number') return false
   if (typeof event.pubkey !== 'string') return false

index.ts

@@ -9,6 +9,7 @@ export * as nip05 from './nip05'
 export * as nip06 from './nip06'
 export * as nip19 from './nip19'
 export * as nip26 from './nip26'
+export * as nip57 from './nip57'
 
 export * as fj from './fakejson'
 export * as utils from './utils'

justfile

@@ -11,3 +11,6 @@ test: build
 
 testOnly file: build
     jest {{file}}
+
+publish: build
+    npm publish

magic.ts

@@ -0,0 +1,140 @@
+import {Relay, relayInit} from './relay'
+import {Event} from './event'
+import {normalizeURL} from './utils'
+
+export default function (
+  writeableRelays: string[],
+  fallbackRelays: string[],
+  safeRelays: string[]
+) {
+  return new MagicPool(fallbackRelays, writeableRelays, safeRelays)
+}
+
+class MagicPool {
+  private _conn: {[url: string]: Relay}
+  private _fallback: {[url: string]: Relay}
+  private _write: {[url: string]: Relay}
+  private _safe: {[url: string]: Relay}
+
+  private _profileRelays: {[pubkey: string]: RelayTableScore}
+  private _tempCache: {[id: string]: Event}
+
+  constructor(
+    fallbackRelays: string[],
+    writeableRelays: string[],
+    safeRelays: string[] = [
+      'wss://eden.nostr.land',
+      'wss://nostr.milou.lol',
+      'wss://relay.minds.com/nostr/v1/ws'
+    ]
+  ) {
+    this._conn = {}
+    this._write = {}
+    this._fallback = {}
+    this._profileRelays = {}
+    this._tempCache = {}
+
+    const hasEventId = (id: string): boolean => id in this._tempCache
+    const init = (url: string) => {
+      this._conn[normalizeURL(url)] = relayInit(normalizeURL(url), hasEventId)
+    }
+
+    fallbackRelays.forEach(init)
+    writeableRelays.forEach(init)
+    safeRelays.forEach(init)
+
+    this._write = Object.fromEntries(
+      writeableRelays.map(url => [
+        normalizeURL(url),
+        this._conn[normalizeURL(url)]
+      ])
+    )
+    this._fallback = Object.fromEntries(
+      fallbackRelays.map(url => [
+        normalizeURL(url),
+        this._conn[normalizeURL(url)]
+      ])
+    )
+    this._safe = Object.fromEntries(
+      safeRelays.map(url => [normalizeURL(url), this._conn[normalizeURL(url)]])
+    )
+  }
+
+  publish(event: Event) {
+    return Promise.all(
+      Object.entries(this._write).map(
+        ([url, relay]) =>
+          new Promise(async resolve => {
+            await relay.connect()
+            let pub = relay.publish(event)
+            let to = setTimeout(() => {
+              let end = setTimeout(() => {
+                resolve({url, success: false, reason: 'timeout'})
+              }, 2500)
+              pub.on('seen', () => {
+                clearTimeout(end)
+                resolve({url, success: true, reason: 'seen'})
+              })
+            }, 2500)
+            pub.on('ok', () => {
+              clearTimeout(to)
+              resolve({url, success: true, reason: 'ok'})
+            })
+            pub.on('failed', (reason: string) => {
+              clearTimeout(to)
+              resolve({url, success: false, reason})
+            })
+          })
+      )
+    )
+  }
+
+  profile(
+    pubkey: string,
+    onUpdate: (events: Event[]) => void
+  ): {
+    page(n: number): void
+  } {
+    var relays = new Set()
+    let rts = this._profileRelays[pubkey]
+    if (rts) {
+      relays = rts.get(3)
+    }
+
+    let fallback = Object.values(this._fallback)
+    for (let i = 0; i < fallback.length; i++) {
+      if (relays.size < 3) {
+        relays.add(fallback[Math.floor(Math.random() * fallback.length)])
+      } else break
+    }
+
+    // start subscription
+    for (let r in relays) {
+        r.
+    }
+
+    return {
+      page(n: number) {}
+    }
+  }
+}
+
+class RelayTableScore {
+  seen: string[] = []
+  hinted: string[] = []
+  explicit: string[] = []
+
+  get(n: number): Set<string> {
+    let relays = new Set<string>()
+    for (let i = 0; i < n; i++) {
+      for (let j = 0; j < 3; j++) {
+        let v = [this.seen, this.explicit, this.hinted][j][i]
+        if (v) {
+          relays.add(v)
+          if (relays.size >= n) return relays
+        }
+      }
+    }
+    return relays
+  }
+}

nip57.ts

@@ -0,0 +1,107 @@
+import {bech32} from '@scure/base'
+
+import {Event, EventTemplate} from './event'
+import {utf8Decoder} from './utils'
+
+var _fetch: any
+
+try {
+  _fetch = fetch
+} catch {}
+
+export function useFetchImplementation(fetchImplementation: any) {
+  _fetch = fetchImplementation
+}
+
+export async function getZapEndpoint(metadata: Event): Promise<null | string> {
+  try {
+    let lnurl: string = ''
+    let {lud06, lud16} = JSON.parse(metadata.content)
+    if (lud06) {
+      let {words} = bech32.decode(lud06, 1000)
+      let data = bech32.fromWords(words)
+      lnurl = utf8Decoder.decode(data)
+    } else if (lud16) {
+      let [name, domain] = lud16.split('@')
+      lnurl = `https://${domain}/.well-known/lnurlp/${name}`
+    } else {
+      return null
+    }
+
+    let res = await _fetch(lnurl)
+    let body = await res.json()
+
+    if (body.allowsNostr && body.nostrPubkey) {
+      return body.callback
+    }
+  } catch (err) {
+    /*-*/
+  }
+
+  return null
+}
+
+export function makeZapRequest({
+  profile,
+  event,
+  amount,
+  relays,
+  comment = ''
+}: {
+  profile: string
+  event: string | null
+  amount: string
+  comment: string
+  relays: string[]
+}): EventTemplate {
+  let zr = {
+    kind: 9734,
+    created_at: Math.round(Date.now() / 1000),
+    content: comment,
+    tags: [
+      ['p', profile],
+      ['amount', amount],
+      ['relays', ...relays]
+    ]
+  }
+
+  if (event) {
+    zr.tags.push(['e', event])
+  }
+
+  return zr
+}
+
+export function makeZapReceipt({
+  zapRequest,
+  preimage,
+  bolt11,
+  paidAt
+}: {
+  zapRequest: string
+  preimage: string | null
+  bolt11: string
+  paidAt: Date
+}): EventTemplate {
+  let zr: Event = JSON.parse(zapRequest)
+  let tagsFromZapRequest = zr.tags.filter(
+    ([t]) => t === 'e' || t === 'p' || t === 'a'
+  )
+
+  let zap = {
+    kind: 9735,
+    created_at: Math.round(paidAt.getTime() / 1000),
+    content: '',
+    tags: [
+      ...tagsFromZapRequest,
+      ['bolt11', bolt11],
+      ['description', zapRequest]
+    ]
+  }
+
+  if (preimage) {
+    zap.tags.push(['preimage', preimage])
+  }
+
+  return zap
+}

package.json

@@ -1,6 +1,6 @@
 {
   "name": "nostr-tools",
-  "version": "1.3.1",
+  "version": "1.4.2",
   "description": "Tools for making a Nostr client.",
   "repository": {
     "type": "git",
@@ -9,11 +9,12 @@
   "main": "lib/nostr.cjs.js",
   "module": "lib/nostr.esm.js",
   "dependencies": {
-    "@noble/hashes": "^0.5.7",
-    "@noble/secp256k1": "^1.7.0",
+    "@noble/hashes": "1.0.0",
+    "@noble/secp256k1": "^1.7.1",
     "@scure/base": "^1.1.1",
-    "@scure/bip32": "^1.1.1",
-    "@scure/bip39": "^1.1.0"
+    "@scure/bip32": "^1.1.5",
+    "@scure/bip39": "^1.1.1",
+    "prettier": "^2.8.4"
   },
   "keywords": [
     "decentralization",
@@ -23,20 +24,20 @@
     "nostr"
   ],
   "devDependencies": {
-    "@types/node": "^18.0.3",
-    "@typescript-eslint/eslint-plugin": "^5.46.1",
-    "@typescript-eslint/parser": "^5.46.1",
+    "@types/node": "^18.13.0",
+    "@typescript-eslint/eslint-plugin": "^5.51.0",
+    "@typescript-eslint/parser": "^5.51.0",
     "esbuild": "0.16.9",
     "esbuild-plugin-alias": "^0.2.1",
-    "eslint": "^8.30.0",
+    "eslint": "^8.33.0",
     "eslint-plugin-babel": "^5.3.1",
-    "esm-loader-typescript": "^1.0.1",
+    "esm-loader-typescript": "^1.0.3",
     "events": "^3.3.0",
-    "jest": "^29.3.1",
-    "node-fetch": "2",
-    "ts-jest": "^29.0.3",
+    "jest": "^29.4.2",
+    "node-fetch": "^2.6.9",
+    "ts-jest": "^29.0.5",
     "tsd": "^0.22.0",
-    "typescript": "^4.9.4",
+    "typescript": "^4.9.5",
     "websocket-polyfill": "^0.0.3"
   }
 }

pool.test.js

@@ -20,7 +20,12 @@ let relays = [
 ]
 
 afterAll(async () => {
-  await pool.close([...relays, 'wss://nostr-relay.untethr.me'])
+  await pool.close([
+    ...relays,
+    'wss://nostr-relay.untethr.me',
+    'wss://offchain.pub',
+    'wss://eden.nostr.land'
+  ])
 })
 
 test('removing duplicates when querying', async () => {
@@ -120,4 +125,9 @@ test('list()', async () => {
       .reduce((acc, n) => (acc.indexOf(n) !== -1 ? acc : [...acc, n]), [])
       .length
   )
+
+  let relaysForAllEvents = events
+    .map(event => pool.seenOn(event.id))
+    .reduce((acc, n) => acc.concat(n), [])
+  expect(relaysForAllEvents.length).toBeGreaterThanOrEqual(events.length)
 })

pool.ts

@@ -6,10 +6,10 @@ import {SubscriptionOptions, Sub, Pub} from './relay'
 
 export class SimplePool {
   private _conn: {[url: string]: Relay}
+  private _seenOn: {[id: string]: Set<string>} = {} // a map of all events we've seen in each relay
 
-  constructor(defaultRelays: string[] = []) {
+  constructor() {
     this._conn = {}
-    defaultRelays.forEach(this.ensureRelay)
   }
 
   async close(relays: string[]): Promise<void> {
@@ -37,7 +37,12 @@ export class SimplePool {
   sub(relays: string[], filters: Filter[], opts?: SubscriptionOptions): Sub {
     let _knownIds: Set<string> = new Set()
     let modifiedOpts = opts || {}
-    modifiedOpts.alreadyHaveEvent = id => _knownIds.has(id)
+    modifiedOpts.alreadyHaveEvent = (id, url) => {
+      let set = this._seenOn[id] || new Set()
+      set.add(url)
+      this._seenOn[id] = set
+      return _knownIds.has(id)
+    }
 
     let subs: Sub[] = []
     let eventListeners: Set<(event: Event) => void> = new Set()
@@ -47,9 +52,7 @@ export class SimplePool {
     let eoseSent = false
     let eoseTimeout = setTimeout(() => {
       eoseSent = true
-      for (let cb of eoseListeners.values()) {
-        cb()
-      }
+      for (let cb of eoseListeners.values()) cb()
     }, 2400)
 
     relays.forEach(async relay => {
@@ -58,9 +61,7 @@ export class SimplePool {
       let s = r.sub(filters, modifiedOpts)
       s.on('event', (event: Event) => {
         _knownIds.add(event.id as string)
-        for (let cb of eventListeners.values()) {
-          cb(event)
-        }
+        for (let cb of eventListeners.values()) cb(event)
       })
       s.on('eose', () => {
         if (eoseSent) return
@@ -68,9 +69,7 @@ export class SimplePool {
         eosesMissing--
         if (eosesMissing === 0) {
           clearTimeout(eoseTimeout)
-          for (let cb of eoseListeners.values()) {
-            cb()
-          }
+          for (let cb of eoseListeners.values()) cb()
         }
       })
       subs.push(s)
@@ -85,9 +84,14 @@ export class SimplePool {
         subs.forEach(sub => sub.unsub())
       },
       on(type, cb) {
-        if (type === 'event') {
-          eventListeners.add(cb)
-        } else if (type === 'eose') eoseListeners.add(cb)
+        switch (type) {
+          case 'event':
+            eventListeners.add(cb)
+            break
+          case 'eose':
+            eoseListeners.add(cb)
+            break
+        }
       },
       off(type, cb) {
         if (type === 'event') {
@@ -147,6 +151,10 @@ export class SimplePool {
       return s
     })
   }
+
+  seenOn(id: string): string[] {
+    return Array.from(this._seenOn[id]?.values?.() || [])
+  }
 }
 
 function badPub(relay: string): Pub {

relay.ts

@@ -19,8 +19,8 @@ export type Relay = {
   off: (type: RelayEvent, cb: any) => void
 }
 export type Pub = {
-  on: (type: 'ok' | 'seen' | 'failed', cb: any) => void
-  off: (type: 'ok' | 'seen' | 'failed', cb: any) => void
+  on: (type: 'ok' | 'failed', cb: any) => void
+  off: (type: 'ok' | 'failed', cb: any) => void
 }
 export type Sub = {
   sub: (filters: Filter[], opts: SubscriptionOptions) => Sub
@@ -30,18 +30,14 @@ export type Sub = {
 }
 
 export type SubscriptionOptions = {
-  skipVerification?: boolean
-  alreadyHaveEvent?: null | ((id: string) => boolean)
   id?: string
+  skipVerification?: boolean
+  alreadyHaveEvent?: null | ((id: string, relay: string) => boolean)
 }
 
 export function relayInit(url: string): Relay {
   var ws: WebSocket
   var resolveClose: () => void
-  var setOpen: (value: PromiseLike<void> | void) => void
-  var untilOpen = new Promise<void>(resolve => {
-    setOpen = resolve
-  })
   var openSubs: {[id: string]: {filters: Filter[]} & SubscriptionOptions} = {}
   var listeners: {
     connect: Array<() => void>
@@ -74,7 +70,6 @@ export function relayInit(url: string): Relay {
 
       ws.onopen = () => {
         listeners.connect.forEach(cb => cb())
-        setOpen()
         resolve()
       }
       ws.onerror = () => {
@@ -112,7 +107,7 @@ export function relayInit(url: string): Relay {
           if (
             so &&
             so.alreadyHaveEvent &&
-            so.alreadyHaveEvent(getHex64(json, 'id'))
+            so.alreadyHaveEvent(getHex64(json, 'id'), url)
           ) {
             return
           }
@@ -140,15 +135,22 @@ export function relayInit(url: string): Relay {
               return
             case 'EOSE': {
               let id = data[1]
-              ;(subListeners[id]?.eose || []).forEach(cb => cb())
+              if (id in subListeners) {
+                subListeners[id].eose.forEach(cb => cb())
+                subListeners[id].eose = [] // 'eose' only happens once per sub, so stop listeners here
+              }
               return
             }
             case 'OK': {
               let id: string = data[1]
               let ok: boolean = data[2]
               let reason: string = data[3] || ''
-              if (ok) pubListeners[id]?.ok.forEach(cb => cb())
-              else pubListeners[id]?.failed.forEach(cb => cb(reason))
+              if (id in pubListeners) {
+                if (ok) pubListeners[id].ok.forEach(cb => cb())
+                else pubListeners[id].failed.forEach(cb => cb(reason))
+                pubListeners[id].ok = [] // 'ok' only happens once per pub, so stop listeners here
+                pubListeners[id].failed = []
+              }
               return
             }
             case 'NOTICE':
@@ -171,7 +173,6 @@ export function relayInit(url: string): Relay {
   async function trySend(params: [string, ...any]) {
     let msg = JSON.stringify(params)
 
-    await untilOpen
     try {
       ws.send(msg)
     } catch (err) {
@@ -271,50 +272,17 @@ export function relayInit(url: string): Relay {
       if (!event.id) throw new Error(`event ${event} has no id`)
       let id = event.id
 
-      var sent = false
-      var mustMonitor = false
-
       trySend(['EVENT', event])
-        .then(() => {
-          sent = true
-          if (mustMonitor) {
-            startMonitoring()
-            mustMonitor = false
-          }
-        })
-        .catch(() => {})
-
-      const startMonitoring = () => {
-        let monitor = sub([{ids: [id]}], {
-          id: `monitor-${id.slice(0, 5)}`
-        })
-        let willUnsub = setTimeout(() => {
-          ;(pubListeners[id]?.failed || []).forEach(cb =>
-            cb('event not seen after 5 seconds')
-          )
-          monitor.unsub()
-        }, 5000)
-        monitor.on('event', () => {
-          clearTimeout(willUnsub)
-          ;(pubListeners[id]?.seen || []).forEach(cb => cb())
-        })
-      }
 
       return {
-        on: (type: 'ok' | 'seen' | 'failed', cb: any) => {
+        on: (type: 'ok' | 'failed', cb: any) => {
           pubListeners[id] = pubListeners[id] || {
             ok: [],
-            seen: [],
             failed: []
           }
           pubListeners[id][type].push(cb)
-
-          if (type === 'seen') {
-            if (sent) startMonitoring()
-            else mustMonitor = true
-          }
         },
-        off: (type: 'ok' | 'seen' | 'failed', cb: any) => {
+        off: (type: 'ok' | 'failed', cb: any) => {
           let listeners = pubListeners[id]
           if (!listeners) return
           let idx = listeners[type].indexOf(cb)
@@ -324,6 +292,10 @@ export function relayInit(url: string): Relay {
     },
     connect,
     close(): Promise<void> {
+      listeners = {connect: [], disconnect: [], error: [], notice: []}
+      subListeners = {}
+      pubListeners = {}
+
       if (ws.readyState > 1) return Promise.resolve()
       ws.close()
       return new Promise<void>(resolve => {