nostr-tools 1.14.2 → 1.16.0

package/README.md

@@ -12,12 +12,14 @@ This package is only providing lower-level functionality. If you want an easy-to
  npm install nostr-tools # or yarn add nostr-tools
 ```
 
+If using TypeScript, this package requires TypeScript >= 5.0.
+
 ## Usage
 
 ### Generating a private key and a public key
 
 ```js
-import {generatePrivateKey, getPublicKey} from 'nostr-tools'
+import { generatePrivateKey, getPublicKey } from 'nostr-tools'
 
 let sk = generatePrivateKey() // `sk` is a hex string
 let pk = getPublicKey(sk) // `pk` is a hex string
@@ -26,20 +28,14 @@ let pk = getPublicKey(sk) // `pk` is a hex string
 ### Creating, signing and verifying events
 
 ```js
-import {
-  validateEvent,
-  verifySignature,
-  getSignature,
-  getEventHash,
-  getPublicKey
-} from 'nostr-tools'
+import { validateEvent, verifySignature, getSignature, getEventHash, getPublicKey } from 'nostr-tools'
 
 let event = {
   kind: 1,
   created_at: Math.floor(Date.now() / 1000),
   tags: [],
   content: 'hello',
-  pubkey: getPublicKey(privateKey)
+  pubkey: getPublicKey(privateKey),
 }
 
 event.id = getEventHash(event)
@@ -52,13 +48,7 @@ let veryOk = verifySignature(event)
 ### Interacting with a relay
 
 ```js
