laantungir/nostr-tools
1
0
Fork 0
mirror of https://github.com/nbd-wtf/nostr-tools.git synced 2025-12-08 16:28:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

Run prettier

Browse Source
This commit is contained in:
futpib
2023-04-02 03:52:20 +04:00
committed by fiatjaf_
parent 3e67f9b014
commit 11ef43abdc
2 changed files with 110 additions and 106 deletions
Download Patch File Download Diff File Expand all files Collapse all files

159
nip10.test.js
View File

@@ -3,7 +3,6 @@
const {nip10} = require('./lib/nostr.cjs') const {nip10} = require('./lib/nostr.cjs')
describe('parse NIP10-referenced events', () => { describe('parse NIP10-referenced events', () => {
test('legacy + a lot of events', () => { test('legacy + a lot of events', () => {
let event = { let event = {
tags: [ tags: [
@@ -47,47 +46,47 @@ describe('parse NIP10-referenced events', () => {
'p', 'p',
'4ca4f5533e40da5e0508796d409e6bb35a50b26fc304345617ab017183d83ac0' '4ca4f5533e40da5e0508796d409e6bb35a50b26fc304345617ab017183d83ac0'
] ]
], ]
}; }
expect(nip10.parse(event)).toEqual({ expect(nip10.parse(event)).toEqual({
"mentions": [ mentions: [
{ {
"id": "bbd72f0ae14374aa8fb166b483cfcf99b57d7f4cf1600ccbf17c350040834631", id: 'bbd72f0ae14374aa8fb166b483cfcf99b57d7f4cf1600ccbf17c350040834631',
"relays": [], relays: []
}, },
{ {
"id": "5e081ebb19153357d7c31e8a10b9ceeef29313f58dc8d701f66727fab02aef64", id: '5e081ebb19153357d7c31e8a10b9ceeef29313f58dc8d701f66727fab02aef64',
"relays": [], relays: []
}, },
{ {
"id": "49aff7ae6daeaaa2777931b90f9bb29f6cb01c5a3d7d88c8ba82d890f264afb4", id: '49aff7ae6daeaaa2777931b90f9bb29f6cb01c5a3d7d88c8ba82d890f264afb4',
"relays": [], relays: []
}, },
{ {
"id": "567b7c11f0fe582361e3cea6fcc7609a8942dfe196ee1b98d5604c93fbeea976", id: '567b7c11f0fe582361e3cea6fcc7609a8942dfe196ee1b98d5604c93fbeea976',
"relays": [], relays: []
}, },
{ {
"id": "090c037b2e399ee74d9f134758928948dd9154413ca1a1acb37155046e03a051", id: '090c037b2e399ee74d9f134758928948dd9154413ca1a1acb37155046e03a051',
"relays": [], relays: []
}, }
], ],
"pubkeys": [ pubkeys: [
"77ce56f89d1228f7ff3743ce1ad1b254857b9008564727ebd5a1f317362f6ca7", '77ce56f89d1228f7ff3743ce1ad1b254857b9008564727ebd5a1f317362f6ca7',
"534780e44da7b494485e85cd4cca6af4f6caa1627472432b6f2a4ece0e9e54ec", '534780e44da7b494485e85cd4cca6af4f6caa1627472432b6f2a4ece0e9e54ec',
"4ca4f5533e40da5e0508796d409e6bb35a50b26fc304345617ab017183d83ac0", '4ca4f5533e40da5e0508796d409e6bb35a50b26fc304345617ab017183d83ac0'
], ],
"reply": { reply: {
"id": "89f220b63465c93542b1a78caa3a952cf4f196e91a50596493c8093c533ebc4d", id: '89f220b63465c93542b1a78caa3a952cf4f196e91a50596493c8093c533ebc4d',
"relays": [], relays: []
}, },
"root": { root: {
"id": "b857504288c18a15950dd05b9e8772c62ca6289d5aac373c0a8ee5b132e94e7c", id: 'b857504288c18a15950dd05b9e8772c62ca6289d5aac373c0a8ee5b132e94e7c',
"relays": [], relays: []
}, }
}); })
}); })
test('legacy + 3 events', () => { test('legacy + 3 events', () => {
let event = { let event = {
@@ -116,31 +115,31 @@ describe('parse NIP10-referenced events', () => {
'p', 'p',
'4ca4f5533e40da5e0508796d409e6bb35a50b26fc304345617ab017183d83ac0' '4ca4f5533e40da5e0508796d409e6bb35a50b26fc304345617ab017183d83ac0'
] ]
], ]
}; }
expect(nip10.parse(event)).toEqual({ expect(nip10.parse(event)).toEqual({
"mentions": [ mentions: [
{ {
"id": "bbd72f0ae14374aa8fb166b483cfcf99b57d7f4cf1600ccbf17c350040834631", id: 'bbd72f0ae14374aa8fb166b483cfcf99b57d7f4cf1600ccbf17c350040834631',
"relays": [], relays: []
}, }
], ],
"pubkeys": [ pubkeys: [
"77ce56f89d1228f7ff3743ce1ad1b254857b9008564727ebd5a1f317362f6ca7", '77ce56f89d1228f7ff3743ce1ad1b254857b9008564727ebd5a1f317362f6ca7',
"534780e44da7b494485e85cd4cca6af4f6caa1627472432b6f2a4ece0e9e54ec", '534780e44da7b494485e85cd4cca6af4f6caa1627472432b6f2a4ece0e9e54ec',
"4ca4f5533e40da5e0508796d409e6bb35a50b26fc304345617ab017183d83ac0", '4ca4f5533e40da5e0508796d409e6bb35a50b26fc304345617ab017183d83ac0'
], ],
"reply": { reply: {
"id": "5e081ebb19153357d7c31e8a10b9ceeef29313f58dc8d701f66727fab02aef64", id: '5e081ebb19153357d7c31e8a10b9ceeef29313f58dc8d701f66727fab02aef64',
"relays": [], relays: []
}, },
"root": { root: {
"id": "b857504288c18a15950dd05b9e8772c62ca6289d5aac373c0a8ee5b132e94e7c", id: 'b857504288c18a15950dd05b9e8772c62ca6289d5aac373c0a8ee5b132e94e7c',
"relays": [], relays: []
}, }
}); })
}); })
test('legacy + 2 events', () => { test('legacy + 2 events', () => {
let event = { let event = {
@@ -165,26 +164,26 @@ describe('parse NIP10-referenced events', () => {
'p', 'p',
'4ca4f5533e40da5e0508796d409e6bb35a50b26fc304345617ab017183d83ac0' '4ca4f5533e40da5e0508796d409e6bb35a50b26fc304345617ab017183d83ac0'
] ]
], ]
}; }
expect(nip10.parse(event)).toEqual({ expect(nip10.parse(event)).toEqual({
"mentions": [], mentions: [],
"pubkeys": [ pubkeys: [
"77ce56f89d1228f7ff3743ce1ad1b254857b9008564727ebd5a1f317362f6ca7", '77ce56f89d1228f7ff3743ce1ad1b254857b9008564727ebd5a1f317362f6ca7',
"534780e44da7b494485e85cd4cca6af4f6caa1627472432b6f2a4ece0e9e54ec", '534780e44da7b494485e85cd4cca6af4f6caa1627472432b6f2a4ece0e9e54ec',
"4ca4f5533e40da5e0508796d409e6bb35a50b26fc304345617ab017183d83ac0", '4ca4f5533e40da5e0508796d409e6bb35a50b26fc304345617ab017183d83ac0'
], ],
"reply": { reply: {
"id": "bbd72f0ae14374aa8fb166b483cfcf99b57d7f4cf1600ccbf17c350040834631", id: 'bbd72f0ae14374aa8fb166b483cfcf99b57d7f4cf1600ccbf17c350040834631',
"relays": [], relays: []
}, },
"root": { root: {
"id": "b857504288c18a15950dd05b9e8772c62ca6289d5aac373c0a8ee5b132e94e7c", id: 'b857504288c18a15950dd05b9e8772c62ca6289d5aac373c0a8ee5b132e94e7c',
"relays": [], relays: []
}, }
}); })
}); })
test('legacy + 1 event', () => { test('legacy + 1 event', () => {
let event = { let event = {
@@ -197,25 +196,25 @@ describe('parse NIP10-referenced events', () => {
'p', 'p',
'534780e44da7b494485e85cd4cca6af4f6caa1627472432b6f2a4ece0e9e54ec' '534780e44da7b494485e85cd4cca6af4f6caa1627472432b6f2a4ece0e9e54ec'
] ]
], ]
}; }
expect(nip10.parse(event)).toEqual({ expect(nip10.parse(event)).toEqual({
"mentions": [], mentions: [],
"pubkeys": [ pubkeys: [
"534780e44da7b494485e85cd4cca6af4f6caa1627472432b6f2a4ece0e9e54ec", '534780e44da7b494485e85cd4cca6af4f6caa1627472432b6f2a4ece0e9e54ec'
], ],
"reply": undefined, reply: undefined,
"root": { root: {
"id": "9abbfd9b9ac5ecdab45d14b8bf8d746139ea039e931a1b376d19a239f1946590", id: '9abbfd9b9ac5ecdab45d14b8bf8d746139ea039e931a1b376d19a239f1946590',
"relays": [], relays: []
}, }
}); })
}); })
// No events with NIP-10 explicit root/reply/mention markers were found in the wild for these tests :( // No events with NIP-10 explicit root/reply/mention markers were found in the wild for these tests :(
test.todo('recommended + a lot of events'); test.todo('recommended + a lot of events')
test.todo('recommended + 3 events'); test.todo('recommended + 3 events')
test.todo('recommended + 2 events'); test.todo('recommended + 2 events')
test.todo('recommended + 1 event'); test.todo('recommended + 1 event')
}); })

