@bsv/overlay-discovery-services 0.1.0

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

@@ -0,0 +1,116 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": 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");
+/**
+ * Implements the SHIP lookup service
+ *
+ * The SHIP lookup service allows querying for overlay services hosting specific topics
+ * within the overlay network.
+ */
+class SHIPLookupService {
+    constructor(storage) {
+        this.storage = storage;
+    }
+    /**
+     * Handles the addition of a new output to the topic.
+     * @param txid - The transaction ID containing the output.
+     * @param outputIndex - The index of the output in the transaction.
+     * @param outputScript - The script of the output to be processed.
+     * @param topic - The topic associated with the output.
+     */
+    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();
+        if (shipIdentifier !== 'SHIP')
+            return;
+        await this.storage.storeSHIPRecord(txid, outputIndex, identityKey, domain, topicSupported);
+    }
+    /**
+     * Handles the spending of an output in the topic.
+     * @param txid - The transaction ID of the spent output.
+     * @param outputIndex - The index of the spent output.
+     * @param topic - The topic associated with the spent output.
+     */
+    async outputSpent(txid, outputIndex, topic) {
+        if (topic !== 'tm_ship')
+            return;
+        await this.storage.deleteSHIPRecord(txid, outputIndex);
+    }
+    /**
+     * Handles the deletion of an output in the topic.
+     * @param txid - The transaction ID of the deleted output.
+     * @param outputIndex - The index of the deleted output.
+     * @param topic - The topic associated with the deleted output.
+     */
+    async outputDeleted(txid, outputIndex, topic) {
+        if (topic !== 'tm_ship')
+            return;
+        await this.storage.deleteSHIPRecord(txid, outputIndex);
+    }
+    /**
+     * Answers a lookup query.
+     * @param question - The lookup question to be answered.
+     * @returns A promise that resolves to a lookup answer or formula.
+     */
+    async lookup(question) {
+        if (question.query === undefined || question.query === null) {
+            throw new Error('A valid query must be provided!');
+        }
+        if (question.service !== 'ls_ship') {
+            throw new Error('Lookup service not supported!');
+        }
+        if (question.query === 'findAll') {
+            return await this.storage.findAll();
+        }
+        const { domain, topics } = question.query;
+        // Validate lookup query
+        if (domain !== undefined && domain !== null && topics !== undefined && topics !== null) {
+            // If both domain and topic are provided, construct a query with both
+            const records = await this.storage.findRecord({ domain, topics });
+            return records;
+        }
+        else if (domain !== undefined && domain !== null) {
+            const records = await this.storage.findRecord({ domain });
+            return records;
+        }
+        else if (topics !== undefined && topics !== null) {
+            const records = await this.storage.findRecord({ topics });
+            return records;
+        }
+        else {
+            throw new Error('A valid domain or topic must be provided in the query!');
+        }
+    }
+    /**
+     * Returns documentation specific to this overlay lookup service.
+     * @returns A promise that resolves to the documentation string.
+     */
+    async getDocumentation() {
+        return await (0, getDocumentation_js_1.getDocumentation)('./docs/SHIP/ship-lookup-service.md');
+    }
+    /**
+     * Returns metadata associated with this lookup service.
+     * @returns A promise that resolves to an object containing metadata.
+     */
+    async getMetaData() {
+        return {
+            name: 'SHIP Lookup Service',
+            shortDescription: 'Provides lookup capabilities for SHIP tokens.'
+        };
+    }
+}
+exports.SHIPLookupService = SHIPLookupService;
+//# sourceMappingURL=SHIPLookupService.js.map

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

@@ -0,0 +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"}

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

