@bsv/overlay 0.1.12 → 0.1.14

package/dist/esm/src/Engine.js

@@ -1,5 +1,8 @@
-import { Transaction, MerklePath, isBroadcastFailure } from '@bsv/sdk';
+import { Transaction, isBroadcastFailure } from '@bsv/sdk';
 import { GASP } from '@bsv/gasp';
+import { OverlayGASPRemote } from './GASP/OverlayGASPRemote.js';
+import { OverlayGASPStorage } from './GASP/OverlayGASPStorage.js';
+import { URL } from "url";
 /**
  * Am engine for running BSV Overlay Services (topic managers and lookup services).
  */
@@ -16,12 +19,13 @@ export class Engine {
     syncConfiguration;
     logTime;
     logPrefix;
+    throwOnBroadcastFailure;
     /**
      * 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} chainTracker - Verifies SPV data associated with transactions
+     * @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
@@ -30,8 +34,9 @@ export class Engine {
      * @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.
      */
-    constructor(managers, lookupServices, storage, chainTracker, hostingURL, shipTrackers, slapTrackers, broadcaster, advertiser, syncConfiguration, logTime = false, logPrefix = '[OVERLAY_ENGINE] ') {
+    constructor(managers, lookupServices, storage, chainTracker, hostingURL, shipTrackers, slapTrackers, broadcaster, advertiser, syncConfiguration, logTime = false, logPrefix = '[OVERLAY_ENGINE] ', throwOnBroadcastFailure = false) {
         this.managers = managers;
         this.lookupServices = lookupServices;
         this.storage = storage;
@@ -44,6 +49,7 @@ export class Engine {
         this.syncConfiguration = syncConfiguration;
         this.logTime = logTime;
         this.logPrefix = logPrefix;
+        this.throwOnBroadcastFailure = throwOnBroadcastFailure;
         // To encourage synchronization of overlay services, the SHIP sync strategy is used by default for all overlay topics, except for 'tm_ship' and 'tm_slap'.
         // For these two topics, any existing trackers are combined with the provided shipTrackers and slapTrackers omitting any duplicates.
         if (syncConfiguration === undefined) {
@@ -93,7 +99,6 @@ export class Engine {
      * @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 {boolean} log
      *
      * The optional callback function should be used to get STEAK when ready, and avoid waiting for broadcast and transaction propagation to complete.
      *
@@ -111,11 +116,11 @@ export class Engine {
         this.startTime(`submit_${txid}`);
         this.startTime(`chainTracker_${txid.substring(0, 10)}`);
         const txValid = await tx.verify(this.chainTracker);
-        this.endTime(`chainTracker_${txid.substring(0, 10)}`);
         if (!txValid)
             throw new Error('Unable to verify SPV information.');
+        this.endTime(`chainTracker_${txid.substring(0, 10)}`);
         const steak = {};
-        let admissableOutputs = { outputsToAdmit: [], coinsToRetain: [] };
+        let admissibleOutputs = { outputsToAdmit: [], coinsToRetain: [] };
         const previousCoins = [];
         // Parallelize the topic processing
         const topicPromises = taggedBEEF.topics.map(async (topic) => {
@@ -131,19 +136,21 @@ export class Engine {
                 return;
             }
             // Check if any input of this transaction is a previous UTXO
-            const outputPromises = tx.inputs.map(input => {
-                const previousTXID = input.sourceTXID || input.sourceTransaction?.id('hex');
-                return this.storage.findOutput(previousTXID, input.sourceOutputIndex, topic);
+            const outputPromises = tx.inputs.map(async (input, i) => {
+                const previousTXID = input.sourceTXID !== undefined ? input.sourceTXID : input.sourceTransaction?.id('hex');
+                if (previousTXID !== undefined) {
+                    const output = this.storage.findOutput(previousTXID, input.sourceOutputIndex, topic);
+                    if (output !== undefined && output !== null) {
+                        previousCoins.push(i);
+                        return await Promise.resolve(output);
+                    }
+                }
+                return await Promise.resolve(null);
             });
             this.startTime(`previousOutputQuery_${txid.substring(0, 10)}`);
             const outputs = await Promise.all(outputPromises);
             this.endTime(`previousOutputQuery_${txid.substring(0, 10)}`);
-            outputs.forEach((output, i) => {
-                if (output !== undefined && output !== null) {
-                    previousCoins.push(i);
-                }
-            });
-            const markSpentPromises = outputs.map(async (output, i) => {
+            const markSpentPromises = outputs.map(async (output) => {
                 if (output !== undefined && output !== null) {
                     try {
                         await this.storage.markUTXOAsSpent(output.txid, output.outputIndex, topic);
@@ -165,7 +172,7 @@ export class Engine {
             const admissibleOutputsPromise = (async () => {
                 try {
                     this.startTime(`identifyAdmissibleOutputs_${txid.substring(0, 10)}`);
-                    admissableOutputs = await this.managers[topic].identifyAdmissibleOutputs(taggedBEEF.beef, previousCoins);
+                    admissibleOutputs = await this.managers[topic].identifyAdmissibleOutputs(taggedBEEF.beef, previousCoins);
                     this.endTime(`identifyAdmissibleOutputs_${txid.substring(0, 10)}`);
                 }
                 catch (_) {
@@ -175,15 +182,17 @@ export class Engine {
             // Wait for both tasks to complete
             await Promise.all([markSpentPromises, admissibleOutputsPromise]);
             // Keep track of what outputs were admitted for what topic
-            steak[topic] = admissableOutputs;
+            steak[topic] = admissibleOutputs;
         });
         await Promise.all(topicPromises);
         // Broadcast the transaction if not historical and broadcaster is configured
         this.startTime(`broadcast_${txid.substring(0, 10)}`);
         if (mode !== 'historical-tx' && this.broadcaster !== undefined) {
             const response = await this.broadcaster.broadcast(tx);
-            if (isBroadcastFailure(response)) {
-                throw new Error(`Failed to broadcast transaction! Error: ${response.description}`);
+            if (isBroadcastFailure(response) && this.throwOnBroadcastFailure) {
+                const e = new Error(`Failed to broadcast transaction! Error: ${response.description}`);
+                e.more = response.more;
+                throw e;
             }
         }
         this.endTime(`broadcast_${txid.substring(0, 10)}`);
@@ -194,7 +203,7 @@ export class Engine {
         }
         for (const topic of taggedBEEF.topics) {
             // Keep track of which outputs to admit, mark as stale, or retain
-            const outputsToAdmit = admissableOutputs.outputsToAdmit;
+            const outputsToAdmit = admissibleOutputs.outputsToAdmit;
             const staleCoins = [];
             const outputsConsumed = [];
             // Find which outputs should not be retained and mark them as stale
@@ -202,7 +211,7 @@ export class Engine {
             for (const inputIndex of previousCoins) {
                 const previousTXID = tx.inputs[inputIndex].sourceTXID || tx.inputs[inputIndex].sourceTransaction?.id('hex');
                 const previousOutputIndex = tx.inputs[inputIndex].sourceOutputIndex;
-                if (!admissableOutputs.coinsToRetain.includes(inputIndex)) {
+                if (!admissibleOutputs.coinsToRetain.includes(inputIndex)) {
                     staleCoins.push({
                         txid: previousTXID,
                         outputIndex: previousOutputIndex
@@ -242,7 +251,7 @@ export class Engine {
                 this.endTime(`insertNewOutput_${txid.substring(0, 10)}`);
                 newUTXOs.push({ txid, outputIndex });
                 this.startTime(`notifyLookupService${txid.substring(0, 10)}`);
-                await Promise.all(Object.values(this.lookupServices).map(l => l.outputAdded?.(txid, outputIndex, tx.outputs[outputIndex].lockingScript, topic)));
+                await Promise.all(Object.values(this.lookupServices).map(async (l) => await l.outputAdded?.(txid, outputIndex, tx.outputs[outputIndex].lockingScript, topic)));
                 this.endTime(`notifyLookupService${txid.substring(0, 10)}`);
             }));
             this.startTime(`outputConsumed_${txid.substring(0, 10)}`);
@@ -266,10 +275,10 @@ export class Engine {
         if (this.advertiser === undefined || mode === 'historical-tx') {
             return steak;
         }
-        this.startTime(`transactionPropgation_${txid.substring(0, 10)}`);
+        this.startTime(`transactionPropagation_${txid.substring(0, 10)}`);
         // Propagate transaction to other nodes according to synchronization agreements
         // 1. Find nodes that host the topics associated with admissable outputs
-        // We want to figure out which topics we actually care about(because their associated outputs were admitted)
+        // We want to figure out which topics we actually care about (because their associated outputs were admitted)
         // AND if the topic was not admitted we want to remove it from the list of topics we care about.
         const relevantTopics = taggedBEEF.topics.filter(topic => steak[topic] !== undefined && steak[topic].outputsToAdmit.length !== 0);
         // TODO: Cache ship/slap lookup with expiry (every 5min)
@@ -419,7 +428,7 @@ export class Engine {
      * @returns {Promise<void>} A promise that resolves when the synchronization process is complete.
      */
     async syncAdvertisements() {
-        if (this.advertiser === undefined) {
+        if (this.advertiser === undefined || !this.hostingURL || !this.isValidUrl(this.hostingURL)) {
             return;
         }
         const advertiser = this.advertiser;
@@ -850,6 +859,53 @@ export class Engine {
         const documentation = await this.lookupServices[provider]?.getDocumentation?.();
         return documentation !== undefined ? documentation : 'No documentation found!';
     }
+    /**
+     * 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
+     */
+    isValidUrl(url) {
+        try {
+            const parsedUrl = new URL(url);
+            // Disallow http:
+            if (parsedUrl.protocol === "http:") {
+                return false;
+            }
+            // Disallow localhost with or without a port
+            if (/^localhost(:\d+)?$/i.test(parsedUrl.hostname)) {
+                return false;
+            }
+            // Disallow internal and non-routable IP addresses
+            const ipAddress = parsedUrl.hostname;
+            // Regex for non-routable IPv4 IPs
+            const nonRoutableIpv4Patterns = [
+                /^127\.\d{1,3}\.\d{1,3}\.\d{1,3}$/, // Loopback IPs
+                /^10\.\d{1,3}\.\d{1,3}\.\d{1,3}$/, // 10.x.x.x private IPs
+                /^192\.168\.\d{1,3}\.\d{1,3}$/, // 192.168.x.x private IPs
+                /^172\.(1[6-9]|2[0-9]|3[0-1])\.\d{1,3}\.\d{1,3}$/, // 172.16.x.x to 172.31.x.x private IPs
+                /^0\.0\.0\.0$/ // Non-routable address
+            ];
+            // Check for IPv4 matches
+            if (nonRoutableIpv4Patterns.some((pattern) => pattern.test(ipAddress))) {
+                return false;
+            }
+            // Check for non-routable IPv6 addresses explicitly
+            if (ipAddress === "[::1]") {
+                return false;
+            }
+            // If none of the disallowed conditions matched, the URL is valid
+            return true;
+        }
+        catch (error) {
+            // If the input is not a valid URL, return false
+            return false;
+        }
+    }
 }
 //////////
 // OTHER FILES
@@ -859,390 +915,5 @@ There is currently a bug with the test runner that prevents importing and using
 Thus, all non-type exports have been moved to Engine.
 */
 // TODO: fix bug with imports that break tests. -----[GASP/OverlayGASPRemote.ts]-----
-export class OverlayGASPRemote {
-    endpointURL;
-    topic;
-    constructor(endpointURL, topic) {
-        this.endpointURL = endpointURL;
-        this.topic = topic;
-    }
-    /**
-     * Given an outgoing initial request, sends the request to the foreign instance and obtains their initial response.
-     * @param request
-     * @returns
-     */
-    async getInitialResponse(request) {
-        // Send out an HTTP request to the URL (current host for topic)
-        // Include the topic in the request
-        // Parse out response and return correct format
-        const url = `${this.endpointURL}/requestSyncResponse`;
-        const response = await fetch(url, {
-            method: 'POST',
-            headers: {
-                'Content-Type': 'application/json',
-                'X-BSV-Topic': this.topic
-            },
-            body: JSON.stringify(request)
-        });
-        if (!response.ok) {
-            throw new Error(`HTTP error! Status: ${response.status}`);
-        }
-        const result = await response.json();
-        // Validate and return the response in the correct format
-        if (!Array.isArray(result.UTXOList) || typeof result.since !== 'number') {
-            throw new Error('Invalid response format');
-        }
-        return {
-            UTXOList: result.UTXOList.map((utxo) => ({
-                txid: utxo.txid,
-                outputIndex: utxo.outputIndex
-            })),
-            since: result.since
-        };
-    }
-    /**
-     * Given an outgoing txid, outputIndex and optional metadata, request the associated GASP node from the foreign instance.
-     * @param graphID
-     * @param txid
-     * @param outputIndex
-     * @param metadata
-     * @returns
-     */
-    async requestNode(graphID, txid, outputIndex, metadata) {
-        // Send an HTTP request with the provided info and get back a gaspNode
-        const url = `${this.endpointURL}/requestForeignGASPNode`;
-        const body = {
-            graphID,
-            txid,
-            outputIndex,
-            metadata
-        };
-        const response = await fetch(url, {
-            method: 'POST',
-            headers: {
-                'Content-Type': 'application/json'
-            },
-            body: JSON.stringify(body)
-        });
-        if (!response.ok) {
-            throw new Error(`HTTP error! Status: ${response.status}`);
-        }
-        const result = await response.json();
-        // Validate and return the response in the correct format
-        if (typeof result.graphID !== 'string' || typeof result.rawTx !== 'string' || typeof result.outputIndex !== 'number') {
-            throw new Error('Invalid response format');
-        }
-        const gaspNode = {
-            graphID: result.graphID,
-            rawTx: result.rawTx,
-            outputIndex: result.outputIndex,
-            proof: result.proof,
-            txMetadata: result.txMetadata,
-            outputMetadata: result.outputMetadata,
-            inputs: result.inputs
-        };
-        return gaspNode;
-    }
-    // ---- Now optional methods ----
-    // When are only syncing to them
-    async getInitialReply(response) {
-        throw new Error('Function not supported!');
-    }
-    // Only used when supporting bidirectional sync.
-    // Overlay services does not support this.
-    async submitNode(node) {
-        throw new Error('Node submission not supported!');
-    }
-}
-export class OverlayGASPStorage {
-    topic;
-    engine;
-    maxNodesInGraph;
-    temporaryGraphNodeRefs = {};
-    constructor(topic, engine, maxNodesInGraph) {
-        this.topic = topic;
-        this.engine = engine;
-        this.maxNodesInGraph = maxNodesInGraph;
-    }
-    /**
-     *
-     * @param since
-     * @returns
-     */
-    async findKnownUTXOs(since) {
-        const UTXOs = await this.engine.storage.findUTXOsForTopic(this.topic, since);
-        return UTXOs.map(output => ({
-            txid: output.txid,
-            outputIndex: output.outputIndex
-        }));
-    }
-    /**
-     * For a given txid and output index, returns the associated transaction, a merkle proof if the transaction is in a block, and metadata if if requested. If no metadata is requested, metadata hashes on inputs are not returned.
-     * @param graphID
-     * @param txid
-     * @param outputIndex
-     * @param metadata
-     * @returns
-     */
-    async hydrateGASPNode(graphID, txid, outputIndex, metadata) {
-        const output = await this.engine.storage.findOutput(txid, outputIndex, undefined, undefined, true);
-        if (output?.beef === undefined) {
-            throw new Error('No matching output found!');
-        }
-        const tx = Transaction.fromBEEF(output.beef);
-        const rawTx = tx.toHex();
-        const node = {
-            rawTx,
-            graphID,
-            outputIndex
-        };
-        if (tx.merklePath !== undefined) {
-            node.proof = tx.merklePath.toHex();
-        }
-        return node;
-    }
-    /**
-    * For a given node, returns the inputs needed to complete the graph, including whether updated metadata is requested for those inputs.
-    * @param tx The node for which needed inputs should be found.
-    * @returns A promise for a mapping of requested input transactions and whether metadata should be provided for each.
-    */
-    async findNeededInputs(tx) {
-        // If there is no Merkle proof, we always need the inputs
-        const response = {
-            requestedInputs: {}
-        };
-        const parsedTx = Transaction.fromHex(tx.rawTx);
-        if (tx.proof === undefined) {
-            for (const input of parsedTx.inputs) {
-                response.requestedInputs[`${input.sourceTXID}.${input.sourceOutputIndex}`] = {
-                    metadata: false
-                };
-            }
-            return await this.stripAlreadyKnownInputs(response);
-        }
-        // Attempt to check if the current transaction is admissible
-        parsedTx.merklePath = MerklePath.fromHex(tx.proof);
-        const admittanceResult = await this.engine.managers[this.topic].identifyAdmissibleOutputs(parsedTx.toBEEF(), []);
-        if (admittanceResult.outputsToAdmit.includes(tx.outputIndex)) {
-            // The transaction is admissible, no further inputs are needed
-        }
-        else {
-            // The transaction is not admissible, get inputs needed for further verification
-            // TopicManagers should implement a function to identify which inputs are needed.
-            if (this.engine.managers[this.topic] !== undefined && typeof this.engine.managers[this.topic].identifyNeededInputs === 'function') {
-                try {
-                    const neededInputs = await this.engine.managers[this.topic].identifyNeededInputs?.(parsedTx.toBEEF()) ?? [];
-                    for (const input of neededInputs) {
-                        response.requestedInputs[`${input.txid}.${input.outputIndex}`] = {
-                            metadata: false
-                        };
-                    }
-                    return await this.stripAlreadyKnownInputs(response);
-                }
-                catch (e) {
-                    console.error(`An error occurred when identifying needed inputs for transaction: ${parsedTx.id('hex')}.${tx.outputIndex}!`);
-                    // Cut off the graph in case of an error here.
-                }
-            }
-            // By default, if the topic manager isn't able to stipulate needed inputs, only the inputs necessary for SPV are requested.
-        }
-        // Everything else falls through to returning undefined/void, which will terminate the synchronization at this point.
-    }
-    /**
-     * Ensures that no inputs are requested from foreign nodes before sending any GASP response
-     * Also terminates graphs if the response would be empty.
-     */
-    async stripAlreadyKnownInputs(response) {
-        if (typeof response === 'undefined') {
-            return response;
-        }
-        for (const inputNodeId of Object.keys(response.requestedInputs)) {
-            const [txid, outputIndex] = inputNodeId.split('.');
-            const found = await this.engine.storage.findOutput(txid, Number(outputIndex), this.topic);
-            if (found !== null && found !== undefined) {
-                // eslint-disable-next-line @typescript-eslint/no-dynamic-delete
-                delete response.requestedInputs[inputNodeId];
-            }
-        }
-        if (Object.keys(response.requestedInputs).length === 0) {
-            return undefined;
-        }
-        return response;
-    }
-    /**
-    * Appends a new node to a temporary graph.
-    * @param tx The node to append to this graph.
-    * @param spentBy Unless this is the same node identified by the graph ID, denotes the TXID and input index for the node which spent this one, in 36-byte format.
-    * @throws If the node cannot be appended to the graph, either because the graph ID is for a graph the recipient does not want or because the graph has grown to be too large before being finalized.
-    */
-    async appendToGraph(tx, spentBy) {
-        if (this.maxNodesInGraph !== undefined && Object.keys(this.temporaryGraphNodeRefs).length >= this.maxNodesInGraph) {
-            throw new Error('The max number of nodes in transaction graph has been reached!');
-        }
-        const parsedTx = Transaction.fromHex(tx.rawTx);
-        const txid = parsedTx.id('hex');
-        if (tx.proof !== undefined) {
-            parsedTx.merklePath = MerklePath.fromHex(tx.proof);
-        }
-        // Given the passed in node, append to the temp graph
-        // Use the spentBy param which should be a txid.inputIndex for the node which spent this one in 36-byte format
-        const newGraphNode = {
-            txid,
-            graphID: tx.graphID,
-            rawTx: tx.rawTx,
-            outputIndex: tx.outputIndex,
-            proof: tx.proof,
-            txMetadata: tx.txMetadata,
-            outputMetadata: tx.outputMetadata,
-            inputs: tx.inputs,
-            children: []
-        };
-        // If spentBy is undefined, then we know it's the root node.
-        if (spentBy === undefined) {
-            this.temporaryGraphNodeRefs[tx.graphID] = newGraphNode;
-        }
-        else {
-            // Find the parent node based on spentBy
-            const parentNode = this.temporaryGraphNodeRefs[spentBy];
-            if (parentNode !== undefined) {
-                // Set parent-child relationship
-                parentNode.children.push(newGraphNode);
-                newGraphNode.parent = parentNode;
-                this.temporaryGraphNodeRefs[`${newGraphNode.txid}.${newGraphNode.outputIndex}`] = newGraphNode;
-            }
-            else {
-                throw new Error(`Parent node with GraphID ${spentBy} not found`);
-            }
-        }
-    }
-    /**
-      * Checks whether the given graph, in its current state, makes reference only to transactions that are proven in the blockchain, or already known by the recipient to be valid.
-      * Additionally, in a breadth-first manner (ensuring that all inputs for any given node are processed before nodes that spend them), it ensures that the root node remains valid according to the rules of the overlay's topic manager,
-      * while considering any coins which the Manager had previously indicated were either valid or invalid.
-      * @param graphID The TXID and output index (in 36-byte format) for the UTXO at the tip of this graph.
-      * @throws If the graph is not well-anchored, according to the rules of Bitcoin or the rules of the Overlay Topic Manager.
-      */
-    async validateGraphAnchor(graphID) {
-        const rootNode = this.temporaryGraphNodeRefs[graphID];
-        if (rootNode === undefined) {
-            throw new Error(`Graph node with ID ${graphID} not found`);
-        }
-        // Check that the root node is Bitcoin-valid.
-        const beef = this.getBEEFForNode(rootNode);
-        const spvTx = Transaction.fromBEEF(beef);
-        const isBitcoinValid = await spvTx.verify(this.engine.chainTracker);
-        if (!isBitcoinValid) {
-            throw new Error('The graph is not well-anchored according to the rules of Bitcoin.');
-        }
-        // Then, ensure the node is Overlay-valid.
-        const beefs = this.computeOrderedBEEFsForGraph(graphID);
-        // coins: a Set of all historical coins to retain (no need to remove them), used to emulate topical admittance of previous inputs over time.
-        const coins = new Set();
-        // Submit all historical BEEFs in order through the topic manager, tracking what would be retained until we submit the root node last.
-        // If, at the end, the root node is admitted, we have a valid overlay-specific graph.
-        for (const beef of beefs) {
-            // For any input to this transaction, see if it's a valid coin that's admitted. If so, it's a previous coin.
-            const previousCoins = [];
-            const tx = Transaction.fromBEEF(beef);
-            for (const inputIndex in tx.inputs) {
-                const input = tx.inputs[inputIndex];
-                const sourceTXID = input.sourceTXID || input.sourceTransaction?.id('hex');
-                const coin = `${sourceTXID}.${input.sourceOutputIndex}`;
-                if (coins.has(coin)) {
-                    previousCoins.push(Number(inputIndex));
-                }
-            }
-            const admittanceInstructions = await this.engine.managers[this.topic].identifyAdmissibleOutputs(beef, previousCoins);
-            // Every admitted output is now a coin.
-            for (const outputIndex of admittanceInstructions.outputsToAdmit) {
-                coins.add(`${tx.id('hex')}.${outputIndex}`);
-            }
-        }
-        // After sending through all the graph's BEEFs...
-        // If the root node is now a coin, we have acceptance by the overlay.
-        // Otherwise, throw.
-        if (!coins.has(graphID)) {
-            throw new Error('This graph did not result in topical admittance of the root node. Rejecting.');
-        }
-    }
-    /**
-     * Deletes all data associated with a temporary graph that has failed to sync, if the graph exists.
-     * @param graphID The TXID and output index (in 36-byte format) for the UTXO at the tip of this graph.
-     */
-    async discardGraph(graphID) {
-        for (const [nodeId, graphRef] of Object.entries(this.temporaryGraphNodeRefs)) {
-            if (graphRef.graphID === graphID) {
-                // Delete child node
-                // eslint-disable-next-line @typescript-eslint/no-dynamic-delete
-                delete this.temporaryGraphNodeRefs[nodeId];
-            }
-        }
-    }
-    /**
-     * Finalizes a graph, solidifying the new UTXO and its ancestors so that it will appear in the list of known UTXOs.
-     * @param graphID The TXID and output index (in 36-byte format) for the UTXO at the root of this graph.
-     */
-    async finalizeGraph(graphID) {
-        const beefs = this.computeOrderedBEEFsForGraph(graphID);
-        // Submit all historical BEEFs in order, finalizing the graph for the current UTXO
-        for (const beef of beefs) {
-            await this.engine.submit({
-                beef,
-                topics: [this.topic]
-            }, () => { }, 'historical-tx');
-        }
-    }
-    /**
-     * Computes an ordered set of BEEFs for the graph with the given graph IDs
-     * @param {string} graphID — The ID of the graph for which BEEFs are required
-     * @returns Ordered BEEFs for the graph
-     */
-    computeOrderedBEEFsForGraph(graphID) {
-        const beefs = [];
-        const hydrator = (node) => {
-            const currentBEEF = this.getBEEFForNode(node);
-            if (beefs.indexOf(currentBEEF) === -1) {
-                beefs.unshift(currentBEEF);
-            }
-            for (const child of node.children) {
-                // Continue backwards to the earliest nodes, adding them onto the beginning
-                hydrator(child);
-            }
-        };
-        // Start the hydrator with the root node
-        const foundRoot = this.temporaryGraphNodeRefs[graphID];
-        if (!foundRoot) {
-            throw new Error('Unable to find root node in graph for finalization!');
-        }
-        hydrator(foundRoot);
-        return beefs;
-    }
-    /**
-     * Computes a full BEEF for a given graph node, based on the temporary graph store.
-     * @param node Graph node for which BEEF is needed.
-     * @returns BEEF array, including all proofs on inputs.
-     */
-    getBEEFForNode(node) {
-        // Given a node, hydrate its merkle proof or all inputs, returning a reference to the hydrated node's Transaction object
-        const hydrator = (node) => {
-            const tx = Transaction.fromHex(node.rawTx);
-            if (node.proof) {
-                tx.merklePath = MerklePath.fromHex(node.proof);
-                return tx; // Transaction with proof, end of the line.
-            }
-            // For each input, look it up and recurse.
-            for (const inputIndex in tx.inputs) {
-                const input = tx.inputs[inputIndex];
-                const foundNode = this.temporaryGraphNodeRefs[`${input.sourceTXID}.${input.sourceOutputIndex}`];
-                if (!foundNode) {
-                    throw new Error('Required input node for unproven parent not found in temporary graph store. Ensure, for every parent of any given already-proven node (kept for Overlay-specific historical reasons), that a proof is also provided on those inputs. While implicitly they are valid by virtue of their descendents being proven in the blockchain, BEEF serialization will still fail when winding forward the topical UTXO set histories during sync.');
-                }
-                tx.inputs[inputIndex].sourceTransaction = hydrator(foundNode);
-            }
-            return tx;
-        };
-        const finalTX = hydrator(node);
-        return finalTX.toBEEF();
-    }
-}
+// TODO: fix bug with imports that break tests. -----[GASP/OverlayGASPStorage.ts]-----
 //# sourceMappingURL=Engine.js.map