mirror of
https://github.com/nbd-wtf/nostr-tools.git
synced 2025-12-09 16:48:50 +00:00
Compare commits
12 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
f6f5ee8223 | ||
|
|
a05506468d | ||
|
|
674ff66b6f | ||
|
|
731705047a | ||
|
|
94b382a49f | ||
|
|
199411a971 | ||
|
|
a1dc6f41b9 | ||
|
|
5b59b93d86 | ||
|
|
12acd7bdca | ||
|
|
3bdb68020d | ||
|
|
b0a58e2ca4 | ||
|
|
b063be76ae |
11
event.ts
11
event.ts
@@ -13,6 +13,7 @@ export enum Kind {
|
|||||||
EncryptedDirectMessage = 4,
|
EncryptedDirectMessage = 4,
|
||||||
EventDeletion = 5,
|
EventDeletion = 5,
|
||||||
Reaction = 7,
|
Reaction = 7,
|
||||||
|
BadgeAward = 8,
|
||||||
ChannelCreation = 40,
|
ChannelCreation = 40,
|
||||||
ChannelMetadata = 41,
|
ChannelMetadata = 41,
|
||||||
ChannelMessage = 42,
|
ChannelMessage = 42,
|
||||||
@@ -23,6 +24,8 @@ export enum Kind {
|
|||||||
Zap = 9735,
|
Zap = 9735,
|
||||||
RelayList = 10002,
|
RelayList = 10002,
|
||||||
ClientAuth = 22242,
|
ClientAuth = 22242,
|
||||||
|
BadgeDefinition = 30008,
|
||||||
|
ProfileBadge = 30009,
|
||||||
Article = 30023
|
Article = 30023
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -78,8 +81,10 @@ export function getEventHash(event: UnsignedEvent): string {
|
|||||||
return secp256k1.utils.bytesToHex(eventHash)
|
return secp256k1.utils.bytesToHex(eventHash)
|
||||||
}
|
}
|
||||||
|
|
||||||
export function validateEvent(event: UnsignedEvent): boolean {
|
const isRecord = (obj: unknown): obj is Record<string, unknown> => obj instanceof Object
|
||||||
if (typeof event !== 'object') return false
|
|
||||||
|
export function validateEvent<T>(event: T): event is T & UnsignedEvent {
|
||||||
|
if (!isRecord(event)) return false
|
||||||
if (typeof event.kind !== 'number') return false
|
if (typeof event.kind !== 'number') return false
|
||||||
if (typeof event.content !== 'string') return false
|
if (typeof event.content !== 'string') return false
|
||||||
if (typeof event.created_at !== 'number') return false
|
if (typeof event.created_at !== 'number') return false
|
||||||
@@ -98,7 +103,7 @@ export function validateEvent(event: UnsignedEvent): boolean {
|
|||||||
return true
|
return true
|
||||||
}
|
}
|
||||||
|
|
||||||
export function verifySignature(event: Event & {sig: string}): boolean {
|
export function verifySignature(event: Event): boolean {
|
||||||
return secp256k1.schnorr.verifySync(
|
return secp256k1.schnorr.verifySync(
|
||||||
event.sig,
|
event.sig,
|
||||||
getEventHash(event),
|
getEventHash(event),
|
||||||
|
|||||||
@@ -37,6 +37,16 @@ describe('Filter', () => {
|
|||||||
expect(result).toEqual(false)
|
expect(result).toEqual(false)
|
||||||
})
|
})
|
||||||
|
|
||||||
|
it('should return true when the event id starts with a prefix', () => {
|
||||||
|
const filter = {ids: ['22', '00']}
|
||||||
|
|
||||||
|
const event = {id: '001'}
|
||||||
|
|
||||||
|
const result = matchFilter(filter, event)
|
||||||
|
|
||||||
|
expect(result).toEqual(true)
|
||||||
|
})
|
||||||
|
|
||||||
it('should return false when the event kind is not in the filter', () => {
|
it('should return false when the event kind is not in the filter', () => {
|
||||||
const filter = {kinds: [1, 2, 3]}
|
const filter = {kinds: [1, 2, 3]}
|
||||||
|
|
||||||
@@ -132,6 +142,20 @@ describe('Filter', () => {
|
|||||||
expect(result).toEqual(true)
|
expect(result).toEqual(true)
|
||||||
})
|
})
|
||||||
|
|
||||||
|
it('should return true when at least one prefix matches the event', () => {
|
||||||
|
const filters = [
|
||||||
|
{ids: ['1'], kinds: [1], authors: ['a']},
|
||||||
|
{ids: ['4'], kinds: [2], authors: ['d']},
|
||||||
|
{ids: ['9'], kinds: [3], authors: ['g']}
|
||||||
|
]
|
||||||
|
|
||||||
|
const event = {id: '987', kind: 3, pubkey: 'ghi'}
|
||||||
|
|
||||||
|
const result = matchFilters(filters, event)
|
||||||
|
|
||||||
|
expect(result).toEqual(true)
|
||||||
|
})
|
||||||
|
|
||||||
it('should return true when event matches one or more filters and some have limit set', () => {
|
it('should return true when event matches one or more filters and some have limit set', () => {
|
||||||
const filters = [
|
const filters = [
|
||||||
{ids: ['123'], limit: 1},
|
{ids: ['123'], limit: 1},
|
||||||
|
|||||||
17
filter.ts
17
filter.ts
@@ -13,12 +13,19 @@ export type Filter = {
|
|||||||
|
|
||||||
export function matchFilter(
|
export function matchFilter(
|
||||||
filter: Filter,
|
filter: Filter,
|
||||||
event: Event & {id: string}
|
event: Event
|
||||||
): boolean {
|
): boolean {
|
||||||
if (filter.ids && filter.ids.indexOf(event.id) === -1) return false
|
if (filter.ids && filter.ids.indexOf(event.id) === -1) {
|
||||||
if (filter.kinds && filter.kinds.indexOf(event.kind) === -1) return false
|
if (!filter.ids.some(prefix => event.id.startsWith(prefix))) {
|
||||||
if (filter.authors && filter.authors.indexOf(event.pubkey) === -1)
|
|
||||||
return false
|
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.some(prefix => event.pubkey.startsWith(prefix))) {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
for (let f in filter) {
|
for (let f in filter) {
|
||||||
if (f[0] === '#') {
|
if (f[0] === '#') {
|
||||||
@@ -42,7 +49,7 @@ export function matchFilter(
|
|||||||
|
|
||||||
export function matchFilters(
|
export function matchFilters(
|
||||||
filters: Filter[],
|
filters: Filter[],
|
||||||
event: Event & {id: string}
|
event: Event
|
||||||
): boolean {
|
): 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
|
||||||
|
|||||||
1
index.ts
1
index.ts
@@ -9,6 +9,7 @@ export * as nip04 from './nip04'
|
|||||||
export * as nip05 from './nip05'
|
export * as nip05 from './nip05'
|
||||||
export * as nip06 from './nip06'
|
export * as nip06 from './nip06'
|
||||||
export * as nip10 from './nip10'
|
export * as nip10 from './nip10'
|
||||||
|
export * as nip13 from './nip13'
|
||||||
export * as nip19 from './nip19'
|
export * as nip19 from './nip19'
|
||||||
export * as nip26 from './nip26'
|
export * as nip26 from './nip26'
|
||||||
export * as nip39 from './nip39'
|
export * as nip39 from './nip39'
|
||||||
|
|||||||
@@ -17,4 +17,9 @@ test('fetch nip05 profiles', async () => {
|
|||||||
'32e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245'
|
'32e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245'
|
||||||
)
|
)
|
||||||
expect(p2.relays).toEqual(['wss://relay.damus.io'])
|
expect(p2.relays).toEqual(['wss://relay.damus.io'])
|
||||||
|
|
||||||
|
let p3 = await nip05.queryProfile('channel.ninja@channel.ninja')
|
||||||
|
expect(p3.pubkey).toEqual(
|
||||||
|
'36e65b503eba8a6b698e724a59137603101166a1cddb45ddc704247fc8aa0fce'
|
||||||
|
)
|
||||||
})
|
})
|
||||||
|
|||||||
2
nip05.ts
2
nip05.ts
@@ -36,7 +36,7 @@ export async function queryProfile(
|
|||||||
name = '_'
|
name = '_'
|
||||||
}
|
}
|
||||||
|
|
||||||
if (!name.match(/^[A-Za-z0-9-_]+$/)) return null
|
if (!name.match(/^[A-Za-z0-9-_.]+$/)) return null
|
||||||
if (!domain.includes('.')) return null
|
if (!domain.includes('.')) return null
|
||||||
|
|
||||||
let res
|
let res
|
||||||
|
|||||||
8
nip13.test.js
Normal file
8
nip13.test.js
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
/* eslint-env jest */
|
||||||
|
const {nip13} = require('./lib/nostr.cjs')
|
||||||
|
|
||||||
|
test('identifies proof-of-work difficulty', async () => {
|
||||||
|
const id = '000006d8c378af1779d2feebc7603a125d99eca0ccf1085959b307f64e5dd358'
|
||||||
|
const difficulty = nip13.getPow(id)
|
||||||
|
expect(difficulty).toEqual(21)
|
||||||
|
})
|
||||||
42
nip13.ts
Normal file
42
nip13.ts
Normal file
@@ -0,0 +1,42 @@
|
|||||||
|
import * as secp256k1 from '@noble/secp256k1'
|
||||||
|
|
||||||
|
/** Get POW difficulty from a Nostr hex ID. */
|
||||||
|
export function getPow(id: string): number {
|
||||||
|
return getLeadingZeroBits(secp256k1.utils.hexToBytes(id))
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get number of leading 0 bits. Adapted from nostream.
|
||||||
|
* https://github.com/Cameri/nostream/blob/fb6948fd83ca87ce552f39f9b5eb780ea07e272e/src/utils/proof-of-work.ts
|
||||||
|
*/
|
||||||
|
function getLeadingZeroBits(hash: Uint8Array): number {
|
||||||
|
let total: number, i: number, bits: number
|
||||||
|
|
||||||
|
for (i = 0, total = 0; i < hash.length; i++) {
|
||||||
|
bits = msb(hash[i])
|
||||||
|
total += bits
|
||||||
|
if (bits !== 8) {
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return total
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Adapted from nostream.
|
||||||
|
* https://github.com/Cameri/nostream/blob/fb6948fd83ca87ce552f39f9b5eb780ea07e272e/src/utils/proof-of-work.ts
|
||||||
|
*/
|
||||||
|
function msb(b: number) {
|
||||||
|
let n = 0
|
||||||
|
|
||||||
|
if (b === 0) {
|
||||||
|
return 8
|
||||||
|
}
|
||||||
|
|
||||||
|
// eslint-disable-next-line no-cond-assign
|
||||||
|
while (b >>= 1) {
|
||||||
|
n++
|
||||||
|
}
|
||||||
|
|
||||||
|
return 7 - n
|
||||||
|
}
|
||||||
19
package.json
19
package.json
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "nostr-tools",
|
"name": "nostr-tools",
|
||||||
"version": "1.8.2",
|
"version": "1.8.4",
|
||||||
"description": "Tools for making a Nostr client.",
|
"description": "Tools for making a Nostr client.",
|
||||||
"repository": {
|
"repository": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
@@ -18,12 +18,11 @@
|
|||||||
},
|
},
|
||||||
"license": "Public domain",
|
"license": "Public domain",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@noble/hashes": "1.0.0",
|
"@noble/hashes": "1.2.0",
|
||||||
"@noble/secp256k1": "^1.7.1",
|
"@noble/secp256k1": "1.7.0",
|
||||||
"@scure/base": "^1.1.1",
|
"@scure/base": "1.1.1",
|
||||||
"@scure/bip32": "^1.1.5",
|
"@scure/bip32": "1.1.4",
|
||||||
"@scure/bip39": "^1.1.1",
|
"@scure/bip39": "1.1.1"
|
||||||
"prettier": "^2.8.4"
|
|
||||||
},
|
},
|
||||||
"keywords": [
|
"keywords": [
|
||||||
"decentralization",
|
"decentralization",
|
||||||
@@ -32,6 +31,11 @@
|
|||||||
"client",
|
"client",
|
||||||
"nostr"
|
"nostr"
|
||||||
],
|
],
|
||||||
|
"scripts": {
|
||||||
|
"build": "node build",
|
||||||
|
"format": "prettier --plugin-search-dir . --write .",
|
||||||
|
"test": "node build && jest"
|
||||||
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@types/node": "^18.13.0",
|
"@types/node": "^18.13.0",
|
||||||
"@typescript-eslint/eslint-plugin": "^5.51.0",
|
"@typescript-eslint/eslint-plugin": "^5.51.0",
|
||||||
@@ -44,6 +48,7 @@
|
|||||||
"events": "^3.3.0",
|
"events": "^3.3.0",
|
||||||
"jest": "^29.4.2",
|
"jest": "^29.4.2",
|
||||||
"node-fetch": "^2.6.9",
|
"node-fetch": "^2.6.9",
|
||||||
|
"prettier": "^2.8.4",
|
||||||
"ts-jest": "^29.0.5",
|
"ts-jest": "^29.0.5",
|
||||||
"tsd": "^0.22.0",
|
"tsd": "^0.22.0",
|
||||||
"typescript": "^4.9.5",
|
"typescript": "^4.9.5",
|
||||||
|
|||||||
@@ -81,7 +81,7 @@ export function parseReferences(evt: Event): Reference[] {
|
|||||||
}
|
}
|
||||||
case 'a': {
|
case 'a': {
|
||||||
try {
|
try {
|
||||||
let [kind, pubkey, identifier] = ref[1].split(':')
|
let [kind, pubkey, identifier] = tag[1].split(':')
|
||||||
references.push({
|
references.push({
|
||||||
text: ref[0],
|
text: ref[0],
|
||||||
address: {
|
address: {
|
||||||
|
|||||||
Reference in New Issue
Block a user