@unicitylabs/nostr-js-sdk 0.1.0 → 0.2.0

package/dist/types/messaging/nip17.d.ts

@@ -0,0 +1,42 @@
+/**
+ * NIP-17 Private Direct Messages Protocol.
+ * Implements gift-wrapping for sender anonymity using NIP-44 encryption.
+ *
+ * Message flow:
+ * 1. Create Rumor (kind 14, unsigned) with actual message content
+ * 2. Create Seal (kind 13, signed by sender) encrypting the rumor
+ * 3. Create Gift Wrap (kind 1059, signed by random ephemeral key) encrypting the seal
+ *
+ * Only the recipient can decrypt and verify the true sender.
+ */
+import { NostrKeyManager } from '../NostrKeyManager.js';
+import { Event } from '../protocol/Event.js';
+import { PrivateMessage, PrivateMessageOptions } from './types.js';
+/**
+ * Create a gift-wrapped private message.
+ *
+ * @param senderKeys Sender's key manager
+ * @param recipientPubkeyHex Recipient's public key (hex)
+ * @param content Message content
+ * @param options Optional message options (reply-to, etc.)
+ * @returns Gift-wrapped event (kind 1059)
+ */
+export declare function createGiftWrap(senderKeys: NostrKeyManager, recipientPubkeyHex: string, content: string, options?: PrivateMessageOptions): Event;
+/**
+ * Create a gift-wrapped read receipt.
+ *
+ * @param senderKeys Sender's key manager
+ * @param recipientPubkeyHex Recipient (original sender) public key
+ * @param messageEventId Event ID of the message being acknowledged
+ * @returns Gift-wrapped read receipt event
+ */
+export declare function createReadReceipt(senderKeys: NostrKeyManager, recipientPubkeyHex: string, messageEventId: string): Event;
+/**
+ * Unwrap a gift-wrapped message.
+ *
+ * @param giftWrap Gift wrap event (kind 1059)
+ * @param recipientKeys Recipient's key manager
+ * @returns Parsed private message
+ */
+export declare function unwrap(giftWrap: Event, recipientKeys: NostrKeyManager): PrivateMessage;
+//# sourceMappingURL=nip17.d.ts.map

package/dist/types/messaging/nip17.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"nip17.d.ts","sourceRoot":"","sources":["../../../src/messaging/nip17.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAIH,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AACxD,OAAO,EAAE,KAAK,EAA6B,MAAM,sBAAsB,CAAC;AAIxE,OAAO,EAAS,cAAc,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AAK1E;;;;;;;;GAQG;AACH,wBAAgB,cAAc,CAC5B,UAAU,EAAE,eAAe,EAC3B,kBAAkB,EAAE,MAAM,EAC1B,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,qBAAqB,GAC9B,KAAK,CAeP;AAED;;;;;;;GAOG;AACH,wBAAgB,iBAAiB,CAC/B,UAAU,EAAE,eAAe,EAC3B,kBAAkB,EAAE,MAAM,EAC1B,cAAc,EAAE,MAAM,GACrB,KAAK,CAwBP;AAED;;;;;;GAMG;AACH,wBAAgB,MAAM,CAAC,QAAQ,EAAE,KAAK,EAAE,aAAa,EAAE,eAAe,GAAG,cAAc,CAiDtF"}

package/dist/types/messaging/types.d.ts

