@bsv/overlay-discovery-services 2.0.1 → 2.0.2

package/dist/esm/src/LegacyNinjaAdvertiser.js

@@ -0,0 +1,233 @@
+import pushdrop from 'pushdrop';
+import { Ninja } from 'ninja-base';
+import { toBEEFfromEnvelope } from '@babbage/sdk-ts';
+import { Transaction, PublicKey, PrivateKey } from '@bsv/sdk';
+import { getPaymentPrivateKey } from 'sendover';
+import { toEnvelopeFromBEEF } from '@babbage/sdk-ts/out/src/utils/toBEEF.js';
+const AD_TOKEN_VALUE = 1;
+// TODO: Add 'implements Advertiser' back, once Advertiser can be properly imported from Overlay Services.
+/**
+ * Implements the Advertiser interface for managing SHIP and SLAP advertisements using a Ninja.
+ */
+export class LegacyNinjaAdvertiser {
+    privateKey;
+    dojoURL;
+    hostingDomain;
+    ninja;
+    engine;
+    /**
+     * 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({
+            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 = PublicKey.fromPrivateKey(new 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 = getPaymentPrivateKey({
+                recipientPrivateKey: this.privateKey,
+                senderPublicKey: identityKey,
+                invoiceNumber: `2-${ad.protocol}-1`,
+                returnType: 'hex'
+            });
+            const lockingScript = await pushdrop.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 = 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 = 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 = Transaction.fromBEEF(advertisement.beef);
+            const adTxid = advertisementTx.id('hex');
+            const outputToRedeem = advertisementTx.outputs[advertisement.outputIndex];
+            const identityKey = PublicKey.fromPrivateKey(new PrivateKey(this.privateKey, 'hex')).toString();
+            // Derive a unlocking private key using BRC-42 derivation scheme
+            const derivedPrivateKey = getPaymentPrivateKey({
+                recipientPrivateKey: this.privateKey,
+                senderPublicKey: identityKey,
+                invoiceNumber: `2-${advertisement.protocol}-1`,
+                returnType: 'hex'
+            });
+            const unlockingScript = await pushdrop.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] = {
+                    ...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 = 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.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!');
+        }
+    }
+}
+//# sourceMappingURL=LegacyNinjaAdvertiser.js.map

package/dist/esm/src/LegacyNinjaAdvertiser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LegacyNinjaAdvertiser.js","sourceRoot":"","sources":["../../../src/LegacyNinjaAdvertiser.ts"],"names":[],"mappings":"AACA,OAAO,QAAQ,MAAM,UAAU,CAAA;AAC/B,OAAO,EAAE,KAAK,EAAoB,MAAM,YAAY,CAAA;AACpD,OAAO,EAAuB,kBAAkB,EAAE,MAAM,iBAAiB,CAAA;AACzE,OAAO,EAAE,WAAW,EAAU,SAAS,EAAE,UAAU,EAAE,MAAM,UAAU,CAAA;AAErE,OAAO,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAA;AAE/C,OAAO,EAAE,kBAAkB,EAAE,MAAM,yCAAyC,CAAA;AAE5E,MAAM,cAAc,GAAG,CAAC,CAAA;AAExB,0GAA0G;AAE1G;;GAEG;AACH,MAAM,OAAO,qBAAqB;IAWvB;IACA;IACA;IAZQ,KAAK,CAAO;IACrB,MAAM,CAAoB;IAElC;;;;;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,KAAK,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,SAAS,CAAC,cAAc,CAAC,IAAI,UAAU,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,oBAAoB,CAAC;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,QAAQ,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,kBAAkB,CAAC;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,WAAW,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,WAAW,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,SAAS,CAAC,cAAc,CAAC,IAAI,UAAU,CAAC,IAAI,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAA;YAE/F,gEAAgE;YAChE,MAAM,iBAAiB,GAAG,oBAAoB,CAAC;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,QAAQ,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,kBAAkB,CAAC,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,kBAAkB,CAAC;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,QAAQ,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"}

package/dist/esm/src/utils/generateDocs.js

@@ -0,0 +1,46 @@
+import { exec } from 'child_process';
+import { promisify } from 'util';
+import * as path from 'path';
+const execPromise = promisify(exec);
+const docs = [
+    {
+        input: './src/SHIP/SHIPTopicManager.ts',
+        output: './docs/SHIP/ship-topic-manager.md'
+    },
+    {
+        input: './src/SHIP/SHIPLookupService.ts',
+        output: './docs/SHIP/ship-lookup-service.md'
+    },
+    {
+        input: './src/SHIP/SHIPStorage.ts',
+        output: './docs/SHIP/ship-storage.md'
+    },
+    {
+        input: './src/SLAP/SLAPTopicManager.ts',
+        output: './docs/SLAP/slap-topic-manager.md'
+    },
+    {
+        input: './src/SLAP/SLAPLookupService.ts',
+        output: './docs/SLAP/slap-lookup-service.md'
+    },
+    {
+        input: './src/SLAP/SLAPStorage.ts',
+        output: './docs/SLAP/slap-storage.md'
+    }
+];
+// Helper function for generating updated documentation
+const generateDocs = async () => {
+    for (const doc of docs) {
+        const command = `npx ts2md --inputFilename ${path.resolve(doc.input)} --outputFilename ${path.resolve(doc.output)} --firstHeadingLevel 2 --noTitle true --readmeMerge true`;
+        try {
+            const { stdout, stderr } = await execPromise(command);
+            console.log(`stdout: ${stdout}`);
+            console.error(`stderr: ${stderr}`);
+        }
+        catch (error) {
+            console.error(`Error generating documentation for ${doc.input}:`, error);
+        }
+    }
+};
+generateDocs().then(() => console.log('Documentation generation complete')).catch(error => console.error('Error:', error));
+//# sourceMappingURL=generateDocs.js.map

package/dist/esm/src/utils/generateDocs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generateDocs.js","sourceRoot":"","sources":["../../../../src/utils/generateDocs.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,eAAe,CAAA;AACpC,OAAO,EAAE,SAAS,EAAE,MAAM,MAAM,CAAA;AAChC,OAAO,KAAK,IAAI,MAAM,MAAM,CAAA;AAE5B,MAAM,WAAW,GAAG,SAAS,CAAC,IAAI,CAAC,CAAA;AAOnC,MAAM,IAAI,GAAgB;IACxB;QACE,KAAK,EAAE,gCAAgC;QACvC,MAAM,EAAE,mCAAmC;KAC5C;IACD;QACE,KAAK,EAAE,iCAAiC;QACxC,MAAM,EAAE,oCAAoC;KAC7C;IACD;QACE,KAAK,EAAE,2BAA2B;QAClC,MAAM,EAAE,6BAA6B;KACtC;IACD;QACE,KAAK,EAAE,gCAAgC;QACvC,MAAM,EAAE,mCAAmC;KAC5C;IACD;QACE,KAAK,EAAE,iCAAiC;QACxC,MAAM,EAAE,oCAAoC;KAC7C;IACD;QACE,KAAK,EAAE,2BAA2B;QAClC,MAAM,EAAE,6BAA6B;KACtC;CACF,CAAA;AAED,uDAAuD;AACvD,MAAM,YAAY,GAAG,KAAK,IAAI,EAAE;IAC9B,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,MAAM,OAAO,GAAG,6BAA6B,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,qBAAqB,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,0DAA0D,CAAA;QAC3K,IAAI,CAAC;YACH,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,WAAW,CAAC,OAAO,CAAC,CAAA;YACrD,OAAO,CAAC,GAAG,CAAC,WAAW,MAAM,EAAE,CAAC,CAAA;YAChC,OAAO,CAAC,KAAK,CAAC,WAAW,MAAM,EAAE,CAAC,CAAA;QACpC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,KAAK,CAAC,sCAAsC,GAAG,CAAC,KAAK,GAAG,EAAE,KAAK,CAAC,CAAA;QAC1E,CAAC;IACH,CAAC;AACH,CAAC,CAAA;AAED,YAAY,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,mCAAmC,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAA"}

package/dist/esm/src/utils/getDocumentation.js

@@ -0,0 +1,20 @@
+import { promises as fs } from 'fs';
+import { resolve, dirname } from 'path';
+/**
+ * Returns documentation specific to the provided filename
+ * @param {string} filePath - The path of the markdown file
+ * @returns A promise that resolves to the documentation string
+ */
+async function getDocumentation(filePath) {
+    try {
+        const resolvedPath = resolve(dirname(require.resolve('@bsv/overlay-discovery-services')), '../../', filePath);
+        const data = await fs.readFile(resolvedPath, 'utf-8');
+        return data;
+    }
+    catch (error) {
+        console.error('Error reading documentation file:', error);
+        throw new Error('Failed to read documentation file');
+    }
+}
+export { getDocumentation };
+//# sourceMappingURL=getDocumentation.js.map

package/dist/esm/src/utils/getDocumentation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getDocumentation.js","sourceRoot":"","sources":["../../../../src/utils/getDocumentation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,IAAI,EAAE,EAAE,MAAM,IAAI,CAAA;AACnC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAA;AACvC;;;;GAIG;AACH,KAAK,UAAU,gBAAgB,CAAC,QAAgB;IAC9C,IAAI,CAAC;QACH,MAAM,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,iCAAiC,CAAC,CAAC,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAA;QAC7G,MAAM,IAAI,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,YAAY,EAAE,OAAO,CAAC,CAAA;QACrD,OAAO,IAAI,CAAA;IACb,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,KAAK,CAAC,mCAAmC,EAAE,KAAK,CAAC,CAAA;QACzD,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAA;IACtD,CAAC;AACH,CAAC;AAED,OAAO,EAAE,gBAAgB,EAAE,CAAA"}

package/dist/esm/src/utils/isValidDomain.js

@@ -0,0 +1,11 @@
+/**
+ * Validates if the provided domain name is valid.
+ * @param domain - The domain name to validate.
+ * @returns True if the domain name is valid, false otherwise.
+ */
+export const isValidDomain = (domain) => {
+    // Simple regex to validate domain name
+    const domainRegex = /^(https?:\/\/)?((([a-zA-Z0-9-]+)\.)+([a-zA-Z]{2,})|localhost(:[0-9]+))(\/.*)?$/;
+    return domainRegex.test(domain);
+};
+//# sourceMappingURL=isValidDomain.js.map

package/dist/esm/src/utils/isValidDomain.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"isValidDomain.js","sourceRoot":"","sources":["../../../../src/utils/isValidDomain.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,MAAc,EAAW,EAAE;IACvD,uCAAuC;IACvC,MAAM,WAAW,GAAG,gFAAgF,CAAA;IACpG,OAAO,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;AACjC,CAAC,CAAA"}

package/dist/esm/src/utils/isValidServiceName.js

@@ -0,0 +1,10 @@
+/**
+ * Validates if the provided service name is valid based on BRC-87 guidelines.
+ * @param service - The service name to validate.
+ * @returns True if the service name is valid, false otherwise.
+ */
+export const isValidServiceName = (service) => {
+    const serviceRegex = /^(?!_)(?!.*__)[a-z_]{1,50}(?<!_)$/;
+    return serviceRegex.test(service);
+};
+//# sourceMappingURL=isValidServiceName.js.map

package/dist/esm/src/utils/isValidServiceName.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"isValidServiceName.js","sourceRoot":"","sources":["../../../../src/utils/isValidServiceName.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,OAAe,EAAW,EAAE;IAC7D,MAAM,YAAY,GAAG,mCAAmC,CAAA;IACxD,OAAO,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;AACnC,CAAC,CAAA"}

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

@@ -0,0 +1,18 @@
+import { PublicKey, Signature } from '@bsv/sdk';
+/**
+ * Verifies the BRC-48 locking key and the signature.
+ * @private
+ * @param identityKey - The BRC-31 identity key of the advertiser.
+ * @param lockingPublicKey - The public key used in the output's locking script.
+ * @param fields - The fields of the token.
+ * @param signature - The signature over the token fields.
+ * @param protocolId - The protocol ID (e.g., 'SHIP' or 'SLAP').
+ * @throws Will throw an error if the locking key or signature is invalid.
+ */
+export const verifyToken = (identityKey, lockingPublicKey, fields, signature) => {
+    const pubKey = PublicKey.fromString(lockingPublicKey);
+    const hasValidSignature = pubKey.verify(Array.from(Buffer.concat(fields)), Signature.fromDER(signature, 'hex'));
+    if (!hasValidSignature)
+        throw new Error('Invalid signature!');
+};
+//# sourceMappingURL=verifyToken.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"verifyToken.js","sourceRoot":"","sources":["../../../../src/utils/verifyToken.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,UAAU,CAAA;AAE/C;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CACzB,WAAmB,EACnB,gBAAwB,EACxB,MAAgB,EAChB,SAAiB,EACX,EAAE;IACR,MAAM,MAAM,GAAG,SAAS,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,SAAS,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"}