57
nip10.ts
View File

@@ -1,73 +1,78 @@
import type { Event } from "./event"; import type {Event} from './event'
import { EventPointer } from "./nip19"; import {EventPointer} from './nip19'
export type NIP10Result = { export type NIP10Result = {
/** /**
* Pointer to the root of the thread. * Pointer to the root of the thread.
*/ */
root: EventPointer | undefined; root: EventPointer | undefined
/** /**
* Pointer to a "parent" event that parsed event replies to (responded to). * Pointer to a "parent" event that parsed event replies to (responded to).
*/ */
reply: EventPointer | undefined; reply: EventPointer | undefined
/** /**
* Pointers to events which may or may not be in the reply chain. * Pointers to events which may or may not be in the reply chain.
*/ */
mentions: EventPointer[]; mentions: EventPointer[]
/** /**
* List of pubkeys that are involved in the thread in no particular order. * List of pubkeys that are involved in the thread in no particular order.
*/ */
pubkeys: string[]; pubkeys: string[]
}; }
export function parse(event: Pick<Event, 'tags'>): NIP10Result { export function parse(event: Pick<Event, 'tags'>): NIP10Result {
const result: NIP10Result = { const result: NIP10Result = {
reply: undefined, reply: undefined,
root: undefined, root: undefined,
mentions: [], mentions: [],
pubkeys: [], pubkeys: []
}; }
const eTags: string[][] = []; const eTags: string[][] = []
for (const tag of event.tags) { for (const tag of event.tags) {
if (tag[0] === "e" && tag[1]) { if (tag[0] === 'e' && tag[1]) {
eTags.push(tag); eTags.push(tag)
} }
if (tag[0] === "p" && tag[1]) { if (tag[0] === 'p' && tag[1]) {
result.pubkeys.push(tag[1]); result.pubkeys.push(tag[1])
} }
} }
for (let eTagIndex = 0; eTagIndex < eTags.length; eTagIndex++) { for (let eTagIndex = 0; eTagIndex < eTags.length; eTagIndex++) {
const eTag = eTags[eTagIndex]; const eTag = eTags[eTagIndex]
const [ _, eTagEventId, eTagRelayUrl, eTagMarker ] = eTag as [string, string, undefined | string, undefined | string]; const [_, eTagEventId, eTagRelayUrl, eTagMarker] = eTag as [
string,
string,
undefined | string,
undefined | string
]
const eventPointer: EventPointer = { const eventPointer: EventPointer = {
id: eTagEventId, id: eTagEventId,
relays: eTagRelayUrl ? [eTagRelayUrl] : [], relays: eTagRelayUrl ? [eTagRelayUrl] : []
}; }
const isFirstETag = eTagIndex === 0; const isFirstETag = eTagIndex === 0
const isLastETag = eTagIndex === eTags.length - 1; const isLastETag = eTagIndex === eTags.length - 1
if (eTagMarker === 'root' || isFirstETag) { if (eTagMarker === 'root' || isFirstETag) {
result.root = eventPointer; result.root = eventPointer
continue; continue
} }
if (eTagMarker === 'reply' || isLastETag) { if (eTagMarker === 'reply' || isLastETag) {
result.reply = eventPointer; result.reply = eventPointer
continue; continue
} }
result.mentions.push(eventPointer); result.mentions.push(eventPointer)
} }
return result; return result
} }