mirror of
https://github.com/nbd-wtf/nostr-tools.git
synced 2025-12-08 16:28:49 +00:00
Compare commits
93 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
cc8e34163d | ||
|
|
9082953ede | ||
|
|
61f397463d | ||
|
|
312b6fd035 | ||
|
|
7f1bd4f4a8 | ||
|
|
26089ef958 | ||
|
|
2e305b7cd4 | ||
|
|
51c1a54ddf | ||
|
|
cb05ee188f | ||
|
|
fa9e169c46 | ||
|
|
bb1e3f2fa6 | ||
|
|
160987472f | ||
|
|
8b18341ebb | ||
|
|
901445dea1 | ||
|
|
91b67cd0d5 | ||
|
|
1e696e0f3b | ||
|
|
4b36848b2d | ||
|
|
3cb351a5f4 | ||
|
|
5db1934fa4 | ||
|
|
50c3f24b25 | ||
|
|
39ea47660d | ||
|
|
8071e2f4fa | ||
|
|
cc2250da1f | ||
|
|
c37d10bb9d | ||
|
|
97e28fdf9a | ||
|
|
87c0f0d061 | ||
|
|
83c397b839 | ||
|
|
cd7d1cec48 | ||
|
|
613a843838 | ||
|
|
74a0d5454a | ||
|
|
c0d1e41424 | ||
|
|
f7e510e1c8 | ||
|
|
c08bdac7a7 | ||
|
|
c5b64404f6 | ||
|
|
c7b26fdba2 | ||
|
|
ac698ef67d | ||
|
|
8262a81cb2 | ||
|
|
26e6da6ba3 | ||
|
|
8aa31bb437 | ||
|
|
4bd4469357 | ||
|
|
89ae21f796 | ||
|
|
41a1614d89 | ||
|
|
0500415a4e | ||
|
|
cee4357cab | ||
|
|
d5cf5930d1 | ||
|
|
a78e2036aa | ||
|
|
adc1854ac6 | ||
|
|
83148e8bdf | ||
|
|
364c37cac5 | ||
|
|
385cdb4ac6 | ||
|
|
3f1025f551 | ||
|
|
482c5affd4 | ||
|
|
679ac0c133 | ||
|
|
b96159ad36 | ||
|
|
6dede4a688 | ||
|
|
50c8bb72f9 | ||
|
|
72781e0eab | ||
|
|
bf120c1348 | ||
|
|
3630d377e5 | ||
|
|
53b0091bf4 | ||
|
|
1a7cc5f21f | ||
|
|
1162935f58 | ||
|
|
a49d971f6a | ||
|
|
897919be3b | ||
|
|
39aca167fb | ||
|
|
de8bdd8370 | ||
|
|
46a0a342db | ||
|
|
4fe2a9c91a | ||
|
|
e62b833464 | ||
|
|
100c77d2aa | ||
|
|
12be5a5338 | ||
|
|
b955ba2a09 | ||
|
|
ec805be4ab | ||
|
|
92fb339afb | ||
|
|
f8f125270a | ||
|
|
1b798b2eee | ||
|
|
ae717a1a4a | ||
|
|
b2015c8fe5 | ||
|
|
c5d2e3b037 | ||
|
|
0ef5d1e19c | ||
|
|
7d9d10fdb1 | ||
|
|
a1e1ce131a | ||
|
|
cdb07bb175 | ||
|
|
1f1bcff803 | ||
|
|
896af30619 | ||
|
|
a8542c4b56 | ||
|
|
9f9e822c6d | ||
|
|
821a8f7895 | ||
|
|
2f7e3f8473 | ||
|
|
536dbcbffe | ||
|
|
ed52d2a8d4 | ||
|
|
faf8e62120 | ||
|
|
dc489bf387 |
@@ -1,5 +1,9 @@
|
|||||||
{
|
{
|
||||||
"root": true,
|
"root": true,
|
||||||
|
|
||||||
|
"parser": "@typescript-eslint/parser",
|
||||||
|
"plugins": ["@typescript-eslint"],
|
||||||
|
|
||||||
"parserOptions": {
|
"parserOptions": {
|
||||||
"ecmaVersion": 9,
|
"ecmaVersion": 9,
|
||||||
"ecmaFeatures": {
|
"ecmaFeatures": {
|
||||||
@@ -14,14 +18,13 @@
|
|||||||
"node": true
|
"node": true
|
||||||
},
|
},
|
||||||
|
|
||||||
"plugins": [
|
"plugins": ["babel"],
|
||||||
"babel"
|
|
||||||
],
|
|
||||||
|
|
||||||
"globals": {
|
"globals": {
|
||||||
"document": false,
|
"document": false,
|
||||||
"navigator": false,
|
"navigator": false,
|
||||||
"window": false,
|
"window": false,
|
||||||
|
"crypto": false,
|
||||||
"location": false,
|
"location": false,
|
||||||
"URL": false,
|
"URL": false,
|
||||||
"URLSearchParams": false,
|
"URLSearchParams": false,
|
||||||
@@ -33,23 +36,23 @@
|
|||||||
|
|
||||||
"rules": {
|
"rules": {
|
||||||
"accessor-pairs": 2,
|
"accessor-pairs": 2,
|
||||||
"arrow-spacing": [2, { "before": true, "after": true }],
|
"arrow-spacing": [2, {"before": true, "after": true}],
|
||||||
"block-spacing": [2, "always"],
|
"block-spacing": [2, "always"],
|
||||||
"brace-style": [2, "1tbs", { "allowSingleLine": true }],
|
"brace-style": [2, "1tbs", {"allowSingleLine": true}],
|
||||||
"comma-dangle": 0,
|
"comma-dangle": 0,
|
||||||
"comma-spacing": [2, { "before": false, "after": true }],
|
"comma-spacing": [2, {"before": false, "after": true}],
|
||||||
"comma-style": [2, "last"],
|
"comma-style": [2, "last"],
|
||||||
"constructor-super": 2,
|
"constructor-super": 2,
|
||||||
"curly": [0, "multi-line"],
|
"curly": [0, "multi-line"],
|
||||||
"dot-location": [2, "property"],
|
"dot-location": [2, "property"],
|
||||||
"eol-last": 2,
|
"eol-last": 2,
|
||||||
"eqeqeq": [2, "allow-null"],
|
"eqeqeq": [2, "allow-null"],
|
||||||
"generator-star-spacing": [2, { "before": true, "after": true }],
|
"generator-star-spacing": [2, {"before": true, "after": true}],
|
||||||
"handle-callback-err": [2, "^(err|error)$" ],
|
"handle-callback-err": [2, "^(err|error)$"],
|
||||||
"indent": 0,
|
"indent": 0,
|
||||||
"jsx-quotes": [2, "prefer-double"],
|
"jsx-quotes": [2, "prefer-double"],
|
||||||
"key-spacing": [2, { "beforeColon": false, "afterColon": true }],
|
"key-spacing": [2, {"beforeColon": false, "afterColon": true}],
|
||||||
"keyword-spacing": [2, { "before": true, "after": true }],
|
"keyword-spacing": [2, {"before": true, "after": true}],
|
||||||
"new-cap": 0,
|
"new-cap": 0,
|
||||||
"new-parens": 0,
|
"new-parens": 0,
|
||||||
"no-array-constructor": 2,
|
"no-array-constructor": 2,
|
||||||
@@ -81,12 +84,12 @@
|
|||||||
"no-irregular-whitespace": 2,
|
"no-irregular-whitespace": 2,
|
||||||
"no-iterator": 2,
|
"no-iterator": 2,
|
||||||
"no-label-var": 2,
|
"no-label-var": 2,
|
||||||
"no-labels": [2, { "allowLoop": false, "allowSwitch": false }],
|
"no-labels": [2, {"allowLoop": false, "allowSwitch": false}],
|
||||||
"no-lone-blocks": 2,
|
"no-lone-blocks": 2,
|
||||||
"no-mixed-spaces-and-tabs": 2,
|
"no-mixed-spaces-and-tabs": 2,
|
||||||
"no-multi-spaces": 2,
|
"no-multi-spaces": 2,
|
||||||
"no-multi-str": 2,
|
"no-multi-str": 2,
|
||||||
"no-multiple-empty-lines": [2, { "max": 2 }],
|
"no-multiple-empty-lines": [2, {"max": 2}],
|
||||||
"no-native-reassign": 2,
|
"no-native-reassign": 2,
|
||||||
"no-negated-in-lhs": 2,
|
"no-negated-in-lhs": 2,
|
||||||
"no-new": 0,
|
"no-new": 0,
|
||||||
@@ -115,23 +118,34 @@
|
|||||||
"no-undef": 2,
|
"no-undef": 2,
|
||||||
"no-undef-init": 2,
|
"no-undef-init": 2,
|
||||||
"no-unexpected-multiline": 2,
|
"no-unexpected-multiline": 2,
|
||||||
"no-unneeded-ternary": [2, { "defaultAssignment": false }],
|
"no-unneeded-ternary": [2, {"defaultAssignment": false}],
|
||||||
"no-unreachable": 2,
|
"no-unreachable": 2,
|
||||||
"no-unused-vars": [2, { "vars": "local", "args": "none", "varsIgnorePattern": "^_"}],
|
"no-unused-vars": [
|
||||||
|
2,
|
||||||
|
{"vars": "local", "args": "none", "varsIgnorePattern": "^_"}
|
||||||
|
],
|
||||||
"no-useless-call": 2,
|
"no-useless-call": 2,
|
||||||
"no-useless-constructor": 2,
|
"no-useless-constructor": 2,
|
||||||
"no-with": 2,
|
"no-with": 2,
|
||||||
"one-var": [0, { "initialized": "never" }],
|
"one-var": [0, {"initialized": "never"}],
|
||||||
"operator-linebreak": [2, "after", { "overrides": { "?": "before", ":": "before" } }],
|
"operator-linebreak": [
|
||||||
|
2,
|
||||||
|
"after",
|
||||||
|
{"overrides": {"?": "before", ":": "before"}}
|
||||||
|
],
|
||||||
"padded-blocks": [2, "never"],
|
"padded-blocks": [2, "never"],
|
||||||
"quotes": [2, "single", { "avoidEscape": true, "allowTemplateLiterals": true }],
|
"quotes": [
|
||||||
|
2,
|
||||||
|
"single",
|
||||||
|
{"avoidEscape": true, "allowTemplateLiterals": true}
|
||||||
|
],
|
||||||
"semi": [2, "never"],
|
"semi": [2, "never"],
|
||||||
"semi-spacing": [2, { "before": false, "after": true }],
|
"semi-spacing": [2, {"before": false, "after": true}],
|
||||||
"space-before-blocks": [2, "always"],
|
"space-before-blocks": [2, "always"],
|
||||||
"space-before-function-paren": 0,
|
"space-before-function-paren": 0,
|
||||||
"space-in-parens": [2, "never"],
|
"space-in-parens": [2, "never"],
|
||||||
"space-infix-ops": 2,
|
"space-infix-ops": 2,
|
||||||
"space-unary-ops": [2, { "words": true, "nonwords": false }],
|
"space-unary-ops": [2, {"words": true, "nonwords": false}],
|
||||||
"spaced-comment": 0,
|
"spaced-comment": 0,
|
||||||
"template-curly-spacing": [2, "never"],
|
"template-curly-spacing": [2, "never"],
|
||||||
"use-isnan": 2,
|
"use-isnan": 2,
|
||||||
|
|||||||
21
.github/workflows/npm-publish.yml
vendored
Normal file
21
.github/workflows/npm-publish.yml
vendored
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
name: publish npm package
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
tags: [v*]
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
publish-npm:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v3
|
||||||
|
- uses: actions/setup-node@v3
|
||||||
|
with:
|
||||||
|
node-version: 18
|
||||||
|
- run: yarn --ignore-engines
|
||||||
|
- run: node build.js
|
||||||
|
- run: yarn test
|
||||||
|
- uses: JS-DevTools/npm-publish@v1
|
||||||
|
with:
|
||||||
|
token: ${{ secrets.NPM_TOKEN }}
|
||||||
|
greater-version-only: true
|
||||||
16
.github/workflows/test.yml
vendored
Normal file
16
.github/workflows/test.yml
vendored
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
name: test every commit
|
||||||
|
on:
|
||||||
|
- push
|
||||||
|
- pull_request
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
test:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v2
|
||||||
|
- uses: actions/setup-node@v3
|
||||||
|
with:
|
||||||
|
node-version: 18
|
||||||
|
- run: yarn --ignore-engines
|
||||||
|
- run: node build.js
|
||||||
|
- run: yarn test
|
||||||
3
.gitignore
vendored
3
.gitignore
vendored
@@ -2,3 +2,6 @@ node_modules
|
|||||||
dist
|
dist
|
||||||
yarn.lock
|
yarn.lock
|
||||||
package-lock.json
|
package-lock.json
|
||||||
|
.envrc
|
||||||
|
lib
|
||||||
|
test.html
|
||||||
|
|||||||
319
README.md
319
README.md
@@ -2,71 +2,268 @@
|
|||||||
|
|
||||||
Tools for developing [Nostr](https://github.com/fiatjaf/nostr) clients.
|
Tools for developing [Nostr](https://github.com/fiatjaf/nostr) clients.
|
||||||
|
|
||||||
|
Only depends on _@scure_ and _@noble_ packages.
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
|
### Generating a private key and a public key
|
||||||
|
|
||||||
```js
|
```js
|
||||||
import {relayPool} from 'nostr-tools'
|
import {generatePrivateKey, getPublicKey} from 'nostr-tools'
|
||||||
|
|
||||||
const pool = relayPool()
|
let sk = generatePrivateKey() // `sk` is a hex string
|
||||||
|
let pk = getPublicKey(sk) // `pk` is a hex string
|
||||||
pool.setPrivateKey('<hex>') // optional
|
|
||||||
|
|
||||||
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) {
|
|
||||||
console.log(`got an event from ${relay.url} which is already validated.`, event)
|
|
||||||
}
|
|
||||||
|
|
||||||
// subscribing to a single user
|
|
||||||
// author is the user's public key
|
|
||||||
pool.sub({cb: onEvent, filter: {author: '<hex>'}})
|
|
||||||
|
|
||||||
// or bulk follow
|
|
||||||
pool.sub({cb:(event, relay) => {...}, filter: {authors: ['<hex1>', '<hex2>', ..., '<hexn>']}})
|
|
||||||
|
|
||||||
// reuse a subscription channel
|
|
||||||
const mySubscription = pool.sub({cb: ..., filter: ....})
|
|
||||||
mySubscription.sub({filter: ....})
|
|
||||||
mySubscription.sub({cb: ...})
|
|
||||||
mySubscription.unsub()
|
|
||||||
|
|
||||||
// get specific event
|
|
||||||
const specificChannel = pool.sub({
|
|
||||||
cb: (event, relay) => {
|
|
||||||
console.log('got specific event from relay', event, relay)
|
|
||||||
specificChannel.unsub()
|
|
||||||
},
|
|
||||||
filter: {id: '<hex>'}
|
|
||||||
})
|
|
||||||
|
|
||||||
// or get a specific event plus all the events that reference it in the 'e' tag
|
|
||||||
pool.sub({ cb: (event, relay) => { ... }, filter: [{id: '<hex>'}, {'#e': '<hex>'}] })
|
|
||||||
|
|
||||||
// get all events
|
|
||||||
pool.sub({cb: (event, relay) => {...}, filter: {}})
|
|
||||||
|
|
||||||
// get recent events
|
|
||||||
pool.sub({cb: (event, relay) => {...}, filter: {since: timestamp}})
|
|
||||||
|
|
||||||
// publishing events(inside an async function):
|
|
||||||
const ev = await pool.publish(eventObject, (status, url) => {
|
|
||||||
if (status === 0) {
|
|
||||||
console.log(`publish request sent to ${url}`)
|
|
||||||
}
|
|
||||||
if (status === 1) {
|
|
||||||
console.log(`event published by ${url}`, ev)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
// it will be signed automatically with the key supplied above
|
|
||||||
// or pass an already signed event to bypass this
|
|
||||||
|
|
||||||
// subscribing to a new relay
|
|
||||||
pool.addRelay('<url>')
|
|
||||||
// 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.
|
### Creating, signing and verifying events
|
||||||
|
|
||||||
For other utils please read the source (for now).
|
```js
|
||||||
|
import {
|
||||||
|
validateEvent,
|
||||||
|
verifySignature,
|
||||||
|
signEvent,
|
||||||
|
getEventHash,
|
||||||
|
getPublicKey
|
||||||
|
} from 'nostr-tools'
|
||||||
|
|
||||||
|
let event = {
|
||||||
|
kind: 1,
|
||||||
|
created_at: Math.floor(Date.now() / 1000),
|
||||||
|
tags: [],
|
||||||
|
content: 'hello',
|
||||||
|
pubkey: getPublicKey(privateKey)
|
||||||
|
}
|
||||||
|
|
||||||
|
event.id = getEventHash(event)
|
||||||
|
event.sig = signEvent(event, privateKey)
|
||||||
|
|
||||||
|
let ok = validateEvent(event)
|
||||||
|
let veryOk = verifySignature(event)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Interacting with a relay
|
||||||
|
|
||||||
|
```js
|
||||||
|
import {
|
||||||
|
relayInit,
|
||||||
|
generatePrivateKey,
|
||||||
|
getPublicKey,
|
||||||
|
getEventHash,
|
||||||
|
signEvent
|
||||||
|
} from 'nostr-tools'
|
||||||
|
|
||||||
|
const relay = relayInit('wss://relay.example.com')
|
||||||
|
await relay.connect()
|
||||||
|
|
||||||
|
relay.on('connect', () => {
|
||||||
|
console.log(`connected to ${relay.url}`)
|
||||||
|
})
|
||||||
|
relay.on('error', () => {
|
||||||
|
console.log(`failed to connect to ${relay.url}`)
|
||||||
|
})
|
||||||
|
|
||||||
|
// let's query for an event that exists
|
||||||
|
let sub = relay.sub([
|
||||||
|
{
|
||||||
|
ids: ['d7dd5eb3ab747e16f8d0212d53032ea2a7cadef53837e5a6c66d42849fcb9027']
|
||||||
|
}
|
||||||
|
])
|
||||||
|
sub.on('event', event => {
|
||||||
|
console.log('we got the event we wanted:', event)
|
||||||
|
})
|
||||||
|
sub.on('eose', () => {
|
||||||
|
sub.unsub()
|
||||||
|
})
|
||||||
|
|
||||||
|
// let's publish a new event while simultaneously monitoring the relay for it
|
||||||
|
let sk = generatePrivateKey()
|
||||||
|
let pk = getPublicKey(sk)
|
||||||
|
|
||||||
|
let sub = relay.sub([
|
||||||
|
{
|
||||||
|
kinds: [1],
|
||||||
|
authors: [pk]
|
||||||
|
}
|
||||||
|
])
|
||||||
|
|
||||||
|
sub.on('event', event => {
|
||||||
|
console.log('got event:', event)
|
||||||
|
})
|
||||||
|
|
||||||
|
let event = {
|
||||||
|
kind: 1,
|
||||||
|
pubkey: pk,
|
||||||
|
created_at: Math.floor(Date.now() / 1000),
|
||||||
|
tags: [],
|
||||||
|
content: 'hello world'
|
||||||
|
}
|
||||||
|
event.id = getEventHash(event)
|
||||||
|
event.sig = signEvent(event, sk)
|
||||||
|
|
||||||
|
let pub = relay.publish(event)
|
||||||
|
pub.on('ok', () => {
|
||||||
|
console.log(`${relay.url} has accepted our event`)
|
||||||
|
})
|
||||||
|
pub.on('seen', () => {
|
||||||
|
console.log(`we saw the event on ${relay.url}`)
|
||||||
|
})
|
||||||
|
pub.on('failed', reason => {
|
||||||
|
console.log(`failed to publish to ${relay.url}: ${reason}`)
|
||||||
|
})
|
||||||
|
|
||||||
|
await relay.close()
|
||||||
|
```
|
||||||
|
|
||||||
|
To use this on Node.js you first must install `websocket-polyfill` and import it:
|
||||||
|
|
||||||
|
```js
|
||||||
|
import 'websocket-polyfill'
|
||||||
|
```
|
||||||
|
|
||||||
|
### Interacting with multiple relays
|
||||||
|
|
||||||
|
```js
|
||||||
|
import {pool} from 'nostr-tools'
|
||||||
|
|
||||||
|
const p = pool()
|
||||||
|
|
||||||
|
["wss://relay.example.com", "wss://relay.example2.com"].forEach(async url => {
|
||||||
|
let relay = pool.ensureRelay(url)
|
||||||
|
await relay.connect()
|
||||||
|
|
||||||
|
relay.sub(...) // same as above
|
||||||
|
relay.publish(...) // etc
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
### Querying profile data from a NIP-05 address
|
||||||
|
|
||||||
|
```js
|
||||||
|
import {nip05} from 'nostr-tools'
|
||||||
|
|
||||||
|
let profile = await nip05.queryProfile('jb55.com')
|
||||||
|
console.log(profile.pubkey)
|
||||||
|
// prints: 32e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245
|
||||||
|
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:
|
||||||
|
|
||||||
|
```js
|
||||||
|
nip05.useFetchImplementation(require('node-fetch'))
|
||||||
|
```
|
||||||
|
|
||||||
|
### Encoding and decoding NIP-19 codes
|
||||||
|
|
||||||
|
```js
|
||||||
|
import {nip19, generatePrivateKey, getPublicKey} from 'nostr-tools'
|
||||||
|
|
||||||
|
let sk = generatePrivateKey()
|
||||||
|
let nsec = nip19.nsecEncode(sk)
|
||||||
|
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)
|
||||||
|
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)
|
||||||
|
assert(type === 'nprofile')
|
||||||
|
assert(data.pubkey === pk)
|
||||||
|
assert(data.relays.length === 2)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Encrypting and decrypting direct messages
|
||||||
|
|
||||||
|
```js
|
||||||
|
import {nip04, getPublicKey, generatePrivateKey} from 'nostr-tools'
|
||||||
|
|
||||||
|
// sender
|
||||||
|
let sk1 = generatePrivateKey()
|
||||||
|
let pk1 = getPublicKey(sk1)
|
||||||
|
|
||||||
|
// receiver
|
||||||
|
let sk2 = generatePrivateKey()
|
||||||
|
let pk2 = getPublicKey(sk2)
|
||||||
|
|
||||||
|
// on the sender side
|
||||||
|
let message = 'hello'
|
||||||
|
let ciphertext = await nip04.encrypt(sk1, pk2, message)
|
||||||
|
|
||||||
|
let event = {
|
||||||
|
kind: 4,
|
||||||
|
pubkey: pk1,
|
||||||
|
tags: [['p', pk2]],
|
||||||
|
content: ciphertext,
|
||||||
|
...otherProperties
|
||||||
|
}
|
||||||
|
|
||||||
|
sendEvent(event)
|
||||||
|
|
||||||
|
// on the receiver side
|
||||||
|
sub.on('event', event => {
|
||||||
|
let sender = event.tags.find(([k, v]) => k === 'p' && v && v !== '')[1]
|
||||||
|
pk1 === sender
|
||||||
|
let plaintext = await nip04.decrypt(sk2, pk1, event.content)
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
### Performing and checking for delegation
|
||||||
|
|
||||||
|
```js
|
||||||
|
import {nip26, getPublicKey, generatePrivateKey} from 'nostr-tools'
|
||||||
|
|
||||||
|
// delegator
|
||||||
|
let sk1 = generatePrivateKey()
|
||||||
|
let pk1 = getPublicKey(sk1)
|
||||||
|
|
||||||
|
// delegatee
|
||||||
|
let sk2 = generatePrivateKey()
|
||||||
|
let pk2 = getPublicKey(sk2)
|
||||||
|
|
||||||
|
// generate delegation
|
||||||
|
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 */
|
||||||
|
})
|
||||||
|
|
||||||
|
// the delegatee uses the delegation when building an event
|
||||||
|
let event = {
|
||||||
|
pubkey: pk2,
|
||||||
|
kind: 1,
|
||||||
|
created_at: Math.round(Date.now() / 1000),
|
||||||
|
content: 'hello from a delegated key',
|
||||||
|
tags: [['delegation', delegation.from, delegation.cond, delegation.sig]]
|
||||||
|
}
|
||||||
|
|
||||||
|
// finally any receiver of this event can check for the presence of a valid delegation tag
|
||||||
|
let delegator = nip26.getDelegator(event)
|
||||||
|
assert(delegator === pk1) // will be null if there is no delegation tag or if it is invalid
|
||||||
|
```
|
||||||
|
|
||||||
|
Please consult the tests or [the source code](https://github.com/fiatjaf/nostr-tools) for more information that isn't available here.
|
||||||
|
|
||||||
|
### Using from the browser (if you don't want to use a bundler)
|
||||||
|
|
||||||
|
```html
|
||||||
|
<script src="https://unpkg.com/nostr-tools/lib/nostr.bundle.js"></script>
|
||||||
|
<script>
|
||||||
|
window.NostrTools.generatePrivateKey('...') // and so on
|
||||||
|
</script>
|
||||||
|
```
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
Public domain.
|
||||||
|
|||||||
41
build.js
Executable file
41
build.js
Executable file
@@ -0,0 +1,41 @@
|
|||||||
|
#!/usr/bin/env node
|
||||||
|
|
||||||
|
const esbuild = require('esbuild')
|
||||||
|
|
||||||
|
let common = {
|
||||||
|
entryPoints: ['index.ts'],
|
||||||
|
bundle: true,
|
||||||
|
sourcemap: 'external'
|
||||||
|
}
|
||||||
|
|
||||||
|
esbuild
|
||||||
|
.build({
|
||||||
|
...common,
|
||||||
|
outfile: 'lib/nostr.esm.js',
|
||||||
|
format: 'esm',
|
||||||
|
packages: 'external'
|
||||||
|
})
|
||||||
|
.then(() => console.log('esm build success.'))
|
||||||
|
|
||||||
|
esbuild
|
||||||
|
.build({
|
||||||
|
...common,
|
||||||
|
outfile: 'lib/nostr.cjs.js',
|
||||||
|
format: 'cjs',
|
||||||
|
packages: 'external'
|
||||||
|
})
|
||||||
|
.then(() => console.log('cjs build success.'))
|
||||||
|
|
||||||
|
esbuild
|
||||||
|
.build({
|
||||||
|
...common,
|
||||||
|
outfile: 'lib/nostr.bundle.js',
|
||||||
|
format: 'iife',
|
||||||
|
globalName: 'NostrTools',
|
||||||
|
define: {
|
||||||
|
window: 'self',
|
||||||
|
global: 'self',
|
||||||
|
process: '{"env": {}}'
|
||||||
|
}
|
||||||
|
})
|
||||||
|
.then(() => console.log('standalone build success.'))
|
||||||
58
event.js
58
event.js
@@ -1,58 +0,0 @@
|
|||||||
import {Buffer} from 'buffer'
|
|
||||||
import createHash from 'create-hash'
|
|
||||||
import * as secp256k1 from '@noble/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 validateEvent(event) {
|
|
||||||
if (event.id !== getEventHash(event)) return false
|
|
||||||
if (typeof event.content !== 'string') return false
|
|
||||||
if (typeof event.created_at !== 'number') return false
|
|
||||||
|
|
||||||
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
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
|
|
||||||
export function verifySignature(event) {
|
|
||||||
return secp256k1.schnorr.verify(event.sig, event.id, event.pubkey)
|
|
||||||
}
|
|
||||||
|
|
||||||
export async function signEvent(event, key) {
|
|
||||||
return Buffer.from(
|
|
||||||
await secp256k1.schnorr.sign(getEventHash(event), key)
|
|
||||||
).toString('hex')
|
|
||||||
}
|
|
||||||
48
event.test.js
Normal file
48
event.test.js
Normal file
@@ -0,0 +1,48 @@
|
|||||||
|
/* eslint-env jest */
|
||||||
|
|
||||||
|
const {
|
||||||
|
validateEvent,
|
||||||
|
verifySignature,
|
||||||
|
signEvent,
|
||||||
|
getPublicKey
|
||||||
|
} = require('./lib/nostr.cjs')
|
||||||
|
|
||||||
|
const event = {
|
||||||
|
id: 'd7dd5eb3ab747e16f8d0212d53032ea2a7cadef53837e5a6c66d42849fcb9027',
|
||||||
|
kind: 1,
|
||||||
|
pubkey: '22a12a128a3be27cd7fb250cbe796e692896398dc1440ae3fa567812c8107c1c',
|
||||||
|
created_at: 1670869179,
|
||||||
|
content:
|
||||||
|
'NOSTR "WINE-ACCOUNT" WITH HARVEST DATE STAMPED\n\n\n"The older the wine, the greater its reputation"\n\n\n22a12a128a3be27cd7fb250cbe796e692896398dc1440ae3fa567812c8107c1c\n\n\nNWA 2022-12-12\nAA',
|
||||||
|
tags: [['client', 'astral']],
|
||||||
|
sig: 'f110e4fdf67835fb07abc72469933c40bdc7334615610cade9554bf00945a1cebf84f8d079ec325d26fefd76fe51cb589bdbe208ac9cdbd63351ddad24a57559'
|
||||||
|
}
|
||||||
|
|
||||||
|
const unsigned = {
|
||||||
|
created_at: 1671217411,
|
||||||
|
kind: 0,
|
||||||
|
tags: [],
|
||||||
|
content:
|
||||||
|
'{"name":"fiatjaf","about":"buy my merch at fiatjaf store","picture":"https://fiatjaf.com/static/favicon.jpg","nip05":"_@fiatjaf.com"}'
|
||||||
|
}
|
||||||
|
|
||||||
|
const privateKey =
|
||||||
|
'5c6c25b7ef18d8633e97512159954e1aa22809c6b763e94b9f91071836d00217'
|
||||||
|
|
||||||
|
test('validate event', () => {
|
||||||
|
expect(validateEvent(event)).toBeTruthy()
|
||||||
|
})
|
||||||
|
|
||||||
|
test('check signature', async () => {
|
||||||
|
expect(verifySignature(event)).toBeTruthy()
|
||||||
|
})
|
||||||
|
|
||||||
|
test('sign event', async () => {
|
||||||
|
let pubkey = getPublicKey(privateKey)
|
||||||
|
let authored = {...unsigned, pubkey}
|
||||||
|
|
||||||
|
let sig = signEvent(authored, privateKey)
|
||||||
|
let signed = {...authored, sig}
|
||||||
|
|
||||||
|
expect(verifySignature(signed)).toBeTruthy()
|
||||||
|
})
|
||||||
91
event.ts
Normal file
91
event.ts
Normal file
@@ -0,0 +1,91 @@
|
|||||||
|
import * as secp256k1 from '@noble/secp256k1'
|
||||||
|
import {sha256} from '@noble/hashes/sha256'
|
||||||
|
|
||||||
|
import {utf8Encoder} from './utils'
|
||||||
|
|
||||||
|
/* eslint-disable no-unused-vars */
|
||||||
|
export enum Kind {
|
||||||
|
Metadata = 0,
|
||||||
|
Text = 1,
|
||||||
|
RecommendRelay = 2,
|
||||||
|
Contacts = 3,
|
||||||
|
EncryptedDirectMessage = 4,
|
||||||
|
EventDeletion = 5,
|
||||||
|
Reaction = 7,
|
||||||
|
ChannelCreation = 40,
|
||||||
|
ChannelMetadata = 41,
|
||||||
|
ChannelMessage = 42,
|
||||||
|
ChannelHideMessage = 43,
|
||||||
|
ChannelMuteUser = 44
|
||||||
|
}
|
||||||
|
|
||||||
|
export type Event = {
|
||||||
|
id?: string
|
||||||
|
sig?: string
|
||||||
|
kind: Kind
|
||||||
|
tags: string[][]
|
||||||
|
pubkey: string
|
||||||
|
content: string
|
||||||
|
created_at: number
|
||||||
|
}
|
||||||
|
|
||||||
|
export function getBlankEvent(): Event {
|
||||||
|
return {
|
||||||
|
kind: 255,
|
||||||
|
pubkey: '',
|
||||||
|
content: '',
|
||||||
|
tags: [],
|
||||||
|
created_at: 0
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export function serializeEvent(evt: Event): string {
|
||||||
|
if (!validateEvent(evt))
|
||||||
|
throw new Error("can't serialize event with wrong or missing properties")
|
||||||
|
|
||||||
|
return JSON.stringify([
|
||||||
|
0,
|
||||||
|
evt.pubkey,
|
||||||
|
evt.created_at,
|
||||||
|
evt.kind,
|
||||||
|
evt.tags,
|
||||||
|
evt.content
|
||||||
|
])
|
||||||
|
}
|
||||||
|
|
||||||
|
export function getEventHash(event: Event): string {
|
||||||
|
let eventHash = sha256(utf8Encoder.encode(serializeEvent(event)))
|
||||||
|
return secp256k1.utils.bytesToHex(eventHash)
|
||||||
|
}
|
||||||
|
|
||||||
|
export function validateEvent(event: Event): boolean {
|
||||||
|
if (typeof event.content !== 'string') return false
|
||||||
|
if (typeof event.created_at !== 'number') return false
|
||||||
|
if (typeof event.pubkey !== 'string') return false
|
||||||
|
if (!event.pubkey.match(/^[a-f0-9]{64}$/)) return false
|
||||||
|
|
||||||
|
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
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
export function verifySignature(event: Event & {sig: string}): boolean {
|
||||||
|
return secp256k1.schnorr.verifySync(
|
||||||
|
event.sig,
|
||||||
|
getEventHash(event),
|
||||||
|
event.pubkey
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
export function signEvent(event: Event, key: string): string {
|
||||||
|
return secp256k1.utils.bytesToHex(
|
||||||
|
secp256k1.schnorr.signSync(getEventHash(event), key)
|
||||||
|
)
|
||||||
|
}
|
||||||
35
fakejson.test.js
Normal file
35
fakejson.test.js
Normal file
@@ -0,0 +1,35 @@
|
|||||||
|
/* eslint-env jest */
|
||||||
|
|
||||||
|
const {fj} = require('./lib/nostr.cjs')
|
||||||
|
|
||||||
|
test('match id', () => {
|
||||||
|
expect(
|
||||||
|
fj.matchEventId(
|
||||||
|
`["EVENT","nostril-query",{"tags":[],"content":"so did we cut all corners and p2p stuff in order to make a decentralized social network that was fast and worked, but in the end what we got was a lot of very slow clients that can't handle the traffic of one jack dorsey tweet?","sig":"ca62629d189edebb8f0811cfa0ac53015013df5f305dcba3f411ba15cfc4074d8c2d517ee7d9e81c9eb72a7328bfbe31c9122156397565ac55e740404e2b1fe7","id":"fef2a50f7d9d3d5a5f38ee761bc087ec16198d3f0140df6d1e8193abf7c2b146","kind":1,"pubkey":"3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d","created_at":1671150419}]`,
|
||||||
|
'fef2a50f7d9d3d5a5f38ee761bc087ec16198d3f0140df6d1e8193abf7c2b146'
|
||||||
|
)
|
||||||
|
).toBeTruthy()
|
||||||
|
|
||||||
|
expect(
|
||||||
|
fj.matchEventId(
|
||||||
|
`["EVENT","nostril-query",{"content":"a bunch of mfs interacted with my post using what I assume were \"likes\": https://nostr.build/i/964.png","created_at":1672506879,"id":"f40bdd0905137ad60482537e260890ab50b0863bf16e67cf9383f203bd26c96f","kind":1,"pubkey":"3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d","sig":"8b825d2d4096f0643b18ca39da59ec07a682cd8a3e717f119c845037573d98099f5bea94ec7ddedd5600c8020144a255ed52882a911f7f7ada6d6abb3c0a1eb4","tags":[]}]`,
|
||||||
|
'fef2a50f7d9d3d5a5f38ee761bc087ec16198d3f0140df6d1e8193abf7c2b146'
|
||||||
|
)
|
||||||
|
).toBeFalsy()
|
||||||
|
})
|
||||||
|
|
||||||
|
test('match kind', () => {
|
||||||
|
expect(
|
||||||
|
fj.matchEventKind(
|
||||||
|
`["EVENT","nostril-query",{"tags":[],"content":"so did we cut all corners and p2p stuff in order to make a decentralized social network that was fast and worked, but in the end what we got was a lot of very slow clients that can't handle the traffic of one jack dorsey tweet?","sig":"ca62629d189edebb8f0811cfa0ac53015013df5f305dcba3f411ba15cfc4074d8c2d517ee7d9e81c9eb72a7328bfbe31c9122156397565ac55e740404e2b1fe7","id":"fef2a50f7d9d3d5a5f38ee761bc087ec16198d3f0140df6d1e8193abf7c2b146","kind":1,"pubkey":"3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d","created_at":1671150419}]`,
|
||||||
|
1
|
||||||
|
)
|
||||||
|
).toBeTruthy()
|
||||||
|
|
||||||
|
expect(
|
||||||
|
fj.matchEventKind(
|
||||||
|
`["EVENT","nostril-query",{"content":"{\"name\":\"fiatjaf\",\"about\":\"buy my merch at fiatjaf store\",\"picture\":\"https://fiatjaf.com/static/favicon.jpg\",\"nip05\":\"_@fiatjaf.com\"}","created_at":1671217411,"id":"b52f93f6dfecf9d81f59062827cd941412a0e8398dda60baf960b17499b88900","kind":12720,"pubkey":"3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d","sig":"fc1ea5d45fa5ed0526faed06e8fc7a558e60d1b213e9714f440828584ee999b93407092f9b04deea7e504fa034fc0428f31f7f0f95417b3280ebe6004b80b470","tags":[]}]`,
|
||||||
|
12720
|
||||||
|
)
|
||||||
|
).toBeTruthy()
|
||||||
|
})
|
||||||
26
fakejson.ts
Normal file
26
fakejson.ts
Normal file
@@ -0,0 +1,26 @@
|
|||||||
|
export function getHex64(json: string, field: string): string {
|
||||||
|
let len = field.length + 3
|
||||||
|
let idx = json.indexOf(`"${field}":`) + len
|
||||||
|
let s = json.slice(idx).indexOf(`"`) + idx + 1
|
||||||
|
return json.slice(s, s + 64)
|
||||||
|
}
|
||||||
|
|
||||||
|
export function getInt(json: string, field: string): number {
|
||||||
|
let len = field.length
|
||||||
|
let idx = json.indexOf(`"${field}":`) + len + 3
|
||||||
|
let sliced = json.slice(idx)
|
||||||
|
let end = Math.min(sliced.indexOf(','), sliced.indexOf('}'))
|
||||||
|
return parseInt(sliced.slice(0, end), 10)
|
||||||
|
}
|
||||||
|
|
||||||
|
export function matchEventId(json: string, id: string): boolean {
|
||||||
|
return id === getHex64(json, 'id')
|
||||||
|
}
|
||||||
|
|
||||||
|
export function matchEventPubkey(json: string, pubkey: string): boolean {
|
||||||
|
return pubkey === getHex64(json, 'pubkey')
|
||||||
|
}
|
||||||
|
|
||||||
|
export function matchEventKind(json: string, kind: number): boolean {
|
||||||
|
return kind === getInt(json, 'kind')
|
||||||
|
}
|
||||||
42
filter.test.js
Normal file
42
filter.test.js
Normal file
@@ -0,0 +1,42 @@
|
|||||||
|
/* eslint-env jest */
|
||||||
|
|
||||||
|
const {matchFilters} = require('./lib/nostr.cjs')
|
||||||
|
|
||||||
|
test('test if filters match', () => {
|
||||||
|
;[
|
||||||
|
{
|
||||||
|
filters: [{ids: ['i']}],
|
||||||
|
good: [{id: 'i'}],
|
||||||
|
bad: [{id: 'j'}]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
filters: [{authors: ['abc']}, {kinds: [1, 3]}],
|
||||||
|
good: [
|
||||||
|
{pubkey: 'xyz', kind: 3},
|
||||||
|
{pubkey: 'abc', kind: 12},
|
||||||
|
{pubkey: 'abc', kind: 1}
|
||||||
|
],
|
||||||
|
bad: [{pubkey: 'hhh', kind: 12}]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
filters: [{'#e': ['yyy'], since: 444}],
|
||||||
|
good: [
|
||||||
|
{
|
||||||
|
tags: [
|
||||||
|
['e', 'uuu'],
|
||||||
|
['e', 'yyy']
|
||||||
|
],
|
||||||
|
created_at: 555
|
||||||
|
}
|
||||||
|
],
|
||||||
|
bad: [{tags: [['e', 'uuu']], created_at: 111}]
|
||||||
|
}
|
||||||
|
].forEach(({filters, good, bad}) => {
|
||||||
|
good.forEach(ev => {
|
||||||
|
expect(matchFilters(filters, ev)).toBeTruthy()
|
||||||
|
})
|
||||||
|
bad.forEach(ev => {
|
||||||
|
expect(matchFilters(filters, ev)).toBeFalsy()
|
||||||
|
})
|
||||||
|
})
|
||||||
|
})
|
||||||
@@ -1,4 +1,19 @@
|
|||||||
export function matchFilter(filter, event) {
|
import {Event} from './event'
|
||||||
|
|
||||||
|
export type Filter = {
|
||||||
|
ids?: string[]
|
||||||
|
kinds?: number[]
|
||||||
|
authors?: string[]
|
||||||
|
since?: number
|
||||||
|
until?: number
|
||||||
|
limit?: number
|
||||||
|
[key: `#${string}`]: string[]
|
||||||
|
}
|
||||||
|
|
||||||
|
export function matchFilter(
|
||||||
|
filter: Filter,
|
||||||
|
event: Event & {id: string}
|
||||||
|
): boolean {
|
||||||
if (filter.ids && filter.ids.indexOf(event.id) === -1) return false
|
if (filter.ids && filter.ids.indexOf(event.id) === -1) return false
|
||||||
if (filter.kinds && filter.kinds.indexOf(event.kind) === -1) return false
|
if (filter.kinds && filter.kinds.indexOf(event.kind) === -1) return false
|
||||||
if (filter.authors && filter.authors.indexOf(event.pubkey) === -1)
|
if (filter.authors && filter.authors.indexOf(event.pubkey) === -1)
|
||||||
@@ -6,10 +21,12 @@ export function matchFilter(filter, event) {
|
|||||||
|
|
||||||
for (let f in filter) {
|
for (let f in filter) {
|
||||||
if (f[0] === '#') {
|
if (f[0] === '#') {
|
||||||
|
let tagName = f.slice(1)
|
||||||
|
let values = filter[`#${tagName}`]
|
||||||
if (
|
if (
|
||||||
filter[f] &&
|
values &&
|
||||||
!event.tags.find(
|
!event.tags.find(
|
||||||
([t, v]) => t === f.slice(1) && filter[f].indexOf(v) !== -1
|
([t, v]) => t === f.slice(1) && values.indexOf(v) !== -1
|
||||||
)
|
)
|
||||||
)
|
)
|
||||||
return false
|
return false
|
||||||
@@ -22,7 +39,10 @@ export function matchFilter(filter, event) {
|
|||||||
return true
|
return true
|
||||||
}
|
}
|
||||||
|
|
||||||
export function matchFilters(filters, event) {
|
export function matchFilters(
|
||||||
|
filters: Filter[],
|
||||||
|
event: Event & {id: string}
|
||||||
|
): boolean {
|
||||||
for (let i = 0; i < filters.length; i++) {
|
for (let i = 0; i < filters.length; i++) {
|
||||||
if (matchFilter(filters[i], event)) return true
|
if (matchFilter(filters[i], event)) return true
|
||||||
}
|
}
|
||||||
27
index.js
27
index.js
@@ -1,27 +0,0 @@
|
|||||||
import {generatePrivateKey, getPublicKey} from './keys'
|
|
||||||
import {relayConnect} from './relay'
|
|
||||||
import {relayPool} from './pool'
|
|
||||||
import {
|
|
||||||
getBlankEvent,
|
|
||||||
signEvent,
|
|
||||||
validateEvent,
|
|
||||||
verifySignature,
|
|
||||||
serializeEvent,
|
|
||||||
getEventHash
|
|
||||||
} from './event'
|
|
||||||
import {matchFilter, matchFilters} from './filter'
|
|
||||||
|
|
||||||
export {
|
|
||||||
generatePrivateKey,
|
|
||||||
relayConnect,
|
|
||||||
relayPool,
|
|
||||||
signEvent,
|
|
||||||
validateEvent,
|
|
||||||
verifySignature,
|
|
||||||
serializeEvent,
|
|
||||||
getEventHash,
|
|
||||||
getPublicKey,
|
|
||||||
getBlankEvent,
|
|
||||||
matchFilter,
|
|
||||||
matchFilters
|
|
||||||
}
|
|
||||||
23
index.ts
Normal file
23
index.ts
Normal file
@@ -0,0 +1,23 @@
|
|||||||
|
export * from './keys'
|
||||||
|
export * from './relay'
|
||||||
|
export * from './event'
|
||||||
|
export * from './filter'
|
||||||
|
export * from './pool'
|
||||||
|
|
||||||
|
export * as nip04 from './nip04'
|
||||||
|
export * as nip05 from './nip05'
|
||||||
|
export * as nip06 from './nip06'
|
||||||
|
export * as nip19 from './nip19'
|
||||||
|
export * as nip26 from './nip26'
|
||||||
|
|
||||||
|
export * as fj from './fakejson'
|
||||||
|
export * as utils from './utils'
|
||||||
|
|
||||||
|
// monkey patch secp256k1
|
||||||
|
import * as secp256k1 from '@noble/secp256k1'
|
||||||
|
import {hmac} from '@noble/hashes/hmac'
|
||||||
|
import {sha256} from '@noble/hashes/sha256'
|
||||||
|
secp256k1.utils.hmacSha256Sync = (key, ...msgs) =>
|
||||||
|
hmac(sha256, key, secp256k1.utils.concatBytes(...msgs))
|
||||||
|
secp256k1.utils.sha256Sync = (...msgs) =>
|
||||||
|
sha256(secp256k1.utils.concatBytes(...msgs))
|
||||||
10
keys.js
10
keys.js
@@ -1,10 +0,0 @@
|
|||||||
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 Buffer.from(secp256k1.schnorr.getPublicKey(privateKey)).toString('hex')
|
|
||||||
}
|
|
||||||
20
keys.test.js
Normal file
20
keys.test.js
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
/* eslint-env jest */
|
||||||
|
|
||||||
|
const {generatePrivateKey, getPublicKey} = require('./lib/nostr.cjs')
|
||||||
|
|
||||||
|
test('test private key generation', () => {
|
||||||
|
expect(generatePrivateKey()).toMatch(/[a-f0-9]{64}/)
|
||||||
|
})
|
||||||
|
|
||||||
|
test('test public key generation', () => {
|
||||||
|
expect(getPublicKey(generatePrivateKey())).toMatch(/[a-f0-9]{64}/)
|
||||||
|
})
|
||||||
|
|
||||||
|
test('test public key from private key deterministic', () => {
|
||||||
|
let sk = generatePrivateKey()
|
||||||
|
let pk = getPublicKey(sk)
|
||||||
|
|
||||||
|
for (let i = 0; i < 5; i++) {
|
||||||
|
expect(getPublicKey(sk)).toEqual(pk)
|
||||||
|
}
|
||||||
|
})
|
||||||
9
keys.ts
Normal file
9
keys.ts
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
import * as secp256k1 from '@noble/secp256k1'
|
||||||
|
|
||||||
|
export function generatePrivateKey(): string {
|
||||||
|
return secp256k1.utils.bytesToHex(secp256k1.utils.randomPrivateKey())
|
||||||
|
}
|
||||||
|
|
||||||
|
export function getPublicKey(privateKey: string): string {
|
||||||
|
return secp256k1.utils.bytesToHex(secp256k1.schnorr.getPublicKey(privateKey))
|
||||||
|
}
|
||||||
42
nip04.js
42
nip04.js
@@ -1,42 +0,0 @@
|
|||||||
import aes from 'browserify-cipher'
|
|
||||||
import {Buffer} from 'buffer'
|
|
||||||
import {randomBytes} from '@noble/hashes/utils'
|
|
||||||
import * as secp256k1 from '@noble/secp256k1'
|
|
||||||
|
|
||||||
export function encrypt(privkey, pubkey, text) {
|
|
||||||
const key = secp256k1.getSharedSecret(privkey, '02' + pubkey)
|
|
||||||
const normalizedKey = getNormalizedX(key)
|
|
||||||
|
|
||||||
let iv = Uint8Array.from(randomBytes(16))
|
|
||||||
var cipher = aes.createCipheriv(
|
|
||||||
'aes-256-cbc',
|
|
||||||
Buffer.from(normalizedKey, 'hex'),
|
|
||||||
iv
|
|
||||||
)
|
|
||||||
let encryptedMessage = cipher.update(text, 'utf8', 'base64')
|
|
||||||
encryptedMessage += cipher.final('base64')
|
|
||||||
|
|
||||||
return `${encryptedMessage}?iv=${Buffer.from(iv.buffer).toString('base64')}`
|
|
||||||
}
|
|
||||||
|
|
||||||
export function decrypt(privkey, pubkey, ciphertext) {
|
|
||||||
let [cip, iv] = ciphertext.split('?iv=')
|
|
||||||
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(cip, 'base64')
|
|
||||||
decryptedMessage += decipher.final('utf8')
|
|
||||||
|
|
||||||
return decryptedMessage
|
|
||||||
}
|
|
||||||
|
|
||||||
function getNormalizedX(key) {
|
|
||||||
return typeof key === 'string'
|
|
||||||
? key.substr(2, 64)
|
|
||||||
: Buffer.from(key.slice(1, 33)).toString('hex')
|
|
||||||
}
|
|
||||||
15
nip04.test.js
Normal file
15
nip04.test.js
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
/* eslint-env jest */
|
||||||
|
|
||||||
|
globalThis.crypto = require('crypto')
|
||||||
|
const {nip04, getPublicKey, generatePrivateKey} = require('./lib/nostr.cjs')
|
||||||
|
|
||||||
|
test('encrypt and decrypt message', async () => {
|
||||||
|
let sk1 = generatePrivateKey()
|
||||||
|
let sk2 = generatePrivateKey()
|
||||||
|
let pk1 = getPublicKey(sk1)
|
||||||
|
let pk2 = getPublicKey(sk2)
|
||||||
|
|
||||||
|
expect(
|
||||||
|
await nip04.decrypt(sk2, pk1, await nip04.encrypt(sk1, pk2, 'hello'))
|
||||||
|
).toEqual('hello')
|
||||||
|
})
|
||||||
66
nip04.ts
Normal file
66
nip04.ts
Normal file
@@ -0,0 +1,66 @@
|
|||||||
|
import {randomBytes} from '@noble/hashes/utils'
|
||||||
|
import * as secp256k1 from '@noble/secp256k1'
|
||||||
|
import {base64} from '@scure/base'
|
||||||
|
|
||||||
|
import {utf8Decoder, utf8Encoder} from './utils'
|
||||||
|
|
||||||
|
export async function encrypt(
|
||||||
|
privkey: string,
|
||||||
|
pubkey: string,
|
||||||
|
text: string
|
||||||
|
): Promise<string> {
|
||||||
|
const key = secp256k1.getSharedSecret(privkey, '02' + pubkey)
|
||||||
|
const normalizedKey = getNormalizedX(key)
|
||||||
|
|
||||||
|
let iv = Uint8Array.from(randomBytes(16))
|
||||||
|
let plaintext = utf8Encoder.encode(text)
|
||||||
|
let cryptoKey = await crypto.subtle.importKey(
|
||||||
|
'raw',
|
||||||
|
normalizedKey,
|
||||||
|
{name: 'AES-CBC'},
|
||||||
|
false,
|
||||||
|
['encrypt']
|
||||||
|
)
|
||||||
|
let ciphertext = await crypto.subtle.encrypt(
|
||||||
|
{name: 'AES-CBC', iv},
|
||||||
|
cryptoKey,
|
||||||
|
plaintext
|
||||||
|
)
|
||||||
|
let ctb64 = base64.encode(new Uint8Array(ciphertext))
|
||||||
|
let ivb64 = base64.encode(new Uint8Array(iv.buffer))
|
||||||
|
|
||||||
|
return `${ctb64}?iv=${ivb64}`
|
||||||
|
}
|
||||||
|
|
||||||
|
export async function decrypt(
|
||||||
|
privkey: string,
|
||||||
|
pubkey: string,
|
||||||
|
data: string
|
||||||
|
): Promise<string> {
|
||||||
|
let [ctb64, ivb64] = data.split('?iv=')
|
||||||
|
let key = secp256k1.getSharedSecret(privkey, '02' + pubkey)
|
||||||
|
let normalizedKey = getNormalizedX(key)
|
||||||
|
|
||||||
|
let cryptoKey = await crypto.subtle.importKey(
|
||||||
|
'raw',
|
||||||
|
normalizedKey,
|
||||||
|
{name: 'AES-CBC'},
|
||||||
|
false,
|
||||||
|
['decrypt']
|
||||||
|
)
|
||||||
|
let ciphertext = base64.decode(ctb64)
|
||||||
|
let iv = base64.decode(ivb64)
|
||||||
|
|
||||||
|
let plaintext = await crypto.subtle.decrypt(
|
||||||
|
{name: 'AES-CBC', iv},
|
||||||
|
cryptoKey,
|
||||||
|
ciphertext
|
||||||
|
)
|
||||||
|
|
||||||
|
let text = utf8Decoder.decode(plaintext)
|
||||||
|
return text
|
||||||
|
}
|
||||||
|
|
||||||
|
function getNormalizedX(key: Uint8Array): Uint8Array {
|
||||||
|
return key.slice(1, 33)
|
||||||
|
}
|
||||||
28
nip05.js
28
nip05.js
@@ -1,28 +0,0 @@
|
|||||||
import fetch from 'cross-fetch'
|
|
||||||
|
|
||||||
export async function searchDomain(domain, query = '') {
|
|
||||||
try {
|
|
||||||
let res = await (
|
|
||||||
await fetch(`https://${domain}/.well-known/nostr.json?name=${query}`)
|
|
||||||
).json()
|
|
||||||
|
|
||||||
return res.names
|
|
||||||
} 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
|
|
||||||
}
|
|
||||||
}
|
|
||||||
20
nip05.test.js
Normal file
20
nip05.test.js
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
/* eslint-env jest */
|
||||||
|
|
||||||
|
const fetch = require('node-fetch')
|
||||||
|
const {nip05} = require('./lib/nostr.cjs')
|
||||||
|
|
||||||
|
test('fetch nip05 profiles', async () => {
|
||||||
|
nip05.useFetchImplementation(fetch)
|
||||||
|
|
||||||
|
let p1 = await nip05.queryProfile('jb55.com')
|
||||||
|
expect(p1.pubkey).toEqual(
|
||||||
|
'32e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245'
|
||||||
|
)
|
||||||
|
expect(p1.relays).toEqual(['wss://relay.damus.io'])
|
||||||
|
|
||||||
|
let p2 = await nip05.queryProfile('jb55@jb55.com')
|
||||||
|
expect(p2.pubkey).toEqual(
|
||||||
|
'32e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245'
|
||||||
|
)
|
||||||
|
expect(p2.relays).toEqual(['wss://relay.damus.io'])
|
||||||
|
})
|
||||||
54
nip05.ts
Normal file
54
nip05.ts
Normal file
@@ -0,0 +1,54 @@
|
|||||||
|
import {ProfilePointer} from './nip19'
|
||||||
|
|
||||||
|
var _fetch: any
|
||||||
|
|
||||||
|
try {
|
||||||
|
_fetch = fetch
|
||||||
|
} catch {}
|
||||||
|
|
||||||
|
export function useFetchImplementation(fetchImplementation: any) {
|
||||||
|
_fetch = fetchImplementation
|
||||||
|
}
|
||||||
|
|
||||||
|
export async function searchDomain(
|
||||||
|
domain: string,
|
||||||
|
query = ''
|
||||||
|
): Promise<{[name: string]: string}> {
|
||||||
|
try {
|
||||||
|
let res = await (
|
||||||
|
await _fetch(`https://${domain}/.well-known/nostr.json?name=${query}`)
|
||||||
|
).json()
|
||||||
|
|
||||||
|
return res.names
|
||||||
|
} catch (_) {
|
||||||
|
return {}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export async function queryProfile(
|
||||||
|
fullname: string
|
||||||
|
): Promise<ProfilePointer | null> {
|
||||||
|
let [name, domain] = fullname.split('@')
|
||||||
|
|
||||||
|
if (!domain) {
|
||||||
|
// if there is no @, it is because it is just a domain, so assume the name is "_"
|
||||||
|
domain = name
|
||||||
|
name = '_'
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!name.match(/^[A-Za-z0-9-_]+$/)) return null
|
||||||
|
|
||||||
|
let res = await (
|
||||||
|
await _fetch(`https://${domain}/.well-known/nostr.json?name=${name}`)
|
||||||
|
).json()
|
||||||
|
|
||||||
|
if (!res?.names?.[name]) return null
|
||||||
|
|
||||||
|
let pubkey = res.names[name] as string
|
||||||
|
let relays = (res.relays?.[pubkey] || []) as string[] // nip35
|
||||||
|
|
||||||
|
return {
|
||||||
|
pubkey,
|
||||||
|
relays
|
||||||
|
}
|
||||||
|
}
|
||||||
26
nip06.js
26
nip06.js
@@ -1,26 +0,0 @@
|
|||||||
import {wordlist} from 'micro-bip39/wordlists/english'
|
|
||||||
import {
|
|
||||||
generateMnemonic,
|
|
||||||
mnemonicToSeedSync,
|
|
||||||
validateMnemonic
|
|
||||||
} from 'micro-bip39'
|
|
||||||
import {HDKey} from 'micro-bip32'
|
|
||||||
|
|
||||||
export function privateKeyFromSeed(seed) {
|
|
||||||
let root = HDKey.fromMasterSeed(Buffer.from(seed, 'hex'))
|
|
||||||
return Buffer.from(root.derive(`m/44'/1237'/0'/0/0`).privateKey).toString(
|
|
||||||
'hex'
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
export function seedFromWords(mnemonic) {
|
|
||||||
return Buffer.from(mnemonicToSeedSync(mnemonic)).toString('hex')
|
|
||||||
}
|
|
||||||
|
|
||||||
export function generateSeedWords() {
|
|
||||||
return generateMnemonic(wordlist)
|
|
||||||
}
|
|
||||||
|
|
||||||
export function validateWords(words) {
|
|
||||||
return validateMnemonic(words, wordlist)
|
|
||||||
}
|
|
||||||
15
nip06.test.js
Normal file
15
nip06.test.js
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
/* eslint-env jest */
|
||||||
|
const {nip06} = require('./lib/nostr.cjs')
|
||||||
|
|
||||||
|
test('generate private key from a mnemonic', async () => {
|
||||||
|
const mnemonic = 'zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo wrong'
|
||||||
|
const privateKey = nip06.privateKeyFromSeedWords(mnemonic)
|
||||||
|
expect(privateKey).toEqual('c26cf31d8ba425b555ca27d00ca71b5008004f2f662470f8c8131822ec129fe2')
|
||||||
|
})
|
||||||
|
|
||||||
|
test('generate private key from a mnemonic and passphrase', async () => {
|
||||||
|
const mnemonic = 'zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo wrong'
|
||||||
|
const passphrase = '123'
|
||||||
|
const privateKey = nip06.privateKeyFromSeedWords(mnemonic, passphrase)
|
||||||
|
expect(privateKey).toEqual('55a22b8203273d0aaf24c22c8fbe99608e70c524b17265641074281c8b978ae4')
|
||||||
|
})
|
||||||
23
nip06.ts
Normal file
23
nip06.ts
Normal file
@@ -0,0 +1,23 @@
|
|||||||
|
import * as secp256k1 from '@noble/secp256k1'
|
||||||
|
import {wordlist} from '@scure/bip39/wordlists/english.js'
|
||||||
|
import {
|
||||||
|
generateMnemonic,
|
||||||
|
mnemonicToSeedSync,
|
||||||
|
validateMnemonic
|
||||||
|
} from '@scure/bip39'
|
||||||
|
import {HDKey} from '@scure/bip32'
|
||||||
|
|
||||||
|
export function privateKeyFromSeedWords(mnemonic: string, passphrase?: string): string {
|
||||||
|
let root = HDKey.fromMasterSeed(mnemonicToSeedSync(mnemonic, passphrase))
|
||||||
|
let privateKey = root.derive(`m/44'/1237'/0'/0/0`).privateKey
|
||||||
|
if (!privateKey) throw new Error('could not derive private key')
|
||||||
|
return secp256k1.utils.bytesToHex(privateKey)
|
||||||
|
}
|
||||||
|
|
||||||
|
export function generateSeedWords(): string {
|
||||||
|
return generateMnemonic(wordlist)
|
||||||
|
}
|
||||||
|
|
||||||
|
export function validateWords(words: string): boolean {
|
||||||
|
return validateMnemonic(words, wordlist)
|
||||||
|
}
|
||||||
36
nip19.test.js
Normal file
36
nip19.test.js
Normal file
@@ -0,0 +1,36 @@
|
|||||||
|
/* eslint-env jest */
|
||||||
|
|
||||||
|
const {nip19, generatePrivateKey, getPublicKey} = require('./lib/nostr.cjs')
|
||||||
|
|
||||||
|
test('encode and decode nsec', () => {
|
||||||
|
let sk = generatePrivateKey()
|
||||||
|
let nsec = nip19.nsecEncode(sk)
|
||||||
|
expect(nsec).toMatch(/nsec1\w+/)
|
||||||
|
let {type, data} = nip19.decode(nsec)
|
||||||
|
expect(type).toEqual('nsec')
|
||||||
|
expect(data).toEqual(sk)
|
||||||
|
})
|
||||||
|
|
||||||
|
test('encode and decode npub', () => {
|
||||||
|
let pk = getPublicKey(generatePrivateKey())
|
||||||
|
let npub = nip19.npubEncode(pk)
|
||||||
|
expect(npub).toMatch(/npub1\w+/)
|
||||||
|
let {type, data} = nip19.decode(npub)
|
||||||
|
expect(type).toEqual('npub')
|
||||||
|
expect(data).toEqual(pk)
|
||||||
|
})
|
||||||
|
|
||||||
|
test('encode and decode nprofile', () => {
|
||||||
|
let pk = getPublicKey(generatePrivateKey())
|
||||||
|
let relays = [
|
||||||
|
'wss://relay.nostr.example.mydomain.example.com',
|
||||||
|
'wss://nostr.banana.com'
|
||||||
|
]
|
||||||
|
let nprofile = nip19.nprofileEncode({pubkey: pk, relays})
|
||||||
|
expect(nprofile).toMatch(/nprofile1\w+/)
|
||||||
|
let {type, data} = nip19.decode(nprofile)
|
||||||
|
expect(type).toEqual('nprofile')
|
||||||
|
expect(data.pubkey).toEqual(pk)
|
||||||
|
expect(data.relays).toContain(relays[0])
|
||||||
|
expect(data.relays).toContain(relays[1])
|
||||||
|
})
|
||||||
127
nip19.ts
Normal file
127
nip19.ts
Normal file
@@ -0,0 +1,127 @@
|
|||||||
|
import * as secp256k1 from '@noble/secp256k1'
|
||||||
|
import {bech32} from '@scure/base'
|
||||||
|
|
||||||
|
import {utf8Decoder, utf8Encoder} from './utils'
|
||||||
|
|
||||||
|
const Bech32MaxSize = 5000
|
||||||
|
|
||||||
|
export type ProfilePointer = {
|
||||||
|
pubkey: string // hex
|
||||||
|
relays?: string[]
|
||||||
|
}
|
||||||
|
|
||||||
|
export type EventPointer = {
|
||||||
|
id: string // hex
|
||||||
|
relays?: string[]
|
||||||
|
}
|
||||||
|
|
||||||
|
export function decode(nip19: string): {
|
||||||
|
type: string
|
||||||
|
data: ProfilePointer | EventPointer | string
|
||||||
|
} {
|
||||||
|
let {prefix, words} = bech32.decode(nip19, Bech32MaxSize)
|
||||||
|
let data = new Uint8Array(bech32.fromWords(words))
|
||||||
|
|
||||||
|
if (prefix === 'nprofile') {
|
||||||
|
let tlv = parseTLV(data)
|
||||||
|
if (!tlv[0]?.[0]) throw new Error('missing TLV 0 for nprofile')
|
||||||
|
if (tlv[0][0].length !== 32) throw new Error('TLV 0 should be 32 bytes')
|
||||||
|
|
||||||
|
return {
|
||||||
|
type: 'nprofile',
|
||||||
|
data: {
|
||||||
|
pubkey: secp256k1.utils.bytesToHex(tlv[0][0]),
|
||||||
|
relays: tlv[1].map(d => utf8Decoder.decode(d))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if (prefix === 'nevent') {
|
||||||
|
let tlv = parseTLV(data)
|
||||||
|
if (!tlv[0]?.[0]) throw new Error('missing TLV 0 for nevent')
|
||||||
|
if (tlv[0][0].length !== 32) throw new Error('TLV 0 should be 32 bytes')
|
||||||
|
|
||||||
|
return {
|
||||||
|
type: 'nevent',
|
||||||
|
data: {
|
||||||
|
id: secp256k1.utils.bytesToHex(tlv[0][0]),
|
||||||
|
relays: tlv[1].map(d => utf8Decoder.decode(d))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if (prefix === 'nsec' || prefix === 'npub' || prefix === 'note') {
|
||||||
|
return {type: prefix, data: secp256k1.utils.bytesToHex(data)}
|
||||||
|
}
|
||||||
|
|
||||||
|
throw new Error(`unknown prefix ${prefix}`)
|
||||||
|
}
|
||||||
|
|
||||||
|
type TLV = {[t: number]: Uint8Array[]}
|
||||||
|
|
||||||
|
function parseTLV(data: Uint8Array): TLV {
|
||||||
|
let result: TLV = {}
|
||||||
|
let rest = data
|
||||||
|
while (rest.length > 0) {
|
||||||
|
let t = rest[0]
|
||||||
|
let l = rest[1]
|
||||||
|
let v = rest.slice(2, 2 + l)
|
||||||
|
rest = rest.slice(2 + l)
|
||||||
|
if (v.length < l) continue
|
||||||
|
result[t] = result[t] || []
|
||||||
|
result[t].push(v)
|
||||||
|
}
|
||||||
|
return result
|
||||||
|
}
|
||||||
|
|
||||||
|
export function nsecEncode(hex: string): string {
|
||||||
|
return encodeBytes('nsec', hex)
|
||||||
|
}
|
||||||
|
|
||||||
|
export function npubEncode(hex: string): string {
|
||||||
|
return encodeBytes('npub', hex)
|
||||||
|
}
|
||||||
|
|
||||||
|
export function noteEncode(hex: string): string {
|
||||||
|
return encodeBytes('note', hex)
|
||||||
|
}
|
||||||
|
|
||||||
|
function encodeBytes(prefix: string, hex: string): string {
|
||||||
|
let data = secp256k1.utils.hexToBytes(hex)
|
||||||
|
let words = bech32.toWords(data)
|
||||||
|
return bech32.encode(prefix, words, Bech32MaxSize)
|
||||||
|
}
|
||||||
|
|
||||||
|
export function nprofileEncode(profile: ProfilePointer): string {
|
||||||
|
let data = encodeTLV({
|
||||||
|
0: [secp256k1.utils.hexToBytes(profile.pubkey)],
|
||||||
|
1: (profile.relays || []).map(url => utf8Encoder.encode(url))
|
||||||
|
})
|
||||||
|
let words = bech32.toWords(data)
|
||||||
|
return bech32.encode('nprofile', words, Bech32MaxSize)
|
||||||
|
}
|
||||||
|
|
||||||
|
export function neventEncode(event: EventPointer): string {
|
||||||
|
let data = encodeTLV({
|
||||||
|
0: [secp256k1.utils.hexToBytes(event.id)],
|
||||||
|
1: (event.relays || []).map(url => utf8Encoder.encode(url))
|
||||||
|
})
|
||||||
|
let words = bech32.toWords(data)
|
||||||
|
return bech32.encode('nevent', words, Bech32MaxSize)
|
||||||
|
}
|
||||||
|
|
||||||
|
function encodeTLV(tlv: TLV): Uint8Array {
|
||||||
|
let entries: Uint8Array[] = []
|
||||||
|
|
||||||
|
Object.entries(tlv).forEach(([t, vs]) => {
|
||||||
|
vs.forEach(v => {
|
||||||
|
let entry = new Uint8Array(v.length + 2)
|
||||||
|
entry.set([parseInt(t)], 0)
|
||||||
|
entry.set([v.length], 1)
|
||||||
|
entry.set(v, 2)
|
||||||
|
entries.push(entry)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
return secp256k1.utils.concatBytes(...entries)
|
||||||
|
}
|
||||||
105
nip26.test.js
Normal file
105
nip26.test.js
Normal file
@@ -0,0 +1,105 @@
|
|||||||
|
/* eslint-env jest */
|
||||||
|
|
||||||
|
const {nip26, getPublicKey, generatePrivateKey} = require('./lib/nostr.cjs')
|
||||||
|
|
||||||
|
test('parse good delegation from NIP', async () => {
|
||||||
|
expect(
|
||||||
|
nip26.getDelegator({
|
||||||
|
id: 'a080fd288b60ac2225ff2e2d815291bd730911e583e177302cc949a15dc2b2dc',
|
||||||
|
pubkey:
|
||||||
|
'62903b1ff41559daf9ee98ef1ae67cc52f301bb5ce26d14baba3052f649c3f49',
|
||||||
|
created_at: 1660896109,
|
||||||
|
kind: 1,
|
||||||
|
tags: [
|
||||||
|
[
|
||||||
|
'delegation',
|
||||||
|
'86f0689bd48dcd19c67a19d994f938ee34f251d8c39976290955ff585f2db42e',
|
||||||
|
'kind=1&created_at>1640995200',
|
||||||
|
'c33c88ba78ec3c760e49db591ac5f7b129e3887c8af7729795e85a0588007e5ac89b46549232d8f918eefd73e726cb450135314bfda419c030d0b6affe401ec1'
|
||||||
|
]
|
||||||
|
],
|
||||||
|
content: 'Hello world',
|
||||||
|
sig: 'cd4a3cd20dc61dcbc98324de561a07fd23b3d9702115920c0814b5fb822cc5b7c5bcdaf3fa326d24ed50c5b9c8214d66c75bae34e3a84c25e4d122afccb66eb6'
|
||||||
|
})
|
||||||
|
).toEqual('86f0689bd48dcd19c67a19d994f938ee34f251d8c39976290955ff585f2db42e')
|
||||||
|
})
|
||||||
|
|
||||||
|
test('parse bad delegations', async () => {
|
||||||
|
expect(
|
||||||
|
nip26.getDelegator({
|
||||||
|
id: 'a080fd288b60ac2225ff2e2d815291bd730911e583e177302cc949a15dc2b2dc',
|
||||||
|
pubkey:
|
||||||
|
'62903b1ff41559daf9ee98ef1ae67cc52f301bb5ce26d14baba3052f649c3f49',
|
||||||
|
created_at: 1660896109,
|
||||||
|
kind: 1,
|
||||||
|
tags: [
|
||||||
|
[
|
||||||
|
'delegation',
|
||||||
|
'86f0689bd48dcd19c67a19d994f938ee34f251d8c39976290955ff585f2db42f',
|
||||||
|
'kind=1&created_at>1640995200',
|
||||||
|
'c33c88ba78ec3c760e49db591ac5f7b129e3887c8af7729795e85a0588007e5ac89b46549232d8f918eefd73e726cb450135314bfda419c030d0b6affe401ec1'
|
||||||
|
]
|
||||||
|
],
|
||||||
|
content: 'Hello world',
|
||||||
|
sig: 'cd4a3cd20dc61dcbc98324de561a07fd23b3d9702115920c0814b5fb822cc5b7c5bcdaf3fa326d24ed50c5b9c8214d66c75bae34e3a84c25e4d122afccb66eb6'
|
||||||
|
})
|
||||||
|
).toEqual(null)
|
||||||
|
|
||||||
|
expect(
|
||||||
|
nip26.getDelegator({
|
||||||
|
id: 'a080fd288b60ac2225ff2e2d815291bd730911e583e177302cc949a15dc2b2dc',
|
||||||
|
pubkey:
|
||||||
|
'62903b1ff41559daf9ee98ef1ae67cc52f301bb5ce26d14baba3052f649c3f49',
|
||||||
|
created_at: 1660896109,
|
||||||
|
kind: 1,
|
||||||
|
tags: [
|
||||||
|
[
|
||||||
|
'delegation',
|
||||||
|
'86f0689bd48dcd19c67a19d994f938ee34f251d8c39976290955ff585f2db42e',
|
||||||
|
'kind=1&created_at>1740995200',
|
||||||
|
'c33c88ba78ec3c760e49db591ac5f7b129e3887c8af7729795e85a0588007e5ac89b46549232d8f918eefd73e726cb450135314bfda419c030d0b6affe401ec1'
|
||||||
|
]
|
||||||
|
],
|
||||||
|
content: 'Hello world',
|
||||||
|
sig: 'cd4a3cd20dc61dcbc98324de561a07fd23b3d9702115920c0814b5fb822cc5b7c5bcdaf3fa326d24ed50c5b9c8214d66c75bae34e3a84c25e4d122afccb66eb6'
|
||||||
|
})
|
||||||
|
).toEqual(null)
|
||||||
|
|
||||||
|
expect(
|
||||||
|
nip26.getDelegator({
|
||||||
|
id: 'a080fd288b60ac2225ff2e2d815291bd730911e583e177302cc949a15dc2b2dc',
|
||||||
|
pubkey:
|
||||||
|
'62903b1ff41559daf9ee98ef1ae67c152f301bb5ce26d14baba3052f649c3f49',
|
||||||
|
created_at: 1660896109,
|
||||||
|
kind: 1,
|
||||||
|
tags: [
|
||||||
|
[
|
||||||
|
'delegation',
|
||||||
|
'86f0689bd48dcd19c67a19d994f938ee34f251d8c39976290955ff585f2db42e',
|
||||||
|
'kind=1&created_at>1640995200',
|
||||||
|
'c33c88ba78ec3c760e49db591ac5f7b129e3887c8af7729795e85a0588007e5ac89b46549232d8f918eefd73e726cb450135314bfda419c030d0b6affe401ec1'
|
||||||
|
]
|
||||||
|
],
|
||||||
|
content: 'Hello world',
|
||||||
|
sig: 'cd4a3cd20dc61dcbc98324de561a07fd23b3d9702115920c0814b5fb822cc5b7c5bcdaf3fa326d24ed50c5b9c8214d66c75bae34e3a84c25e4d122afccb66eb6'
|
||||||
|
})
|
||||||
|
).toEqual(null)
|
||||||
|
})
|
||||||
|
|
||||||
|
test('create and verify delegation', async () => {
|
||||||
|
let sk1 = generatePrivateKey()
|
||||||
|
let pk1 = getPublicKey(sk1)
|
||||||
|
let sk2 = generatePrivateKey()
|
||||||
|
let pk2 = getPublicKey(sk2)
|
||||||
|
let delegation = nip26.createDelegation(sk1, {pubkey: pk2, kind: 1})
|
||||||
|
expect(delegation).toHaveProperty('from', pk1)
|
||||||
|
expect(delegation).toHaveProperty('to', pk2)
|
||||||
|
expect(delegation).toHaveProperty('cond', 'kind=1')
|
||||||
|
|
||||||
|
let event = {
|
||||||
|
kind: 1,
|
||||||
|
tags: [['delegation', delegation.from, delegation.cond, delegation.sig]],
|
||||||
|
pubkey: pk2
|
||||||
|
}
|
||||||
|
expect(nip26.getDelegator(event)).toEqual(pk1)
|
||||||
|
})
|
||||||
90
nip26.ts
Normal file
90
nip26.ts
Normal file
@@ -0,0 +1,90 @@
|
|||||||
|
import * as secp256k1 from '@noble/secp256k1'
|
||||||
|
import {sha256} from '@noble/hashes/sha256'
|
||||||
|
|
||||||
|
import {Event} from './event'
|
||||||
|
import {utf8Encoder} from './utils'
|
||||||
|
import {getPublicKey} from './keys'
|
||||||
|
|
||||||
|
export type Parameters = {
|
||||||
|
pubkey: string // the key to whom the delegation will be given
|
||||||
|
kind: number | undefined
|
||||||
|
until: number | undefined // delegation will only be valid until this date
|
||||||
|
since: number | undefined // delegation will be valid from this date on
|
||||||
|
}
|
||||||
|
|
||||||
|
export type Delegation = {
|
||||||
|
from: string // the pubkey who signed the delegation
|
||||||
|
to: string // the pubkey that is allowed to use the delegation
|
||||||
|
cond: string // the string of conditions as they should be included in the event tag
|
||||||
|
sig: string
|
||||||
|
}
|
||||||
|
|
||||||
|
export function createDelegation(
|
||||||
|
privateKey: string,
|
||||||
|
parameters: Parameters
|
||||||
|
): Delegation {
|
||||||
|
let conditions = []
|
||||||
|
if ((parameters.kind || -1) >= 0) conditions.push(`kind=${parameters.kind}`)
|
||||||
|
if (parameters.until) conditions.push(`created_at<${parameters.until}`)
|
||||||
|
if (parameters.since) conditions.push(`created_at>${parameters.since}`)
|
||||||
|
let cond = conditions.join('&')
|
||||||
|
|
||||||
|
if (cond === '')
|
||||||
|
throw new Error('refusing to create a delegation without any conditions')
|
||||||
|
|
||||||
|
let sighash = sha256(
|
||||||
|
utf8Encoder.encode(`nostr:delegation:${parameters.pubkey}:${cond}`)
|
||||||
|
)
|
||||||
|
|
||||||
|
let sig = secp256k1.utils.bytesToHex(
|
||||||
|
secp256k1.schnorr.signSync(sighash, privateKey)
|
||||||
|
)
|
||||||
|
|
||||||
|
return {
|
||||||
|
from: getPublicKey(privateKey),
|
||||||
|
to: parameters.pubkey,
|
||||||
|
cond,
|
||||||
|
sig
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export function getDelegator(event: Event): string | null {
|
||||||
|
// find delegation tag
|
||||||
|
let tag = event.tags.find(tag => tag[0] === 'delegation' && tag.length >= 4)
|
||||||
|
if (!tag) return null
|
||||||
|
|
||||||
|
let pubkey = tag[1]
|
||||||
|
let cond = tag[2]
|
||||||
|
let sig = tag[3]
|
||||||
|
|
||||||
|
// check conditions
|
||||||
|
let conditions = cond.split('&')
|
||||||
|
for (let i = 0; i < conditions.length; i++) {
|
||||||
|
let [key, operator, value] = conditions[i].split(/\b/)
|
||||||
|
|
||||||
|
// the supported conditions are just 'kind' and 'created_at' for now
|
||||||
|
if (key === 'kind' && operator === '=' && event.kind === parseInt(value))
|
||||||
|
continue
|
||||||
|
else if (
|
||||||
|
key === 'created_at' &&
|
||||||
|
operator === '<' &&
|
||||||
|
event.created_at < parseInt(value)
|
||||||
|
)
|
||||||
|
continue
|
||||||
|
else if (
|
||||||
|
key === 'created_at' &&
|
||||||
|
operator === '>' &&
|
||||||
|
event.created_at > parseInt(value)
|
||||||
|
)
|
||||||
|
continue
|
||||||
|
else return null // invalid condition
|
||||||
|
}
|
||||||
|
|
||||||
|
// check signature
|
||||||
|
let sighash = sha256(
|
||||||
|
utf8Encoder.encode(`nostr:delegation:${event.pubkey}:${cond}`)
|
||||||
|
)
|
||||||
|
if (!secp256k1.schnorr.verifySync(sig, sighash, pubkey)) return null
|
||||||
|
|
||||||
|
return pubkey
|
||||||
|
}
|
||||||
47
package.json
47
package.json
@@ -1,36 +1,47 @@
|
|||||||
{
|
{
|
||||||
"name": "nostr-tools",
|
"name": "nostr-tools",
|
||||||
"version": "0.23.0",
|
"version": "1.2.3",
|
||||||
"description": "Tools for making a Nostr client.",
|
"description": "Tools for making a Nostr client.",
|
||||||
"repository": {
|
"repository": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
"url": "https://github.com/fiatjaf/nostr-tools.git"
|
"url": "https://github.com/fiatjaf/nostr-tools.git"
|
||||||
},
|
},
|
||||||
|
"main": "lib/nostr.cjs.js",
|
||||||
|
"module": "lib/nostr.esm.js",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@noble/hashes": "^0.5.7",
|
"@noble/hashes": "^0.5.7",
|
||||||
"@noble/secp256k1": "^1.5.2",
|
"@noble/secp256k1": "^1.7.0",
|
||||||
"browserify-cipher": ">=1",
|
"@scure/base": "^1.1.1",
|
||||||
"buffer": ">=5",
|
"@scure/bip32": "^1.1.1",
|
||||||
"create-hash": "^1.2.0",
|
"@scure/bip39": "^1.1.0"
|
||||||
"cross-fetch": "^3.1.4",
|
|
||||||
"micro-bip32": "^0.1.0",
|
|
||||||
"micro-bip39": "^0.1.3",
|
|
||||||
"websocket-polyfill": "^0.0.3"
|
|
||||||
},
|
},
|
||||||
"keywords": [
|
"keywords": [
|
||||||
"decentralization",
|
"decentralization",
|
||||||
"twitter",
|
|
||||||
"p2p",
|
|
||||||
"mastodon",
|
|
||||||
"ssb",
|
|
||||||
"social",
|
"social",
|
||||||
"unstoppable",
|
|
||||||
"censorship",
|
|
||||||
"censorship-resistance",
|
"censorship-resistance",
|
||||||
"client"
|
"client",
|
||||||
|
"nostr"
|
||||||
],
|
],
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"eslint": "^8.5.0",
|
"@types/node": "^18.0.3",
|
||||||
"eslint-plugin-babel": "^5.3.1"
|
"@typescript-eslint/eslint-plugin": "^5.46.1",
|
||||||
|
"@typescript-eslint/parser": "^5.46.1",
|
||||||
|
"esbuild": "0.16.9",
|
||||||
|
"esbuild-plugin-alias": "^0.2.1",
|
||||||
|
"eslint": "^8.30.0",
|
||||||
|
"eslint-plugin-babel": "^5.3.1",
|
||||||
|
"esm-loader-typescript": "^1.0.1",
|
||||||
|
"events": "^3.3.0",
|
||||||
|
"jest": "^29.3.1",
|
||||||
|
"node-fetch": "2",
|
||||||
|
"ts-jest": "^29.0.3",
|
||||||
|
"tsd": "^0.22.0",
|
||||||
|
"typescript": "^4.9.4",
|
||||||
|
"websocket-polyfill": "^0.0.3"
|
||||||
|
},
|
||||||
|
"scripts": {
|
||||||
|
"build": "node build.js",
|
||||||
|
"pretest": "node build.js",
|
||||||
|
"test": "jest"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
204
pool.js
204
pool.js
@@ -1,204 +0,0 @@
|
|||||||
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
|
|
||||||
randomChoice: null,
|
|
||||||
|
|
||||||
// setting this to true will cause .publish() calls to wait until the event has
|
|
||||||
// been published -- or at least attempted to be published -- to all relays
|
|
||||||
wait: false
|
|
||||||
}
|
|
||||||
const relays = {}
|
|
||||||
const noticeCallbacks = []
|
|
||||||
|
|
||||||
function propagateNotice(notice, relayURL) {
|
|
||||||
for (let i = 0; i < noticeCallbacks.length; i++) {
|
|
||||||
let {relay} = relays[relayURL]
|
|
||||||
noticeCallbacks[i](notice, relay)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
const activeSubscriptions = {}
|
|
||||||
|
|
||||||
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), 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,
|
|
||||||
beforeSend = activeBeforeSend
|
|
||||||
}) => {
|
|
||||||
Object.entries(subControllers).map(([relayURL, sub]) => [
|
|
||||||
relayURL,
|
|
||||||
sub.sub({cb, filter, beforeSend}, 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]
|
|
||||||
}
|
|
||||||
|
|
||||||
return {
|
|
||||||
sub,
|
|
||||||
relays,
|
|
||||||
setPrivateKey(privateKey) {
|
|
||||||
globalPrivateKey = privateKey
|
|
||||||
},
|
|
||||||
registerSigningFunction(fn) {
|
|
||||||
globalSigningFunction = fn
|
|
||||||
},
|
|
||||||
setPolicy(key, value) {
|
|
||||||
poolPolicy[key] = value
|
|
||||||
},
|
|
||||||
addRelay(url, policy = {read: true, write: true}) {
|
|
||||||
let relayURL = normalizeRelayURL(url)
|
|
||||||
if (relayURL in relays) return
|
|
||||||
|
|
||||||
let relay = relayConnect(url, notice => {
|
|
||||||
propagateNotice(notice, relayURL)
|
|
||||||
})
|
|
||||||
relays[relayURL] = {relay, policy}
|
|
||||||
|
|
||||||
if (policy.read) {
|
|
||||||
Object.values(activeSubscriptions).forEach(subscription =>
|
|
||||||
subscription.addRelay(relay)
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
return relay
|
|
||||||
},
|
|
||||||
removeRelay(url) {
|
|
||||||
let relayURL = normalizeRelayURL(url)
|
|
||||||
let data = relays[relayURL]
|
|
||||||
if (!data) return
|
|
||||||
|
|
||||||
let {relay} = data
|
|
||||||
Object.values(activeSubscriptions).forEach(subscription =>
|
|
||||||
subscription.removeRelay(relay)
|
|
||||||
)
|
|
||||||
relay.close()
|
|
||||||
delete relays[relayURL]
|
|
||||||
},
|
|
||||||
onNotice(cb) {
|
|
||||||
noticeCallbacks.push(cb)
|
|
||||||
},
|
|
||||||
offNotice(cb) {
|
|
||||||
let index = noticeCallbacks.indexOf(cb)
|
|
||||||
if (index !== -1) noticeCallbacks.splice(index, 1)
|
|
||||||
},
|
|
||||||
async publish(event, statusCallback) {
|
|
||||||
event.id = getEventHash(event)
|
|
||||||
|
|
||||||
if (!event.sig) {
|
|
||||||
event.tags = event.tags || []
|
|
||||||
|
|
||||||
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, provide a signing function or pass a private key while initializing this relay pool so it can be signed automatically."
|
|
||||||
)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
let writeable = Object.values(relays)
|
|
||||||
.filter(({policy}) => policy.write)
|
|
||||||
.sort(() => Math.random() - 0.5) // random
|
|
||||||
|
|
||||||
let maxTargets = poolPolicy.randomChoice
|
|
||||||
? poolPolicy.randomChoice
|
|
||||||
: writeable.length
|
|
||||||
|
|
||||||
let successes = 0
|
|
||||||
|
|
||||||
if (poolPolicy.wait) {
|
|
||||||
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 => {
|
|
||||||
if (statusCallback) statusCallback(status, relay.url)
|
|
||||||
resolve()
|
|
||||||
})
|
|
||||||
} catch (err) {
|
|
||||||
if (statusCallback) statusCallback(-1, relay.url)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
|
|
||||||
successes++
|
|
||||||
if (successes >= maxTargets) {
|
|
||||||
break
|
|
||||||
}
|
|
||||||
} catch (err) {
|
|
||||||
/***/
|
|
||||||
}
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
writeable.forEach(async ({relay}) => {
|
|
||||||
let callback = statusCallback
|
|
||||||
? status => statusCallback(status, relay.url)
|
|
||||||
: null
|
|
||||||
relay.publish(event, callback)
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
return event
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
27
pool.ts
Normal file
27
pool.ts
Normal file
@@ -0,0 +1,27 @@
|
|||||||
|
import {Relay, relayInit} from './relay'
|
||||||
|
import {normalizeURL} from './utils'
|
||||||
|
|
||||||
|
export function pool(defaultRelays: string[] = []) {
|
||||||
|
return new SimplePool(defaultRelays)
|
||||||
|
}
|
||||||
|
|
||||||
|
class SimplePool {
|
||||||
|
private _conn: {[url: string]: Relay}
|
||||||
|
private _knownIds: Set<string> = new Set()
|
||||||
|
|
||||||
|
constructor(defaultRelays: string[]) {
|
||||||
|
this._conn = {}
|
||||||
|
defaultRelays.forEach(this.ensureRelay)
|
||||||
|
}
|
||||||
|
|
||||||
|
ensureRelay(url: string): Relay {
|
||||||
|
const nm = normalizeURL(url)
|
||||||
|
const existing = this._conn[nm]
|
||||||
|
if (existing) return existing
|
||||||
|
|
||||||
|
const hasEventId = (id: string): boolean => this._knownIds.has(id)
|
||||||
|
const relay = relayInit(nm, hasEventId)
|
||||||
|
this._conn[nm] = relay
|
||||||
|
return relay
|
||||||
|
}
|
||||||
|
}
|
||||||
192
relay.js
192
relay.js
@@ -1,192 +0,0 @@
|
|||||||
/* global WebSocket */
|
|
||||||
|
|
||||||
import 'websocket-polyfill'
|
|
||||||
|
|
||||||
import {verifySignature, validateEvent} from './event'
|
|
||||||
import {matchFilters} from './filter'
|
|
||||||
|
|
||||||
export function normalizeRelayURL(url) {
|
|
||||||
let [host, ...qs] = url.trim().split('?')
|
|
||||||
if (host.slice(0, 4) === 'http') host = 'ws' + host.slice(4)
|
|
||||||
if (host.slice(0, 2) !== 'ws') host = 'wss://' + host
|
|
||||||
if (host.length && host[host.length - 1] === '/') host = host.slice(0, -1)
|
|
||||||
return [host, ...qs].join('?')
|
|
||||||
}
|
|
||||||
|
|
||||||
export function relayConnect(url, onNotice = () => {}, onError = () => {}) {
|
|
||||||
url = normalizeRelayURL(url)
|
|
||||||
|
|
||||||
var ws, resolveOpen, untilOpen, wasClosed
|
|
||||||
var openSubs = {}
|
|
||||||
let attemptNumber = 1
|
|
||||||
let nextAttemptSeconds = 1
|
|
||||||
|
|
||||||
function resetOpenState() {
|
|
||||||
untilOpen = new Promise(resolve => {
|
|
||||||
resolveOpen = resolve
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
var channels = {}
|
|
||||||
|
|
||||||
function connect() {
|
|
||||||
ws = new WebSocket(url)
|
|
||||||
|
|
||||||
ws.onopen = () => {
|
|
||||||
console.log('connected to', url)
|
|
||||||
resolveOpen()
|
|
||||||
|
|
||||||
// restablish old subscriptions
|
|
||||||
if (wasClosed) {
|
|
||||||
wasClosed = false
|
|
||||||
for (let channel in openSubs) {
|
|
||||||
let filters = openSubs[channel]
|
|
||||||
let cb = channels[channel]
|
|
||||||
sub({cb, filter: filters}, channel)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
ws.onerror = err => {
|
|
||||||
console.log('error connecting to relay', url)
|
|
||||||
onError(err)
|
|
||||||
}
|
|
||||||
ws.onclose = () => {
|
|
||||||
resetOpenState()
|
|
||||||
attemptNumber++
|
|
||||||
nextAttemptSeconds += attemptNumber ** 3
|
|
||||||
if (nextAttemptSeconds > 14400) {
|
|
||||||
nextAttemptSeconds = 14400 // 4 hours
|
|
||||||
}
|
|
||||||
console.log(
|
|
||||||
`relay ${url} connection closed. reconnecting in ${nextAttemptSeconds} seconds.`
|
|
||||||
)
|
|
||||||
setTimeout(async () => {
|
|
||||||
try {
|
|
||||||
connect()
|
|
||||||
} catch (err) {}
|
|
||||||
}, nextAttemptSeconds * 1000)
|
|
||||||
|
|
||||||
wasClosed = true
|
|
||||||
}
|
|
||||||
|
|
||||||
ws.onmessage = async e => {
|
|
||||||
var data
|
|
||||||
try {
|
|
||||||
data = JSON.parse(e.data)
|
|
||||||
} catch (err) {
|
|
||||||
data = e.data
|
|
||||||
}
|
|
||||||
|
|
||||||
if (data.length > 1) {
|
|
||||||
if (data[0] === 'NOTICE') {
|
|
||||||
if (data.length < 2) return
|
|
||||||
|
|
||||||
console.log('message from relay ' + url + ': ' + data[1])
|
|
||||||
onNotice(data[1])
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
if (data[0] === 'EVENT') {
|
|
||||||
if (data.length < 3) return
|
|
||||||
|
|
||||||
let channel = data[1]
|
|
||||||
let event = data[2]
|
|
||||||
|
|
||||||
if (
|
|
||||||
validateEvent(event) &&
|
|
||||||
verifySignature(event) &&
|
|
||||||
channels[channel] &&
|
|
||||||
matchFilters(openSubs[channel], event)
|
|
||||||
) {
|
|
||||||
channels[channel](event)
|
|
||||||
}
|
|
||||||
return
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
resetOpenState()
|
|
||||||
|
|
||||||
try {
|
|
||||||
connect()
|
|
||||||
} catch (err) {}
|
|
||||||
|
|
||||||
async function trySend(params) {
|
|
||||||
let msg = JSON.stringify(params)
|
|
||||||
|
|
||||||
await untilOpen
|
|
||||||
ws.send(msg)
|
|
||||||
}
|
|
||||||
|
|
||||||
const sub = (
|
|
||||||
{cb, filter, beforeSend},
|
|
||||||
channel = Math.random().toString().slice(2)
|
|
||||||
) => {
|
|
||||||
var filters = []
|
|
||||||
if (Array.isArray(filter)) {
|
|
||||||
filters = filter
|
|
||||||
} else {
|
|
||||||
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,
|
|
||||||
beforeSend = activeBeforeSend
|
|
||||||
}) => sub({cb, filter, beforeSend}, channel),
|
|
||||||
unsub: () => {
|
|
||||||
delete openSubs[channel]
|
|
||||||
delete channels[channel]
|
|
||||||
trySend(['CLOSE', channel])
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return {
|
|
||||||
url,
|
|
||||||
sub,
|
|
||||||
async publish(event, statusCallback) {
|
|
||||||
try {
|
|
||||||
await trySend(['EVENT', event])
|
|
||||||
if (statusCallback) {
|
|
||||||
statusCallback(0)
|
|
||||||
let {unsub} = sub(
|
|
||||||
{
|
|
||||||
cb: () => {
|
|
||||||
statusCallback(1)
|
|
||||||
unsub()
|
|
||||||
clearTimeout(willUnsub)
|
|
||||||
},
|
|
||||||
filter: {ids: [event.id]}
|
|
||||||
},
|
|
||||||
`monitor-${event.id.slice(0, 5)}`
|
|
||||||
)
|
|
||||||
let willUnsub = setTimeout(unsub, 5000)
|
|
||||||
}
|
|
||||||
} catch (err) {
|
|
||||||
if (statusCallback) statusCallback(-1)
|
|
||||||
}
|
|
||||||
},
|
|
||||||
close() {
|
|
||||||
ws.close()
|
|
||||||
},
|
|
||||||
get status() {
|
|
||||||
return ws.readyState
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
114
relay.test.js
Normal file
114
relay.test.js
Normal file
@@ -0,0 +1,114 @@
|
|||||||
|
/* eslint-env jest */
|
||||||
|
|
||||||
|
require('websocket-polyfill')
|
||||||
|
const {
|
||||||
|
relayInit,
|
||||||
|
generatePrivateKey,
|
||||||
|
getPublicKey,
|
||||||
|
getEventHash,
|
||||||
|
signEvent
|
||||||
|
} = require('./lib/nostr.cjs')
|
||||||
|
|
||||||
|
let relay = relayInit('wss://nostr-dev.wellorder.net/')
|
||||||
|
|
||||||
|
beforeAll(() => {
|
||||||
|
relay.connect()
|
||||||
|
})
|
||||||
|
|
||||||
|
afterAll(async () => {
|
||||||
|
await relay.close()
|
||||||
|
})
|
||||||
|
|
||||||
|
test('connectivity', () => {
|
||||||
|
return expect(
|
||||||
|
new Promise(resolve => {
|
||||||
|
relay.on('connect', () => {
|
||||||
|
resolve(true)
|
||||||
|
})
|
||||||
|
relay.on('error', () => {
|
||||||
|
resolve(false)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
).resolves.toBe(true)
|
||||||
|
})
|
||||||
|
|
||||||
|
test('querying', () => {
|
||||||
|
var resolve1
|
||||||
|
var resolve2
|
||||||
|
|
||||||
|
let sub = relay.sub([
|
||||||
|
{
|
||||||
|
ids: ['d7dd5eb3ab747e16f8d0212d53032ea2a7cadef53837e5a6c66d42849fcb9027']
|
||||||
|
}
|
||||||
|
])
|
||||||
|
sub.on('event', event => {
|
||||||
|
expect(event).toHaveProperty(
|
||||||
|
'id',
|
||||||
|
'd7dd5eb3ab747e16f8d0212d53032ea2a7cadef53837e5a6c66d42849fcb9027'
|
||||||
|
)
|
||||||
|
resolve1(true)
|
||||||
|
})
|
||||||
|
sub.on('eose', () => {
|
||||||
|
resolve2(true)
|
||||||
|
})
|
||||||
|
|
||||||
|
return expect(
|
||||||
|
Promise.all([
|
||||||
|
new Promise(resolve => {
|
||||||
|
resolve1 = resolve
|
||||||
|
}),
|
||||||
|
new Promise(resolve => {
|
||||||
|
resolve2 = resolve
|
||||||
|
})
|
||||||
|
])
|
||||||
|
).resolves.toEqual([true, true])
|
||||||
|
})
|
||||||
|
|
||||||
|
test('listening (twice) and publishing', async () => {
|
||||||
|
let sk = generatePrivateKey()
|
||||||
|
let pk = getPublicKey(sk)
|
||||||
|
var resolve1
|
||||||
|
var resolve2
|
||||||
|
|
||||||
|
let sub = relay.sub([
|
||||||
|
{
|
||||||
|
kinds: [27572],
|
||||||
|
authors: [pk]
|
||||||
|
}
|
||||||
|
])
|
||||||
|
|
||||||
|
sub.on('event', event => {
|
||||||
|
expect(event).toHaveProperty('pubkey', pk)
|
||||||
|
expect(event).toHaveProperty('kind', 27572)
|
||||||
|
expect(event).toHaveProperty('content', 'nostr-tools test suite')
|
||||||
|
resolve1(true)
|
||||||
|
})
|
||||||
|
sub.on('event', event => {
|
||||||
|
expect(event).toHaveProperty('pubkey', pk)
|
||||||
|
expect(event).toHaveProperty('kind', 27572)
|
||||||
|
expect(event).toHaveProperty('content', 'nostr-tools test suite')
|
||||||
|
resolve2(true)
|
||||||
|
})
|
||||||
|
|
||||||
|
let event = {
|
||||||
|
kind: 27572,
|
||||||
|
pubkey: pk,
|
||||||
|
created_at: Math.floor(Date.now() / 1000),
|
||||||
|
tags: [],
|
||||||
|
content: 'nostr-tools test suite'
|
||||||
|
}
|
||||||
|
event.id = getEventHash(event)
|
||||||
|
event.sig = signEvent(event, sk)
|
||||||
|
|
||||||
|
relay.publish(event)
|
||||||
|
return expect(
|
||||||
|
Promise.all([
|
||||||
|
new Promise(resolve => {
|
||||||
|
resolve1 = resolve
|
||||||
|
}),
|
||||||
|
new Promise(resolve => {
|
||||||
|
resolve2 = resolve
|
||||||
|
})
|
||||||
|
])
|
||||||
|
).resolves.toEqual([true, true])
|
||||||
|
})
|
||||||
293
relay.ts
Normal file
293
relay.ts
Normal file
@@ -0,0 +1,293 @@
|
|||||||
|
/* global WebSocket */
|
||||||
|
|
||||||
|
import {Event, verifySignature, validateEvent} from './event'
|
||||||
|
import {Filter, matchFilters} from './filter'
|
||||||
|
import {getHex64} from './fakejson'
|
||||||
|
|
||||||
|
type RelayEvent = 'connect' | 'disconnect' | 'error' | 'notice'
|
||||||
|
|
||||||
|
export type Relay = {
|
||||||
|
url: string
|
||||||
|
status: number
|
||||||
|
connect: () => Promise<void>
|
||||||
|
close: () => Promise<void>
|
||||||
|
sub: (filters: Filter[], opts?: SubscriptionOptions) => Sub
|
||||||
|
publish: (event: Event) => Pub
|
||||||
|
on: (type: RelayEvent, cb: any) => void
|
||||||
|
off: (type: RelayEvent, cb: any) => void
|
||||||
|
}
|
||||||
|
export type Pub = {
|
||||||
|
on: (type: 'ok' | 'seen' | 'failed', cb: any) => void
|
||||||
|
off: (type: 'ok' | 'seen' | 'failed', cb: any) => void
|
||||||
|
}
|
||||||
|
export type Sub = {
|
||||||
|
sub: (filters: Filter[], opts: SubscriptionOptions) => Sub
|
||||||
|
unsub: () => void
|
||||||
|
on: (type: 'event' | 'eose', cb: any) => void
|
||||||
|
off: (type: 'event' | 'eose', cb: any) => void
|
||||||
|
}
|
||||||
|
|
||||||
|
type SubscriptionOptions = {
|
||||||
|
skipVerification?: boolean
|
||||||
|
id?: string
|
||||||
|
}
|
||||||
|
|
||||||
|
export function relayInit(
|
||||||
|
url: string,
|
||||||
|
alreadyHaveEvent: (id: string) => boolean = () => false
|
||||||
|
): Relay {
|
||||||
|
var ws: WebSocket
|
||||||
|
var resolveClose: () => void
|
||||||
|
var setOpen: (value: PromiseLike<void> | void) => void
|
||||||
|
var untilOpen = new Promise<void>(resolve => {
|
||||||
|
setOpen = resolve
|
||||||
|
})
|
||||||
|
var openSubs: {[id: string]: {filters: Filter[]} & SubscriptionOptions} = {}
|
||||||
|
var listeners: {
|
||||||
|
connect: Array<() => void>
|
||||||
|
disconnect: Array<() => void>
|
||||||
|
error: Array<(e: globalThis.Event) => void>
|
||||||
|
notice: Array<(msg: string) => void>
|
||||||
|
} = {
|
||||||
|
connect: [],
|
||||||
|
disconnect: [],
|
||||||
|
error: [],
|
||||||
|
notice: []
|
||||||
|
}
|
||||||
|
var subListeners: {
|
||||||
|
[subid: string]: {
|
||||||
|
event: Array<(event: Event) => void>
|
||||||
|
eose: Array<() => void>
|
||||||
|
}
|
||||||
|
} = {}
|
||||||
|
var pubListeners: {
|
||||||
|
[eventid: string]: {
|
||||||
|
ok: Array<() => void>
|
||||||
|
seen: Array<() => void>
|
||||||
|
failed: Array<(reason: string) => void>
|
||||||
|
}
|
||||||
|
} = {}
|
||||||
|
|
||||||
|
async function connectRelay(): Promise<void> {
|
||||||
|
return new Promise((resolve, reject) => {
|
||||||
|
ws = new WebSocket(url)
|
||||||
|
|
||||||
|
ws.onopen = () => {
|
||||||
|
listeners.connect.forEach(cb => cb())
|
||||||
|
setOpen()
|
||||||
|
resolve()
|
||||||
|
}
|
||||||
|
ws.onerror = (e: globalThis.Event) => {
|
||||||
|
listeners.error.forEach(cb => cb(e))
|
||||||
|
reject(e)
|
||||||
|
}
|
||||||
|
ws.onclose = async () => {
|
||||||
|
listeners.disconnect.forEach(cb => cb())
|
||||||
|
resolveClose && resolveClose()
|
||||||
|
}
|
||||||
|
|
||||||
|
let incomingMessageQueue: string[] = []
|
||||||
|
let handleNextInterval: any
|
||||||
|
|
||||||
|
ws.onmessage = e => {
|
||||||
|
incomingMessageQueue.push(e.data)
|
||||||
|
if (!handleNextInterval) {
|
||||||
|
handleNextInterval = setInterval(handleNext, 0)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function handleNext() {
|
||||||
|
if (incomingMessageQueue.length === 0) {
|
||||||
|
clearInterval(handleNextInterval)
|
||||||
|
handleNextInterval = null
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
var json = incomingMessageQueue.shift()
|
||||||
|
if (!json || alreadyHaveEvent(getHex64(json, 'id'))) {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
let data = JSON.parse(json)
|
||||||
|
|
||||||
|
// we won't do any checks against the data since all failures (i.e. invalid messages from relays)
|
||||||
|
// will naturally be caught by the encompassing try..catch block
|
||||||
|
|
||||||
|
switch (data[0]) {
|
||||||
|
case 'EVENT':
|
||||||
|
let id = data[1]
|
||||||
|
let event = data[2]
|
||||||
|
if (
|
||||||
|
validateEvent(event) &&
|
||||||
|
openSubs[id] &&
|
||||||
|
(openSubs[id].skipVerification || verifySignature(event)) &&
|
||||||
|
matchFilters(openSubs[id].filters, event)
|
||||||
|
) {
|
||||||
|
openSubs[id]
|
||||||
|
;(subListeners[id]?.event || []).forEach(cb => cb(event))
|
||||||
|
}
|
||||||
|
return
|
||||||
|
case 'EOSE': {
|
||||||
|
let id = data[1]
|
||||||
|
;(subListeners[id]?.eose || []).forEach(cb => cb())
|
||||||
|
return
|
||||||
|
}
|
||||||
|
case 'OK': {
|
||||||
|
let id: string = data[1]
|
||||||
|
let ok: boolean = data[2]
|
||||||
|
let reason: string = data[3] || ''
|
||||||
|
if (ok) pubListeners[id]?.ok.forEach(cb => cb())
|
||||||
|
else pubListeners[id]?.failed.forEach(cb => cb(reason))
|
||||||
|
return
|
||||||
|
}
|
||||||
|
case 'NOTICE':
|
||||||
|
let notice = data[1]
|
||||||
|
listeners.notice.forEach(cb => cb(notice))
|
||||||
|
return
|
||||||
|
}
|
||||||
|
} catch (err) {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
async function connect(): Promise<void> {
|
||||||
|
if (ws?.readyState && ws.readyState === 1) return // ws already open
|
||||||
|
await connectRelay()
|
||||||
|
}
|
||||||
|
|
||||||
|
async function trySend(params: [string, ...any]) {
|
||||||
|
let msg = JSON.stringify(params)
|
||||||
|
|
||||||
|
await untilOpen
|
||||||
|
try {
|
||||||
|
ws.send(msg)
|
||||||
|
} catch (err) {
|
||||||
|
console.log(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const sub = (
|
||||||
|
filters: Filter[],
|
||||||
|
{
|
||||||
|
skipVerification = false,
|
||||||
|
id = Math.random().toString().slice(2)
|
||||||
|
}: SubscriptionOptions = {}
|
||||||
|
): Sub => {
|
||||||
|
let subid = id
|
||||||
|
|
||||||
|
openSubs[subid] = {
|
||||||
|
id: subid,
|
||||||
|
filters,
|
||||||
|
skipVerification
|
||||||
|
}
|
||||||
|
trySend(['REQ', subid, ...filters])
|
||||||
|
|
||||||
|
return {
|
||||||
|
sub: (newFilters, newOpts = {}) =>
|
||||||
|
sub(newFilters || filters, {
|
||||||
|
skipVerification: newOpts.skipVerification || skipVerification,
|
||||||
|
id: subid
|
||||||
|
}),
|
||||||
|
unsub: () => {
|
||||||
|
delete openSubs[subid]
|
||||||
|
delete subListeners[subid]
|
||||||
|
trySend(['CLOSE', subid])
|
||||||
|
},
|
||||||
|
on: (type: 'event' | 'eose', cb: any): void => {
|
||||||
|
subListeners[subid] = subListeners[subid] || {
|
||||||
|
event: [],
|
||||||
|
eose: []
|
||||||
|
}
|
||||||
|
subListeners[subid][type].push(cb)
|
||||||
|
},
|
||||||
|
off: (type: 'event' | 'eose', cb: any): void => {
|
||||||
|
let listeners = subListeners[subid]
|
||||||
|
let idx = listeners[type].indexOf(cb)
|
||||||
|
if (idx >= 0) listeners[type].splice(idx, 1)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return {
|
||||||
|
url,
|
||||||
|
sub,
|
||||||
|
on: (type: RelayEvent, cb: any): void => {
|
||||||
|
listeners[type].push(cb)
|
||||||
|
if (type === 'connect' && ws?.readyState === 1) {
|
||||||
|
cb()
|
||||||
|
}
|
||||||
|
},
|
||||||
|
off: (type: RelayEvent, cb: any): void => {
|
||||||
|
let index = listeners[type].indexOf(cb)
|
||||||
|
if (index !== -1) listeners[type].splice(index, 1)
|
||||||
|
},
|
||||||
|
publish(event: Event): Pub {
|
||||||
|
if (!event.id) throw new Error(`event ${event} has no id`)
|
||||||
|
let id = event.id
|
||||||
|
|
||||||
|
var sent = false
|
||||||
|
var mustMonitor = false
|
||||||
|
|
||||||
|
trySend(['EVENT', event])
|
||||||
|
.then(() => {
|
||||||
|
sent = true
|
||||||
|
if (mustMonitor) {
|
||||||
|
startMonitoring()
|
||||||
|
mustMonitor = false
|
||||||
|
}
|
||||||
|
})
|
||||||
|
.catch(() => {})
|
||||||
|
|
||||||
|
const startMonitoring = () => {
|
||||||
|
let monitor = sub([{ids: [id]}], {
|
||||||
|
id: `monitor-${id.slice(0, 5)}`
|
||||||
|
})
|
||||||
|
let willUnsub = setTimeout(() => {
|
||||||
|
;(pubListeners[id]?.failed || []).forEach(cb =>
|
||||||
|
cb('event not seen after 5 seconds')
|
||||||
|
)
|
||||||
|
monitor.unsub()
|
||||||
|
}, 5000)
|
||||||
|
monitor.on('event', () => {
|
||||||
|
clearTimeout(willUnsub)
|
||||||
|
;(pubListeners[id]?.seen || []).forEach(cb => cb())
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
return {
|
||||||
|
on: (type: 'ok' | 'seen' | 'failed', cb: any) => {
|
||||||
|
pubListeners[id] = pubListeners[id] || {
|
||||||
|
ok: [],
|
||||||
|
seen: [],
|
||||||
|
failed: []
|
||||||
|
}
|
||||||
|
pubListeners[id][type].push(cb)
|
||||||
|
|
||||||
|
if (type === 'seen') {
|
||||||
|
if (sent) startMonitoring()
|
||||||
|
else mustMonitor = true
|
||||||
|
}
|
||||||
|
},
|
||||||
|
off: (type: 'ok' | 'seen' | 'failed', cb: any) => {
|
||||||
|
let listeners = pubListeners[id]
|
||||||
|
if (!listeners) return
|
||||||
|
let idx = listeners[type].indexOf(cb)
|
||||||
|
if (idx >= 0) listeners[type].splice(idx, 1)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
connect,
|
||||||
|
close(): Promise<void> {
|
||||||
|
ws.close()
|
||||||
|
return new Promise<void>(resolve => {
|
||||||
|
resolveClose = resolve
|
||||||
|
})
|
||||||
|
},
|
||||||
|
get status() {
|
||||||
|
return ws?.readyState ?? 3
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
15
tsconfig.json
Normal file
15
tsconfig.json
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
{
|
||||||
|
"compilerOptions": {
|
||||||
|
"module": "esnext",
|
||||||
|
"target": "esnext",
|
||||||
|
"lib": ["dom", "dom.iterable", "esnext"],
|
||||||
|
"declaration": true,
|
||||||
|
"strict": true,
|
||||||
|
"moduleResolution": "node",
|
||||||
|
"skipLibCheck": true,
|
||||||
|
"esModuleInterop": true,
|
||||||
|
"emitDeclarationOnly": true,
|
||||||
|
"outDir": "dist",
|
||||||
|
"rootDir": "."
|
||||||
|
}
|
||||||
|
}
|
||||||
183
utils.test.js
Normal file
183
utils.test.js
Normal file
@@ -0,0 +1,183 @@
|
|||||||
|
/* eslint-env jest */
|
||||||
|
|
||||||
|
const {utils} = require('./lib/nostr.cjs')
|
||||||
|
|
||||||
|
const {insertEventIntoAscendingList, insertEventIntoDescendingList} = utils
|
||||||
|
|
||||||
|
describe('inserting into a desc sorted list of events', () => {
|
||||||
|
test('insert into an empty list', async () => {
|
||||||
|
const list0 = []
|
||||||
|
expect(
|
||||||
|
insertEventIntoDescendingList(list0, {id: 'abc', created_at: 10})
|
||||||
|
).toHaveLength(1)
|
||||||
|
})
|
||||||
|
|
||||||
|
test('insert in the beginning of a list', async () => {
|
||||||
|
const list0 = [{created_at: 20}, {created_at: 10}]
|
||||||
|
const list1 = insertEventIntoDescendingList(list0, {
|
||||||
|
id: 'abc',
|
||||||
|
created_at: 30
|
||||||
|
})
|
||||||
|
expect(list1).toHaveLength(3)
|
||||||
|
expect(list1[0].id).toBe('abc')
|
||||||
|
})
|
||||||
|
|
||||||
|
test('insert in the beginning of a list with same created_at', async () => {
|
||||||
|
const list0 = [{created_at: 30}, {created_at: 20}, {created_at: 10}]
|
||||||
|
const list1 = insertEventIntoDescendingList(list0, {
|
||||||
|
id: 'abc',
|
||||||
|
created_at: 30
|
||||||
|
})
|
||||||
|
expect(list1).toHaveLength(4)
|
||||||
|
expect(list1[0].id).toBe('abc')
|
||||||
|
})
|
||||||
|
|
||||||
|
test('insert in the middle of a list', async () => {
|
||||||
|
const list0 = [
|
||||||
|
{created_at: 30},
|
||||||
|
{created_at: 20},
|
||||||
|
{created_at: 10},
|
||||||
|
{created_at: 1}
|
||||||
|
]
|
||||||
|
const list1 = insertEventIntoDescendingList(list0, {
|
||||||
|
id: 'abc',
|
||||||
|
created_at: 15
|
||||||
|
})
|
||||||
|
expect(list1).toHaveLength(5)
|
||||||
|
expect(list1[2].id).toBe('abc')
|
||||||
|
})
|
||||||
|
|
||||||
|
test('insert in the end of a list', async () => {
|
||||||
|
const list0 = [
|
||||||
|
{created_at: 20},
|
||||||
|
{created_at: 20},
|
||||||
|
{created_at: 20},
|
||||||
|
{created_at: 20},
|
||||||
|
{created_at: 10}
|
||||||
|
]
|
||||||
|
const list1 = insertEventIntoDescendingList(list0, {
|
||||||
|
id: 'abc',
|
||||||
|
created_at: 5
|
||||||
|
})
|
||||||
|
expect(list1).toHaveLength(6)
|
||||||
|
expect(list1.slice(-1)[0].id).toBe('abc')
|
||||||
|
})
|
||||||
|
|
||||||
|
test('insert in the last-to-end of a list with same created_at', async () => {
|
||||||
|
const list0 = [
|
||||||
|
{created_at: 20},
|
||||||
|
{created_at: 20},
|
||||||
|
{created_at: 20},
|
||||||
|
{created_at: 20},
|
||||||
|
{created_at: 10}
|
||||||
|
]
|
||||||
|
const list1 = insertEventIntoDescendingList(list0, {
|
||||||
|
id: 'abc',
|
||||||
|
created_at: 10
|
||||||
|
})
|
||||||
|
expect(list1).toHaveLength(6)
|
||||||
|
expect(list1.slice(-2)[0].id).toBe('abc')
|
||||||
|
})
|
||||||
|
|
||||||
|
test('do not insert duplicates', async () => {
|
||||||
|
const list0 = [
|
||||||
|
{created_at: 20},
|
||||||
|
{created_at: 20},
|
||||||
|
{created_at: 10, id: 'abc'}
|
||||||
|
]
|
||||||
|
const list1 = insertEventIntoDescendingList(list0, {
|
||||||
|
id: 'abc',
|
||||||
|
created_at: 10
|
||||||
|
})
|
||||||
|
expect(list1).toHaveLength(3)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('inserting into a asc sorted list of events', () => {
|
||||||
|
test('insert into an empty list', async () => {
|
||||||
|
const list0 = []
|
||||||
|
expect(
|
||||||
|
insertEventIntoAscendingList(list0, {id: 'abc', created_at: 10})
|
||||||
|
).toHaveLength(1)
|
||||||
|
})
|
||||||
|
|
||||||
|
test('insert in the beginning of a list', async () => {
|
||||||
|
const list0 = [{created_at: 10}, {created_at: 20}]
|
||||||
|
const list1 = insertEventIntoAscendingList(list0, {
|
||||||
|
id: 'abc',
|
||||||
|
created_at: 1
|
||||||
|
})
|
||||||
|
expect(list1).toHaveLength(3)
|
||||||
|
expect(list1[0].id).toBe('abc')
|
||||||
|
})
|
||||||
|
|
||||||
|
test('insert in the beginning of a list with same created_at', async () => {
|
||||||
|
const list0 = [{created_at: 10}, {created_at: 20}, {created_at: 30}]
|
||||||
|
const list1 = insertEventIntoAscendingList(list0, {
|
||||||
|
id: 'abc',
|
||||||
|
created_at: 10
|
||||||
|
})
|
||||||
|
expect(list1).toHaveLength(4)
|
||||||
|
expect(list1[0].id).toBe('abc')
|
||||||
|
})
|
||||||
|
|
||||||
|
test('insert in the middle of a list', async () => {
|
||||||
|
const list0 = [
|
||||||
|
{created_at: 10},
|
||||||
|
{created_at: 20},
|
||||||
|
{created_at: 30},
|
||||||
|
{created_at: 40}
|
||||||
|
]
|
||||||
|
const list1 = insertEventIntoAscendingList(list0, {
|
||||||
|
id: 'abc',
|
||||||
|
created_at: 25
|
||||||
|
})
|
||||||
|
expect(list1).toHaveLength(5)
|
||||||
|
expect(list1[2].id).toBe('abc')
|
||||||
|
})
|
||||||
|
|
||||||
|
test('insert in the end of a list', async () => {
|
||||||
|
const list0 = [
|
||||||
|
{created_at: 20},
|
||||||
|
{created_at: 20},
|
||||||
|
{created_at: 20},
|
||||||
|
{created_at: 20},
|
||||||
|
{created_at: 40}
|
||||||
|
]
|
||||||
|
const list1 = insertEventIntoAscendingList(list0, {
|
||||||
|
id: 'abc',
|
||||||
|
created_at: 50
|
||||||
|
})
|
||||||
|
expect(list1).toHaveLength(6)
|
||||||
|
expect(list1.slice(-1)[0].id).toBe('abc')
|
||||||
|
})
|
||||||
|
|
||||||
|
test('insert in the last-to-end of a list with same created_at', async () => {
|
||||||
|
const list0 = [
|
||||||
|
{created_at: 20},
|
||||||
|
{created_at: 20},
|
||||||
|
{created_at: 20},
|
||||||
|
{created_at: 20},
|
||||||
|
{created_at: 30}
|
||||||
|
]
|
||||||
|
const list1 = insertEventIntoAscendingList(list0, {
|
||||||
|
id: 'abc',
|
||||||
|
created_at: 30
|
||||||
|
})
|
||||||
|
expect(list1).toHaveLength(6)
|
||||||
|
expect(list1.slice(-2)[0].id).toBe('abc')
|
||||||
|
})
|
||||||
|
|
||||||
|
test('do not insert duplicates', async () => {
|
||||||
|
const list0 = [
|
||||||
|
{created_at: 20},
|
||||||
|
{created_at: 20},
|
||||||
|
{created_at: 30, id: 'abc'}
|
||||||
|
]
|
||||||
|
const list1 = insertEventIntoAscendingList(list0, {
|
||||||
|
id: 'abc',
|
||||||
|
created_at: 30
|
||||||
|
})
|
||||||
|
expect(list1).toHaveLength(3)
|
||||||
|
})
|
||||||
|
})
|
||||||
111
utils.ts
Normal file
111
utils.ts
Normal file
@@ -0,0 +1,111 @@
|
|||||||
|
import {Event} from './event'
|
||||||
|
|
||||||
|
export const utf8Decoder = new TextDecoder('utf-8')
|
||||||
|
export const utf8Encoder = new TextEncoder()
|
||||||
|
|
||||||
|
export function normalizeURL(url: string): string {
|
||||||
|
let p = new URL(url)
|
||||||
|
p.pathname = p.pathname.replace(/\/+/g, '/')
|
||||||
|
if (p.pathname.endsWith('/')) p.pathname = p.pathname.slice(0, -1)
|
||||||
|
if (
|
||||||
|
(p.port === '80' && p.protocol === 'ws:') ||
|
||||||
|
(p.port === '443' && p.protocol === 'wss:')
|
||||||
|
)
|
||||||
|
p.port = ''
|
||||||
|
p.searchParams.sort()
|
||||||
|
p.hash = ''
|
||||||
|
return p.toString()
|
||||||
|
}
|
||||||
|
|
||||||
|
//
|
||||||
|
// fast insert-into-sorted-array functions adapted from https://github.com/terrymorse58/fast-sorted-array
|
||||||
|
//
|
||||||
|
export function insertEventIntoDescendingList(
|
||||||
|
sortedArray: Event[],
|
||||||
|
event: Event
|
||||||
|
) {
|
||||||
|
let start = 0
|
||||||
|
let end = sortedArray.length - 1
|
||||||
|
let midPoint
|
||||||
|
let position = start
|
||||||
|
|
||||||
|
if (end < 0) {
|
||||||
|
position = 0
|
||||||
|
} else if (event.created_at < sortedArray[end].created_at) {
|
||||||
|
position = end + 1
|
||||||
|
} else if (event.created_at >= sortedArray[start].created_at) {
|
||||||
|
position = start
|
||||||
|
} else
|
||||||
|
while (true) {
|
||||||
|
if (end <= start + 1) {
|
||||||
|
position = end
|
||||||
|
break
|
||||||
|
}
|
||||||
|
midPoint = Math.floor(start + (end - start) / 2)
|
||||||
|
if (sortedArray[midPoint].created_at > event.created_at) {
|
||||||
|
start = midPoint
|
||||||
|
} else if (sortedArray[midPoint].created_at < event.created_at) {
|
||||||
|
end = midPoint
|
||||||
|
} else {
|
||||||
|
// aMidPoint === num
|
||||||
|
position = midPoint
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// insert when num is NOT already in (no duplicates)
|
||||||
|
if (sortedArray[position]?.id !== event.id) {
|
||||||
|
return [
|
||||||
|
...sortedArray.slice(0, position),
|
||||||
|
event,
|
||||||
|
...sortedArray.slice(position)
|
||||||
|
]
|
||||||
|
}
|
||||||
|
|
||||||
|
return sortedArray
|
||||||
|
}
|
||||||
|
|
||||||
|
export function insertEventIntoAscendingList(
|
||||||
|
sortedArray: Event[],
|
||||||
|
event: Event
|
||||||
|
) {
|
||||||
|
let start = 0
|
||||||
|
let end = sortedArray.length - 1
|
||||||
|
let midPoint
|
||||||
|
let position = start
|
||||||
|
|
||||||
|
if (end < 0) {
|
||||||
|
position = 0
|
||||||
|
} else if (event.created_at > sortedArray[end].created_at) {
|
||||||
|
position = end + 1
|
||||||
|
} else if (event.created_at <= sortedArray[start].created_at) {
|
||||||
|
position = start
|
||||||
|
} else
|
||||||
|
while (true) {
|
||||||
|
if (end <= start + 1) {
|
||||||
|
position = end
|
||||||
|
break
|
||||||
|
}
|
||||||
|
midPoint = Math.floor(start + (end - start) / 2)
|
||||||
|
if (sortedArray[midPoint].created_at < event.created_at) {
|
||||||
|
start = midPoint
|
||||||
|
} else if (sortedArray[midPoint].created_at > event.created_at) {
|
||||||
|
end = midPoint
|
||||||
|
} else {
|
||||||
|
// aMidPoint === num
|
||||||
|
position = midPoint
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// insert when num is NOT already in (no duplicates)
|
||||||
|
if (sortedArray[position]?.id !== event.id) {
|
||||||
|
return [
|
||||||
|
...sortedArray.slice(0, position),
|
||||||
|
event,
|
||||||
|
...sortedArray.slice(position)
|
||||||
|
]
|
||||||
|
}
|
||||||
|
|
||||||
|
return sortedArray
|
||||||
|
}
|
||||||
Reference in New Issue
Block a user