@bsv/overlay 2.2.1 → 2.3.0

package/dist/cjs/src/Advertiser.d.ts

@@ -0,0 +1,36 @@
+import { Script, TaggedBEEF } from '@bsv/sdk';
+import { Advertisement } from './Advertisement.js';
+export interface AdvertisementData {
+    protocol: 'SHIP' | 'SLAP';
+    topicOrServiceName: string;
+}
+/**
+ * Interface for managing SHIP and SLAP advertisements.
+ * Provides methods for creating, finding, and revoking advertisements.
+ */
+export interface Advertiser {
+    /**
+     * Creates a new SHIP/SLAP advertisement for a given topic.
+     * @param adsData - The data indicating the type of advertisement.
+     * @returns A promise that resolves to the created advertisement as TaggedBEEF.
+     */
+    createAdvertisements: (adsData: AdvertisementData[]) => Promise<TaggedBEEF>;
+    /**
+     * Finds all SHIP/SLAP advertisements.
+     * @returns A promise that resolves to an array of SHIP/SLAP advertisements.
+     */
+    findAllAdvertisements: (protocol: 'SHIP' | 'SLAP') => Promise<Advertisement[]>;
+    /**
+     * Revokes an existing advertisement, either SHIP or SLAP.
+     * @param advertisements - The advertisements to revoke, either SHIP or SLAP.
+     * @returns A promise that resolves to the revocation transaction as TaggedBEEF.
+     */
+    revokeAdvertisements: (advertisements: Advertisement[]) => Promise<TaggedBEEF>;
+    /**
+     * Parses an output script to extract an advertisement.
+     * @param outputScript - The script of the output to be parsed.
+     * @returns The parsed advertisement
+     */
+    parseAdvertisement: (outputScript: Script) => Advertisement;
+}
+//# sourceMappingURL=Advertiser.d.ts.map

package/dist/cjs/src/Advertiser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Advertiser.d.ts","sourceRoot":"","sources":["../../../src/Advertiser.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,UAAU,CAAA;AAC7C,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAA;AAElD,MAAM,WAAW,iBAAiB;IAChC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAA;IACzB,kBAAkB,EAAE,MAAM,CAAA;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;IAEzB;;;;OAIG;IACH,oBAAoB,EAAE,CAAC,OAAO,EAAE,iBAAiB,EAAE,KAAK,OAAO,CAAC,UAAU,CAAC,CAAA;IAE3E;;;OAGG;IACH,qBAAqB,EAAE,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,KAAK,OAAO,CAAC,aAAa,EAAE,CAAC,CAAA;IAE9E;;;;OAIG;IACH,oBAAoB,EAAE,CAAC,cAAc,EAAE,aAAa,EAAE,KAAK,OAAO,CAAC,UAAU,CAAC,CAAA;IAE9E;;;;OAIG;IACH,kBAAkB,EAAE,CAAC,YAAY,EAAE,MAAM,KAAK,aAAa,CAAA;CAC5D"}

package/dist/cjs/src/BASM.d.ts

@@ -0,0 +1,110 @@
+import { MerklePath } from '@bsv/sdk';
+export declare const BASM_ZERO_HASH = "0000000000000000000000000000000000000000000000000000000000000000";
+export interface TopicBlockAnchor {
+    topic: string;
+    blockHeight: number;
+    blockHash: string;
+    basmRoot: string;
+    admittedCount: number;
+    tac: string;
+}
+export interface TopicAnchorTip {
+    topic: string;
+    blockHeight: number;
+    blockHash?: string;
+    basmRoot?: string;
+    admittedCount?: number;
+    tac: string;
+}
+export interface AdmittedTxRef {
+    txid: string;
+    blockIndex: number;
+}
+export interface RawTransactionRecord {
+    txid: string;
+    rawTx: string;
+}
+export interface RawTransactionRequest {
+    txids: string[];
+}
+export interface RawTransactionResponse {
+    transactions: RawTransactionRecord[];
+    missing: string[];
+}
+export interface TopicAnchorHeader {
+    blockHeight: number;
+    blockHash: string;
+    merkleRoot?: string;
+}
+export type TopicAnchorHeaderResolver = (blockHeight: number) => Promise<TopicAnchorHeader | undefined>;
+export interface TopicAnchorRangeRequest {
+    fromHeight: number;
+    toHeight: number;
+}
+export interface TopicAnchorRangeResponse {
+    topic: string;
+    anchors: TopicBlockAnchor[];
+}
+export interface AdmittedListRequest {
+    blockHeight: number;
+    blockHash?: string;
+}
+export interface AdmittedListResponse {
+    topic: string;
+    blockHeight: number;
+    blockHash?: string;
+    admitted: AdmittedTxRef[];
+}
+export interface CompoundMerklePathRequest {
+    blockHeight: number;
+    txids: string[];
+}
+export interface CompoundMerklePathResponse {
+    topic: string;
+    blockHeight: number;
+    txids: string[];
+    merklePath: string;
+}
+export interface MerkleProofMetadata {
+    blockHeight: number;
+    blockIndex: number;
+    merkleRoot: string;
+}
+export interface ReorgReport {
+    perTopic: Array<{
+        topic: string;
+        demotedTxids: string[];
+        rebuiltFrom: number;
+        rebuiltTo: number;
+    }>;
+}
+export interface BASMPeerSyncReport {
+    topic: string;
+    endpoint: string;
+    status: 'matched' | 'advanced' | 'diverged' | 'skipped' | 'error';
+    localTip?: TopicAnchorTip;
+    remoteTip?: TopicAnchorTip;
+    checkedHeights: number[];
+    missingTxids: string[];
+    fetchedTxCount: number;
+    message?: string;
+}
+type AdmittedTxLike = string | AdmittedTxRef;
+/**
+ * Computes a BRC-136 BASM root from admitted topic txids.
+ *
+ * The API accepts normal display-order txid hex because that is what the BSV
+ * TypeScript stack exposes at its public boundaries. Hashing is performed on
+ * internal byte order as required by the BRC, and the returned root is display
+ * order for JSON/wire compatibility.
+ */
+export declare function computeBasmRoot(admitted: AdmittedTxLike[]): string;
+/**
+ * Computes the BRC-136 cumulative Topic Anchor Chain hash:
+ * SHA256d(prevTac || blockHash || basmRoot), with all inputs reversed to
+ * internal byte order before hashing and the output returned as display hex.
+ */
+export declare function computeTac(prevTac: string, blockHash: string, basmRoot: string): string;
+export declare function extractMerkleProofMetadata(txid: string, proof?: MerklePath): MerkleProofMetadata | undefined;
+export {};
+//# sourceMappingURL=BASM.d.ts.map

