Compare commits

...

13 Commits

Author SHA1 Message Date
fiatjaf
b271d6c06b fix .kind filter validator. 2022-01-01 10:26:55 -03:00
fiatjaf
76624a0f23 validateEvent() function. 2022-01-01 10:04:36 -03:00
fiatjaf
1f1a6380f0 fix getPublicKey to return the bip340 key. 2022-01-01 10:03:36 -03:00
fiatjaf
a46568d55c fix argument to micro-bip32 2021-12-31 23:09:43 -03:00
fiatjaf
ff4e63ecdf fix param order for verifySignature. 2021-12-31 22:53:27 -03:00
fiatjaf
01dd5b7a3c bring back @noble/secp256k1 along with micro-bip32. 2021-12-31 22:47:45 -03:00
fiatjaf
16536340e5 small fix on pool.removeRelay() 2021-12-31 22:25:33 -03:00
fiatjaf
1037eee335 trim relay url on normalize. 2021-12-31 22:03:02 -03:00
fiatjaf
5ce1b4c9f7 only initiate subscriptions for new relays added with read:true 2021-12-31 20:50:02 -03:00
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
9 changed files with 147 additions and 97 deletions

View File

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

View File

@@ -1,6 +1,6 @@
import {Buffer} from 'buffer' import {Buffer} from 'buffer'
import createHash from 'create-hash' import createHash from 'create-hash'
import {signSchnorr, verifySchnorr} from 'tiny-secp256k1' import * as secp256k1 from '@noble/secp256k1'
export function getBlankEvent() { export function getBlankEvent() {
return { return {
@@ -18,7 +18,7 @@ export function serializeEvent(evt) {
evt.pubkey, evt.pubkey,
evt.created_at, evt.created_at,
evt.kind, evt.kind,
evt.tags || [], evt.tags,
evt.content evt.content
]) ])
} }
@@ -30,17 +30,27 @@ export function getEventHash(event) {
return Buffer.from(eventHash).toString('hex') return Buffer.from(eventHash).toString('hex')
} }
export function verifySignature(event) { export function validateEvent(event) {
if (event.id !== getEventHash(event)) return false if (event.id !== getEventHash(event)) return false
return verifySchnorr( if (typeof event.content !== 'string') return false
Buffer.from(event.id, 'hex'), if (typeof event.created_at !== 'number') return false
Buffer.from(event.pubkey, 'hex')
Buffer.from(event.sig, 'hex'), if (!Array.isArray(event.tags)) return false
) for (let i = 0; i < event.tags.length; i++) {
let tag = event.tags[i]
if (!Array.isArray(tag)) return false
for (let j = 0; j < tag.length; j++) {
if (typeof tag[j] === 'object') return false
}
} }
export function signEvent(event, key) { return true
let eventHash = Buffer.from(getEventHash(event), 'hex') }
let key = Buffer.from(key, 'hex')
return Buffer.from(signSchnorr(eventHash, key)).toString('hex') export function verifySignature(event) {
return secp256k1.schnorr.verify(event.sig, event.id, event.pubkey)
}
export async function signEvent(event, key) {
return secp256k1.schnorr.sign(getEventHash(event), key)
} }

View File

