applesauce-signers 0.0.0-next-20250610175335 → 0.0.0-next-20250718170433

package/dist/index.d.ts

@@ -1,3 +1,3 @@
-export * from "./nip-07.js";
+export * from "./interface.js";
 export * from "./signers/index.js";
 export * as Helpers from "./helpers/index.js";

package/dist/index.js

@@ -1,3 +1,3 @@
-export * from "./nip-07.js";
+export * from "./interface.js";
 export * from "./signers/index.js";
 export * as Helpers from "./helpers/index.js";

package/dist/interface.d.ts

@@ -0,0 +1,15 @@
+import { EventTemplate, NostrEvent } from "nostr-tools";
+export type ISigner = {
+    getPublicKey: () => Promise<string>;
+    signEvent: (template: EventTemplate) => Promise<NostrEvent>;
+    nip04?: {
+        encrypt: (pubkey: string, plaintext: string) => Promise<string>;
+        decrypt: (pubkey: string, ciphertext: string) => Promise<string>;
+    };
+    nip44?: {
+        encrypt: (pubkey: string, plaintext: string) => Promise<string>;
+        decrypt: (pubkey: string, ciphertext: string) => Promise<string>;
+    };
+};
+/** @deprecated Use ISigner instead */
+export type Nip07Interface = ISigner;

package/dist/interface.js

@@ -0,0 +1 @@
+export {};

package/dist/nip-07.d.ts

@@ -1,20 +1,16 @@
 import { EventTemplate, NostrEvent } from "nostr-tools";