package/dist/cjs/src/BASM.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BASM.d.ts","sourceRoot":"","sources":["../../../src/BASM.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAA;AAErC,eAAO,MAAM,cAAc,qEAAqE,CAAA;AAEhG,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,MAAM,CAAA;IACb,WAAW,EAAE,MAAM,CAAA;IACnB,SAAS,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE,MAAM,CAAA;IAChB,aAAa,EAAE,MAAM,CAAA;IACrB,GAAG,EAAE,MAAM,CAAA;CACZ;AAED,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,MAAM,CAAA;IACb,WAAW,EAAE,MAAM,CAAA;IACnB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,GAAG,EAAE,MAAM,CAAA;CACZ;AAED,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,EAAE,MAAM,CAAA;CACnB;AAED,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,qBAAqB;IACpC,KAAK,EAAE,MAAM,EAAE,CAAA;CAChB;AAED,MAAM,WAAW,sBAAsB;IACrC,YAAY,EAAE,oBAAoB,EAAE,CAAA;IACpC,OAAO,EAAE,MAAM,EAAE,CAAA;CAClB;AAED,MAAM,WAAW,iBAAiB;IAChC,WAAW,EAAE,MAAM,CAAA;IACnB,SAAS,EAAE,MAAM,CAAA;IACjB,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED,MAAM,MAAM,yBAAyB,GAAG,CAAC,WAAW,EAAE,MAAM,KAAK,OAAO,CAAC,iBAAiB,GAAG,SAAS,CAAC,CAAA;AAEvG,MAAM,WAAW,uBAAuB;IACtC,UAAU,EAAE,MAAM,CAAA;IAClB,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED,MAAM,WAAW,wBAAwB;IACvC,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,gBAAgB,EAAE,CAAA;CAC5B;AAED,MAAM,WAAW,mBAAmB;IAClC,WAAW,EAAE,MAAM,CAAA;IACnB,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAED,MAAM,WAAW,oBAAoB;IACnC,KAAK,EAAE,MAAM,CAAA;IACb,WAAW,EAAE,MAAM,CAAA;IACnB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,QAAQ,EAAE,aAAa,EAAE,CAAA;CAC1B;AAED,MAAM,WAAW,yBAAyB;IACxC,WAAW,EAAE,MAAM,CAAA;IACnB,KAAK,EAAE,MAAM,EAAE,CAAA;CAChB;AAED,MAAM,WAAW,0BAA0B;IACzC,KAAK,EAAE,MAAM,CAAA;IACb,WAAW,EAAE,MAAM,CAAA;IACnB,KAAK,EAAE,MAAM,EAAE,CAAA;IACf,UAAU,EAAE,MAAM,CAAA;CACnB;AAED,MAAM,WAAW,mBAAmB;IAClC,WAAW,EAAE,MAAM,CAAA;IACnB,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,CAAA;CACnB;AAED,MAAM,WAAW,WAAW;IAC1B,QAAQ,EAAE,KAAK,CAAC;QACd,KAAK,EAAE,MAAM,CAAA;QACb,YAAY,EAAE,MAAM,EAAE,CAAA;QACtB,WAAW,EAAE,MAAM,CAAA;QACnB,SAAS,EAAE,MAAM,CAAA;KAClB,CAAC,CAAA;CACH;AAED,MAAM,WAAW,kBAAkB;IACjC,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,EAAE,SAAS,GAAG,UAAU,GAAG,UAAU,GAAG,SAAS,GAAG,OAAO,CAAA;IACjE,QAAQ,CAAC,EAAE,cAAc,CAAA;IACzB,SAAS,CAAC,EAAE,cAAc,CAAA;IAC1B,cAAc,EAAE,MAAM,EAAE,CAAA;IACxB,YAAY,EAAE,MAAM,EAAE,CAAA;IACtB,cAAc,EAAE,MAAM,CAAA;IACtB,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED,KAAK,cAAc,GAAG,MAAM,GAAG,aAAa,CAAA;AAkC5C;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAAC,QAAQ,EAAE,cAAc,EAAE,GAAG,MAAM,CAuBlE;AAED;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,CAOvF;AAED,wBAAgB,0BAA0B,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,UAAU,GAAG,mBAAmB,GAAG,SAAS,CAe5G"}

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

