laantungir
/
nostr-tools
mirror of https://github.com/nbd-wtf/nostr-tools.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

move to bun and bun:test and remove jest.

This commit is contained in:
fiatjaf 2023-12-16 14:53:32 -03:00
parent 1357642575
commit 3d541e537e
No known key found for this signature in database
GPG Key ID: BAD43C4BE5C1A3A1
36 changed files with 130 additions and 4356 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
.eslintrc.json
View File

@ -139,13 +139,5 @@
"wrap-iife": [2, "any"],
"yield-star-spacing": [2, "both"],
"yoda": [0]
},
"overrides": [
{
"files": ["**/*.test.ts"],
"env": { "jest/globals": true },
"plugins": ["jest"],
"extends": ["plugin:jest/recommended"]
}
]
}

15
build.js
View File

@ -1,15 +1,10 @@
#!/usr/bin/env node
const fs = require('fs')
const fs = require('node:fs')
const esbuild = require('esbuild')
const { join } = require('path');
const { join } = require('path')
const entryPoints = fs.readdirSync(process.cwd())
.filter(
(file) =>
file.endsWith(".ts") && !file.endsWith("test.ts") &&
fs.statSync(join(process.cwd(), file)).isFile()
);
const entryPoints = fs
.readdirSync(process.cwd())
.filter(file => file.endsWith('.ts') && !file.endsWith('test.ts') && fs.statSync(join(process.cwd(), file)).isFile())
let common = {
entryPoints,

BIN
bun.lockb Executable file
View File

Binary file not shown.

36
event.test.ts
View File

@ -1,3 +1,5 @@
import { describe, test, expect } from 'bun:test'
import {
finishEvent,
serializeEvent,
@ -12,7 +14,7 @@ import { ShortTextNote } from './kinds.ts'
describe('Event', () => {
describe('finishEvent', () => {
it('should create a signed event from a template', () => {
test('should create a signed event from a template', () => {
const privateKey = 'd217c1ff2f8a65c3e3a1740db3b9f58b8c848bb45e26d00ed4714e4a0f4ceecf'
const publicKey = getPublicKey(privateKey)
@ -36,7 +38,7 @@ describe('Event', () => {
})
describe('serializeEvent', () => {
it('should serialize a valid event object', () => {
test('should serialize a valid event object', () => {
const privateKey = 'd217c1ff2f8a65c3e3a1740db3b9f58b8c848bb45e26d00ed4714e4a0f4ceecf'
const publicKey = getPublicKey(privateKey)
@ -62,7 +64,7 @@ describe('Event', () => {
)
})
it('should throw an error for an invalid event object', () => {
test('should throw an error for an invalid event object', () => {
const privateKey = 'd217c1ff2f8a65c3e3a1740db3b9f58b8c848bb45e26d00ed4714e4a0f4ceecf'
const publicKey = getPublicKey(privateKey)
@ -81,7 +83,7 @@ describe('Event', () => {
})
describe('getEventHash', () => {
it('should return the correct event hash', () => {
test('should return the correct event hash', () => {
const privateKey = 'd217c1ff2f8a65c3e3a1740db3b9f58b8c848bb45e26d00ed4714e4a0f4ceecf'
const publicKey = getPublicKey(privateKey)
@ -101,7 +103,7 @@ describe('Event', () => {
})
describe('validateEvent', () => {
it('should return true for a valid event object', () => {
test('should return true for a valid event object', () => {
const privateKey = 'd217c1ff2f8a65c3e3a1740db3b9f58b8c848bb45e26d00ed4714e4a0f4ceecf'
const publicKey = getPublicKey(privateKey)
@ -118,7 +120,7 @@ describe('Event', () => {
expect(isValid).toEqual(true)
})
it('should return false for a non object event', () => {
test('should return false for a non object event', () => {
const nonObjectEvent = ''
const isValid = validateEvent(nonObjectEvent)
@ -126,7 +128,7 @@ describe('Event', () => {
expect(isValid).toEqual(false)
})
it('should return false for an event object with missing properties', () => {
test('should return false for an event object with missing properties', () => {
const invalidEvent = {
kind: ShortTextNote,
tags: [],
@ -138,7 +140,7 @@ describe('Event', () => {
expect(isValid).toEqual(false)
})
it('should return false for an empty object', () => {
test('should return false for an empty object', () => {
const emptyObj = {}
const isValid = validateEvent(emptyObj)
@ -146,7 +148,7 @@ describe('Event', () => {
expect(isValid).toEqual(false)
})
it('should return false for an object with invalid properties', () => {
test('should return false for an object with invalid properties', () => {
const privateKey = 'd217c1ff2f8a65c3e3a1740db3b9f58b8c848bb45e26d00ed4714e4a0f4ceecf'
const publicKey = getPublicKey(privateKey)
@ -162,7 +164,7 @@ describe('Event', () => {
expect(isValid).toEqual(false)
})
it('should return false for an object with an invalid public key', () => {
test('should return false for an object with an invalid public key', () => {
const invalidEvent = {
kind: 1,
tags: [],
@ -176,7 +178,7 @@ describe('Event', () => {
expect(isValid).toEqual(false)
})
it('should return false for an object with invalid tags', () => {
test('should return false for an object with invalid tags', () => {
const privateKey = 'd217c1ff2f8a65c3e3a1740db3b9f58b8c848bb45e26d00ed4714e4a0f4ceecf'
const publicKey = getPublicKey(privateKey)
@ -195,7 +197,7 @@ describe('Event', () => {
})
describe('verifySignature', () => {
it('should return true for a valid event signature', () => {
test('should return true for a valid event signature', () => {
const privateKey = 'd217c1ff2f8a65c3e3a1740db3b9f58b8c848bb45e26d00ed4714e4a0f4ceecf'
const event = finishEvent(
@ -213,7 +215,7 @@ describe('Event', () => {
expect(isValid).toEqual(true)
})
it('should return false for an invalid event signature', () => {
test('should return false for an invalid event signature', () => {
const privateKey = 'd217c1ff2f8a65c3e3a1740db3b9f58b8c848bb45e26d00ed4714e4a0f4ceecf'
const { [verifiedSymbol]: _, ...event } = finishEvent(
@ -234,7 +236,7 @@ describe('Event', () => {
expect(isValid).toEqual(false)
})
it('should return false when verifying an event with a different private key', () => {
test('should return false when verifying an event with a different private key', () => {
const privateKey1 = 'd217c1ff2f8a65c3e3a1740db3b9f58b8c848bb45e26d00ed4714e4a0f4ceecf'
const privateKey2 = '5b4a34f4e4b23c63ad55a35e3f84a3b53d96dbf266edf521a8358f71d19cbf67'
@ -259,7 +261,7 @@ describe('Event', () => {
expect(isValid).toEqual(false)
})
it('should return false for an invalid event id', () => {
test('should return false for an invalid event id', () => {
const privateKey = 'd217c1ff2f8a65c3e3a1740db3b9f58b8c848bb45e26d00ed4714e4a0f4ceecf'
const { [verifiedSymbol]: _, ...event } = finishEvent(
@ -282,7 +284,7 @@ describe('Event', () => {
})
describe('getSignature', () => {
it('should produce the correct signature for an event object', () => {
test('should produce the correct signature for an event object', () => {
const privateKey = 'd217c1ff2f8a65c3e3a1740db3b9f58b8c848bb45e26d00ed4714e4a0f4ceecf'
const publicKey = getPublicKey(privateKey)
@ -308,7 +310,7 @@ describe('Event', () => {
expect(isValid).toEqual(true)
})
it('should not sign an event with different private key', () => {
test('should not sign an event with different private key', () => {
const privateKey = 'd217c1ff2f8a65c3e3a1740db3b9f58b8c848bb45e26d00ed4714e4a0f4ceecf'
const publicKey = getPublicKey(privateKey)

1
fakejson.test.ts
View File

@ -1,3 +1,4 @@
import { test, expect } from 'bun:test'
import { matchEventId, matchEventKind, getSubscriptionId } from './fakejson.ts'
test('match id', () => {

37
filter.test.ts
View File

@ -1,9 +1,10 @@
import { describe, test, expect } from 'bun:test'
import { matchFilter, matchFilters, mergeFilters } from './filter.ts'
import { buildEvent } from './test-helpers.ts'
describe('Filter', () => {
describe('matchFilter', () => {
it('should return true when all filter conditions are met', () => {
test('should return true when all filter conditions are met', () => {
const filter = {
ids: ['123', '456'],
kinds: [1, 2, 3],
@ -26,7 +27,7 @@ describe('Filter', () => {
expect(result).toEqual(true)
})
it('should return false when the event id is not in the filter', () => {
test('should return false when the event id is not in the filter', () => {
const filter = { ids: ['123', '456'] }
const event = buildEvent({ id: '789' })
@ -36,7 +37,7 @@ describe('Filter', () => {
expect(result).toEqual(false)
})
it('should return true when the event id starts with a prefix', () => {
test('should return true when the event id starts with a prefix', () => {
const filter = { ids: ['22', '00'] }
const event = buildEvent({ id: '001' })
@ -46,7 +47,7 @@ describe('Filter', () => {
expect(result).toEqual(true)
})
it('should return false when the event kind is not in the filter', () => {
test('should return false when the event kind is not in the filter', () => {
const filter = { kinds: [1, 2, 3] }
const event = buildEvent({ kind: 4 })
@ -56,7 +57,7 @@ describe('Filter', () => {
expect(result).toEqual(false)
})
it('should return false when the event author is not in the filter', () => {
test('should return false when the event author is not in the filter', () => {
const filter = { authors: ['abc', 'def'] }
const event = buildEvent({ pubkey: 'ghi' })
@ -66,7 +67,7 @@ describe('Filter', () => {
expect(result).toEqual(false)
})
it('should return false when a tag is not present in the event', () => {
test('should return false when a tag is not present in the event', () => {
const filter = { '#tag': ['value1', 'value2'] }
const event = buildEvent({ tags: [['not_tag', 'value1']] })
@ -76,7 +77,7 @@ describe('Filter', () => {
expect(result).toEqual(false)
})
it('should return false when a tag value is not present in the event', () => {
test('should return false when a tag value is not present in the event', () => {
const filter = { '#tag': ['value1', 'value2'] }
const event = buildEvent({ tags: [['tag', 'value3']] })
@ -86,7 +87,7 @@ describe('Filter', () => {
expect(result).toEqual(false)
})
it('should return true when filter has tags that is present in the event', () => {
test('should return true when filter has tags that is present in the event', () => {
const filter = { '#tag1': ['foo'] }
const event = buildEvent({
@ -105,7 +106,7 @@ describe('Filter', () => {
expect(result).toEqual(true)
})
it('should return false when the event is before the filter since value', () => {
test('should return false when the event is before the filter since value', () => {
const filter = { since: 100 }
const event = buildEvent({ created_at: 50 })
@ -115,7 +116,7 @@ describe('Filter', () => {
expect(result).toEqual(false)
})
it('should return true when the timestamp of event is equal to the filter since value', () => {
test('should return true when the timestamp of event is equal to the filter since value', () => {
const filter = { since: 100 }
const event = buildEvent({ created_at: 100 })
@ -125,7 +126,7 @@ describe('Filter', () => {
expect(result).toEqual(true)
})
it('should return false when the event is after the filter until value', () => {
test('should return false when the event is after the filter until value', () => {
const filter = { until: 100 }
const event = buildEvent({ created_at: 150 })
@ -135,7 +136,7 @@ describe('Filter', () => {
expect(result).toEqual(false)
})
it('should return true when the timestamp of event is equal to the filter until value', () => {
test('should return true when the timestamp of event is equal to the filter until value', () => {
const filter = { until: 100 }
const event = buildEvent({ created_at: 100 })
@ -147,7 +148,7 @@ describe('Filter', () => {
})
describe('matchFilters', () => {
it('should return true when at least one filter matches the event', () => {
test('should return true when at least one filter matches the event', () => {
const filters = [
{ ids: ['123'], kinds: [1], authors: ['abc'] },
{ ids: ['456'], kinds: [2], authors: ['def'] },
@ -161,7 +162,7 @@ describe('Filter', () => {
expect(result).toEqual(true)
})
it('should return true when at least one prefix matches the event', () => {
test('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'] },
@ -175,7 +176,7 @@ describe('Filter', () => {
expect(result).toEqual(true)
})
it('should return true when event matches one or more filters and some have limit set', () => {
test('should return true when event matches one or more filters and some have limit set', () => {
const filters = [
{ ids: ['123'], limit: 1 },
{ kinds: [1], limit: 2 },
@ -194,7 +195,7 @@ describe('Filter', () => {
expect(result).toEqual(true)
})
it('should return false when no filters match the event', () => {
test('should return false when no filters match the event', () => {
const filters = [
{ ids: ['123'], kinds: [1], authors: ['abc'] },
{ ids: ['456'], kinds: [2], authors: ['def'] },
@ -208,7 +209,7 @@ describe('Filter', () => {
expect(result).toEqual(false)
})
it('should return false when event matches none of the filters and some have limit set', () => {
test('should return false when event matches none of the filters and some have limit set', () => {
const filters = [
{ ids: ['123'], limit: 1 },
{ kinds: [1], limit: 2 },
@ -228,7 +229,7 @@ describe('Filter', () => {
})
describe('mergeFilters', () => {
it('should merge filters', () => {
test('should merge filters', () => {
expect(mergeFilters({ ids: ['a', 'b'], limit: 3 }, { authors: ['x'], ids: ['b', 'c'] })).toEqual({
ids: ['a', 'b', 'c'],
limit: 3,

5
jest.config.js
View File

@ -1,5 +0,0 @@
/** @type {import('ts-jest').JestConfigWithTsJest} */
module.exports = {
preset: 'ts-jest',
testEnvironment: 'node',
}

6
justfile
View File

@ -5,13 +5,13 @@ install-dependencies:
build:
rm -rf lib
node build.js
bun run build.js
test:
jest
bun test
test-only file:
jest {{file}}
bun test {{file}}
emit-types:
tsc # see tsconfig.json

1
keys.test.ts
View File

@ -1,3 +1,4 @@
import { test, expect } from 'bun:test'
import { generatePrivateKey, getPublicKey } from './keys.ts'
test('private key generation', () => {

1
kinds.test.ts
View File

@ -1,3 +1,4 @@
import { test, expect } from 'bun:test'
import { classifyKind } from './kinds.ts'
test('kind classification', () => {

1
nip04.test.ts
View File

@ -1,3 +1,4 @@
import { test, expect } from 'bun:test'
import crypto from 'node:crypto'
import { encrypt, decrypt } from './nip04.ts'

1
nip05.test.ts
View File

@ -1,3 +1,4 @@
import { test, expect } from 'bun:test'
import fetch from 'node-fetch'
import { useFetchImplementation, queryProfile } from './nip05.ts'

1
nip06.test.ts
View File

@ -1,3 +1,4 @@
import { test, expect } from 'bun:test'
import { privateKeyFromSeedWords } from './nip06.ts'
test('generate private key from a mnemonic', async () => {

1
nip10.test.ts
View File

@ -1,3 +1,4 @@
import { describe, test, expect } from 'bun:test'
import { parse } from './nip10.ts'
describe('parse NIP10-referenced events', () => {

1
nip11.test.ts
View File

@ -1,3 +1,4 @@
import { describe, test, expect } from 'bun:test'
import fetch from 'node-fetch'
import { useFetchImplementation, fetchRelayInformation } from './nip11'

1
nip13.test.ts
View File

@ -1,3 +1,4 @@
import { test, expect } from 'bun:test'
import { getPow, minePow } from './nip13.ts'
test('identifies proof-of-work difficulty', async () => {

11
nip18.test.ts
View File

@ -1,3 +1,4 @@
import { describe, test, expect } from 'bun:test'
import { finishEvent } from './event.ts'
import { getPublicKey } from './keys.ts'
import { Repost, ShortTextNote } from './kinds.ts'
@ -24,7 +25,7 @@ describe('finishRepostEvent + getRepostedEventPointer + getRepostedEvent', () =>
privateKey,
)
it('should create a signed event from a minimal template', () => {
test('should create a signed event from a minimal template', () => {
const template = {
created_at: 1617932115,
}
@ -53,7 +54,7 @@ describe('finishRepostEvent + getRepostedEventPointer + getRepostedEvent', () =>
expect(repostedEventFromContent).toEqual(repostedEvent)
})
it('should create a signed event from a filled template', () => {
test('should create a signed event from a filled template', () => {
const template = {
tags: [['nonstandard', 'tag']],
content: '' as const,
@ -82,12 +83,12 @@ describe('finishRepostEvent + getRepostedEventPointer + getRepostedEvent', () =>
const repostedEventFromContent = getRepostedEvent(event)
expect(repostedEventFromContent).toEqual(undefined)
expect(repostedEventFromContent).toBeUndefined()
})
})
describe('getRepostedEventPointer', () => {
it('should parse an event with only an `e` tag', () => {
test('should parse an event with only an `e` tag', () => {
const event = buildEvent({
kind: Repost,
tags: [['e', 'reposted event id', relayUrl]],
@ -96,7 +97,7 @@ describe('getRepostedEventPointer', () => {
const repostedEventPointer = getRepostedEventPointer(event)
expect(repostedEventPointer!.id).toEqual('reposted event id')
expect(repostedEventPointer!.author).toEqual(undefined)
expect(repostedEventPointer!.author).toBeUndefined()
expect(repostedEventPointer!.relays).toEqual([relayUrl])
})
})

1
nip19.test.ts
View File

@ -1,3 +1,4 @@
import { test, expect } from 'bun:test'
import { generatePrivateKey, getPublicKey } from './keys.ts'
import {
decode,

1
nip21.test.ts
View File

@ -1,3 +1,4 @@
import { test, expect } from 'bun:test'
import { test as testRegex, parse } from './nip21.ts'
test('test()', () => {

5
nip25.test.ts
View File

@ -1,3 +1,4 @@
import { describe, test, expect } from 'bun:test'
import { finishEvent } from './event.ts'
import { getPublicKey } from './keys.ts'
import { Reaction, ShortTextNote } from './kinds.ts'
@ -21,7 +22,7 @@ describe('finishReactionEvent + getReactedEventPointer', () => {
privateKey,
)
it('should create a signed event from a minimal template', () => {
test('should create a signed event from a minimal template', () => {
const template = {
created_at: 1617932115,
}
@ -47,7 +48,7 @@ describe('finishReactionEvent + getReactedEventPointer', () => {
expect(reactedEventPointer!.author).toEqual(reactedEvent.pubkey)
})
it('should create a signed event from a filled template', () => {
test('should create a signed event from a filled template', () => {
const template = {
tags: [['nonstandard', 'tag']],
content: '👍',

1
nip27.test.ts
View File

@ -1,3 +1,4 @@
import { test, expect } from 'bun:test'
import { matchAll, replaceAll } from './nip27.ts'
test('matchAll', () => {

29
nip28.test.ts
View File

@ -1,3 +1,4 @@
import { describe, test, expect } from 'bun:test'
import { getPublicKey } from './keys.ts'
import * as Kind from './kinds.ts'
import {
@ -20,7 +21,7 @@ describe('NIP-28 Functions', () => {
picture: 'https://example.com/picture.jpg',
}
it('channelCreateEvent should create an event with given template', () => {
test('channelCreateEvent should create an event with given template', () => {
const template = {
content: channelMetadata,
created_at: 1617932115,
@ -32,7 +33,7 @@ describe('NIP-28 Functions', () => {
expect(event!.pubkey).toEqual(publicKey)
})
it('channelMetadataEvent should create a signed event with given template', () => {
test('channelMetadataEvent should create a signed event with given template', () => {
const template = {
channel_create_event_id: 'channel creation event id',
content: channelMetadata,
@ -48,8 +49,8 @@ describe('NIP-28 Functions', () => {
expect(typeof event!.sig).toEqual('string')
})
it('channelMessageEvent should create a signed message event with given template', () => {
const template = {
test('channelMessageEvent should create a signed message event with given template', () => {
const template: ChannelMessageEventTemplate = {
channel_create_event_id: 'channel creation event id',
relay_url: 'https://relay.example.com',
content: 'Hello, world!',
@ -65,7 +66,7 @@ describe('NIP-28 Functions', () => {
expect(typeof event.sig).toEqual('string')
})
it('channelMessageEvent should create a signed message reply event with given template', () => {
test('channelMessageEvent should create a signed message reply event with given template', () => {
const template: ChannelMessageEventTemplate = {
channel_create_event_id: 'channel creation event id',
reply_to_channel_message_event_id: 'channel message event id',
@ -76,15 +77,25 @@ describe('NIP-28 Functions', () => {
const event = channelMessageEvent(template, privateKey)
expect(event.kind).toEqual(Kind.ChannelMessage)
expect(event.tags).toContainEqual(['e', template.channel_create_event_id, template.relay_url, 'root'])
expect(event.tags).toContainEqual(['e', template.reply_to_channel_message_event_id, template.relay_url, 'reply'])
expect(event.tags.find(tag => tag[0] === 'e' && tag[1] === template.channel_create_event_id)).toEqual([
'e',
template.channel_create_event_id,
template.relay_url,
'root',
])
expect(event.tags.find(tag => tag[0] === 'e' && tag[1] === template.reply_to_channel_message_event_id)).toEqual([
'e',
template.reply_to_channel_message_event_id as string,
template.relay_url,
'reply',
])
expect(event.content).toEqual(template.content)
expect(event.pubkey).toEqual(publicKey)
expect(typeof event.id).toEqual('string')
expect(typeof event.sig).toEqual('string')
})
it('channelHideMessageEvent should create a signed event with given template', () => {
test('channelHideMessageEvent should create a signed event with given template', () => {
const template = {
channel_message_event_id: 'channel message event id',
content: { reason: 'Inappropriate content' },
@ -100,7 +111,7 @@ describe('NIP-28 Functions', () => {
expect(typeof event!.sig).toEqual('string')
})
it('channelMuteUserEvent should create a signed event with given template', () => {
test('channelMuteUserEvent should create a signed event with given template', () => {
const template = {
content: { reason: 'Spamming' },
created_at: 1617932115,

1
nip30.test.ts
View File

@ -1,3 +1,4 @@
import { test, expect } from 'bun:test'
import { matchAll, replaceAll } from './nip30.ts'
test('matchAll', () => {

1
nip39.test.ts
View File

@ -1,3 +1,4 @@
import { test, expect } from 'bun:test'
import fetch from 'node-fetch'
import { useFetchImplementation, validateGithub } from './nip39.ts'

1
nip42.test.ts
View File

@ -1,3 +1,4 @@
import { test, expect } from 'bun:test'
import 'websocket-polyfill'
import { makeAuthEvent } from './nip42.ts'

1
nip47.test.ts
View File

@ -1,3 +1,4 @@
import { describe, test, expect } from 'bun:test'
import { makeNwcRequestEvent, parseConnectionString } from './nip47'
import { decrypt } from './nip04.ts'
import crypto from 'node:crypto'

33
nip57.test.ts
View File

@ -1,3 +1,4 @@
import { describe, test, expect, mock } from 'bun:test'
import { finishEvent } from './event.ts'
import { getPublicKey, generatePrivateKey } from './keys.ts'
import { getZapEndpoint, makeZapReceipt, makeZapRequest, useFetchImplementation, validateZapRequest } from './nip57.ts'
@ -12,7 +13,7 @@ describe('getZapEndpoint', () => {
})
test('returns null if fetch fails', async () => {
const fetchImplementation = jest.fn(() => Promise.reject(new Error()))
const fetchImplementation = mock(() => Promise.reject(new Error()))
useFetchImplementation(fetchImplementation)
const metadata = buildEvent({ kind: 0, content: '{"lud16": "name@domain"}' })
@ -23,7 +24,7 @@ describe('getZapEndpoint', () => {
})
test('returns null if the response does not allow Nostr payments', async () => {
const fetchImplementation = jest.fn(() => Promise.resolve({ json: () => ({ allowsNostr: false }) }))
const fetchImplementation = mock(() => Promise.resolve({ json: () => ({ allowsNostr: false }) }))
useFetchImplementation(fetchImplementation)
const metadata = buildEvent({ kind: 0, content: '{"lud16": "name@domain"}' })
@ -34,7 +35,7 @@ describe('getZapEndpoint', () => {
})
test('returns the callback URL if the response allows Nostr payments', async () => {
const fetchImplementation = jest.fn(() =>
const fetchImplementation = mock(() =>
Promise.resolve({
json: () => ({
allowsNostr: true,
@ -94,9 +95,9 @@ describe('makeZapRequest', () => {
['p', 'profile'],
['amount', '100'],
['relays', 'relay1', 'relay2'],
['e', 'event'],
]),
)
expect(result.tags).toContainEqual(['e', 'event'])
})
})
@ -271,10 +272,14 @@ describe('makeZapReceipt', () => {
expect(result.kind).toBe(9735)
expect(result.created_at).toBeCloseTo(paidAt.getTime() / 1000, 0)
expect(result.content).toBe('')
expect(result.tags).toContainEqual(['bolt11', bolt11])
expect(result.tags).toContainEqual(['description', zapRequest])
expect(result.tags).toContainEqual(['p', publicKey])
expect(result.tags).toContainEqual(['preimage', preimage])
expect(result.tags).toEqual(
expect.arrayContaining([
['bolt11', bolt11],
['description', zapRequest],
['p', publicKey],
['preimage', preimage],
]),
)
})
test('returns a valid Zap receipt without a preimage', () => {
@ -304,9 +309,13 @@ describe('makeZapReceipt', () => {
expect(result.kind).toBe(9735)
expect(result.created_at).toBeCloseTo(paidAt.getTime() / 1000, 0)
expect(result.content).toBe('')
expect(result.tags).toContainEqual(['bolt11', bolt11])
expect(result.tags).toContainEqual(['description', zapRequest])
expect(result.tags).toContainEqual(['p', publicKey])
expect(result.tags).not.toContain('preimage')
expect(result.tags).toEqual(
expect.arrayContaining([
['bolt11', bolt11],
['description', zapRequest],
['p', publicKey],
]),
)
expect(JSON.stringify(result.tags)).not.toContain('preimage')
})
})

19
nip98.test.ts
View File

@ -1,3 +1,4 @@
import { describe, test, expect } from 'bun:test'
import { getToken, unpackEventFromToken, validateEvent, validateToken } from './nip98.ts'
import { Event, finishEvent } from './event.ts'
import { generatePrivateKey, getPublicKey } from './keys.ts'
@ -60,12 +61,12 @@ describe('getToken', () => {
test('getToken missing loginUrl throws an error', async () => {
const result = getToken('', 'get', e => finishEvent(e, sk))
await expect(result).rejects.toThrow(Error)
expect(result).rejects.toThrow(Error)
})
test('getToken missing httpMethod throws an error', async () => {
const result = getToken('http://test.com', '', e => finishEvent(e, sk))
await expect(result).rejects.toThrow(Error)
expect(result).rejects.toThrow(Error)
})
test('getToken returns token with a valid payload tag when payload is present', async () => {
@ -104,26 +105,26 @@ describe('validateToken', () => {
test('validateToken throws an error for invalid token', async () => {
const result = validateToken('fake', 'http://test.com', 'get')
await expect(result).rejects.toThrow(Error)
expect(result).rejects.toThrow(Error)
})
test('validateToken throws an error for missing token', async () => {
const result = validateToken('', 'http://test.com', 'get')
await expect(result).rejects.toThrow(Error)
expect(result).rejects.toThrow(Error)
})
test('validateToken throws an error for a wrong url', async () => {
const validToken = await getToken('http://test.com', 'get', e => finishEvent(e, sk))
const result = validateToken(validToken, 'http://wrong-test.com', 'get')
await expect(result).rejects.toThrow(Error)
expect(result).rejects.toThrow(Error)
})
test('validateToken throws an error for a wrong method', async () => {
const validToken = await getToken('http://test.com', 'get', e => finishEvent(e, sk))
const result = validateToken(validToken, 'http://test.com', 'post')
await expect(result).rejects.toThrow(Error)
expect(result).rejects.toThrow(Error)
})
test('validateEvent returns true for valid decoded token with authorization scheme', async () => {
@ -139,7 +140,7 @@ describe('validateToken', () => {
const decodedResult: Event = await unpackEventFromToken(validToken)
const result = validateEvent(decodedResult, 'http://wrong-test.com', 'get')
await expect(result).rejects.toThrow(Error)
expect(result).rejects.toThrow(Error)
})
test('validateEvent throws an error for a wrong method', async () => {
@ -147,7 +148,7 @@ describe('validateToken', () => {
const decodedResult: Event = await unpackEventFromToken(validToken)
const result = validateEvent(decodedResult, 'http://test.com', 'post')
await expect(result).rejects.toThrow(Error)
expect(result).rejects.toThrow(Error)
})
test('validateEvent returns true for valid payload tag hash', async () => {
@ -163,6 +164,6 @@ describe('validateToken', () => {
const decodedResult: Event = await unpackEventFromToken(validToken)
const result = validateEvent(decodedResult, 'http://test.com', 'post', { test: 'a-different-payload' })
await expect(result).rejects.toThrow(Error)
expect(result).rejects.toThrow(Error)
})
})

2
nip98.ts
View File

@ -26,8 +26,6 @@ export async function getToken(
includeAuthorizationScheme: boolean = false,
payload?: Record<string, any>,
): Promise<string> {
if (!loginUrl || !httpMethod) throw new Error('Missing loginUrl or httpMethod')
const event: EventTemplate = {
kind: HTTPAuth,
tags: [

10
package.json
View File

@ -169,29 +169,21 @@
"client",
"nostr"
],
"scripts": {
"build": "node build && tsc",
"format": "prettier --plugin-search-dir . --write .",
"test": "jest"
},
"devDependencies": {
"@types/jest": "^29.5.1",
"@types/node": "^18.13.0",
"@types/node-fetch": "^2.6.3",
"@typescript-eslint/eslint-plugin": "^6.5.0",
"@typescript-eslint/parser": "^6.5.0",
"bun-types": "^1.0.18",
"esbuild": "0.16.9",
"esbuild-plugin-alias": "^0.2.1",
"eslint": "^8.56.0",
"eslint-config-prettier": "^9.0.0",
"eslint-plugin-babel": "^5.3.1",
"eslint-plugin-jest": "^27.2.3",
"esm-loader-typescript": "^1.0.3",
"events": "^3.3.0",
"jest": "^29.5.0",
"node-fetch": "^2.6.9",
"prettier": "^3.0.3",
"ts-jest": "^29.1.0",
"tsd": "^0.22.0",
"typescript": "^5.0.4",
"websocket-polyfill": "^0.0.3"

1
pool.test.ts
View File

@ -1,3 +1,4 @@
import { test, expect } from 'bun:test'
import 'websocket-polyfill'
import { finishEvent, type Event } from './event.ts'

1
references.test.ts
View File

@ -1,3 +1,4 @@
import { test, expect } from 'bun:test'
import { parseReferences } from './references.ts'
import { buildEvent } from './test-helpers.ts'

1
relay.test.ts
View File

@ -1,3 +1,4 @@
import { test, expect } from 'bun:test'
import 'websocket-polyfill'
import { finishEvent } from './event.ts'

3
tsconfig.json
View File

@ -12,6 +12,7 @@
"outDir": "lib/types",
"resolveJsonModule": true,
"rootDir": ".",
"allowImportingTsExtensions": true
"allowImportingTsExtensions": true,
"types": ["bun-types"]
}
}

1
utils.test.ts
View File

@ -1,3 +1,4 @@
import { describe, test, expect } from 'bun:test'
import { buildEvent } from './test-helpers.ts'
import { MessageQueue, insertEventIntoAscendingList, insertEventIntoDescendingList } from './utils.ts'

4245
yarn.lock
View File

File diff suppressed because it is too large Load Diff