@bsv/overlay-discovery-services 2.0.1 → 2.0.2

package/dist/types/src/LegacyNinjaAdvertiser.d.ts

@@ -0,0 +1,60 @@
+import { TaggedBEEF } from '@bsv/overlay';
+import { Script } from '@bsv/sdk';
+import { AdvertisementData } from '@bsv/overlay';
+import { Advertisement, Engine } from '@bsv/overlay';
+/**
+ * Implements the Advertiser interface for managing SHIP and SLAP advertisements using a Ninja.
+ */
+export declare class LegacyNinjaAdvertiser {
+    privateKey: string;
+    dojoURL: string;
+    hostingDomain: string;
+    private readonly ninja;
+    private 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: string, dojoURL: string, hostingDomain: string);
+    /**
+     * 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: Engine): void;
+    /**
+     * 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.
+     */
+    createAdvertisements(adsData: AdvertisementData[]): Promise<TaggedBEEF>;
+    /**
+     * 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.
+     */
+    findAllAdvertisements(protocol: 'SHIP' | 'SLAP'): Promise<Advertisement[]>;
+    /**
+     * 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.
+     */
+    revokeAdvertisements(advertisements: Advertisement[]): Promise<TaggedBEEF>;
+    /**
+     * 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: Script): Advertisement;
+}
+//# sourceMappingURL=LegacyNinjaAdvertiser.d.ts.map

package/dist/types/src/LegacyNinjaAdvertiser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"LegacyNinjaAdvertiser.d.ts","sourceRoot":"","sources":["../../../src/LegacyNinjaAdvertiser.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AAIzC,OAAO,EAAe,MAAM,EAAyB,MAAM,UAAU,CAAA;AACrE,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAEhD,OAAO,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM,cAAc,CAAA;AAOpD;;GAEG;AACH,qBAAa,qBAAqB;IAWvB,UAAU,EAAE,MAAM;IAClB,OAAO,EAAE,MAAM;IACf,aAAa,EAAE,MAAM;IAZ9B,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAO;IAC7B,OAAO,CAAC,MAAM,CAAoB;IAElC;;;;;OAKG;gBAEM,UAAU,EAAE,MAAM,EAClB,OAAO,EAAE,MAAM,EACf,aAAa,EAAE,MAAM;IAU9B;;;;;;;;OAQG;IACH,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAIrC;;;;;;;;OAQG;IACG,oBAAoB,CACxB,OAAO,EAAE,iBAAiB,EAAE,GAC3B,OAAO,CAAC,UAAU,CAAC;IA8CtB;;;;OAIG;IACG,qBAAqB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;IAiChF;;;;OAIG;IACG,oBAAoB,CAAC,cAAc,EAAE,aAAa,EAAE,GAAG,OAAO,CAAC,UAAU,CAAC;IAqEhF;;;;OAIG;IACH,kBAAkB,CAAC,YAAY,EAAE,MAAM,GAAG,aAAa;CAgCxD"}

package/dist/types/src/utils/generateDocs.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=generateDocs.d.ts.map

package/dist/types/src/utils/generateDocs.d.ts.map

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

package/dist/types/src/utils/getDocumentation.d.ts

@@ -0,0 +1,8 @@
+/**
+ * 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
+ */
+declare function getDocumentation(filePath: string): Promise<string>;
+export { getDocumentation };
+//# sourceMappingURL=getDocumentation.d.ts.map

package/dist/types/src/utils/getDocumentation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getDocumentation.d.ts","sourceRoot":"","sources":["../../../../src/utils/getDocumentation.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,iBAAe,gBAAgB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CASjE;AAED,OAAO,EAAE,gBAAgB,EAAE,CAAA"}

package/dist/types/src/utils/isValidDomain.d.ts

@@ -0,0 +1,7 @@
+/**
+ * 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 declare const isValidDomain: (domain: string) => boolean;
+//# sourceMappingURL=isValidDomain.d.ts.map

package/dist/types/src/utils/isValidDomain.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"isValidDomain.d.ts","sourceRoot":"","sources":["../../../../src/utils/isValidDomain.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,eAAO,MAAM,aAAa,WAAY,MAAM,KAAG,OAI9C,CAAA"}

package/dist/types/src/utils/isValidServiceName.d.ts

@@ -0,0 +1,7 @@
+/**
+ * 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 declare const isValidServiceName: (service: string) => boolean;
+//# sourceMappingURL=isValidServiceName.d.ts.map

package/dist/types/src/utils/isValidServiceName.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"isValidServiceName.d.ts","sourceRoot":"","sources":["../../../../src/utils/isValidServiceName.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,YAAa,MAAM,KAAG,OAGpD,CAAA"}

package/dist/types/src/utils/verifyToken.d.ts

@@ -0,0 +1,12 @@
+/**
+ * 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 declare const verifyToken: (identityKey: string, lockingPublicKey: string, fields: Buffer[], signature: string) => void;
+//# sourceMappingURL=verifyToken.d.ts.map

package/dist/types/src/utils/verifyToken.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"verifyToken.d.ts","sourceRoot":"","sources":["../../../../src/utils/verifyToken.ts"],"names":[],"mappings":"AAEA;;;;;;;;;GASG;AACH,eAAO,MAAM,WAAW,gBACT,MAAM,oBACD,MAAM,UAChB,MAAM,EAAE,aACL,MAAM,KAChB,IAQF,CAAA"}