applesauce-signers 4.0.0 → 4.2.0

package/README.md

@@ -37,12 +37,12 @@ A basic signer that holds the secret key in memory with NIP-04 and NIP-44 encryp
 
 ```ts
 // Create new signer with random key
-const signer = new SimpleSigner();
+const signer = new PrivateKeySigner();
 
 // Or import existing key
 const key = new Uint8Array(32);
 window.crypto.getRandomValues(key);
-const signer = new SimpleSigner(key);
+const signer = new PrivateKeySigner(key);
 ```
 
 ### Nostr Connect Signer (NIP-46)

package/dist/signers/extension-signer.js

@@ -1,4 +1,5 @@
 import { verifyEvent } from "nostr-tools";
+import { isHexKey } from "applesauce-core/helpers";
 /** AN error that is throw when the window.nostr extension is missing */
 export class ExtensionMissingError extends Error {
 }
@@ -16,7 +17,10 @@ export class ExtensionSigner {
             throw new ExtensionMissingError("Signer extension missing");
         if (this.pubkey)
             return this.pubkey;
-        this.pubkey = await window.nostr.getPublicKey();
+        const key = await window.nostr.getPublicKey();
+        if (!isHexKey(key))
+            throw new Error("Extension returned an invalid public key");
+        this.pubkey = key;
         return this.pubkey;
     }
     async signEvent(template) {

package/dist/signers/index.d.ts

@@ -5,4 +5,5 @@ export * from "./nostr-connect-signer.js";
 export * from "./password-signer.js";
 export * from "./readonly-signer.js";
 export * from "./serial-port-signer.js";
+export * from "./private-key-signer.js";
 export * from "./simple-signer.js";

package/dist/signers/index.js

@@ -5,4 +5,5 @@ export * from "./nostr-connect-signer.js";
 export * from "./password-signer.js";
 export * from "./readonly-signer.js";
 export * from "./serial-port-signer.js";
+export * from "./private-key-signer.js";
 export * from "./simple-signer.js";

package/dist/signers/nostr-connect-provider.js

@@ -7,7 +7,7 @@ import { filter, from, repeat, retry } from "rxjs";
 import { isNIP04 } from "../helpers/encryption.js";
 import { createBunkerURI, NostrConnectMethod, parseNostrConnectURI, } from "../helpers/nostr-connect.js";
 import { getConnectionMethods, } from "../interop.js";
-import { SimpleSigner } from "./simple-signer.js";
+import { PrivateKeySigner } from "./private-key-signer.js";
 export class NostrConnectProvider {
     /** A fallback method to use for subscriptionMethod if none is passed in when creating the provider */
     static subscriptionMethod = undefined;
@@ -55,7 +55,7 @@ export class NostrConnectProvider {
     constructor(options) {
         this.relays = options.relays;
         this.upstream = options.upstream;
-        this.signer = options.signer ?? new SimpleSigner();
+        this.signer = options.signer ?? new PrivateKeySigner();
         this.secret = options.secret;
         // Get the subscription and publish methods
         const { subscriptionMethod, publishMethod } = getConnectionMethods(options, NostrConnectProvider);

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

@@ -1,13 +1,13 @@
 import { Deferred } from "applesauce-core/promise";
-import { ISigner, NostrConnectionMethodsOptions, NostrPool, NostrPublishMethod, NostrSubscriptionMethod, SimpleSigner } from "applesauce-signers";
+import { ISigner, NostrConnectionMethodsOptions, NostrPool, NostrPublishMethod, NostrSubscriptionMethod, PrivateKeySigner } from "applesauce-signers";
 import { EventTemplate, NostrEvent, verifyEvent } from "nostr-tools";
 import { Subscription } from "rxjs";
 import { BunkerURI, NostrConnectAppMetadata } from "../helpers/nostr-connect.js";
 export type NostrConnectSignerOptions = NostrConnectionMethodsOptions & {
     /** The relays to communicate over */
     relays: string[];
-    /** A {@link SimpleSigner} for this client */
-    signer?: SimpleSigner;
+    /** A {@link PrivateKeySigner} for this client */
+    signer?: PrivateKeySigner;
     /** pubkey of the remote signer application */
     remote?: string;
     /** Users pubkey */
@@ -30,7 +30,7 @@ export declare class NostrConnectSigner implements ISigner {
     protected subscriptionMethod: NostrSubscriptionMethod;
     protected log: import("debug").Debugger;
     /** The local client signer */
-    signer: SimpleSigner;
+    signer: PrivateKeySigner;
     /** Whether the signer is listening for events */
     listening: boolean;
     /** Whether the signer is connected to the remote signer */
@@ -97,6 +97,6 @@ export declare class NostrConnectSigner implements ISigner {
     /** Create a {@link NostrConnectSigner} from a bunker:// URI */
     static fromBunkerURI(uri: string, options?: Omit<NostrConnectSignerOptions, "relays"> & {
         permissions?: string[];
-        signer?: SimpleSigner;
+        signer?: PrivateKeySigner;
     }): Promise<NostrConnectSigner>;
 }

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

@@ -1,7 +1,7 @@
 import { logger } from "applesauce-core";
-import { getHiddenContent, unixNow } from "applesauce-core/helpers";
+import { getHiddenContent, isHexKey, unixNow } from "applesauce-core/helpers";
 import { createDefer } from "applesauce-core/promise";
-import { SimpleSigner, getConnectionMethods, } from "applesauce-signers";
+import { PrivateKeySigner, getConnectionMethods, } from "applesauce-signers";
 import { nanoid } from "nanoid";
 import { getPublicKey, kinds, verifyEvent } from "nostr-tools";
 import { filter, from, repeat, retry } from "rxjs";
@@ -58,7 +58,7 @@ export class NostrConnectSigner {
         if (options.onAuth)
             this.onAuth = options.onAuth;
         // Get or create the local signer
-        this.signer = options?.signer || new SimpleSigner();
+        this.signer = options?.signer || new PrivateKeySigner();
         this.nip04 = {
             encrypt: this.nip04Encrypt.bind(this),
             decrypt: this.nip04Decrypt.bind(this),
@@ -265,7 +265,10 @@ export class NostrConnectSigner {
         if (this.pubkey)
             return this.pubkey;
         await this.requireConnection();
-        return this.makeRequest(NostrConnectMethod.GetPublicKey, []);
+        const key = await this.makeRequest(NostrConnectMethod.GetPublicKey, []);
+        if (!isHexKey(key))
+            throw new Error("Remote signer returned an invalid public key");
+        return key;
     }
     /** Request to sign an event */
     async signEvent(template) {

package/dist/signers/private-key-signer.d.ts

@@ -0,0 +1,19 @@
+import { EventTemplate } from "nostr-tools";
+import { ISigner } from "../interop.js";
+/** A Simple signer that holds the private key in memory */
+export declare class PrivateKeySigner implements ISigner {
+    key: Uint8Array;
+    constructor(key?: Uint8Array);
+    getPublicKey(): Promise<string>;
+    signEvent(event: EventTemplate): Promise<import("nostr-tools").VerifiedEvent>;
+    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>;
+    };
+    /** Creates a PrivateKeySigner from a hex private key or NIP-19 nsec */
+    static fromKey(privateKey: Uint8Array | string): PrivateKeySigner;
+}

package/dist/signers/private-key-signer.js

@@ -0,0 +1,27 @@
+import { normalizeToSecretKey } from "applesauce-core/helpers";
+import { finalizeEvent, generateSecretKey, getPublicKey, nip04, nip44 } from "nostr-tools";
+/** A Simple signer that holds the private key in memory */
+export class PrivateKeySigner {
+    key;
+    constructor(key) {
+        this.key = key || generateSecretKey();
+    }
+    async getPublicKey() {
+        return getPublicKey(this.key);
+    }
+    async signEvent(event) {
+        return finalizeEvent(event, this.key);
+    }
+    nip04 = {
+        encrypt: async (pubkey, plaintext) => nip04.encrypt(this.key, pubkey, plaintext),
+        decrypt: async (pubkey, ciphertext) => nip04.decrypt(this.key, pubkey, ciphertext),
+    };
+    nip44 = {
+        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 PrivateKeySigner from a hex private key or NIP-19 nsec */
+    static fromKey(privateKey) {
+        return new PrivateKeySigner(normalizeToSecretKey(privateKey));
+    }
+}

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

@@ -1,19 +1,4 @@
-import { EventTemplate } from "nostr-tools";
-import { ISigner } from "../interop.js";
-/** A Simple NIP-07 signer class */
-export declare class SimpleSigner implements ISigner {
-    key: Uint8Array;
-    constructor(key?: Uint8Array);
-    getPublicKey(): Promise<string>;
-    signEvent(event: EventTemplate): Promise<import("nostr-tools").VerifiedEvent>;
-    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>;
-    };
-    /** Creates a SimpleSigner from a hex private key or NIP-19 nsec */
-    static fromKey(privateKey: Uint8Array | string): SimpleSigner;
-}
+import { PrivateKeySigner } from "./private-key-signer.js";
+/** @deprecated Use PrivateKeySigner instead */
+declare const SimpleSigner: typeof PrivateKeySigner;
+export { SimpleSigner };

package/dist/signers/simple-signer.js

@@ -1,27 +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 {
-    key;
-    constructor(key) {
-        this.key = key || generateSecretKey();
-    }
-    async getPublicKey() {
-        return getPublicKey(this.key);
-    }
-    async signEvent(event) {
-        return finalizeEvent(event, this.key);
-    }
-    nip04 = {
-        encrypt: async (pubkey, plaintext) => nip04.encrypt(this.key, pubkey, plaintext),
-        decrypt: async (pubkey, ciphertext) => nip04.decrypt(this.key, pubkey, ciphertext),
-    };
-    nip44 = {
-        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));
-    }
-}
+import { PrivateKeySigner } from "./private-key-signer.js";
+/** @deprecated Use PrivateKeySigner instead */
+const SimpleSigner = PrivateKeySigner;
+export { SimpleSigner };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "applesauce-signers",
-  "version": "4.0.0",
+  "version": "4.2.0",
   "description": "Signer classes for applesauce",
   "type": "module",
   "main": "dist/index.js",
@@ -47,7 +47,7 @@
     "@noble/hashes": "^1.7.1",
     "@noble/secp256k1": "^1.7.1",
     "@scure/base": "^1.2.4",
-    "applesauce-core": "^4.0.0",
+    "applesauce-core": "^4.2.0",
     "debug": "^4.4.0",
     "nanoid": "^5.0.9",
     "nostr-tools": "~2.17",