@@ -1 +1 @@
-{"version":3,"file":"BASM.js","sourceRoot":"","sources":["../../../src/BASM.ts"],"names":[],"mappings":";;;AAyJA,0CAuBC;AAOD,gCAOC;AAED,gEAeC;AA/MD,6CAAwC;AAG3B,QAAA,cAAc,GAAG,kEAAkE,CAAA;AA8GhG,SAAS,OAAO,CAAC,MAAc;IAC7B,MAAM,KAAK,GAAG,IAAA,wBAAU,EAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,CAAA;IAC1D,OAAO,IAAA,wBAAU,EAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,CAAA;AACpD,CAAC;AAED,SAAS,aAAa,CAAC,IAAY,EAAE,KAAa;IAChD,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QACpC,MAAM,IAAI,KAAK,CAAC,GAAG,KAAK,0BAA0B,CAAC,CAAA;IACrD,CAAC;AACH,CAAC;AAED,SAAS,oBAAoB,CAAC,IAAY;IACxC,aAAa,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;IAC3B,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,OAAO,EAAE,CAAA;AAC3C,CAAC;AAED,SAAS,oBAAoB,CAAC,IAAY;IACxC,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAA;AACpD,CAAC;AAED,SAAS,sBAAsB,CAAC,QAA0B;IACxD,OAAO,QAAQ;SACZ,GAAG,CAAC,CAAC,IAAI,EAAE,aAAa,EAAE,EAAE;QAC3B,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC7B,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,UAAU,EAAE,aAAa,EAAE,CAAA;QAClD,CAAC;QACD,OAAO,IAAI,CAAA;IACb,CAAC,CAAC;SACD,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,GAAG,CAAC,CAAC,UAAU,CAAC;SAC3C,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAA;AACzC,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,eAAe,CAAC,QAA0B;IACxD,MAAM,KAAK,GAAG,sBAAsB,CAAC,QAAQ,CAAC,CAAA;IAE9C,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACvB,OAAO,sBAAc,CAAA;IACvB,CAAC;IAED,IAAI,KAAK,GAAG,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC,CAAA;IACzD,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACvB,OAAO,oBAAoB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;IACvC,CAAC;IAED,OAAO,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACxB,MAAM,IAAI,GAAa,EAAE,CAAA;QACzB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;YACzC,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAA;YACrB,MAAM,KAAK,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAA;YACxD,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;QAClD,CAAC;QACD,KAAK,GAAG,IAAI,CAAA;IACd,CAAC;IAED,OAAO,oBAAoB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;AACvC,CAAC;AAED;;;;GAIG;AACH,SAAgB,UAAU,CAAC,OAAe,EAAE,SAAiB,EAAE,QAAgB;IAC7E,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC;QAC1B,oBAAoB,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC;QAC3C,oBAAoB,CAAC,SAAS,CAAC,WAAW,EAAE,CAAC;QAC7C,oBAAoB,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC;KAC7C,CAAC,CAAA;IACF,OAAO,oBAAoB,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAA;AAC7C,CAAC;AAED,SAAgB,0BAA0B,CAAC,IAAY,EAAE,KAAkB;;IACzE,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACxB,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,MAAM,IAAI,GAAG,MAAA,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,0CAAE,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,SAAS,CAAC,IAAI,KAAK,IAAI,CAAC,CAAA;IACtE,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACvB,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,OAAO;QACL,WAAW,EAAE,KAAK,CAAC,WAAW;QAC9B,UAAU,EAAE,IAAI,CAAC,MAAM;QACvB,UAAU,EAAE,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC;KACpC,CAAA;AACH,CAAC"}
+{"version":3,"file":"BASM.js","sourceRoot":"","sources":["../../../src/BASM.ts"],"names":[],"mappings":";;;;;;AAAA,6CAAwC;AAG3B,QAAA,cAAc,GAAG,kEAAkE,CAAA;AA8GhG,SAAS,OAAO,CAAC,MAAc;IAC7B,MAAM,KAAK,GAAG,IAAA,wBAAU,EAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,CAAA;IAC1D,OAAO,IAAA,wBAAU,EAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,CAAA;AACpD,CAAC;AAED,SAAS,aAAa,CAAC,IAAY,EAAE,KAAa;IAChD,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QACpC,MAAM,IAAI,KAAK,CAAC,GAAG,KAAK,0BAA0B,CAAC,CAAA;IACrD,CAAC;AACH,CAAC;AAED,SAAS,oBAAoB,CAAC,IAAY;IACxC,aAAa,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;IAC3B,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,OAAO,EAAE,CAAA;AAC3C,CAAC;AAED,SAAS,oBAAoB,CAAC,IAAY;IACxC,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAA;AACpD,CAAC;AAED,SAAS,sBAAsB,CAAC,QAA0B;IACxD,OAAO,QAAQ;SACZ,GAAG,CAAC,CAAC,IAAI,EAAE,aAAa,EAAE,EAAE;QAC3B,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC7B,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,UAAU,EAAE,aAAa,EAAE,CAAA;QAClD,CAAC;QACD,OAAO,IAAI,CAAA;IACb,CAAC,CAAC;SACD,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,GAAG,CAAC,CAAC,UAAU,CAAC;SAC3C,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAA;AACzC,CAAC;AAED;;;;;;;GAOG;AACH,yBAAgC,QAA0B;IACxD,MAAM,KAAK,GAAG,sBAAsB,CAAC,QAAQ,CAAC,CAAA;IAE9C,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACvB,OAAO,QAAA,cAAc,CAAA;IACvB,CAAC;IAED,IAAI,KAAK,GAAG,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC,CAAA;IACzD,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACvB,OAAO,oBAAoB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;IACvC,CAAC;IAED,OAAO,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACxB,MAAM,IAAI,GAAa,EAAE,CAAA;QACzB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;YACzC,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAA;YACrB,MAAM,KAAK,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAA;YACxD,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;QAClD,CAAC;QACD,KAAK,GAAG,IAAI,CAAA;IACd,CAAC;IAED,OAAO,oBAAoB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;AACvC,CAAC;AAED;;;;GAIG;AACH,oBAA2B,OAAe,EAAE,SAAiB,EAAE,QAAgB;IAC7E,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC;QAC1B,oBAAoB,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC;QAC3C,oBAAoB,CAAC,SAAS,CAAC,WAAW,EAAE,CAAC;QAC7C,oBAAoB,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC;KAC7C,CAAC,CAAA;IACF,OAAO,oBAAoB,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAA;AAC7C,CAAC;AAED,oCAA2C,IAAY,EAAE,KAAkB;;IACzE,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACxB,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,MAAM,IAAI,GAAG,MAAA,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,0CAAE,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,SAAS,CAAC,IAAI,KAAK,IAAI,CAAC,CAAA;IACtE,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACvB,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,OAAO;QACL,WAAW,EAAE,KAAK,CAAC,WAAW;QAC9B,UAAU,EAAE,IAAI,CAAC,MAAM;QACvB,UAAU,EAAE,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC;KACpC,CAAA;AACH,CAAC"}

package/dist/cjs/src/BASMRemote.d.ts

@@ -0,0 +1,14 @@
+import type { AdmittedListResponse, CompoundMerklePathResponse, RawTransactionResponse, TopicAnchorRangeResponse, TopicAnchorTip } from './BASM.js';
+export declare class BASMRemote {
+    private readonly endpoint;
+    private readonly topic;
+    private readonly fetchImpl;
+    constructor(endpoint: string, topic: string, fetchImpl?: typeof fetch);
+    requestTopicAnchorTip(): Promise<TopicAnchorTip>;
+    requestTopicAnchorRange(fromHeight: number, toHeight: number): Promise<TopicAnchorRangeResponse>;
+    requestAdmittedList(blockHeight: number, blockHash?: string): Promise<AdmittedListResponse>;
+    requestCompoundMerklePath(blockHeight: number, txids: string[]): Promise<CompoundMerklePathResponse>;
+    requestRawTransactions(txids: string[]): Promise<RawTransactionResponse>;
+    private post;
+}
+//# sourceMappingURL=BASMRemote.d.ts.map

package/dist/cjs/src/BASMRemote.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BASMRemote.d.ts","sourceRoot":"","sources":["../../../src/BASMRemote.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,oBAAoB,EACpB,0BAA0B,EAC1B,sBAAsB,EACtB,wBAAwB,EACxB,cAAc,EACf,MAAM,WAAW,CAAA;AAElB,qBAAa,UAAU;IAEnB,OAAO,CAAC,QAAQ,CAAC,QAAQ;IACzB,OAAO,CAAC,QAAQ,CAAC,KAAK;IACtB,OAAO,CAAC,QAAQ,CAAC,SAAS;IAH5B,YACmB,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,MAAM,EACb,SAAS,GAAE,OAAO,KAA8B,EAC9D;IAEC,qBAAqB,IAAI,OAAO,CAAC,cAAc,CAAC,CAErD;IAEK,uBAAuB,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC,CAErG;IAEK,mBAAmB,CAAC,WAAW,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAEhG;IAEK,yBAAyB,CAAC,WAAW,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,0BAA0B,CAAC,CAEzG;IAEK,sBAAsB,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAE7E;YAEa,IAAI;CAkBnB"}

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