@@ -0,0 +1,87 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SHIPStorage = void 0;
+/**
+ * Implements a storage engine for SHIP protocol
+ */
+class SHIPStorage {
+    /**
+     * Constructs a new SHIPStorage instance
+     * @param {Db} db - connected mongo database instance
+     */
+    constructor(db) {
+        this.db = db;
+        this.shipRecords = db.collection('shipRecords');
+    }
+    /**
+     * Ensures the necessary indexes are created for the collections.
+     */
+    async ensureIndexes() {
+        await this.shipRecords.createIndex({ domain: 1, topic: 1 });
+    }
+    /**
+     * Stores a SHIP record
+     * @param {string} txid transaction id
+     * @param {number} outputIndex index of the UTXO
+     * @param {string} identityKey identity key
+     * @param {string} domain domain name
+     * @param {string} topic topic name
+     */
+    async storeSHIPRecord(txid, outputIndex, identityKey, domain, topic) {
+        await this.shipRecords.insertOne({
+            txid,
+            outputIndex,
+            identityKey,
+            domain,
+            topic,
+            createdAt: new Date()
+        });
+    }
+    /**
+     * Deletes a SHIP record
+     * @param {string} txid transaction id
+     * @param {number} outputIndex index of the UTXO
+     */
+    async deleteSHIPRecord(txid, outputIndex) {
+        await this.shipRecords.deleteOne({ txid, outputIndex });
+    }
+    /**
+     * Finds SHIP records based on a given query object.
+     * @param {Object} query The query object which may contain properties for domain or topics.
+     * @returns {Promise<UTXOReference[]>} Returns matching UTXO references.
+     */
+    async findRecord(query) {
+        const mongoQuery = {};
+        // Add domain to the query if provided
+        if (query.domain) {
+            mongoQuery.domain = query.domain;
+        }
+        // Add topics to the query if provided
+        if (query.topics && Array.isArray(query.topics)) {
+            mongoQuery.topic = { $in: query.topics };
+        }
+        return await this.shipRecords
+            .find(mongoQuery)
+            .project({ txid: 1, outputIndex: 1 })
+            .toArray()
+            .then((results) => results.map((record) => ({
+            txid: record.txid,
+            outputIndex: record.outputIndex,
+        })));
+    }
+    /**
+   * Returns all results tracked by the overlay
+   * @returns {Promise<UTXOReference[]>} returns matching UTXO references
+   */
+    async findAll() {
+        return await this.shipRecords.find({})
+            .project({ txid: 1, outputIndex: 1 })
+            .toArray()
+            .then(results => results.map(shipRecords => ({
+            txid: shipRecords.txid,
+            outputIndex: shipRecords.outputIndex
+        })));
+    }
+}
+exports.SHIPStorage = SHIPStorage;
+//# sourceMappingURL=SHIPStorage.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"SHIPStorage.js","sourceRoot":"","sources":["../../../../src/SHIP/SHIPStorage.ts"],"names":[],"mappings":";;;AAGA;;GAEG;AACH,MAAa,WAAW;IAGtB;;;OAGG;IACH,YAA6B,EAAM;QAAN,OAAE,GAAF,EAAE,CAAI;QACjC,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC,UAAU,CAAa,aAAa,CAAC,CAAA;IAC7D,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,aAAa;QACjB,MAAM,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAA;IAC7D,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,eAAe,CAAC,IAAY,EAAE,WAAmB,EAAE,WAAmB,EAAE,MAAc,EAAE,KAAa;QACzG,MAAM,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC;YAC/B,IAAI;YACJ,WAAW;YACX,WAAW;YACX,MAAM;YACN,KAAK;YACL,SAAS,EAAE,IAAI,IAAI,EAAE;SACtB,CAAC,CAAA;IACJ,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,gBAAgB,CAAC,IAAY,EAAE,WAAmB;QACtD,MAAM,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,CAAA;IACzD,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,UAAU,CAAC,KAA6C;QAC5D,MAAM,UAAU,GAAQ,EAAE,CAAA;QAE1B,sCAAsC;QACtC,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;YACjB,UAAU,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAA;QAClC,CAAC;QAED,sCAAsC;QACtC,IAAI,KAAK,CAAC,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;YAChD,UAAU,CAAC,KAAK,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,MAAM,EAAE,CAAA;QAC1C,CAAC;QAED,OAAO,MAAM,IAAI,CAAC,WAAW;aAC1B,IAAI,CAAC,UAAU,CAAC;aAChB,OAAO,CAAgB,EAAE,IAAI,EAAE,CAAC,EAAE,WAAW,EAAE,CAAC,EAAE,CAAC;aACnD,OAAO,EAAE;aACT,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAChB,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;YACvB,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,WAAW,EAAE,MAAM,CAAC,WAAW;SAChC,CAAC,CAAC,CACJ,CAAA;IACL,CAAC;IAED;;;KAGC;IACD,KAAK,CAAC,OAAO;QACX,OAAO,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;aACnC,OAAO,CAAgB,EAAE,IAAI,EAAE,CAAC,EAAE,WAAW,EAAE,CAAC,EAAE,CAAC;aACnD,OAAO,EAAE;aACT,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;YAC3C,IAAI,EAAE,WAAW,CAAC,IAAI;YACtB,WAAW,EAAE,WAAW,CAAC,WAAW;SACrC,CAAC,CAAC,CAAC,CAAA;IACR,CAAC;CACF;AAzFD,kCAyFC"}

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

