Merge pull request #3 from block-core/improve-nostr-scaling

Improve the resolve logic to only use provided relays for kind:10002

Author: sondreb

README.md

@@ -4,6 +4,18 @@ Library that helps resolve DID Documents (decentralized identities) from the "di
 
 Specification: https://nostrcg.github.io/did-nostr/
 
+## Description
+
+This library is a JavaScript implementation of the Nostr DID Resolver. It allows you to resolve DIDs (Decentralized Identifiers) using the Nostr protocol. The resolver constructs the DID document from the events retrieived specified relays (and user's relay list) and returns it in a standard format.
+
+The relays provided (or default) will only be used to retrieve the relay list (kind:10002),
+upon retrieving the relay list, the resolver will use the relays from the list to retrieve the profile metadata (kind:0).
+
+If the profile metadata is not found on the user's relays, it will fall back to the provided (or default) relays for another attempt at finding the user profile.
+
+This ensures that Nostr can scale better and the initial bootstrapping is only to discover 
+the relay list (kind:10002).
+
 ## Usage
 
 ```sh

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@blockcore/nostr-did-resolver",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "",
   "main": "lib/index.js",
   "type": "module",

package.json

@@ -30,17 +30,49 @@ export class BlockcoreDidResolver {
     const pool = new SimplePool();
     const services = [] as any[];
     let profile = null;
-
-    const metadata = await pool.get(this.#relays, {
-      kinds: [kinds.Metadata],
-      authors: [parsed.id],
-    });
+    let metadata = null;
 
     const relays = await pool.get(this.#relays, {
       kinds: [kinds.RelayList],
       authors: [parsed.id],
     });
 
+    let relayUrls: string[] = [];
+
+    if (relays) {
+      relayUrls = relays.tags.filter(tag => tag.length >= 2 && tag[0] === 'r').map(tag => tag[1]);
+
+      for (let i = 0; i < relayUrls.length; i++) {
+        services.push({
+          id: `${parsed.did}#${i + 1}`,
+          type: 'Relay',
+          serviceEndpoint: relayUrls[i],
+        });
+      }
+    }
+
+    // Attempt to connect to the user's defined relays, to help Nostr with
+    // scaling, we don't use the default relays here.
+    if (relayUrls.length > 0) {
+      const userPool = new SimplePool();
+
+      metadata = await userPool.get(relayUrls, {
+        kinds: [kinds.Metadata],
+        authors: [parsed.id],
+      });
+
+      userPool.close(relayUrls);
+    }
+
+    // If we for some reason did not find the user profile on their defined relays,
+    // or we didn't find relays, we will fall back to the default relays.
+    if (!metadata) {
+      metadata = await pool.get(this.#relays, {
+        kinds: [kinds.Metadata],
+        authors: [parsed.id],
+      });
+    }
+
     pool.close(this.#relays);
 
     if (metadata?.content) {
@@ -66,18 +98,6 @@ export class BlockcoreDidResolver {
       // }
     }
 
-    if (relays) {
-      const relayUrls = relays.tags.filter(tag => tag.length >= 2 && tag[0] === 'r').map(tag => tag[1]);
-
-      for (let i = 0; i < relayUrls.length; i++) {
-        services.push({
-          id: `${parsed.did}#${i + 1}`,
-          type: 'Relay',
-          serviceEndpoint: relayUrls[i],
-        });
-      }
-    }
-
     const didDocument = this.getDocument(parsed.did, services);
 
     const resolution: DIDResolutionResult = {

src/resolver.ts

@@ -25,9 +25,9 @@ test('Create the resolver', async t => {
   t.assert(didResolution.didResolutionMetadata.contentType == 'application/did+ld+json');
 
   t.assert(didResolution.didDocument.verificationMethod[0].publicKeyMultibase == 'z6DtPPzVD8nXDKTHG3x8cx8UpoVP6VSBsXaDhSWcoysUnkEY');
-  t.assert(didResolution.didDocument.service[0].serviceEndpoint == 'https://sondreb.com');
   t.assert(didResolution.didDocumentMetadata.profile !== null);
   t.assert(didResolution.didDocumentMetadata.profile.name == 'sondreb');
+  t.assert(didResolution.didDocument.service.find(s => s.type === 'LinkedDomains')?.serviceEndpoint === 'https://sondreb.com');
 
   // Used to generate README example:
   // console.log(JSON.stringify(didResolution, null, 2));