fix tests, .seenOn() method for pools.

README.md

@@ -4,13 +4,6 @@ Tools for developing [Nostr](https://github.com/fiatjaf/nostr) clients.
 
 Only depends on _@scure_ and _@noble_ packages.
 
-## Installation
-
-```bash
- npm install nostr-tools # or yarn add nostr-tools
-```
-
-
 ## Usage
 
 ### Generating a private key and a public key
@@ -60,6 +53,8 @@ import {
 } from 'nostr-tools'
 
 const relay = relayInit('wss://relay.example.com')
+await relay.connect()
+
 relay.on('connect', () => {
   console.log(`connected to ${relay.url}`)
 })
@@ -67,8 +62,6 @@ relay.on('error', () => {
   console.log(`failed to connect to ${relay.url}`)
 })
 
-await relay.connect()
-
 // let's query for an event that exists
 let sub = relay.sub([
   {
@@ -111,6 +104,9 @@ 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}`)
 })
@@ -132,7 +128,7 @@ import 'websocket-polyfill'
 ### Interacting with multiple relays
 
 ```js
-import {SimplePool} from 'nostr-tools'
+import {pool} from 'nostr-tools'
 
 const pool = new SimplePool()
 
@@ -297,11 +293,6 @@ 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

@@ -2,7 +2,6 @@ import * as secp256k1 from '@noble/secp256k1'
 import {sha256} from '@noble/hashes/sha256'
 
 import {utf8Encoder} from './utils'
-import {getPublicKey} from './keys'
 
 /* eslint-disable no-unused-vars */
 export enum Kind {
@@ -17,49 +16,30 @@ export enum Kind {
   ChannelMetadata = 41,
   ChannelMessage = 42,
   ChannelHideMessage = 43,
-  ChannelMuteUser = 44,
-  Report = 1984,
-  ZapRequest = 9734,
-  Zap = 9735,
-  RelayList = 10002,
-  ClientAuth = 22242,
-  Article = 30023
+  ChannelMuteUser = 44
 }
 
-export type EventTemplate = {
+export type Event = {
+  id?: string
+  sig?: string
   kind: Kind
   tags: string[][]
+  pubkey: string
   content: string
   created_at: number
 }
 
-export type UnsignedEvent = EventTemplate & {
-  pubkey: string
-}
-
-export type Event = UnsignedEvent & {
-  id: string
-  sig: string
-}
-
-export function getBlankEvent(): EventTemplate {
+export function getBlankEvent(): Event {
   return {
     kind: 255,
+    pubkey: '',
     content: '',
     tags: [],
     created_at: 0
   }
 }
 
-export function finishEvent(t: EventTemplate, privateKey: string): Event {
-  let event = t as Event
-  event.pubkey = getPublicKey(privateKey)
-  event.id = getEventHash(event)
-  event.sig = signEvent(event, privateKey)
-  return event
-}
-
-export function serializeEvent(evt: UnsignedEvent): string {
+export function serializeEvent(evt: Event): string {
   if (!validateEvent(evt))
     throw new Error("can't serialize event with wrong or missing properties")
 
@@ -73,13 +53,12 @@ export function serializeEvent(evt: UnsignedEvent): string {
   ])
 }
 
-export function getEventHash(event: UnsignedEvent): string {
+export function getEventHash(event: Event): string {
   let eventHash = sha256(utf8Encoder.encode(serializeEvent(event)))
   return secp256k1.utils.bytesToHex(eventHash)
 }
 
-export function validateEvent(event: UnsignedEvent): boolean {
-  if (typeof event !== 'object') return false
+export function validateEvent(event: Event): boolean {
   if (typeof event.content !== 'string') return false
   if (typeof event.created_at !== 'number') return false
   if (typeof event.pubkey !== 'string') return false
@@ -105,7 +84,7 @@ export function verifySignature(event: Event & {sig: string}): boolean {
   )
 }
 
-export function signEvent(event: UnsignedEvent, key: string): string {
+export function signEvent(event: Event, key: string): string {
   return secp256k1.utils.bytesToHex(
     secp256k1.schnorr.signSync(getEventHash(event), key)
   )

index.ts

@@ -9,7 +9,6 @@ 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'

nip19.test.js

@@ -34,25 +34,3 @@ test('encode and decode nprofile', () => {
   expect(data.relays).toContain(relays[0])
   expect(data.relays).toContain(relays[1])
 })
-
-test('encode and decode naddr', () => {
-  let pk = getPublicKey(generatePrivateKey())
-  let relays = [
-    'wss://relay.nostr.example.mydomain.example.com',
-    'wss://nostr.banana.com'
-  ]
-  let naddr = nip19.naddrEncode({
-    pubkey: pk,
-    relays,
-    kind: 30023,
-    identifier: 'banana'
-  })
-  expect(naddr).toMatch(/naddr1\w+/)
-  let {type, data} = nip19.decode(naddr)
-  expect(type).toEqual('naddr')
-  expect(data.pubkey).toEqual(pk)
-  expect(data.relays).toContain(relays[0])
-  expect(data.relays).toContain(relays[1])
-  expect(data.kind).toEqual(30023)
-  expect(data.identifier).toEqual('banana')
-})

nip19.ts

@@ -15,75 +15,46 @@ export type EventPointer = {
   relays?: string[]
 }
 
-export type AddressPointer = {
-  identifier: string
-  pubkey: string
-  kind: number
-  relays?: string[]
-}
-
 export function decode(nip19: string): {
   type: string
-  data: ProfilePointer | EventPointer | AddressPointer | string
+  data: ProfilePointer | EventPointer | string
 } {
   let {prefix, words} = bech32.decode(nip19, Bech32MaxSize)
   let data = new Uint8Array(bech32.fromWords(words))
 
-  switch (prefix) {
-    case 'nprofile': {
-      let tlv = parseTLV(data)
-      if (!tlv[0]?.[0]) throw new Error('missing TLV 0 for nprofile')
-      if (tlv[0][0].length !== 32) throw new Error('TLV 0 should be 32 bytes')
+  if (prefix === 'nprofile') {
+    let tlv = parseTLV(data)
+    if (!tlv[0]?.[0]) throw new Error('missing TLV 0 for nprofile')
+    if (tlv[0][0].length !== 32) throw new Error('TLV 0 should be 32 bytes')
 
-      return {
-        type: 'nprofile',
-        data: {
-          pubkey: secp256k1.utils.bytesToHex(tlv[0][0]),
-          relays: tlv[1].map(d => utf8Decoder.decode(d))
-        }
+    return {
+      type: 'nprofile',
+      data: {
+        pubkey: secp256k1.utils.bytesToHex(tlv[0][0]),
+        relays: tlv[1].map(d => utf8Decoder.decode(d))
       }
     }
-    case 'nevent': {
-      let tlv = parseTLV(data)
-      if (!tlv[0]?.[0]) throw new Error('missing TLV 0 for nevent')
-      if (tlv[0][0].length !== 32) throw new Error('TLV 0 should be 32 bytes')
-
-      return {
-        type: 'nevent',
-        data: {
-          id: secp256k1.utils.bytesToHex(tlv[0][0]),
-          relays: tlv[1].map(d => utf8Decoder.decode(d))
-        }
-      }
-    }
-
-    case 'naddr': {
-      let tlv = parseTLV(data)
-      if (!tlv[0]?.[0]) throw new Error('missing TLV 0 for naddr')
-      if (!tlv[2]?.[0]) throw new Error('missing TLV 2 for naddr')
-      if (tlv[2][0].length !== 32) throw new Error('TLV 2 should be 32 bytes')
-      if (!tlv[3]?.[0]) throw new Error('missing TLV 3 for naddr')
-      if (tlv[3][0].length !== 4) throw new Error('TLV 3 should be 4 bytes')
-
-      return {
-        type: 'naddr',
-        data: {
-          identifier: utf8Decoder.decode(tlv[0][0]),
-          pubkey: secp256k1.utils.bytesToHex(tlv[2][0]),
-          kind: parseInt(secp256k1.utils.bytesToHex(tlv[3][0]), 16),
-          relays: tlv[1].map(d => utf8Decoder.decode(d))
-        }
-      }
-    }
-
-    case 'nsec':
-    case 'npub':
-    case 'note':
-      return {type: prefix, data: secp256k1.utils.bytesToHex(data)}
-
-    default:
-      throw new Error(`unknown prefix ${prefix}`)
   }
+
+  if (prefix === 'nevent') {
+    let tlv = parseTLV(data)
+    if (!tlv[0]?.[0]) throw new Error('missing TLV 0 for nevent')
+    if (tlv[0][0].length !== 32) throw new Error('TLV 0 should be 32 bytes')
+
+    return {
+      type: 'nevent',
+      data: {
+        id: secp256k1.utils.bytesToHex(tlv[0][0]),
+        relays: tlv[1].map(d => utf8Decoder.decode(d))
+      }
+    }
+  }
+
+  if (prefix === 'nsec' || prefix === 'npub' || prefix === 'note') {
+    return {type: prefix, data: secp256k1.utils.bytesToHex(data)}
+  }
+
+  throw new Error(`unknown prefix ${prefix}`)
 }
 
 type TLV = {[t: number]: Uint8Array[]}
@@ -139,20 +110,6 @@ export function neventEncode(event: EventPointer): string {
   return bech32.encode('nevent', words, Bech32MaxSize)
 }
 
-export function naddrEncode(addr: AddressPointer): string {
-  let kind = new ArrayBuffer(4)
-  new DataView(kind).setUint32(0, addr.kind, false)
-
-  let data = encodeTLV({
-    0: [utf8Encoder.encode(addr.identifier)],
-    1: (addr.relays || []).map(url => utf8Encoder.encode(url)),
-    2: [secp256k1.utils.hexToBytes(addr.pubkey)],
-    3: [new Uint8Array(kind)]
-  })
-  let words = bech32.toWords(data)
-  return bech32.encode('naddr', words, Bech32MaxSize)
-}
-
 function encodeTLV(tlv: TLV): Uint8Array {
   let entries: Uint8Array[] = []
 

nip57.ts

@@ -1,138 +0,0 @@
-import {bech32} from '@scure/base'
-
-import {Event, EventTemplate, validateEvent, verifySignature} 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: number
-  comment: string
-  relays: string[]
-}): EventTemplate {
-  if (!amount) throw new Error('amount not given')
-  if (!profile) throw new Error('profile not given')
-
-  let zr = {
-    kind: 9734,
-    created_at: Math.round(Date.now() / 1000),
-    content: comment,
-    tags: [
-      ['p', profile],
-      ['amount', amount.toString()],
-      ['relays', ...relays]
-    ]
-  }
-
-  if (event) {
-    zr.tags.push(['e', event])
-  }
-
-  return zr
-}
-
-export function validateZapRequest(zapRequestString: string): string | null {
-  let zapRequest: Event
-
-  try {
-    zapRequest = JSON.parse(zapRequestString)
-  } catch (err) {
-    return 'Invalid zap request JSON.'
-  }
-
-  if (!validateEvent(zapRequest))
-    return 'Zap request is not a valid Nostr event.'
-  if (!verifySignature(zapRequest)) return 'Invalid signature on zap request.'
-
-  let p = zapRequest.tags.find(([t, v]) => t === 'p' && v)
-  if (!p) return "Zap request doesn't have a 'p' tag."
-  if (!p[1].match(/^[a-f0-9]{64}$/))
-    return "Zap request 'p' tag is not valid hex."
-
-  let e = zapRequest.tags.find(([t, v]) => t === 'e' && v)
-  if (e && !e[1].match(/^[a-f0-9]{64}$/))
-    return "Zap request 'e' tag is not valid hex."
-
-  let relays = zapRequest.tags.find(([t, v]) => t === 'relays' && v)
-  if (!relays) return "Zap request doesn't have a 'relays' tag."
-
-  return null
-}
-
-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.5.0",
+  "version": "1.3.2",
   "description": "Tools for making a Nostr client.",
   "repository": {
     "type": "git",
@@ -9,12 +9,11 @@
   "main": "lib/nostr.cjs.js",
   "module": "lib/nostr.esm.js",
   "dependencies": {
-    "@noble/hashes": "1.0.0",
-    "@noble/secp256k1": "^1.7.1",
+    "@noble/hashes": "^0.5.7",
+    "@noble/secp256k1": "^1.7.0",
     "@scure/base": "^1.1.1",
-    "@scure/bip32": "^1.1.5",
-    "@scure/bip39": "^1.1.1",
-    "prettier": "^2.8.4"
+    "@scure/bip32": "^1.1.1",
+    "@scure/bip39": "^1.1.0"
   },
   "keywords": [
     "decentralization",
@@ -24,20 +23,20 @@
     "nostr"
   ],
   "devDependencies": {
-    "@types/node": "^18.13.0",
-    "@typescript-eslint/eslint-plugin": "^5.51.0",
-    "@typescript-eslint/parser": "^5.51.0",
+    "@types/node": "^18.0.3",
+    "@typescript-eslint/eslint-plugin": "^5.46.1",
+    "@typescript-eslint/parser": "^5.46.1",
     "esbuild": "0.16.9",
     "esbuild-plugin-alias": "^0.2.1",
-    "eslint": "^8.33.0",
+    "eslint": "^8.30.0",
     "eslint-plugin-babel": "^5.3.1",
-    "esm-loader-typescript": "^1.0.3",
+    "esm-loader-typescript": "^1.0.1",
     "events": "^3.3.0",
-    "jest": "^29.4.2",
-    "node-fetch": "^2.6.9",
-    "ts-jest": "^29.0.5",
+    "jest": "^29.3.1",
+    "node-fetch": "2",
+    "ts-jest": "^29.0.3",
     "tsd": "^0.22.0",
-    "typescript": "^4.9.5",
+    "typescript": "^4.9.4",
     "websocket-polyfill": "^0.0.3"
   }
 }

relay.ts

@@ -19,8 +19,8 @@ export type Relay = {
   off: (type: RelayEvent, cb: any) => void
 }
 export type Pub = {
-  on: (type: 'ok' | 'failed', cb: any) => void
-  off: (type: 'ok' | 'failed', cb: any) => void
+  on: (type: 'ok' | 'seen' | 'failed', cb: any) => void
+  off: (type: 'ok' | 'seen' | 'failed', cb: any) => void
 }
 export type Sub = {
   sub: (filters: Filter[], opts: SubscriptionOptions) => Sub
@@ -38,6 +38,10 @@ export type SubscriptionOptions = {
 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>
@@ -70,6 +74,7 @@ export function relayInit(url: string): Relay {
 
       ws.onopen = () => {
         listeners.connect.forEach(cb => cb())
+        setOpen()
         resolve()
       }
       ws.onerror = () => {
@@ -135,22 +140,15 @@ export function relayInit(url: string): Relay {
               return
             case 'EOSE': {
               let id = data[1]
-              if (id in subListeners) {
-                subListeners[id].eose.forEach(cb => cb())
-                subListeners[id].eose = [] // 'eose' only happens once per sub, so stop listeners here
-              }
+              ;(subListeners[id]?.eose || []).forEach(cb => cb())
               return
             }
             case 'OK': {
               let id: string = data[1]
               let ok: boolean = data[2]
               let reason: string = data[3] || ''
-              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 = []
-              }
+              if (ok) pubListeners[id]?.ok.forEach(cb => cb())
+              else pubListeners[id]?.failed.forEach(cb => cb(reason))
               return
             }
             case 'NOTICE':
@@ -173,6 +171,7 @@ 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) {
@@ -272,17 +271,50 @@ 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' | 'failed', cb: any) => {
+        on: (type: 'ok' | 'seen' | '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' | 'failed', cb: any) => {
+        off: (type: 'ok' | 'seen' | 'failed', cb: any) => {
           let listeners = pubListeners[id]
           if (!listeners) return
           let idx = listeners[type].indexOf(cb)
@@ -292,10 +324,6 @@ 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 => {