-export type Nip07Interface = {
-    getPublicKey: () => Promise<string> | string;
-    signEvent: (template: EventTemplate) => Promise<NostrEvent> | NostrEvent;
-    getRelays?: () => Record<string, {
-        read: boolean;
-        write: boolean;
-    }> | Promise<Record<string, {
-        read: boolean;
-        write: boolean;
-    }>>;
+export type ISigner = {
+    getPublicKey: () => Promise<string>;
+    signEvent: (template: EventTemplate) => Promise<NostrEvent>;
     nip04?: {
-        encrypt: (pubkey: string, plaintext: string) => Promise<string> | string;
-        decrypt: (pubkey: string, ciphertext: string) => Promise<string> | string;
+        encrypt: (pubkey: string, plaintext: string) => Promise<string>;
+        decrypt: (pubkey: string, ciphertext: string) => Promise<string>;
     };
     nip44?: {
-        encrypt: (pubkey: string, plaintext: string) => Promise<string> | string;
-        decrypt: (pubkey: string, ciphertext: string) => Promise<string> | string;
+        encrypt: (pubkey: string, plaintext: string) => Promise<string>;
+        decrypt: (pubkey: string, ciphertext: string) => Promise<string>;
     };
 };
+
+/** @deprecated Use ISigner instead */
+export type Nip07Interface = ISigner;

package/dist/signers/__tests__/nostr-connect-signer.test.js

@@ -1,66 +1,23 @@
-import { beforeEach, describe, expect, it, vi } from "vitest";
+import { describe, expect, it, vi } from "vitest";
 import { NostrConnectSigner } from "../nostr-connect-signer.js";
 import { SimpleSigner } from "../simple-signer.js";
-const relays = ["wss://relay.signer.com"];
-const client = new SimpleSigner();
-const remote = new SimpleSigner();
-const observable = { unsubscribe: vi.fn() };
-const req = { subscribe: vi.fn().mockReturnValue(observable) };
-const subscriptionMethod = vi.fn().mockReturnValue(req);
-const publishMethod = vi.fn(async () => { });
-let signer;
-beforeEach(async () => {
-    observable.unsubscribe.mockClear();
-    req.subscribe.mockClear();
-    subscriptionMethod.mockClear();
-    publishMethod.mockClear();
-    signer = new NostrConnectSigner({
-        relays,
-        remote: await remote.getPublicKey(),
-        signer: client,
-        subscriptionMethod,
-        publishMethod,
-    });
-});
-describe("connection", () => {
-    it("should call subscription method with filters", async () => {
-        signer.connect();
-        expect(subscriptionMethod).toHaveBeenCalledWith(relays, [{ "#p": [await client.getPublicKey()], kinds: [24133] }]);
-    });
-});
-describe("open", () => {
-    it("should call subscription method with filters", async () => {
-        signer.open();
-        expect(subscriptionMethod).toHaveBeenCalledWith(relays, [{ "#p": [await client.getPublicKey()], kinds: [24133] }]);
-    });
-});
-describe("waitForSigner", () => {
-    it("should accept an abort signal", async () => {
-        const signer = new NostrConnectSigner({
-            relays: ["wss://relay.signer.com"],
-            signer: client,
-            subscriptionMethod,
-            publishMethod,
+describe("NostrConnectSigner", () => {
+    describe("connection", () => {
+        it("should call subscription method with filters", async () => {
+            const relays = ["wss://relay.signer.com"];
+            const subscription = vi.fn().mockReturnValue({ subscribe: vi.fn() });
+            const publish = vi.fn(async () => { });
+            const client = new SimpleSigner();
+            const remote = new SimpleSigner();
+            const signer = new NostrConnectSigner({
+                relays,
+                remote: await remote.getPublicKey(),
+                signer: client,
+                subscriptionMethod: subscription,
+                publishMethod: publish,
+            });
+            signer.connect();
+            expect(subscription).toHaveBeenCalledWith(relays, [{ "#p": [await client.getPublicKey()], kinds: [24133] }]);
         });
-        const controller = new AbortController();
-        const p = signer.waitForSigner(controller.signal);
-        setTimeout(() => {
-            controller.abort();
-        }, 10);
-        await expect(p).rejects.toThrow("Aborted");
-        expect(signer.listening).toBe(false);
-    });
-});
-describe("close", () => {
-    it("should close the connection", async () => {
-        await signer.open();
-        expect(req.subscribe).toHaveBeenCalled();
-        await signer.close();
-        expect(observable.unsubscribe).toHaveBeenCalled();
-    });
-    it("it should cancel waiting for signer promie", async () => {
-        const p = signer.waitForSigner();
-        await signer.close();
-        await expect(p).rejects.toThrow("Closed");
     });
 });

package/dist/signers/amber-clipboard-signer.d.ts

@@ -1,22 +1,22 @@
 import { EventTemplate, VerifiedEvent, verifyEvent } from "nostr-tools";
-import { Nip07Interface } from "../nip-07.js";
+import { ISigner } from "../interface.js";
 /**
  * A Signer for [amber](https://github.com/greenart7c3/Amber) clipboard API
  * @see https://github.com/greenart7c3/Amber/blob/master/docs/web-apps.md
  */
-export declare class AmberClipboardSigner implements Nip07Interface {
+export declare class AmberClipboardSigner implements ISigner {
     /** If the signer is supported on this platform */
     static SUPPORTED: false | (() => Promise<string>);
     private pendingRequest;
     pubkey?: string;
     verifyEvent: typeof verifyEvent;
     nip04: {
-        encrypt: (pubkey: string, plaintext: string) => Promise<string> | string;
-        decrypt: (pubkey: string, ciphertext: string) => Promise<string> | string;
+        encrypt: (pubkey: string, plaintext: string) => Promise<string>;
+        decrypt: (pubkey: string, ciphertext: string) => Promise<string>;
     };
     nip44: {
-        encrypt: (pubkey: string, plaintext: string) => Promise<string> | string;
-        decrypt: (pubkey: string, ciphertext: string) => Promise<string> | string;
+        encrypt: (pubkey: string, plaintext: string) => Promise<string>;
+        decrypt: (pubkey: string, ciphertext: string) => Promise<string>;
     };
     constructor();
     private onVisibilityChange;

package/dist/signers/extension-signer.d.ts

@@ -1,26 +1,19 @@
-import { EventTemplate } from "nostr-tools";
-import { Nip07Interface } from "../nip-07.js";
+import { EventTemplate, VerifiedEvent } from "nostr-tools";
+import { ISigner } from "../interface.js";
 /** AN error that is throw when the window.nostr extension is missing */
 export declare class ExtensionMissingError extends Error {
 }
 /** A signer that is a proxy for window.nostr */
-export declare class ExtensionSigner implements Nip07Interface {
+export declare class ExtensionSigner implements ISigner {
     get nip04(): {
-        encrypt: (pubkey: string, plaintext: string) => Promise<string> | string;
-        decrypt: (pubkey: string, ciphertext: string) => Promise<string> | string;
+        encrypt: (pubkey: string, plaintext: string) => Promise<string>;
+        decrypt: (pubkey: string, ciphertext: string) => Promise<string>;
     } | undefined;
     get nip44(): {
-        encrypt: (pubkey: string, plaintext: string) => Promise<string> | string;
-        decrypt: (pubkey: string, ciphertext: string) => Promise<string> | string;
+        encrypt: (pubkey: string, plaintext: string) => Promise<string>;
+        decrypt: (pubkey: string, ciphertext: string) => Promise<string>;
     } | undefined;
     protected pubkey: string | undefined;
-    getPublicKey(): string | Promise<string>;
-    getRelays(): Record<string, {
-        read: boolean;
-        write: boolean;
-    }> | Promise<Record<string, {
-        read: boolean;
-        write: boolean;
-    }>>;
-    signEvent(template: EventTemplate): import("nostr-tools").Event | Promise<import("nostr-tools").Event>;
+    getPublicKey(): Promise<string>;
+    signEvent(template: EventTemplate): Promise<VerifiedEvent>;
 }

package/dist/signers/extension-signer.js

@@ -1,3 +1,4 @@
+import { verifyEvent } from "nostr-tools";
 /** AN error that is throw when the window.nostr extension is missing */
 export class ExtensionMissingError extends Error {
 }
@@ -10,32 +11,20 @@ export class ExtensionSigner {
         return window.nostr?.nip44;
     }
     pubkey = undefined;
-    getPublicKey() {
+    async getPublicKey() {
         if (!window.nostr)
             throw new ExtensionMissingError("Signer extension missing");
         if (this.pubkey)
             return this.pubkey;
-        const p = window.nostr.getPublicKey();
-        if (p instanceof Promise)
-            return p.then((pubkey) => {
-                this.pubkey = pubkey;
-                return pubkey;
-            });
-        else {
-            this.pubkey = p;
-            return p;
-        }
+        this.pubkey = await window.nostr.getPublicKey();
+        return this.pubkey;
     }
-    getRelays() {
+    async signEvent(template) {
         if (!window.nostr)
             throw new ExtensionMissingError("Signer extension missing");
-        if (!window.nostr.getRelays)
-            return {};
-        return window.nostr.getRelays();
-    }
-    signEvent(template) {
-        if (!window.nostr)
-            throw new ExtensionMissingError("Signer extension missing");
-        return window.nostr.signEvent(template);
+        const event = await window.nostr.signEvent(template);
+        if (!verifyEvent(event))
+            throw new Error("Extension returned an invalid event");
+        return event;
     }
 }

package/dist/signers/nostr-connect-signer.d.ts

@@ -1,5 +1,5 @@
 import { EventTemplate, Filter, NostrEvent, verifyEvent } from "nostr-tools";
-import { Nip07Interface, SimpleSigner } from "applesauce-signers";
+import { ISigner, SimpleSigner } from "applesauce-signers";
 import { Deferred } from "applesauce-core/promise";
 export declare function isErrorResponse(response: any): response is NostrConnectErrorResponse;
 export declare enum Permission {
@@ -92,7 +92,7 @@ export type NostrConnectAppMetadata = {
     url?: string | URL;
     permissions?: string[];
 };
-export declare class NostrConnectSigner implements Nip07Interface {
+export declare class NostrConnectSigner implements ISigner {
     /** A method that is called when an event needs to be published */
     protected publishMethod: NostrPublishMethod;
     /** The active nostr subscription */
@@ -118,12 +118,12 @@ export declare class NostrConnectSigner implements Nip07Interface {
     /** A secret used when initiating a connection from the client side */
     protected clientSecret: string;
     nip04?: {
-        encrypt: (pubkey: string, plaintext: string) => Promise<string> | string;
-        decrypt: (pubkey: string, ciphertext: string) => Promise<string> | string;
+        encrypt: (pubkey: string, plaintext: string) => Promise<string>;
+        decrypt: (pubkey: string, ciphertext: string) => Promise<string>;
     } | undefined;
     nip44?: {
-        encrypt: (pubkey: string, plaintext: string) => Promise<string> | string;
-        decrypt: (pubkey: string, ciphertext: string) => Promise<string> | string;
+        encrypt: (pubkey: string, plaintext: string) => Promise<string>;
+        decrypt: (pubkey: string, ciphertext: string) => Promise<string>;
     } | undefined;
     /** A fallback method to use for subscriptionMethod if none is pass in when creating the signer */
     static subscriptionMethod: NostrSubscriptionMethod | undefined;

package/dist/signers/password-signer.d.ts

@@ -1,17 +1,17 @@
 import { EventTemplate } from "nostr-tools";
 import { Deferred } from "applesauce-core/promise";
-import { Nip07Interface } from "../nip-07.js";
+import { ISigner } from "../interface.js";
 /** A NIP-49 (Private Key Encryption) signer */
-export declare class PasswordSigner implements Nip07Interface {
+export declare class PasswordSigner implements ISigner {
     key: Uint8Array | null;
     ncryptsec?: string;
     nip04: {
-        encrypt: (pubkey: string, plaintext: string) => Promise<string> | string;
-        decrypt: (pubkey: string, ciphertext: string) => Promise<string> | string;
+        encrypt: (pubkey: string, plaintext: string) => Promise<string>;
+        decrypt: (pubkey: string, ciphertext: string) => Promise<string>;
     };
     nip44: {
-        encrypt: (pubkey: string, plaintext: string) => Promise<string> | string;
-        decrypt: (pubkey: string, ciphertext: string) => Promise<string> | string;
+        encrypt: (pubkey: string, plaintext: string) => Promise<string>;
+        decrypt: (pubkey: string, ciphertext: string) => Promise<string>;
     };
     get unlocked(): boolean;
     constructor();
@@ -31,4 +31,8 @@ export declare class PasswordSigner implements Nip07Interface {
     nip04Decrypt(pubkey: string, ciphertext: string): Promise<string>;
     nip44Encrypt(pubkey: string, plaintext: string): Promise<string>;
     nip44Decrypt(pubkey: string, ciphertext: string): Promise<string>;
+    /** Creates a PasswordSigner from a hex private key or NIP-19 nsec and password */
+    static fromPrivateKey(privateKey: Uint8Array | string, password: string): Promise<PasswordSigner>;
+    /** Creates a PasswordSigner from a ncryptsec and unlocks it with the provided password */
+    static fromNcryptsec(ncryptsec: string, password?: string): Promise<PasswordSigner>;
 }

package/dist/signers/password-signer.js

@@ -1,6 +1,7 @@
 import { finalizeEvent, getPublicKey, nip04, nip44 } from "nostr-tools";
 import { encrypt, decrypt } from "nostr-tools/nip49";
 import { createDefer } from "applesauce-core/promise";
+import { normalizeToSecretKey } from "applesauce-core/helpers";
 /** A NIP-49 (Private Key Encryption) signer */
 export class PasswordSigner {
     key = null;
@@ -51,9 +52,14 @@ export class PasswordSigner {
         if (this.key)
             return;
         if (this.ncryptsec) {
-            this.key = decrypt(this.ncryptsec, password);
-            if (!this.key)
-                throw new Error("Failed to decrypt key");
+            try {
+                this.key = decrypt(this.ncryptsec, password);
+                if (!this.key)
+                    throw new Error("Failed to decrypt key");
+            }
+            catch (error) {
+                throw new Error("failed to decrypt key: " + (error instanceof Error ? error.message : String(error)));
+            }
         }
         else
             throw new Error("Missing ncryptsec");
@@ -89,4 +95,19 @@ export class PasswordSigner {
         await this.requestUnlock();
         return nip44.v2.decrypt(ciphertext, nip44.v2.utils.getConversationKey(this.key, pubkey));
     }
+    /** Creates a PasswordSigner from a hex private key or NIP-19 nsec and password */
+    static async fromPrivateKey(privateKey, password) {
+        const signer = new PasswordSigner();
+        signer.key = normalizeToSecretKey(privateKey);
+        await signer.setPassword(password);
+        return signer;
+    }
+    /** Creates a PasswordSigner from a ncryptsec and unlocks it with the provided password */
+    static async fromNcryptsec(ncryptsec, password) {
+        const signer = new PasswordSigner();
+        signer.ncryptsec = ncryptsec;
+        if (password)
+            await signer.unlock(password);
+        return signer;
+    }
 }

package/dist/signers/readonly-signer.d.ts

@@ -1,22 +1,23 @@
 import { VerifiedEvent } from "nostr-tools";
-import { Nip07Interface } from "../nip-07.js";
+import { ISigner } from "../interface.js";
 /** A signer that only implements getPublicKey and throws on ever other method */
-export declare class ReadonlySigner implements Nip07Interface {
+export declare class ReadonlySigner implements ISigner {
     private pubkey;
     nip04: {
-        encrypt: (pubkey: string, plaintext: string) => Promise<string> | string;
-        decrypt: (pubkey: string, ciphertext: string) => Promise<string> | string;
+        encrypt: (pubkey: string, plaintext: string) => Promise<string>;
+        decrypt: (pubkey: string, ciphertext: string) => Promise<string>;
     };
     nip44: {
-        encrypt: (pubkey: string, plaintext: string) => Promise<string> | string;
-        decrypt: (pubkey: string, ciphertext: string) => Promise<string> | string;
+        encrypt: (pubkey: string, plaintext: string) => Promise<string>;
+        decrypt: (pubkey: string, ciphertext: string) => Promise<string>;
     };
     constructor(pubkey: string);
-    getPublicKey(): string;
-    getRelays(): {};
-    signEvent(): VerifiedEvent;
-    nip04Encrypt(): string;
-    nip04Decrypt(): string;
-    nip44Encrypt(): string;
-    nip44Decrypt(): string;
+    getPublicKey(): Promise<string>;
+    signEvent(): Promise<VerifiedEvent>;
+    nip04Encrypt(): Promise<string>;
+    nip04Decrypt(): Promise<string>;
+    nip44Encrypt(): Promise<string>;
+    nip44Decrypt(): Promise<string>;
+    /** Creates a ReadonlySigner from a hex public key or NIP-19 npub */
+    static fromPubkey(pubkey: string): ReadonlySigner;
 }

package/dist/signers/readonly-signer.js

@@ -1,4 +1,4 @@
-import { isHexKey } from "applesauce-core/helpers";
+import { isHexKey, normalizeToPubkey } from "applesauce-core/helpers";
 /** A signer that only implements getPublicKey and throws on ever other method */
 export class ReadonlySigner {
     pubkey;
@@ -17,25 +17,26 @@ export class ReadonlySigner {
             decrypt: this.nip44Decrypt.bind(this),
         };
     }
-    getPublicKey() {
+    async getPublicKey() {
         return this.pubkey;
     }
-    getRelays() {
-        return {};
-    }
-    signEvent() {
+    async signEvent() {
         throw new Error("Cant sign events with readonly");
     }
-    nip04Encrypt() {
+    async nip04Encrypt() {
         throw new Error("Cant encrypt with readonly");
     }
-    nip04Decrypt() {
+    async nip04Decrypt() {
         throw new Error("Cant decrypt with readonly");
     }
-    nip44Encrypt() {
+    async nip44Encrypt() {
         throw new Error("Cant encrypt with readonly");
     }
-    nip44Decrypt() {
+    async nip44Decrypt() {
         throw new Error("Cant decrypt with readonly");
     }
+    /** Creates a ReadonlySigner from a hex public key or NIP-19 npub */
+    static fromPubkey(pubkey) {
+        return new ReadonlySigner(normalizeToPubkey(pubkey));
+    }
 }

package/dist/signers/serial-port-signer.d.ts

@@ -1,6 +1,6 @@
 import { Deferred } from "applesauce-core/promise";
 import { EventTemplate, verifyEvent } from "nostr-tools";
-import { Nip07Interface } from "../nip-07.js";
+import { ISigner } from "../interface.js";
 type Callback = () => void;
 type DeviceOpts = {
     onConnect?: Callback;
@@ -9,15 +9,15 @@ type DeviceOpts = {
     onDone?: Callback;
 };
 /** A signer that works with [nostr-signing-device](https://github.com/lnbits/nostr-signing-device) */
-export declare class SerialPortSigner implements Nip07Interface {
+export declare class SerialPortSigner implements ISigner {
     protected log: import("debug").Debugger;
     protected writer: WritableStreamDefaultWriter<string> | null;
     pubkey?: string;
     get isConnected(): boolean;
     verifyEvent: typeof verifyEvent;
     nip04: {
-        encrypt: (pubkey: string, plaintext: string) => Promise<string> | string;
-        decrypt: (pubkey: string, ciphertext: string) => Promise<string> | string;
+        encrypt: (pubkey: string, plaintext: string) => Promise<string>;
+        decrypt: (pubkey: string, ciphertext: string) => Promise<string>;
     };
     constructor();
     protected lastCommand: Deferred<string> | null;

package/dist/signers/simple-signer.d.ts

@@ -1,6 +1,7 @@
 import { EventTemplate } from "nostr-tools";
+import { ISigner } from "../interface.js";
 /** A Simple NIP-07 signer class */
-export declare class SimpleSigner {
+export declare class SimpleSigner implements ISigner {
     key: Uint8Array;
     constructor(key?: Uint8Array);
     getPublicKey(): Promise<string>;
@@ -13,4 +14,6 @@ export declare class SimpleSigner {
         encrypt: (pubkey: string, plaintext: string) => Promise<string>;
         decrypt: (pubkey: string, ciphertext: string) => Promise<string>;
     };
+    /** Creates a SimpleSigner from a hex private key or NIP-19 nsec */
+    static fromKey(privateKey: Uint8Array | string): SimpleSigner;
 }

package/dist/signers/simple-signer.js

@@ -1,3 +1,4 @@
+import { normalizeToSecretKey } from "applesauce-core/helpers";
 import { finalizeEvent, generateSecretKey, getPublicKey, nip04, nip44 } from "nostr-tools";
 /** A Simple NIP-07 signer class */
 export class SimpleSigner {
@@ -19,4 +20,8 @@ export class SimpleSigner {
         encrypt: async (pubkey, plaintext) => nip44.v2.encrypt(plaintext, nip44.v2.utils.getConversationKey(this.key, pubkey)),
         decrypt: async (pubkey, ciphertext) => nip44.v2.decrypt(ciphertext, nip44.v2.utils.getConversationKey(this.key, pubkey)),
     };
+    /** Creates a SimpleSigner from a hex private key or NIP-19 nsec */
+    static fromKey(privateKey) {
+        return new SimpleSigner(normalizeToSecretKey(privateKey));
+    }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "applesauce-signers",
-  "version": "0.0.0-next-20250610175335",
+  "version": "0.0.0-next-20250718170433",
   "description": "Signer classes for applesauce",
   "type": "module",
   "main": "dist/index.js",
@@ -36,7 +36,7 @@
     "@noble/hashes": "^1.7.1",
     "@noble/secp256k1": "^1.7.1",
     "@scure/base": "^1.2.4",
-    "applesauce-core": "0.0.0-next-20250610175335",
+    "applesauce-core": "^2.0.0",
     "debug": "^4.4.0",
     "nanoid": "^5.0.9",
     "nostr-tools": "^2.13"