Merge pull request #385 from v0l/nostr-package-nip20-ok
`nostr` pacakge: implement basic NIP-20 `OK` functionality
This commit is contained in:
commit
ffc6f44e40
@ -1,6 +1,6 @@
|
|||||||
import { ProtocolError } from "../error"
|
import { ProtocolError } from "../error"
|
||||||
import { Filters, SubscriptionId } from "."
|
import { Filters, SubscriptionId } from "."
|
||||||
import { RawEvent, SignedEvent } from "../event"
|
import { EventId, RawEvent, SignedEvent } from "../event"
|
||||||
import WebSocket from "ws"
|
import WebSocket from "ws"
|
||||||
import { unixTimestamp } from "../util"
|
import { unixTimestamp } from "../util"
|
||||||
|
|
||||||
@ -14,7 +14,6 @@ import { unixTimestamp } from "../util"
|
|||||||
*/
|
*/
|
||||||
export class Conn {
|
export class Conn {
|
||||||
readonly #socket: WebSocket
|
readonly #socket: WebSocket
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Messages which were requested to be sent before the websocket was ready.
|
* Messages which were requested to be sent before the websocket was ready.
|
||||||
* Once the websocket becomes ready, these messages will be sent and cleared.
|
* Once the websocket becomes ready, these messages will be sent and cleared.
|
||||||
@ -23,16 +22,26 @@ export class Conn {
|
|||||||
// before NIP-44 auth. The legacy code reuses the same array for these two but I think they should be
|
// before NIP-44 auth. The legacy code reuses the same array for these two but I think they should be
|
||||||
// different, and the NIP-44 stuff should be handled by Nostr.
|
// different, and the NIP-44 stuff should be handled by Nostr.
|
||||||
#pending: OutgoingMessage[] = []
|
#pending: OutgoingMessage[] = []
|
||||||
|
/**
|
||||||
#msgCallback?: IncomingMessageCallback
|
* Callback for errors.
|
||||||
#errorCallback?: ErrorCallback
|
*/
|
||||||
|
readonly #onError: (err: unknown) => void
|
||||||
|
|
||||||
get url(): string {
|
get url(): string {
|
||||||
return this.#socket.url
|
return this.#socket.url
|
||||||
}
|
}
|
||||||
|
|
||||||
constructor(endpoint: string | URL) {
|
constructor({
|
||||||
this.#socket = new WebSocket(endpoint)
|
url,
|
||||||
|
onMessage,
|
||||||
|
onError,
|
||||||
|
}: {
|
||||||
|
url: URL
|
||||||
|
onMessage: (msg: IncomingMessage) => void
|
||||||
|
onError: (err: unknown) => void
|
||||||
|
}) {
|
||||||
|
this.#onError = onError
|
||||||
|
this.#socket = new WebSocket(url)
|
||||||
|
|
||||||
// Handle incoming messages.
|
// Handle incoming messages.
|
||||||
this.#socket.addEventListener("message", async (msgData) => {
|
this.#socket.addEventListener("message", async (msgData) => {
|
||||||
@ -40,14 +49,14 @@ export class Conn {
|
|||||||
// Validate and parse the message.
|
// Validate and parse the message.
|
||||||
if (typeof value !== "string") {
|
if (typeof value !== "string") {
|
||||||
const err = new ProtocolError(`invalid message data: ${value}`)
|
const err = new ProtocolError(`invalid message data: ${value}`)
|
||||||
this.#errorCallback?.(err)
|
onError(err)
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
try {
|
try {
|
||||||
const msg = await parseIncomingMessage(value)
|
const msg = await Conn.#parseIncomingMessage(value)
|
||||||
this.#msgCallback?.(msg)
|
onMessage(msg)
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
this.#errorCallback?.(err)
|
onError(err)
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
|
|
||||||
@ -60,22 +69,10 @@ export class Conn {
|
|||||||
})
|
})
|
||||||
|
|
||||||
this.#socket.addEventListener("error", (err) => {
|
this.#socket.addEventListener("error", (err) => {
|
||||||
this.#errorCallback?.(err)
|
onError(err)
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
on(on: "message", cb: IncomingMessageCallback): void
|
|
||||||
on(on: "error", cb: ErrorCallback): void
|
|
||||||
on(on: "message" | "error", cb: IncomingMessageCallback | ErrorCallback) {
|
|
||||||
if (on === "message") {
|
|
||||||
this.#msgCallback = cb as IncomingMessageCallback
|
|
||||||
} else if (on === "error") {
|
|
||||||
this.#errorCallback = cb as ErrorCallback
|
|
||||||
} else {
|
|
||||||
throw new Error(`unexpected input: ${on}`)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
send(msg: OutgoingMessage): void {
|
send(msg: OutgoingMessage): void {
|
||||||
if (this.#socket.readyState < WebSocket.OPEN) {
|
if (this.#socket.readyState < WebSocket.OPEN) {
|
||||||
this.#pending.push(msg)
|
this.#pending.push(msg)
|
||||||
@ -84,11 +81,11 @@ export class Conn {
|
|||||||
try {
|
try {
|
||||||
this.#socket.send(serializeOutgoingMessage(msg), (err) => {
|
this.#socket.send(serializeOutgoingMessage(msg), (err) => {
|
||||||
if (err !== undefined && err !== null) {
|
if (err !== undefined && err !== null) {
|
||||||
this.#errorCallback?.(err)
|
this.#onError?.(err)
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
this.#errorCallback?.(err)
|
this.#onError?.(err)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -96,93 +93,11 @@ export class Conn {
|
|||||||
try {
|
try {
|
||||||
this.#socket.close()
|
this.#socket.close()
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
this.#errorCallback?.(err)
|
this.#onError?.(err)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
static async #parseIncomingMessage(data: string): Promise<IncomingMessage> {
|
||||||
* A message sent from a relay to the client.
|
|
||||||
*/
|
|
||||||
export type IncomingMessage = IncomingEvent | IncomingNotice
|
|
||||||
|
|
||||||
export const enum IncomingKind {
|
|
||||||
Event,
|
|
||||||
Notice,
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Incoming "EVENT" message.
|
|
||||||
*/
|
|
||||||
export interface IncomingEvent {
|
|
||||||
kind: IncomingKind.Event
|
|
||||||
subscriptionId: SubscriptionId
|
|
||||||
signed: SignedEvent
|
|
||||||
raw: RawEvent
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Incoming "NOTICE" message.
|
|
||||||
*/
|
|
||||||
export interface IncomingNotice {
|
|
||||||
kind: IncomingKind.Notice
|
|
||||||
notice: string
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* A message sent from the client to a relay.
|
|
||||||
*/
|
|
||||||
export type OutgoingMessage =
|
|
||||||
| OutgoingEvent
|
|
||||||
| OutgoingOpenSubscription
|
|
||||||
| OutgoingCloseSubscription
|
|
||||||
|
|
||||||
export const enum OutgoingKind {
|
|
||||||
Event,
|
|
||||||
OpenSubscription,
|
|
||||||
CloseSubscription,
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Outgoing "EVENT" message.
|
|
||||||
*/
|
|
||||||
export interface OutgoingEvent {
|
|
||||||
kind: OutgoingKind.Event
|
|
||||||
event: SignedEvent | RawEvent
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Outgoing "REQ" message, which opens a subscription.
|
|
||||||
*/
|
|
||||||
export interface OutgoingOpenSubscription {
|
|
||||||
kind: OutgoingKind.OpenSubscription
|
|
||||||
id: SubscriptionId
|
|
||||||
filters: Filters[]
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Outgoing "CLOSE" message, which closes a subscription.
|
|
||||||
*/
|
|
||||||
export interface OutgoingCloseSubscription {
|
|
||||||
kind: OutgoingKind.CloseSubscription
|
|
||||||
id: SubscriptionId
|
|
||||||
}
|
|
||||||
|
|
||||||
type IncomingMessageCallback = (message: IncomingMessage) => unknown
|
|
||||||
type ErrorCallback = (error: unknown) => unknown
|
|
||||||
|
|
||||||
interface RawFilters {
|
|
||||||
ids?: string[]
|
|
||||||
authors?: string[]
|
|
||||||
kinds?: number[]
|
|
||||||
["#e"]?: string[]
|
|
||||||
["#p"]?: string[]
|
|
||||||
since?: number
|
|
||||||
until?: number
|
|
||||||
limit?: number
|
|
||||||
}
|
|
||||||
|
|
||||||
async function parseIncomingMessage(data: string): Promise<IncomingMessage> {
|
|
||||||
const json = parseJson(data)
|
const json = parseJson(data)
|
||||||
if (!(json instanceof Array)) {
|
if (!(json instanceof Array)) {
|
||||||
throw new ProtocolError(`incoming message is not an array: ${data}`)
|
throw new ProtocolError(`incoming message is not an array: ${data}`)
|
||||||
@ -203,7 +118,7 @@ async function parseIncomingMessage(data: string): Promise<IncomingMessage> {
|
|||||||
}
|
}
|
||||||
const raw = parseEventData(json[2])
|
const raw = parseEventData(json[2])
|
||||||
return {
|
return {
|
||||||
kind: IncomingKind.Event,
|
kind: "event",
|
||||||
subscriptionId: new SubscriptionId(json[1]),
|
subscriptionId: new SubscriptionId(json[1]),
|
||||||
signed: await SignedEvent.verify(raw),
|
signed: await SignedEvent.verify(raw),
|
||||||
raw,
|
raw,
|
||||||
@ -216,25 +131,130 @@ async function parseIncomingMessage(data: string): Promise<IncomingMessage> {
|
|||||||
)
|
)
|
||||||
}
|
}
|
||||||
return {
|
return {
|
||||||
kind: IncomingKind.Notice,
|
kind: "notice",
|
||||||
notice: json[1],
|
notice: json[1],
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
if (json[0] === "OK") {
|
||||||
|
if (typeof json[1] !== "string") {
|
||||||
|
throw new ProtocolError(
|
||||||
|
`second element of "OK" should be a string, but wasn't: ${data}`
|
||||||
|
)
|
||||||
|
}
|
||||||
|
if (typeof json[2] !== "boolean") {
|
||||||
|
throw new ProtocolError(
|
||||||
|
`third element of "OK" should be a boolean, but wasn't: ${data}`
|
||||||
|
)
|
||||||
|
}
|
||||||
|
if (typeof json[3] !== "string") {
|
||||||
|
throw new ProtocolError(
|
||||||
|
`fourth element of "OK" should be a string, but wasn't: ${data}`
|
||||||
|
)
|
||||||
|
}
|
||||||
|
return {
|
||||||
|
kind: "ok",
|
||||||
|
eventId: new EventId(json[1]),
|
||||||
|
ok: json[2],
|
||||||
|
message: json[3],
|
||||||
|
}
|
||||||
|
}
|
||||||
throw new ProtocolError(`unknown incoming message: ${data}`)
|
throw new ProtocolError(`unknown incoming message: ${data}`)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A message sent from a relay to the client.
|
||||||
|
*/
|
||||||
|
export type IncomingMessage = IncomingEvent | IncomingNotice | IncomingOk
|
||||||
|
|
||||||
|
export type IncomingKind = "event" | "notice" | "ok"
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Incoming "EVENT" message.
|
||||||
|
*/
|
||||||
|
export interface IncomingEvent {
|
||||||
|
kind: "event"
|
||||||
|
subscriptionId: SubscriptionId
|
||||||
|
signed: SignedEvent
|
||||||
|
raw: RawEvent
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Incoming "NOTICE" message.
|
||||||
|
*/
|
||||||
|
export interface IncomingNotice {
|
||||||
|
kind: "notice"
|
||||||
|
notice: string
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Incoming "OK" message.
|
||||||
|
*/
|
||||||
|
export interface IncomingOk {
|
||||||
|
kind: "ok"
|
||||||
|
eventId: EventId
|
||||||
|
ok: boolean
|
||||||
|
message: string
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A message sent from the client to a relay.
|
||||||
|
*/
|
||||||
|
export type OutgoingMessage =
|
||||||
|
| OutgoingEvent
|
||||||
|
| OutgoingOpenSubscription
|
||||||
|
| OutgoingCloseSubscription
|
||||||
|
|
||||||
|
export type OutgoingKind = "event" | "openSubscription" | "closeSubscription"
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Outgoing "EVENT" message.
|
||||||
|
*/
|
||||||
|
export interface OutgoingEvent {
|
||||||
|
kind: "event"
|
||||||
|
event: SignedEvent | RawEvent
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Outgoing "REQ" message, which opens a subscription.
|
||||||
|
*/
|
||||||
|
export interface OutgoingOpenSubscription {
|
||||||
|
kind: "openSubscription"
|
||||||
|
id: SubscriptionId
|
||||||
|
filters: Filters[]
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Outgoing "CLOSE" message, which closes a subscription.
|
||||||
|
*/
|
||||||
|
export interface OutgoingCloseSubscription {
|
||||||
|
kind: "closeSubscription"
|
||||||
|
id: SubscriptionId
|
||||||
|
}
|
||||||
|
|
||||||
|
interface RawFilters {
|
||||||
|
ids?: string[]
|
||||||
|
authors?: string[]
|
||||||
|
kinds?: number[]
|
||||||
|
["#e"]?: string[]
|
||||||
|
["#p"]?: string[]
|
||||||
|
since?: number
|
||||||
|
until?: number
|
||||||
|
limit?: number
|
||||||
}
|
}
|
||||||
|
|
||||||
function serializeOutgoingMessage(msg: OutgoingMessage): string {
|
function serializeOutgoingMessage(msg: OutgoingMessage): string {
|
||||||
if (msg.kind === OutgoingKind.Event) {
|
if (msg.kind === "event") {
|
||||||
const raw =
|
const raw =
|
||||||
msg.event instanceof SignedEvent ? msg.event.serialize() : msg.event
|
msg.event instanceof SignedEvent ? msg.event.serialize() : msg.event
|
||||||
return JSON.stringify(["EVENT", raw])
|
return JSON.stringify(["EVENT", raw])
|
||||||
} else if (msg.kind === OutgoingKind.OpenSubscription) {
|
} else if (msg.kind === "openSubscription") {
|
||||||
return JSON.stringify([
|
return JSON.stringify([
|
||||||
"REQ",
|
"REQ",
|
||||||
msg.id.toString(),
|
msg.id.toString(),
|
||||||
...serializeFilters(msg.filters),
|
...serializeFilters(msg.filters),
|
||||||
])
|
])
|
||||||
} else if (msg.kind === OutgoingKind.CloseSubscription) {
|
} else if (msg.kind === "closeSubscription") {
|
||||||
return JSON.stringify(["CLOSE", msg.id.toString()])
|
return JSON.stringify(["CLOSE", msg.id.toString()])
|
||||||
} else {
|
} else {
|
||||||
throw new Error(`invalid message: ${JSON.stringify(msg)}`)
|
throw new Error(`invalid message: ${JSON.stringify(msg)}`)
|
||||||
|
@ -1,5 +1,6 @@
|
|||||||
import Base from "events"
|
import Base from "events"
|
||||||
import { EventParams, Nostr } from "."
|
import { Nostr, SubscriptionId } from "."
|
||||||
|
import { EventId, RawEvent, SignedEvent } from "../event"
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Overrides providing better types for EventEmitter methods.
|
* Overrides providing better types for EventEmitter methods.
|
||||||
@ -11,6 +12,7 @@ export class EventEmitter extends Base {
|
|||||||
listener: RemoveListener
|
listener: RemoveListener
|
||||||
): this
|
): this
|
||||||
override addListener(eventName: "notice", listener: NoticeListener): this
|
override addListener(eventName: "notice", listener: NoticeListener): this
|
||||||
|
override addListener(eventName: "ok", listener: OkListener): this
|
||||||
override addListener(eventName: "error", listener: ErrorListener): this
|
override addListener(eventName: "error", listener: ErrorListener): this
|
||||||
override addListener(eventName: "newListener", listener: ErrorListener): this
|
override addListener(eventName: "newListener", listener: ErrorListener): this
|
||||||
override addListener(eventName: EventName, listener: Listener): this {
|
override addListener(eventName: EventName, listener: Listener): this {
|
||||||
@ -21,6 +23,7 @@ export class EventEmitter extends Base {
|
|||||||
override emit(eventName: "removeListener", listener: RemoveListener): boolean
|
override emit(eventName: "removeListener", listener: RemoveListener): boolean
|
||||||
override emit(eventName: "event", params: EventParams, nostr: Nostr): boolean
|
override emit(eventName: "event", params: EventParams, nostr: Nostr): boolean
|
||||||
override emit(eventName: "notice", notice: string, nostr: Nostr): boolean
|
override emit(eventName: "notice", notice: string, nostr: Nostr): boolean
|
||||||
|
override emit(eventName: "ok", params: OkParams, nostr: Nostr): boolean
|
||||||
override emit(eventName: "error", err: unknown, nostr: Nostr): boolean
|
override emit(eventName: "error", err: unknown, nostr: Nostr): boolean
|
||||||
override emit(eventName: EventName, ...args: unknown[]): boolean {
|
override emit(eventName: EventName, ...args: unknown[]): boolean {
|
||||||
return super.emit(eventName, ...args)
|
return super.emit(eventName, ...args)
|
||||||
@ -34,6 +37,7 @@ export class EventEmitter extends Base {
|
|||||||
override listeners(eventName: "removeListener"): EventListener[]
|
override listeners(eventName: "removeListener"): EventListener[]
|
||||||
override listeners(eventName: "event"): EventListener[]
|
override listeners(eventName: "event"): EventListener[]
|
||||||
override listeners(eventName: "notice"): NoticeListener[]
|
override listeners(eventName: "notice"): NoticeListener[]
|
||||||
|
override listeners(eventName: "ok"): OkListener[]
|
||||||
override listeners(eventName: "error"): ErrorListener[]
|
override listeners(eventName: "error"): ErrorListener[]
|
||||||
override listeners(eventName: EventName): Listener[] {
|
override listeners(eventName: EventName): Listener[] {
|
||||||
return super.listeners(eventName) as Listener[]
|
return super.listeners(eventName) as Listener[]
|
||||||
@ -43,8 +47,9 @@ export class EventEmitter extends Base {
|
|||||||
override off(eventName: "removeListener", listener: RemoveListener): this
|
override off(eventName: "removeListener", listener: RemoveListener): this
|
||||||
override off(eventName: "event", listener: EventListener): this
|
override off(eventName: "event", listener: EventListener): this
|
||||||
override off(eventName: "notice", listener: NoticeListener): this
|
override off(eventName: "notice", listener: NoticeListener): this
|
||||||
|
override off(eventName: "ok", listener: OkListener): this
|
||||||
override off(eventName: "error", listener: ErrorListener): this
|
override off(eventName: "error", listener: ErrorListener): this
|
||||||
override off(eventName: string, listener: Listener): this {
|
override off(eventName: EventName, listener: Listener): this {
|
||||||
return super.off(eventName, listener)
|
return super.off(eventName, listener)
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -52,6 +57,7 @@ export class EventEmitter extends Base {
|
|||||||
override on(eventName: "removeListener", listener: RemoveListener): this
|
override on(eventName: "removeListener", listener: RemoveListener): this
|
||||||
override on(eventName: "event", listener: EventListener): this
|
override on(eventName: "event", listener: EventListener): this
|
||||||
override on(eventName: "notice", listener: NoticeListener): this
|
override on(eventName: "notice", listener: NoticeListener): this
|
||||||
|
override on(eventName: "ok", listener: OkListener): this
|
||||||
override on(eventName: "error", listener: ErrorListener): this
|
override on(eventName: "error", listener: ErrorListener): this
|
||||||
override on(eventName: EventName, listener: Listener): this {
|
override on(eventName: EventName, listener: Listener): this {
|
||||||
return super.on(eventName, listener)
|
return super.on(eventName, listener)
|
||||||
@ -61,6 +67,7 @@ export class EventEmitter extends Base {
|
|||||||
override once(eventName: "removeListener", listener: RemoveListener): this
|
override once(eventName: "removeListener", listener: RemoveListener): this
|
||||||
override once(eventName: "event", listener: EventListener): this
|
override once(eventName: "event", listener: EventListener): this
|
||||||
override once(eventName: "notice", listener: NoticeListener): this
|
override once(eventName: "notice", listener: NoticeListener): this
|
||||||
|
override once(eventName: "ok", listener: OkListener): this
|
||||||
override once(eventName: "error", listener: ErrorListener): this
|
override once(eventName: "error", listener: ErrorListener): this
|
||||||
override once(eventName: EventName, listener: Listener): this {
|
override once(eventName: EventName, listener: Listener): this {
|
||||||
return super.once(eventName, listener)
|
return super.once(eventName, listener)
|
||||||
@ -76,6 +83,7 @@ export class EventEmitter extends Base {
|
|||||||
): this
|
): this
|
||||||
override prependListener(eventName: "event", listener: EventListener): this
|
override prependListener(eventName: "event", listener: EventListener): this
|
||||||
override prependListener(eventName: "notice", listener: NoticeListener): this
|
override prependListener(eventName: "notice", listener: NoticeListener): this
|
||||||
|
override prependListener(eventName: "ok", listener: OkListener): this
|
||||||
override prependListener(eventName: "error", listener: ErrorListener): this
|
override prependListener(eventName: "error", listener: ErrorListener): this
|
||||||
override prependListener(eventName: EventName, listener: Listener): this {
|
override prependListener(eventName: EventName, listener: Listener): this {
|
||||||
return super.prependListener(eventName, listener)
|
return super.prependListener(eventName, listener)
|
||||||
@ -97,6 +105,7 @@ export class EventEmitter extends Base {
|
|||||||
eventName: "notice",
|
eventName: "notice",
|
||||||
listener: NoticeListener
|
listener: NoticeListener
|
||||||
): this
|
): this
|
||||||
|
override prependOnceListener(eventName: "ok", listener: OkListener): this
|
||||||
override prependOnceListener(
|
override prependOnceListener(
|
||||||
eventName: "error",
|
eventName: "error",
|
||||||
listener: ErrorListener
|
listener: ErrorListener
|
||||||
@ -116,6 +125,7 @@ export class EventEmitter extends Base {
|
|||||||
): this
|
): this
|
||||||
override removeListener(eventName: "event", listener: EventListener): this
|
override removeListener(eventName: "event", listener: EventListener): this
|
||||||
override removeListener(eventName: "notice", listener: NoticeListener): this
|
override removeListener(eventName: "notice", listener: NoticeListener): this
|
||||||
|
override removeListener(eventName: "ok", listener: OkListener): this
|
||||||
override removeListener(eventName: "error", listener: ErrorListener): this
|
override removeListener(eventName: "error", listener: ErrorListener): this
|
||||||
override removeListener(eventName: EventName, listener: Listener): this {
|
override removeListener(eventName: EventName, listener: Listener): this {
|
||||||
return super.removeListener(eventName, listener)
|
return super.removeListener(eventName, listener)
|
||||||
@ -131,15 +141,40 @@ export class EventEmitter extends Base {
|
|||||||
|
|
||||||
// TODO Also add on: ("subscribed", subscriptionId) which checks "OK"/"NOTICE" and makes a callback?
|
// TODO Also add on: ("subscribed", subscriptionId) which checks "OK"/"NOTICE" and makes a callback?
|
||||||
// TODO Also add on: ("ok", boolean, eventId) which checks "OK"/"NOTICE" and makes a callback?
|
// TODO Also add on: ("ok", boolean, eventId) which checks "OK"/"NOTICE" and makes a callback?
|
||||||
type EventName = "newListener" | "removeListener" | "event" | "notice" | "error"
|
type EventName =
|
||||||
|
| "newListener"
|
||||||
|
| "removeListener"
|
||||||
|
| "event"
|
||||||
|
| "notice"
|
||||||
|
| "ok"
|
||||||
|
| "error"
|
||||||
|
|
||||||
type NewListener = (eventName: EventName, listener: Listener) => void
|
type NewListener = (eventName: EventName, listener: Listener) => void
|
||||||
type RemoveListener = (eventName: EventName, listener: Listener) => void
|
type RemoveListener = (eventName: EventName, listener: Listener) => void
|
||||||
type EventListener = (params: EventParams, nostr: Nostr) => void
|
type EventListener = (params: EventParams, nostr: Nostr) => void
|
||||||
|
type OkListener = (params: OkParams, nostr: Nostr) => void
|
||||||
type NoticeListener = (notice: string, nostr: Nostr) => void
|
type NoticeListener = (notice: string, nostr: Nostr) => void
|
||||||
type ErrorListener = (error: unknown, nostr: Nostr) => void
|
type ErrorListener = (error: unknown, nostr: Nostr) => void
|
||||||
|
|
||||||
type Listener =
|
type Listener =
|
||||||
| NewListener
|
| NewListener
|
||||||
| RemoveListener
|
| RemoveListener
|
||||||
| EventListener
|
| EventListener
|
||||||
| NoticeListener
|
| NoticeListener
|
||||||
|
| OkListener
|
||||||
| ErrorListener
|
| ErrorListener
|
||||||
|
|
||||||
|
// TODO Document this
|
||||||
|
export interface EventParams {
|
||||||
|
signed: SignedEvent
|
||||||
|
subscriptionId: SubscriptionId
|
||||||
|
raw: RawEvent
|
||||||
|
}
|
||||||
|
|
||||||
|
// TODO Document this
|
||||||
|
export interface OkParams {
|
||||||
|
eventId: EventId
|
||||||
|
relay: URL
|
||||||
|
ok: boolean
|
||||||
|
message: string
|
||||||
|
}
|
||||||
|
@ -1,7 +1,7 @@
|
|||||||
import { ProtocolError } from "../error"
|
import { ProtocolError } from "../error"
|
||||||
import { EventId, Event, EventKind, SignedEvent, RawEvent } from "../event"
|
import { EventId, Event, EventKind, SignedEvent, RawEvent } from "../event"
|
||||||
import { PrivateKey, PublicKey } from "../keypair"
|
import { PrivateKey, PublicKey } from "../keypair"
|
||||||
import { Conn, IncomingKind, OutgoingKind } from "./conn"
|
import { Conn } from "./conn"
|
||||||
import * as secp from "@noble/secp256k1"
|
import * as secp from "@noble/secp256k1"
|
||||||
import { EventEmitter } from "./emitter"
|
import { EventEmitter } from "./emitter"
|
||||||
|
|
||||||
@ -46,13 +46,15 @@ export class Nostr extends EventEmitter {
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
// If there is no existing connection, open a new one.
|
const connUrl = new URL(url)
|
||||||
const conn = new Conn(url)
|
|
||||||
|
|
||||||
|
// If there is no existing connection, open a new one.
|
||||||
|
const conn = new Conn({
|
||||||
|
url: connUrl,
|
||||||
// Handle messages on this connection.
|
// Handle messages on this connection.
|
||||||
conn.on("message", async (msg) => {
|
onMessage: (msg) => {
|
||||||
try {
|
try {
|
||||||
if (msg.kind === IncomingKind.Event) {
|
if (msg.kind === "event") {
|
||||||
this.emit(
|
this.emit(
|
||||||
"event",
|
"event",
|
||||||
{
|
{
|
||||||
@ -62,26 +64,35 @@ export class Nostr extends EventEmitter {
|
|||||||
},
|
},
|
||||||
this
|
this
|
||||||
)
|
)
|
||||||
} else if (msg.kind === IncomingKind.Notice) {
|
} else if (msg.kind === "notice") {
|
||||||
this.emit("notice", msg.notice, this)
|
this.emit("notice", msg.notice, this)
|
||||||
|
} else if (msg.kind === "ok") {
|
||||||
|
this.emit(
|
||||||
|
"ok",
|
||||||
|
{
|
||||||
|
eventId: msg.eventId,
|
||||||
|
relay: connUrl,
|
||||||
|
ok: msg.ok,
|
||||||
|
message: msg.message,
|
||||||
|
},
|
||||||
|
this
|
||||||
|
)
|
||||||
} else {
|
} else {
|
||||||
throw new ProtocolError(`invalid message ${msg}`)
|
throw new ProtocolError(`invalid message ${msg}`)
|
||||||
}
|
}
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
this.emit("error", err, this)
|
this.emit("error", err, this)
|
||||||
}
|
}
|
||||||
})
|
},
|
||||||
|
// Forward errors on this connection.
|
||||||
// Forward connection errors to the error callbacks.
|
onError: (err) => this.emit("error", err, this),
|
||||||
conn.on("error", (err) => {
|
|
||||||
this.emit("error", err, this)
|
|
||||||
})
|
})
|
||||||
|
|
||||||
// Resend existing subscriptions to this connection.
|
// Resend existing subscriptions to this connection.
|
||||||
for (const [key, filters] of this.#subscriptions.entries()) {
|
for (const [key, filters] of this.#subscriptions.entries()) {
|
||||||
const subscriptionId = new SubscriptionId(key)
|
const subscriptionId = new SubscriptionId(key)
|
||||||
conn.send({
|
conn.send({
|
||||||
kind: OutgoingKind.OpenSubscription,
|
kind: "openSubscription",
|
||||||
id: subscriptionId,
|
id: subscriptionId,
|
||||||
filters,
|
filters,
|
||||||
})
|
})
|
||||||
@ -145,7 +156,7 @@ export class Nostr extends EventEmitter {
|
|||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
conn.send({
|
conn.send({
|
||||||
kind: OutgoingKind.OpenSubscription,
|
kind: "openSubscription",
|
||||||
id: subscriptionId,
|
id: subscriptionId,
|
||||||
filters,
|
filters,
|
||||||
})
|
})
|
||||||
@ -167,7 +178,7 @@ export class Nostr extends EventEmitter {
|
|||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
conn.send({
|
conn.send({
|
||||||
kind: OutgoingKind.CloseSubscription,
|
kind: "closeSubscription",
|
||||||
id: subscriptionId,
|
id: subscriptionId,
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
@ -210,7 +221,7 @@ export class Nostr extends EventEmitter {
|
|||||||
event = await SignedEvent.sign(event, key)
|
event = await SignedEvent.sign(event, key)
|
||||||
}
|
}
|
||||||
conn.send({
|
conn.send({
|
||||||
kind: OutgoingKind.Event,
|
kind: "event",
|
||||||
event,
|
event,
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
@ -289,10 +300,3 @@ export interface Filters {
|
|||||||
until?: Date
|
until?: Date
|
||||||
limit?: number
|
limit?: number
|
||||||
}
|
}
|
||||||
|
|
||||||
// TODO Document this
|
|
||||||
export interface EventParams {
|
|
||||||
signed: SignedEvent
|
|
||||||
subscriptionId: SubscriptionId
|
|
||||||
raw: RawEvent
|
|
||||||
}
|
|
||||||
|
@ -87,7 +87,8 @@ export class EventId {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
private constructor(hex: string) {
|
constructor(hex: string) {
|
||||||
|
// TODO Validate that this is 32-byte hex
|
||||||
this.#hex = hex
|
this.#hex = hex
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -1,26 +1,37 @@
|
|||||||
import { EventParams, Nostr } from "../src/client"
|
import { Nostr } from "../src/client"
|
||||||
import { EventKind } from "../src/event"
|
import { EventKind, SignedEvent } from "../src/event"
|
||||||
import { PrivateKey } from "../src/keypair"
|
import { PrivateKey } from "../src/keypair"
|
||||||
import assert from "assert"
|
import assert from "assert"
|
||||||
|
import { EventParams } from "../src/client/emitter"
|
||||||
|
|
||||||
// TODO Switch out the relay implementation and see if the issue persists
|
// TODO Switch out the relay implementation and see if the issue persists
|
||||||
|
// TODO Do on("error", done) for all of these
|
||||||
|
|
||||||
describe("single event communication", function () {
|
describe("simple communication", function () {
|
||||||
it("ok", function (done) {
|
|
||||||
const secret = new PrivateKey(
|
const secret = new PrivateKey(
|
||||||
"nsec1xlu55y6fqfgrq448xslt6a8j2rh7lj08hyhgs94ryq04yf6surwsjl0kzh"
|
"nsec1xlu55y6fqfgrq448xslt6a8j2rh7lj08hyhgs94ryq04yf6surwsjl0kzh"
|
||||||
)
|
)
|
||||||
const pubkey = secret.pubkey
|
const pubkey = secret.pubkey
|
||||||
|
|
||||||
const timestamp = new Date()
|
const timestamp = new Date()
|
||||||
const note = "hello world"
|
const note = "hello world"
|
||||||
|
const url = new URL("ws://localhost:12648")
|
||||||
|
|
||||||
const publisher = new Nostr()
|
const publisher = new Nostr()
|
||||||
publisher.open("ws://localhost:12648")
|
|
||||||
const subscriber = new Nostr()
|
const subscriber = new Nostr()
|
||||||
subscriber.open("ws://localhost:12648")
|
|
||||||
|
|
||||||
function listener({ signed: { event } }: EventParams) {
|
beforeEach(() => {
|
||||||
|
publisher.open(url)
|
||||||
|
subscriber.open(url)
|
||||||
|
})
|
||||||
|
|
||||||
|
afterEach(() => {
|
||||||
|
publisher.close()
|
||||||
|
subscriber.close()
|
||||||
|
})
|
||||||
|
|
||||||
|
it("publish and receive", function (done) {
|
||||||
|
function listener({ signed: { event } }: EventParams, nostr: Nostr) {
|
||||||
|
assert.equal(nostr, subscriber)
|
||||||
assert.equal(event.kind, EventKind.TextNote)
|
assert.equal(event.kind, EventKind.TextNote)
|
||||||
assert.equal(event.pubkey.toString(), pubkey.toString())
|
assert.equal(event.pubkey.toString(), pubkey.toString())
|
||||||
assert.equal(event.createdAt.toString(), timestamp.toString())
|
assert.equal(event.createdAt.toString(), timestamp.toString())
|
||||||
@ -34,16 +45,11 @@ describe("single event communication", function () {
|
|||||||
// for future events.
|
// for future events.
|
||||||
subscriber.off("event", listener)
|
subscriber.off("event", listener)
|
||||||
|
|
||||||
publisher.close()
|
|
||||||
subscriber.close()
|
|
||||||
|
|
||||||
done()
|
done()
|
||||||
}
|
}
|
||||||
|
|
||||||
subscriber.on("event", listener)
|
subscriber.on("event", listener)
|
||||||
|
|
||||||
subscriber.subscribe([])
|
subscriber.subscribe([])
|
||||||
|
|
||||||
publisher.publish(
|
publisher.publish(
|
||||||
{
|
{
|
||||||
kind: EventKind.TextNote,
|
kind: EventKind.TextNote,
|
||||||
@ -54,4 +60,26 @@ describe("single event communication", function () {
|
|||||||
secret
|
secret
|
||||||
)
|
)
|
||||||
})
|
})
|
||||||
|
|
||||||
|
it("publish and ok", function (done) {
|
||||||
|
SignedEvent.sign(
|
||||||
|
{
|
||||||
|
kind: EventKind.TextNote,
|
||||||
|
createdAt: timestamp,
|
||||||
|
content: note,
|
||||||
|
pubkey,
|
||||||
|
},
|
||||||
|
secret
|
||||||
|
).then((event) => {
|
||||||
|
publisher.on("ok", (params, nostr) => {
|
||||||
|
assert.equal(nostr, publisher)
|
||||||
|
assert.equal(params.eventId.toString(), event.eventId.toString())
|
||||||
|
assert.equal(params.relay.toString(), url.toString())
|
||||||
|
assert.equal(params.ok, true)
|
||||||
|
done()
|
||||||
|
})
|
||||||
|
publisher.on("error", done)
|
||||||
|
publisher.publish(event)
|
||||||
|
})
|
||||||
|
})
|
||||||
})
|
})
|
||||||
|
Loading…
Reference in New Issue
Block a user