@@ -0,0 +1,84 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": 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");
+/**
+ * SHIP Topic Manager
+ * Implements the TopicManager interface for SHIP (Service Host Interconnect Protocol) tokens.
+ *
+ * The SHIP Topic Manager identifies admissible outputs based on SHIP protocol requirements.
+ * SHIP tokens facilitate the advertisement of nodes hosting specific topics within the overlay network.
+ */
+class SHIPTopicManager {
+    /**
+     * Identifies admissible outputs for SHIP tokens.
+     * @param beef - The transaction data in BEEF format.
+     * @param previousCoins - The previous coins to consider.
+     * @returns A promise that resolves with the admittance instructions.
+     */
+    async identifyAdmissibleOutputs(beef, previousCoins) {
+        const outputsToAdmit = [];
+        try {
+            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()
+                    if (shipIdentifier !== 'SHIP')
+                        continue;
+                    // Validate domain and service
+                    if (!(0, isValidDomain_js_1.isValidDomain)(domain))
+                        continue;
+                    // if (!isValidTopicName(topic)) continue
+                    // Verify the token locking key and signature
+                    (0, verifyToken_js_1.verifyToken)(identityKey, result.lockingPublicKey, result.fields, result.signature);
+                    outputsToAdmit.push(i);
+                }
+                catch (error) {
+                    console.error('Error processing output:', error);
+                }
+            }
+        }
+        catch (error) {
+            console.error('Error identifying admissible outputs:', error);
+        }
+        return {
+            outputsToAdmit,
+            coinsToRetain: []
+        };
+    }
+    /**
+     * Returns documentation specific to the SHIP topic manager.
+     * @returns A promise that resolves to the documentation string.
+     */
+    async getDocumentation() {
+        return await (0, getDocumentation_js_1.getDocumentation)('./docs/SHIP/ship-lookup-service.md');
+    }
+    /**
+     * Returns metadata associated with this topic manager.
+     * @returns A promise that resolves to an object containing metadata.
+     */
+    async getMetaData() {
+        return {
+            name: 'SHIP Topic Manager',
+            shortDescription: 'Manages SHIP tokens for service host interconnect.'
+        };
+    }
+}
+exports.SHIPTopicManager = SHIPTopicManager;
+//# sourceMappingURL=SHIPTopicManager.js.map

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

@@ -0,0 +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,8BAA8B;oBAC9B,IAAI,CAAC,IAAA,gCAAa,EAAC,MAAM,CAAC;wBAAE,SAAQ;oBACpC,yCAAyC;oBAEzC,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,OAAO,CAAC,KAAK,CAAC,0BAA0B,EAAE,KAAK,CAAC,CAAA;gBAClD,CAAC;YACH,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,KAAK,CAAC,uCAAuC,EAAE,KAAK,CAAC,CAAA;QAC/D,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;AA1ED,4CA0EC"}

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

