nostr-double-ratchet 0.0.1

package/dist/Channel.d.ts

@@ -0,0 +1,24 @@
+import { VerifiedEvent } from "nostr-tools";
+import { ChannelState, Unsubscribe, NostrSubscribe, MessageCallback, KeyPair, Sender, KeyType } from "./types";
+export declare class Channel {
+    private nostrSubscribe;
+    state: ChannelState;
+    nostrUnsubscribe: Unsubscribe | undefined;
+    nostrNextUnsubscribe: Unsubscribe | undefined;
+    currentInternalSubscriptionId: number;
+    internalSubscriptions: Map<number, MessageCallback>;
+    name: string;
+    constructor(nostrSubscribe: NostrSubscribe, state: ChannelState);
+    /**
+     * To preserve forward secrecy, do not use long-term keys for channel initialization. Use e.g. InviteLink to exchange session keys.
+     */
+    static init(nostrSubscribe: NostrSubscribe, theirCurrentNostrPublicKey: string, ourCurrentPrivateKey: Uint8Array, name?: string): Channel;
+    updateTheirCurrentNostrPublicKey(theirNewPublicKey: string): void;
+    private rotateOurCurrentNostrKey;
+    getNostrSenderKeypair(sender: Sender, keyType: KeyType): KeyPair;
+    private nostrSubscribeNext;
+    private subscribeToNostrEvents;
+    onMessage(callback: MessageCallback): Unsubscribe;
+    send(data: string): VerifiedEvent;
+}
+//# sourceMappingURL=Channel.d.ts.map

package/dist/Channel.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Channel.d.ts","sourceRoot":"","sources":["../src/Channel.ts"],"names":[],"mappings":"AAAA,OAAO,EAAyD,aAAa,EAAE,MAAM,aAAa,CAAC;AAEnG,OAAO,EACL,YAAY,EAEZ,WAAW,EACX,cAAc,EACd,eAAe,EAEf,OAAO,EACP,MAAM,EACN,OAAO,EACR,MAAM,SAAS,CAAC;AAGjB,qBAAa,OAAO;IAON,OAAO,CAAC,cAAc;IAAyB,KAAK,EAAE,YAAY;IAN9E,gBAAgB,EAAE,WAAW,GAAG,SAAS,CAAA;IACzC,oBAAoB,EAAE,WAAW,GAAG,SAAS,CAAA;IAC7C,6BAA6B,SAAI;IACjC,qBAAqB,+BAAqC;IAC1D,IAAI,SAA6C;gBAE7B,cAAc,EAAE,cAAc,EAAS,KAAK,EAAE,YAAY;IAI9E;;OAEG;IACH,MAAM,CAAC,IAAI,CAAC,cAAc,EAAE,cAAc,EAAE,0BAA0B,EAAE,MAAM,EAAE,oBAAoB,EAAE,UAAU,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO;IAoBzI,gCAAgC,CAAC,iBAAiB,EAAE,MAAM;IAU1D,OAAO,CAAC,wBAAwB;IAShC,qBAAqB,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO;IAchE,OAAO,CAAC,kBAAkB;IAiB1B,OAAO,CAAC,sBAAsB;IAiB9B,SAAS,CAAC,QAAQ,EAAE,eAAe,GAAG,WAAW;IAOjD,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,aAAa;CAmBlC"}

package/dist/InviteLink.d.ts