@@ -1 +1 @@
-{"version":3,"file":"BASMRemote.js","sourceRoot":"","sources":["../../../src/BASMRemote.ts"],"names":[],"mappings":";;;AAQA,MAAa,UAAU;IACrB,YACmB,QAAgB,EAChB,KAAa,EACb,YAA0B,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC;QAFhD,aAAQ,GAAR,QAAQ,CAAQ;QAChB,UAAK,GAAL,KAAK,CAAQ;QACb,cAAS,GAAT,SAAS,CAAuC;IAC/D,CAAC;IAEL,KAAK,CAAC,qBAAqB;QACzB,OAAO,MAAM,IAAI,CAAC,IAAI,CAAiB,wBAAwB,EAAE,EAAE,CAAC,CAAA;IACtE,CAAC;IAED,KAAK,CAAC,uBAAuB,CAAC,UAAkB,EAAE,QAAgB;QAChE,OAAO,MAAM,IAAI,CAAC,IAAI,CAA2B,0BAA0B,EAAE,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC,CAAA;IACxG,CAAC;IAED,KAAK,CAAC,mBAAmB,CAAC,WAAmB,EAAE,SAAkB;QAC/D,OAAO,MAAM,IAAI,CAAC,IAAI,CAAuB,sBAAsB,EAAE,EAAE,WAAW,EAAE,SAAS,EAAE,CAAC,CAAA;IAClG,CAAC;IAED,KAAK,CAAC,yBAAyB,CAAC,WAAmB,EAAE,KAAe;QAClE,OAAO,MAAM,IAAI,CAAC,IAAI,CAA6B,4BAA4B,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC,CAAA;IAC1G,CAAC;IAED,KAAK,CAAC,sBAAsB,CAAC,KAAe;QAC1C,OAAO,MAAM,IAAI,CAAC,IAAI,CAAyB,yBAAyB,EAAE,EAAE,KAAK,EAAE,CAAC,CAAA;IACtF,CAAC;IAEO,KAAK,CAAC,IAAI,CAAI,IAAY,EAAE,IAAa;QAC/C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,QAAQ,EAAE,EAAE;YAC7E,MAAM,EAAE,MAAM;YACd,OAAO,EAAE;gBACP,MAAM,EAAE,kBAAkB;gBAC1B,cAAc,EAAE,kBAAkB;gBAClC,aAAa,EAAE,IAAI,CAAC,KAAK;aAC1B;YACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;SAC3B,CAAC,CAAA;QAEF,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAA;QAClC,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,aAAa,IAAI,CAAC,QAAQ,aAAa,QAAQ,CAAC,MAAM,KAAK,IAAI,EAAE,CAAC,CAAA;QACpF,CAAC;QAED,OAAO,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAM,CAAA;IACzD,CAAC;CACF;AA7CD,gCA6CC"}
+{"version":3,"file":"BASMRemote.js","sourceRoot":"","sources":["../../../src/BASMRemote.ts"],"names":[],"mappings":";;;AAQA;IACE,YACmB,QAAgB,EAChB,KAAa,EACb,SAAS,GAAiB,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC;wBAFhD,QAAQ;qBACR,KAAK;yBACL,SAAS;IACxB,CAAC;IAEL,KAAK,CAAC,qBAAqB;QACzB,OAAO,MAAM,IAAI,CAAC,IAAI,CAAiB,wBAAwB,EAAE,EAAE,CAAC,CAAA;IACtE,CAAC;IAED,KAAK,CAAC,uBAAuB,CAAC,UAAkB,EAAE,QAAgB;QAChE,OAAO,MAAM,IAAI,CAAC,IAAI,CAA2B,0BAA0B,EAAE,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC,CAAA;IACxG,CAAC;IAED,KAAK,CAAC,mBAAmB,CAAC,WAAmB,EAAE,SAAkB;QAC/D,OAAO,MAAM,IAAI,CAAC,IAAI,CAAuB,sBAAsB,EAAE,EAAE,WAAW,EAAE,SAAS,EAAE,CAAC,CAAA;IAClG,CAAC;IAED,KAAK,CAAC,yBAAyB,CAAC,WAAmB,EAAE,KAAe;QAClE,OAAO,MAAM,IAAI,CAAC,IAAI,CAA6B,4BAA4B,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC,CAAA;IAC1G,CAAC;IAED,KAAK,CAAC,sBAAsB,CAAC,KAAe;QAC1C,OAAO,MAAM,IAAI,CAAC,IAAI,CAAyB,yBAAyB,EAAE,EAAE,KAAK,EAAE,CAAC,CAAA;IACtF,CAAC;IAEO,KAAK,CAAC,IAAI,CAAI,IAAY,EAAE,IAAa;QAC/C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,QAAQ,EAAE,EAAE;YAC7E,MAAM,EAAE,MAAM;YACd,OAAO,EAAE;gBACP,MAAM,EAAE,kBAAkB;gBAC1B,cAAc,EAAE,kBAAkB;gBAClC,aAAa,EAAE,IAAI,CAAC,KAAK;aAC1B;YACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;SAC3B,CAAC,CAAA;QAEF,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAA;QAClC,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,aAAa,IAAI,CAAC,QAAQ,aAAa,QAAQ,CAAC,MAAM,KAAK,IAAI,EAAE,CAAC,CAAA;QACpF,CAAC;QAED,OAAO,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAM,CAAA;IACzD,CAAC;CACF"}

package/dist/cjs/src/Engine.d.ts