@@ -0,0 +1,114 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": 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");
+/**
+ * Implements the SLAP lookup service
+ *
+ * The SLAP lookup service allows querying for service availability within the
+ * overlay network. This service listens for SLAP-related UTXOs and stores relevant
+ * records for lookup purposes.
+ */
+class SLAPLookupService {
+    constructor(storage) {
+        this.storage = storage;
+    }
+    /**
+     * Handles the addition of a new output to the topic.
+     * @param txid - The transaction ID containing the output.
+     * @param outputIndex - The index of the output in the transaction.
+     * @param outputScript - The script of the output to be processed.
+     * @param topic - The topic associated with the output.
+     */
+    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();
+        if (protocol !== 'SLAP')
+            return;
+        await this.storage.storeSLAPRecord(txid, outputIndex, identityKey, domain, service);
+    }
+    /**
+     * Handles the spending of an output in the topic.
+     * @param txid - The transaction ID of the spent output.
+     * @param outputIndex - The index of the spent output.
+     * @param topic - The topic associated with the spent output.
+     */
+    async outputSpent(txid, outputIndex, topic) {
+        if (topic !== 'tm_slap')
+            return;
+        await this.storage.deleteSLAPRecord(txid, outputIndex);
+    }
+    /**
+     * Handles the deletion of an output in the topic.
+     * @param txid - The transaction ID of the deleted output.
+     * @param outputIndex - The index of the deleted output.
+     * @param topic - The topic associated with the deleted output.
+     */
+    async outputDeleted(txid, outputIndex, topic) {
+        if (topic !== 'tm_slap')
+            return;
+        await this.storage.deleteSLAPRecord(txid, outputIndex);
+    }
+    /**
+     * Answers a lookup query.
+     * @param question - The lookup question to be answered.
+     * @returns A promise that resolves to a lookup answer or formula.
+     */
+    async lookup(question) {
+        if (question.query === undefined || question.query === null) {
+            throw new Error('A valid query must be provided!');
+        }
+        if (question.service !== 'ls_slap') {
+            throw new Error('Lookup service not supported!');
+        }
+        if (question.query === 'findAll') {
+            return await this.storage.findAll();
+        }
+        const { domain, service } = question.query;
+        // Validate lookup query
+        if (domain !== undefined && domain !== null && service !== undefined && service !== null) {
+            // If both domain and service are provided, construct a query with both
+            return await this.storage.findRecord({ domain, service });
+        }
+        else if (domain !== undefined && domain !== null) {
+            return await this.storage.findRecord({ domain });
+        }
+        else if (service !== undefined && service !== null) {
+            return await this.storage.findRecord({ service });
+        }
+        else {
+            throw new Error('A valid domain or service must be provided in the query!');
+        }
+    }
+    /**
+     * Returns documentation specific to this overlay lookup service.
+     * @returns A promise that resolves to the documentation string.
+     */
+    async getDocumentation() {
+        return await (0, getDocumentation_js_1.getDocumentation)('./docs/SLAP/slap-lookup-service.md');
+    }
+    /**
+     * Returns metadata associated with this lookup service.
+     * @returns A promise that resolves to an object containing metadata.
+     */
+    async getMetaData() {
+        return {
+            name: 'SLAP Lookup Service',
+            shortDescription: 'Provides lookup capabilities for SLAP tokens.'
+        };
+    }
+}
+exports.SLAPLookupService = SLAPLookupService;
+//# sourceMappingURL=SLAPLookupService.js.map

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

@@ -0,0 +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"}

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