@@ -0,0 +1,59 @@
+/**
+ * NIP-17 Messaging Types - Private Direct Messages
+ */
+import { EventTag } from '../protocol/Event.js';
+/**
+ * Rumor - An unsigned inner event for NIP-17 private messages.
+ * Rumors are wrapped in seals and gift wraps for sender privacy.
+ * Unlike regular Events, Rumors do NOT have a signature field.
+ */
+export interface Rumor {
+    /** Event ID (SHA-256 hash of serialized rumor) */
+    id: string;
+    /** Public key of rumor creator (real sender) */
+    pubkey: string;
+    /** Unix timestamp in seconds */
+    created_at: number;
+    /** Event kind (14 for chat message, 15 for read receipt) */
+    kind: number;
+    /** Event tags */
+    tags: EventTag[];
+    /** Message content */
+    content: string;
+}
+/**
+ * Parsed private message from NIP-17 gift-wrapped event.
+ * Contains the decrypted message content and metadata.
+ */
+export interface PrivateMessage {
+    /** Nostr event ID of the gift wrap (for deduplication) */
+    eventId: string;
+    /** Sender's public key (from the seal, not the gift wrap) */
+    senderPubkey: string;
+    /** Recipient's public key */
+    recipientPubkey: string;
+    /** Message content */
+    content: string;
+    /** Message timestamp (from the rumor) */
+    timestamp: number;
+    /** Original rumor kind (14 for chat, 15 for read receipt) */
+    kind: number;
+    /** Reply-to event ID (if this is a reply) */
+    replyToEventId?: string;
+}
+/**
+ * Check if a message is a chat message (kind 14).
+ */
+export declare function isChatMessage(message: PrivateMessage): boolean;
+/**
+ * Check if a message is a read receipt (kind 15).
+ */
+export declare function isReadReceipt(message: PrivateMessage): boolean;
+/**
+ * Options for creating a private message.
+ */
+export interface PrivateMessageOptions {
+    /** Optional event ID this message is replying to */
+    replyToEventId?: string;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types/messaging/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/messaging/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAEhD;;;;GAIG;AACH,MAAM,WAAW,KAAK;IACpB,kDAAkD;IAClD,EAAE,EAAE,MAAM,CAAC;IAEX,gDAAgD;IAChD,MAAM,EAAE,MAAM,CAAC;IAEf,gCAAgC;IAChC,UAAU,EAAE,MAAM,CAAC;IAEnB,4DAA4D;IAC5D,IAAI,EAAE,MAAM,CAAC;IAEb,iBAAiB;IACjB,IAAI,EAAE,QAAQ,EAAE,CAAC;IAEjB,sBAAsB;IACtB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B,0DAA0D;IAC1D,OAAO,EAAE,MAAM,CAAC;IAEhB,6DAA6D;IAC7D,YAAY,EAAE,MAAM,CAAC;IAErB,6BAA6B;IAC7B,eAAe,EAAE,MAAM,CAAC;IAExB,sBAAsB;IACtB,OAAO,EAAE,MAAM,CAAC;IAEhB,yCAAyC;IACzC,SAAS,EAAE,MAAM,CAAC;IAElB,6DAA6D;IAC7D,IAAI,EAAE,MAAM,CAAC;IAEb,6CAA6C;IAC7C,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;GAEG;AACH,wBAAgB,aAAa,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAE9D;AAED;;GAEG;AACH,wBAAgB,aAAa,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAE9D;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,oDAAoD;IACpD,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB"}

package/dist/types/payment/PaymentRequestProtocol.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PaymentRequestProtocol.d.ts","sourceRoot":"","sources":["../../../src/payment/PaymentRequestProtocol.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AACxD,OAAO,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAC;AAM7C;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,wDAAwD;IACxD,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC;IACxB,sDAAsD;IACtD,MAAM,EAAE,MAAM,CAAC;IACf,8CAA8C;IAC9C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,oEAAoE;IACpE,gBAAgB,EAAE,MAAM,CAAC;IACzB,sEAAsE;IACtE,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,+BAA+B;IAC/B,MAAM,EAAE,MAAM,CAAC;IACf,2BAA2B;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,uBAAuB;IACvB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,0CAA0C;IAC1C,gBAAgB,EAAE,MAAM,CAAC;IACzB,wBAAwB;IACxB,SAAS,EAAE,MAAM,CAAC;IAClB,sDAAsD;IACtD,YAAY,EAAE,MAAM,CAAC;IACrB,sBAAsB;IACtB,SAAS,EAAE,MAAM,CAAC;IAClB,wBAAwB;IACxB,OAAO,EAAE,MAAM,CAAC;CACjB;AAoBD;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAsB,yBAAyB,CAC7C,UAAU,EAAE,eAAe,EAC3B,eAAe,EAAE,MAAM,EACvB,OAAO,EAAE,cAAc,GACtB,OAAO,CAAC,KAAK,CAAC,CAmChB;AAED;;;;;;;;GAQG;AACH,wBAAsB,mBAAmB,CACvC,KAAK,EAAE,KAAK,EACZ,UAAU,EAAE,eAAe,GAC1B,OAAO,CAAC,oBAAoB,CAAC,CAgD/B;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,CAKtD;AAED;;;;GAIG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,GAAG,SAAS,CAU1D;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,GAAG,SAAS,CAEpE;AAED;;;;GAIG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,GAAG,SAAS,CAE1D;AAED;;;;GAIG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,CAE9C;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,QAAQ,GAAE,MAAU,GAAG,MAAM,CAiBlF;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,GAAE,MAAU,GAAG,MAAM,CAsB3E"}
+{"version":3,"file":"PaymentRequestProtocol.d.ts","sourceRoot":"","sources":["../../../src/payment/PaymentRequestProtocol.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AACxD,OAAO,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAC;AAM7C;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,wDAAwD;IACxD,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC;IACxB,sDAAsD;IACtD,MAAM,EAAE,MAAM,CAAC;IACf,8CAA8C;IAC9C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,oEAAoE;IACpE,gBAAgB,EAAE,MAAM,CAAC;IACzB,sEAAsE;IACtE,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,+BAA+B;IAC/B,MAAM,EAAE,MAAM,CAAC;IACf,2BAA2B;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,uBAAuB;IACvB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,0CAA0C;IAC1C,gBAAgB,EAAE,MAAM,CAAC;IACzB,wBAAwB;IACxB,SAAS,EAAE,MAAM,CAAC;IAClB,sDAAsD;IACtD,YAAY,EAAE,MAAM,CAAC;IACrB,sBAAsB;IACtB,SAAS,EAAE,MAAM,CAAC;IAClB,wBAAwB;IACxB,OAAO,EAAE,MAAM,CAAC;CACjB;AAsBD;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAsB,yBAAyB,CAC7C,UAAU,EAAE,eAAe,EAC3B,eAAe,EAAE,MAAM,EACvB,OAAO,EAAE,cAAc,GACtB,OAAO,CAAC,KAAK,CAAC,CAmChB;AAED;;;;;;;;GAQG;AACH,wBAAsB,mBAAmB,CACvC,KAAK,EAAE,KAAK,EACZ,UAAU,EAAE,eAAe,GAC1B,OAAO,CAAC,oBAAoB,CAAC,CAgD/B;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,CAKtD;AAED;;;;GAIG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,GAAG,SAAS,CAU1D;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,GAAG,SAAS,CAEpE;AAED;;;;GAIG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,GAAG,SAAS,CAE1D;AAED;;;;GAIG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,CAE9C;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,QAAQ,GAAE,MAAU,GAAG,MAAM,CAiBlF;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,GAAE,MAAU,GAAG,MAAM,CAsB3E"}

package/dist/types/protocol/EventKinds.d.ts

@@ -14,6 +14,12 @@ export declare const CONTACTS = 3;
 export declare const ENCRYPTED_DM = 4;
 /** NIP-09: Event deletion */
 export declare const DELETION = 5;
+/** NIP-17: Seal (signed, encrypted rumor) */
+export declare const SEAL = 13;
+/** NIP-17: Private chat message (rumor - unsigned inner event) */
+export declare const CHAT_MESSAGE = 14;
+/** NIP-17: Read receipt (rumor kind) */
+export declare const READ_RECEIPT = 15;
 /** NIP-25: Reactions (likes, etc.) */
 export declare const REACTION = 7;
 /** NIP-59: Gift wrap for private events */

package/dist/types/protocol/EventKinds.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"EventKinds.d.ts","sourceRoot":"","sources":["../../../src/protocol/EventKinds.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAMH,oCAAoC;AACpC,eAAO,MAAM,OAAO,IAAI,CAAC;AAEzB,8BAA8B;AAC9B,eAAO,MAAM,SAAS,IAAI,CAAC;AAE3B,2CAA2C;AAC3C,eAAO,MAAM,eAAe,IAAI,CAAC;AAEjC,qCAAqC;AACrC,eAAO,MAAM,QAAQ,IAAI,CAAC;AAE1B,wCAAwC;AACxC,eAAO,MAAM,YAAY,IAAI,CAAC;AAE9B,6BAA6B;AAC7B,eAAO,MAAM,QAAQ,IAAI,CAAC;AAE1B,sCAAsC;AACtC,eAAO,MAAM,QAAQ,IAAI,CAAC;AAE1B,2CAA2C;AAC3C,eAAO,MAAM,SAAS,OAAO,CAAC;AAE9B,kCAAkC;AAClC,eAAO,MAAM,UAAU,QAAQ,CAAC;AAEhC,oEAAoE;AACpE,eAAO,MAAM,QAAQ,QAAQ,CAAC;AAM9B,yCAAyC;AACzC,eAAO,MAAM,aAAa,QAAQ,CAAC;AAEnC,kCAAkC;AAClC,eAAO,MAAM,cAAc,QAAQ,CAAC;AAEpC,oCAAoC;AACpC,eAAO,MAAM,cAAc,QAAQ,CAAC;AAEpC,6BAA6B;AAC7B,eAAO,MAAM,aAAa,QAAQ,CAAC;AAEnC,+BAA+B;AAC/B,eAAO,MAAM,eAAe,QAAQ,CAAC;AAMrC;;;;;;GAMG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAEnD;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAEjD;AAED;;;;;;GAMG;AACH,wBAAgB,0BAA0B,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAEhE;AAED;;;;GAIG;AACH,wBAAgB,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CA4C5C"}
+{"version":3,"file":"EventKinds.d.ts","sourceRoot":"","sources":["../../../src/protocol/EventKinds.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAMH,oCAAoC;AACpC,eAAO,MAAM,OAAO,IAAI,CAAC;AAEzB,8BAA8B;AAC9B,eAAO,MAAM,SAAS,IAAI,CAAC;AAE3B,2CAA2C;AAC3C,eAAO,MAAM,eAAe,IAAI,CAAC;AAEjC,qCAAqC;AACrC,eAAO,MAAM,QAAQ,IAAI,CAAC;AAE1B,wCAAwC;AACxC,eAAO,MAAM,YAAY,IAAI,CAAC;AAE9B,6BAA6B;AAC7B,eAAO,MAAM,QAAQ,IAAI,CAAC;AAE1B,6CAA6C;AAC7C,eAAO,MAAM,IAAI,KAAK,CAAC;AAEvB,kEAAkE;AAClE,eAAO,MAAM,YAAY,KAAK,CAAC;AAE/B,wCAAwC;AACxC,eAAO,MAAM,YAAY,KAAK,CAAC;AAE/B,sCAAsC;AACtC,eAAO,MAAM,QAAQ,IAAI,CAAC;AAE1B,2CAA2C;AAC3C,eAAO,MAAM,SAAS,OAAO,CAAC;AAE9B,kCAAkC;AAClC,eAAO,MAAM,UAAU,QAAQ,CAAC;AAEhC,oEAAoE;AACpE,eAAO,MAAM,QAAQ,QAAQ,CAAC;AAM9B,yCAAyC;AACzC,eAAO,MAAM,aAAa,QAAQ,CAAC;AAEnC,kCAAkC;AAClC,eAAO,MAAM,cAAc,QAAQ,CAAC;AAEpC,oCAAoC;AACpC,eAAO,MAAM,cAAc,QAAQ,CAAC;AAEpC,6BAA6B;AAC7B,eAAO,MAAM,aAAa,QAAQ,CAAC;AAEnC,+BAA+B;AAC/B,eAAO,MAAM,eAAe,QAAQ,CAAC;AAMrC;;;;;;GAMG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAEnD;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAEjD;AAED;;;;;;GAMG;AACH,wBAAgB,0BAA0B,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAEhE;AAED;;;;GAIG;AACH,wBAAgB,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAkD5C"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unicitylabs/nostr-js-sdk",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Unicity Nostr SDK - Token transfers and nametag bindings over Nostr protocol",
   "license": "MIT",
   "author": "Unicity Labs",
@@ -64,6 +64,7 @@
     "prepublishOnly": "npm run clean && npm run build && npm test"
   },
   "dependencies": {
+    "@noble/ciphers": "^1.0.0",
     "@noble/curves": "^1.6.0",
     "@noble/hashes": "^1.5.0",
     "@scure/base": "^1.1.9",