fix docs

nostr-dev-kit · Aug 2, 2024 · 36ea99b · 36ea99b
1 parent cdb656f
commit 36ea99b
Show file tree

Hide file tree

Showing 13 changed files with 80 additions and 50 deletions.
diff --git a/ndk/src/cache/index.ts b/ndk/src/cache/index.ts
@@ -3,7 +3,7 @@ import type { NDKRelay } from "../relay/index.js";
 import type { NDKFilter, NDKSubscription } from "../subscription/index.js";
 import type { Hexpubkey, ProfilePointer } from "../user/index.js";
 import type { NDKUserProfile } from "../user/profile.js";
-import { NDKLnUrlData } from "../zapper/ln.js";
+import type { NDKLnUrlData } from "../zapper/ln.js";
 
 export interface NDKCacheAdapter {
     /**

diff --git a/ndk/src/events/encode.test.ts b/ndk/src/events/encode.test.ts
@@ -8,7 +8,6 @@ describe("event.encode", () => {
     it("encodes all relays the event is known to be on", async () => {
         const event = new NDKEvent(undefined);
         event.kind = 1;
-        event.onRelays = [new NDKRelay("wss://relay1/"), new NDKRelay("wss://relay2/")];
         await event.sign(NDKPrivateKeySigner.generate());
 
         const encoded = event.encode();

diff --git a/ndk/src/events/kinds/nutzap/index.ts b/ndk/src/events/kinds/nutzap/index.ts
@@ -1,6 +1,8 @@
 import debug from "debug";
-import NDK, { Hexpubkey, NDKEvent, NDKKind, NDKUser, NostrEvent } from "../../../index.js";
-import { Proof } from "./proof.js";
+import type { Hexpubkey, NostrEvent } from "../../../index.js";
+import type NDK from "../../../index.js";
+import { NDKEvent, NDKKind, NDKUser } from "../../../index.js";
+import type { Proof } from "./proof.js";
 
 /**
  * Represents a NIP-61 nutzap
@@ -116,7 +118,7 @@ export class NDKNutzap extends NDKEvent {
         return this.tagValue("unit") ?? "msat";
     }
 
-    set unit(value: string | undefined) { 
+    set unit(value: string | undefined) {
         this.removeTag("unit");
         if (value) this.tag(["unit", value]);
     }
@@ -177,4 +179,4 @@ export class NDKNutzap extends NDKEvent {
             this.proofs.length > 0
         );
     }
-}
+}
diff --git a/ndk/src/ndk/index.ts b/ndk/src/ndk/index.ts
@@ -25,9 +25,17 @@ import { Queue } from "./queue/index.js";
 import { signatureVerificationInit } from "../events/signature.js";
 import { NDKSubscriptionManager } from "../subscription/manager.js";
 import { setActiveUser } from "./active-user.js";
-import { CashuPayCb, LnPayCb, NDKPaymentConfirmation, NDKZapConfirmation, NDKZapper, NDKZapSplit } from "../zapper/index.js";
+import type {
+    CashuPayCb,
+    LnPayCb,
+    NDKPaymentConfirmation,
+    NDKZapSplit} from "../zapper/index.js";
+import {
+    NDKZapConfirmation,
+    NDKZapper
+} from "../zapper/index.js";
 import type { NostrEvent } from "nostr-tools";
-import { NDKLnUrlData } from "../zapper/ln.js";
+import type { NDKLnUrlData } from "../zapper/ln.js";
 
 export type NDKValidationRatioFn = (
     relay: NDKRelay,
@@ -38,7 +46,9 @@ export type NDKValidationRatioFn = (
 export interface NDKWalletConfig {
     onLnPay?: LnPayCb;
     onCashuPay?: CashuPayCb;
-    onPaymentComplete: (results: Map<NDKZapSplit, NDKPaymentConfirmation | Error | undefined>) => void;
+    onPaymentComplete: (
+        results: Map<NDKZapSplit, NDKPaymentConfirmation | Error | undefined>
+    ) => void;
 }
 
 export interface NDKConstructorParams {
@@ -737,7 +747,9 @@ export class NDK extends EventEmitter<{
             tags?: NDKTag[];
             onLnPay?: LnPayCb | false;
             onCashuPay?: CashuPayCb | false;
-            onComplete?: (results: Map<NDKZapSplit, NDKPaymentConfirmation | Error | undefined>) => void;
+            onComplete?: (
+                results: Map<NDKZapSplit, NDKPaymentConfirmation | Error | undefined>
+            ) => void;
             signer?: NDKSigner;
         }
     ): NDKZapper {

diff --git a/ndk/src/relay/connectivity.ts b/ndk/src/relay/connectivity.ts
@@ -222,7 +222,9 @@ export class NDKRelayConnectivity {
                 case "OK": {
                     const ok: boolean = data[2];
                     const reason: string = data[3];
-                    const ep = this.openEventPublishes.get(id) as EventPublishResolver[] | undefined;
+                    const ep = this.openEventPublishes.get(id) as
+                        | EventPublishResolver[]
+                        | undefined;
                     const firstEp = ep?.pop();
 
                     if (!ep || !firstEp) {
@@ -506,7 +508,11 @@ export class NDKRelayConnectivity {
         const ret = new Promise<string>((resolve, reject) => {
             const val = this.openEventPublishes.get(event.id!) ?? [];
             if (val.length > 0) {
-                console.warn("Duplicate event publishing detected, you are publishing event "+event.id!+" twice");
+                console.warn(
+                    "Duplicate event publishing detected, you are publishing event " +
+                        event.id! +
+                        " twice"
+                );
             }
 
             val.push({ resolve, reject });

diff --git a/ndk/src/relay/index.test.ts b/ndk/src/relay/index.test.ts
@@ -38,7 +38,6 @@ describe("NDKRelay", () => {
         it("creates a new NDKRelay", () => {
             expect(relay).toBeInstanceOf(NDKRelay);
             expect(relay.url).toBe("ws://localhost/");
-            expect(relay.activeSubscriptions.length).toBe(0);
             expect(relay.status).toEqual(NDKRelayStatus.DISCONNECTED);
         });
     });

diff --git a/ndk/src/relay/index.ts b/ndk/src/relay/index.ts
@@ -247,10 +247,6 @@ export class NDKRelay extends EventEmitter<{
         return [["r", this.url]];
     }
 
-    // public activeSubscriptions(): Map<NDKFilter[], NDKSubscription[]> {
-    //     // return this.subs.executedFilters();
-    // }
-
     public addValidatedEvent(): void {
         this.validatedEventCount++;
     }

diff --git a/ndk/src/user/index.ts b/ndk/src/user/index.ts
@@ -15,11 +15,12 @@ import type {
     NDKZapMethodInfo,
 } from "../index.js";
 import { NDKCashuMintList } from "../events/kinds/nutzap/mint-list.js";
+import type {
+    LNPaymentRequest,
+    NDKLnUrlData} from "../zapper/ln.js";
 import {
     getNip57ZapSpecFromLud,
-    LnPaymentInfo,
-    LNPaymentRequest,
-    NDKLnUrlData,
+    LnPaymentInfo
 } from "../zapper/ln.js";
 
 export type Hexpubkey = string;

diff --git a/ndk/src/zapper/index.test.ts b/ndk/src/zapper/index.test.ts
@@ -1,10 +1,13 @@
 import type { NostrEvent } from "nostr-tools";
+import type { NDKZapDetails} from ".";
 import { NDKZapper } from ".";
 import { NDKEvent } from "../events";
 import { NDKCashuMintList } from "../events/kinds/nutzap/mint-list";
 import { NDK } from "../ndk";
 import { NDKPrivateKeySigner } from "../signers/private-key";
 import type { NDKUser } from "../user";
+import type { CashuPaymentInfo } from "./nip61";
+import type { LnPaymentInfo } from "./ln";
 
 jest.mock("./ln.js", () => ({
     getNip57ZapSpecFromLud: jest.fn(async () => {
@@ -91,10 +94,10 @@ describe("getZapMethod", () => {
         await mintList.sign(signer);
         ndk.fetchEvents = jest.fn().mockResolvedValue(new Set([mintList]));
         const zapper = new NDKZapper(user, 1000);
-        zapper.onNutPay = async (payment: NDKZapPaymentDetails): Promise<false> => false;
-        const zapMethod = await zapper.getZapMethod(ndk, user.pubkey);
+        zapper.onCashuPay = async (payment: NDKZapDetails<CashuPaymentInfo>) => undefined;
+        const zapMethod = (await zapper.getZapMethods(ndk, user.pubkey))[0];
         expect(zapMethod.type).toBe("nip61");
-        expect((zapMethod.data as NutPaymentInfo).mints).toEqual([
+        expect((zapMethod.data as CashuPaymentInfo).mints).toEqual([
             "https://mint1",
             "https://mint2",
         ]);
@@ -107,13 +110,14 @@ describe("getZapMethod", () => {
         } as NostrEvent);
         ndk.fetchEvents = jest.fn().mockResolvedValue(new Set<NDKEvent>([profile]));
         const zapper = new NDKZapper(user, 1000);
-        zapper.onNutPay = async (payment: NDKZapPaymentDetails): Promise<false> => false;
-        zapper.onLnPay = async (payment: NDKZapPaymentDetails): Promise<NDKZapConfirmation> =>
-            false;
-        const zapMethod = await zapper.getZapMethod(
-            ndk,
-            "fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52"
-        );
+        zapper.onCashuPay = async (payment: NDKZapDetails<CashuPaymentInfo>) => undefined;
+        zapper.onLnPay = async (payment: NDKZapDetails<LnPaymentInfo>) => undefined;
+        const zapMethod = (
+            await zapper.getZapMethods(
+                ndk,
+                "fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52"
+            )
+        )[0];
 
         expect(zapMethod.type).toBe("nip57");
     });

diff --git a/ndk/src/zapper/index.ts b/ndk/src/zapper/index.ts
@@ -1,6 +1,6 @@
 import type { NDK } from "../ndk";
 import type { NDKTag } from "../events";
-import { NDKEvent } from "../events";
+import type { NDKEvent } from "../events";
 import type { Hexpubkey } from "../user";
 import { NDKUser } from "../user";
 import type { NDKSigner } from "../signers";
@@ -10,8 +10,8 @@ import { getRelayListForUsers } from "../utils/get-users-relay-list";
 import { EventEmitter } from "tseep";
 import { generateZapRequest } from "./nip57";
 import { NDKNutzap } from "../events/kinds/nutzap";
-import { LnPaymentInfo, NDKLnUrlData, NDKPaymentConfirmationLN, NDKZapConfirmationLN } from "./ln";
-import { NDKZapConfirmationCashu, CashuPaymentInfo, NDKPaymentConfirmationCashu } from "./nip61";
+import type { LnPaymentInfo, NDKLnUrlData, NDKPaymentConfirmationLN, NDKZapConfirmationLN } from "./ln";
+import type { NDKZapConfirmationCashu, CashuPaymentInfo, NDKPaymentConfirmationCashu } from "./nip61";
 import { NDKRelaySet } from "../relay/sets";
 
 const d = createDebug("ndk:zapper");
@@ -75,7 +75,7 @@ export type LnPayCb = (
 ) => Promise<NDKPaymentConfirmationLN | undefined>;
 export type CashuPayCb = (
     payment: NDKZapDetails<CashuPaymentInfo>
-) => Promise<NDKPaymentConfirmationCashu | Error>;
+) => Promise<NDKPaymentConfirmationCashu | undefined>;
 
 /**
  *
@@ -108,7 +108,9 @@ class NDKZapper extends EventEmitter<{
      * in any of the provided mints and return the proofs and mint used.
      */
     public onCashuPay?: CashuPayCb;
-    public onComplete?: (results: Map<NDKZapSplit, NDKPaymentConfirmation | Error | undefined>) => void;
+    public onComplete?: (
+        results: Map<NDKZapSplit, NDKPaymentConfirmation | Error | undefined>
+    ) => void;
 
     public maxRelays = 3;
 
@@ -165,7 +167,7 @@ class NDKZapper extends EventEmitter<{
     }
 
     async zapSplit(split: NDKZapSplit): Promise<NDKPaymentConfirmation | undefined> {
-        let zapped = false;
+        const zapped = false;
         let zapMethods = await this.getZapMethods(this.ndk, split.pubkey);
         let retVal: NDKPaymentConfirmation | Error | undefined;
 
@@ -195,7 +197,7 @@ class NDKZapper extends EventEmitter<{
                 switch (zapMethod.type) {
                     case "nip61": {
                         const data = zapMethod.data as CashuPaymentInfo;
-                        let ret: NDKPaymentConfirmationCashu | Error;
+                        let ret: NDKPaymentConfirmationCashu | undefined;
                         ret = await this.onCashuPay!({
                             target: this.target,
                             comment: this.comment,
@@ -224,7 +226,7 @@ class NDKZapper extends EventEmitter<{
 
                             // we have a confirmation, generate the nutzap
                             const nutzap = new NDKNutzap(this.ndk);
-                            nutzap.tags = [ ...nutzap.tags, ...(this.tags || []) ];
+                            nutzap.tags = [...nutzap.tags, ...(this.tags || [])];
                             nutzap.proofs = proofs;
                             nutzap.mint = mint;
                             nutzap.comment = this.comment;
@@ -279,9 +281,16 @@ class NDKZapper extends EventEmitter<{
                     }
                 }
             } catch (e: any) {
-                if (e instanceof Error) retVal = e
-                else retVal = new Error(e)
-                d("Error zapping to %s with %d %s using %s: %o", split.pubkey, split.amount, this.unit, zapMethod.type, e);
+                if (e instanceof Error) retVal = e;
+                else retVal = new Error(e);
+                d(
+                    "Error zapping to %s with %d %s using %s: %o",
+                    split.pubkey,
+                    split.amount,
+                    this.unit,
+                    zapMethod.type,
+                    e
+                );
             }
         }
 

diff --git a/ndk/src/zapper/ln.ts b/ndk/src/zapper/ln.ts
@@ -1,7 +1,7 @@
 import { bech32 } from "@scure/base";
 import type { NDK } from "../ndk";
 import createDebug from "debug";
-import { Hexpubkey } from "../user";
+import type { Hexpubkey } from "../user";
 
 const d = createDebug("ndk:zapper:ln");
 

diff --git a/ndk/src/zapper/nip57.ts b/ndk/src/zapper/nip57.ts
@@ -1,9 +1,11 @@
-import { nip57, NostrEvent } from "nostr-tools";
-import { NDKTag, NDKEvent } from "../events";
-import { NDKSigner } from "../signers";
-import { NDKUser } from "../user";
-import { NDK } from "../ndk";
-import { NDKLnUrlData } from "./ln.js";
+import type { NostrEvent } from "nostr-tools";
+import { nip57 } from "nostr-tools";
+import type { NDKTag} from "../events";
+import { NDKEvent } from "../events";
+import type { NDKSigner } from "../signers";
+import type { NDKUser } from "../user";
+import type { NDK } from "../ndk";
+import type { NDKLnUrlData } from "./ln.js";
 
 export async function generateZapRequest(
     target: NDKEvent | NDKUser,

diff --git a/ndk/src/zapper/nip61.ts b/ndk/src/zapper/nip61.ts
@@ -1,5 +1,5 @@
-import { NDKNutzap } from "../events/kinds/nutzap";
-import { Proof } from "../events/kinds/nutzap/proof";
+import type { NDKNutzap } from "../events/kinds/nutzap";
+import type { Proof } from "../events/kinds/nutzap/proof";
 
 /**
  * Provides information that should be used to send a NIP-61 nutzap.