ncc-05 1.0.0 → 1.1.0

package/dist/index.d.ts

@@ -18,6 +18,24 @@ export interface ResolverOptions {
     timeout?: number;
     websocketImplementation?: any;
 }
+/**
+ * Utility for managing shared group access to NCC-05 records.
+ */
+export declare class NCC05Group {
+    /**
+     * Generate a new shared identity for a group.
+     * The nsec should be shared with all authorized members.
+     */
+    static createGroupIdentity(): {
+        nsec: `nsec1${string}`;
+        sk: Uint8Array<ArrayBufferLike>;
+        pk: string;
+    };
+    /**
+     * Resolve a record that was published using a group's shared identity.
+     */
+    static resolveAsGroup(resolver: NCC05Resolver, groupPubkey: string, groupSecretKey: Uint8Array, identifier?: string): Promise<NCC05Payload | null>;
+}
 export declare class NCC05Resolver {
     private pool;
     private bootstrapRelays;
@@ -40,7 +58,8 @@ export declare class NCC05Publisher {
     });
     /**
      * Create and publish a locator record.
+     * @param recipientPubkey Optional hex pubkey of the recipient. If omitted, self-encrypts.
      */
-    publish(relays: string[], secretKey: Uint8Array, payload: NCC05Payload, identifier?: string): Promise<Event>;
+    publish(relays: string[], secretKey: Uint8Array, payload: NCC05Payload, identifier?: string, recipientPubkey?: string): Promise<Event>;
     close(relays: string[]): void;
 }

package/dist/index.js

