@bsv/overlay-discovery-services 1.1.4 → 1.1.6

package/dist/cjs/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bsv/overlay-discovery-services",
-  "version": "1.1.3",
+  "version": "1.1.5",
   "type": "commonjs",
   "description": "BSV Blockchain Overlay Services Engine",
   "files": [

package/dist/cjs/src/NinjaAdvertiser.js

@@ -0,0 +1,234 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NinjaAdvertiser = void 0;
+const pushdrop_1 = __importDefault(require("pushdrop"));
+const ninja_base_1 = require("ninja-base");
+const sdk_ts_1 = require("@babbage/sdk-ts");
+const sdk_1 = require("@bsv/sdk");
+const sendover_1 = require("sendover");
+const toBEEF_js_1 = require("@babbage/sdk-ts/out/src/utils/toBEEF.js");
+const AD_TOKEN_VALUE = 1;
+/**
+ * Implements the Advertiser interface for managing SHIP and SLAP advertisements using a Ninja.
+ */
+class NinjaAdvertiser {
+    /**
+     * Constructs a new NinjaAdvertiser instance.
+     * @param privateKey - The private key used for signing transactions.
+     * @param dojoURL - The URL of the dojo server for the Ninja.
+     * @param hostingDomain - The base server URL for the NinjaAdvertiser.
+     */
+    constructor(privateKey, dojoURL, hostingDomain) {
+        this.privateKey = privateKey;
+        this.dojoURL = dojoURL;
+        this.hostingDomain = hostingDomain;
+        this.ninja = new ninja_base_1.Ninja({
+            privateKey,
+            config: {
+                dojoURL
+            }
+        });
+    }
+    /**
+     * Sets the Engine instance to be used by this NinjaAdvertiser. This method allows for late
+     * binding of the Engine, thus avoiding circular dependencies during instantiation. The Engine
+     * provides necessary context with the relevant topic managers and lookup services,
+     * as well as the lookup function used for querying advertisements.
+     *
+     * @param engine The Engine instance to be associated with this NinjaAdvertiser. The Engine should
+     * be fully initialized before being passed to this method to ensure all functionalities are available.
+     */
+    setLookupEngine(engine) {
+        this.engine = engine;
+    }
+    /**
+     * Utility function to create multiple advertisements in a single transaction.
+     * @param privateKey The private key used to sign the transaction.
+     * @param adsData Array of advertisement details.
+     * @param ninja Ninja instance for transaction processing.
+     * @param note A note attached to the transaction.
+     * @returns A promise that resolves to an array of TaggedBEEF objects.
+     * @throws Will throw an error if the locking key is invalid.
+     */
+    async createAdvertisements(adsData) {
+        const identityKey = sdk_1.PublicKey.fromPrivateKey(new sdk_1.PrivateKey(this.privateKey, 'hex')).toString();
+        const outputs = await Promise.all(adsData.map(async (ad) => {
+            // Derive a locking private key using BRC-42 derivation scheme
+            const derivedPrivateKey = (0, sendover_1.getPaymentPrivateKey)({
+                recipientPrivateKey: this.privateKey,
+                senderPublicKey: identityKey,
+                invoiceNumber: `2-${ad.protocol}-1`,
+                returnType: 'hex'
+            });
+            const lockingScript = await pushdrop_1.default.create({
+                fields: [
+                    Buffer.from(ad.protocol),
+                    Buffer.from(identityKey, 'hex'),
+                    Buffer.from(this.hostingDomain),
+                    Buffer.from(ad.topicOrServiceName)
+                ],
+                key: derivedPrivateKey
+            });
+            return {
+                satoshis: AD_TOKEN_VALUE,
+                script: lockingScript
+            };
+        }));
+        const tx = await this.ninja.getTransactionWithOutputs({
+            outputs,
+            note: 'SHIP/SLAP Advertisement Issuance',
+            autoProcess: true
+        });
+        const beef = (0, sdk_ts_1.toBEEFfromEnvelope)({
+            rawTx: tx.rawTx,
+            inputs: tx.inputs,
+            txid: tx.txid
+        }).beef;
+        return {
+            beef,
+            topics: [...new Set(adsData.map(ad => ad.protocol === 'SHIP' ? 'tm_ship' : 'tm_slap'))]
+        };
+    }
+    /**
+     * Finds all SHIP advertisements for a given topic.
+     * @param topic - The topic name to search for.
+     * @returns A promise that resolves to an array of SHIP advertisements.
+     */
+    async findAllAdvertisements(protocol) {
+        if (this.engine === undefined) {
+            throw new Error('Advertiser must be configured with an overlay services engine for advertisement lookup.');
+        }
+        const advertisements = [];
+        const lookupAnswer = await this.engine.lookup({
+            service: protocol === 'SHIP' ? 'ls_ship' : 'ls_slap',
+            query: 'findAll'
+        });
+        // Lookup will currently always return type output-list
+        if (lookupAnswer.type === 'output-list') {
+            lookupAnswer.outputs.forEach(output => {
+                try {
+                    // Parse out the advertisements using the provided parser
+                    const tx = sdk_1.Transaction.fromBEEF(output.beef);
+                    const advertisement = this.parseAdvertisement(tx.outputs[output.outputIndex].lockingScript);
+                    if (advertisement !== undefined && advertisement !== null && advertisement.protocol === protocol) {
+                        advertisements.push({
+                            ...advertisement,
+                            beef: output.beef,
+                            outputIndex: output.outputIndex
+                        });
+                    }
+                }
+                catch (error) {
+                    console.error('Failed to parse advertisement output:', error);
+                }
+            });
+        }
+        return advertisements;
+    }
+    /**
+     * Revokes an existing advertisement.
+     * @param advertisements - The advertisements to revoke, either SHIP or SLAP.
+     * @returns A promise that resolves to the revoked advertisement as TaggedBEEF.
+     */
+    async revokeAdvertisements(advertisements) {
+        if (advertisements.length === 0) {
+            throw new Error('Must provide advertisements to revoke!');
+        }
+        const inputsByTxid = {};
+        for (const advertisement of advertisements) {
+            if (advertisement.beef === undefined || advertisement.outputIndex === undefined) {
+                throw new Error('Advertisement to revoke must contain tagged beef!');
+            }
+            // Parse the transaction and UTXO to spend
+            const advertisementTx = sdk_1.Transaction.fromBEEF(advertisement.beef);
+            const adTxid = advertisementTx.id('hex');
+            const outputToRedeem = advertisementTx.outputs[advertisement.outputIndex];
+            const identityKey = sdk_1.PublicKey.fromPrivateKey(new sdk_1.PrivateKey(this.privateKey, 'hex')).toString();
+            // Derive a unlocking private key using BRC-42 derivation scheme
+            const derivedPrivateKey = (0, sendover_1.getPaymentPrivateKey)({
+                recipientPrivateKey: this.privateKey,
+                senderPublicKey: identityKey,
+                invoiceNumber: `2-${advertisement.protocol}-1`,
+                returnType: 'hex'
+            });
+            const unlockingScript = await pushdrop_1.default.redeem({
+                key: derivedPrivateKey,
+                prevTxId: adTxid,
+                outputIndex: advertisement.outputIndex,
+                lockingScript: outputToRedeem.lockingScript.toHex(),
+                outputAmount: outputToRedeem.satoshis
+            });
+            const constructedRedeem = {
+                index: advertisement.outputIndex,
+                unlockingScript
+            };
+            // Group outputs by their transaction ID
+            if (inputsByTxid[adTxid] === undefined) {
+                inputsByTxid[adTxid] = {
+                    ...(0, toBEEF_js_1.toEnvelopeFromBEEF)(advertisementTx),
+                    rawTx: advertisementTx.toHex(),
+                    outputsToRedeem: [constructedRedeem]
+                };
+            }
+            else {
+                inputsByTxid[adTxid].outputsToRedeem.push(constructedRedeem);
+            }
+        }
+        // Create a new transaction that spends the SHIP or SLAP advertisement issuance token
+        const revokeTx = await this.ninja.getTransactionWithOutputs({
+            inputs: inputsByTxid,
+            outputs: [],
+            labels: [],
+            note: 'Revoked SHIP/SLAP advertisements',
+            autoProcess: true
+        });
+        const beef = (0, sdk_ts_1.toBEEFfromEnvelope)({
+            rawTx: revokeTx.rawTx,
+            inputs: revokeTx.inputs,
+            txid: revokeTx.txid
+        }).beef;
+        return {
+            beef,
+            topics: [...new Set(advertisements.map(ad => ad.protocol === 'SHIP' ? 'tm_ship' : 'tm_slap'))]
+        };
+    }
+    /**
+     * Parses an advertisement from the provided output script.
+     * @param outputScript - The output script to parse.
+     * @returns An Advertisement object if the script matches the expected format, otherwise throws an error.
+     */
+    parseAdvertisement(outputScript) {
+        try {
+            const result = pushdrop_1.default.decode({
+                script: outputScript.toHex(),
+                fieldFormat: 'buffer'
+            });
+            if (result.fields.length < 4) {
+                throw new Error('Invalid SHIP/SLAP advertisement!');
+            }
+            const protocol = result.fields[0].toString();
+            if (protocol !== 'SHIP' && protocol !== 'SLAP') {
+                throw new Error('Invalid protocol type!');
+            }
+            const identityKey = result.fields[1].toString('hex');
+            const domain = result.fields[2].toString();
+            const topicOrService = result.fields[3].toString();
+            // Construct a unified Advertisement object
+            return {
+                protocol: protocol,
+                identityKey,
+                domain,
+                topicOrService
+            };
+        }
+        catch (error) {
+            console.error('Error parsing advertisement:', error);
+            throw new Error('Error parsing advertisement!');
+        }
+    }
+}
+exports.NinjaAdvertiser = NinjaAdvertiser;
+//# sourceMappingURL=NinjaAdvertiser.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"NinjaAdvertiser.js","sourceRoot":"","sources":["../../../src/NinjaAdvertiser.ts"],"names":[],"mappings":";;;;;;AACA,wDAA+B;AAC/B,2CAAoD;AACpD,4CAAyE;AACzE,kCAAqE;AAErE,uCAA+C;AAE/C,uEAA4E;AAE5E,MAAM,cAAc,GAAG,CAAC,CAAA;AAExB;;GAEG;AACH,MAAa,eAAe;IAI1B;;;;;OAKG;IACH,YACS,UAAkB,EAClB,OAAe,EACf,aAAqB;QAFrB,eAAU,GAAV,UAAU,CAAQ;QAClB,YAAO,GAAP,OAAO,CAAQ;QACf,kBAAa,GAAb,aAAa,CAAQ;QAE5B,IAAI,CAAC,KAAK,GAAG,IAAI,kBAAK,CAAC;YACrB,UAAU;YACV,MAAM,EAAE;gBACN,OAAO;aACR;SACF,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;OAQG;IACH,eAAe,CAAC,MAAc;QAC5B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,oBAAoB,CACxB,OAA4B;QAE5B,MAAM,WAAW,GAAG,eAAS,CAAC,cAAc,CAAC,IAAI,gBAAU,CAAC,IAAI,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAA;QAE/F,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE,EAAE,EAAE;YACzD,8DAA8D;YAC9D,MAAM,iBAAiB,GAAG,IAAA,+BAAoB,EAAC;gBAC7C,mBAAmB,EAAE,IAAI,CAAC,UAAU;gBACpC,eAAe,EAAE,WAAW;gBAC5B,aAAa,EAAE,KAAK,EAAE,CAAC,QAAQ,IAAI;gBACnC,UAAU,EAAE,KAAK;aAClB,CAAC,CAAA;YAEF,MAAM,aAAa,GAAG,MAAM,kBAAQ,CAAC,MAAM,CAAC;gBAC1C,MAAM,EAAE;oBACN,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,QAAQ,CAAC;oBACxB,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC;oBAC/B,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC;oBAC/B,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,kBAAkB,CAAC;iBACnC;gBACD,GAAG,EAAE,iBAAiB;aACvB,CAAC,CAAA;YAEF,OAAO;gBACL,QAAQ,EAAE,cAAc;gBACxB,MAAM,EAAE,aAAa;aACtB,CAAA;QACH,CAAC,CAAC,CAAC,CAAA;QAEH,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,yBAAyB,CAAC;YACpD,OAAO;YACP,IAAI,EAAE,kCAAkC;YACxC,WAAW,EAAE,IAAI;SAClB,CAAC,CAAA;QAEF,MAAM,IAAI,GAAG,IAAA,2BAAkB,EAAC;YAC9B,KAAK,EAAE,EAAE,CAAC,KAAe;YACzB,MAAM,EAAE,EAAE,CAAC,MAAM;YACjB,IAAI,EAAE,EAAE,CAAC,IAAI;SACS,CAAC,CAAC,IAAI,CAAA;QAE9B,OAAO;YACL,IAAI;YACJ,MAAM,EAAE,CAAC,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,QAAQ,KAAK,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;SACxF,CAAA;IACH,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,qBAAqB,CAAC,QAAyB;QACnD,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAC9B,MAAM,IAAI,KAAK,CAAC,yFAAyF,CAAC,CAAA;QAC5G,CAAC;QACD,MAAM,cAAc,GAAoB,EAAE,CAAA;QAC1C,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC;YAC5C,OAAO,EAAE,QAAQ,KAAK,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS;YACpD,KAAK,EAAE,SAAS;SACjB,CAAC,CAAA;QAEF,uDAAuD;QACvD,IAAI,YAAY,CAAC,IAAI,KAAK,aAAa,EAAE,CAAC;YACxC,YAAY,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;gBACpC,IAAI,CAAC;oBACH,yDAAyD;oBACzD,MAAM,EAAE,GAAG,iBAAW,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;oBAC5C,MAAM,aAAa,GAAG,IAAI,CAAC,kBAAkB,CAAC,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,aAAa,CAAC,CAAA;oBAC3F,IAAI,aAAa,KAAK,SAAS,IAAI,aAAa,KAAK,IAAI,IAAI,aAAa,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;wBACjG,cAAc,CAAC,IAAI,CAAC;4BAClB,GAAG,aAAa;4BAChB,IAAI,EAAE,MAAM,CAAC,IAAI;4BACjB,WAAW,EAAE,MAAM,CAAC,WAAW;yBAChC,CAAC,CAAA;oBACJ,CAAC;gBACH,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACf,OAAO,CAAC,KAAK,CAAC,uCAAuC,EAAE,KAAK,CAAC,CAAA;gBAC/D,CAAC;YACH,CAAC,CAAC,CAAA;QACJ,CAAC;QAED,OAAO,cAAc,CAAA;IACvB,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,oBAAoB,CAAC,cAA+B;QACxD,IAAI,cAAc,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAChC,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAA;QAC3D,CAAC;QACD,MAAM,YAAY,GAAyC,EAAE,CAAA;QAC7D,KAAK,MAAM,aAAa,IAAI,cAAc,EAAE,CAAC;YAC3C,IAAI,aAAa,CAAC,IAAI,KAAK,SAAS,IAAI,aAAa,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;gBAChF,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAA;YACtE,CAAC;YACD,0CAA0C;YAC1C,MAAM,eAAe,GAAG,iBAAW,CAAC,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,CAAA;YAChE,MAAM,MAAM,GAAG,eAAe,CAAC,EAAE,CAAC,KAAK,CAAC,CAAA;YACxC,MAAM,cAAc,GAAG,eAAe,CAAC,OAAO,CAAC,aAAa,CAAC,WAAW,CAAC,CAAA;YACzE,MAAM,WAAW,GAAG,eAAS,CAAC,cAAc,CAAC,IAAI,gBAAU,CAAC,IAAI,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAA;YAE/F,gEAAgE;YAChE,MAAM,iBAAiB,GAAG,IAAA,+BAAoB,EAAC;gBAC7C,mBAAmB,EAAE,IAAI,CAAC,UAAU;gBACpC,eAAe,EAAE,WAAW;gBAC5B,aAAa,EAAE,KAAK,aAAa,CAAC,QAAQ,IAAI;gBAC9C,UAAU,EAAE,KAAK;aAClB,CAAC,CAAA;YAEF,MAAM,eAAe,GAAG,MAAM,kBAAQ,CAAC,MAAM,CAAC;gBAC5C,GAAG,EAAE,iBAAiB;gBACtB,QAAQ,EAAE,MAAM;gBAChB,WAAW,EAAE,aAAa,CAAC,WAAW;gBACtC,aAAa,EAAE,cAAc,CAAC,aAAa,CAAC,KAAK,EAAE;gBACnD,YAAY,EAAE,cAAc,CAAC,QAAQ;aACtC,CAAC,CAAA;YAEF,MAAM,iBAAiB,GAAG;gBACxB,KAAK,EAAE,aAAa,CAAC,WAAW;gBAChC,eAAe;aAChB,CAAA;YAED,wCAAwC;YACxC,IAAI,YAAY,CAAC,MAAM,CAAC,KAAK,SAAS,EAAE,CAAC;gBACvC,YAAY,CAAC,MAAM,CAAC,GAAG;oBACrB,GAAG,IAAA,8BAAkB,EAAC,eAAe,CAAC;oBACtC,KAAK,EAAE,eAAe,CAAC,KAAK,EAAE;oBAC9B,eAAe,EAAE,CAAC,iBAAiB,CAAC;iBACrC,CAAA;YACH,CAAC;iBAAM,CAAC;gBACN,YAAY,CAAC,MAAM,CAAC,CAAC,eAAe,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAA;YAC9D,CAAC;QACH,CAAC;QAED,qFAAqF;QACrF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,yBAAyB,CAAC;YAC1D,MAAM,EAAE,YAAY;YACpB,OAAO,EAAE,EAAE;YACX,MAAM,EAAE,EAAE;YACV,IAAI,EAAE,kCAAkC;YACxC,WAAW,EAAE,IAAI;SAClB,CAAC,CAAA;QAEF,MAAM,IAAI,GAAG,IAAA,2BAAkB,EAAC;YAC9B,KAAK,EAAE,QAAQ,CAAC,KAAe;YAC/B,MAAM,EAAE,QAAQ,CAAC,MAAM;YACvB,IAAI,EAAE,QAAQ,CAAC,IAAI;SACG,CAAC,CAAC,IAAI,CAAA;QAE9B,OAAO;YACL,IAAI;YACJ,MAAM,EAAE,CAAC,GAAG,IAAI,GAAG,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,QAAQ,KAAK,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;SAC/F,CAAA;IACH,CAAC;IAED;;;;OAIG;IACH,kBAAkB,CAAC,YAAoB;QACrC,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,kBAAQ,CAAC,MAAM,CAAC;gBAC7B,MAAM,EAAE,YAAY,CAAC,KAAK,EAAE;gBAC5B,WAAW,EAAE,QAAQ;aACtB,CAAC,CAAA;YAEF,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC7B,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAA;YACrD,CAAC;YAED,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAA;YAC5C,IAAI,QAAQ,KAAK,MAAM,IAAI,QAAQ,KAAK,MAAM,EAAE,CAAC;gBAC/C,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAA;YAC3C,CAAC;YAED,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAA;YACpD,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAA;YAC1C,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAA;YAElD,2CAA2C;YAC3C,OAAO;gBACL,QAAQ,EAAE,QAA2B;gBACrC,WAAW;gBACX,MAAM;gBACN,cAAc;aACf,CAAA;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,KAAK,CAAC,8BAA8B,EAAE,KAAK,CAAC,CAAA;YACpD,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAA;QACjD,CAAC;IACH,CAAC;CACF;AAlPD,0CAkPC"}

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

@@ -75,16 +75,25 @@ class SLAPLookupService {
         }
         // Validate lookup query
         const { domain, service, identityKey } = question.query;
-        if (typeof domain !== 'string' && typeof domain !== 'undefined') {
+        // Validate that provided values are strings.
+        if (domain !== undefined && typeof domain !== 'string') {
             throw new Error('query.domain must be a string if provided');
         }
-        if (typeof service !== 'string' && typeof service !== 'undefined') {
+        if (service !== undefined && typeof service !== 'string') {
             throw new Error('query.service must be a string if provided');
         }
-        if (typeof identityKey !== 'string' && typeof identityKey !== 'undefined') {
+        if (identityKey !== undefined && typeof identityKey !== 'string') {
             throw new Error('query.identityKey must be a string if provided');
         }
-        const result = await this.storage.findRecord({ domain, service, identityKey });
+        // Build the query object dynamically to omit any undefined values.
+        const query = {};
+        if (domain !== undefined)
+            query.domain = domain;
+        if (service !== undefined)
+            query.service = service;
+        if (identityKey !== undefined)
+            query.identityKey = identityKey;
+        const result = await this.storage.findRecord(query);
         console.log('LOOKUP RESULT', result);
         return result;
     }

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

@@ -1 +1 @@
-{"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,wBAAwB;QACxB,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW,EAAE,GAAG,QAAQ,CAAC,KAAkB,CAAA;QACpE,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,OAAO,MAAM,KAAK,WAAW,EAAE,CAAC;YAChE,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAA;QAC9D,CAAC;QACD,IAAI,OAAO,OAAO,KAAK,QAAQ,IAAI,OAAO,OAAO,KAAK,WAAW,EAAE,CAAC;YAClE,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAA;QAC/D,CAAC;QACD,IAAI,OAAO,WAAW,KAAK,QAAQ,IAAI,OAAO,WAAW,KAAK,WAAW,EAAE,CAAC;YAC1E,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAA;QACnE,CAAC;QACD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW,EAAE,CAAC,CAAA;QAC9E,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,MAAM,CAAC,CAAA;QACpC,OAAO,MAAM,CAAA;IACf,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;AApGD,8CAoGC"}
+{"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,wBAAwB;QACxB,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW,EAAE,GAAG,QAAQ,CAAC,KAAkB,CAAA;QAEpE,6CAA6C;QAC7C,IAAI,MAAM,KAAK,SAAS,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;YACvD,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAA;QAC9D,CAAC;QACD,IAAI,OAAO,KAAK,SAAS,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;YACzD,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAA;QAC/D,CAAC;QACD,IAAI,WAAW,KAAK,SAAS,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE,CAAC;YACjE,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAA;QACnE,CAAC;QAED,mEAAmE;QACnE,MAAM,KAAK,GAAuB,EAAE,CAAA;QACpC,IAAI,MAAM,KAAK,SAAS;YAAE,KAAK,CAAC,MAAM,GAAG,MAAM,CAAA;QAC/C,IAAI,OAAO,KAAK,SAAS;YAAE,KAAK,CAAC,OAAO,GAAG,OAAO,CAAA;QAClD,IAAI,WAAW,KAAK,SAAS;YAAE,KAAK,CAAC,WAAW,GAAG,WAAW,CAAA;QAE9D,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,CAAA;QACnD,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,MAAM,CAAC,CAAA;QACpC,OAAO,MAAM,CAAA;IACf,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;AA7GD,8CA6GC"}

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

@@ -51,7 +51,21 @@ class SLAPStorage {
      * @returns {Promise<UTXOReference[]>} returns matching UTXO references
      */
     async findRecord(query) {
-        return await this.slapRecords.find(query)
+        const mongoQuery = {};
+        // Add domain to the query if provided
+        if (typeof query.domain === 'string') {
+            mongoQuery.domain = query.domain;
+        }
+        // Add service to the query if provided
+        if (typeof query.service === 'string') {
+            mongoQuery.service = query.service;
+        }
+        // Add identityKey to the query if provided
+        if (typeof query.identityKey === 'string') {
+            mongoQuery.identityKey = query.identityKey;
+        }
+        console.log(mongoQuery);
+        return await this.slapRecords.find(mongoQuery)
             .project({ txid: 1, outputIndex: 1 })
             .toArray()
             .then(results => results.map(record => ({

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

@@ -1 +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,KAAgB;QAC/B,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"}
+{"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,KAAgB;QAC/B,MAAM,UAAU,GAAQ,EAAE,CAAA;QAE1B,sCAAsC;QACtC,IAAI,OAAO,KAAK,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;YACrC,UAAU,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAA;QAClC,CAAC;QAED,uCAAuC;QACvC,IAAI,OAAO,KAAK,CAAC,OAAO,KAAK,QAAQ,EAAE,CAAC;YACtC,UAAU,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,CAAA;QACpC,CAAC;QAED,2CAA2C;QAC3C,IAAI,OAAO,KAAK,CAAC,WAAW,KAAK,QAAQ,EAAE,CAAC;YAC1C,UAAU,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAA;QAC5C,CAAC;QACD,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAA;QAEvB,OAAO,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC;aAC3C,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;AA5FD,kCA4FC"}

package/dist/cjs/src/utils/verifyToken.js

@@ -13,8 +13,7 @@ const sdk_1 = require("@bsv/sdk");
  * @throws Will throw an error if the locking key or signature is invalid.
  */
 const verifyToken = (identityKey, lockingPublicKey, fields, signature) => {
-    const pubKey = sdk_1.PublicKey.fromString(lockingPublicKey);
-    const hasValidSignature = pubKey.verify(Array.from(Buffer.concat(fields)), sdk_1.Signature.fromDER(signature, 'hex'));
+    const hasValidSignature = lockingPublicKey.verify(fields.reduce((a, e) => [...a, ...e], []), sdk_1.Signature.fromDER(signature, 'hex'));
     if (!hasValidSignature)
         throw new Error('Invalid signature!');
 };

package/dist/cjs/src/utils/verifyToken.js.map

@@ -1 +1 @@
-{"version":3,"file":"verifyToken.js","sourceRoot":"","sources":["../../../../src/utils/verifyToken.ts"],"names":[],"mappings":";;;AAAA,kCAA+C;AAE/C;;;;;;;;;GASG;AACI,MAAM,WAAW,GAAG,CACzB,WAAmB,EACnB,gBAAwB,EACxB,MAAgB,EAChB,SAAiB,EACX,EAAE;IACR,MAAM,MAAM,GAAG,eAAS,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAA;IACrD,MAAM,iBAAiB,GAAG,MAAM,CAAC,MAAM,CACrC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EACjC,eAAS,CAAC,OAAO,CAAC,SAAS,EAAE,KAAK,CAAC,CACpC,CAAA;IAED,IAAI,CAAC,iBAAiB;QAAE,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAA;AAC/D,CAAC,CAAA;AAbY,QAAA,WAAW,eAavB"}
+{"version":3,"file":"verifyToken.js","sourceRoot":"","sources":["../../../../src/utils/verifyToken.ts"],"names":[],"mappings":";;;AAAA,kCAA+C;AAE/C;;;;;;;;;GASG;AACI,MAAM,WAAW,GAAG,CACzB,WAAmB,EACnB,gBAA2B,EAC3B,MAAkB,EAClB,SAAiB,EACX,EAAE;IACR,MAAM,iBAAiB,GAAG,gBAAgB,CAAC,MAAM,CAC/C,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC,EAAE,EAAE,CAAC,EACzC,eAAS,CAAC,OAAO,CAAC,SAAS,EAAE,KAAK,CAAC,CACpC,CAAA;IAED,IAAI,CAAC,iBAAiB;QAAE,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAA;AAC/D,CAAC,CAAA;AAZY,QAAA,WAAW,eAYvB"}