Compare commits

..

19 Commits

Author SHA1 Message Date
fiatjaf
7bc9083bc5 randomChoice pool policy. 2021-12-30 21:46:54 -03:00
fiatjaf
ce214ebbab small tweaks on relayConnect. 2021-12-30 15:02:05 -03:00
fiatjaf
800beb37f1 cut out the first byte of pubkeys. 2021-12-29 15:15:53 -03:00
fiatjaf
6d4916e6f7 eslint and minor fixes. 2021-12-29 14:35:28 -03:00
fiatjaf
60fc0d7940 use tiny-secp256k1, updated nip06 and other utils. 2021-12-29 14:29:43 -03:00
fiatjaf
faa308049f always add event.id 2021-12-28 20:44:35 -03:00
fiatjaf
7b0220c1b8 use browserify-cipher for aes.
it seems everybody was including this by default before, but now webpack and others are not.
2021-12-18 20:30:58 -03:00
fiatjaf
d8eee25e3a another typo: null != undefined. 2021-12-14 22:06:31 -03:00
fiatjaf
d5e93e0c30 fix a typo in matchFilter function. 2021-12-14 22:02:56 -03:00
fiatjaf
fff31b5ff4 automatically run received events through the filters they should pass (double-check the work made by the relay). 2021-12-14 22:00:42 -03:00
fiatjaf
cd7ffb8911 add local event filter functions. 2021-12-14 21:56:07 -03:00
fiatjaf
4f0cae0eb8 add missing id arguments. 2021-12-13 21:22:23 -03:00
fiatjaf
06e867b675 stop sending repeated REQs. 2021-12-13 20:58:49 -03:00
fiatjaf
22e895c7c2 use exponential backoff for reconnections. 2021-12-12 11:39:56 -03:00
fiatjaf
02cacd4446 return sub object from .sub() and other methods. 2021-12-12 06:47:52 -03:00
fiatjaf
a99188e4cf remove log line for events with invalid signature. 2021-12-12 05:54:48 -03:00
fiatjaf
93b22e48a6 add nip06. 2021-12-11 19:46:51 -03:00
fiatjaf
57b9bac9b1 end the rollup madness, just ship the source. 2021-12-11 09:01:52 -03:00
fiatjaf
625b3bb3ba fix buffer import and use rollup for transpiling the package. 2021-12-11 08:53:43 -03:00
15 changed files with 262 additions and 146 deletions

View File

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

View File

@@ -67,4 +67,6 @@ pool.addRelay('<url>')
// will automatically subscribe to the all the events called with .sub above // will automatically subscribe to the all the events called with .sub above
``` ```
All functions expect bytearrays as hex strings and output bytearrays as hex strings.
For other utils please read the source (for now). For other utils please read the source (for now).

46
event.js Normal file
View File

@@ -0,0 +1,46 @@
import {Buffer} from 'buffer'
import createHash from 'create-hash'
import {signSchnorr, verifySchnorr} from 'tiny-secp256k1'
export function getBlankEvent() {
return {
kind: 255,
pubkey: null,
content: '',
tags: [],
created_at: 0
}
}
export function serializeEvent(evt) {
return JSON.stringify([
0,
evt.pubkey,
evt.created_at,
evt.kind,
evt.tags || [],
evt.content
])
}
export function getEventHash(event) {
let eventHash = createHash('sha256')
.update(Buffer.from(serializeEvent(event)))
.digest()
return Buffer.from(eventHash).toString('hex')
}
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')
)
}
export function signEvent(event, key) {
let eventHash = Buffer.from(getEventHash(event), 'hex')
let keyB = Buffer.from(key, 'hex')
return Buffer.from(signSchnorr(eventHash, keyB)).toString('hex')
}

27
filter.js Normal file
View File

