mirror of
https://github.com/nbd-wtf/nostr-tools.git
synced 2025-12-08 16:28:49 +00:00
Compare commits
10 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
faf8e62120 | ||
|
|
dc489bf387 | ||
|
|
60ce13e17d | ||
|
|
727bcb05a8 | ||
|
|
c236e41f80 | ||
|
|
f04bc0cee1 | ||
|
|
e63479ee7f | ||
|
|
c47f091d9b | ||
|
|
4c785279bc | ||
|
|
6786641b1d |
1
.gitignore
vendored
1
.gitignore
vendored
@@ -2,3 +2,4 @@ node_modules
|
|||||||
dist
|
dist
|
||||||
yarn.lock
|
yarn.lock
|
||||||
package-lock.json
|
package-lock.json
|
||||||
|
nostr.js
|
||||||
|
|||||||
19
README.md
19
README.md
@@ -15,7 +15,7 @@ pool.addRelay('ws://some.relay.com', {read: true, write: true})
|
|||||||
pool.addRelay('ws://other.relay.cool', {read: true, write: true})
|
pool.addRelay('ws://other.relay.cool', {read: true, write: true})
|
||||||
|
|
||||||
// example callback function for a subscription
|
// example callback function for a subscription
|
||||||
function onEvent(event, relay) => {
|
function onEvent(event, relay) {
|
||||||
console.log(`got an event from ${relay.url} which is already validated.`, event)
|
console.log(`got an event from ${relay.url} which is already validated.`, event)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -70,3 +70,20 @@ pool.addRelay('<url>')
|
|||||||
All functions expect bytearrays as hex strings and output bytearrays as hex strings.
|
All functions expect bytearrays as hex strings and output bytearrays as hex strings.
|
||||||
|
|
||||||
For other utils please read the source (for now).
|
For other utils please read the source (for now).
|
||||||
|
|
||||||
|
### Using from the browser (if you don't want to use a bundler)
|
||||||
|
|
||||||
|
You can import nostr-tools as an ES module. Just add a script tag like this:
|
||||||
|
|
||||||
|
```html
|
||||||
|
<script type="module">
|
||||||
|
import {generatePrivateKey} from 'https://unpkg.com/nostr-tools/nostr.js'
|
||||||
|
console.log(generatePrivateKey())
|
||||||
|
</script>
|
||||||
|
```
|
||||||
|
|
||||||
|
And import whatever function you would import from `"nostr-tools"` in a bundler.
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
Public domain.
|
||||||
|
|||||||
25
build.js
Executable file
25
build.js
Executable file
@@ -0,0 +1,25 @@
|
|||||||
|
#!/usr/bin/env node
|
||||||
|
|
||||||
|
const esbuild = require('esbuild')
|
||||||
|
const alias = require('esbuild-plugin-alias')
|
||||||
|
const nodeGlobals = require('@esbuild-plugins/node-globals-polyfill').default
|
||||||
|
|
||||||
|
const buildOptions = {
|
||||||
|
entryPoints: ['index.js'],
|
||||||
|
outfile: 'nostr.js',
|
||||||
|
bundle: true,
|
||||||
|
format: 'esm',
|
||||||
|
plugins: [
|
||||||
|
alias({
|
||||||
|
stream: require.resolve('readable-stream')
|
||||||
|
}),
|
||||||
|
nodeGlobals({buffer: true})
|
||||||
|
],
|
||||||
|
define: {
|
||||||
|
window: 'self',
|
||||||
|
global: 'self'
|
||||||
|
},
|
||||||
|
loader: {'.js': 'jsx'}
|
||||||
|
}
|
||||||
|
|
||||||
|
esbuild.build(buildOptions).then(() => console.log('build success.'))
|
||||||
4
event.js
4
event.js
@@ -52,5 +52,7 @@ export function verifySignature(event) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
export async function signEvent(event, key) {
|
export async function signEvent(event, key) {
|
||||||
return secp256k1.schnorr.sign(getEventHash(event), key)
|
return Buffer.from(
|
||||||
|
await secp256k1.schnorr.sign(getEventHash(event), key)
|
||||||
|
).toString('hex')
|
||||||
}
|
}
|
||||||
|
|||||||
3
keys.js
3
keys.js
@@ -1,9 +1,10 @@
|
|||||||
import * as secp256k1 from '@noble/secp256k1'
|
import * as secp256k1 from '@noble/secp256k1'
|
||||||
|
import {Buffer} from 'buffer'
|
||||||
|
|
||||||
export function generatePrivateKey() {
|
export function generatePrivateKey() {
|
||||||
return Buffer.from(secp256k1.utils.randomPrivateKey()).toString('hex')
|
return Buffer.from(secp256k1.utils.randomPrivateKey()).toString('hex')
|
||||||
}
|
}
|
||||||
|
|
||||||
export function getPublicKey(privateKey) {
|
export function getPublicKey(privateKey) {
|
||||||
return secp256k1.schnorr.getPublicKey(privateKey)
|
return Buffer.from(secp256k1.schnorr.getPublicKey(privateKey)).toString('hex')
|
||||||
}
|
}
|
||||||
|
|||||||
2
nip04.js
2
nip04.js
@@ -38,5 +38,5 @@ export function decrypt(privkey, pubkey, ciphertext) {
|
|||||||
function getNormalizedX(key) {
|
function getNormalizedX(key) {
|
||||||
return typeof key === 'string'
|
return typeof key === 'string'
|
||||||
? key.substr(2, 64)
|
? key.substr(2, 64)
|
||||||
: Buffer.from(key.slice(1)).toString('hex')
|
: Buffer.from(key.slice(1, 33)).toString('hex')
|
||||||
}
|
}
|
||||||
|
|||||||
6
nip05.js
6
nip05.js
@@ -15,11 +15,7 @@ export async function searchDomain(domain, query = '') {
|
|||||||
export async function queryName(fullname) {
|
export async function queryName(fullname) {
|
||||||
try {
|
try {
|
||||||
let [name, domain] = fullname.split('@')
|
let [name, domain] = fullname.split('@')
|
||||||
|
if (!domain) return null
|
||||||
if (!domain) {
|
|
||||||
domain = name
|
|
||||||
name = '_'
|
|
||||||
}
|
|
||||||
|
|
||||||
let res = await (
|
let res = await (
|
||||||
await fetch(`https://${domain}/.well-known/nostr.json?name=${name}`)
|
await fetch(`https://${domain}/.well-known/nostr.json?name=${name}`)
|
||||||
|
|||||||
14
package.json
14
package.json
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "nostr-tools",
|
"name": "nostr-tools",
|
||||||
"version": "0.21.3",
|
"version": "0.23.3",
|
||||||
"description": "Tools for making a Nostr client.",
|
"description": "Tools for making a Nostr client.",
|
||||||
"repository": {
|
"repository": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
@@ -8,7 +8,7 @@
|
|||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@noble/hashes": "^0.5.7",
|
"@noble/hashes": "^0.5.7",
|
||||||
"@noble/secp256k1": "^1.3.0",
|
"@noble/secp256k1": "^1.5.2",
|
||||||
"browserify-cipher": ">=1",
|
"browserify-cipher": ">=1",
|
||||||
"buffer": ">=5",
|
"buffer": ">=5",
|
||||||
"create-hash": "^1.2.0",
|
"create-hash": "^1.2.0",
|
||||||
@@ -30,7 +30,15 @@
|
|||||||
"client"
|
"client"
|
||||||
],
|
],
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
|
"@esbuild-plugins/node-globals-polyfill": "^0.1.1",
|
||||||
|
"esbuild": "^0.14.38",
|
||||||
|
"esbuild-plugin-alias": "^0.2.1",
|
||||||
"eslint": "^8.5.0",
|
"eslint": "^8.5.0",
|
||||||
"eslint-plugin-babel": "^5.3.1"
|
"eslint-plugin-babel": "^5.3.1",
|
||||||
|
"events": "^3.3.0",
|
||||||
|
"readable-stream": "^3.6.0"
|
||||||
|
},
|
||||||
|
"scripts": {
|
||||||
|
"prepublish": "node build.js"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
15
pool.js
15
pool.js
@@ -26,27 +26,34 @@ export function relayPool() {
|
|||||||
|
|
||||||
const activeSubscriptions = {}
|
const activeSubscriptions = {}
|
||||||
|
|
||||||
const sub = ({cb, filter}, id = Math.random().toString().slice(2)) => {
|
const sub = ({cb, filter, beforeSend}, id) => {
|
||||||
|
if (!id) id = Math.random().toString().slice(2)
|
||||||
|
|
||||||
const subControllers = Object.fromEntries(
|
const subControllers = Object.fromEntries(
|
||||||
Object.values(relays)
|
Object.values(relays)
|
||||||
.filter(({policy}) => policy.read)
|
.filter(({policy}) => policy.read)
|
||||||
.map(({relay}) => [
|
.map(({relay}) => [
|
||||||
relay.url,
|
relay.url,
|
||||||
relay.sub({filter, cb: event => cb(event, relay.url)}, id)
|
relay.sub({filter, cb: event => cb(event, relay.url), beforeSend}, id)
|
||||||
])
|
])
|
||||||
)
|
)
|
||||||
|
|
||||||
const activeCallback = cb
|
const activeCallback = cb
|
||||||
const activeFilters = filter
|
const activeFilters = filter
|
||||||
|
const activeBeforeSend = beforeSend
|
||||||
|
|
||||||
const unsub = () => {
|
const unsub = () => {
|
||||||
Object.values(subControllers).forEach(sub => sub.unsub())
|
Object.values(subControllers).forEach(sub => sub.unsub())
|
||||||
delete activeSubscriptions[id]
|
delete activeSubscriptions[id]
|
||||||
}
|
}
|
||||||
const sub = ({cb = activeCallback, filter = activeFilters}) => {
|
const sub = ({
|
||||||
|
cb = activeCallback,
|
||||||
|
filter = activeFilters,
|
||||||
|
beforeSend = activeBeforeSend
|
||||||
|
}) => {
|
||||||
Object.entries(subControllers).map(([relayURL, sub]) => [
|
Object.entries(subControllers).map(([relayURL, sub]) => [
|
||||||
relayURL,
|
relayURL,
|
||||||
sub.sub({cb, filter}, id)
|
sub.sub({cb, filter, beforeSend}, id)
|
||||||
])
|
])
|
||||||
return activeSubscriptions[id]
|
return activeSubscriptions[id]
|
||||||
}
|
}
|
||||||
|
|||||||
20
relay.js
20
relay.js
@@ -119,7 +119,10 @@ export function relayConnect(url, onNotice = () => {}, onError = () => {}) {
|
|||||||
ws.send(msg)
|
ws.send(msg)
|
||||||
}
|
}
|
||||||
|
|
||||||
const sub = ({cb, filter}, channel = Math.random().toString().slice(2)) => {
|
const sub = (
|
||||||
|
{cb, filter, beforeSend},
|
||||||
|
channel = Math.random().toString().slice(2)
|
||||||
|
) => {
|
||||||
var filters = []
|
var filters = []
|
||||||
if (Array.isArray(filter)) {
|
if (Array.isArray(filter)) {
|
||||||
filters = filter
|
filters = filter
|
||||||
@@ -127,16 +130,25 @@ export function relayConnect(url, onNotice = () => {}, onError = () => {}) {
|
|||||||
filters.push(filter)
|
filters.push(filter)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if (beforeSend) {
|
||||||
|
const beforeSendResult = beforeSend({filter, relay: url, channel})
|
||||||
|
filters = beforeSendResult.filter
|
||||||
|
}
|
||||||
|
|
||||||
trySend(['REQ', channel, ...filters])
|
trySend(['REQ', channel, ...filters])
|
||||||
channels[channel] = cb
|
channels[channel] = cb
|
||||||
openSubs[channel] = filters
|
openSubs[channel] = filters
|
||||||
|
|
||||||
const activeCallback = cb
|
const activeCallback = cb
|
||||||
const activeFilters = filters
|
const activeFilters = filters
|
||||||
|
const activeBeforeSend = beforeSend
|
||||||
|
|
||||||
return {
|
return {
|
||||||
sub: ({cb = activeCallback, filter = activeFilters}) =>
|
sub: ({
|
||||||
sub({cb, filter}, channel),
|
cb = activeCallback,
|
||||||
|
filter = activeFilters,
|
||||||
|
beforeSend = activeBeforeSend
|
||||||
|
}) => sub({cb, filter, beforeSend}, channel),
|
||||||
unsub: () => {
|
unsub: () => {
|
||||||
delete openSubs[channel]
|
delete openSubs[channel]
|
||||||
delete channels[channel]
|
delete channels[channel]
|
||||||
@@ -160,7 +172,7 @@ export function relayConnect(url, onNotice = () => {}, onError = () => {}) {
|
|||||||
unsub()
|
unsub()
|
||||||
clearTimeout(willUnsub)
|
clearTimeout(willUnsub)
|
||||||
},
|
},
|
||||||
filter: {id: event.id}
|
filter: {ids: [event.id]}
|
||||||
},
|
},
|
||||||
`monitor-${event.id.slice(0, 5)}`
|
`monitor-${event.id.slice(0, 5)}`
|
||||||
)
|
)
|
||||||
|
|||||||
Reference in New Issue
Block a user