applesauce-signers 0.0.0-next-20250428223834 → 0.0.0-next-20250511152752

package/README.md

@@ -1,5 +1,101 @@
 # applesauce-signer
 
-A collection of signer classes for applesauce
+A collection of signer classes for applesauce that are compatible with the [NIP-07](https://github.com/nostr-protocol/nips/blob/master/07.md) API.
 
-See [documentation](https://hzrd149.github.io/applesauce/signers/signers.html)
+## Documentation
+
+For detailed documentation and API reference, see:
+
+- [Signers Documentation](https://hzrd149.github.io/applesauce/signers/signers.html)
+- [Nostr Connect Documentation](https://hzrd149.github.io/applesauce/signers/nostr-connect.html)
+- [API Reference](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.html)
+
+## Available Signers
+
+### Password Signer (NIP-49)
+
+A secure signer that encrypts private keys using [NIP-49](https://github.com/nostr-protocol/nips/blob/master/49.md).
+
+```ts
+// Create a new password signer
+const signer = new PasswordSigner();
+
+// Set up with a new key and password
+const randomBytes = new Uint8Array(64);
+window.crypto.getRandomValues(randomBytes);
+
+signer.key = randomBytes;
+signer.setPassword("your-password");
+
+// Unlock the signer when needed
+await signer.unlock("your-password");
+```
+
+### Simple Signer
+
+A basic signer that holds the secret key in memory with NIP-04 and NIP-44 encryption support.
+
+```ts
+// Create new signer with random key
+const signer = new SimpleSigner();
+
+// Or import existing key
+const key = new Uint8Array(32);
+window.crypto.getRandomValues(key);
+const signer = new SimpleSigner(key);
+```
+
+### Nostr Connect Signer (NIP-46)
+
+A client-side implementation for remote signing using [NIP-46](https://github.com/nostr-protocol/nips/blob/master/46.md).
+
+```ts
+// First, set up the required relay communication methods
+import { Observable } from "rxjs";
+
+// Define subscription method for receiving events
+const subscriptionMethod = (filters, relays) => {
+  return new Observable((observer) => {
+    // Create subscription to relays
+    const cleanup = subscribeToRelays(relays, filters, (event) => {
+      observer.next(event);
+    });
+    return () => cleanup();
+  });
+};
+
+// Define publish method for sending events
+const publishMethod = async (event, relays) => {
+  for (const relay of relays) await publishToRelay(relay, event);
+};
+
+// You can set these methods globally at app initialization
+NostrConnectSigner.subscriptionMethod = subscriptionMethod;
+NostrConnectSigner.publishMethod = publishMethod;
+
+// Now create and use the signer
+const signer = new NostrConnectSigner({
+  remote: "<remote signer pubkey>",
+  relays: ["wss://relay.example.com"],
+  // Or pass methods directly to the constructor
+  subscriptionMethod,
+  publishMethod,
+});
+
+// Create a connection URI for your app
+const uri = signer.getNostrConnectURI({
+  name: "My App",
+  url: "https://example.com",
+  permissions: NostrConnectSigner.buildSigningPermissions([0, 1, 3]),
+});
+
+// Connect using bunker URI
+const bunkerSigner = await NostrConnectSigner.fromBunkerURI("bunker://...your-uri-here...", {
+  permissions: NostrConnectSigner.buildSigningPermissions([0, 1, 3]),
+});
+```
+
+### Other Signers
+
+- **Serial Port Signer**: For hardware signing devices (Chrome browsers only)
+- **Amber Clipboard Signer**: Integration with Amber wallet's web API

package/dist/__tests__/exports.test.d.ts

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

package/dist/__tests__/exports.test.js

@@ -0,0 +1,22 @@
+import { describe, expect, it } from "vitest";
+import * as exports from "../index.js";
+describe("exports", () => {
+    it("should export the expected functions", () => {
+        expect(Object.keys(exports).sort()).toMatchInlineSnapshot(`
+      [
+        "AmberClipboardSigner",
+        "ExtensionMissingError",
+        "ExtensionSigner",
+        "Helpers",
+        "NostrConnectMethod",
+        "NostrConnectSigner",
+        "PasswordSigner",
+        "Permission",
+        "ReadonlySigner",
+        "SerialPortSigner",
+        "SimpleSigner",
+        "isErrorResponse",
+      ]
+    `);
+    });
+});

package/dist/helpers/__tests__/exports.test.d.ts

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

package/dist/helpers/__tests__/exports.test.js

@@ -0,0 +1,11 @@
+import { describe, expect, it } from "vitest";
+import * as exports from "../index.js";
+describe("exports", () => {
+    it("should export the expected functions", () => {
+        expect(Object.keys(exports).sort()).toMatchInlineSnapshot(`
+      [
+        "isNIP04",
+      ]
+    `);
+    });
+});

package/dist/signers/__tests__/exports.test.d.ts

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

package/dist/signers/__tests__/exports.test.js

@@ -0,0 +1,21 @@
+import { describe, expect, it } from "vitest";
+import * as exports from "../index.js";
+describe("exports", () => {
+    it("should export the expected functions", () => {
+        expect(Object.keys(exports).sort()).toMatchInlineSnapshot(`
+      [
+        "AmberClipboardSigner",
+        "ExtensionMissingError",
+        "ExtensionSigner",
+        "NostrConnectMethod",
+        "NostrConnectSigner",
+        "PasswordSigner",
+        "Permission",
+        "ReadonlySigner",
+        "SerialPortSigner",
+        "SimpleSigner",
+        "isErrorResponse",
+      ]
+    `);
+    });
+});

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

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

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

@@ -0,0 +1,66 @@
+import { beforeEach, 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,
+        });
+        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/nostr-connect-signer.d.ts

@@ -82,8 +82,8 @@ interface Observer<T> {
 type Subscribable<T extends unknown> = {
     subscribe: (observer: Partial<Observer<T>>) => Unsubscribable;
 };
-export type NostrSubscriptionMethod = (filters: Filter[], relays: string[]) => Subscribable<NostrEvent>;
-export type NostrPublishMethod = (event: NostrEvent, relays: string[]) => void | Promise<void>;
+export type NostrSubscriptionMethod = (relays: string[], filters: Filter[]) => Subscribable<NostrEvent>;
+export type NostrPublishMethod = (relays: string[], event: NostrEvent) => any | Promise<any>;
 export type NostrConnectAppMetadata = {
     name?: string;
     image?: string;
@@ -98,7 +98,8 @@ export declare class NostrConnectSigner implements Nip07Interface {
     protected log: import("debug").Debugger;
     /** The local client signer */
     signer: SimpleSigner;
-    protected subscriptionOpen: boolean;
+    /** Whether the signer is listening for events */
+    listening: boolean;
     /** Whether the signer is connected to the remote signer */
     isConnected: boolean;
     /** The users pubkey */
@@ -143,7 +144,7 @@ export declare class NostrConnectSigner implements Nip07Interface {
     connect(secret?: string | undefined, permissions?: string[]): Promise<"ack">;
     private waitingPromise;
     /** Wait for a remote signer to connect */
-    waitForSigner(): Promise<void>;
+    waitForSigner(abort?: AbortSignal): Promise<void>;
     /** Request to create an account on the remote signer */
     createAccount(username: string, domain: string, email?: string, permissions?: string[]): Promise<string>;
     /** Ensure the signer is connected to the remote signer */

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

@@ -40,7 +40,8 @@ export class NostrConnectSigner {
     log = logger.extend("NostrConnectSigner");
     /** The local client signer */
     signer;
-    subscriptionOpen = false;
+    /** Whether the signer is listening for events */
+    listening = false;
     /** Whether the signer is connected to the remote signer */
     isConnected = false;
     /** The users pubkey */
@@ -92,26 +93,35 @@ export class NostrConnectSigner {
     req;
     /** Open the connection */
     async open() {
-        if (this.subscriptionOpen)
+        if (this.listening)
             return;
-        this.subscriptionOpen = true;
+        this.listening = true;
         const pubkey = await this.signer.getPublicKey();
         // Setup subscription
-        this.req = this.subscriptionMethod([
+        this.req = this.subscriptionMethod(this.relays, [
             {
                 kinds: [kinds.NostrConnect],
                 "#p": [pubkey],
             },
-        ], this.relays).subscribe({
+        ]).subscribe({
             next: (event) => this.handleEvent(event),
         });
         this.log("Opened", this.relays);
     }
     /** Close the connection */
     async close() {
-        this.subscriptionOpen = false;
+        this.listening = false;
         this.isConnected = false;
-        this.req?.unsubscribe();
+        // Close the current subscription
+        if (this.req) {
+            this.req.unsubscribe();
+            this.req = undefined;
+        }
+        // Cancel waiting promise
+        if (this.waitingPromise) {
+            this.waitingPromise.reject(new Error("Closed"));
+            this.waitingPromise = null;
+        }
         this.log("Closed");
     }
     requests = new Map();
@@ -188,7 +198,7 @@ export class NostrConnectSigner {
         this.log(`Sending request ${id} (${method}) ${JSON.stringify(params)}`);
         const p = createDefer();
         this.requests.set(id, p);
-        await this.publishMethod?.(event, this.relays);
+        await this.publishMethod?.(this.relays, event);
         return p;
     }
     /** Connect to remote signer */
@@ -216,11 +226,16 @@ export class NostrConnectSigner {
     }
     waitingPromise = null;
     /** Wait for a remote signer to connect */
-    waitForSigner() {
+    waitForSigner(abort) {
         if (this.isConnected)
             return Promise.resolve();
         this.open();
         this.waitingPromise = createDefer();
+        abort?.addEventListener("abort", () => {
+            this.waitingPromise?.reject(new Error("Aborted"));
+            this.waitingPromise = null;
+            this.close();
+        }, true);
         return this.waitingPromise;
     }
     /** Request to create an account on the remote signer */

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

@@ -17,7 +17,7 @@ describe("NostrConnectSigner", () => {
                 publishMethod: publish,
             });
             signer.connect();
-            expect(subscription).toHaveBeenCalledWith([{ "#p": [await client.getPublicKey()], kinds: [24133] }], relays);
+            expect(subscription).toHaveBeenCalledWith(relays, [{ "#p": [await client.getPublicKey()], kinds: [24133] }]);
         });
     });
 });

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

@@ -1,5 +1,5 @@
-import { EventTemplate, verifyEvent } from "nostr-tools";
 import { Deferred } from "applesauce-core/promise";
+import { EventTemplate, verifyEvent } from "nostr-tools";
 import { Nip07Interface } from "../nip-07.js";
 type Callback = () => void;
 type DeviceOpts = {

package/dist/signers/serial-port-signer.js

@@ -1,10 +1,10 @@
 /// <reference types="@types/dom-serial" />
-import { getEventHash, verifyEvent } from "nostr-tools";
-import { base64 } from "@scure/base";
-import { randomBytes, hexToBytes, bytesToHex } from "@noble/hashes/utils";
+import { bytesToHex, hexToBytes, randomBytes } from "@noble/hashes/utils";
 import { Point } from "@noble/secp256k1";
+import { base64 } from "@scure/base";
+import { logger } from "applesauce-core";
 import { createDefer } from "applesauce-core/promise";
-import { logger } from "../logger.js";
+import { getEventHash, verifyEvent } from "nostr-tools";
 const sleep = (ms) => new Promise((r) => setTimeout(r, ms));
 function xOnlyToXY(p) {
     return Point.fromHex(p).toHex().substring(2);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "applesauce-signers",
-  "version": "0.0.0-next-20250428223834",
+  "version": "0.0.0-next-20250511152752",
   "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-20250428223834",
+    "applesauce-core": "0.0.0-next-20250511152752",
     "debug": "^4.4.0",
     "nanoid": "^5.0.9",
     "nostr-tools": "^2.10.4"
@@ -45,7 +45,7 @@
     "@types/debug": "^4.1.12",
     "@types/dom-serial": "^1.0.6",
     "typescript": "^5.8.3",
-    "vitest": "^3.1.1"
+    "vitest": "^3.1.3"
   },
   "funding": {
     "type": "lightning",