@@ -0,0 +1,27 @@
export function matchFilter(filter, event) {
if (filter.id && event.id !== filter.id) return false
if (filter.kind && event.kind !== filter.kind) return false
if (filter.author && event.pubkey !== filter.author) return false
if (filter.authors && filter.authors.indexOf(event.pubkey) === -1)
return false
if (
filter['#e'] &&
!event.tags.find(([t, v]) => t === 'e' && v === filter['#e'])
)
return false
if (
filter['#p'] &&
!event.tags.find(([t, v]) => t === 'p' && v === filter['#p'])
)
return false
if (filter.since && event.created_at <= filter.since) return false
return true
}
export function matchFilters(filters, event) {
for (let i = 0; i < filters.length; i++) {
if (matchFilter(filters[i], event)) return true
}
return false
}

View File

@@ -1,3 +1,4 @@
import {generatePrivateKey, getPublicKey} from './keys'
import {relayConnect} from './relay' import {relayConnect} from './relay'
import {relayPool} from './pool' import {relayPool} from './pool'
import { import {
@@ -7,19 +8,18 @@ import {
serializeEvent, serializeEvent,
getEventHash getEventHash
} from './event' } from './event'
import {makeRandom32, sha256, getPublicKey} from './utils' import {matchFilter, matchFilters} from './filter'
export { export {
generatePrivateKey,
relayConnect, relayConnect,
relayPool, relayPool,
signEvent, signEvent,
verifySignature, verifySignature,
serializeEvent, serializeEvent,
getEventHash, getEventHash,
makeRandom32,
sha256,
getPublicKey, getPublicKey,
getBlankEvent getBlankEvent,
matchFilter,
matchFilters
} }
export * from './nip04'
export * from './nip05'

19
keys.js Normal file
View File

@@ -0,0 +1,19 @@
import randomBytes from 'randombytes'
import {isPrivate, pointFromScalar} from 'tiny-secp256k1'
export function generatePrivateKey() {
let i = 8
while (i--) {
let r32 = Buffer.from(randomBytes(32))
if (isPrivate(r32)) return r32.toString('hex')
}
throw new Error(
'Valid private key was not found in 8 iterations. PRNG is broken'
)
}
export function getPublicKey(privateKey) {
return Buffer.from(pointFromScalar(Buffer.from(privateKey, 'hex'), true))
.toString('hex')
.slice(2)
}

View File

@@ -1,12 +1,14 @@
import Buffer from 'buffer' import aes from 'browserify-cipher'
import {Buffer} from 'buffer'
import randomBytes from 'randombytes'
import * as secp256k1 from '@noble/secp256k1' import * as secp256k1 from '@noble/secp256k1'
export function encrypt(privkey, pubkey, text) { export function encrypt(privkey, pubkey, text) {
const key = secp256k1.getSharedSecret(privkey, '02' + pubkey) const key = secp256k1.getSharedSecret(privkey, '02' + pubkey)
const normalizedKey = getOnlyXFromFullSharedSecret(key) const normalizedKey = getOnlyXFromFullSharedSecret(key)
let iv = crypto.randomFillSync(new Uint8Array(16)) let iv = Uint8Array.from(randomBytes(16))
var cipher = crypto.createCipheriv( var cipher = aes.createCipheriv(
'aes-256-cbc', 'aes-256-cbc',
Buffer.from(normalizedKey, 'hex'), Buffer.from(normalizedKey, 'hex'),
iv iv
@@ -21,7 +23,7 @@ export function decrypt(privkey, pubkey, ciphertext, iv) {
const key = secp256k1.getSharedSecret(privkey, '02' + pubkey) const key = secp256k1.getSharedSecret(privkey, '02' + pubkey)
const normalizedKey = getOnlyXFromFullSharedSecret(key) const normalizedKey = getOnlyXFromFullSharedSecret(key)
var decipher = crypto.createDecipheriv( var decipher = aes.createDecipheriv(
'aes-256-cbc', 'aes-256-cbc',
Buffer.from(normalizedKey, 'hex'), Buffer.from(normalizedKey, 'hex'),
Buffer.from(iv, 'base64') Buffer.from(iv, 'base64')

View File

@@ -1,4 +1,4 @@
import Buffer from 'buffer' import {Buffer} from 'buffer'
import dnsPacket from 'dns-packet' import dnsPacket from 'dns-packet'
const dohProviders = [ const dohProviders = [

27
nip06.js Normal file
View File

@@ -0,0 +1,27 @@
import {wordlist} from 'micro-bip39/wordlists/english'
import {
generateMnemonic,
mnemonicToSeedSync,
validateMnemonic
} from 'micro-bip39'
import BIP32Factory from 'bip32'
import * as ecc from 'tiny-secp256k1'
const bip32 = BIP32Factory(ecc)
export function privateKeyFromSeed(seed) {
let root = bip32.fromSeed(Buffer.from(seed, 'hex'))
return root.derivePath(`m/44'/1237'/0'/0'`).privateKey.toString('hex')
}
export function seedFromWords(mnemonic) {
return Buffer.from(mnemonicToSeedSync(mnemonic, wordlist)).toString('hex')
}
export function generateSeedWords() {
return generateMnemonic(wordlist)
}
export function validateWords(words) {
return validateMnemonic(words, wordlist)
}

View File

@@ -1,18 +1,21 @@
{ {
"name": "nostr-tools", "name": "nostr-tools",
"version": "0.6.1", "version": "0.13.0",
"description": "Tools for making a Nostr client.", "description": "Tools for making a Nostr client.",
"main": "dist/nostr-tools.esm.min.js",
"module": "dist/nostr-tools.esm.min.js",
"browser": "dist/nostr-tools.umd.min.js",
"repository": { "repository": {
"type": "git", "type": "git",
"url": "https://github.com/fiatjaf/nostr-tools.git" "url": "https://github.com/fiatjaf/nostr-tools.git"
}, },
"dependencies": { "dependencies": {
"@noble/secp256k1": "^1.3.0", "@noble/secp256k1": "^1.3.0",
"buffer": "^6.0.3", "bip32": "^3.0.1",
"browserify-cipher": ">=1",
"buffer": ">=5",
"create-hash": "^1.2.0",
"dns-packet": "^5.2.4", "dns-packet": "^5.2.4",
"micro-bip39": "^0.1.3",
"randombytes": ">=2",
"tiny-secp256k1": "^2.1.2",
"websocket-polyfill": "^0.0.3" "websocket-polyfill": "^0.0.3"
}, },
"keywords": [ "keywords": [
@@ -28,12 +31,7 @@
"client" "client"
], ],
"devDependencies": { "devDependencies": {
"rollup": "^2.61.1" "eslint": "^8.5.0",
}, "eslint-plugin-babel": "^5.3.1"
"files": [
"dist"
],
"scripts": {
"prepublish": "rollup -c"
} }
} }

View File

@@ -1,9 +1,14 @@
import {getEventHash, signEvent} from './event' import {getEventHash, signEvent} from './event'
import {relayConnect, normalizeRelayURL} from './relay' 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 relays = {}
const globalSub = []
const noticeCallbacks = [] const noticeCallbacks = []
function propagateNotice(notice, relayURL) { function propagateNotice(notice, relayURL) {
@@ -21,32 +26,41 @@ export function relayPool(globalPrivateKey) {
.filter(({policy}) => policy.read) .filter(({policy}) => policy.read)
.map(({relay}) => [ .map(({relay}) => [
relay.url, relay.url,
relay.sub({filter, cb: event => cb(event, relay.url)}) relay.sub({filter, cb: event => cb(event, relay.url)}, id)
]) ])
) )
const activeCallback = cb const activeCallback = cb
const activeFilters = filter const activeFilters = filter
activeSubscriptions[id] = { const unsub = () => {
sub: ({cb = activeCallback, filter = activeFilters}) => Object.values(subControllers).forEach(sub => sub.unsub())
Object.entries(subControllers).map(([relayURL, sub]) => [ delete activeSubscriptions[id]
relayURL, }
sub.sub({cb, filter}, id) const sub = ({cb = activeCallback, filter = activeFilters}) => {
]), Object.entries(subControllers).map(([relayURL, sub]) => [
addRelay: relay => { relayURL,
subControllers[relay.url] = relay.sub({cb, filter}) sub.sub({cb, filter}, id)
}, ])
removeRelay: relayURL => { return activeSubscriptions[id]
if (relayURL in subControllers) { }
subControllers[relayURL].unsub() const addRelay = relay => {
if (Object.keys(subControllers).length === 0) unsub() subControllers[relay.url] = relay.sub({cb, filter}, id)
} return activeSubscriptions[id]
}, }
unsub: () => { const removeRelay = relayURL => {
Object.values(subControllers).forEach(sub => sub.unsub()) if (relayURL in subControllers) {
delete activeSubscriptions[id] subControllers[relayURL].unsub()
if (Object.keys(subControllers).length === 0) unsub()
} }
return activeSubscriptions[id]
}
activeSubscriptions[id] = {
sub,
unsub,
addRelay,
removeRelay
} }
return activeSubscriptions[id] return activeSubscriptions[id]
@@ -58,11 +72,14 @@ export function relayPool(globalPrivateKey) {
setPrivateKey(privateKey) { setPrivateKey(privateKey) {
globalPrivateKey = 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) let relayURL = normalizeRelayURL(url)
if (relayURL in relays) return if (relayURL in relays) return
let relay = await relayConnect(url, notice => { let relay = relayConnect(url, notice => {
propagateNotice(notice, relayURL) propagateNotice(notice, relayURL)
}) })
relays[relayURL] = {relay, policy} relays[relayURL] = {relay, policy}
@@ -91,12 +108,13 @@ export function relayPool(globalPrivateKey) {
if (index !== -1) noticeCallbacks.splice(index, 1) if (index !== -1) noticeCallbacks.splice(index, 1)
}, },
async publish(event, statusCallback = (status, relayURL) => {}) { async publish(event, statusCallback = (status, relayURL) => {}) {
event.id = getEventHash(event)
if (!event.sig) { if (!event.sig) {
event.tags = event.tags || [] event.tags = event.tags || []
if (globalPrivateKey) { if (globalPrivateKey) {
event.id = await getEventHash(event) event.sig = signEvent(event, globalPrivateKey)
event.sig = await signEvent(event, globalPrivateKey)
} else { } else {
throw new Error( 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 or pass a private key while initializing this relay pool so it can be signed automatically."
@@ -104,17 +122,39 @@ export function relayPool(globalPrivateKey) {
} }
} }
Object.values(relays) let writeable = Object.values(relays)
.filter(({policy}) => policy.write) .filter(({policy}) => policy.write)
.map(async ({relay}) => { .sort(() => Math.random() - 0.5) // random
try {
await relay.publish(event, status => let maxTargets = poolPolicy.randomChoice
statusCallback(status, relay.url) ? poolPolicy.randomChoice
) : writeable.length
} catch (err) {
statusCallback(-1, relay.url) 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 return event
} }

View File

@@ -1,6 +1,9 @@
/* global WebSocket */
import 'websocket-polyfill' import 'websocket-polyfill'
import {verifySignature} from './event' import {verifySignature} from './event'
import {matchFilters} from './filter'
export function normalizeRelayURL(url) { export function normalizeRelayURL(url) {
let [host, ...qs] = url.split('?') let [host, ...qs] = url.split('?')
@@ -10,10 +13,10 @@ export function normalizeRelayURL(url) {
return [host, ...qs].join('?') return [host, ...qs].join('?')
} }
export function relayConnect(url, onNotice) { export function relayConnect(url, onNotice = () => {}, onError = () => {}) {
url = normalizeRelayURL(url) url = normalizeRelayURL(url)
var ws, resolveOpen, untilOpen var ws, resolveOpen, untilOpen, wasClosed
var openSubs = {} var openSubs = {}
let attemptNumber = 1 let attemptNumber = 1
let nextAttemptSeconds = 1 let nextAttemptSeconds = 1
@@ -34,19 +37,26 @@ export function relayConnect(url, onNotice) {
resolveOpen() resolveOpen()
// restablish old subscriptions // restablish old subscriptions
for (let channel in openSubs) { if (wasClosed) {
let filters = openSubs[channel] wasClosed = false
let cb = channels[channel] for (let channel in openSubs) {
sub({cb, filter: filters}, channel) let filters = openSubs[channel]
let cb = channels[channel]
sub({cb, filter: filters}, channel)
}
} }
} }
ws.onerror = () => { ws.onerror = (err) => {
console.log('error connecting to relay', url) console.log('error connecting to relay', url)
onError(err)
} }
ws.onclose = () => { ws.onclose = () => {
resetOpenState() resetOpenState()
attemptNumber++ attemptNumber++
nextAttemptSeconds += attemptNumber nextAttemptSeconds += attemptNumber ** 3
if (nextAttemptSeconds > 14400) {
nextAttemptSeconds = 14400 // 4 hours
}
console.log( console.log(
`relay ${url} connection closed. reconnecting in ${nextAttemptSeconds} seconds.` `relay ${url} connection closed. reconnecting in ${nextAttemptSeconds} seconds.`
) )
@@ -55,6 +65,8 @@ export function relayConnect(url, onNotice) {
connect() connect()
} catch (err) {} } catch (err) {}
}, nextAttemptSeconds * 1000) }, nextAttemptSeconds * 1000)
wasClosed = true
} }
ws.onmessage = async e => { ws.onmessage = async e => {
@@ -80,12 +92,12 @@ export function relayConnect(url, onNotice) {
let channel = data[1] let channel = data[1]
let event = data[2] let event = data[2]
if (await verifySignature(event)) { if (
if (channels[channel]) { (await verifySignature(event)) &&
channels[channel](event) channels[channel] &&
} matchFilters(openSubs[channel], event)
} else { ) {
console.warn('got event with invalid signature from ' + url, event) channels[channel](event)
} }
return return
} }
@@ -135,19 +147,26 @@ export function relayConnect(url, onNotice) {
return { return {
url, url,
sub, sub,
async publish(event, statusCallback = status => {}) { async publish(event, statusCallback) {
try { try {
await trySend(['EVENT', event]) await trySend(['EVENT', event])
statusCallback(0) if (statusCallback) {
let {unsub} = relay.sub({ statusCallback(0)
cb: () => { let {unsub} = sub(
statusCallback(1) {
}, cb: () => {
filter: {id: event.id} statusCallback(1)
}) unsub()
setTimeout(unsub, 5000) clearTimeout(willUnsub)
},
filter: {id: event.id}
},
`monitor-${event.id.slice(0, 5)}`
)
let willUnsub = setTimeout(unsub, 5000)
}
} catch (err) { } catch (err) {
statusCallback(-1) if (statusCallback) statusCallback(-1)
} }
}, },
close() { close() {

View File

@@ -1,16 +0,0 @@
import pkg from './package.json'
export default {
input: 'src/index.js',
output: [
{
name: 'nostrtools',
file: pkg.browser,
format: 'umd'
},
{
file: pkg.module,
format: 'es'
}
]
}

View File

@@ -1,43 +0,0 @@
import Buffer from 'buffer'
import * as secp256k1 from '@noble/secp256k1'
import {sha256} from './utils'
export function getBlankEvent() {
return {
kind: 255,
pubkey: null,
content: '',
tags: [],
created_at: 0
}
}
export function serializeEvent(evt) {
return JSON.stringify([
0,
evt.pubkey,
evt.created_at,
evt.kind,
evt.tags || [],
evt.content
])
}
export async function getEventHash(event) {
let eventHash = await sha256(Buffer.from(serializeEvent(event)))
return Buffer.from(eventHash).toString('hex')
}
export async function verifySignature(event) {
return await secp256k1.schnorr.verify(
event.sig,
await getEventHash(event),
event.pubkey
)
}
export async function signEvent(event, key) {
let eventHash = await getEventHash(event)
return await secp256k1.schnorr.sign(eventHash, key)
}

View File

@@ -1,6 +0,0 @@
import * as secp256k1 from '@noble/secp256k1'
export const makeRandom32 = () => secp256k1.utils.randomPrivateKey()
export const sha256 = m => secp256k1.utils.sha256(Uint8Array.from(m))
export const getPublicKey = privateKey =>
secp256k1.schnorr.getPublicKey(privateKey)