@@ -0,0 +1,51 @@
+import { VerifiedEvent } from "nostr-tools";
+import { NostrSubscribe, Unsubscribe } from "./types";
+import { Channel } from "./Channel";
+import { EncryptFunction, DecryptFunction } from "./types";
+/**
+ * Invite link is a safe way to exchange session keys and initiate secret channels.
+ *
+ * Even if inviter's or invitee's long-term private key (identity key) and the shared secret (link) is compromised,
+ * forward secrecy is preserved as long as the session keys are not compromised.
+ *
+ * Shared secret Nostr channel: inviter listens to it and invitees can write to it. Outside observers don't know who are communicating over it.
+ * It is vulnerable to spam, so the link should only be given to trusted invitees or used with a reasonable maxUses limit.
+ *
+ * Also make sure to keep the session key safe.
+ */
+export declare class InviteLink {
+    inviterSessionPublicKey: string;
+    linkSecret: string;
+    inviter: string;
+    inviterSessionPrivateKey?: Uint8Array | undefined;
+    label?: string | undefined;
+    maxUses?: number | undefined;
+    usedBy: string[];
+    constructor(inviterSessionPublicKey: string, linkSecret: string, inviter: string, inviterSessionPrivateKey?: Uint8Array | undefined, label?: string | undefined, maxUses?: number | undefined, usedBy?: string[]);
+    static createNew(inviter: string, label?: string, maxUses?: number): InviteLink;
+    static fromUrl(url: string): InviteLink;
+    static deserialize(json: string): InviteLink;
+    serialize(): string;
+    getUrl(root?: string): string;
+    /**
+     * Accepts the invite and creates a new channel with the inviter.
+     *
+     * @param inviteeSecretKey - The invitee's secret key or a signing function
+     * @param nostrSubscribe - A function to subscribe to Nostr events
+     * @returns An object containing the new channel and an event to be published
+     *
+     * 1. Inner event: No signature, content encrypted with DH(inviter, invitee).
+     *    Purpose: Authenticate invitee. Contains invitee session key.
+     * 2. Envelope: No signature, content encrypted with DH(inviter, random key).
+     *    Purpose: Contains inner event. Hides invitee from others who might have the shared Nostr key.
+
+     * Note: You need to publish the returned event on Nostr using NDK or another Nostr system of your choice,
+     * so the inviter can create the channel on their side.
+     */
+    acceptInvite(nostrSubscribe: NostrSubscribe, inviteePublicKey: string, inviteeSecretKey: Uint8Array | EncryptFunction): Promise<{
+        channel: Channel;
+        event: VerifiedEvent;
+    }>;
+    listen(inviterSecretKey: Uint8Array | DecryptFunction, nostrSubscribe: NostrSubscribe, onChannel: (channel: Channel, identity?: string) => void): Unsubscribe;
+}
+//# sourceMappingURL=InviteLink.d.ts.map

package/dist/InviteLink.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"InviteLink.d.ts","sourceRoot":"","sources":["../src/InviteLink.ts"],"names":[],"mappings":"AAAA,OAAO,EAAyD,aAAa,EAAS,MAAM,aAAa,CAAC;AAE1G,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAEtD,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAE3D;;;;;;;;;;GAUG;AACH,qBAAa,UAAU;IAER,uBAAuB,EAAE,MAAM;IAC/B,UAAU,EAAE,MAAM;IAClB,OAAO,EAAE,MAAM;IACf,wBAAwB,CAAC,EAAE,UAAU;IACrC,KAAK,CAAC,EAAE,MAAM;IACd,OAAO,CAAC,EAAE,MAAM;IAChB,MAAM,EAAE,MAAM,EAAE;gBANhB,uBAAuB,EAAE,MAAM,EAC/B,UAAU,EAAE,MAAM,EAClB,OAAO,EAAE,MAAM,EACf,wBAAwB,CAAC,EAAE,UAAU,YAAA,EACrC,KAAK,CAAC,EAAE,MAAM,YAAA,EACd,OAAO,CAAC,EAAE,MAAM,YAAA,EAChB,MAAM,GAAE,MAAM,EAAO;IAGhC,MAAM,CAAC,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,UAAU;IAc/E,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU;IA6BvC,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU;IAa5C,SAAS,IAAI,MAAM;IAYnB,MAAM,CAAC,IAAI,SAAoB;IAO/B;;;;;;;;;;;;;;OAcG;IACG,YAAY,CACd,cAAc,EAAE,cAAc,EAC9B,gBAAgB,EAAE,MAAM,EACxB,gBAAgB,EAAE,UAAU,GAAG,eAAe,GAC/C,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,KAAK,EAAE,aAAa,CAAA;KAAE,CAAC;IAiCtD,MAAM,CAAC,gBAAgB,EAAE,UAAU,GAAG,eAAe,EAAE,cAAc,EAAE,cAAc,EAAE,SAAS,EAAE,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,IAAI,GAAG,WAAW;CAkChK"}

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./Channel";
+export * from "./InviteLink";
+export * from "./types";
+export * from "./utils";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAA;AACzB,cAAc,cAAc,CAAA;AAC5B,cAAc,SAAS,CAAA;AACvB,cAAc,SAAS,CAAA"}