chore: bump version to 0.23.0

'Buffer' wasn't imported initially and was causing issues when I tried to use generatePrivateKey in a client I am building. not sure why Branle has no error, maybe I am doing something wrong?

README.md

@@ -15,7 +15,7 @@ pool.addRelay('ws://some.relay.com', {read: true, write: true})
 pool.addRelay('ws://other.relay.cool', {read: true, write: true})
 
 // example callback function for a subscription
-function onEvent(event, relay) => {
+function onEvent(event, relay) {
   console.log(`got an event from ${relay.url} which is already validated.`, event)
 }
 

event.js

@@ -52,5 +52,7 @@ export function verifySignature(event) {
 }
 
 export async function signEvent(event, key) {
-  return secp256k1.schnorr.sign(getEventHash(event), key)
+  return Buffer.from(
+    await secp256k1.schnorr.sign(getEventHash(event), key)
+  ).toString('hex')
 }

keys.js

@@ -1,9 +1,10 @@
 import * as secp256k1 from '@noble/secp256k1'
+import {Buffer} from 'buffer'
 
 export function generatePrivateKey() {
   return Buffer.from(secp256k1.utils.randomPrivateKey()).toString('hex')
 }
 
 export function getPublicKey(privateKey) {
-  return secp256k1.schnorr.getPublicKey(privateKey)
+  return Buffer.from(secp256k1.schnorr.getPublicKey(privateKey)).toString('hex')
 }

nip04.js

@@ -5,7 +5,7 @@ import * as secp256k1 from '@noble/secp256k1'
 
 export function encrypt(privkey, pubkey, text) {
   const key = secp256k1.getSharedSecret(privkey, '02' + pubkey)
-  const normalizedKey = getOnlyXFromFullSharedSecret(key)
+  const normalizedKey = getNormalizedX(key)
 
   let iv = Uint8Array.from(randomBytes(16))
   var cipher = aes.createCipheriv(
@@ -16,24 +16,27 @@ export function encrypt(privkey, pubkey, text) {
   let encryptedMessage = cipher.update(text, 'utf8', 'base64')
   encryptedMessage += cipher.final('base64')
 
-  return [encryptedMessage, Buffer.from(iv.buffer).toString('base64')]
+  return `${encryptedMessage}?iv=${Buffer.from(iv.buffer).toString('base64')}`
 }
 
-export function decrypt(privkey, pubkey, ciphertext, iv) {
+export function decrypt(privkey, pubkey, ciphertext) {
-  const key = secp256k1.getSharedSecret(privkey, '02' + pubkey)
+  let [cip, iv] = ciphertext.split('?iv=')
-  const normalizedKey = getOnlyXFromFullSharedSecret(key)
+  let key = secp256k1.getSharedSecret(privkey, '02' + pubkey)
+  let normalizedKey = getNormalizedX(key)
 
   var decipher = aes.createDecipheriv(
     'aes-256-cbc',
     Buffer.from(normalizedKey, 'hex'),
     Buffer.from(iv, 'base64')
   )
-  let decryptedMessage = decipher.update(ciphertext, 'base64')
+  let decryptedMessage = decipher.update(cip, 'base64')
   decryptedMessage += decipher.final('utf8')
 
   return decryptedMessage
 }
 
-function getOnlyXFromFullSharedSecret(fullSharedSecretCoordinates) {
+function getNormalizedX(key) {
-  return fullSharedSecretCoordinates.substr(2, 64)
+  return typeof key === 'string'
+    ? key.substr(2, 64)
+    : Buffer.from(key.slice(1, 33)).toString('hex')
 }

nip05.js

@@ -1,52 +1,28 @@
-import {Buffer} from 'buffer'
+import fetch from 'cross-fetch'
-import dnsPacket from 'dns-packet'
-
-const dohProviders = [
-  'cloudflare-dns.com',
-  'fi.doh.dns.snopyta.org',
-  'basic.bravedns.com',
-  'hydra.plan9-ns1.com',
-  'doh.pl.ahadns.net',
-  'dns.flatuslifir.is',
-  'doh.dns.sb',
-  'doh.li'
-]
-
-let counter = 0
-
-export async function keyFromDomain(domain) {
-  let host = dohProviders[counter % dohProviders.length]
-
-  let buf = dnsPacket.encode({
-    type: 'query',
-    id: Math.floor(Math.random() * 65534),
-    flags: dnsPacket.RECURSION_DESIRED,
-    questions: [
-      {
-        type: 'TXT',
-        name: `_nostrkey.${domain}`
-      }
-    ]
-  })
-
-  let fetching = fetch(`https://${host}/dns-query`, {
-    method: 'POST',
-    headers: {
-      'Content-Type': 'application/dns-message',
-      'Content-Length': Buffer.byteLength(buf)
-    },
-    body: buf
-  })
-
-  counter++
 
+export async function searchDomain(domain, query = '') {
   try {
-    let response = Buffer.from(await (await fetching).arrayBuffer())
+    let res = await (
-    let {answers} = dnsPacket.decode(response)
+      await fetch(`https://${domain}/.well-known/nostr.json?name=${query}`)
-    if (answers.length === 0) return null
+    ).json()
-    return Buffer.from(answers[0].data[0]).toString()
+
-  } catch (err) {
+    return res.names
-    console.log(`error querying DNS for ${domain} on ${host}`, err)
+  } catch (_) {
+    return []
+  }
+}
+
+export async function queryName(fullname) {
+  try {
+    let [name, domain] = fullname.split('@')
+    if (!domain) return null
+
+    let res = await (
+      await fetch(`https://${domain}/.well-known/nostr.json?name=${name}`)
+    ).json()
+
+    return res.names && res.names[name]
+  } catch (_) {
     return null
   }
 }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "nostr-tools",
-  "version": "0.18.0",
+  "version": "0.23.0",
   "description": "Tools for making a Nostr client.",
   "repository": {
     "type": "git",
@@ -8,11 +8,11 @@
   },
   "dependencies": {
     "@noble/hashes": "^0.5.7",
-    "@noble/secp256k1": "^1.3.0",
+    "@noble/secp256k1": "^1.5.2",
     "browserify-cipher": ">=1",
     "buffer": ">=5",
     "create-hash": "^1.2.0",
-    "dns-packet": "^5.2.4",
+    "cross-fetch": "^3.1.4",
     "micro-bip32": "^0.1.0",
     "micro-bip39": "^0.1.3",
     "websocket-polyfill": "^0.0.3"

pool.js

@@ -1,8 +1,10 @@
-import {getEventHash, signEvent} from './event'
+import {getEventHash, verifySignature, signEvent} from './event'
 import {relayConnect, normalizeRelayURL} from './relay'
 
 export function relayPool() {
   var globalPrivateKey
+  var globalSigningFunction
+
   const poolPolicy = {
     // setting this to a number will cause events to be published to a random
     // set of relays only, instead of publishing to all relays all the time
@@ -24,27 +26,35 @@ export function relayPool() {
 
   const activeSubscriptions = {}
 
-  const sub = ({cb, filter}, id = Math.random().toString().slice(2)) => {
+  const sub = (
+    {cb, filter, beforeSend},
+    id = Math.random().toString().slice(2)
+  ) => {
     const subControllers = Object.fromEntries(
       Object.values(relays)
         .filter(({policy}) => policy.read)
         .map(({relay}) => [
           relay.url,
-          relay.sub({filter, cb: event => cb(event, relay.url)}, id)
+          relay.sub({filter, cb: event => cb(event, relay.url), beforeSend}, id)
         ])
     )
 
     const activeCallback = cb
     const activeFilters = filter
+    const activeBeforeSend = beforeSend
 
     const unsub = () => {
       Object.values(subControllers).forEach(sub => sub.unsub())
       delete activeSubscriptions[id]
     }
-    const sub = ({cb = activeCallback, filter = activeFilters}) => {
+    const sub = ({
+      cb = activeCallback,
+      filter = activeFilters,
+      beforeSend = activeBeforeSend
+    }) => {
       Object.entries(subControllers).map(([relayURL, sub]) => [
         relayURL,
-        sub.sub({cb, filter}, id)
+        sub.sub({cb, filter, beforeSend}, id)
       ])
       return activeSubscriptions[id]
     }
@@ -76,6 +86,9 @@ export function relayPool() {
     setPrivateKey(privateKey) {
       globalPrivateKey = privateKey
     },
+    registerSigningFunction(fn) {
+      globalSigningFunction = fn
+    },
     setPolicy(key, value) {
       poolPolicy[key] = value
     },
@@ -123,9 +136,21 @@ export function relayPool() {
 
         if (globalPrivateKey) {
           event.sig = await signEvent(event, globalPrivateKey)
+        } else if (globalSigningFunction) {
+          event.sig = await globalSigningFunction(event)
+          if (!event.sig) {
+            // abort here
+            return
+          } else {
+            // check
+            if (!(await verifySignature(event)))
+              throw new Error(
+                'signature provided by custom signing function is invalid.'
+              )
+          }
         } else {
           throw new Error(
-            "can't publish unsigned event. either sign this event beforehand or pass a private key while initializing this relay pool so it can be signed automatically."
+            "can't publish unsigned event. either sign this event beforehand, provide a signing function or pass a private key while initializing this relay pool so it can be signed automatically."
           )
         }
       }

relay.js

@@ -119,7 +119,10 @@ export function relayConnect(url, onNotice = () => {}, onError = () => {}) {
     ws.send(msg)
   }
 
-  const sub = ({cb, filter}, channel = Math.random().toString().slice(2)) => {
+  const sub = (
+    {cb, filter, beforeSend},
+    channel = Math.random().toString().slice(2)
+  ) => {
     var filters = []
     if (Array.isArray(filter)) {
       filters = filter
@@ -127,16 +130,25 @@ export function relayConnect(url, onNotice = () => {}, onError = () => {}) {
       filters.push(filter)
     }
 
+    if (beforeSend) {
+      const beforeSendResult = beforeSend({filter, relay: url, channel})
+      filters = beforeSendResult.filter
+    }
+
     trySend(['REQ', channel, ...filters])
     channels[channel] = cb
     openSubs[channel] = filters
 
     const activeCallback = cb
     const activeFilters = filters
+    const activeBeforeSend = beforeSend
 
     return {
-      sub: ({cb = activeCallback, filter = activeFilters}) =>
+      sub: ({
-        sub({cb, filter}, channel),
+        cb = activeCallback,
+        filter = activeFilters,
+        beforeSend = activeBeforeSend
+      }) => sub({cb, filter, beforeSend}, channel),
       unsub: () => {
         delete openSubs[channel]
         delete channels[channel]
@@ -160,7 +172,7 @@ export function relayConnect(url, onNotice = () => {}, onError = () => {}) {
                 unsub()
                 clearTimeout(willUnsub)
               },
-              filter: {id: event.id}
+              filter: {ids: [event.id]}
             },
             `monitor-${event.id.slice(0, 5)}`
           )