applesauce-signers 0.0.0-next-20250428164231 → 0.0.0-next-20250429163257

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/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) => void | Promise<void>;
 export type NostrConnectAppMetadata = {
     name?: string;
     image?: string;

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

@@ -97,12 +97,12 @@ export class NostrConnectSigner {
         this.subscriptionOpen = 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);
@@ -188,7 +188,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 */

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "applesauce-signers",
-  "version": "0.0.0-next-20250428164231",
+  "version": "0.0.0-next-20250429163257",
   "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-20250428164231",
+    "applesauce-core": "0.0.0-next-20250429163257",
     "debug": "^4.4.0",
     "nanoid": "^5.0.9",
     "nostr-tools": "^2.10.4"