mirror of
https://github.com/nbd-wtf/nostr-tools.git
synced 2026-02-01 14:55:51 +00:00
Compare commits
10 Commits
b40f59af74
...
master
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
6fc7788a4f | ||
|
|
2180c7a1fe | ||
|
|
b4bec2097d | ||
|
|
fb7de7f1aa | ||
|
|
ccb9641fb9 | ||
|
|
b624ad4059 | ||
|
|
b3d314643a | ||
|
|
30ac8a02c2 | ||
|
|
42c9c7554d | ||
|
|
3588d30044 |
43
README.md
43
README.md
@@ -1,4 +1,4 @@
|
|||||||
#  [](https://jsr.io/@nostr/tools) nostr-tools
|
# [](https://jsr.io/@nostr/tools) @nostr/tools
|
||||||
|
|
||||||
Tools for developing [Nostr](https://github.com/fiatjaf/nostr) clients.
|
Tools for developing [Nostr](https://github.com/fiatjaf/nostr) clients.
|
||||||
|
|
||||||
@@ -9,9 +9,6 @@ This package is only providing lower-level functionality. If you want higher-lev
|
|||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# npm
|
|
||||||
npm install --save nostr-tools
|
|
||||||
|
|
||||||
# jsr
|
# jsr
|
||||||
npx jsr add @nostr/tools
|
npx jsr add @nostr/tools
|
||||||
```
|
```
|
||||||
@@ -27,7 +24,7 @@ https://jsr.io/@nostr/tools/doc
|
|||||||
### Generating a private key and a public key
|
### Generating a private key and a public key
|
||||||
|
|
||||||
```js
|
```js
|
||||||
import { generateSecretKey, getPublicKey } from 'nostr-tools/pure'
|
import { generateSecretKey, getPublicKey } from '@nostr/tools/pure'
|
||||||
|
|
||||||
let sk = generateSecretKey() // `sk` is a Uint8Array
|
let sk = generateSecretKey() // `sk` is a Uint8Array
|
||||||
let pk = getPublicKey(sk) // `pk` is a hex string
|
let pk = getPublicKey(sk) // `pk` is a hex string
|
||||||
@@ -36,7 +33,7 @@ let pk = getPublicKey(sk) // `pk` is a hex string
|
|||||||
To get the secret key in hex format, use
|
To get the secret key in hex format, use
|
||||||
|
|
||||||
```js
|
```js
|
||||||
import { bytesToHex, hexToBytes } from '@noble/hashes/utils' // already an installed dependency
|
import { bytesToHex, hexToBytes } from '@noble/hashes/utils.js' // already an installed dependency
|
||||||
|
|
||||||
let skHex = bytesToHex(sk)
|
let skHex = bytesToHex(sk)
|
||||||
let backToBytes = hexToBytes(skHex)
|
let backToBytes = hexToBytes(skHex)
|
||||||
@@ -45,7 +42,7 @@ let backToBytes = hexToBytes(skHex)
|
|||||||
### Creating, signing and verifying events
|
### Creating, signing and verifying events
|
||||||
|
|
||||||
```js
|
```js
|
||||||
import { finalizeEvent, verifyEvent } from 'nostr-tools/pure'
|
import { finalizeEvent, verifyEvent } from '@nostr/tools/pure'
|
||||||
|
|
||||||
let event = finalizeEvent({
|
let event = finalizeEvent({
|
||||||
kind: 1,
|
kind: 1,
|
||||||
@@ -62,8 +59,8 @@ let isGood = verifyEvent(event)
|
|||||||
Doesn't matter what you do, you always should be using a `SimplePool`:
|
Doesn't matter what you do, you always should be using a `SimplePool`:
|
||||||
|
|
||||||
```js
|
```js
|
||||||
import { finalizeEvent, generateSecretKey, getPublicKey } from 'nostr-tools/pure'
|
import { finalizeEvent, generateSecretKey, getPublicKey } from '@nostr/tools/pure'
|
||||||
import { SimplePool } from 'nostr-tools/pool'
|
import { SimplePool } from '@nostr/tools/pool'
|
||||||
|
|
||||||
const pool = new SimplePool()
|
const pool = new SimplePool()
|
||||||
|
|
||||||
@@ -126,8 +123,8 @@ relay.close()
|
|||||||
To use this on Node.js you first must install `ws` and call something like this:
|
To use this on Node.js you first must install `ws` and call something like this:
|
||||||
|
|
||||||
```js
|
```js
|
||||||
import { useWebSocketImplementation } from 'nostr-tools/pool'
|
import { useWebSocketImplementation } from '@nostr/tools/pool'
|
||||||
// or import { useWebSocketImplementation } from 'nostr-tools/relay' if you're using the Relay directly
|
// or import { useWebSocketImplementation } from '@nostr/tools/relay' if you're using the Relay directly
|
||||||
|
|
||||||
import WebSocket from 'ws'
|
import WebSocket from 'ws'
|
||||||
useWebSocketImplementation(WebSocket)
|
useWebSocketImplementation(WebSocket)
|
||||||
@@ -138,7 +135,7 @@ 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, like Node.js, don't report websocket disconnections due to network issues, and enabling this can increase the reliability of the `onclose` event.
|
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, like Node.js, don't report websocket disconnections due to network issues, and enabling this can increase the reliability of the `onclose` event.
|
||||||
|
|
||||||
```js
|
```js
|
||||||
import { SimplePool } from 'nostr-tools/pool'
|
import { SimplePool } from '@nostr/tools/pool'
|
||||||
|
|
||||||
const pool = new SimplePool({ enablePing: true })
|
const pool = new SimplePool({ enablePing: true })
|
||||||
```
|
```
|
||||||
@@ -148,7 +145,7 @@ const pool = new SimplePool({ enablePing: true })
|
|||||||
You can also enable automatic reconnection with the `enableReconnect` option. This will make the pool try to reconnect to relays with an exponential backoff delay if the connection is lost unexpectedly.
|
You can also enable automatic reconnection with the `enableReconnect` option. This will make the pool try to reconnect to relays with an exponential backoff delay if the connection is lost unexpectedly.
|
||||||
|
|
||||||
```js
|
```js
|
||||||
import { SimplePool } from 'nostr-tools/pool'
|
import { SimplePool } from '@nostr/tools/pool'
|
||||||
|
|
||||||
const pool = new SimplePool({ enableReconnect: true })
|
const pool = new SimplePool({ enableReconnect: true })
|
||||||
```
|
```
|
||||||
@@ -331,7 +328,7 @@ for (let profile of refs.profiles) {
|
|||||||
### Querying profile data from a NIP-05 address
|
### Querying profile data from a NIP-05 address
|
||||||
|
|
||||||
```js
|
```js
|
||||||
import { queryProfile } from 'nostr-tools/nip05'
|
import { queryProfile } from '@nostr/tools/nip05'
|
||||||
|
|
||||||
let profile = await queryProfile('jb55.com')
|
let profile = await queryProfile('jb55.com')
|
||||||
console.log(profile.pubkey)
|
console.log(profile.pubkey)
|
||||||
@@ -343,13 +340,13 @@ console.log(profile.relays)
|
|||||||
To use this on Node.js < v18, you first must install `node-fetch@2` and call something like this:
|
To use this on Node.js < v18, you first must install `node-fetch@2` and call something like this:
|
||||||
|
|
||||||
```js
|
```js
|
||||||
import { useFetchImplementation } from 'nostr-tools/nip05'
|
import { useFetchImplementation } from '@nostr/tools/nip05'
|
||||||
useFetchImplementation(require('node-fetch'))
|
useFetchImplementation(require('node-fetch'))
|
||||||
```
|
```
|
||||||
|
|
||||||
### Including NIP-07 types
|
### Including NIP-07 types
|
||||||
```js
|
```js
|
||||||
import type { WindowNostr } from 'nostr-tools/nip07'
|
import type { WindowNostr } from '@nostr/tools/nip07'
|
||||||
|
|
||||||
declare global {
|
declare global {
|
||||||
interface Window {
|
interface Window {
|
||||||
@@ -361,8 +358,8 @@ declare global {
|
|||||||
### Encoding and decoding NIP-19 codes
|
### Encoding and decoding NIP-19 codes
|
||||||
|
|
||||||
```js
|
```js
|
||||||
import { generateSecretKey, getPublicKey } from 'nostr-tools/pure'
|
import { generateSecretKey, getPublicKey } from '@nostr/tools/pure'
|
||||||
import * as nip19 from 'nostr-tools/nip19'
|
import * as nip19 from '@nostr/tools/nip19'
|
||||||
|
|
||||||
let sk = generateSecretKey()
|
let sk = generateSecretKey()
|
||||||
let nsec = nip19.nsecEncode(sk)
|
let nsec = nip19.nsecEncode(sk)
|
||||||
@@ -390,7 +387,7 @@ assert(data.relays.length === 2)
|
|||||||
[`nostr-wasm`](https://github.com/fiatjaf/nostr-wasm) is a thin wrapper over [libsecp256k1](https://github.com/bitcoin-core/secp256k1) compiled to WASM just for hashing, signing and verifying Nostr events.
|
[`nostr-wasm`](https://github.com/fiatjaf/nostr-wasm) is a thin wrapper over [libsecp256k1](https://github.com/bitcoin-core/secp256k1) compiled to WASM just for hashing, signing and verifying Nostr events.
|
||||||
|
|
||||||
```js
|
```js
|
||||||
import { setNostrWasm, generateSecretKey, finalizeEvent, verifyEvent } from 'nostr-tools/wasm'
|
import { setNostrWasm, generateSecretKey, finalizeEvent, verifyEvent } from '@nostr/tools/wasm'
|
||||||
import { initNostrWasm } from 'nostr-wasm'
|
import { initNostrWasm } from 'nostr-wasm'
|
||||||
|
|
||||||
// make sure this promise resolves before your app starts calling finalizeEvent or verifyEvent
|
// make sure this promise resolves before your app starts calling finalizeEvent or verifyEvent
|
||||||
@@ -403,9 +400,9 @@ initNostrWasm().then(setNostrWasm)
|
|||||||
If you're going to use `Relay` and `SimplePool` you must also import `nostr-tools/abstract-relay` and/or `nostr-tools/abstract-pool` instead of the defaults and then instantiate them by passing the `verifyEvent`:
|
If you're going to use `Relay` and `SimplePool` you must also import `nostr-tools/abstract-relay` and/or `nostr-tools/abstract-pool` instead of the defaults and then instantiate them by passing the `verifyEvent`:
|
||||||
|
|
||||||
```js
|
```js
|
||||||
import { setNostrWasm, verifyEvent } from 'nostr-tools/wasm'
|
import { setNostrWasm, verifyEvent } from '@nostr/tools/wasm'
|
||||||
import { AbstractRelay } from 'nostr-tools/abstract-relay'
|
import { AbstractRelay } from '@nostr/tools/abstract-relay'
|
||||||
import { AbstractSimplePool } from 'nostr-tools/abstract-pool'
|
import { AbstractSimplePool } from '@nostr/tools/abstract-pool'
|
||||||
import { initNostrWasm } from 'nostr-wasm'
|
import { initNostrWasm } from 'nostr-wasm'
|
||||||
|
|
||||||
initNostrWasm().then(setNostrWasm)
|
initNostrWasm().then(setNostrWasm)
|
||||||
@@ -442,7 +439,7 @@ summary for relay read message and verify event
|
|||||||
|
|
||||||
## Plumbing
|
## Plumbing
|
||||||
|
|
||||||
To develop `nostr-tools`, install [`just`](https://just.systems/) and run `just -l` to see commands available.
|
To develop `@nostr/tools`, install [`just`](https://just.systems/) and run `just -l` to see commands available.
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
|
|||||||
@@ -11,6 +11,7 @@ import { normalizeURL } from './utils.ts'
|
|||||||
import type { Event, EventTemplate, Nostr, VerifiedEvent } from './core.ts'
|
import type { Event, EventTemplate, Nostr, VerifiedEvent } from './core.ts'
|
||||||
import { type Filter } from './filter.ts'
|
import { type Filter } from './filter.ts'
|
||||||
import { alwaysTrue } from './helpers.ts'
|
import { alwaysTrue } from './helpers.ts'
|
||||||
|
import { Relay } from './relay.ts'
|
||||||
|
|
||||||
export type SubCloser = { close: (reason?: string) => void }
|
export type SubCloser = { close: (reason?: string) => void }
|
||||||
|
|
||||||
@@ -19,6 +20,16 @@ export type AbstractPoolConstructorOptions = AbstractRelayConstructorOptions & {
|
|||||||
// in case that relay shouldn't be authenticated against
|
// in case that relay shouldn't be authenticated against
|
||||||
// or a function to sign the AUTH event template otherwise (that function may still throw in case of failure)
|
// or a function to sign the AUTH event template otherwise (that function may still throw in case of failure)
|
||||||
automaticallyAuth?: (relayURL: string) => null | ((event: EventTemplate) => Promise<VerifiedEvent>)
|
automaticallyAuth?: (relayURL: string) => null | ((event: EventTemplate) => Promise<VerifiedEvent>)
|
||||||
|
// onRelayConnectionFailure is called with the URL of a relay that failed the initial connection
|
||||||
|
onRelayConnectionFailure?: (url: string) => void
|
||||||
|
// onRelayConnectionSuccess is called with the URL of a relay that succeeds the initial connection
|
||||||
|
onRelayConnectionSuccess?: (url: string) => void
|
||||||
|
// allowConnectingToRelay takes a relay URL and the operation being performed
|
||||||
|
// return false to skip connecting to that relay
|
||||||
|
allowConnectingToRelay?: (url: string, operation: ['read', Filter[]] | ['write', Event]) => boolean
|
||||||
|
// maxWaitForConnection takes a number in milliseconds that will be given to ensureRelay such that we
|
||||||
|
// don't get stuck forever when attempting to connect to a relay, it is 3000 (3 seconds) by default
|
||||||
|
maxWaitForConnection: number
|
||||||
}
|
}
|
||||||
|
|
||||||
export type SubscribeManyParams = Omit<SubscriptionParams, 'onclose'> & {
|
export type SubscribeManyParams = Omit<SubscriptionParams, 'onclose'> & {
|
||||||
@@ -40,6 +51,10 @@ export class AbstractSimplePool {
|
|||||||
public enableReconnect: boolean
|
public enableReconnect: boolean
|
||||||
public automaticallyAuth?: (relayURL: string) => null | ((event: EventTemplate) => Promise<VerifiedEvent>)
|
public automaticallyAuth?: (relayURL: string) => null | ((event: EventTemplate) => Promise<VerifiedEvent>)
|
||||||
public trustedRelayURLs: Set<string> = new Set()
|
public trustedRelayURLs: Set<string> = new Set()
|
||||||
|
public onRelayConnectionFailure?: (url: string) => void
|
||||||
|
public onRelayConnectionSuccess?: (url: string) => void
|
||||||
|
public allowConnectingToRelay?: (url: string, operation: ['read', Filter[]] | ['write', Event]) => boolean
|
||||||
|
public maxWaitForConnection: number
|
||||||
|
|
||||||
private _WebSocket?: typeof WebSocket
|
private _WebSocket?: typeof WebSocket
|
||||||
|
|
||||||
@@ -49,6 +64,10 @@ export class AbstractSimplePool {
|
|||||||
this.enablePing = opts.enablePing
|
this.enablePing = opts.enablePing
|
||||||
this.enableReconnect = opts.enableReconnect || false
|
this.enableReconnect = opts.enableReconnect || false
|
||||||
this.automaticallyAuth = opts.automaticallyAuth
|
this.automaticallyAuth = opts.automaticallyAuth
|
||||||
|
this.onRelayConnectionFailure = opts.onRelayConnectionFailure
|
||||||
|
this.onRelayConnectionSuccess = opts.onRelayConnectionSuccess
|
||||||
|
this.allowConnectingToRelay = opts.allowConnectingToRelay
|
||||||
|
this.maxWaitForConnection = opts.maxWaitForConnection || 3000
|
||||||
}
|
}
|
||||||
|
|
||||||
async ensureRelay(
|
async ensureRelay(
|
||||||
@@ -181,17 +200,28 @@ export class AbstractSimplePool {
|
|||||||
// open a subscription in all given relays
|
// open a subscription in all given relays
|
||||||
const allOpened = Promise.all(
|
const allOpened = Promise.all(
|
||||||
groupedRequests.map(async ({ url, filters }, i) => {
|
groupedRequests.map(async ({ url, filters }, i) => {
|
||||||
|
if (this.allowConnectingToRelay?.(url, ['read', filters]) === false) {
|
||||||
|
handleClose(i, 'connection skipped by allowConnectingToRelay')
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
let relay: AbstractRelay
|
let relay: AbstractRelay
|
||||||
try {
|
try {
|
||||||
relay = await this.ensureRelay(url, {
|
relay = await this.ensureRelay(url, {
|
||||||
connectionTimeout: params.maxWait ? Math.max(params.maxWait * 0.8, params.maxWait - 1000) : undefined,
|
connectionTimeout:
|
||||||
|
this.maxWaitForConnection < (params.maxWait || 0)
|
||||||
|
? Math.max(params.maxWait! * 0.8, params.maxWait! - 1000)
|
||||||
|
: this.maxWaitForConnection,
|
||||||
abort: params.abort,
|
abort: params.abort,
|
||||||
})
|
})
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
|
this.onRelayConnectionFailure?.(url)
|
||||||
handleClose(i, (err as any)?.message || String(err))
|
handleClose(i, (err as any)?.message || String(err))
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
|
this.onRelayConnectionSuccess?.(url)
|
||||||
|
|
||||||
let subscription = relay.subscribe(filters, {
|
let subscription = relay.subscribe(filters, {
|
||||||
...params,
|
...params,
|
||||||
oneose: () => handleEose(i),
|
oneose: () => handleEose(i),
|
||||||
@@ -298,7 +328,11 @@ export class AbstractSimplePool {
|
|||||||
publish(
|
publish(
|
||||||
relays: string[],
|
relays: string[],
|
||||||
event: Event,
|
event: Event,
|
||||||
options?: { onauth?: (evt: EventTemplate) => Promise<VerifiedEvent> },
|
params?: {
|
||||||
|
onauth?: (evt: EventTemplate) => Promise<VerifiedEvent>
|
||||||
|
maxWait?: number
|
||||||
|
abort?: AbortSignal
|
||||||
|
},
|
||||||
): Promise<string>[] {
|
): Promise<string>[] {
|
||||||
return relays.map(normalizeURL).map(async (url, i, arr) => {
|
return relays.map(normalizeURL).map(async (url, i, arr) => {
|
||||||
if (arr.indexOf(url) !== i) {
|
if (arr.indexOf(url) !== i) {
|
||||||
@@ -306,12 +340,29 @@ export class AbstractSimplePool {
|
|||||||
return Promise.reject('duplicate url')
|
return Promise.reject('duplicate url')
|
||||||
}
|
}
|
||||||
|
|
||||||
let r = await this.ensureRelay(url)
|
if (this.allowConnectingToRelay?.(url, ['write', event]) === false) {
|
||||||
|
return Promise.reject('connection skipped by allowConnectingToRelay')
|
||||||
|
}
|
||||||
|
|
||||||
|
let r: Relay
|
||||||
|
try {
|
||||||
|
r = await this.ensureRelay(url, {
|
||||||
|
connectionTimeout:
|
||||||
|
this.maxWaitForConnection < (params?.maxWait || 0)
|
||||||
|
? Math.max(params!.maxWait! * 0.8, params!.maxWait! - 1000)
|
||||||
|
: this.maxWaitForConnection,
|
||||||
|
abort: params?.abort,
|
||||||
|
})
|
||||||
|
} catch (err) {
|
||||||
|
this.onRelayConnectionFailure?.(url)
|
||||||
|
return String('connection failure: ' + String(err))
|
||||||
|
}
|
||||||
|
|
||||||
return r
|
return r
|
||||||
.publish(event)
|
.publish(event)
|
||||||
.catch(async err => {
|
.catch(async err => {
|
||||||
if (err instanceof Error && err.message.startsWith('auth-required: ') && options?.onauth) {
|
if (err instanceof Error && err.message.startsWith('auth-required: ') && params?.onauth) {
|
||||||
await r.auth(options.onauth)
|
await r.auth(params.onauth)
|
||||||
return r.publish(event) // retry
|
return r.publish(event) // retry
|
||||||
}
|
}
|
||||||
throw err
|
throw err
|
||||||
|
|||||||
@@ -45,7 +45,7 @@ export class AbstractRelay {
|
|||||||
private reconnectTimeoutHandle: ReturnType<typeof setTimeout> | undefined
|
private reconnectTimeoutHandle: ReturnType<typeof setTimeout> | undefined
|
||||||
private pingIntervalHandle: ReturnType<typeof setInterval> | undefined
|
private pingIntervalHandle: ReturnType<typeof setInterval> | undefined
|
||||||
private reconnectAttempts: number = 0
|
private reconnectAttempts: number = 0
|
||||||
private closedIntentionally: boolean = false
|
private skipReconnection: boolean = false
|
||||||
|
|
||||||
private connectionPromise: Promise<void> | undefined
|
private connectionPromise: Promise<void> | undefined
|
||||||
private openCountRequests = new Map<string, CountResolver>()
|
private openCountRequests = new Map<string, CountResolver>()
|
||||||
@@ -120,12 +120,9 @@ export class AbstractRelay {
|
|||||||
this._connected = false
|
this._connected = false
|
||||||
this.connectionPromise = undefined
|
this.connectionPromise = undefined
|
||||||
|
|
||||||
const wasIntentional = this.closedIntentionally
|
|
||||||
this.closedIntentionally = false // reset for next time
|
|
||||||
|
|
||||||
this.onclose?.()
|
this.onclose?.()
|
||||||
|
|
||||||
if (this.enableReconnect && !wasIntentional) {
|
if (this.enableReconnect && !this.skipReconnection) {
|
||||||
this.reconnect()
|
this.reconnect()
|
||||||
} else {
|
} else {
|
||||||
this.closeAllSubscriptions(reason)
|
this.closeAllSubscriptions(reason)
|
||||||
@@ -139,13 +136,15 @@ export class AbstractRelay {
|
|||||||
|
|
||||||
this.challenge = undefined
|
this.challenge = undefined
|
||||||
this.authPromise = undefined
|
this.authPromise = undefined
|
||||||
|
this.skipReconnection = false
|
||||||
this.connectionPromise = new Promise((resolve, reject) => {
|
this.connectionPromise = new Promise((resolve, reject) => {
|
||||||
if (opts?.timeout) {
|
if (opts?.timeout) {
|
||||||
connectionTimeoutHandle = setTimeout(() => {
|
connectionTimeoutHandle = setTimeout(() => {
|
||||||
reject('connection timed out')
|
reject('connection timed out')
|
||||||
this.connectionPromise = undefined
|
this.connectionPromise = undefined
|
||||||
|
this.skipReconnection = true
|
||||||
this.onclose?.()
|
this.onclose?.()
|
||||||
this.closeAllSubscriptions('relay connection timed out')
|
this.handleHardClose('relay connection timed out')
|
||||||
}, opts.timeout)
|
}, opts.timeout)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -191,10 +190,13 @@ export class AbstractRelay {
|
|||||||
resolve()
|
resolve()
|
||||||
}
|
}
|
||||||
|
|
||||||
this.ws.onerror = ev => {
|
this.ws.onerror = () => {
|
||||||
clearTimeout(connectionTimeoutHandle)
|
clearTimeout(connectionTimeoutHandle)
|
||||||
reject((ev as any).message || 'websocket error')
|
reject('connection failed')
|
||||||
this.handleHardClose('relay connection errored')
|
this.connectionPromise = undefined
|
||||||
|
this.skipReconnection = true
|
||||||
|
this.onclose?.()
|
||||||
|
this.handleHardClose('relay connection failed')
|
||||||
}
|
}
|
||||||
|
|
||||||
this.ws.onclose = ev => {
|
this.ws.onclose = ev => {
|
||||||
@@ -466,7 +468,7 @@ export class AbstractRelay {
|
|||||||
}
|
}
|
||||||
|
|
||||||
public close() {
|
public close() {
|
||||||
this.closedIntentionally = true
|
this.skipReconnection = true
|
||||||
if (this.reconnectTimeoutHandle) {
|
if (this.reconnectTimeoutHandle) {
|
||||||
clearTimeout(this.reconnectTimeoutHandle)
|
clearTimeout(this.reconnectTimeoutHandle)
|
||||||
this.reconnectTimeoutHandle = undefined
|
this.reconnectTimeoutHandle = undefined
|
||||||
|
|||||||
2
jsr.json
2
jsr.json
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@nostr/tools",
|
"name": "@nostr/tools",
|
||||||
"version": "2.20.0",
|
"version": "2.22.2",
|
||||||
"exports": {
|
"exports": {
|
||||||
".": "./index.ts",
|
".": "./index.ts",
|
||||||
"./core": "./core.ts",
|
"./core": "./core.ts",
|
||||||
|
|||||||
4
nip04.ts
4
nip04.ts
@@ -1,6 +1,6 @@
|
|||||||
import { bytesToHex, hexToBytes, randomBytes } from '@noble/hashes/utils.js'
|
import { hexToBytes, randomBytes } from '@noble/hashes/utils.js'
|
||||||
import { secp256k1 } from '@noble/curves/secp256k1.js'
|
import { secp256k1 } from '@noble/curves/secp256k1.js'
|
||||||
import { cbc } from '@noble/ciphers/aes'
|
import { cbc } from '@noble/ciphers/aes.js'
|
||||||
import { base64 } from '@scure/base'
|
import { base64 } from '@scure/base'
|
||||||
|
|
||||||
import { utf8Decoder, utf8Encoder } from './utils.ts'
|
import { utf8Decoder, utf8Encoder } from './utils.ts'
|
||||||
|
|||||||
2
nip06.ts
2
nip06.ts
@@ -1,5 +1,5 @@
|
|||||||
import { bytesToHex } from '@noble/hashes/utils.js'
|
import { bytesToHex } from '@noble/hashes/utils.js'
|
||||||
import { wordlist } from '@scure/bip39/wordlists/english'
|
import { wordlist } from '@scure/bip39/wordlists/english.js'
|
||||||
import { generateMnemonic, mnemonicToSeedSync, validateMnemonic } from '@scure/bip39'
|
import { generateMnemonic, mnemonicToSeedSync, validateMnemonic } from '@scure/bip39'
|
||||||
import { HDKey } from '@scure/bip32'
|
import { HDKey } from '@scure/bip32'
|
||||||
|
|
||||||
|
|||||||
2
nip19.ts
2
nip19.ts
@@ -110,7 +110,7 @@ export function decode(nip19: NPub): DecodedNpub
|
|||||||
export function decode(nip19: Note): DecodedNote
|
export function decode(nip19: Note): DecodedNote
|
||||||
export function decode(code: string): DecodedResult
|
export function decode(code: string): DecodedResult
|
||||||
export function decode(code: string): DecodedResult {
|
export function decode(code: string): DecodedResult {
|
||||||
let { prefix, words } = bech32.decode(code, Bech32MaxSize)
|
let { prefix, words } = bech32.decode(code as `${string}1${string}`, Bech32MaxSize)
|
||||||
let data = new Uint8Array(bech32.fromWords(words))
|
let data = new Uint8Array(bech32.fromWords(words))
|
||||||
|
|
||||||
switch (prefix) {
|
switch (prefix) {
|
||||||
|
|||||||
4
nip44.ts
4
nip44.ts
@@ -1,5 +1,5 @@
|
|||||||
import { chacha20 } from '@noble/ciphers/chacha'
|
import { chacha20 } from '@noble/ciphers/chacha.js'
|
||||||
import { equalBytes } from '@noble/ciphers/utils'
|
import { equalBytes } from '@noble/ciphers/utils.js'
|
||||||
import { secp256k1 } from '@noble/curves/secp256k1.js'
|
import { secp256k1 } from '@noble/curves/secp256k1.js'
|
||||||
import { extract as hkdf_extract, expand as hkdf_expand } from '@noble/hashes/hkdf.js'
|
import { extract as hkdf_extract, expand as hkdf_expand } from '@noble/hashes/hkdf.js'
|
||||||
import { hmac } from '@noble/hashes/hmac.js'
|
import { hmac } from '@noble/hashes/hmac.js'
|
||||||
|
|||||||
6
nip49.ts
6
nip49.ts
@@ -1,8 +1,8 @@
|
|||||||
|
import { bech32 } from '@scure/base'
|
||||||
import { scrypt } from '@noble/hashes/scrypt.js'
|
import { scrypt } from '@noble/hashes/scrypt.js'
|
||||||
import { xchacha20poly1305 } from '@noble/ciphers/chacha'
|
import { xchacha20poly1305 } from '@noble/ciphers/chacha.js'
|
||||||
import { concatBytes, randomBytes } from '@noble/hashes/utils.js'
|
import { concatBytes, randomBytes } from '@noble/hashes/utils.js'
|
||||||
import { Bech32MaxSize, Ncryptsec, encodeBytes } from './nip19.ts'
|
import { Bech32MaxSize, Ncryptsec, encodeBytes } from './nip19.ts'
|
||||||
import { bech32 } from '@scure/base'
|
|
||||||
|
|
||||||
export function encrypt(
|
export function encrypt(
|
||||||
sec: Uint8Array,
|
sec: Uint8Array,
|
||||||
@@ -22,7 +22,7 @@ export function encrypt(
|
|||||||
}
|
}
|
||||||
|
|
||||||
export function decrypt(ncryptsec: string, password: string): Uint8Array {
|
export function decrypt(ncryptsec: string, password: string): Uint8Array {
|
||||||
let { prefix, words } = bech32.decode(ncryptsec, Bech32MaxSize)
|
let { prefix, words } = bech32.decode(ncryptsec as `${string}1${string}`, Bech32MaxSize)
|
||||||
if (prefix !== 'ncryptsec') {
|
if (prefix !== 'ncryptsec') {
|
||||||
throw new Error(`invalid prefix ${prefix}, expected 'ncryptsec'`)
|
throw new Error(`invalid prefix ${prefix}, expected 'ncryptsec'`)
|
||||||
}
|
}
|
||||||
|
|||||||
2
nip77.ts
2
nip77.ts
@@ -1,4 +1,4 @@
|
|||||||
import { bytesToHex, hexToBytes } from '@noble/ciphers/utils'
|
import { bytesToHex, hexToBytes } from '@noble/hashes/utils.js'
|
||||||
import { Filter } from './filter.ts'
|
import { Filter } from './filter.ts'
|
||||||
import { AbstractRelay, Subscription } from './relay.ts'
|
import { AbstractRelay, Subscription } from './relay.ts'
|
||||||
import { sha256 } from '@noble/hashes/sha2.js'
|
import { sha256 } from '@noble/hashes/sha2.js'
|
||||||
|
|||||||
14
package.json
14
package.json
@@ -1,7 +1,7 @@
|
|||||||
{
|
{
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"name": "nostr-tools",
|
"name": "nostr-tools",
|
||||||
"version": "2.20.0",
|
"version": "2.22.2",
|
||||||
"description": "Tools for making a Nostr client.",
|
"description": "Tools for making a Nostr client.",
|
||||||
"repository": {
|
"repository": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
@@ -236,12 +236,12 @@
|
|||||||
},
|
},
|
||||||
"license": "Unlicense",
|
"license": "Unlicense",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@noble/ciphers": "^0.5.1",
|
"@noble/ciphers": "2.1.1",
|
||||||
"@noble/curves": "^2.0.1",
|
"@noble/curves": "2.0.1",
|
||||||
"@noble/hashes": "^2.0.1",
|
"@noble/hashes": "2.0.1",
|
||||||
"@scure/base": "1.1.1",
|
"@scure/base": "2.0.0",
|
||||||
"@scure/bip32": "1.3.1",
|
"@scure/bip32": "2.0.1",
|
||||||
"@scure/bip39": "1.2.1",
|
"@scure/bip39": "2.0.1",
|
||||||
"nostr-wasm": "0.1.0"
|
"nostr-wasm": "0.1.0"
|
||||||
},
|
},
|
||||||
"peerDependencies": {
|
"peerDependencies": {
|
||||||
|
|||||||
2
pool.ts
2
pool.ts
@@ -15,7 +15,7 @@ export function useWebSocketImplementation(websocketImplementation: any) {
|
|||||||
|
|
||||||
export class SimplePool extends AbstractSimplePool {
|
export class SimplePool extends AbstractSimplePool {
|
||||||
constructor(options?: Pick<AbstractPoolConstructorOptions, 'enablePing' | 'enableReconnect'>) {
|
constructor(options?: Pick<AbstractPoolConstructorOptions, 'enablePing' | 'enableReconnect'>) {
|
||||||
super({ verifyEvent, websocketImplementation: _WebSocket, ...options })
|
super({ verifyEvent, websocketImplementation: _WebSocket, maxWaitForConnection: 3000, ...options })
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -6,6 +6,7 @@ import {
|
|||||||
insertEventIntoDescendingList,
|
insertEventIntoDescendingList,
|
||||||
binarySearch,
|
binarySearch,
|
||||||
normalizeURL,
|
normalizeURL,
|
||||||
|
mergeReverseSortedLists,
|
||||||
} from './utils.ts'
|
} from './utils.ts'
|
||||||
|
|
||||||
import type { Event } from './core.ts'
|
import type { Event } from './core.ts'
|
||||||
@@ -270,6 +271,94 @@ test('binary search', () => {
|
|||||||
expect(binarySearch(['a', 'b', 'd', 'e'], b => ('[' < b ? -1 : '[' === b ? 0 : 1))).toEqual([0, false])
|
expect(binarySearch(['a', 'b', 'd', 'e'], b => ('[' < b ? -1 : '[' === b ? 0 : 1))).toEqual([0, false])
|
||||||
})
|
})
|
||||||
|
|
||||||
|
describe('mergeReverseSortedLists', () => {
|
||||||
|
test('merge empty lists', () => {
|
||||||
|
const list1: Event[] = []
|
||||||
|
const list2: Event[] = []
|
||||||
|
expect(mergeReverseSortedLists(list1, list2)).toHaveLength(0)
|
||||||
|
})
|
||||||
|
|
||||||
|
test('merge list with empty list', () => {
|
||||||
|
const list1 = [buildEvent({ id: 'a', created_at: 30 }), buildEvent({ id: 'b', created_at: 20 })]
|
||||||
|
const list2: Event[] = []
|
||||||
|
const result = mergeReverseSortedLists(list1, list2)
|
||||||
|
expect(result).toHaveLength(2)
|
||||||
|
expect(result.map(e => e.id)).toEqual(['a', 'b'])
|
||||||
|
})
|
||||||
|
|
||||||
|
test('merge two simple lists', () => {
|
||||||
|
const list1 = [
|
||||||
|
buildEvent({ id: 'a', created_at: 30 }),
|
||||||
|
buildEvent({ id: 'b', created_at: 10 }),
|
||||||
|
buildEvent({ id: 'f', created_at: 3 }),
|
||||||
|
buildEvent({ id: 'g', created_at: 2 }),
|
||||||
|
]
|
||||||
|
const list2 = [
|
||||||
|
buildEvent({ id: 'c', created_at: 25 }),
|
||||||
|
buildEvent({ id: 'd', created_at: 5 }),
|
||||||
|
buildEvent({ id: 'e', created_at: 1 }),
|
||||||
|
]
|
||||||
|
const result = mergeReverseSortedLists(list1, list2)
|
||||||
|
expect(result.map(e => e.id)).toEqual(['a', 'c', 'b', 'd', 'f', 'g', 'e'])
|
||||||
|
})
|
||||||
|
|
||||||
|
test('merge lists with same timestamps', () => {
|
||||||
|
const list1 = [
|
||||||
|
buildEvent({ id: 'a', created_at: 30 }),
|
||||||
|
buildEvent({ id: 'b', created_at: 20 }),
|
||||||
|
buildEvent({ id: 'f', created_at: 10 }),
|
||||||
|
]
|
||||||
|
const list2 = [
|
||||||
|
buildEvent({ id: 'c', created_at: 30 }),
|
||||||
|
buildEvent({ id: 'd', created_at: 20 }),
|
||||||
|
buildEvent({ id: 'e', created_at: 20 }),
|
||||||
|
]
|
||||||
|
const result = mergeReverseSortedLists(list1, list2)
|
||||||
|
expect(result.map(e => e.id)).toEqual(['c', 'a', 'd', 'e', 'b', 'f'])
|
||||||
|
})
|
||||||
|
|
||||||
|
test('deduplicate events with same timestamp and id', () => {
|
||||||
|
const list1 = [
|
||||||
|
buildEvent({ id: 'a', created_at: 30 }),
|
||||||
|
buildEvent({ id: 'b', created_at: 20 }),
|
||||||
|
buildEvent({ id: 'b', created_at: 20 }),
|
||||||
|
buildEvent({ id: 'c', created_at: 20 }),
|
||||||
|
buildEvent({ id: 'd', created_at: 10 }),
|
||||||
|
]
|
||||||
|
const list2 = [
|
||||||
|
buildEvent({ id: 'a', created_at: 30 }),
|
||||||
|
buildEvent({ id: 'c', created_at: 20 }),
|
||||||
|
buildEvent({ id: 'b', created_at: 20 }),
|
||||||
|
buildEvent({ id: 'd', created_at: 10 }),
|
||||||
|
buildEvent({ id: 'e', created_at: 10 }),
|
||||||
|
buildEvent({ id: 'd', created_at: 10 }),
|
||||||
|
]
|
||||||
|
console.log('==================')
|
||||||
|
const result = mergeReverseSortedLists(list1, list2)
|
||||||
|
console.log(
|
||||||
|
'result:',
|
||||||
|
result.map(e => e.id),
|
||||||
|
)
|
||||||
|
expect(result.map(e => e.id)).toEqual(['a', 'c', 'b', 'd', 'e'])
|
||||||
|
})
|
||||||
|
|
||||||
|
test('merge when one list is completely before the other', () => {
|
||||||
|
const list1 = [buildEvent({ id: 'a', created_at: 50 }), buildEvent({ id: 'b', created_at: 40 })]
|
||||||
|
const list2 = [buildEvent({ id: 'c', created_at: 30 }), buildEvent({ id: 'd', created_at: 20 })]
|
||||||
|
const result = mergeReverseSortedLists(list1, list2)
|
||||||
|
expect(result).toHaveLength(4)
|
||||||
|
expect(result.map(e => e.id)).toEqual(['a', 'b', 'c', 'd'])
|
||||||
|
})
|
||||||
|
|
||||||
|
test('merge when one list is completely after the other', () => {
|
||||||
|
const list1 = [buildEvent({ id: 'a', created_at: 10 }), buildEvent({ id: 'b', created_at: 5 })]
|
||||||
|
const list2 = [buildEvent({ id: 'c', created_at: 30 }), buildEvent({ id: 'd', created_at: 20 })]
|
||||||
|
const result = mergeReverseSortedLists(list1, list2)
|
||||||
|
expect(result).toHaveLength(4)
|
||||||
|
expect(result.map(e => e.id)).toEqual(['c', 'd', 'a', 'b'])
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
describe('normalizeURL', () => {
|
describe('normalizeURL', () => {
|
||||||
test('normalizes wss:// URLs', () => {
|
test('normalizes wss:// URLs', () => {
|
||||||
expect(normalizeURL('wss://example.com')).toBe('wss://example.com/')
|
expect(normalizeURL('wss://example.com')).toBe('wss://example.com/')
|
||||||
|
|||||||
62
utils.ts
62
utils.ts
@@ -1,4 +1,4 @@
|
|||||||
import type { Event } from './core.ts'
|
import type { NostrEvent } from './core.ts'
|
||||||
|
|
||||||
export const utf8Decoder: TextDecoder = new TextDecoder('utf-8')
|
export const utf8Decoder: TextDecoder = new TextDecoder('utf-8')
|
||||||
export const utf8Encoder: TextEncoder = new TextEncoder()
|
export const utf8Encoder: TextEncoder = new TextEncoder()
|
||||||
@@ -22,7 +22,7 @@ export function normalizeURL(url: string): string {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
export function insertEventIntoDescendingList(sortedArray: Event[], event: Event): Event[] {
|
export function insertEventIntoDescendingList(sortedArray: NostrEvent[], event: NostrEvent): NostrEvent[] {
|
||||||
const [idx, found] = binarySearch(sortedArray, b => {
|
const [idx, found] = binarySearch(sortedArray, b => {
|
||||||
if (event.id === b.id) return 0
|
if (event.id === b.id) return 0
|
||||||
if (event.created_at === b.created_at) return -1
|
if (event.created_at === b.created_at) return -1
|
||||||
@@ -34,7 +34,7 @@ export function insertEventIntoDescendingList(sortedArray: Event[], event: Event
|
|||||||
return sortedArray
|
return sortedArray
|
||||||
}
|
}
|
||||||
|
|
||||||
export function insertEventIntoAscendingList(sortedArray: Event[], event: Event): Event[] {
|
export function insertEventIntoAscendingList(sortedArray: NostrEvent[], event: NostrEvent): NostrEvent[] {
|
||||||
const [idx, found] = binarySearch(sortedArray, b => {
|
const [idx, found] = binarySearch(sortedArray, b => {
|
||||||
if (event.id === b.id) return 0
|
if (event.id === b.id) return 0
|
||||||
if (event.created_at === b.created_at) return -1
|
if (event.created_at === b.created_at) return -1
|
||||||
@@ -68,6 +68,62 @@ export function binarySearch<T>(arr: T[], compare: (b: T) => number): [number, b
|
|||||||
return [start, false]
|
return [start, false]
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export function mergeReverseSortedLists(list1: NostrEvent[], list2: NostrEvent[]): NostrEvent[] {
|
||||||
|
const result: NostrEvent[] = new Array(list1.length + list2.length)
|
||||||
|
result.length = 0
|
||||||
|
let i1 = 0
|
||||||
|
let i2 = 0
|
||||||
|
let sameTimestampIds: string[] = []
|
||||||
|
|
||||||
|
while (i1 < list1.length && i2 < list2.length) {
|
||||||
|
let next: NostrEvent
|
||||||
|
if (list1[i1]?.created_at > list2[i2]?.created_at) {
|
||||||
|
next = list1[i1]
|
||||||
|
i1++
|
||||||
|
} else {
|
||||||
|
next = list2[i2]
|
||||||
|
i2++
|
||||||
|
}
|
||||||
|
|
||||||
|
if (result.length > 0 && result[result.length - 1].created_at === next.created_at) {
|
||||||
|
if (sameTimestampIds.includes(next.id)) continue
|
||||||
|
} else {
|
||||||
|
sameTimestampIds.length = 0
|
||||||
|
}
|
||||||
|
|
||||||
|
result.push(next)
|
||||||
|
sameTimestampIds.push(next.id)
|
||||||
|
}
|
||||||
|
|
||||||
|
while (i1 < list1.length) {
|
||||||
|
const next = list1[i1]
|
||||||
|
i1++
|
||||||
|
|
||||||
|
if (result.length > 0 && result[result.length - 1].created_at === next.created_at) {
|
||||||
|
if (sameTimestampIds.includes(next.id)) continue
|
||||||
|
} else {
|
||||||
|
sameTimestampIds.length = 0
|
||||||
|
}
|
||||||
|
result.push(next)
|
||||||
|
sameTimestampIds.push(next.id)
|
||||||
|
}
|
||||||
|
|
||||||
|
while (i2 < list2.length) {
|
||||||
|
const next = list2[i2]
|
||||||
|
i2++
|
||||||
|
|
||||||
|
if (result.length > 0 && result[result.length - 1].created_at === next.created_at) {
|
||||||
|
if (sameTimestampIds.includes(next.id)) continue
|
||||||
|
} else {
|
||||||
|
sameTimestampIds.length = 0
|
||||||
|
}
|
||||||
|
result.push(next)
|
||||||
|
sameTimestampIds.push(next.id)
|
||||||
|
}
|
||||||
|
|
||||||
|
return result
|
||||||
|
}
|
||||||
|
|
||||||
export class QueueNode<V> {
|
export class QueueNode<V> {
|
||||||
public value: V
|
public value: V
|
||||||
public next: QueueNode<V> | null = null
|
public next: QueueNode<V> | null = null
|
||||||
|
|||||||
Reference in New Issue
Block a user