nostr-tools 0.12.1 → 0.13.0

package/.eslintrc.json

@@ -1,4 +1,5 @@
 {
+  "root": true,
   "parserOptions": {
     "ecmaVersion": 9,
     "ecmaFeatures": {

package/event.js

@@ -34,13 +34,13 @@ export function verifySignature(event) {
   if (event.id !== getEventHash(event)) return false
   return verifySchnorr(
     Buffer.from(event.id, 'hex'),
-    Buffer.from(event.pubkey, 'hex')
-    Buffer.from(event.sig, 'hex'),
+    Buffer.from(event.pubkey, 'hex'),
+    Buffer.from(event.sig, 'hex')
   )
 }
 
 export function signEvent(event, key) {
   let eventHash = Buffer.from(getEventHash(event), 'hex')
-  let key = Buffer.from(key, 'hex')
-  return Buffer.from(signSchnorr(eventHash, key)).toString('hex')
+  let keyB = Buffer.from(key, 'hex')
+  return Buffer.from(signSchnorr(eventHash, keyB)).toString('hex')
 }

package/index.js

@@ -11,6 +11,7 @@ import {
 import {matchFilter, matchFilters} from './filter'
 
 export {
+  generatePrivateKey,
   relayConnect,
   relayPool,
   signEvent,

package/keys.js

@@ -13,7 +13,7 @@ export function generatePrivateKey() {
 }
 
 export function getPublicKey(privateKey) {
-  return Buffer.from(
-    pointFromScalar(Buffer.from(privateKey, 'hex'), true)
-  ).toString('hex')
+  return Buffer.from(pointFromScalar(Buffer.from(privateKey, 'hex'), true))
+    .toString('hex')
+    .slice(2)
 }

package/nip06.js

@@ -1,4 +1,3 @@
-import createHmac from 'create-hmac'
 import {wordlist} from 'micro-bip39/wordlists/english'
 import {
   generateMnemonic,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nostr-tools",
-  "version": "0.12.1",
+  "version": "0.13.0",
   "description": "Tools for making a Nostr client.",
   "repository": {
     "type": "git",
@@ -12,7 +12,6 @@
     "browserify-cipher": ">=1",
     "buffer": ">=5",
     "create-hash": "^1.2.0",
-    "create-hmac": ">=1",
     "dns-packet": "^5.2.4",
     "micro-bip39": "^0.1.3",
     "randombytes": ">=2",
@@ -30,5 +29,9 @@
     "censorship",
     "censorship-resistance",
     "client"
-  ]
+  ],
+  "devDependencies": {
+    "eslint": "^8.5.0",
+    "eslint-plugin-babel": "^5.3.1"
+  }
 }

package/pool.js

@@ -1,9 +1,14 @@
 import {getEventHash, signEvent} from './event'
 import {relayConnect, normalizeRelayURL} from './relay'
 
-export function relayPool(globalPrivateKey) {
+export function relayPool() {
+  var globalPrivateKey
+  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
+    randomChoice: null
+  }
   const relays = {}
-  const globalSub = []
   const noticeCallbacks = []
 
   function propagateNotice(notice, relayURL) {
@@ -28,29 +33,34 @@ export function relayPool(globalPrivateKey) {
     const activeCallback = cb
     const activeFilters = filter
 
-    activeSubscriptions[id] = {
-      sub: ({cb = activeCallback, filter = activeFilters}) => {
-        Object.entries(subControllers).map(([relayURL, sub]) => [
-          relayURL,
-          sub.sub({cb, filter}, id)
-        ])
-        return activeSubscriptions[id]
-      },
-      addRelay: relay => {
-        subControllers[relay.url] = relay.sub({cb, filter}, id)
-        return activeSubscriptions[id]
-      },
-      removeRelay: relayURL => {
-        if (relayURL in subControllers) {
-          subControllers[relayURL].unsub()
-          if (Object.keys(subControllers).length === 0) unsub()
-        }
-        return activeSubscriptions[id]
-      },
-      unsub: () => {
-        Object.values(subControllers).forEach(sub => sub.unsub())
-        delete activeSubscriptions[id]
+    const unsub = () => {
+      Object.values(subControllers).forEach(sub => sub.unsub())
+      delete activeSubscriptions[id]
+    }
+    const sub = ({cb = activeCallback, filter = activeFilters}) => {
+      Object.entries(subControllers).map(([relayURL, sub]) => [
+        relayURL,
+        sub.sub({cb, filter}, id)
+      ])
+      return activeSubscriptions[id]
+    }
+    const addRelay = relay => {
+      subControllers[relay.url] = relay.sub({cb, filter}, id)
+      return activeSubscriptions[id]
+    }
+    const removeRelay = relayURL => {
+      if (relayURL in subControllers) {
+        subControllers[relayURL].unsub()
+        if (Object.keys(subControllers).length === 0) unsub()
       }
+      return activeSubscriptions[id]
+    }
+
+    activeSubscriptions[id] = {
+      sub,
+      unsub,
+      addRelay,
+      removeRelay
     }
 
     return activeSubscriptions[id]
@@ -62,11 +72,14 @@ export function relayPool(globalPrivateKey) {
     setPrivateKey(privateKey) {
       globalPrivateKey = privateKey
     },
-    async addRelay(url, policy = {read: true, write: true}) {
+    setPolicy(key, value) {
+      poolPolicy[key] = value
+    },
+    addRelay(url, policy = {read: true, write: true}) {
       let relayURL = normalizeRelayURL(url)
       if (relayURL in relays) return
 
-      let relay = await relayConnect(url, notice => {
+      let relay = relayConnect(url, notice => {
         propagateNotice(notice, relayURL)
       })
       relays[relayURL] = {relay, policy}
@@ -95,13 +108,13 @@ export function relayPool(globalPrivateKey) {
       if (index !== -1) noticeCallbacks.splice(index, 1)
     },
     async publish(event, statusCallback = (status, relayURL) => {}) {
-      event.id = await getEventHash(event)
+      event.id = getEventHash(event)
 
       if (!event.sig) {
         event.tags = event.tags || []
 
         if (globalPrivateKey) {
-          event.sig = await signEvent(event, globalPrivateKey)
+          event.sig = signEvent(event, globalPrivateKey)
         } 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."
@@ -109,17 +122,39 @@ export function relayPool(globalPrivateKey) {
         }
       }
 
-      Object.values(relays)
+      let writeable = Object.values(relays)
         .filter(({policy}) => policy.write)
-        .map(async ({relay}) => {
-          try {
-            await relay.publish(event, status =>
-              statusCallback(status, relay.url)
-            )
-          } catch (err) {
-            statusCallback(-1, relay.url)
+        .sort(() => Math.random() - 0.5) // random
+
+      let maxTargets = poolPolicy.randomChoice
+        ? poolPolicy.randomChoice
+        : writeable.length
+
+      let successes = 0
+
+      for (let i = 0; i < writeable.length; i++) {
+        let {relay} = writeable[i]
+
+        try {
+          await new Promise(async (resolve, reject) => {
+            try {
+              await relay.publish(event, status => {
+                statusCallback(status, relay.url)
+                resolve()
+              })
+            } catch (err) {
+              statusCallback(-1, relay.url)
+            }
+          })
+
+          successes++
+          if (successes >= maxTargets) {
+            break
           }
-        })
+        } catch (err) {
+          /***/
+        }
+      }
 
       return event
     }

package/relay.js

@@ -1,3 +1,5 @@
+/* global WebSocket */
+
 import 'websocket-polyfill'
 
 import {verifySignature} from './event'
@@ -11,7 +13,7 @@ export function normalizeRelayURL(url) {
   return [host, ...qs].join('?')
 }
 
-export function relayConnect(url, onNotice) {
+export function relayConnect(url, onNotice = () => {}, onError = () => {}) {
   url = normalizeRelayURL(url)
 
   var ws, resolveOpen, untilOpen, wasClosed
@@ -44,8 +46,9 @@ export function relayConnect(url, onNotice) {
         }
       }
     }
-    ws.onerror = () => {
+    ws.onerror = (err) => {
       console.log('error connecting to relay', url)
+      onError(err)
     }
     ws.onclose = () => {
       resetOpenState()
@@ -144,22 +147,26 @@ export function relayConnect(url, onNotice) {
   return {
     url,
     sub,
-    async publish(event, statusCallback = status => {}) {
+    async publish(event, statusCallback) {
       try {
         await trySend(['EVENT', event])
-        statusCallback(0)
-        let {unsub} = relay.sub(
-          {
-            cb: () => {
-              statusCallback(1)
+        if (statusCallback) {
+          statusCallback(0)
+          let {unsub} = sub(
+            {
+              cb: () => {
+                statusCallback(1)
+                unsub()
+                clearTimeout(willUnsub)
+              },
+              filter: {id: event.id}
             },
-            filter: {id: event.id}
-          },
-          `monitor-${event.id.slice(0, 5)}`
-        )
-        setTimeout(unsub, 5000)
+            `monitor-${event.id.slice(0, 5)}`
+          )
+          let willUnsub = setTimeout(unsub, 5000)
+        }
       } catch (err) {
-        statusCallback(-1)
+        if (statusCallback) statusCallback(-1)
       }
     },
     close() {