Compare commits

...

4 Commits

Author SHA1 Message Date
fiatjaf
719462f041 something 2025-07-19 10:41:48 -03:00
vornis101
de1cf0ed60 Fix JSON syntax of jsr.json 2025-07-19 08:58:05 -03:00
fiatjaf
d706ef961f pool: closed relays must be eliminated. 2025-07-17 23:39:16 -03:00
SondreB
2f529b3f8a enhance parseConnectionString to support double slash URL format 2025-07-13 11:59:04 -03:00
9 changed files with 72 additions and 22 deletions

View File

@@ -50,6 +50,9 @@ export class AbstractSimplePool {
verifyEvent: this.trustedRelayURLs.has(url) ? alwaysTrue : this.verifyEvent,
websocketImplementation: this._WebSocket,
})
relay.onclose = () => {
this.relays.delete(url)
}
if (params?.connectionTimeout) relay.connectionTimeout = params.connectionTimeout
this.relays.set(url, relay)
}
@@ -61,6 +64,7 @@ export class AbstractSimplePool {
close(relays: string[]) {
relays.map(normalizeURL).forEach(url => {
this.relays.get(url)?.close()
this.relays.delete(url)
})
}

View File

@@ -7,9 +7,22 @@ import { Queue, normalizeURL } from './utils.ts'
import { makeAuthEvent } from './nip42.ts'
import { yieldThread } from './helpers.ts'
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
websocketImplementation?: WebSocketBase
}
export class SendingOnClosedConnection extends Error {
@@ -43,7 +56,7 @@ 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)
@@ -319,6 +332,7 @@ export class AbstractRelay {
this.closeAllSubscriptions('relay connection closed by us')
this._connected = false
this.ws?.close()
this.onclose?.()
}
// this is the function assigned to this.ws.onmessage

View File

@@ -1,6 +1,6 @@
{
"name": "@nostr/tools",
"version": "2.15.0",
"version": "2.15.1",
"exports": {
".": "./index.ts",
"./core": "./core.ts",
@@ -44,7 +44,7 @@
"./nip99": "./nip99.ts",
"./nipb7": "./nipb7.ts",
"./fakejson": "./fakejson.ts",
"./utils": "./utils.ts"
"./utils": "./utils.ts",
"./signer": "./signer.ts"
}
}

View File

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

View File

@@ -5,6 +5,16 @@ import { decrypt } from './nip04.ts'
import { NWCWalletRequest } from './kinds.ts'
describe('parseConnectionString', () => {
test('returns pubkey, relay, and secret if connection string has double slash', () => {
const connectionString =
'nostr+walletconnect://b889ff5b1513b641e2a139f661a661364979c5beee91842f8f0ef42ab558e9d4?relay=wss%3A%2F%2Frelay.damus.io&secret=71a8c14c1407c113601079c4302dab36460f0ccd0ad506f1f2dc73b5100e4f3c'
const { pubkey, relay, secret } = parseConnectionString(connectionString)
expect(pubkey).toBe('b889ff5b1513b641e2a139f661a661364979c5beee91842f8f0ef42ab558e9d4')
expect(relay).toBe('wss://relay.damus.io')
expect(secret).toBe('71a8c14c1407c113601079c4302dab36460f0ccd0ad506f1f2dc73b5100e4f3c')
})
test('returns pubkey, relay, and secret if connection string is valid', () => {
const connectionString =
'nostr+walletconnect:b889ff5b1513b641e2a139f661a661364979c5beee91842f8f0ef42ab558e9d4?relay=wss%3A%2F%2Frelay.damus.io&secret=71a8c14c1407c113601079c4302dab36460f0ccd0ad506f1f2dc73b5100e4f3c'

View File

@@ -9,8 +9,8 @@ interface NWCConnection {
}
export function parseConnectionString(connectionString: string): NWCConnection {
const { pathname, searchParams } = new URL(connectionString)
const pubkey = pathname
const { host, pathname, searchParams } = new URL(connectionString)
const pubkey = pathname || host
const relay = searchParams.get('relay')
const secret = searchParams.get('secret')

29
node-ws-relay.ts Normal file
View File

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

View File

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

View File

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