feat: add NIP-11 root response fields and CORS headers

Author: a-khushal

src/handlers/request-handlers/root-request-handler.ts

@@ -13,7 +13,7 @@ export const rootRequestHandler = (request: Request, response: Response, next: N
 
   if (accepts(request).type(['application/nostr+json'])) {
     const {
-      info: { name, description, pubkey: rawPubkey, contact, relay_url },
+      info: { name, description, banner, icon, pubkey: rawPubkey, self: rawSelf, contact, relay_url, terms_of_service },
     } = settings
 
     const paymentsUrl = new URL(relay_url)
@@ -23,16 +23,21 @@ export const rootRequestHandler = (request: Request, response: Response, next: N
     const content = settings.limits?.event?.content
 
     const pubkey = rawPubkey.startsWith('npub1') ? fromBech32(rawPubkey) : rawPubkey
+    const self = rawSelf?.startsWith('npub1') ? fromBech32(rawSelf) : rawSelf
 
     const relayInformationDocument = {
       name,
       description,
+      banner,
+      icon,
       pubkey,
+      self,
       contact,
       supported_nips: packageJson.supportedNips,
       supported_nip_extensions: packageJson.supportedNipExtensions,
       software: packageJson.repository.url,
       version: packageJson.version,
+      terms_of_service,
       limitation: {
         max_message_length: settings.network.maxPayloadSize,
         max_subscriptions: settings.limits?.client?.subscription?.maxSubscriptions,
@@ -68,6 +73,8 @@ export const rootRequestHandler = (request: Request, response: Response, next: N
     response
       .setHeader('content-type', 'application/nostr+json')
       .setHeader('access-control-allow-origin', '*')
+      .setHeader('access-control-allow-headers', '*')
+      .setHeader('access-control-allow-methods', 'GET, OPTIONS')
       .status(200)
       .send(relayInformationDocument)
 

test/unit/handlers/request-handlers/root-request-handler.spec.ts

@@ -83,6 +83,14 @@ describe('rootRequestHandler', () => {
       expect(res.status).to.have.been.calledWith(200)
     })
 
+    it('sets required NIP-11 CORS headers', () => {
+      rootRequestHandler(req, res, next)
+
+      expect(res.setHeader).to.have.been.calledWith('access-control-allow-origin', '*')
+      expect(res.setHeader).to.have.been.calledWith('access-control-allow-headers', '*')
+      expect(res.setHeader).to.have.been.calledWith('access-control-allow-methods', 'GET, OPTIONS')
+    })
+
     it('includes the relay name in the response', () => {
       rootRequestHandler(req, res, next)
 
@@ -95,6 +103,27 @@ describe('rootRequestHandler', () => {
 
       expect(getTemplateStub).to.not.have.been.called
     })
+
+    it('includes optional NIP-11 fields when configured', () => {
+      createSettingsStub.returns({
+        ...baseSettings,
+        info: {
+          ...baseSettings.info,
+          banner: 'https://relay.example.com/banner.png',
+          icon: 'https://relay.example.com/icon.png',
+          self: 'f'.repeat(64),
+          terms_of_service: 'https://relay.example.com/terms',
+        },
+      })
+
+      rootRequestHandler(req, res, next)
+
+      const doc = res.send.firstCall.args[0]
+      expect(doc.banner).to.equal('https://relay.example.com/banner.png')
+      expect(doc.icon).to.equal('https://relay.example.com/icon.png')
+      expect(doc.self).to.equal('f'.repeat(64))
+      expect(doc.terms_of_service).to.equal('https://relay.example.com/terms')
+    })
   })
 
   describe('when serving HTML', () => {