@@ -0,0 +1,379 @@
+import { TopicManager } from './TopicManager.js';
+import { LookupService } from './LookupService.js';
+import { Storage } from './storage/Storage.js';
+import type { Output } from './Output.js';
+import { ChainTracker, MerklePath, Broadcaster, TaggedBEEF, STEAK, LookupQuestion, LookupAnswer, OverlayBroadcastFacilitator } from '@bsv/sdk';
+import { Advertiser } from './Advertiser.js';
+import { GASPInitialRequest, GASPInitialResponse, GASPNode } from '@bsv/gasp';
+import { SyncConfiguration } from './SyncConfiguration.js';
+import { type AdmittedListResponse, type BASMPeerSyncReport, type CompoundMerklePathResponse, type RawTransactionResponse, type ReorgReport, type TopicAnchorHeaderResolver, type TopicAnchorRangeResponse, type TopicAnchorTip } from './BASM.js';
+type UTXOHistoryHydrationContext = {
+    outputCache: Map<string, Promise<Output | null>>;
+};
+/**
+ * An engine for running BSV Overlay Services (topic managers and lookup services).
+ */
+export declare class Engine {
+    managers: {
+        [key: string]: TopicManager;
+    };
+    lookupServices: {
+        [key: string]: LookupService;
+    };
+    storage: Storage;
+    chainTracker: ChainTracker | 'scripts only';
+    hostingURL?: string | undefined;
+    shipTrackers?: string[] | undefined;
+    slapTrackers?: string[] | undefined;
+    broadcaster?: Broadcaster | undefined;
+    advertiser?: Advertiser | undefined;
+    syncConfiguration?: SyncConfiguration | undefined;
+    logTime: boolean;
+    logPrefix: string;
+    throwOnBroadcastFailure: boolean;
+    overlayBroadcastFacilitator: OverlayBroadcastFacilitator;
+    logger: typeof console;
+    suppressDefaultSyncAdvertisements: boolean;
+    topicAnchorHeaderResolver?: TopicAnchorHeaderResolver | undefined;
+    basmSyncEnabled: boolean;
+    unprovenEvictionBlocks: number;
+    maxLookupResults: number;
+    /**
+     * Creates a new Overlay Services Engine
+     * @param {[key: string]: TopicManager} managers - manages topic admittance
+     * @param {[key: string]: LookupService} lookupServices - manages UTXO lookups
+     * @param {Storage} storage - for interacting with internally-managed persistent data
+     * @param {ChainTracker | 'scripts only'} chainTracker - Verifies SPV data associated with transactions
+     * @param {string} [hostingURL] - The URL this engine is hosted at. Required if going to support peer-discovery with an advertiser.
+     * @param {Broadcaster} [Broadcaster] - broadcaster used for broadcasting the incoming transaction
+     * @param {Advertiser} [Advertiser] - handles SHIP and SLAP advertisements for peer-discovery
+     * @param {string[]} shipTrackers - SHIP domains we know to bootstrap the system
+     * @param {string[]} slapTrackers - SLAP domains we know to bootstrap the system
+     * @param {SyncConfiguration} syncConfiguration — Configuration object describing historical synchronization of topics.
+     * @param {boolean} logTime - Enables / disables the timing logs for various operations in the Overlay submit route.
+     * @param {string} logPrefix - Supports overriding the log prefix with a custom string.
+     * @param {boolean} throwOnBroadcastFailure - Enables / disables throwing an error when a transaction broadcast failure is detected.
+     * @param {OverlayBroadcastFacilitator} overlayBroadcastFacilitator - Facilitator for propagation to other Overlay Services.
+     * @param {typeof console} logger - The place where log entries are written.
+     * @param {boolean} suppressDefaultSyncAdvertisements - Whether to suppress the default (SHIP/SLAP) sync advertisements.
+     * @param {TopicAnchorHeaderResolver} topicAnchorHeaderResolver - Resolves block hashes for BASM anchors.
+     * @param {boolean} basmSyncEnabled - Whether BASM sync should run automatically.
+     * @param {number} unprovenEvictionBlocks - Default block age for opt-in unproven state eviction.
+     * @param {number} maxLookupResults - Maximum lookup formulas hydrated per request. Use -1 to opt out.
+     */
+    constructor(managers: {
+        [key: string]: TopicManager;
+    }, lookupServices: {
+        [key: string]: LookupService;
+    }, storage: Storage, chainTracker: ChainTracker | 'scripts only', hostingURL?: string | undefined, shipTrackers?: string[] | undefined, slapTrackers?: string[] | undefined, broadcaster?: Broadcaster | undefined, advertiser?: Advertiser | undefined, syncConfiguration?: SyncConfiguration | undefined, logTime?: boolean, logPrefix?: string, throwOnBroadcastFailure?: boolean, overlayBroadcastFacilitator?: OverlayBroadcastFacilitator, logger?: typeof console, suppressDefaultSyncAdvertisements?: boolean, topicAnchorHeaderResolver?: TopicAnchorHeaderResolver | undefined, basmSyncEnabled?: boolean, unprovenEvictionBlocks?: number, maxLookupResults?: number);
+    private startTime;
+    private endTime;
+    private currentHeightOrUndefined;
+    private resolveBlockHash;
+    private compactBEEFForStorage;
+    private recordTransactionData;
+    private buildAppliedTransactionRecord;
+    private recomputeTopicBlockAnchor;
+    /**
+     * Extends every configured topic's anchor chain forward with empty Topic Block
+     * Anchors (basmRoot = zero hash, admittedCount = 0) up to `toHeight`, so the
+     * cumulative TAC advances on every block even when a topic admits nothing —
+     * this is what lets a peer authoritatively confirm "this block contained no
+     * transactions for this topic". Chains with no first admission yet are left
+     * unstarted (genesis is the topic's first admitted height).
+     */
+    advanceTopicAnchorChains(toHeight?: number): Promise<void>;
+    /**
+     * Rebuilds a contiguous slice of a topic's anchor chain over [fromHeight,
+     * toHeight]. Each height uses its admitted transactions (empty -> zero basmRoot)
+     * and chains the cumulative TAC from the prior height. Missing heights are
+     * filled rather than skipped, so the chain stays gap-free. If a block hash
+     * cannot be resolved for some height the extension halts there to preserve
+     * contiguity instead of leaving a hole.
+     */
+    private rebuildTopicAnchorChain;
+    /**
+     * Reconciles BASM anchors with a blockchain reorganization reported by the
+     * chain tracker (e.g. go-chaintracks `/v2/reorg/stream`). Proven topic
+     * transactions whose block was orphaned are demoted to unproven so they leave
+     * the admitted set, then every topic anchor chain intersecting the affected
+     * height range is rebuilt over the canonical block hashes. A reorg changes the
+     * canonical block hash for the affected heights, so topics with no demoted
+     * transaction are rebuilt too. Idempotent: a clean window demotes nothing and
+     * reproduces an identical TAC, so this is safe to invoke on every reorg event,
+     * SSE reconnect, and poll.
+     */
+    handleReorg(input: {
+        orphanedBlockHashes: string[];
+        rebuildFromHeight: number;
+        newTipHeight: number;
+    }): Promise<ReorgReport>;
+    /**
+     * Revalidation sweep: the reorg fallback for chain trackers without a reorg
+     * event stream, and the catch-up step on every reorg-SSE (re)connect (the
+     * go-chaintracks reorg stream carries no event ids, so a reconnect cannot
+     * replay events missed while disconnected). Scans proven applied transactions
+     * in `[tip - depth + 1, tip]`; any whose proof root no longer validates against
+     * the chain tracker, or whose block hash diverges from the canonical header, is
+     * treated as orphaned and reconciled via {@link handleReorg}.
+     */
+    private isProvenAnchorStale;
+    revalidateRecentAnchors(depth?: number): Promise<ReorgReport | undefined>;
+    private validateTopicSubmission;
+    private isTopicSubmissionAccepted;
+    private broadcastAcceptedSubmission;
+    private notifyOutputSpent;
+    private markPreviousOutputSpent;
+    private markPreviousOutputsSpent;
+    private classifyPreviousCoins;
+    private removeStaleOutputs;
+    private notifyOutputAdmitted;
+    private admitOutput;
+    private updateConsumedOutput;
+    private applyTopicStorageMutation;
+    private applyStorageMutations;
+    private propagateSubmission;
+    /**
+     * Submits a transaction for processing by Overlay Services.
+     * @param {TaggedBEEF} taggedBEEF - The transaction to process
+     * @param {function(STEAK): void} [onSTEAKReady] - Optional callback function invoked when the STEAK is ready.
+     * @param {string} mode — Indicates the submission behavior, whether historical or current. Historical transactions are not broadcast or propagated.
+     * @param {number[]} offChainValues — Values necessary to evaluate topical admittance that are not stored on-chain.
+     *
+     * The optional callback function should be used to get STEAK when ready, and avoid waiting for broadcast and transaction propagation to complete.
+     *
+     * @returns {Promise<STEAK>} The submitted transaction execution acknowledgement
+     */
+    submit(taggedBEEF: TaggedBEEF, onSteakReady?: (steak: STEAK) => void, mode?: 'historical-tx' | 'current-tx' | 'historical-tx-no-spv', offChainValues?: number[]): Promise<STEAK>;
+    /**
+     * Submit a lookup question to the Overlay Services Engine, and receive back a Lookup Answer
+     * @param LookupQuestion — The question to ask the Overlay Services Engine
+     * @returns The answer to the question
+     */
+    lookup(lookupQuestion: LookupQuestion): Promise<LookupAnswer>;
+    private createUTXOHistoryHydrationContext;
+    private toOutputCacheKey;
+    private preloadOutputsWithBEEF;
+    private loadOutputWithBEEF;
+    private hydrateUTXOHistoryNode;
+    /**
+     * Ensures alignment between the current SHIP/SLAP advertisements and the
+     * configured Topic Managers and Lookup Services in the engine.
+     *
+     * This method performs the following actions:
+     * 1. Retrieves the current configuration of topics and services.
+     * 2. Fetches the existing SHIP advertisements for each configured topic.
+     * 3. Fetches the existing SLAP advertisements for each configured service.
+     * 4. Compares the current configuration with the fetched advertisements to determine which advertisements
+     *    need to be created or revoked.
+     * 5. Creates new SHIP/SLAP advertisements if they do not exist for the configured topics/services.
+     * 6. Revokes existing SHIP/SLAP advertisements if they are no longer required based on the current configuration.
+     *
+     * The function uses the `Advertiser` methods to create or revoke advertisements and ensures the updates are
+     * submitted to the SHIP/SLAP overlay networks using the engine's `submit()` method.
+     *
+     * @throws Will throw an error if there are issues during the advertisement synchronization process.
+     * @returns {Promise<void>} A promise that resolves when the synchronization process is complete.
+     */
+    syncAdvertisements(): Promise<void>;
+    /**
+     * This method goes through each topic that we support syncing and attempts to sync with each endpoint
+     * associated with that topic. If the sync configuration is 'SHIP', it will sync to all peers that support
+     * the topic.
+     *
+     * @throws Error if the overlay service engine is not configured for topical synchronization.
+     */
+    startGASPSync(): Promise<void>;
+    private syncGASPWithPeer;
+    private resolveSyncEndpointsForTopic;
+    provideTopicAnchorTip(topic: string): Promise<TopicAnchorTip>;
+    provideTopicAnchorRange(topic: string, fromHeight: number, toHeight: number): Promise<TopicAnchorRangeResponse>;
+    provideAdmittedList(topic: string, blockHeight: number, blockHash?: string): Promise<AdmittedListResponse>;
+    provideCompoundMerklePath(topic: string, blockHeight: number, txids: string[]): Promise<CompoundMerklePathResponse>;
+    provideRawTransactions(txids: string[]): Promise<RawTransactionResponse>;
+    startBASMSync(): Promise<BASMPeerSyncReport[]>;
+    private reconcileBASMWithPeer;
+    private reconcileRemoteAnchor;
+    private fetchBASMMissingTransactions;
+    evictUnprovenTransactions(options?: {
+        topic?: string;
+        thresholdBlocks?: number;
+    }): Promise<{
+        cutoffHeight: number;
+        candidates: number;
+        evictedTransactions: number;
+        evictedOutputs: number;
+    }>;
+    refreshUnprovenTransactionProofs(options: {
+        topic?: string;
+        thresholdBlocks?: number;
+        proofProvider: (txid: string) => Promise<{
+            merklePath: MerklePath;
+            blockHeight?: number;
+        } | undefined>;
+    }): Promise<{
+        cutoffHeight: number;
+        candidates: number;
+        refreshedTransactions: number;
+        missingProofs: number;
+        failedProofs: number;
+        failures: Array<{
+            txid: string;
+            error: string;
+        }>;
+    }>;
+    maintainUnprovenTransactions(options: {
+        topic?: string;
+        thresholdBlocks?: number;
+        proofProvider: (txid: string) => Promise<{
+            merklePath: MerklePath;
+            blockHeight?: number;
+        } | undefined>;
+    }): Promise<{
+        refresh: {
+            cutoffHeight: number;
+            candidates: number;
+            refreshedTransactions: number;
+            missingProofs: number;
+            failedProofs: number;
+            failures: Array<{
+                txid: string;
+                error: string;
+            }>;
+        };
+        eviction: {
+            cutoffHeight: number;
+            candidates: number;
+            evictedTransactions: number;
+            evictedOutputs: number;
+        };
+    }>;
+    evictAppliedTransaction(txid: string, options?: {
+        topic?: string;
+        reason?: string;
+    }): Promise<{
+        txid: string;
+        reason?: string;
+        evictedTransactions: number;
+        evictedOutputs: number;
+    }>;
+    /**
+     * Given a GASP request, create an initial response.
+     *
+     * This method processes an initial synchronization request by finding the relevant UTXOs for the given topic
+     * since the provided block height in the request. It constructs a response that includes a list of these UTXOs
+     * and the min block height from the initial request.
+     *
+     * @param initialRequest - The GASP initial request containing the version and the block height since the last sync.
+     * @param topic - The topic for which UTXOs are being requested.
+     * @returns A promise that resolves to a GASPInitialResponse containing the list of UTXOs and the provided min block height.
+     */
+    provideForeignSyncResponse(initialRequest: GASPInitialRequest, topic: string): Promise<GASPInitialResponse>;
+    /**
+     * Provides a GASPNode for the given graphID, transaction ID, and output index.
+     *
+     * @param graphID - The identifier for the graph to which this node belongs (in the format txid.outputIndex).
+     * @param txid - The transaction ID for the requested output from somewhere within the graph's history.
+     * @param outputIndex - The index of the output in the transaction.
+     * @returns A promise that resolves to a GASPNode containing the raw transaction and other optional data.
+     * @throws An error if no output is found for the given transaction ID and output index.
+     */
+    provideForeignGASPNode(graphID: string, txid: string, outputIndex: number): Promise<GASPNode>;
+    /**
+     * Traverse and return the history of a UTXO.
+     *
+     * This method traverses the history of a given Unspent Transaction Output (UTXO) and returns
+     * its historical data based on the provided history selector and current depth.
+     *
+     * @param output - The UTXO to traverse the history for.
+     * @param historySelector - Optionally directs the history traversal:
+     *  - If a number, denotes how many previous spends (in terms of chain depth) to include.
+     *  - If a function, accepts a BEEF-formatted transaction, an output index, and the current depth as parameters,
+     *    returning a promise that resolves to a boolean indicating whether to include the output in the history.
+     * @param {number} [currentDepth=0] - The current depth of the traversal relative to the top-level UTXO.
+     *
+     * @returns {Promise<Output | undefined>} - A promise that resolves to the output history if found, or undefined if not.
+    */
+    getUTXOHistory(output: Output, historySelector?: ((beef: number[], outputIndex: number, currentDepth: number) => Promise<boolean>) | number, currentDepth?: number, context?: UTXOHistoryHydrationContext): Promise<Output | undefined>;
+    /**
+     * Delete a UTXO and all stale consumed inputs.
+     * @param output - The UTXO to be deleted.
+     * @returns {Promise<void>} - A promise that resolves when the deletion process is complete.
+     */
+    private deleteUTXODeep;
+    /**
+     * Given a new transaction proof (txid, proof),
+     * update tx.merklePath if appropriate,
+     * and if not, recurse through all input sourceTransactions.
+     *
+     * @param tx transaction which may benefit from new proof.
+     * @param txid BE hex string double hash of transaction proven by proof.
+     * @param proof for txid
+     */
+    private updateInputProofs;
+    /**
+     * Recursively updates beefs (merkle proofs) of this output and its consumedBy lineage.
+     *
+     * @param output - An output derived from txid which may benefit from new proof.
+     * @param txid - The txid for which proof is a valid merkle path.
+     * @param proof - The merklePath proving txid is a mined transaction hash
+     */
+    private updateMerkleProof;
+    /**
+     * Recursively prune UTXOs when an incoming Merkle Proof is received.
+     *
+     * @param txid - Transaction ID of the associated outputs to prune.
+     * @param proof - Merkle proof containing the Merkle path and other relevant data to verify the transaction.
+     * @param blockHeight - The block height associated with the incoming merkle proof.
+     */
+    handleNewMerkleProof(txid: string, proof: MerklePath, blockHeight?: number): Promise<void>;
+    /**
+     * Find a list of supported topic managers
+     * @public
+     * @returns {Promise<Record<string, { name: string; shortDescription: string; iconURL?: string; version?: string; informationURL?: string; }>>} - Supported topic managers and their metadata
+     */
+    listTopicManagers(): Promise<Record<string, {
+        name: string;
+        shortDescription: string;
+        iconURL?: string;
+        version?: string;
+        informationURL?: string;
+    }>>;
+    /**
+     * Find a list of supported lookup services
+     * @public
+     * @returns {Promise<Record<string, { name: string; shortDescription: string; iconURL?: string; version?: string; informationURL?: string; }>>} - Supported lookup services and their metadata
+     */
+    listLookupServiceProviders(): Promise<Record<string, {
+        name: string;
+        shortDescription: string;
+        iconURL?: string;
+        version?: string;
+        informationURL?: string;
+    }>>;
+    /**
+     * Run a query to get the documentation for a particular topic manager
+     * @public
+     * @returns {Promise<string>} - the documentation for the topic manager
+     */
+    getDocumentationForTopicManager(manager: any): Promise<string>;
+    /**
+     * Run a query to get the documentation for a particular lookup service
+     * @public
+     * @returns {Promise<string>} -  the documentation for the lookup service
+     */
+    getDocumentationForLookupServiceProvider(provider: any): Promise<string>;
+    /**
+     * Validates a URL to ensure it does not match disallowed patterns:
+     * - Contains "http:" protocol
+     * - Contains "localhost" (with or without a port)
+     * - Internal or non-routable IP addresses (e.g., 192.168.x.x, 10.x.x.x, 172.16.x.x to 172.31.x.x)
+     * - Non-routable IPs like 127.x.x.x, 0.0.0.0, or IPv6 loopback (::1)
+     *
+     * @param url - The URL string to validate
+     * @returns {boolean} - Returns `false` if the URL violates any of the conditions `true` otherwise
+     */
+    private isValidUrl;
+}
+export {};
+//# sourceMappingURL=Engine.d.ts.map