@@ -1,4 +1,29 @@
-import { SimplePool, nip44, nip19, finalizeEvent, verifyEvent, getPublicKey } from 'nostr-tools';
+import { SimplePool, nip44, nip19, finalizeEvent, verifyEvent, getPublicKey, generateSecretKey } from 'nostr-tools';
+/**
+ * Utility for managing shared group access to NCC-05 records.
+ */
+export class NCC05Group {
+    /**
+     * Generate a new shared identity for a group.
+     * The nsec should be shared with all authorized members.
+     */
+    static createGroupIdentity() {
+        const sk = generateSecretKey();
+        return {
+            nsec: nip19.nsecEncode(sk),
+            sk: sk,
+            pk: getPublicKey(sk)
+        };
+    }
+    /**
+     * Resolve a record that was published using a group's shared identity.
+     */
+    static async resolveAsGroup(resolver, groupPubkey, groupSecretKey, identifier = 'addr') {
+        // In group mode, we use the group's SK to decrypt a record 
+        // that was self-encrypted by the group's PK.
+        return resolver.resolve(groupPubkey, groupSecretKey, identifier);
+    }
+}
 export class NCC05Resolver {
     pool;
     bootstrapRelays;
@@ -97,16 +122,19 @@ export class NCC05Publisher {
     }
     /**
      * Create and publish a locator record.
+     * @param recipientPubkey Optional hex pubkey of the recipient. If omitted, self-encrypts.
      */
-    async publish(relays, secretKey, payload, identifier = 'addr') {
-        const pubkey = getPublicKey(secretKey);
+    async publish(relays, secretKey, payload, identifier = 'addr', recipientPubkey) {
+        const myPubkey = getPublicKey(secretKey);
+        const encryptionTarget = recipientPubkey || myPubkey;
         // 1. Encrypt
-        const conversationKey = nip44.getConversationKey(secretKey, pubkey);
+        const conversationKey = nip44.getConversationKey(secretKey, encryptionTarget);
         const encryptedContent = nip44.encrypt(JSON.stringify(payload), conversationKey);
         // 2. Create and Finalize Event
         const eventTemplate = {
             kind: 30058,
             created_at: Math.floor(Date.now() / 1000),
+            pubkey: myPubkey,
             tags: [['d', identifier]],
             content: encryptedContent,
         };

package/dist/test.js

@@ -1,4 +1,4 @@
-import { NCC05Publisher, NCC05Resolver } from './index.js';
+import { NCC05Publisher, NCC05Resolver, NCC05Group } from './index.js';
 import { generateSecretKey, getPublicKey } from 'nostr-tools';
 async function test() {
     const sk = generateSecretKey();
@@ -73,6 +73,37 @@ async function test() {
         console.error('FAILED: npub resolution did not find record.');
         process.exit(1);
     }
+    // Test Friend-to-Friend resolution
+    console.log('Testing Friend-to-Friend resolution...');
+    const skA = generateSecretKey();
+    const pkA = getPublicKey(skA);
+    const skB = generateSecretKey();
+    const pkB = getPublicKey(skB);
+    const payloadFriend = {
+        v: 1, ttl: 60, updated_at: Math.floor(Date.now() / 1000),
+        endpoints: [{ type: 'tcp', uri: 'friend:7777', priority: 1, family: 'ipv4' }]
+    };
+    // User A publishes for User B
+    console.log('User A publishing for User B...');
+    await publisher.publish(relays, skA, payloadFriend, 'friend-test', pkB);
+    // Test Group Resolution Utility
+    console.log('Testing NCC05Group utility...');
+    const groupIdentity = NCC05Group.createGroupIdentity();
+    const payloadGroup = {
+        v: 1, ttl: 60, updated_at: Math.floor(Date.now() / 1000),
+        endpoints: [{ type: 'tcp', uri: 'group-service:8888', priority: 1, family: 'ipv4' }]
+    };
+    console.log('Publishing as Group...');
+    await publisher.publish(relays, groupIdentity.sk, payloadGroup, 'group-test');
+    console.log('Resolving as Group Member...');
+    const groupResult = await NCC05Group.resolveAsGroup(resolver, groupIdentity.pk, groupIdentity.sk, 'group-test');
+    if (groupResult && groupResult.endpoints[0].uri === 'group-service:8888') {
+        console.log('NCC05Group resolution successful.');
+    }
+    else {
+        console.error('FAILED: NCC05Group resolution.');
+        process.exit(1);
+    }
     publisher.close(relays);
     resolver.close();
     process.exit(0);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ncc-05",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Nostr Community Convention 05 - Identity-Bound Service Locator Resolution",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -9,7 +9,13 @@
     "build": "tsc",
     "prepublishOnly": "npm run build"
   },
-  "keywords": ["nostr", "dns", "identity", "resolution", "privacy"],
+  "keywords": [
+    "nostr",
+    "dns",
+    "identity",
+    "resolution",
+    "privacy"
+  ],
   "author": "lostcause",
   "license": "MIT",
   "dependencies": {
@@ -19,4 +25,4 @@
     "typescript": "^5.0.0",
     "@types/node": "^20.0.0"
   }
-}
+}

package/src/index.ts

@@ -5,7 +5,8 @@ import {
     finalizeEvent, 
     verifyEvent, 
     Event, 
-    getPublicKey
+    getPublicKey,
+    generateSecretKey
 } from 'nostr-tools';
 
 export interface NCC05Endpoint {
@@ -30,6 +31,38 @@ export interface ResolverOptions {
     websocketImplementation?: any; // To support Tor/SOCKS5 proxies in Node.js
 }
 
+/**
+ * Utility for managing shared group access to NCC-05 records.
+ */
+export class NCC05Group {
+    /**
+     * Generate a new shared identity for a group.
+     * The nsec should be shared with all authorized members.
+     */
+    static createGroupIdentity() {
+        const sk = generateSecretKey();
+        return {
+            nsec: nip19.nsecEncode(sk),
+            sk: sk,
+            pk: getPublicKey(sk)
+        };
+    }
+
+    /**
+     * Resolve a record that was published using a group's shared identity.
+     */
+    static async resolveAsGroup(
+        resolver: NCC05Resolver,
+        groupPubkey: string,
+        groupSecretKey: Uint8Array,
+        identifier: string = 'addr'
+    ): Promise<NCC05Payload | null> {
+        // In group mode, we use the group's SK to decrypt a record 
+        // that was self-encrypted by the group's PK.
+        return resolver.resolve(groupPubkey, groupSecretKey, identifier);
+    }
+}
+
 export class NCC05Resolver {
     private pool: SimplePool;
     private bootstrapRelays: string[];
@@ -151,23 +184,27 @@ export class NCC05Publisher {
 
     /**
      * Create and publish a locator record.
+     * @param recipientPubkey Optional hex pubkey of the recipient. If omitted, self-encrypts.
      */
     async publish(
         relays: string[],
         secretKey: Uint8Array,
         payload: NCC05Payload,
-        identifier: string = 'addr'
+        identifier: string = 'addr',
+        recipientPubkey?: string
     ): Promise<Event> {
-        const pubkey = getPublicKey(secretKey);
+        const myPubkey = getPublicKey(secretKey);
+        const encryptionTarget = recipientPubkey || myPubkey;
         
         // 1. Encrypt
-        const conversationKey = nip44.getConversationKey(secretKey, pubkey);
+        const conversationKey = nip44.getConversationKey(secretKey, encryptionTarget);
         const encryptedContent = nip44.encrypt(JSON.stringify(payload), conversationKey);
 
         // 2. Create and Finalize Event
         const eventTemplate = {
             kind: 30058,
             created_at: Math.floor(Date.now() / 1000),
+            pubkey: myPubkey,
             tags: [['d', identifier]],
             content: encryptedContent,
         };
@@ -183,4 +220,4 @@ export class NCC05Publisher {
     close(relays: string[]) {
         this.pool.close(relays);
     }
-}
+}

package/src/test.ts

@@ -1,4 +1,4 @@
-import { NCC05Publisher, NCC05Resolver, NCC05Payload } from './index.js';
+import { NCC05Publisher, NCC05Resolver, NCC05Payload, NCC05Group } from './index.js';
 import { generateSecretKey, getPublicKey } from 'nostr-tools';
 
 async function test() {
@@ -81,6 +81,42 @@ async function test() {
         process.exit(1);
     }
 
+    // Test Friend-to-Friend resolution
+    console.log('Testing Friend-to-Friend resolution...');
+    const skA = generateSecretKey();
+    const pkA = getPublicKey(skA);
+    const skB = generateSecretKey();
+    const pkB = getPublicKey(skB);
+
+    const payloadFriend: NCC05Payload = {
+        v: 1, ttl: 60, updated_at: Math.floor(Date.now() / 1000),
+        endpoints: [{ type: 'tcp', uri: 'friend:7777', priority: 1, family: 'ipv4' }]
+    };
+
+    // User A publishes for User B
+    console.log('User A publishing for User B...');
+    await publisher.publish(relays, skA, payloadFriend, 'friend-test', pkB);
+
+    // Test Group Resolution Utility
+    console.log('Testing NCC05Group utility...');
+    const groupIdentity = NCC05Group.createGroupIdentity();
+    const payloadGroup: NCC05Payload = {
+        v: 1, ttl: 60, updated_at: Math.floor(Date.now() / 1000),
+        endpoints: [{ type: 'tcp', uri: 'group-service:8888', priority: 1, family: 'ipv4' }]
+    };
+
+    console.log('Publishing as Group...');
+    await publisher.publish(relays, groupIdentity.sk, payloadGroup, 'group-test');
+
+    console.log('Resolving as Group Member...');
+    const groupResult = await NCC05Group.resolveAsGroup(resolver, groupIdentity.pk, groupIdentity.sk, 'group-test');
+    if (groupResult && groupResult.endpoints[0].uri === 'group-service:8888') {
+        console.log('NCC05Group resolution successful.');
+    } else {
+        console.error('FAILED: NCC05Group resolution.');
+        process.exit(1);
+    }
+
     publisher.close(relays);
     resolver.close();
     process.exit(0);