nostr-tools 1.4.2 → 1.5.0

package/README.md

@@ -4,6 +4,13 @@ Tools for developing [Nostr](https://github.com/fiatjaf/nostr) clients.
 
 Only depends on _@scure_ and _@noble_ packages.
 
+## Installation
+
+```bash
+ npm install nostr-tools # or yarn add nostr-tools
+```
+
+
 ## Usage
 
 ### Generating a private key and a public key
@@ -53,8 +60,6 @@ import {
 } from 'nostr-tools'
 
 const relay = relayInit('wss://relay.example.com')
-await relay.connect()
-
 relay.on('connect', () => {
   console.log(`connected to ${relay.url}`)
 })
@@ -62,6 +67,8 @@ relay.on('error', () => {
   console.log(`failed to connect to ${relay.url}`)
 })
 
+await relay.connect()
+
 // let's query for an event that exists
 let sub = relay.sub([
   {

package/event.ts

@@ -2,6 +2,7 @@ import * as secp256k1 from '@noble/secp256k1'
 import {sha256} from '@noble/hashes/sha256'
 
 import {utf8Encoder} from './utils'
+import {getPublicKey} from './keys'
 
 /* eslint-disable no-unused-vars */
 export enum Kind {
@@ -32,8 +33,11 @@ export type EventTemplate = {
   created_at: number
 }
 
-export type Event = EventTemplate & {
+export type UnsignedEvent = EventTemplate & {
   pubkey: string
+}
+
+export type Event = UnsignedEvent & {
   id: string
   sig: string
 }
@@ -47,7 +51,15 @@ export function getBlankEvent(): EventTemplate {
   }
 }
 
-export function serializeEvent(evt: Event): string {
+export function finishEvent(t: EventTemplate, privateKey: string): Event {
+  let event = t as Event
+  event.pubkey = getPublicKey(privateKey)
+  event.id = getEventHash(event)
+  event.sig = signEvent(event, privateKey)
+  return event
+}
+
+export function serializeEvent(evt: UnsignedEvent): string {
   if (!validateEvent(evt))
     throw new Error("can't serialize event with wrong or missing properties")
 
@@ -61,12 +73,12 @@ export function serializeEvent(evt: Event): string {
   ])
 }
 
-export function getEventHash(event: Event): string {
+export function getEventHash(event: UnsignedEvent): string {
   let eventHash = sha256(utf8Encoder.encode(serializeEvent(event)))
   return secp256k1.utils.bytesToHex(eventHash)
 }
 
-export function validateEvent(event: Event): boolean {
+export function validateEvent(event: UnsignedEvent): boolean {
   if (typeof event !== 'object') return false
   if (typeof event.content !== 'string') return false
   if (typeof event.created_at !== 'number') return false
@@ -93,7 +105,7 @@ export function verifySignature(event: Event & {sig: string}): boolean {
   )
 }
 
-export function signEvent(event: Event, key: string): string {
+export function signEvent(event: UnsignedEvent, key: string): string {
   return secp256k1.utils.bytesToHex(
     secp256k1.schnorr.signSync(getEventHash(event), key)
   )

package/lib/nostr.bundle.js

@@ -3605,6 +3605,7 @@ zoo`.split("\n");
   __export(nostr_tools_exports, {
     Kind: () => Kind,
     SimplePool: () => SimplePool,
+    finishEvent: () => finishEvent,
     fj: () => fakejson_exports,
     generatePrivateKey: () => generatePrivateKey,
     getBlankEvent: () => getBlankEvent,
@@ -5117,6 +5118,13 @@ zoo`.split("\n");
       created_at: 0
     };
   }
+  function finishEvent(t, privateKey) {
+    let event = t;
+    event.pubkey = getPublicKey(privateKey);
+    event.id = getEventHash(event);
+    event.sig = signEvent(event, privateKey);
+    return event;
+  }
   function serializeEvent(evt) {
     if (!validateEvent(evt))
       throw new Error("can't serialize event with wrong or missing properties");
@@ -8459,7 +8467,8 @@ zoo`.split("\n");
     getZapEndpoint: () => getZapEndpoint,
     makeZapReceipt: () => makeZapReceipt,
     makeZapRequest: () => makeZapRequest,
-    useFetchImplementation: () => useFetchImplementation2
+    useFetchImplementation: () => useFetchImplementation2,
+    validateZapRequest: () => validateZapRequest
   });
   init_define_process();
   var _fetch2;
@@ -8500,13 +8509,17 @@ zoo`.split("\n");
     relays,
     comment = ""
   }) {
+    if (!amount)
+      throw new Error("amount not given");
+    if (!profile)
+      throw new Error("profile not given");
     let zr = {
       kind: 9734,
       created_at: Math.round(Date.now() / 1e3),
       content: comment,
       tags: [
         ["p", profile],
-        ["amount", amount],
+        ["amount", amount.toString()],
         ["relays", ...relays]
       ]
     };
@@ -8515,6 +8528,30 @@ zoo`.split("\n");
     }
     return zr;
   }
+  function validateZapRequest(zapRequestString) {
+    let zapRequest;
+    try {
+      zapRequest = JSON.parse(zapRequestString);
+    } catch (err) {
+      return "Invalid zap request JSON.";
+    }
+    if (!validateEvent(zapRequest))
+      return "Zap request is not a valid Nostr event.";
+    if (!verifySignature(zapRequest))
+      return "Invalid signature on zap request.";
+    let p = zapRequest.tags.find(([t, v]) => t === "p" && v);
+    if (!p)
+      return "Zap request doesn't have a 'p' tag.";
+    if (!p[1].match(/^[a-f0-9]{64}$/))
+      return "Zap request 'p' tag is not valid hex.";
+    let e = zapRequest.tags.find(([t, v]) => t === "e" && v);
+    if (e && !e[1].match(/^[a-f0-9]{64}$/))
+      return "Zap request 'e' tag is not valid hex.";
+    let relays = zapRequest.tags.find(([t, v]) => t === "relays" && v);
+    if (!relays)
+      return "Zap request doesn't have a 'relays' tag.";
+    return null;
+  }
   function makeZapReceipt({
     zapRequest,
     preimage,