package/dist/cjs/src/Engine.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Engine.d.ts","sourceRoot":"","sources":["../../../src/Engine.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAChD,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAA;AAClD,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAA;AAC9C,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACzC,OAAO,EAEL,YAAY,EACZ,UAAU,EACV,WAAW,EAEX,UAAU,EAAE,KAAK,EACjB,cAAc,EACd,YAAY,EAMZ,2BAA2B,EAG5B,MAAM,UAAU,CAAA;AACjB,OAAO,EAAqB,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAC/D,OAAO,EAAQ,kBAAkB,EAAE,mBAAmB,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAA;AACnF,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAA;AAG1D,OAAO,EAEL,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,0BAA0B,EAC/B,KAAK,sBAAsB,EAC3B,KAAK,WAAW,EAChB,KAAK,yBAAyB,EAC9B,KAAK,wBAAwB,EAC7B,KAAK,cAAc,EAKpB,MAAM,WAAW,CAAA;AAOlB,KAAK,2BAA2B,GAAG;IACjC,WAAW,EAAE,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC,CAAA;CACjD,CAAA;AA+DD;;GAEG;AACH,qBAAa,MAAM;IAyBR,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,YAAY,CAAA;KAAE;IACzC,cAAc,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,aAAa,CAAA;KAAE;IAChD,OAAO,EAAE,OAAO;IAChB,YAAY,EAAE,YAAY,GAAG,cAAc;IAC3C,UAAU,CAAC,EAAE,MAAM;IACnB,YAAY,CAAC,EAAE,MAAM,EAAE;IACvB,YAAY,CAAC,EAAE,MAAM,EAAE;IACvB,WAAW,CAAC,EAAE,WAAW;IACzB,UAAU,CAAC,EAAE,UAAU;IACvB,iBAAiB,CAAC,EAAE,iBAAiB;IACrC,OAAO;IACP,SAAS;IACT,uBAAuB;IACvB,2BAA2B,EAAE,2BAA2B;IACxD,MAAM,EAAE,OAAO,OAAO;IACtB,iCAAiC;IACjC,yBAAyB,CAAC,EAAE,yBAAyB;IACrD,eAAe;IACf,sBAAsB;IACtB,gBAAgB;IA3CzB;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,YACS,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,YAAY,CAAA;KAAE,EACzC,cAAc,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,aAAa,CAAA;KAAE,EAChD,OAAO,EAAE,OAAO,EAChB,YAAY,EAAE,YAAY,GAAG,cAAc,EAC3C,UAAU,CAAC,EAAE,MAAM,YAAA,EACnB,YAAY,CAAC,EAAE,MAAM,EAAE,YAAA,EACvB,YAAY,CAAC,EAAE,MAAM,EAAE,YAAA,EACvB,WAAW,CAAC,EAAE,WAAW,YAAA,EACzB,UAAU,CAAC,EAAE,UAAU,YAAA,EACvB,iBAAiB,CAAC,EAAE,iBAAiB,YAAA,EACrC,OAAO,UAAQ,EACf,SAAS,SAAsB,EAC/B,uBAAuB,UAAQ,EAC/B,2BAA2B,GAAE,2BAAoE,EACjG,MAAM,GAAE,OAAO,OAAiB,EAChC,iCAAiC,UAAO,EACxC,yBAAyB,CAAC,EAAE,yBAAyB,YAAA,EACrD,eAAe,UAAQ,EACvB,sBAAsB,SAAM,EAC5B,gBAAgB,SAAO,EA6B/B;IAGD,OAAO,CAAC,SAAS;IAMjB,OAAO,CAAC,OAAO;YAMD,wBAAwB;YAYxB,gBAAgB;IAgB9B,OAAO,CAAC,qBAAqB;YAIf,qBAAqB;YAmBrB,6BAA6B;YAyB7B,yBAAyB;IA6BvC;;;;;;;OAOG;IACG,wBAAwB,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAkB/D;IAED;;;;;;;OAOG;YACW,uBAAuB;IAoDrC;;;;;;;;;;OAUG;IACG,WAAW,CAAC,KAAK,EAAE;QACvB,mBAAmB,EAAE,MAAM,EAAE,CAAA;QAC7B,iBAAiB,EAAE,MAAM,CAAA;QACzB,YAAY,EAAE,MAAM,CAAA;KACrB,GAAG,OAAO,CAAC,WAAW,CAAC,CA4CvB;IAED;;;;;;;;OAQG;YACW,mBAAmB;IAmB3B,uBAAuB,CAAC,KAAK,SAAI,GAAG,OAAO,CAAC,WAAW,GAAG,SAAS,CAAC,CAuCzE;YAEa,uBAAuB;IA8ErC,OAAO,CAAC,yBAAyB;YAYnB,2BAA2B;YAoC3B,iBAAiB;YAsDjB,uBAAuB;YA6BvB,wBAAwB;IAqBtC,OAAO,CAAC,qBAAqB;YA6Bf,kBAAkB;YAiBlB,oBAAoB;YAiCpB,WAAW;YAiDX,oBAAoB;YAgBpB,yBAAyB;YA8CzB,qBAAqB;YAmCrB,mBAAmB;IAuCjC;;;;;;;;;;OAUG;IACG,MAAM,CAAC,UAAU,EAAE,UAAU,EAAE,YAAY,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,EAAE,IAAI,GAAE,eAAe,GAAG,YAAY,GAAG,sBAAqC,EAAE,cAAc,CAAC,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,KAAK,CAAC,CAmGnM;IAED;;;;OAIG;IACG,MAAM,CAAC,cAAc,EAAE,cAAc,GAAG,OAAO,CAAC,YAAY,CAAC,CA8ClE;IAED,OAAO,CAAC,iCAAiC;IAMzC,OAAO,CAAC,gBAAgB;YAIV,sBAAsB;YAkDtB,kBAAkB;YAelB,sBAAsB;IAmEpC;;;;;;;;;;;;;;;;;;OAkBG;IACG,kBAAkB,IAAI,OAAO,CAAC,IAAI,CAAC,CA+DxC;IAED;;;;;;OAMG;IACG,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC,CAqBnC;YAEa,gBAAgB;YA4BhB,4BAA4B;IAiDpC,qBAAqB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,CAOlE;IAEK,uBAAuB,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC,CAepH;IAEK,mBAAmB,CAAC,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAW/G;IAEK,yBAAyB,CAAC,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,0BAA0B,CAAC,CAiDxH;IAEK,sBAAsB,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAW7E;IAEK,aAAa,IAAI,OAAO,CAAC,kBAAkB,EAAE,CAAC,CAcnD;YAEa,qBAAqB;YA6CrB,qBAAqB;YAqCrB,4BAA4B;IAsCpC,yBAAyB,CAAC,OAAO,GAAE;QACvC,KAAK,CAAC,EAAE,MAAM,CAAA;QACd,eAAe,CAAC,EAAE,MAAM,CAAA;KACpB,GAAG,OAAO,CAAC;QACb,YAAY,EAAE,MAAM,CAAA;QACpB,UAAU,EAAE,MAAM,CAAA;QAClB,mBAAmB,EAAE,MAAM,CAAA;QAC3B,cAAc,EAAE,MAAM,CAAA;KACvB,CAAC,CAmCH;IAEK,gCAAgC,CAAC,OAAO,EAAE;QAC9C,KAAK,CAAC,EAAE,MAAM,CAAA;QACd,eAAe,CAAC,EAAE,MAAM,CAAA;QACxB,aAAa,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC;YAAE,UAAU,EAAE,UAAU,CAAC;YAAC,WAAW,CAAC,EAAE,MAAM,CAAA;SAAE,GAAG,SAAS,CAAC,CAAA;KACvG,GAAG,OAAO,CAAC;QACR,YAAY,EAAE,MAAM,CAAA;QACpB,UAAU,EAAE,MAAM,CAAA;QAClB,qBAAqB,EAAE,MAAM,CAAA;QAC7B,aAAa,EAAE,MAAM,CAAA;QACrB,YAAY,EAAE,MAAM,CAAA;QACpB,QAAQ,EAAE,KAAK,CAAC;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,KAAK,EAAE,MAAM,CAAA;SAAE,CAAC,CAAA;KACjD,CAAC,CA4CH;IAEK,4BAA4B,CAAC,OAAO,EAAE;QAC1C,KAAK,CAAC,EAAE,MAAM,CAAA;QACd,eAAe,CAAC,EAAE,MAAM,CAAA;QACxB,aAAa,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC;YAAE,UAAU,EAAE,UAAU,CAAC;YAAC,WAAW,CAAC,EAAE,MAAM,CAAA;SAAE,GAAG,SAAS,CAAC,CAAA;KACvG,GAAG,OAAO,CAAC;QACR,OAAO,EAAE;YACP,YAAY,EAAE,MAAM,CAAA;YACpB,UAAU,EAAE,MAAM,CAAA;YAClB,qBAAqB,EAAE,MAAM,CAAA;YAC7B,aAAa,EAAE,MAAM,CAAA;YACrB,YAAY,EAAE,MAAM,CAAA;YACpB,QAAQ,EAAE,KAAK,CAAC;gBAAE,IAAI,EAAE,MAAM,CAAC;gBAAC,KAAK,EAAE,MAAM,CAAA;aAAE,CAAC,CAAA;SACjD,CAAA;QACD,QAAQ,EAAE;YACR,YAAY,EAAE,MAAM,CAAA;YACpB,UAAU,EAAE,MAAM,CAAA;YAClB,mBAAmB,EAAE,MAAM,CAAA;YAC3B,cAAc,EAAE,MAAM,CAAA;SACvB,CAAA;KACF,CAAC,CAOH;IAEK,uBAAuB,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE;QACnD,KAAK,CAAC,EAAE,MAAM,CAAA;QACd,MAAM,CAAC,EAAE,MAAM,CAAA;KACX,GAAG,OAAO,CAAC;QACb,IAAI,EAAE,MAAM,CAAA;QACZ,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,mBAAmB,EAAE,MAAM,CAAA;QAC3B,cAAc,EAAE,MAAM,CAAA;KACvB,CAAC,CAkCH;IAED;;;;;;;;;;OAUG;IACG,0BAA0B,CAAC,cAAc,EAAE,kBAAkB,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAWhH;IAED;;;;;;;;OAQG;IACG,sBAAsB,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CA+DlG;IAED;;;;;;;;;;;;;;MAcE;IACI,cAAc,CAClB,MAAM,EAAE,MAAM,EACd,eAAe,CAAC,EAAE,CAAC,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,WAAW,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC,GAAG,MAAM,EAC5G,YAAY,SAAI,EAChB,OAAO,GAAE,2BAAsE,GAC9E,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CA2B7B;IAED;;;;OAIG;YACW,cAAc;IAkD5B;;;;;;;;OAQG;IACH,OAAO,CAAC,iBAAiB;IAkBzB;;;;;;OAMG;YACW,iBAAiB;IAsB/B;;;;;;OAMG;IACG,oBAAoB,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CA2C/F;IAED;;;;OAIG;IACG,iBAAiB,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE;QAChD,IAAI,EAAE,MAAM,CAAA;QACZ,gBAAgB,EAAE,MAAM,CAAA;QACxB,OAAO,CAAC,EAAE,MAAM,CAAA;QAChB,OAAO,CAAC,EAAE,MAAM,CAAA;QAChB,cAAc,CAAC,EAAE,MAAM,CAAA;KACxB,CAAC,CAAC,CAoBF;IAED;;;;OAIG;IACG,0BAA0B,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE;QACzD,IAAI,EAAE,MAAM,CAAA;QACZ,gBAAgB,EAAE,MAAM,CAAA;QACxB,OAAO,CAAC,EAAE,MAAM,CAAA;QAChB,OAAO,CAAC,EAAE,MAAM,CAAA;QAChB,cAAc,CAAC,EAAE,MAAM,CAAA;KACxB,CAAC,CAAC,CAoBF;IAED;;;;OAIG;IACG,+BAA+B,CAAC,OAAO,EAAE,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC,CAGnE;IAED;;;;OAIG;IACG,wCAAwC,CAAC,QAAQ,EAAE,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC,CAG7E;IAED;;;;;;;;;OASG;IACH,OAAO,CAAC,UAAU;CA2CnB"}