-import {
-  relayInit,
-  generatePrivateKey,
-  getPublicKey,
-  getEventHash,
-  getSignature
-} from 'nostr-tools'
+import { relayInit, finishEvent, generatePrivateKey, getPublicKey } from 'nostr-tools'
 
 const relay = relayInit('wss://relay.example.com')
 relay.on('connect', () => {
@@ -73,8 +63,8 @@ await relay.connect()
 // let's query for an event that exists
 let sub = relay.sub([
   {
-    ids: ['d7dd5eb3ab747e16f8d0212d53032ea2a7cadef53837e5a6c66d42849fcb9027']
-  }
+    ids: ['d7dd5eb3ab747e16f8d0212d53032ea2a7cadef53837e5a6c66d42849fcb9027'],
+  },
 ])
 sub.on('event', event => {
   console.log('we got the event we wanted:', event)
@@ -90,8 +80,8 @@ let pk = getPublicKey(sk)
 let sub = relay.sub([
   {
     kinds: [1],
-    authors: [pk]
-  }
+    authors: [pk],
+  },
 ])
 
 sub.on('event', event => {
@@ -100,19 +90,18 @@ sub.on('event', event => {
 
 let event = {
   kind: 1,
-  pubkey: pk,
   created_at: Math.floor(Date.now() / 1000),
   tags: [],
-  content: 'hello world'
+  content: 'hello world',
 }
-event.id = getEventHash(event)
-event.sig = getSignature(event, sk)
 
-await relay.publish(event)
+// this assigns the pubkey, calculates the event id and signs the event in a single step
+const signedEvent = finishEvent(event, sk)
+await relay.publish(signedEvent)
 
-let events = await relay.list([{kinds: [0, 1]}])
+let events = await relay.list([{ kinds: [0, 1] }])
 let event = await relay.get({
-  ids: ['44e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245']
+  ids: ['44e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245'],
 })
 
 relay.close()
@@ -127,7 +116,7 @@ import 'websocket-polyfill'
 ### Interacting with multiple relays
 
 ```js
-import {SimplePool} from 'nostr-tools'
+import { SimplePool } from 'nostr-tools'
 
 const pool = new SimplePool()
 
@@ -137,11 +126,9 @@ let sub = pool.sub(
   [...relays, 'wss://relay.example3.com'],
   [
     {
-      authors: [
-        '32e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245'
-      ]
-    }
-  ]
+      authors: ['32e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245'],
+    },
+  ],
 )
 
 sub.on('event', event => {
@@ -150,31 +137,35 @@ sub.on('event', event => {
 })
 
 let pubs = pool.publish(relays, newEvent)
-pubs.on('ok', () => {
-  // this may be called multiple times, once for every relay that accepts the event
-  // ...
-})
+await Promise.all(pubs)
 
-let events = await pool.list(relays, [{kinds: [0, 1]}])
+let events = await pool.list(relays, [{ kinds: [0, 1] }])
 let event = await pool.get(relays, {
-  ids: ['44e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245']
+  ids: ['44e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245'],
 })
 
-let relaysForEvent = pool.seenOn(
-  '44e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245'
-)
+let batchedEvents = await pool.batchedList('notes', relays, [{ kinds: [1] }])
+// `batchedList` will wait for other function calls with the same `batchKey`
+// (e.g. 'notes', 'authors', etc) within a fixed amount of time (default: `100ms`) before sending
+// next ws request, and batch all requests with similar `batchKey`s together in a single request.
+
+let relaysForEvent = pool.seenOn('44e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245')
 // relaysForEvent will be an array of URLs from relays a given event was seen on
+
+pool.close()
 ```
 
+read more details about `batchedList` on this pr: [https://github.com/nbd-wtf/nostr-tools/pull/279](https://github.com/nbd-wtf/nostr-tools/pull/279#issue-1859315757)
+
 ### Parsing references (mentions) from a content using NIP-10 and NIP-27
 
 ```js
-import {parseReferences} from 'nostr-tools'
+import { parseReferences } from 'nostr-tools'
 
 let references = parseReferences(event)
 let simpleAugmentedContent = event.content
 for (let i = 0; i < references.length; i++) {
-  let {text, profile, event, address} = references[i]
+  let { text, profile, event, address } = references[i]
   let augmentedReference = profile
     ? `<strong>@${profilesCache[profile.pubkey].name}</strong>`
     : event
@@ -189,7 +180,7 @@ for (let i = 0; i < references.length; i++) {
 ### Querying profile data from a NIP-05 address
 
 ```js
-import {nip05} from 'nostr-tools'
+import { nip05 } from 'nostr-tools'
 
 let profile = await nip05.queryProfile('jb55.com')
 console.log(profile.pubkey)
@@ -198,7 +189,7 @@ console.log(profile.relays)
 // prints: [wss://relay.damus.io]
 ```
 
-To use this on Node.js 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
 nip05.useFetchImplementation(require('node-fetch'))
@@ -207,27 +198,24 @@ nip05.useFetchImplementation(require('node-fetch'))
 ### Encoding and decoding NIP-19 codes
 
 ```js
-import {nip19, generatePrivateKey, getPublicKey} from 'nostr-tools'
+import { nip19, generatePrivateKey, getPublicKey } from 'nostr-tools'
 
 let sk = generatePrivateKey()
 let nsec = nip19.nsecEncode(sk)
-let {type, data} = nip19.decode(nsec)
+let { type, data } = nip19.decode(nsec)
 assert(type === 'nsec')
 assert(data === sk)
 
 let pk = getPublicKey(generatePrivateKey())
 let npub = nip19.npubEncode(pk)
-let {type, data} = nip19.decode(npub)
+let { type, data } = nip19.decode(npub)
 assert(type === 'npub')
 assert(data === pk)
 
 let pk = getPublicKey(generatePrivateKey())
-let relays = [
-  'wss://relay.nostr.example.mydomain.example.com',
-  'wss://nostr.banana.com'
-]
-let nprofile = nip19.nprofileEncode({pubkey: pk, relays})
-let {type, data} = nip19.decode(nprofile)
+let relays = ['wss://relay.nostr.example.mydomain.example.com', 'wss://nostr.banana.com']
+let nprofile = nip19.nprofileEncode({ pubkey: pk, relays })
+let { type, data } = nip19.decode(nprofile)
 assert(type === 'nprofile')
 assert(data.pubkey === pk)
 assert(data.relays.length === 2)
@@ -236,7 +224,7 @@ assert(data.relays.length === 2)
 ### Encrypting and decrypting direct messages
 
 ```js
-import {nip04, getPublicKey, generatePrivateKey} from 'nostr-tools'
+import { nip04, getPublicKey, generatePrivateKey } from 'nostr-tools'
 
 // sender
 let sk1 = generatePrivateKey()
@@ -255,13 +243,13 @@ let event = {
   pubkey: pk1,
   tags: [['p', pk2]],
   content: ciphertext,
-  ...otherProperties
+  ...otherProperties,
 }
 
 sendEvent(event)
 
 // on the receiver side
-sub.on('event', event => {
+sub.on('event', async event => {
   let sender = event.pubkey
   pk1 === sender
   let plaintext = await nip04.decrypt(sk2, pk1, event.content)
@@ -271,7 +259,7 @@ sub.on('event', event => {
 ### Performing and checking for delegation
 
 ```js
-import {nip26, getPublicKey, generatePrivateKey} from 'nostr-tools'
+import { nip26, getPublicKey, generatePrivateKey } from 'nostr-tools'
 
 // delegator
 let sk1 = generatePrivateKey()
@@ -286,7 +274,7 @@ let delegation = nip26.createDelegation(sk1, {
   pubkey: pk2,
   kind: 1,
   since: Math.round(Date.now() / 1000),
-  until: Math.round(Date.now() / 1000) + 60 * 60 * 24 * 30 /* 30 days */
+  until: Math.round(Date.now() / 1000) + 60 * 60 * 24 * 30 /* 30 days */,
 })
 
 // the delegatee uses the delegation when building an event
@@ -295,7 +283,7 @@ let event = {
   kind: 1,
   created_at: Math.round(Date.now() / 1000),
   content: 'hello from a delegated key',
-  tags: [['delegation', delegation.from, delegation.cond, delegation.sig]]
+  tags: [['delegation', delegation.from, delegation.cond, delegation.sig]],
 }
 
 // finally any receiver of this event can check for the presence of a valid delegation tag