Compare commits

..

1 Commits

Author SHA1 Message Date
fiatjaf
d46c5f947c fix tests, .seenOn() method for pools. 2023-02-09 15:11:09 -03:00
13 changed files with 287 additions and 389 deletions

View File

@@ -4,13 +4,6 @@ Tools for developing [Nostr](https://github.com/fiatjaf/nostr) clients.
Only depends on _@scure_ and _@noble_ packages. Only depends on _@scure_ and _@noble_ packages.
## Installation
```bash
npm install nostr-tools # or yarn add nostr-tools
```
## Usage ## Usage
### Generating a private key and a public key ### Generating a private key and a public key
@@ -60,6 +53,8 @@ import {
} from 'nostr-tools' } from 'nostr-tools'
const relay = relayInit('wss://relay.example.com') const relay = relayInit('wss://relay.example.com')
await relay.connect()
relay.on('connect', () => { relay.on('connect', () => {
console.log(`connected to ${relay.url}`) console.log(`connected to ${relay.url}`)
}) })
@@ -67,8 +62,6 @@ relay.on('error', () => {
console.log(`failed to connect to ${relay.url}`) console.log(`failed to connect to ${relay.url}`)
}) })
await relay.connect()
// let's query for an event that exists // let's query for an event that exists
let sub = relay.sub([ let sub = relay.sub([
{ {
@@ -111,6 +104,9 @@ let pub = relay.publish(event)
pub.on('ok', () => { pub.on('ok', () => {
console.log(`${relay.url} has accepted our event`) console.log(`${relay.url} has accepted our event`)
}) })
pub.on('seen', () => {
console.log(`we saw the event on ${relay.url}`)
})
pub.on('failed', reason => { pub.on('failed', reason => {
console.log(`failed to publish to ${relay.url}: ${reason}`) console.log(`failed to publish to ${relay.url}: ${reason}`)
}) })
@@ -120,7 +116,7 @@ let event = await relay.get({
ids: ['44e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245'] ids: ['44e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245']
}) })
relay.close() await relay.close()
``` ```
To use this on Node.js you first must install `websocket-polyfill` and import it: To use this on Node.js you first must install `websocket-polyfill` and import it:
@@ -132,7 +128,7 @@ import 'websocket-polyfill'
### Interacting with multiple relays ### Interacting with multiple relays
```js ```js
import {SimplePool} from 'nostr-tools' import {pool} from 'nostr-tools'
const pool = new SimplePool() const pool = new SimplePool()
@@ -140,14 +136,16 @@ let relays = ['wss://relay.example.com', 'wss://relay.example2.com']
let relay = await pool.ensureRelay('wss://relay.example3.com') let relay = await pool.ensureRelay('wss://relay.example3.com')
let sub = pool.sub([...relays, relay], [{ let subs = pool.sub([...relays, relay], {
authors: ['32e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245'] authors: ['32e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245']
}]) })
sub.on('event', event => { subs.forEach(sub =>
sub.on('event', event => {
// this will only be called once the first time the event is received // this will only be called once the first time the event is received
// ... // ...
}) })
)
let pubs = pool.publish(relays, newEvent) let pubs = pool.publish(relays, newEvent)
pubs.forEach(pub => pubs.forEach(pub =>
@@ -295,11 +293,6 @@ Please consult the tests or [the source code](https://github.com/fiatjaf/nostr-t
</script> </script>
``` ```
## Plumbing
1. Install [`just`](https://just.systems/)
2. `just -l`
## License ## License
Public domain. Public domain.

View File

@@ -1,6 +1,5 @@
#!/usr/bin/env node #!/usr/bin/env node
const fs = require('fs')
const esbuild = require('esbuild') const esbuild = require('esbuild')
let common = { let common = {
@@ -12,16 +11,11 @@ let common = {
esbuild esbuild
.build({ .build({
...common, ...common,
outfile: 'lib/esm/nostr.mjs', outfile: 'lib/nostr.esm.js',
format: 'esm', format: 'esm',
packages: 'external' packages: 'external'
}) })
.then(() => { .then(() => console.log('esm build success.'))
const packageJson = JSON.stringify({ type: 'module' })
fs.writeFileSync(`${__dirname}/lib/esm/package.json`, packageJson, 'utf8')
console.log('esm build success.')
})
esbuild esbuild
.build({ .build({

View File

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

View File

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

140
magic.ts Normal file
View File

@@ -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
}
}

View File

@@ -34,37 +34,3 @@ test('encode and decode nprofile', () => {
expect(data.relays).toContain(relays[0]) expect(data.relays).toContain(relays[0])
expect(data.relays).toContain(relays[1]) 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')
})
test('encode and decode naddr from habla.news', () => {
let {type, data} = nip19.decode(
'naddr1qq98yetxv4ex2mnrv4esygrl54h466tz4v0re4pyuavvxqptsejl0vxcmnhfl60z3rth2xkpjspsgqqqw4rsf34vl5'
)
expect(type).toEqual('naddr')
expect(data.pubkey).toEqual(
'7fa56f5d6962ab1e3cd424e758c3002b8665f7b0d8dcee9fe9e288d7751ac194'
)
expect(data.kind).toEqual(30023)
expect(data.identifier).toEqual('references')
})

View File

@@ -15,22 +15,14 @@ export type EventPointer = {
relays?: string[] relays?: string[]
} }
export type AddressPointer = {
identifier: string
pubkey: string
kind: number
relays?: string[]
}
export function decode(nip19: string): { export function decode(nip19: string): {
type: string type: string
data: ProfilePointer | EventPointer | AddressPointer | string data: ProfilePointer | EventPointer | string
} { } {
let {prefix, words} = bech32.decode(nip19, Bech32MaxSize) let {prefix, words} = bech32.decode(nip19, Bech32MaxSize)
let data = new Uint8Array(bech32.fromWords(words)) let data = new Uint8Array(bech32.fromWords(words))
switch (prefix) { if (prefix === 'nprofile') {
case 'nprofile': {
let tlv = parseTLV(data) let tlv = parseTLV(data)
if (!tlv[0]?.[0]) throw new Error('missing TLV 0 for nprofile') 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 (tlv[0][0].length !== 32) throw new Error('TLV 0 should be 32 bytes')
@@ -39,11 +31,12 @@ export function decode(nip19: string): {
type: 'nprofile', type: 'nprofile',
data: { data: {
pubkey: secp256k1.utils.bytesToHex(tlv[0][0]), pubkey: secp256k1.utils.bytesToHex(tlv[0][0]),
relays: tlv[1] ? tlv[1].map(d => utf8Decoder.decode(d)) : [] relays: tlv[1].map(d => utf8Decoder.decode(d))
} }
} }
} }
case 'nevent': {
if (prefix === 'nevent') {
let tlv = parseTLV(data) let tlv = parseTLV(data)
if (!tlv[0]?.[0]) throw new Error('missing TLV 0 for nevent') 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') if (tlv[0][0].length !== 32) throw new Error('TLV 0 should be 32 bytes')
@@ -52,38 +45,16 @@ export function decode(nip19: string): {
type: 'nevent', type: 'nevent',
data: { data: {
id: secp256k1.utils.bytesToHex(tlv[0][0]), id: secp256k1.utils.bytesToHex(tlv[0][0]),
relays: tlv[1] ? tlv[1].map(d => utf8Decoder.decode(d)) : [] relays: tlv[1].map(d => utf8Decoder.decode(d))
} }
} }
} }
case 'naddr': { if (prefix === 'nsec' || prefix === 'npub' || prefix === 'note') {
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] ? tlv[1].map(d => utf8Decoder.decode(d)) : []
}
}
}
case 'nsec':
case 'npub':
case 'note':
return {type: prefix, data: secp256k1.utils.bytesToHex(data)} return {type: prefix, data: secp256k1.utils.bytesToHex(data)}
default:
throw new Error(`unknown prefix ${prefix}`)
} }
throw new Error(`unknown prefix ${prefix}`)
} }
type TLV = {[t: number]: Uint8Array[]} type TLV = {[t: number]: Uint8Array[]}
@@ -139,20 +110,6 @@ export function neventEncode(event: EventPointer): string {
return bech32.encode('nevent', words, Bech32MaxSize) 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 { function encodeTLV(tlv: TLV): Uint8Array {
let entries: Uint8Array[] = [] let entries: Uint8Array[] = []

138
nip57.ts
View File

@@ -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
}

View File

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

View File

@@ -19,8 +19,8 @@ let relays = [
'wss://nostr.zebedee.cloud/' 'wss://nostr.zebedee.cloud/'
] ]
afterAll(() => { afterAll(async () => {
pool.close([ await pool.close([
...relays, ...relays,
'wss://nostr-relay.untethr.me', 'wss://nostr-relay.untethr.me',
'wss://offchain.pub', 'wss://offchain.pub',

34
pool.ts
View File

@@ -8,20 +8,17 @@ export class SimplePool {
private _conn: {[url: string]: Relay} private _conn: {[url: string]: Relay}
private _seenOn: {[id: string]: Set<string>} = {} // a map of all events we've seen in each relay private _seenOn: {[id: string]: Set<string>} = {} // a map of all events we've seen in each relay
private eoseSubTimeout: number constructor() {
private getTimeout: number
constructor(options: {eoseSubTimeout?: number; getTimeout?: number} = {}) {
this._conn = {} this._conn = {}
this.eoseSubTimeout = options.eoseSubTimeout || 3400
this.getTimeout = options.getTimeout || 3400
} }
close(relays: string[]): void { async close(relays: string[]): Promise<void> {
relays.forEach(url => { await Promise.all(
relays.map(async url => {
let relay = this._conn[normalizeURL(url)] let relay = this._conn[normalizeURL(url)]
if (relay) relay.close() if (relay) await relay.close()
}) })
)
} }
async ensureRelay(url: string): Promise<Relay> { async ensureRelay(url: string): Promise<Relay> {
@@ -56,16 +53,10 @@ export class SimplePool {
let eoseTimeout = setTimeout(() => { let eoseTimeout = setTimeout(() => {
eoseSent = true eoseSent = true
for (let cb of eoseListeners.values()) cb() for (let cb of eoseListeners.values()) cb()
}, this.eoseSubTimeout) }, 2400)
relays.forEach(async relay => { relays.forEach(async relay => {
let r let r = await this.ensureRelay(relay)
try {
r = await this.ensureRelay(relay)
} catch (err) {
handleEose()
return
}
if (!r) return if (!r) return
let s = r.sub(filters, modifiedOpts) let s = r.sub(filters, modifiedOpts)
s.on('event', (event: Event) => { s.on('event', (event: Event) => {
@@ -74,17 +65,14 @@ export class SimplePool {
}) })
s.on('eose', () => { s.on('eose', () => {
if (eoseSent) return if (eoseSent) return
handleEose()
})
subs.push(s)
function handleEose() {
eosesMissing-- eosesMissing--
if (eosesMissing === 0) { if (eosesMissing === 0) {
clearTimeout(eoseTimeout) clearTimeout(eoseTimeout)
for (let cb of eoseListeners.values()) cb() for (let cb of eoseListeners.values()) cb()
} }
} })
subs.push(s)
}) })
let greaterSub: Sub = { let greaterSub: Sub = {
@@ -125,7 +113,7 @@ export class SimplePool {
let timeout = setTimeout(() => { let timeout = setTimeout(() => {
sub.unsub() sub.unsub()
resolve(null) resolve(null)
}, this.getTimeout) }, 1500)
sub.on('event', (event: Event) => { sub.on('event', (event: Event) => {
resolve(event) resolve(event)
clearTimeout(timeout) clearTimeout(timeout)

View File

@@ -15,8 +15,8 @@ beforeAll(() => {
relay.connect() relay.connect()
}) })
afterAll(() => { afterAll(async () => {
relay.close() await relay.close()
}) })
test('connectivity', () => { test('connectivity', () => {

View File

@@ -10,7 +10,7 @@ export type Relay = {
url: string url: string
status: number status: number
connect: () => Promise<void> connect: () => Promise<void>
close: () => void close: () => Promise<void>
sub: (filters: Filter[], opts?: SubscriptionOptions) => Sub sub: (filters: Filter[], opts?: SubscriptionOptions) => Sub
list: (filters: Filter[], opts?: SubscriptionOptions) => Promise<Event[]> list: (filters: Filter[], opts?: SubscriptionOptions) => Promise<Event[]>
get: (filter: Filter, opts?: SubscriptionOptions) => Promise<Event | null> get: (filter: Filter, opts?: SubscriptionOptions) => Promise<Event | null>
@@ -19,8 +19,8 @@ export type Relay = {
off: (type: RelayEvent, cb: any) => void off: (type: RelayEvent, cb: any) => void
} }
export type Pub = { export type Pub = {
on: (type: 'ok' | 'failed', cb: any) => void on: (type: 'ok' | 'seen' | 'failed', cb: any) => void
off: (type: 'ok' | 'failed', cb: any) => void off: (type: 'ok' | 'seen' | 'failed', cb: any) => void
} }
export type Sub = { export type Sub = {
sub: (filters: Filter[], opts: SubscriptionOptions) => Sub sub: (filters: Filter[], opts: SubscriptionOptions) => Sub
@@ -37,6 +37,11 @@ export type SubscriptionOptions = {
export function relayInit(url: string): Relay { export function relayInit(url: string): Relay {
var ws: WebSocket 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 openSubs: {[id: string]: {filters: Filter[]} & SubscriptionOptions} = {}
var listeners: { var listeners: {
connect: Array<() => void> connect: Array<() => void>
@@ -69,6 +74,7 @@ export function relayInit(url: string): Relay {
ws.onopen = () => { ws.onopen = () => {
listeners.connect.forEach(cb => cb()) listeners.connect.forEach(cb => cb())
setOpen()
resolve() resolve()
} }
ws.onerror = () => { ws.onerror = () => {
@@ -77,6 +83,7 @@ export function relayInit(url: string): Relay {
} }
ws.onclose = async () => { ws.onclose = async () => {
listeners.disconnect.forEach(cb => cb()) listeners.disconnect.forEach(cb => cb())
resolveClose && resolveClose()
} }
let incomingMessageQueue: string[] = [] let incomingMessageQueue: string[] = []
@@ -133,22 +140,15 @@ export function relayInit(url: string): Relay {
return return
case 'EOSE': { case 'EOSE': {
let id = data[1] let id = data[1]
if (id in subListeners) { ;(subListeners[id]?.eose || []).forEach(cb => cb())
subListeners[id].eose.forEach(cb => cb())
subListeners[id].eose = [] // 'eose' only happens once per sub, so stop listeners here
}
return return
} }
case 'OK': { case 'OK': {
let id: string = data[1] let id: string = data[1]
let ok: boolean = data[2] let ok: boolean = data[2]
let reason: string = data[3] || '' let reason: string = data[3] || ''
if (id in pubListeners) { if (ok) pubListeners[id]?.ok.forEach(cb => cb())
if (ok) pubListeners[id].ok.forEach(cb => cb()) else pubListeners[id]?.failed.forEach(cb => cb(reason))
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 return
} }
case 'NOTICE': case 'NOTICE':
@@ -163,23 +163,15 @@ export function relayInit(url: string): Relay {
}) })
} }
function connected() {
return ws?.readyState === 1
}
async function connect(): Promise<void> { async function connect(): Promise<void> {
if (connected()) return // ws already open if (ws?.readyState && ws.readyState === 1) return // ws already open
await connectRelay() await connectRelay()
} }
async function trySend(params: [string, ...any]) { async function trySend(params: [string, ...any]) {
let msg = JSON.stringify(params) let msg = JSON.stringify(params)
if (!connected()) {
await new Promise(resolve => setTimeout(resolve, 1000)) await untilOpen
if (!connected()) {
return
}
}
try { try {
ws.send(msg) ws.send(msg)
} catch (err) { } catch (err) {
@@ -279,17 +271,50 @@ export function relayInit(url: string): Relay {
if (!event.id) throw new Error(`event ${event} has no id`) if (!event.id) throw new Error(`event ${event} has no id`)
let id = event.id let id = event.id
var sent = false
var mustMonitor = false
trySend(['EVENT', event]) 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 { return {
on: (type: 'ok' | 'failed', cb: any) => { on: (type: 'ok' | 'seen' | 'failed', cb: any) => {
pubListeners[id] = pubListeners[id] || { pubListeners[id] = pubListeners[id] || {
ok: [], ok: [],
seen: [],
failed: [] failed: []
} }
pubListeners[id][type].push(cb) 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] let listeners = pubListeners[id]
if (!listeners) return if (!listeners) return
let idx = listeners[type].indexOf(cb) let idx = listeners[type].indexOf(cb)
@@ -298,12 +323,12 @@ export function relayInit(url: string): Relay {
} }
}, },
connect, connect,
close(): void { close(): Promise<void> {
listeners = {connect: [], disconnect: [], error: [], notice: []} if (ws.readyState > 1) return Promise.resolve()
subListeners = {} ws.close()
pubListeners = {} return new Promise<void>(resolve => {
resolveClose = resolve
ws?.close() })
}, },
get status() { get status() {
return ws?.readyState ?? 3 return ws?.readyState ?? 3