@@ -1,7 +1,6 @@
export function matchFilter(filter, event) { export function matchFilter(filter, event) {
if (filter.id && event.id !== filter.id) return false if (filter.id && event.id !== filter.id) return false
if (filter.kind && event.kind !== filter.kind) return false if (typeof filter.kind === 'number' && event.kind !== filter.kind) return false
if (filter.author && event.pubkey !== filter.author) return false
if (filter.authors && filter.authors.indexOf(event.pubkey) === -1) if (filter.authors && filter.authors.indexOf(event.pubkey) === -1)
return false return false
if ( if (

View File

@@ -4,6 +4,7 @@ import {relayPool} from './pool'
import { import {
getBlankEvent, getBlankEvent,
signEvent, signEvent,
validateEvent,
verifySignature, verifySignature,
serializeEvent, serializeEvent,
getEventHash getEventHash
@@ -11,9 +12,11 @@ import {
import {matchFilter, matchFilters} from './filter' import {matchFilter, matchFilters} from './filter'
export { export {
generatePrivateKey,
relayConnect, relayConnect,
relayPool, relayPool,
signEvent, signEvent,
validateEvent,
verifySignature, verifySignature,
serializeEvent, serializeEvent,
getEventHash, getEventHash,

16
keys.js
View File

@@ -1,19 +1,9 @@
import randomBytes from 'randombytes' import * as secp256k1 from '@noble/secp256k1'
import {isPrivate, pointFromScalar} from 'tiny-secp256k1'
export function generatePrivateKey() { export function generatePrivateKey() {
let i = 8 return Buffer.from(secp256k1.utils.randomPrivateKey()).toString('hex')
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) { export function getPublicKey(privateKey) {
return Buffer.from( return secp256k1.schnorr.getPublicKey(privateKey)
pointFromScalar(Buffer.from(privateKey, 'hex'), true)
).toString('hex')
} }

View File

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

View File

@@ -1,6 +1,6 @@
{ {
"name": "nostr-tools", "name": "nostr-tools",
"version": "0.12.1", "version": "0.15.1",
"description": "Tools for making a Nostr client.", "description": "Tools for making a Nostr client.",
"repository": { "repository": {
"type": "git", "type": "git",
@@ -8,15 +8,13 @@
}, },
"dependencies": { "dependencies": {
"@noble/secp256k1": "^1.3.0", "@noble/secp256k1": "^1.3.0",
"bip32": "^3.0.1",
"browserify-cipher": ">=1", "browserify-cipher": ">=1",
"buffer": ">=5", "buffer": ">=5",
"create-hash": "^1.2.0", "create-hash": "^1.2.0",
"create-hmac": ">=1",
"dns-packet": "^5.2.4", "dns-packet": "^5.2.4",
"micro-bip32": "^0.1.0",
"micro-bip39": "^0.1.3", "micro-bip39": "^0.1.3",
"randombytes": ">=2", "randombytes": ">=2",
"tiny-secp256k1": "^2.1.2",
"websocket-polyfill": "^0.0.3" "websocket-polyfill": "^0.0.3"
}, },
"keywords": [ "keywords": [
@@ -30,5 +28,9 @@
"censorship", "censorship",
"censorship-resistance", "censorship-resistance",
"client" "client"
] ],
"devDependencies": {
"eslint": "^8.5.0",
"eslint-plugin-babel": "^5.3.1"
}
} }

81
pool.js
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) {
@@ -28,29 +33,34 @@ export function relayPool(globalPrivateKey) {
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())
delete activeSubscriptions[id]
}
const sub = ({cb = activeCallback, filter = activeFilters}) => {
Object.entries(subControllers).map(([relayURL, sub]) => [ Object.entries(subControllers).map(([relayURL, sub]) => [
relayURL, relayURL,
sub.sub({cb, filter}, id) sub.sub({cb, filter}, id)
]) ])
return activeSubscriptions[id] return activeSubscriptions[id]
}, }
addRelay: relay => { const addRelay = relay => {
subControllers[relay.url] = relay.sub({cb, filter}, id) subControllers[relay.url] = relay.sub({cb, filter}, id)
return activeSubscriptions[id] return activeSubscriptions[id]
}, }
removeRelay: relayURL => { const removeRelay = relayURL => {
if (relayURL in subControllers) { if (relayURL in subControllers) {
subControllers[relayURL].unsub() subControllers[relayURL].unsub()
if (Object.keys(subControllers).length === 0) unsub() if (Object.keys(subControllers).length === 0) unsub()
} }
return activeSubscriptions[id] return activeSubscriptions[id]
},
unsub: () => {
Object.values(subControllers).forEach(sub => sub.unsub())
delete activeSubscriptions[id]
} }
activeSubscriptions[id] = {
sub,
unsub,
addRelay,
removeRelay
} }
return activeSubscriptions[id] return activeSubscriptions[id]
@@ -62,25 +72,32 @@ 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}
if (policy.read) {
Object.values(activeSubscriptions).forEach(subscription => Object.values(activeSubscriptions).forEach(subscription =>
subscription.addRelay(relay) subscription.addRelay(relay)
) )
}
return relay return relay
}, },
removeRelay(url) { removeRelay(url) {
let relayURL = normalizeRelayURL(url) let relayURL = normalizeRelayURL(url)
let {relay} = relays[relayURL] let data = relays[relayURL]
if (!relay) return if (!data) return
let {relay} = data
Object.values(activeSubscriptions).forEach(subscription => Object.values(activeSubscriptions).forEach(subscription =>
subscription.removeRelay(relay) subscription.removeRelay(relay)
) )
@@ -95,7 +112,7 @@ 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 = await getEventHash(event) event.id = getEventHash(event)
if (!event.sig) { if (!event.sig) {
event.tags = event.tags || [] event.tags = event.tags || []
@@ -109,18 +126,40 @@ 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
let maxTargets = poolPolicy.randomChoice
? poolPolicy.randomChoice
: writeable.length
let successes = 0
for (let i = 0; i < writeable.length; i++) {
let {relay} = writeable[i]
try { try {
await relay.publish(event, status => await new Promise(async (resolve, reject) => {
try {
await relay.publish(event, status => {
statusCallback(status, relay.url) statusCallback(status, relay.url)
) resolve()
})
} catch (err) { } catch (err) {
statusCallback(-1, relay.url) statusCallback(-1, relay.url)
} }
}) })
successes++
if (successes >= maxTargets) {
break
}
} catch (err) {
/***/
}
}
return event return event
} }
} }

View File

@@ -1,17 +1,19 @@
/* global WebSocket */
import 'websocket-polyfill' import 'websocket-polyfill'
import {verifySignature} from './event' import {verifySignature, validateEvent} from './event'
import {matchFilters} from './filter' import {matchFilters} from './filter'
export function normalizeRelayURL(url) { export function normalizeRelayURL(url) {
let [host, ...qs] = url.split('?') let [host, ...qs] = url.trim().split('?')
if (host.slice(0, 4) === 'http') host = 'ws' + host.slice(4) if (host.slice(0, 4) === 'http') host = 'ws' + host.slice(4)
if (host.slice(0, 2) !== 'ws') host = 'wss://' + host if (host.slice(0, 2) !== 'ws') host = 'wss://' + host
if (host.length && host[host.length - 1] === '/') host = host.slice(0, -1) if (host.length && host[host.length - 1] === '/') host = host.slice(0, -1)
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, wasClosed 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) console.log('error connecting to relay', url)
onError(err)
} }
ws.onclose = () => { ws.onclose = () => {
resetOpenState() resetOpenState()
@@ -90,7 +93,8 @@ export function relayConnect(url, onNotice) {
let event = data[2] let event = data[2]
if ( if (
(await verifySignature(event)) && validateEvent(event) &&
verifySignature(event) &&
channels[channel] && channels[channel] &&
matchFilters(openSubs[channel], event) matchFilters(openSubs[channel], event)
) { ) {
@@ -144,22 +148,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])
if (statusCallback) {
statusCallback(0) statusCallback(0)
let {unsub} = relay.sub( let {unsub} = sub(
{ {
cb: () => { cb: () => {
statusCallback(1) statusCallback(1)
unsub()
clearTimeout(willUnsub)
}, },
filter: {id: event.id} filter: {id: event.id}
}, },
`monitor-${event.id.slice(0, 5)}` `monitor-${event.id.slice(0, 5)}`
) )
setTimeout(unsub, 5000) let willUnsub = setTimeout(unsub, 5000)
}
} catch (err) { } catch (err) {
statusCallback(-1) if (statusCallback) statusCallback(-1)
} }
}, },
close() { close() {