@@ -0,0 +1,77 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SLAPStorage = void 0;
+/**
+ * Implements a storage engine for SLAP protocol
+ */
+class SLAPStorage {
+    /**
+     * Constructs a new SLAPStorage instance
+     * @param {Db} db - connected mongo database instance
+     */
+    constructor(db) {
+        this.db = db;
+        this.slapRecords = db.collection('slapRecords');
+    }
+    /**
+     * Ensures the necessary indexes are created for the collections.
+     */
+    async ensureIndexes() {
+        await this.slapRecords.createIndex({ domain: 1, service: 1 });
+    }
+    /**
+     * Stores a SLAP record
+     * @param {string} txid transaction id
+     * @param {number} outputIndex index of the UTXO
+     * @param {string} identityKey identity key
+     * @param {string} domain domain name
+     * @param {string} service service name
+     */
+    async storeSLAPRecord(txid, outputIndex, identityKey, domain, service) {
+        await this.slapRecords.insertOne({
+            txid,
+            outputIndex,
+            identityKey,
+            domain,
+            service,
+            createdAt: new Date()
+        });
+    }
+    /**
+     * Deletes a SLAP record
+     * @param {string} txid transaction id
+     * @param {number} outputIndex index of the UTXO
+     */
+    async deleteSLAPRecord(txid, outputIndex) {
+        await this.slapRecords.deleteOne({ txid, outputIndex });
+    }
+    /**
+     * Finds SLAP records based on a given query object.
+     * @param {Object} query The query object which may contain properties for domain or service.
+     * @returns {Promise<UTXOReference[]>} returns matching UTXO references
+     */
+    async findRecord(query) {
+        return await this.slapRecords.find(query)
+            .project({ txid: 1, outputIndex: 1 })
+            .toArray()
+            .then(results => results.map(record => ({
+            txid: record.txid,
+            outputIndex: record.outputIndex
+        })));
+    }
+    /**
+    * Returns all results tracked by the overlay
+    * @returns {Promise<UTXOReference[]>} returns matching UTXO references
+    */
+    async findAll() {
+        return await this.slapRecords.find({})
+            .project({ txid: 1, outputIndex: 1 })
+            .toArray()
+            .then(results => results.map(slapRecords => ({
+            txid: slapRecords.txid,
+            outputIndex: slapRecords.outputIndex
+        })));
+    }
+}
+exports.SLAPStorage = SLAPStorage;
+//# sourceMappingURL=SLAPStorage.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"SLAPStorage.js","sourceRoot":"","sources":["../../../../src/SLAP/SLAPStorage.ts"],"names":[],"mappings":";;;AAGA;;GAEG;AACH,MAAa,WAAW;IAGtB;;;OAGG;IACH,YAA6B,EAAM;QAAN,OAAE,GAAF,EAAE,CAAI;QACjC,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC,UAAU,CAAa,aAAa,CAAC,CAAA;IAC7D,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,aAAa;QACjB,MAAM,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC,CAAA;IAC/D,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,eAAe,CAAC,IAAY,EAAE,WAAmB,EAAE,WAAmB,EAAE,MAAc,EAAE,OAAe;QAC3G,MAAM,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC;YAC/B,IAAI;YACJ,WAAW;YACX,WAAW;YACX,MAAM;YACN,OAAO;YACP,SAAS,EAAE,IAAI,IAAI,EAAE;SACtB,CAAC,CAAA;IACJ,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,gBAAgB,CAAC,IAAY,EAAE,WAAmB;QACtD,MAAM,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,CAAA;IACzD,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,UAAU,CAAC,KAA4C;QAC3D,OAAO,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC;aACtC,OAAO,CAAgB,EAAE,IAAI,EAAE,CAAC,EAAE,WAAW,EAAE,CAAC,EAAE,CAAC;aACnD,OAAO,EAAE;aACT,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;YACtC,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,WAAW,EAAE,MAAM,CAAC,WAAW;SAChC,CAAC,CAAC,CAAC,CAAA;IACR,CAAC;IAED;;;MAGE;IACF,KAAK,CAAC,OAAO;QACX,OAAO,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;aACnC,OAAO,CAAgB,EAAE,IAAI,EAAE,CAAC,EAAE,WAAW,EAAE,CAAC,EAAE,CAAC;aACnD,OAAO,EAAE;aACT,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;YAC3C,IAAI,EAAE,WAAW,CAAC,IAAI;YACtB,WAAW,EAAE,WAAW,CAAC,WAAW;SACrC,CAAC,CAAC,CAAC,CAAA;IACR,CAAC;CACF;AA1ED,kCA0EC"}

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

