@bsv/overlay-discovery-services 0.1.3 → 1.1.0

package/dist/cjs/mod.js

@@ -20,9 +20,9 @@ __exportStar(require("./src/SHIP/SHIPTopicManager.js"), exports);
 __exportStar(require("./src/SLAP/SLAPLookupService.js"), exports);
 __exportStar(require("./src/SLAP/SLAPStorage.js"), exports);
 __exportStar(require("./src/SLAP/SLAPTopicManager.js"), exports);
-__exportStar(require("./src/LegacyNinjaAdvertiser.js"), exports);
-__exportStar(require("./src/utils/isValidDomain.js"), exports);
-__exportStar(require("./src/utils/isValidServiceName.js"), exports);
-__exportStar(require("./src/utils/verifyToken.js"), exports);
+__exportStar(require("./src/WalletAdvertiser.js"), exports);
+__exportStar(require("./src/utils/isAdvertisableURI.js"), exports);
+__exportStar(require("./src/utils/isValidTopicOrServiceName.js"), exports);
+__exportStar(require("./src/utils/isTokenSignatureCorrectlyLinked.js"), exports);
 __exportStar(require("./src/types.js"), exports);
 //# sourceMappingURL=mod.js.map

package/dist/cjs/mod.js.map

@@ -1 +1 @@
-{"version":3,"file":"mod.js","sourceRoot":"","sources":["../../mod.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,kEAA+C;AAC/C,4DAAyC;AACzC,iEAA8C;AAE9C,kEAA+C;AAC/C,4DAAyC;AACzC,iEAA8C;AAE9C,iEAA8C;AAE9C,+DAA4C;AAC5C,oEAAiD;AACjD,6DAA0C;AAE1C,iDAA8B"}
+{"version":3,"file":"mod.js","sourceRoot":"","sources":["../../mod.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,kEAA+C;AAC/C,4DAAyC;AACzC,iEAA8C;AAE9C,kEAA+C;AAC/C,4DAAyC;AACzC,iEAA8C;AAE9C,4DAAyC;AAEzC,mEAAgD;AAChD,2EAAwD;AACxD,iFAA8D;AAE9D,iDAA8B"}

package/dist/cjs/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bsv/overlay-discovery-services",
-  "version": "0.1.2",
+  "version": "1.1.0",
   "type": "commonjs",
   "description": "BSV Blockchain Overlay Services Engine",
   "files": [
@@ -18,8 +18,7 @@
     "build": "tsc -b && tsconfig-to-dual-package tsconfig.cjs.json",
     "dev": "tsc -b -w",
     "prepublish": "npm run build",
-    "doc": "ts2md --inputFilename=mod.ts --outputFilename=API.md --filenameSubstring=API --firstHeadingLevel=1",
-    "generate-service-docs": "node ./dist/cjs/src/utils/generateDocs.js"
+    "doc": "ts2md --inputFilename=mod.ts --outputFilename=API.md --filenameSubstring=API --firstHeadingLevel=1"
   },
   "repository": {
     "type": "git",
@@ -48,12 +47,9 @@
     "typescript": "^5.2.2"
   },
   "dependencies": {
-    "@bsv/overlay": "^0.1.15",
-    "@bsv/sdk": "^1.2.3",
-    "mongodb": "^6.11.0",
-    "ninja-base": "0.3.46",
-    "pushdrop": "^0.1.64",
-    "sendover": "^1.3.27",
-    "uhrp-url": "^0.1.10"
+    "@bsv/overlay": "^0.1.23",
+    "@bsv/sdk": "^1.3.24",
+    "@bsv/wallet-toolbox-client": "^1.1.30",
+    "mongodb": "^6.11.0"
   }
 }

package/dist/cjs/src/SHIP/SHIPLookup.docs.js

@@ -0,0 +1,103 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = `# SHIP Lookup Service
+
+**Protocol Name**: SHIP (Service Host Interconnect Protocol)  
+**Lookup Service Name**: \`SHIPLookupService\`  
+
+---
+
+## Overview
+
+The SHIP Lookup Service is used to **query** the known SHIP tokens in your overlay database. It allows you to discover nodes that have published SHIP outputs, indicating they host or participate in certain topics (prefixed \`tm_\`).
+
+This lookup service is typically invoked by sending a [LookupQuestion](https://www.npmjs.com/package/@bsv/overlay#lookupservice) with:
+- \`question.service = 'ls_ship'\`
+- \`question.query\` containing parameters for searching.
+
+---
+
+## Purpose
+
+- **Discovery**: Find all hosts that declared themselves via SHIP tokens.
+- **Filtering**: Narrow results by domain, by topic, or both.
+
+---
+
+## Querying the SHIP Lookup Service
+
+When you call \`lookup(question)\` on the SHIP Lookup Service, you must include:
+
+1. **\`question.service\`** set to \`"ls_ship"\`.
+2. **\`question.query\`**: Can be one of the following:
+   - \`"findAll"\` (string literal): Returns **all** known SHIP records.
+   - An object of type:
+     \`\`\`ts
+     interface SHIPQuery {
+       domain?: string
+       topics?: string[]
+     }
+     \`\`\`
+     where:
+     - \`domain\` is an optional string. If provided, results will match that domain/advertisedURI.
+     - \`topics\` is an optional string array. If provided, results will match any of those \`tm_\` topics.
+
+### Examples
+
+1. **Find all SHIP records**:
+   \`\`\`js
+   const question = {
+     service: 'ls_ship',
+     query: 'findAll'
+   }
+   const results = await overlayClient.lookup(question)
+   \`\`\`
+
+2. **Find by domain**:
+   \`\`\`js
+   const question = {
+     service: 'ls_ship',
+     query: { domain: 'https://myexample.com' }
+   }
+   const results = await overlayClient.lookup(question)
+   \`\`\`
+
+3. **Find by topics**:
+   \`\`\`js
+   const question = {
+     service: 'ls_ship',
+     query: { topics: ['tm_bridge', 'tm_sync'] }
+   }
+   const results = await overlayClient.lookup(question)
+   \`\`\`
+
+4. **Find by domain AND topics**:
+   \`\`\`js
+   const question = {
+     service: 'ls_ship',
+     query: {
+       domain: 'https://myexample.com',
+       topics: ['tm_bridge']
+     }
+   }
+   const results = await overlayClient.lookup(question)
+   \`\`\`
+
+---
+
+## Gotchas and Tips
+
+- **Topic Prefix**: The SHIP manager expects topics to start with \`tm_\`. If you see no results, ensure you used the correct prefix.
+- **Strict Matching**: Domain matching requires an exact string match. If you have a different protocol (https vs https+bsvauth vs https+bsvauth+smf), be sure to store/lookup accordingly.
+- **Partial Queries**: If you only provide \`topics\`, domain-based filtering is not applied, and vice versa.
+- **Multiple Topics**: Since \`topics\` is an array, the storage will return all records matching **any** listed topic.
+
+---
+
+## Further Reading
+
+- **SHIPTopicManager**: For how the outputs are admitted.
+- **BRC-101 Overlays**: The general pattern for these sorts of services.
+- **SLAP**: The complementary protocol for service lookup availability ads.
+`;
+//# sourceMappingURL=SHIPLookup.docs.js.map

package/dist/cjs/src/SHIP/SHIPLookup.docs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SHIPLookup.docs.js","sourceRoot":"","sources":["../../../../src/SHIP/SHIPLookup.docs.ts"],"names":[],"mappings":";;AAAA,kBAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAmGd,CAAA"}

package/dist/cjs/src/SHIP/SHIPLookupService.js

@@ -4,8 +4,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SHIPLookupService = void 0;
-const pushdrop_1 = __importDefault(require("pushdrop"));
-const getDocumentation_js_1 = require("../utils/getDocumentation.js");
+const sdk_1 = require("@bsv/sdk");
+const SHIPLookup_docs_js_1 = __importDefault(require("./SHIPLookup.docs.js"));
 /**
  * Implements the SHIP lookup service
  *
@@ -26,14 +26,11 @@ class SHIPLookupService {
     async outputAdded(txid, outputIndex, outputScript, topic) {
         if (topic !== 'tm_ship')
             return;
-        const result = pushdrop_1.default.decode({
-            script: outputScript.toHex(),
-            fieldFormat: 'buffer'
-        });
-        const shipIdentifier = result.fields[0].toString();
-        const identityKey = result.fields[1].toString('hex');
-        const domain = result.fields[2].toString();
-        const topicSupported = result.fields[3].toString();
+        const result = sdk_1.PushDrop.decode(outputScript);
+        const shipIdentifier = sdk_1.Utils.toUTF8(result.fields[0]);
+        const identityKey = sdk_1.Utils.toHex(result.fields[1]);
+        const domain = sdk_1.Utils.toUTF8(result.fields[2]);
+        const topicSupported = sdk_1.Utils.toUTF8(result.fields[3]);
         if (shipIdentifier !== 'SHIP')
             return;
         await this.storage.storeSHIPRecord(txid, outputIndex, identityKey, domain, topicSupported);
@@ -99,7 +96,7 @@ class SHIPLookupService {
      * @returns A promise that resolves to the documentation string.
      */
     async getDocumentation() {
-        return await (0, getDocumentation_js_1.getDocumentation)('./docs/SHIP/ship-lookup-service.md');
+        return SHIPLookup_docs_js_1.default;
     }
     /**
      * Returns metadata associated with this lookup service.

package/dist/cjs/src/SHIP/SHIPLookupService.js.map

@@ -1 +1 @@
-{"version":3,"file":"SHIPLookupService.js","sourceRoot":"","sources":["../../../../src/SHIP/SHIPLookupService.ts"],"names":[],"mappings":";;;;;;AAGA,wDAA+B;AAE/B,sEAA+D;AAE/D;;;;;GAKG;AACH,MAAa,iBAAiB;IAC5B,YAAmB,OAAoB;QAApB,YAAO,GAAP,OAAO,CAAa;IAAI,CAAC;IAE5C;;;;;;OAMG;IACH,KAAK,CAAC,WAAW,CAAE,IAAY,EAAE,WAAmB,EAAE,YAAoB,EAAE,KAAa;QACvF,IAAI,KAAK,KAAK,SAAS;YAAE,OAAM;QAE/B,MAAM,MAAM,GAAG,kBAAQ,CAAC,MAAM,CAAC;YAC7B,MAAM,EAAE,YAAY,CAAC,KAAK,EAAE;YAC5B,WAAW,EAAE,QAAQ;SACtB,CAAC,CAAA;QAEF,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAA;QAClD,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAA;QACpD,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAA;QAC1C,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAA;QAClD,IAAI,cAAc,KAAK,MAAM;YAAE,OAAM;QAErC,MAAM,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,IAAI,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,EAAE,cAAc,CAAC,CAAA;IAC5F,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,WAAW,CAAE,IAAY,EAAE,WAAmB,EAAE,KAAa;QACjE,IAAI,KAAK,KAAK,SAAS;YAAE,OAAM;QAC/B,MAAM,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,IAAI,EAAE,WAAW,CAAC,CAAA;IACxD,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,aAAa,CAAE,IAAY,EAAE,WAAmB,EAAE,KAAa;QACnE,IAAI,KAAK,KAAK,SAAS;YAAE,OAAM;QAC/B,MAAM,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,IAAI,EAAE,WAAW,CAAC,CAAA;IACxD,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,MAAM,CAAC,QAAwB;QACnC,IAAI,QAAQ,CAAC,KAAK,KAAK,SAAS,IAAI,QAAQ,CAAC,KAAK,KAAK,IAAI,EAAE,CAAC;YAC5D,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAA;QACpD,CAAC;QACD,IAAI,QAAQ,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YACnC,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAA;QAClD,CAAC;QAED,IAAI,QAAQ,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;YACjC,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAA;QACrC,CAAC;QAED,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,QAAQ,CAAC,KAAkB,CAAA;QAEtD,wBAAwB;QACxB,IAAI,MAAM,KAAK,SAAS,IAAI,MAAM,KAAK,IAAI,IAAI,MAAM,KAAK,SAAS,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;YACvF,qEAAqE;YACrE,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAA;YACjE,OAAO,OAAO,CAAA;QAChB,CAAC;aAAM,IAAI,MAAM,KAAK,SAAS,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;YACnD,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC,CAAA;YACzD,OAAO,OAAO,CAAA;QAChB,CAAC;aAAM,IAAI,MAAM,KAAK,SAAS,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;YACnD,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC,CAAA;YACzD,OAAO,OAAO,CAAA;QAChB,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,wDAAwD,CAAC,CAAA;QAC3E,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,gBAAgB;QACpB,OAAO,MAAM,IAAA,sCAAgB,EAAC,oCAAoC,CAAC,CAAA;IACrE,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,WAAW;QAOf,OAAO;YACL,IAAI,EAAE,qBAAqB;YAC3B,gBAAgB,EAAE,+CAA+C;SAClE,CAAA;IACH,CAAC;CACF;AA5GD,8CA4GC"}
+{"version":3,"file":"SHIPLookupService.js","sourceRoot":"","sources":["../../../../src/SHIP/SHIPLookupService.ts"],"names":[],"mappings":";;;;;;AAEA,kCAAkD;AAElD,8EAAiD;AAEjD;;;;;GAKG;AACH,MAAa,iBAAiB;IAC5B,YAAmB,OAAoB;QAApB,YAAO,GAAP,OAAO,CAAa;IAAI,CAAC;IAE5C;;;;;;OAMG;IACH,KAAK,CAAC,WAAW,CAAE,IAAY,EAAE,WAAmB,EAAE,YAAoB,EAAE,KAAa;QACvF,IAAI,KAAK,KAAK,SAAS;YAAE,OAAM;QAC/B,MAAM,MAAM,GAAG,cAAQ,CAAC,MAAM,CAAC,YAAY,CAAC,CAAA;QAC5C,MAAM,cAAc,GAAG,WAAK,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAA;QACrD,MAAM,WAAW,GAAG,WAAK,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAA;QACjD,MAAM,MAAM,GAAG,WAAK,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAA;QAC7C,MAAM,cAAc,GAAG,WAAK,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAA;QACrD,IAAI,cAAc,KAAK,MAAM;YAAE,OAAM;QACrC,MAAM,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,IAAI,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,EAAE,cAAc,CAAC,CAAA;IAC5F,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,WAAW,CAAE,IAAY,EAAE,WAAmB,EAAE,KAAa;QACjE,IAAI,KAAK,KAAK,SAAS;YAAE,OAAM;QAC/B,MAAM,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,IAAI,EAAE,WAAW,CAAC,CAAA;IACxD,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,aAAa,CAAE,IAAY,EAAE,WAAmB,EAAE,KAAa;QACnE,IAAI,KAAK,KAAK,SAAS;YAAE,OAAM;QAC/B,MAAM,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,IAAI,EAAE,WAAW,CAAC,CAAA;IACxD,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,MAAM,CAAC,QAAwB;QACnC,IAAI,QAAQ,CAAC,KAAK,KAAK,SAAS,IAAI,QAAQ,CAAC,KAAK,KAAK,IAAI,EAAE,CAAC;YAC5D,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAA;QACpD,CAAC;QACD,IAAI,QAAQ,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YACnC,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAA;QAClD,CAAC;QAED,IAAI,QAAQ,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;YACjC,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAA;QACrC,CAAC;QAED,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,QAAQ,CAAC,KAAkB,CAAA;QAEtD,wBAAwB;QACxB,IAAI,MAAM,KAAK,SAAS,IAAI,MAAM,KAAK,IAAI,IAAI,MAAM,KAAK,SAAS,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;YACvF,qEAAqE;YACrE,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAA;YACjE,OAAO,OAAO,CAAA;QAChB,CAAC;aAAM,IAAI,MAAM,KAAK,SAAS,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;YACnD,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC,CAAA;YACzD,OAAO,OAAO,CAAA;QAChB,CAAC;aAAM,IAAI,MAAM,KAAK,SAAS,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;YACnD,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC,CAAA;YACzD,OAAO,OAAO,CAAA;QAChB,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,wDAAwD,CAAC,CAAA;QAC3E,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,gBAAgB;QACpB,OAAO,4BAAc,CAAA;IACvB,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,WAAW;QAOf,OAAO;YACL,IAAI,EAAE,qBAAqB;YAC3B,gBAAgB,EAAE,+CAA+C;SAClE,CAAA;IACH,CAAC;CACF;AAtGD,8CAsGC"}

package/dist/cjs/src/SHIP/SHIPTopic.docs.js

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = `# SHIP Topic Manager
+
+**Protocol Name**: SHIP (Service Host Interconnect Protocol)  
+**Manager Name**: \`SHIPTopicManager\`  
+
+---
+
+## Overview
+
+The SHIP Topic Manager is responsible for identifying _admissible outputs_ in transactions that declare themselves as part of the SHIP protocol. In other words, it looks at transaction outputs (UTXOs) that embed certain metadata via a [PushDrop](https://www.npmjs.com/package/@bsv/sdk#pushdrop) locking script. This metadata must meet SHIP-specific requirements so that your node or application can recognize valid SHIP advertisements.
+
+A **SHIP token** (in the context of BRC-101 overlays) is a UTXO containing information that advertises a node or host providing some topic-based service to the network. That topic must be prefixed with \`tm_\` — short for "topic manager."
+
+---
+
+## Purpose
+
+- **Announce**: The SHIP token is used to signal that "this identity key is hosting a certain topic (prefixed with \`tm_\`)."
+- **Connect**: By publishing a SHIP output, a node indicates it offers some service or is a participant in a specific overlay "topic."
+- **Authorize**: The SHIP token includes a signature which binds it to an identity key, ensuring authenticity and preventing impersonation.
+
+This allows other nodes to discover hosts by querying the lookup service for valid SHIP tokens.
+
+---
+
+## Requirements for a Valid SHIP Output
+
+1. **PushDrop Fields**: Exactly five fields must be present:
+   1. \`"SHIP"\` — The protocol identifier string.
+   2. \`identityKey\` — The 33-byte compressed DER secp256k1 public key that claims to own this UTXO.
+   3. \`advertisedURI\` — A URI string describing how or where to connect (see BRC-101).
+   4. \`topic\` — A string that identifies the topic. Must:
+      - Start with \`tm_\`
+      - Pass the BRC-87 checks
+   5. \`signature\` — A valid signature (in DER) proving that \`identityKey\` is authorizing this output, in conjunction with the PushDrop locking key.
+
+2. **Signature Verification**:  
+   - The signature in the last field must be valid for the data in the first 4 fields.
+   - It must match the identity key, which in turn must match the locking public key used in the output script.  
+   - See the code in \`isTokenSignatureCorrectlyLinked\` for the implementation details.
+
+3. **Advertised URI**:  
+   - Must align with what is contemplated in BRC-101, which enforces certain URI formats (e.g., \`https://\`, \`wss://\`, or custom prefixed \`https+bsvauth...\` URIs).
+   - No \`localhost\` or invalid URIs allowed.
+
+If any of these checks fail, the SHIP token output is _not_ admitted by the topic manager.
+
+---
+
+## Gotchas and Tips
+
+- **Field Ordering**: The fields **must** appear in the exact order specified above (SHIP -> identityKey -> advertisedURI -> topic -> signature).
+- **Exact Five Fields**: More or fewer fields will cause the manager to skip the output.
+- **Proper Locking Script**: Ensure the output is locked with a valid [PushDrop](https://www.npmjs.com/package/@bsv/sdk#pushdrop) format. If the \`lockingScript\` can’t be decoded by \`PushDrop\`, the output is invalid.
+- **Signature Data**: The signature is a raw ECDSA signature over the raw bytes of the preceding fields. The manager expects that the identity key and signature match up with the logic in \`isTokenSignatureCorrectlyLinked\`.
+- **Funding**: Remember to fund your SHIP output with at least one satoshi so it remains unspent if you want your advertisement to be valid.
+`;
+//# sourceMappingURL=SHIPTopic.docs.js.map

package/dist/cjs/src/SHIP/SHIPTopic.docs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SHIPTopic.docs.js","sourceRoot":"","sources":["../../../../src/SHIP/SHIPTopic.docs.ts"],"names":[],"mappings":";;AAAA,kBAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAwDd,CAAA"}

package/dist/cjs/src/SHIP/SHIPTopicManager.js

@@ -5,10 +5,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SHIPTopicManager = void 0;
 const sdk_1 = require("@bsv/sdk");
-const pushdrop_1 = __importDefault(require("pushdrop"));
-const verifyToken_js_1 = require("../utils/verifyToken.js");
-const isValidDomain_js_1 = require("../utils/isValidDomain.js");
-const getDocumentation_js_1 = require("../utils/getDocumentation.js");
+const isTokenSignatureCorrectlyLinked_js_1 = require("../utils/isTokenSignatureCorrectlyLinked.js");
+const isAdvertisableURI_js_1 = require("../utils/isAdvertisableURI.js");
+const SHIPTopic_docs_js_1 = __importDefault(require("./SHIPTopic.docs.js"));
+const isValidTopicOrServiceName_js_1 = require("../utils/isValidTopicOrServiceName.js");
 /**
  * 🚢 SHIP Topic Manager
  * Implements the TopicManager interface for SHIP (Service Host Interconnect Protocol) tokens.
@@ -29,24 +29,22 @@ class SHIPTopicManager {
             const parsedTransaction = sdk_1.Transaction.fromBEEF(beef);
             for (const [i, output] of parsedTransaction.outputs.entries()) {
                 try {
-                    const result = pushdrop_1.default.decode({
-                        script: output.lockingScript.toHex(),
-                        fieldFormat: 'buffer'
-                    });
-                    if (result.fields.length !== 4)
-                        continue; // SHIP tokens should have 4 fields
-                    const shipIdentifier = result.fields[0].toString();
-                    const identityKey = result.fields[1].toString('hex');
-                    const domain = result.fields[2].toString();
-                    // const topic = result.fields[3].toString()
+                    const result = sdk_1.PushDrop.decode(output.lockingScript);
+                    if (result.fields.length !== 5)
+                        continue; // SHIP tokens have 5 fields
+                    const shipIdentifier = sdk_1.Utils.toUTF8(result.fields[0]);
                     if (shipIdentifier !== 'SHIP')
-                        continue;
-                    // Validate domain
-                    if (!(0, isValidDomain_js_1.isValidDomain)(domain))
-                        continue;
-                    // Additional validations can be added here
-                    // Verify the token locking key and signature
-                    (0, verifyToken_js_1.verifyToken)(identityKey, result.lockingPublicKey, result.fields, result.signature);
+                        continue; // SHIP identifier must be present
+                    const advertisedURI = sdk_1.Utils.toUTF8(result.fields[2]);
+                    if (!(0, isAdvertisableURI_js_1.isAdvertisableURI)(advertisedURI))
+                        continue; // Advertised URI must be acceptable
+                    const topic = sdk_1.Utils.toUTF8(result.fields[3]);
+                    if (!(0, isValidTopicOrServiceName_js_1.isValidTopicOrServiceName)(topic))
+                        continue; // Topic or service name must be valid
+                    if (!topic.startsWith('tm_'))
+                        continue; // SHIP only accepts "tm_" (topic manager) advertisements
+                    if (!(0, isTokenSignatureCorrectlyLinked_js_1.isTokenSignatureCorrectlyLinked)(result.lockingPublicKey, result.fields))
+                        continue; // Signatures must be properly linked
                     outputsToAdmit.push(i);
                 }
                 catch (error) {
@@ -80,7 +78,7 @@ class SHIPTopicManager {
      * @returns A promise that resolves to the documentation string.
      */
     async getDocumentation() {
-        return await (0, getDocumentation_js_1.getDocumentation)('./docs/SHIP/ship-lookup-service.md');
+        return SHIPTopic_docs_js_1.default;
     }
     /**
      * Returns metadata associated with this topic manager.

package/dist/cjs/src/SHIP/SHIPTopicManager.js.map

@@ -1 +1 @@
-{"version":3,"file":"SHIPTopicManager.js","sourceRoot":"","sources":["../../../../src/SHIP/SHIPTopicManager.ts"],"names":[],"mappings":";;;;;;AACA,kCAAsC;AACtC,wDAA+B;AAC/B,4DAAqD;AACrD,gEAAyD;AACzD,sEAA+D;AAE/D;;;;;;GAMG;AACH,MAAa,gBAAgB;IAC3B;;;;;OAKG;IACH,KAAK,CAAC,yBAAyB,CAAC,IAAc,EAAE,aAAuB;QACrE,MAAM,cAAc,GAAa,EAAE,CAAA;QACnC,IAAI,CAAC;YACH,MAAM,iBAAiB,GAAG,iBAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAA;YAEpD,KAAK,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,IAAI,iBAAiB,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC;gBAC9D,IAAI,CAAC;oBACH,MAAM,MAAM,GAAG,kBAAQ,CAAC,MAAM,CAAC;wBAC7B,MAAM,EAAE,MAAM,CAAC,aAAa,CAAC,KAAK,EAAE;wBACpC,WAAW,EAAE,QAAQ;qBACtB,CAAC,CAAA;oBAEF,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC;wBAAE,SAAQ,CAAC,mCAAmC;oBAE5E,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAA;oBAClD,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAA;oBACpD,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAA;oBAC1C,4CAA4C;oBAE5C,IAAI,cAAc,KAAK,MAAM;wBAAE,SAAQ;oBAEvC,kBAAkB;oBAClB,IAAI,CAAC,IAAA,gCAAa,EAAC,MAAM,CAAC;wBAAE,SAAQ;oBACpC,2CAA2C;oBAE3C,6CAA6C;oBAC7C,IAAA,4BAAW,EAAC,WAAW,EAAE,MAAM,CAAC,gBAAgB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,SAAS,CAAC,CAAA;oBAElF,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;gBACxB,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACf,4EAA4E;oBAC5E,SAAQ;gBACV,CAAC;YACH,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,+EAA+E;YAC/E,IAAI,cAAc,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,CAAC,aAAa,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,CAAC,EAAE,CAAC;gBAClF,OAAO,CAAC,KAAK,CAAC,0CAA0C,EAAE,KAAK,CAAC,CAAA;YAClE,CAAC;QACH,CAAC;QAED,IAAI,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC9B,OAAO,CAAC,GAAG,CAAC,sBAAsB,cAAc,CAAC,MAAM,SAAS,cAAc,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,GAAG,CAAC,CAAA;QACxH,CAAC;QAED,IAAI,aAAa,IAAI,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC9C,OAAO,CAAC,GAAG,CAAC,eAAe,aAAa,CAAC,MAAM,kBAAkB,aAAa,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,GAAG,CAAC,CAAA;QACpH,CAAC;QAED,IAAI,cAAc,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,CAAC,aAAa,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,CAAC,EAAE,CAAC;YAClF,OAAO,CAAC,IAAI,CAAC,iEAAiE,CAAC,CAAA;QACjF,CAAC;QAED,OAAO;YACL,cAAc;YACd,aAAa,EAAE,EAAE;SAClB,CAAA;IACH,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,gBAAgB;QACpB,OAAO,MAAM,IAAA,sCAAgB,EAAC,oCAAoC,CAAC,CAAA;IACrE,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,WAAW;QAOf,OAAO;YACL,IAAI,EAAE,oBAAoB;YAC1B,gBAAgB,EAAE,oDAAoD;SACvE,CAAA;IACH,CAAC;CACF;AA1FD,4CA0FC"}
+{"version":3,"file":"SHIPTopicManager.js","sourceRoot":"","sources":["../../../../src/SHIP/SHIPTopicManager.ts"],"names":[],"mappings":";;;;;;AACA,kCAAuD;AACvD,oGAA6F;AAC7F,wEAAiE;AACjE,4EAA+C;AAC/C,wFAAiF;AAEjF;;;;;;GAMG;AACH,MAAa,gBAAgB;IAC3B;;;;;OAKG;IACH,KAAK,CAAC,yBAAyB,CAAC,IAAc,EAAE,aAAuB;QACrE,MAAM,cAAc,GAAa,EAAE,CAAA;QACnC,IAAI,CAAC;YACH,MAAM,iBAAiB,GAAG,iBAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAA;YAEpD,KAAK,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,IAAI,iBAAiB,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC;gBAC9D,IAAI,CAAC;oBACH,MAAM,MAAM,GAAG,cAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAA;oBACpD,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC;wBAAE,SAAQ,CAAC,4BAA4B;oBAErE,MAAM,cAAc,GAAG,WAAK,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAA;oBACrD,IAAI,cAAc,KAAK,MAAM;wBAAE,SAAQ,CAAC,kCAAkC;oBAE1E,MAAM,aAAa,GAAG,WAAK,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAA;oBACpD,IAAI,CAAC,IAAA,wCAAiB,EAAC,aAAa,CAAC;wBAAE,SAAQ,CAAC,oCAAoC;oBAEpF,MAAM,KAAK,GAAG,WAAK,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAA;oBAC5C,IAAI,CAAC,IAAA,wDAAyB,EAAC,KAAK,CAAC;wBAAE,SAAQ,CAAC,sCAAsC;oBACtF,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,KAAK,CAAC;wBAAE,SAAQ,CAAC,yDAAyD;oBAChG,IAAI,CAAC,IAAA,oEAA+B,EAAC,MAAM,CAAC,gBAAgB,EAAE,MAAM,CAAC,MAAM,CAAC;wBAAE,SAAQ,CAAC,qCAAqC;oBAE5H,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;gBACxB,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACf,4EAA4E;oBAC5E,SAAQ;gBACV,CAAC;YACH,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,+EAA+E;YAC/E,IAAI,cAAc,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,CAAC,aAAa,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,CAAC,EAAE,CAAC;gBAClF,OAAO,CAAC,KAAK,CAAC,0CAA0C,EAAE,KAAK,CAAC,CAAA;YAClE,CAAC;QACH,CAAC;QAED,IAAI,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC9B,OAAO,CAAC,GAAG,CAAC,sBAAsB,cAAc,CAAC,MAAM,SAAS,cAAc,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,GAAG,CAAC,CAAA;QACxH,CAAC;QAED,IAAI,aAAa,IAAI,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC9C,OAAO,CAAC,GAAG,CAAC,eAAe,aAAa,CAAC,MAAM,kBAAkB,aAAa,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,GAAG,CAAC,CAAA;QACpH,CAAC;QAED,IAAI,cAAc,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,CAAC,aAAa,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,CAAC,EAAE,CAAC;YAClF,OAAO,CAAC,IAAI,CAAC,iEAAiE,CAAC,CAAA;QACjF,CAAC;QAED,OAAO;YACL,cAAc;YACd,aAAa,EAAE,EAAE;SAClB,CAAA;IACH,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,gBAAgB;QACpB,OAAO,2BAAa,CAAA;IACtB,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,WAAW;QAOf,OAAO;YACL,IAAI,EAAE,oBAAoB;YAC1B,gBAAgB,EAAE,oDAAoD;SACvE,CAAA;IACH,CAAC;CACF;AAnFD,4CAmFC"}

package/dist/cjs/src/SLAP/SLAPLookup.docs.js

@@ -0,0 +1,97 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = `# SLAP Lookup Service
+
+**Protocol Name**: SLAP (Service Lookup Availability Protocol)  
+**Lookup Service Name**: \`SLAPLookupService\`
+
+---
+
+## Overview
+
+The SLAP Lookup Service is an overlay component that answers queries about SLAP advertisements. A SLAP advertisement states that an identity key offers a service (prefixed \`ls_\`) at a given URI. By querying this service, you can find all known SLAP records that match your criteria.
+
+---
+
+## Purpose
+
+- **Discovery**: Find all services that have been advertised with the \`SLAP\` protocol.
+- **Filtering**: Narrow results by domain or by the \`ls_\` service name.
+
+---
+
+## How to Query the SLAP Lookup Service
+
+You will typically provide a [LookupQuestion](https://www.npmjs.com/package/@bsv/overlay#lookupservice) object to the \`lookup\` method with:
+- \`question.service = 'ls_slap'\`
+- \`question.query\` describing the domain and/or service name you want.
+
+### \`question.query\` Options
+
+1. **\`"findAll"\`** (string literal): Returns every SLAP record in the database.
+2. **\`SLAPQuery\` object**:
+   \`\`\`ts
+   interface SLAPQuery {
+     domain?: string
+     service?: string
+   }
+   \`\`\`
+   - \`domain\`: Optional. If provided, only returns records whose \`advertisedURI\` matches this domain.
+   - \`service\`: Optional. Must be a string starting with \`ls_\`.
+
+### Example Usages
+
+1. **Find all**:
+   \`\`\`js
+   const question = {
+     service: 'ls_slap',
+     query: 'findAll'
+   }
+   const answers = await overlayClient.lookup(question)
+   \`\`\`
+
+2. **Find by domain**:
+   \`\`\`js
+   const question = {
+     service: 'ls_slap',
+     query: { domain: 'https://mylookup.example' }
+   }
+   const answers = await overlayClient.lookup(question)
+   \`\`\`
+
+3. **Find by service (most common)**:
+   \`\`\`js
+   const question = {
+     service: 'ls_slap',
+     query: { service: 'ls_treasury' }
+   }
+   const answers = await overlayClient.lookup(question)
+   \`\`\`
+
+4. **Find by domain & service**:
+   \`\`\`js
+   const question = {
+     service: 'ls_slap',
+     query: {
+       domain: 'https://mylookup.example',
+       service: 'ls_treasury'
+     }
+   }
+   const answers = await overlayClient.lookup(question)
+   \`\`\`
+
+---
+
+## Gotchas
+
+- **Strict Matching**: Domain matching requires an exact string match. If you have a different protocol (https vs https+bsvauth vs https+bsvauth+smf), be sure to store/lookup accordingly.
+- **Must Start with \`ls_\`**: The \`service\` field in the original SLAP advertisement must begin with \`ls_\`. If you query for something that doesn’t match exactly, you may get zero results.
+
+---
+
+## Further Reading
+
+- **SLAPTopicManager**: Learn how SLAP outputs are detected and admitted.
+- **BRC-101 Overlays**: The higher-level specification for modular overlay availability schemes.
+`;
+//# sourceMappingURL=SLAPLookup.docs.js.map

package/dist/cjs/src/SLAP/SLAPLookup.docs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SLAPLookup.docs.js","sourceRoot":"","sources":["../../../../src/SLAP/SLAPLookup.docs.ts"],"names":[],"mappings":";;AAAA,kBAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA6Fd,CAAA"}

package/dist/cjs/src/SLAP/SLAPLookupService.js

@@ -4,8 +4,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SLAPLookupService = void 0;
-const pushdrop_1 = __importDefault(require("pushdrop"));
-const getDocumentation_js_1 = require("../utils/getDocumentation.js");
+const sdk_1 = require("@bsv/sdk");
+const SLAPLookup_docs_js_1 = __importDefault(require("./SLAPLookup.docs.js"));
 /**
  * Implements the SLAP lookup service
  *
@@ -27,14 +27,11 @@ class SLAPLookupService {
     async outputAdded(txid, outputIndex, outputScript, topic) {
         if (topic !== 'tm_slap')
             return;
-        const result = pushdrop_1.default.decode({
-            script: outputScript.toHex(),
-            fieldFormat: 'buffer'
-        });
-        const protocol = result.fields[0].toString();
-        const identityKey = result.fields[1].toString('hex');
-        const domain = result.fields[2].toString();
-        const service = result.fields[3].toString();
+        const result = sdk_1.PushDrop.decode(outputScript);
+        const protocol = sdk_1.Utils.toUTF8(result.fields[0]);
+        const identityKey = sdk_1.Utils.toHex(result.fields[1]);
+        const domain = sdk_1.Utils.toUTF8(result.fields[2]);
+        const service = sdk_1.Utils.toUTF8(result.fields[3]);
         if (protocol !== 'SLAP')
             return;
         await this.storage.storeSLAPRecord(txid, outputIndex, identityKey, domain, service);
@@ -97,7 +94,7 @@ class SLAPLookupService {
      * @returns A promise that resolves to the documentation string.
      */
     async getDocumentation() {
-        return await (0, getDocumentation_js_1.getDocumentation)('./docs/SLAP/slap-lookup-service.md');
+        return SLAPLookup_docs_js_1.default;
     }
     /**
      * Returns metadata associated with this lookup service.

package/dist/cjs/src/SLAP/SLAPLookupService.js.map

@@ -1 +1 @@
-{"version":3,"file":"SLAPLookupService.js","sourceRoot":"","sources":["../../../../src/SLAP/SLAPLookupService.ts"],"names":[],"mappings":";;;;;;AAGA,wDAA+B;AAE/B,sEAA+D;AAE/D;;;;;;GAMG;AACH,MAAa,iBAAiB;IAC5B,YAAmB,OAAoB;QAApB,YAAO,GAAP,OAAO,CAAa;IAAI,CAAC;IAE5C;;;;;;OAMG;IACH,KAAK,CAAC,WAAW,CAAE,IAAY,EAAE,WAAmB,EAAE,YAAoB,EAAE,KAAa;QACvF,IAAI,KAAK,KAAK,SAAS;YAAE,OAAM;QAE/B,MAAM,MAAM,GAAG,kBAAQ,CAAC,MAAM,CAAC;YAC7B,MAAM,EAAE,YAAY,CAAC,KAAK,EAAE;YAC5B,WAAW,EAAE,QAAQ;SACtB,CAAC,CAAA;QAEF,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAA;QAC5C,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAA;QACpD,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAA;QAC1C,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAA;QAE3C,IAAI,QAAQ,KAAK,MAAM;YAAE,OAAM;QAE/B,MAAM,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,IAAI,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC,CAAA;IACrF,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,WAAW,CAAE,IAAY,EAAE,WAAmB,EAAE,KAAa;QACjE,IAAI,KAAK,KAAK,SAAS;YAAE,OAAM;QAC/B,MAAM,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,IAAI,EAAE,WAAW,CAAC,CAAA;IACxD,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,aAAa,CAAE,IAAY,EAAE,WAAmB,EAAE,KAAa;QACnE,IAAI,KAAK,KAAK,SAAS;YAAE,OAAM;QAC/B,MAAM,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,IAAI,EAAE,WAAW,CAAC,CAAA;IACxD,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,MAAM,CAAC,QAAwB;QACnC,IAAI,QAAQ,CAAC,KAAK,KAAK,SAAS,IAAI,QAAQ,CAAC,KAAK,KAAK,IAAI,EAAE,CAAC;YAC5D,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAA;QACpD,CAAC;QACD,IAAI,QAAQ,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YACnC,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAA;QAClD,CAAC;QAED,IAAI,QAAQ,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;YACjC,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAA;QACrC,CAAC;QAED,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,QAAQ,CAAC,KAAkB,CAAA;QAEvD,wBAAwB;QACxB,IAAI,MAAM,KAAK,SAAS,IAAI,MAAM,KAAK,IAAI,IAAI,OAAO,KAAK,SAAS,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;YACzF,uEAAuE;YACvE,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,CAAA;QAC3D,CAAC;aAAM,IAAI,MAAM,KAAK,SAAS,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;YACnD,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC,CAAA;QAClD,CAAC;aAAM,IAAI,OAAO,KAAK,SAAS,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;YACrD,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,OAAO,EAAE,CAAC,CAAA;QACnD,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,0DAA0D,CAAC,CAAA;QAC7E,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,gBAAgB;QACpB,OAAO,MAAM,IAAA,sCAAgB,EAAC,oCAAoC,CAAC,CAAA;IACrE,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,WAAW;QAOf,OAAO;YACL,IAAI,EAAE,qBAAqB;YAC3B,gBAAgB,EAAE,+CAA+C;SAClE,CAAA;IACH,CAAC;CACF;AA1GD,8CA0GC"}
+{"version":3,"file":"SLAPLookupService.js","sourceRoot":"","sources":["../../../../src/SLAP/SLAPLookupService.ts"],"names":[],"mappings":";;;;;;AAEA,kCAAkD;AAElD,8EAAiD;AAEjD;;;;;;GAMG;AACH,MAAa,iBAAiB;IAC5B,YAAmB,OAAoB;QAApB,YAAO,GAAP,OAAO,CAAa;IAAI,CAAC;IAE5C;;;;;;OAMG;IACH,KAAK,CAAC,WAAW,CAAE,IAAY,EAAE,WAAmB,EAAE,YAAoB,EAAE,KAAa;QACvF,IAAI,KAAK,KAAK,SAAS;YAAE,OAAM;QAC/B,MAAM,MAAM,GAAG,cAAQ,CAAC,MAAM,CAAC,YAAY,CAAC,CAAA;QAC5C,MAAM,QAAQ,GAAG,WAAK,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAA;QAC/C,MAAM,WAAW,GAAG,WAAK,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAA;QACjD,MAAM,MAAM,GAAG,WAAK,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAA;QAC7C,MAAM,OAAO,GAAG,WAAK,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAA;QAC9C,IAAI,QAAQ,KAAK,MAAM;YAAE,OAAM;QAC/B,MAAM,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,IAAI,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC,CAAA;IACrF,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,WAAW,CAAE,IAAY,EAAE,WAAmB,EAAE,KAAa;QACjE,IAAI,KAAK,KAAK,SAAS;YAAE,OAAM;QAC/B,MAAM,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,IAAI,EAAE,WAAW,CAAC,CAAA;IACxD,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,aAAa,CAAE,IAAY,EAAE,WAAmB,EAAE,KAAa;QACnE,IAAI,KAAK,KAAK,SAAS;YAAE,OAAM;QAC/B,MAAM,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,IAAI,EAAE,WAAW,CAAC,CAAA;IACxD,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,MAAM,CAAC,QAAwB;QACnC,IAAI,QAAQ,CAAC,KAAK,KAAK,SAAS,IAAI,QAAQ,CAAC,KAAK,KAAK,IAAI,EAAE,CAAC;YAC5D,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAA;QACpD,CAAC;QACD,IAAI,QAAQ,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YACnC,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAA;QAClD,CAAC;QAED,IAAI,QAAQ,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;YACjC,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAA;QACrC,CAAC;QAED,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,QAAQ,CAAC,KAAkB,CAAA;QAEvD,wBAAwB;QACxB,IAAI,MAAM,KAAK,SAAS,IAAI,MAAM,KAAK,IAAI,IAAI,OAAO,KAAK,SAAS,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;YACzF,uEAAuE;YACvE,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,CAAA;QAC3D,CAAC;aAAM,IAAI,MAAM,KAAK,SAAS,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;YACnD,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC,CAAA;QAClD,CAAC;aAAM,IAAI,OAAO,KAAK,SAAS,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;YACrD,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,OAAO,EAAE,CAAC,CAAA;QACnD,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,0DAA0D,CAAC,CAAA;QAC7E,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,gBAAgB;QACpB,OAAO,4BAAc,CAAA;IACvB,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,WAAW;QAOf,OAAO;YACL,IAAI,EAAE,qBAAqB;YAC3B,gBAAgB,EAAE,+CAA+C;SAClE,CAAA;IACH,CAAC;CACF;AAnGD,8CAmGC"}

package/dist/cjs/src/SLAP/SLAPTopic.docs.js

@@ -0,0 +1,69 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = `# SLAP Topic Manager
+
+**Protocol Name**: SLAP (Service Lookup Availability Protocol)  
+**Manager Name**: \`SLAPTopicManager\`  
+
+---
+
+## Overview
+
+The SLAP Topic Manager is responsible for identifying valid SLAP outputs in transactions. These outputs advertise the availability of a **lookup service** that can be accessed within an overlay network. By publishing a SLAP token, a node declares it is providing a specific service, prefixed \`ls_\`.
+
+---
+
+## Purpose
+
+- **Announce**: Declare that the identity key provides a certain lookup service, such as \`ls_example\` or other overlay lookups.
+- **Availability**: Indicate that the node or service is currently active and can be queried via the provided URI.
+
+---
+
+## Requirements for a Valid SLAP Output
+
+Similar to SHIP, SLAP tokens must follow a specific 5-field structure in a [PushDrop](https://www.npmjs.com/package/@bsv/sdk#pushdrop) script:
+
+1. \`"SLAP"\` — The literal string indicating SLAP protocol.
+2. \`identityKey\` — The public key that claims ownership of this advertisement.
+3. \`advertisedURI\` — A valid URI, aligning with what is contemplated in BRC-101.
+4. \`service\` — The name of the service. Must:
+   - Pass the BRC-87 checks.
+   - Start with \`ls_\`.
+5. \`signature\` — The ECDSA signature from \`identityKey\` covering the above 4 fields.
+
+---
+
+## Signature and Locking Key
+
+The final field is a signature that **must** link back to the identity key. The \`SLAPTopicManager\` uses the \`isTokenSignatureCorrectlyLinked\` code to confirm:
+
+- The signature is valid for the data in the first four fields.
+- The \`lockingPublicKey\` of the UTXO matches the derived key from the identity key used to sign.
+
+If any step fails, the SLAP output is rejected.
+
+---
+
+## Data Format and Validation
+
+1. **Exact 5 PushDrop Fields**:
+   - If fewer or more than 5 fields are found, the SLAP manager will skip the output.
+2. **Valid \`service\`**:
+   - Must begin with \`ls_\`.
+   - Only letters (lowercase) and underscores are allowed, per \`isValidTopicOrServiceName\` (BRC-87).
+3. **Advertised URI**:
+   - Must not be \`localhost\`.
+   - Must use a recognized scheme (\`https://\`, \`wss://\`, or specialized custom \`https+bsvauth...\` forms).
+4. **Signature**:
+   - Must be in DER format.
+   - Must match the identity key.
+
+---
+
+## Further Reading
+
+- **SLAPLookupService**: For how to query these records afterward.
+- **SHIP**: The complementary protocol for advertising "host-based" topics (\`tm_\`).
+`;
+//# sourceMappingURL=SLAPTopic.docs.js.map

package/dist/cjs/src/SLAP/SLAPTopic.docs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SLAPTopic.docs.js","sourceRoot":"","sources":["../../../../src/SLAP/SLAPTopic.docs.ts"],"names":[],"mappings":";;AAAA,kBAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAiEd,CAAA"}