@@ -0,0 +1,84 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SLAPTopicManager = void 0;
+const sdk_1 = require("@bsv/sdk");
+const pushdrop_1 = __importDefault(require("pushdrop"));
+const verifyToken_js_1 = require("../utils/verifyToken.js");
+const isValidServiceName_js_1 = require("../utils/isValidServiceName.js");
+const getDocumentation_js_1 = require("../utils/getDocumentation.js");
+/**
+ * SLAP Topic Manager
+ * Implements the TopicManager interface for SLAP (Service Lookup Availability Protocol) tokens.
+ *
+ * The SLAP Topic Manager identifies admissible outputs based on SLAP protocol requirements.
+ * SLAP tokens facilitate the advertisement of lookup services availability within the overlay network.
+ */
+class SLAPTopicManager {
+    /**
+     * Identifies admissible outputs for SLAP tokens.
+     * @param beef - The transaction data in BEEF format.
+     * @param previousCoins - The previous coins to consider.
+     * @returns A promise that resolves with the admittance instructions.
+     */
+    async identifyAdmissibleOutputs(beef, previousCoins) {
+        const outputsToAdmit = [];
+        try {
+            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; // SLAP tokens should have 4 fields
+                    const slapIdentifier = result.fields[0].toString();
+                    const identityKey = result.fields[1].toString('hex');
+                    // const domain = result.fields[2].toString()
+                    const service = result.fields[3].toString();
+                    if (slapIdentifier !== 'SLAP')
+                        continue;
+                    // Validate domain and service
+                    // if (isValidDomain(domain) !== true) continue
+                    if (!(0, isValidServiceName_js_1.isValidServiceName)(service))
+                        continue;
+                    // Verify the token locking key and signature
+                    (0, verifyToken_js_1.verifyToken)(identityKey, result.lockingPublicKey, result.fields, result.signature);
+                    outputsToAdmit.push(i);
+                }
+                catch (error) {
+                    console.error('Error processing output:', error);
+                }
+            }
+        }
+        catch (error) {
+            console.error('Error identifying admissible outputs:', error);
+        }
+        return {
+            outputsToAdmit,
+            coinsToRetain: []
+        };
+    }
+    /**
+     * Returns documentation specific to the SLAP topic manager.
+     * @returns A promise that resolves to the documentation string.
+     */
+    async getDocumentation() {
+        return await (0, getDocumentation_js_1.getDocumentation)('./docs/SLAP/slap-lookup-service.md');
+    }
+    /**
+     * Returns metadata associated with this topic manager.
+     * @returns A promise that resolves to an object containing metadata.
+     */
+    async getMetaData() {
+        return {
+            name: 'SLAP Topic Manager',
+            shortDescription: 'Manages SLAP tokens for service lookup availability.',
+        };
+    }
+}
+exports.SLAPTopicManager = SLAPTopicManager;
+//# sourceMappingURL=SLAPTopicManager.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"SLAPTopicManager.js","sourceRoot":"","sources":["../../../../src/SLAP/SLAPTopicManager.ts"],"names":[],"mappings":";;;;;;AACA,kCAAsC;AACtC,wDAA+B;AAC/B,4DAAqD;AACrD,0EAAmE;AACnE,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,6CAA6C;oBAC7C,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAA;oBAC3C,IAAI,cAAc,KAAK,MAAM;wBAAE,SAAQ;oBAEvC,8BAA8B;oBAC9B,+CAA+C;oBAC/C,IAAI,CAAC,IAAA,0CAAkB,EAAC,OAAO,CAAC;wBAAE,SAAQ;oBAE1C,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,OAAO,CAAC,KAAK,CAAC,0BAA0B,EAAE,KAAK,CAAC,CAAA;gBAClD,CAAC;YACH,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,KAAK,CAAC,uCAAuC,EAAE,KAAK,CAAC,CAAA;QAC/D,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,sDAAsD;SACzE,CAAA;IACH,CAAC;CACF;AAzED,4CAyEC"}

package/dist/cjs/src/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/cjs/src/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/types.ts"],"names":[],"mappings":""}